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);
235 static void check_ignorelist_and_submit(const char *dev,
236 struct rtnl_link_stats *stats)
239 if (check_ignorelist (dev, "interface", NULL) == 0)
241 submit_two (dev, "if_octets", NULL, stats->rx_bytes, stats->tx_bytes);
242 submit_two (dev, "if_packets", NULL, stats->rx_packets, stats->tx_packets);
243 submit_two (dev, "if_errors", NULL, stats->rx_errors, stats->tx_errors);
247 DEBUG ("netlink plugin: Ignoring %s/interface.", dev);
250 if (check_ignorelist (dev, "if_detail", NULL) == 0)
252 submit_two (dev, "if_dropped", NULL, stats->rx_dropped, stats->tx_dropped);
253 submit_one (dev, "if_multicast", NULL, stats->multicast);
254 submit_one (dev, "if_collisions", NULL, stats->collisions);
256 submit_one (dev, "if_rx_errors", "length", stats->rx_length_errors);
257 submit_one (dev, "if_rx_errors", "over", stats->rx_over_errors);
258 submit_one (dev, "if_rx_errors", "crc", stats->rx_crc_errors);
259 submit_one (dev, "if_rx_errors", "frame", stats->rx_frame_errors);
260 submit_one (dev, "if_rx_errors", "fifo", stats->rx_fifo_errors);
261 submit_one (dev, "if_rx_errors", "missed", stats->rx_missed_errors);
263 submit_one (dev, "if_tx_errors", "aborted", stats->tx_aborted_errors);
264 submit_one (dev, "if_tx_errors", "carrier", stats->tx_carrier_errors);
265 submit_one (dev, "if_tx_errors", "fifo", stats->tx_fifo_errors);
266 submit_one (dev, "if_tx_errors", "heartbeat", stats->tx_heartbeat_errors);
267 submit_one (dev, "if_tx_errors", "window", stats->tx_window_errors);
271 DEBUG ("netlink plugin: Ignoring %s/if_detail.", dev);
276 static int link_filter_cb (const struct nlmsghdr *nlh,
277 void __attribute__((unused)) *args)
279 struct ifinfomsg *ifm = mnl_nlmsg_get_payload (nlh);
281 struct rtnl_link_stats *stats = NULL;
282 const char *dev = NULL;
284 if (nlh->nlmsg_type != RTM_NEWLINK)
286 ERROR ("netlink plugin: link_filter_cb: Don't know how to handle type %i.",
291 mnl_attr_for_each (attr, nlh, sizeof (*ifm))
293 if (mnl_attr_get_type (attr) != IFLA_IFNAME)
296 if (mnl_attr_validate (attr, MNL_TYPE_STRING) < 0)
298 ERROR ("netlink plugin: link_filter_cb: IFLA_IFNAME mnl_attr_validate failed.");
302 dev = mnl_attr_get_str (attr);
303 if (update_iflist (ifm, dev) < 0)
310 ERROR ("netlink plugin: link_filter_cb: dev == NULL");
314 mnl_attr_for_each (attr, nlh, sizeof (*ifm))
316 if (mnl_attr_get_type (attr) != IFLA_STATS)
319 if (mnl_attr_validate2 (attr, MNL_TYPE_UNSPEC, sizeof(*stats)) < 0)
321 ERROR ("netlink plugin: link_filter_cb: IFLA_STATS mnl_attr_validate2 failed.");
324 stats = mnl_attr_get_payload(attr);
326 check_ignorelist_and_submit(dev, stats);
332 DEBUG ("netlink plugin: link_filter: No statistics for interface %s.", dev);
337 } /* int link_filter_cb */
340 static int qos_attr_cb (const struct nlattr *attr, void *data)
342 struct gnet_stats_basic *bs = *(struct gnet_stats_basic **)data;
344 /* skip unsupported attribute in user-space */
345 if (mnl_attr_type_valid(attr, TCA_STATS_MAX) < 0)
348 if (mnl_attr_get_type(attr) == TCA_STATS_BASIC)
350 if (mnl_attr_validate2 (attr, MNL_TYPE_UNSPEC, sizeof (*bs)) < 0)
352 ERROR ("netlink plugin: qos_attr_cb: TCA_STATS_BASIC mnl_attr_validate2 failed.");
355 bs = mnl_attr_get_payload(attr);
363 static int qos_filter_cb (const struct nlmsghdr *nlh, void *args)
365 struct tcmsg *tm = mnl_nlmsg_get_payload(nlh);
368 int wanted_ifindex = *((int *) args);
371 const char *kind = NULL;
373 /* char *type_instance; */
375 char tc_inst[DATA_MAX_NAME_LEN];
377 int __attribute__((unused)) stats_submitted = 0;
379 if (nlh->nlmsg_type == RTM_NEWQDISC)
381 else if (nlh->nlmsg_type == RTM_NEWTCLASS)
383 else if (nlh->nlmsg_type == RTM_NEWTFILTER)
387 ERROR ("netlink plugin: qos_filter_cb: Don't know how to handle type %i.",
392 if (tm->tcm_ifindex != wanted_ifindex)
394 DEBUG ("netlink plugin: qos_filter_cb: Got %s for interface #%i, "
396 tc_type, tm->tcm_ifindex, wanted_ifindex);
400 if ((tm->tcm_ifindex >= 0)
401 && ((size_t) tm->tcm_ifindex >= iflist_len))
403 ERROR ("netlink plugin: qos_filter_cb: tm->tcm_ifindex = %i "
404 ">= iflist_len = %zu",
405 tm->tcm_ifindex, iflist_len);
409 dev = iflist[tm->tcm_ifindex];
412 ERROR ("netlink plugin: qos_filter_cb: iflist[%i] == NULL",
417 mnl_attr_for_each (attr, nlh, sizeof (*tm))
419 if (mnl_attr_get_type(attr) != TCA_KIND)
422 if (mnl_attr_validate (attr, MNL_TYPE_STRING) < 0)
424 ERROR ("netlink plugin: qos_filter_cb: TCA_KIND mnl_attr_validate failed.");
428 kind = mnl_attr_get_str(attr);
434 ERROR ("netlink plugin: qos_filter_cb: kind == NULL");
439 uint32_t numberic_id;
441 numberic_id = tm->tcm_handle;
442 if (strcmp (tc_type, "filter") == 0)
443 numberic_id = tm->tcm_parent;
445 ssnprintf (tc_inst, sizeof (tc_inst), "%s-%x:%x",
448 numberic_id & 0x0000FFFF);
451 DEBUG ("netlink plugin: qos_filter_cb: got %s for %s (%i).",
452 tc_type, dev, tm->tcm_ifindex);
454 if (check_ignorelist (dev, tc_type, tc_inst))
458 mnl_attr_for_each (attr, nlh, sizeof (*tm))
460 struct gnet_stats_basic *bs = NULL;
462 if (mnl_attr_get_type(attr) != TCA_STATS2)
465 if (mnl_attr_validate(attr, MNL_TYPE_NESTED) < 0)
467 ERROR ("netlink plugin: qos_filter_cb: TCA_STATS2 mnl_attr_validate failed.");
471 mnl_attr_parse_nested(attr, qos_attr_cb, &bs);
475 char type_instance[DATA_MAX_NAME_LEN];
479 ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
482 submit_one (dev, "ipt_bytes", type_instance, bs->bytes);
483 submit_one (dev, "ipt_packets", type_instance, bs->packets);
488 #endif /* TCA_STATS2 */
491 mnl_attr_for_each (attr, nlh, sizeof (*tm))
493 struct tc_stats *ts = NULL;
495 if (mnl_attr_get_type(attr) != TCA_STATS)
498 if (mnl_attr_validate2 (attr, MNL_TYPE_UNSPEC, sizeof (*ts)) < 0)
500 ERROR ("netlink plugin: qos_filter_cb: TCA_STATS mnl_attr_validate2 failed.");
503 ts = mnl_attr_get_payload(attr);
505 if (!stats_submitted && ts != NULL)
507 char type_instance[DATA_MAX_NAME_LEN];
509 ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
512 submit_one (dev, "ipt_bytes", type_instance, ts->bytes);
513 submit_one (dev, "ipt_packets", type_instance, ts->packets);
519 #endif /* TCA_STATS */
521 #if !(HAVE_TCA_STATS && HAVE_TCA_STATS2)
522 DEBUG ("netlink plugin: qos_filter_cb: Have neither TCA_STATS2 nor "
527 } /* int qos_filter_cb */
529 static int ir_config (const char *key, const char *value)
536 new_val = strdup (value);
540 fields_num = strsplit (new_val, fields, STATIC_ARRAY_SIZE (fields));
541 if ((fields_num < 1) || (fields_num > 8))
547 if ((strcasecmp (key, "Interface") == 0)
548 || (strcasecmp (key, "VerboseInterface") == 0))
552 ERROR ("netlink plugin: Invalid number of fields for option "
553 "`%s'. Got %i, expected 1.", key, fields_num);
558 add_ignorelist (fields[0], "interface", NULL);
559 if (strcasecmp (key, "VerboseInterface") == 0)
560 add_ignorelist (fields[0], "if_detail", NULL);
564 else if ((strcasecmp (key, "QDisc") == 0)
565 || (strcasecmp (key, "Class") == 0)
566 || (strcasecmp (key, "Filter") == 0))
568 if ((fields_num < 1) || (fields_num > 2))
570 ERROR ("netlink plugin: Invalid number of fields for option "
571 "`%s'. Got %i, expected 1 or 2.", key, fields_num);
576 add_ignorelist (fields[0], key,
577 (fields_num == 2) ? fields[1] : NULL);
581 else if (strcasecmp (key, "IgnoreSelected") == 0)
585 ERROR ("netlink plugin: Invalid number of fields for option "
586 "`IgnoreSelected'. Got %i, expected 1.", fields_num);
591 if (IS_TRUE (fields[0]))
592 ir_ignorelist_invert = 0;
594 ir_ignorelist_invert = 1;
602 } /* int ir_config */
604 static int ir_init (void)
606 nl = mnl_socket_open(NETLINK_ROUTE);
609 ERROR ("netlink plugin: ir_init: mnl_socket_open failed.");
613 if (mnl_socket_bind(nl, 0, MNL_SOCKET_AUTOPID) < 0)
615 ERROR ("netlink plugin: ir_init: mnl_socket_bind failed.");
622 static int ir_read (void)
624 char buf[MNL_SOCKET_BUFFER_SIZE];
625 struct nlmsghdr *nlh;
628 unsigned int seq, portid;
632 static const int type_id[] = { RTM_GETQDISC, RTM_GETTCLASS, RTM_GETTFILTER };
633 static const char *type_name[] = { "qdisc", "class", "filter" };
635 portid = mnl_socket_get_portid(nl);
637 nlh = mnl_nlmsg_put_header (buf);
638 nlh->nlmsg_type = RTM_GETLINK;
639 nlh->nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
640 nlh->nlmsg_seq = seq = time (NULL);
641 rt = mnl_nlmsg_put_extra_header (nlh, sizeof (*rt));
642 rt->rtgen_family = AF_PACKET;
644 if (mnl_socket_sendto (nl, nlh, nlh->nlmsg_len) < 0)
646 ERROR ("netlink plugin: ir_read: rtnl_wilddump_request failed.");
650 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
653 ret = mnl_cb_run (buf, ret, seq, portid, link_filter_cb, NULL);
654 if (ret <= MNL_CB_STOP)
656 ret = mnl_socket_recvfrom (nl, buf, sizeof(buf));
660 ERROR ("netlink plugin: ir_read: mnl_socket_recvfrom failed.");
664 /* `link_filter_cb' will update `iflist' which is used here to iterate
665 * over all interfaces. */
666 for (ifindex = 0; ifindex < iflist_len; ifindex++)
672 if (iflist[ifindex] == NULL)
675 for (type_index = 0; type_index < STATIC_ARRAY_SIZE (type_id); type_index++)
677 if (check_ignorelist (iflist[ifindex], type_name[type_index], NULL))
679 DEBUG ("netlink plugin: ir_read: check_ignorelist (%s, %s, (nil)) "
680 "== TRUE", iflist[ifindex], type_name[type_index]);
684 DEBUG ("netlink plugin: ir_read: querying %s from %s (%i).",
685 type_name[type_index], iflist[ifindex], ifindex);
687 nlh = mnl_nlmsg_put_header (buf);
688 nlh->nlmsg_type = type_id[type_index];
689 nlh->nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
690 nlh->nlmsg_seq = seq = time (NULL);
691 tm = mnl_nlmsg_put_extra_header (nlh, sizeof (*tm));
692 tm->tcm_family = AF_PACKET;
693 tm->tcm_ifindex = ifindex;
695 if (mnl_socket_sendto (nl, nlh, nlh->nlmsg_len) < 0)
697 ERROR ("netlink plugin: ir_read: mnl_socket_sendto failed.");
701 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
704 ret = mnl_cb_run (buf, ret, seq, portid, qos_filter_cb, &ifindex);
705 if (ret <= MNL_CB_STOP)
707 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
711 ERROR ("netlink plugin: ir_read:mnl_socket_recvfrom failed.");
715 } /* for (type_index) */
716 } /* for (if_index) */
721 static int ir_shutdown (void)
725 mnl_socket_close(nl);
730 } /* int ir_shutdown */
732 void module_register (void)
734 plugin_register_config ("netlink", ir_config, config_keys, config_keys_num);
735 plugin_register_init ("netlink", ir_init);
736 plugin_register_read ("netlink", ir_read);
737 plugin_register_shutdown ("netlink", ir_shutdown);
738 } /* void module_register */
741 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :