2 * collectd - src/snmp.c
3 * Copyright (C) 2007-2012 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>
25 #include "utils_complain.h"
29 #include <net-snmp/net-snmp-config.h>
30 #include <net-snmp/net-snmp-includes.h>
33 * Private data structes
40 typedef struct oid_s oid_t;
44 char string[DATA_MAX_NAME_LEN];
47 typedef union instance_u instance_t;
49 struct data_definition_s
51 char *name; /* used to reference this from the `Collect' option */
52 char *type; /* used to find the data_set */
55 char *instance_prefix;
60 struct data_definition_s *next;
62 typedef struct data_definition_s data_definition_t;
64 struct host_definition_s
71 c_complain_t complaint;
73 data_definition_t **data_list;
76 typedef struct host_definition_s host_definition_t;
78 /* These two types are used to cache values in `csnmp_read_table' to handle
80 struct csnmp_list_instances_s
83 char instance[DATA_MAX_NAME_LEN];
84 struct csnmp_list_instances_s *next;
86 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
88 struct csnmp_table_values_s
92 struct csnmp_table_values_s *next;
94 typedef struct csnmp_table_values_s csnmp_table_values_t;
99 static data_definition_t *data_head = NULL;
104 static int csnmp_read_host (user_data_t *ud);
109 static void csnmp_oid_init (oid_t *dst, oid const *src, size_t n)
111 assert (n <= STATIC_ARRAY_LEN (dst->oid));
112 memcpy (dst->oid, src, sizeof (*src) * n);
116 static int csnmp_oid_compare (oid_t const *left, oid_t const *right)
118 return (snmp_oid_compare (left->oid, left->oid_len,
119 right->oid, right->oid_len));
122 static int csnmp_oid_suffix (oid_t *dst, oid_t const *src,
125 /* Make sure "src" is in "root"s subtree. */
126 if (src->oid_len <= root->oid_len)
128 if (snmp_oid_ncompare (root->oid, root->oid_len,
129 src->oid, src->oid_len,
130 /* n = */ root->oid_len) != 0)
133 memset (dst, 0, sizeof (*dst));
134 dst->oid_len = src->oid_len - root->oid_len;
135 memcpy (dst->oid, &src->oid[root->oid_len],
136 dst->oid_len * sizeof (dst->oid[0]));
140 static int csnmp_oid_to_string (char *buffer, size_t buffer_size,
143 char oid_str[MAX_OID_LEN][16];
144 char *oid_str_ptr[MAX_OID_LEN];
147 for (i = 0; i < o->oid_len; i++)
149 ssnprintf (oid_str[i], sizeof (oid_str[i]), "%lu", (unsigned long) o->oid[i]);
150 oid_str_ptr[i] = oid_str[i];
153 return (strjoin (buffer, buffer_size,
154 oid_str_ptr, o->oid_len, /* separator = */ "."));
157 static void csnmp_host_close_session (host_definition_t *host) /* {{{ */
159 if (host->sess_handle == NULL)
162 snmp_sess_close (host->sess_handle);
163 host->sess_handle = NULL;
164 } /* }}} void csnmp_host_close_session */
166 static void csnmp_host_definition_destroy (void *arg) /* {{{ */
168 host_definition_t *hd;
175 if (hd->name != NULL)
177 DEBUG ("snmp plugin: Destroying host definition for host `%s'.",
181 csnmp_host_close_session (hd);
185 sfree (hd->community);
186 sfree (hd->data_list);
189 } /* }}} void csnmp_host_definition_destroy */
191 /* Many functions to handle the configuration. {{{ */
192 /* First there are many functions which do configuration stuff. It's a big
193 * bloated and messy, I'm afraid. */
196 * Callgraph for the config stuff:
198 * +-> call_snmp_init_once
199 * +-> csnmp_config_add_data
200 * ! +-> csnmp_config_add_data_type
201 * ! +-> csnmp_config_add_data_table
202 * ! +-> csnmp_config_add_data_instance
203 * ! +-> csnmp_config_add_data_instance_prefix
204 * ! +-> csnmp_config_add_data_values
205 * +-> csnmp_config_add_host
206 * +-> csnmp_config_add_host_address
207 * +-> csnmp_config_add_host_community
208 * +-> csnmp_config_add_host_version
209 * +-> csnmp_config_add_host_collect
211 static void call_snmp_init_once (void)
213 static int have_init = 0;
216 init_snmp (PACKAGE_NAME);
218 } /* void call_snmp_init_once */
220 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
222 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
224 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
229 dd->type = strdup (ci->values[0].value.string);
230 if (dd->type == NULL)
234 } /* int csnmp_config_add_data_type */
236 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
238 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
240 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
244 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
247 } /* int csnmp_config_add_data_table */
249 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
251 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
253 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
259 /* Instance is an OID */
260 dd->instance.oid.oid_len = MAX_OID_LEN;
262 if (!read_objid (ci->values[0].value.string,
263 dd->instance.oid.oid, &dd->instance.oid.oid_len))
265 ERROR ("snmp plugin: read_objid (%s) failed.",
266 ci->values[0].value.string);
272 /* Instance is a simple string */
273 sstrncpy (dd->instance.string, ci->values[0].value.string,
274 sizeof (dd->instance.string));
278 } /* int csnmp_config_add_data_instance */
280 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
283 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
285 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
291 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
292 "is set to `false'.", dd->name);
296 sfree (dd->instance_prefix);
297 dd->instance_prefix = strdup (ci->values[0].value.string);
298 if (dd->instance_prefix == NULL)
302 } /* int csnmp_config_add_data_instance_prefix */
304 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
308 if (ci->values_num < 1)
310 WARNING ("snmp plugin: `Values' needs at least one argument.");
314 for (i = 0; i < ci->values_num; i++)
315 if (ci->values[i].type != OCONFIG_TYPE_STRING)
317 WARNING ("snmp plugin: `Values' needs only string argument.");
323 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
324 if (dd->values == NULL)
326 dd->values_len = ci->values_num;
328 for (i = 0; i < ci->values_num; i++)
330 dd->values[i].oid_len = MAX_OID_LEN;
332 if (NULL == snmp_parse_oid (ci->values[i].value.string,
333 dd->values[i].oid, &dd->values[i].oid_len))
335 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
336 ci->values[i].value.string);
345 } /* int csnmp_config_add_data_instance */
347 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
349 if ((ci->values_num != 1)
350 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
352 WARNING ("snmp plugin: The `Shift' config option needs exactly one number argument.");
356 dd->shift = ci->values[0].value.number;
359 } /* int csnmp_config_add_data_shift */
361 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
363 if ((ci->values_num != 1)
364 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
366 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
370 dd->scale = ci->values[0].value.number;
373 } /* int csnmp_config_add_data_scale */
375 static int csnmp_config_add_data (oconfig_item_t *ci)
377 data_definition_t *dd;
381 if ((ci->values_num != 1)
382 || (ci->values[0].type != OCONFIG_TYPE_STRING))
384 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
388 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
391 memset (dd, '\0', sizeof (data_definition_t));
393 dd->name = strdup (ci->values[0].value.string);
394 if (dd->name == NULL)
402 for (i = 0; i < ci->children_num; i++)
404 oconfig_item_t *option = ci->children + i;
407 if (strcasecmp ("Type", option->key) == 0)
408 status = csnmp_config_add_data_type (dd, option);
409 else if (strcasecmp ("Table", option->key) == 0)
410 status = csnmp_config_add_data_table (dd, option);
411 else if (strcasecmp ("Instance", option->key) == 0)
412 status = csnmp_config_add_data_instance (dd, option);
413 else if (strcasecmp ("InstancePrefix", option->key) == 0)
414 status = csnmp_config_add_data_instance_prefix (dd, option);
415 else if (strcasecmp ("Values", option->key) == 0)
416 status = csnmp_config_add_data_values (dd, option);
417 else if (strcasecmp ("Shift", option->key) == 0)
418 status = csnmp_config_add_data_shift (dd, option);
419 else if (strcasecmp ("Scale", option->key) == 0)
420 status = csnmp_config_add_data_scale (dd, option);
423 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
429 } /* for (ci->children) */
433 if (dd->type == NULL)
435 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
439 if (dd->values == NULL)
441 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
447 } /* while (status == 0) */
452 sfree (dd->instance_prefix);
458 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
459 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
461 if (data_head == NULL)
465 data_definition_t *last;
467 while (last->next != NULL)
473 } /* int csnmp_config_add_data */
475 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
477 if ((ci->values_num != 1)
478 || (ci->values[0].type != OCONFIG_TYPE_STRING))
480 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
484 if (hd->address == NULL)
487 hd->address = strdup (ci->values[0].value.string);
488 if (hd->address == NULL)
491 DEBUG ("snmp plugin: host = %s; host->address = %s;",
492 hd->name, hd->address);
495 } /* int csnmp_config_add_host_address */
497 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
499 if ((ci->values_num != 1)
500 || (ci->values[0].type != OCONFIG_TYPE_STRING))
502 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
506 if (hd->community == NULL)
507 free (hd->community);
509 hd->community = strdup (ci->values[0].value.string);
510 if (hd->community == NULL)
513 DEBUG ("snmp plugin: host = %s; host->community = %s;",
514 hd->name, hd->community);
517 } /* int csnmp_config_add_host_community */
519 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
523 if ((ci->values_num != 1)
524 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
526 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
530 version = (int) ci->values[0].value.number;
531 if ((version != 1) && (version != 2))
533 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
537 hd->version = version;
540 } /* int csnmp_config_add_host_address */
542 static int csnmp_config_add_host_collect (host_definition_t *host,
545 data_definition_t *data;
546 data_definition_t **data_list;
550 if (ci->values_num < 1)
552 WARNING ("snmp plugin: `Collect' needs at least one argument.");
556 for (i = 0; i < ci->values_num; i++)
557 if (ci->values[i].type != OCONFIG_TYPE_STRING)
559 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
563 data_list_len = host->data_list_len + ci->values_num;
564 data_list = (data_definition_t **) realloc (host->data_list,
565 sizeof (data_definition_t *) * data_list_len);
566 if (data_list == NULL)
568 host->data_list = data_list;
570 for (i = 0; i < ci->values_num; i++)
572 for (data = data_head; data != NULL; data = data->next)
573 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
578 WARNING ("snmp plugin: No such data configured: `%s'",
579 ci->values[i].value.string);
583 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
584 host->name, host->data_list_len, data->name);
586 host->data_list[host->data_list_len] = data;
587 host->data_list_len++;
588 } /* for (values_num) */
591 } /* int csnmp_config_add_host_collect */
593 static int csnmp_config_add_host (oconfig_item_t *ci)
595 host_definition_t *hd;
599 /* Registration stuff. */
600 char cb_name[DATA_MAX_NAME_LEN];
602 struct timespec cb_interval;
604 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
606 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
610 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
613 memset (hd, '\0', sizeof (host_definition_t));
615 C_COMPLAIN_INIT (&hd->complaint);
617 hd->name = strdup (ci->values[0].value.string);
618 if (hd->name == NULL)
624 hd->sess_handle = NULL;
627 for (i = 0; i < ci->children_num; i++)
629 oconfig_item_t *option = ci->children + i;
632 if (strcasecmp ("Address", option->key) == 0)
633 status = csnmp_config_add_host_address (hd, option);
634 else if (strcasecmp ("Community", option->key) == 0)
635 status = csnmp_config_add_host_community (hd, option);
636 else if (strcasecmp ("Version", option->key) == 0)
637 status = csnmp_config_add_host_version (hd, option);
638 else if (strcasecmp ("Collect", option->key) == 0)
639 csnmp_config_add_host_collect (hd, option);
640 else if (strcasecmp ("Interval", option->key) == 0)
641 cf_util_get_cdtime (option, &hd->interval);
644 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
650 } /* for (ci->children) */
654 if (hd->address == NULL)
656 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
660 if (hd->community == NULL)
662 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
668 } /* while (status == 0) */
672 csnmp_host_definition_destroy (hd);
676 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
677 hd->name, hd->address, hd->community, hd->version);
679 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
681 memset (&cb_data, 0, sizeof (cb_data));
683 cb_data.free_func = csnmp_host_definition_destroy;
685 CDTIME_T_TO_TIMESPEC (hd->interval, &cb_interval);
687 status = plugin_register_complex_read (/* group = */ NULL, cb_name,
688 csnmp_read_host, /* interval = */ &cb_interval,
689 /* user_data = */ &cb_data);
692 ERROR ("snmp plugin: Registering complex read function failed.");
693 csnmp_host_definition_destroy (hd);
698 } /* int csnmp_config_add_host */
700 static int csnmp_config (oconfig_item_t *ci)
704 call_snmp_init_once ();
706 for (i = 0; i < ci->children_num; i++)
708 oconfig_item_t *child = ci->children + i;
709 if (strcasecmp ("Data", child->key) == 0)
710 csnmp_config_add_data (child);
711 else if (strcasecmp ("Host", child->key) == 0)
712 csnmp_config_add_host (child);
715 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
717 } /* for (ci->children) */
720 } /* int csnmp_config */
722 /* }}} End of the config stuff. Now the interesting part begins */
724 static void csnmp_host_open_session (host_definition_t *host)
726 struct snmp_session sess;
728 if (host->sess_handle != NULL)
729 csnmp_host_close_session (host);
731 snmp_sess_init (&sess);
732 sess.peername = host->address;
733 sess.community = (u_char *) host->community;
734 sess.community_len = strlen (host->community);
735 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
737 /* snmp_sess_open will copy the `struct snmp_session *'. */
738 host->sess_handle = snmp_sess_open (&sess);
740 if (host->sess_handle == NULL)
744 snmp_error (&sess, NULL, NULL, &errstr);
746 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
747 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
750 } /* void csnmp_host_open_session */
752 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
753 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
754 double scale, double shift)
757 uint64_t tmp_unsigned = 0;
758 int64_t tmp_signed = 0;
760 /* Set to true when the original SNMP type appears to have been signed. */
761 _Bool prefer_signed = 0;
763 if ((vl->type == ASN_INTEGER)
764 || (vl->type == ASN_UINTEGER)
765 || (vl->type == ASN_COUNTER)
767 || (vl->type == ASN_TIMETICKS)
769 || (vl->type == ASN_GAUGE))
771 tmp_unsigned = (uint32_t) *vl->val.integer;
772 tmp_signed = (int32_t) *vl->val.integer;
774 if ((vl->type == ASN_INTEGER)
775 || (vl->type == ASN_GAUGE))
778 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", tmp_unsigned);
780 else if (vl->type == ASN_COUNTER64)
782 tmp_unsigned = (uint32_t) vl->val.counter64->high;
783 tmp_unsigned = tmp_unsigned << 32;
784 tmp_unsigned += (uint32_t) vl->val.counter64->low;
785 tmp_signed = (int64_t) tmp_unsigned;
786 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
788 else if (vl->type == ASN_OCTET_STR)
790 /* We'll handle this later.. */
794 char oid_buffer[1024];
796 memset (oid_buffer, 0, sizeof (oid_buffer));
797 snprint_objid (oid_buffer, sizeof (oid_buffer) - 1,
798 vl->name, vl->name_length);
801 if (vl->type == ASN_NULL)
802 INFO ("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)",
806 WARNING ("snmp plugin: I don't know the ASN type \"%i\" (OID: %s)",
807 (int) vl->type, oid_buffer);
812 if (vl->type == ASN_OCTET_STR)
816 if (vl->val.string != NULL)
819 size_t string_length;
821 string_length = sizeof (string) - 1;
822 if (vl->val_len < string_length)
823 string_length = vl->val_len;
825 /* The strings we get from the Net-SNMP library may not be null
826 * terminated. That is why we're using `memcpy' here and not `strcpy'.
827 * `string_length' is set to `vl->val_len' which holds the length of the
829 memcpy (string, vl->val.string, string_length);
830 string[string_length] = 0;
832 status = parse_value (string, &ret, type);
835 ERROR ("snmp plugin: csnmp_value_list_to_value: Parsing string as %s failed: %s",
836 DS_TYPE_TO_STRING (type), string);
844 case DS_TYPE_COUNTER:
846 case DS_TYPE_ABSOLUTE:
847 memset (&ret, 0, sizeof (ret));
855 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
856 "data source type: %i.", type);
860 } /* if (vl->type == ASN_OCTET_STR) */
861 else if (type == DS_TYPE_COUNTER)
863 ret.counter = tmp_unsigned;
865 else if (type == DS_TYPE_GAUGE)
869 else if (prefer_signed)
870 ret.gauge = (scale * tmp_signed) + shift;
872 ret.gauge = (scale * tmp_unsigned) + shift;
874 else if (type == DS_TYPE_DERIVE)
877 ret.derive = (derive_t) tmp_signed;
879 ret.derive = (derive_t) tmp_unsigned;
881 else if (type == DS_TYPE_ABSOLUTE)
883 ret.absolute = (absolute_t) tmp_unsigned;
887 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
893 } /* value_t csnmp_value_list_to_value */
895 /* Returns true if all OIDs have left their subtree */
896 static int csnmp_check_res_left_subtree (const host_definition_t *host,
897 const data_definition_t *data,
898 struct snmp_pdu *res)
900 struct variable_list *vb;
902 int num_left_subtree;
910 num_left_subtree = 0;
912 /* check all the variables and count how many have left their subtree */
913 for (vb = res->variables, i = 0;
914 (vb != NULL) && (i < data->values_len);
915 vb = vb->next_variable, i++)
919 if ((vb->type == SNMP_ENDOFMIBVIEW)
920 || (snmp_oid_ncompare (data->values[i].oid,
921 data->values[i].oid_len,
922 vb->name, vb->name_length,
923 data->values[i].oid_len) != 0))
927 /* check if enough variables have been returned */
928 if (i < data->values_len)
930 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
931 host->name, data->values_len, i);
935 if (data->instance.oid.oid_len > 0)
939 ERROR ("snmp plugin: host %s: Expected one more variable for "
940 "the instance..", host->name);
945 if (snmp_oid_ncompare (data->instance.oid.oid,
946 data->instance.oid.oid_len,
947 vb->name, vb->name_length,
948 data->instance.oid.oid_len) != 0)
952 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
953 "left their subtree",
954 num_left_subtree, num_checked);
955 if (num_left_subtree >= num_checked)
958 } /* int csnmp_check_res_left_subtree */
960 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
961 const struct variable_list *vb, size_t dst_size)
968 buffer_free = dst_size;
970 for (i = 0; i < vb->val_len; i++)
974 status = snprintf (buffer_ptr, buffer_free,
975 (i == 0) ? "%02x" : ":%02x", (unsigned int) vb->val.bitstring[i]);
977 if (status >= buffer_free)
979 buffer_ptr += (buffer_free - 1);
981 return (dst_size + (buffer_free - status));
983 else /* if (status < buffer_free) */
985 buffer_ptr += status;
986 buffer_free -= status;
990 return ((int) (dst_size - buffer_free));
991 } /* }}} int csnmp_strvbcopy_hexstring */
993 static int csnmp_strvbcopy (char *dst, /* {{{ */
994 const struct variable_list *vb, size_t dst_size)
1000 if (vb->type == ASN_OCTET_STR)
1001 src = (char *) vb->val.string;
1002 else if (vb->type == ASN_BIT_STR)
1003 src = (char *) vb->val.bitstring;
1010 num_chars = dst_size - 1;
1011 if (num_chars > vb->val_len)
1012 num_chars = vb->val_len;
1014 for (i = 0; i < num_chars; i++)
1016 /* Check for control characters. */
1017 if ((unsigned char)src[i] < 32)
1018 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
1023 return ((int) vb->val_len);
1024 } /* }}} int csnmp_strvbcopy */
1026 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
1027 csnmp_list_instances_t **tail,
1028 struct snmp_pdu const *res,
1031 csnmp_list_instances_t *il;
1032 struct variable_list *vb;
1036 /* Set vb on the last variable */
1037 for (vb = res->variables;
1038 (vb != NULL) && (vb->next_variable != NULL);
1039 vb = vb->next_variable)
1044 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1046 il = malloc (sizeof (*il));
1049 ERROR ("snmp plugin: malloc failed.");
1052 memset (il, 0, sizeof (*il));
1055 status = csnmp_oid_suffix (&il->suffix, &vb_name, root);
1062 /* Get instance name */
1063 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
1067 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
1069 for (ptr = il->instance; *ptr != '\0'; ptr++)
1071 if ((*ptr > 0) && (*ptr < 32))
1073 else if (*ptr == '/')
1076 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1080 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
1081 ssnprintf (il->instance, sizeof (il->instance),
1082 "%llu", val.counter);
1085 /* TODO: Debugging output */
1094 } /* int csnmp_instance_list_add */
1096 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1097 csnmp_list_instances_t *instance_list,
1098 csnmp_table_values_t **value_table)
1100 const data_set_t *ds;
1101 value_list_t vl = VALUE_LIST_INIT;
1103 csnmp_list_instances_t *instance_list_ptr;
1104 csnmp_table_values_t **value_table_ptr;
1108 oid_t current_suffix;
1110 ds = plugin_get_ds (data->type);
1113 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1116 assert (ds->ds_num == data->values_len);
1118 instance_list_ptr = instance_list;
1120 value_table_ptr = malloc (sizeof (*value_table_ptr) * data->values_len);
1121 if (value_table_ptr == NULL)
1123 for (i = 0; i < data->values_len; i++)
1124 value_table_ptr[i] = value_table[i];
1126 vl.values_len = ds->ds_num;
1127 vl.values = malloc (sizeof (*vl.values) * vl.values_len);
1128 if (vl.values == NULL)
1130 ERROR ("snmp plugin: malloc failed.");
1131 sfree (value_table_ptr);
1135 sstrncpy (vl.host, host->name, sizeof (vl.host));
1136 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1138 vl.interval = host->interval;
1141 memset (¤t_suffix, 0, sizeof (current_suffix));
1144 _Bool suffix_skipped = 0;
1146 /* Determine next suffix to handle. */
1147 if (instance_list != NULL)
1149 if (instance_list_ptr == NULL)
1155 memcpy (¤t_suffix, &instance_list_ptr->suffix, sizeof (current_suffix));
1157 else /* no instance configured */
1159 csnmp_table_values_t *ptr = value_table_ptr[0];
1166 memcpy (¤t_suffix, &ptr->suffix, sizeof (current_suffix));
1169 /* Update all the value_table_ptr to point at the entry with the same
1170 * trailing partial OID */
1171 for (i = 0; i < data->values_len; i++)
1173 while ((value_table_ptr[i] != NULL)
1174 && (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) < 0))
1175 value_table_ptr[i] = value_table_ptr[i]->next;
1177 if (value_table_ptr[i] == NULL)
1182 else if (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) > 0)
1184 /* This suffix is missing in the subtree. Indicate this with the
1185 * "suffix_skipped" flag and try the next instance / suffix. */
1189 } /* for (i = 0; i < columns; i++) */
1194 /* Matching the values failed. Start from the beginning again. */
1197 if (instance_list != NULL)
1198 instance_list_ptr = instance_list_ptr->next;
1200 value_table_ptr[0] = value_table_ptr[0]->next;
1205 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1206 * to the same subid. instance_list_ptr is either NULL or points to the
1207 * same subid, too. */
1209 for (i = 1; i < data->values_len; i++)
1211 assert (value_table_ptr[i] != NULL);
1212 assert (csnmp_oid_compare (&value_table_ptr[i-1]->suffix,
1213 &value_table_ptr[i]->suffix) == 0);
1215 assert ((instance_list_ptr == NULL)
1216 || (csnmp_oid_compare (&instance_list_ptr->suffix,
1217 &value_table_ptr[0]->suffix) == 0));
1220 sstrncpy (vl.type, data->type, sizeof (vl.type));
1223 char temp[DATA_MAX_NAME_LEN];
1225 if (instance_list_ptr == NULL)
1226 csnmp_oid_to_string (temp, sizeof (temp), ¤t_suffix);
1228 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1230 if (data->instance_prefix == NULL)
1231 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1233 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1234 data->instance_prefix, temp);
1237 for (i = 0; i < data->values_len; i++)
1238 vl.values[i] = value_table_ptr[i]->value;
1240 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1241 plugin_dispatch_values (&vl);
1243 if (instance_list != NULL)
1244 instance_list_ptr = instance_list_ptr->next;
1246 value_table_ptr[0] = value_table_ptr[0]->next;
1247 } /* while (have_more) */
1250 sfree (value_table_ptr);
1253 } /* int csnmp_dispatch_table */
1255 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1257 struct snmp_pdu *req;
1258 struct snmp_pdu *res;
1259 struct variable_list *vb;
1261 const data_set_t *ds;
1263 uint32_t oid_list_len;
1268 /* `value_list_head' and `value_list_tail' implement a linked list for each
1269 * value. `instance_list_head' and `instance_list_tail' implement a linked list of
1270 * instance names. This is used to jump gaps in the table. */
1271 csnmp_list_instances_t *instance_list_head;
1272 csnmp_list_instances_t *instance_list_tail;
1273 csnmp_table_values_t **value_list_head;
1274 csnmp_table_values_t **value_list_tail;
1276 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1277 host->name, data->name);
1279 if (host->sess_handle == NULL)
1281 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1285 ds = plugin_get_ds (data->type);
1288 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1292 if (ds->ds_num != data->values_len)
1294 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1295 data->type, ds->ds_num, data->values_len);
1299 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1300 oid_list_len = data->values_len + 1;
1301 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1302 if (oid_list == NULL)
1304 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1307 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1308 if (data->instance.oid.oid_len > 0)
1309 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1313 /* We're going to construct n linked lists, one for each "value".
1314 * value_list_head will contain pointers to the heads of these linked lists,
1315 * value_list_tail will contain pointers to the tail of the lists. */
1316 value_list_head = calloc (data->values_len, sizeof (*value_list_head));
1317 value_list_tail = calloc (data->values_len, sizeof (*value_list_tail));
1318 if ((value_list_head == NULL) || (value_list_tail == NULL))
1320 ERROR ("snmp plugin: csnmp_read_table: calloc failed.");
1322 sfree (value_list_head);
1323 sfree (value_list_tail);
1327 instance_list_head = NULL;
1328 instance_list_tail = NULL;
1333 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1336 ERROR ("snmp plugin: snmp_pdu_create failed.");
1341 for (i = 0; (uint32_t) i < oid_list_len; i++)
1342 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1345 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1347 if ((status != STAT_SUCCESS) || (res == NULL))
1349 char *errstr = NULL;
1351 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1353 c_complain (LOG_ERR, &host->complaint,
1354 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1355 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1358 snmp_free_pdu (res);
1362 csnmp_host_close_session (host);
1368 assert (res != NULL);
1369 c_release (LOG_INFO, &host->complaint,
1370 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1373 vb = res->variables;
1380 /* Check if all values (and possibly the instance) have left their
1382 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1388 /* Copy the OID of the value used as instance to oid_list, if an instance
1390 if (data->instance.oid.oid_len > 0)
1392 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1393 * add it to the list */
1394 if (csnmp_instance_list_add (&instance_list_head, &instance_list_tail,
1395 res, &data->instance.oid) != 0)
1397 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1402 /* The instance OID is added to the list of OIDs to GET from the
1403 * snmp agent last, so set vb on the last variable returned and copy
1405 for (vb = res->variables;
1406 (vb != NULL) && (vb->next_variable != NULL);
1407 vb = vb->next_variable)
1409 assert (vb != NULL);
1411 /* Copy the OID of the instance value to oid_list[data->values_len].
1412 * "oid_list" is used for the next GETNEXT request. */
1413 memcpy (oid_list[data->values_len].oid, vb->name,
1414 sizeof (oid) * vb->name_length);
1415 oid_list[data->values_len].oid_len = vb->name_length;
1418 /* Iterate over all the (non-instance) values returned by the agent. The
1419 * (i < value_len) check will make sure we're not handling the instance OID
1421 for (vb = res->variables, i = 0;
1422 (vb != NULL) && (i < data->values_len);
1423 vb = vb->next_variable, i++)
1425 csnmp_table_values_t *vt;
1429 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1431 /* Calculate the current suffix. This is later used to check that the
1432 * suffix is increasing. This also checks if we left the subtree */
1433 status = csnmp_oid_suffix (&suffix, &vb_name, data->values + i);
1436 DEBUG ("snmp plugin: host = %s; data = %s; Value %i failed. "
1437 "It probably left its subtree.",
1438 host->name, data->name, i);
1442 /* Make sure the OIDs returned by the agent are increasing. Otherwise our
1443 * table matching algorithm will get confused. */
1444 if ((value_list_tail[i] != NULL)
1445 && (csnmp_oid_compare (&suffix, &value_list_tail[i]->suffix) <= 0))
1447 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1448 "Suffix is not increasing.",
1449 host->name, data->name, i);
1453 vt = malloc (sizeof (*vt));
1456 ERROR ("snmp plugin: malloc failed.");
1460 memset (vt, 0, sizeof (*vt));
1462 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1463 data->scale, data->shift);
1464 memcpy (&vt->suffix, &suffix, sizeof (vt->suffix));
1467 if (value_list_tail[i] == NULL)
1468 value_list_head[i] = vt;
1470 value_list_tail[i]->next = vt;
1471 value_list_tail[i] = vt;
1473 /* Copy OID to oid_list[i + 1] */
1474 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1475 oid_list[i].oid_len = vb->name_length;
1476 } /* for (i = data->values_len) */
1479 snmp_free_pdu (res);
1481 } /* while (status == 0) */
1484 snmp_free_pdu (res);
1488 csnmp_dispatch_table (host, data, instance_list_head, value_list_head);
1490 /* Free all allocated variables here */
1491 while (instance_list_head != NULL)
1493 csnmp_list_instances_t *next = instance_list_head->next;
1494 sfree (instance_list_head);
1495 instance_list_head = next;
1498 for (i = 0; i < data->values_len; i++)
1500 while (value_list_head[i] != NULL)
1502 csnmp_table_values_t *next = value_list_head[i]->next;
1503 sfree (value_list_head[i]);
1504 value_list_head[i] = next;
1508 sfree (value_list_head);
1509 sfree (value_list_tail);
1513 } /* int csnmp_read_table */
1515 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1517 struct snmp_pdu *req;
1518 struct snmp_pdu *res;
1519 struct variable_list *vb;
1521 const data_set_t *ds;
1522 value_list_t vl = VALUE_LIST_INIT;
1527 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1528 host->name, data->name);
1530 if (host->sess_handle == NULL)
1532 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1536 ds = plugin_get_ds (data->type);
1539 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1543 if (ds->ds_num != data->values_len)
1545 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1546 data->type, ds->ds_num, data->values_len);
1550 vl.values_len = ds->ds_num;
1551 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1552 if (vl.values == NULL)
1554 for (i = 0; i < vl.values_len; i++)
1556 if (ds->ds[i].type == DS_TYPE_COUNTER)
1557 vl.values[i].counter = 0;
1559 vl.values[i].gauge = NAN;
1562 sstrncpy (vl.host, host->name, sizeof (vl.host));
1563 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1564 sstrncpy (vl.type, data->type, sizeof (vl.type));
1565 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1567 vl.interval = host->interval;
1569 req = snmp_pdu_create (SNMP_MSG_GET);
1572 ERROR ("snmp plugin: snmp_pdu_create failed.");
1577 for (i = 0; i < data->values_len; i++)
1578 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1581 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1583 if ((status != STAT_SUCCESS) || (res == NULL))
1585 char *errstr = NULL;
1587 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1588 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1589 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1592 snmp_free_pdu (res);
1596 csnmp_host_close_session (host);
1602 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1606 snprint_variable (buffer, sizeof (buffer),
1607 vb->name, vb->name_length, vb);
1608 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1609 #endif /* COLLECT_DEBUG */
1611 for (i = 0; i < data->values_len; i++)
1612 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1613 vb->name, vb->name_length) == 0)
1614 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1615 data->scale, data->shift);
1616 } /* for (res->variables) */
1619 snmp_free_pdu (res);
1622 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1623 plugin_dispatch_values (&vl);
1627 } /* int csnmp_read_value */
1629 static int csnmp_read_host (user_data_t *ud)
1631 host_definition_t *host;
1632 cdtime_t time_start;
1640 if (host->interval == 0)
1641 host->interval = interval_g;
1643 time_start = cdtime ();
1645 if (host->sess_handle == NULL)
1646 csnmp_host_open_session (host);
1648 if (host->sess_handle == NULL)
1652 for (i = 0; i < host->data_list_len; i++)
1654 data_definition_t *data = host->data_list[i];
1657 status = csnmp_read_table (host, data);
1659 status = csnmp_read_value (host, data);
1665 time_end = cdtime ();
1666 if ((time_end - time_start) > host->interval)
1668 WARNING ("snmp plugin: Host `%s' should be queried every %.3f "
1669 "seconds, but reading all values takes %.3f seconds.",
1671 CDTIME_T_TO_DOUBLE (host->interval),
1672 CDTIME_T_TO_DOUBLE (time_end - time_start));
1679 } /* int csnmp_read_host */
1681 static int csnmp_init (void)
1683 call_snmp_init_once ();
1686 } /* int csnmp_init */
1688 static int csnmp_shutdown (void)
1690 data_definition_t *data_this;
1691 data_definition_t *data_next;
1693 /* When we get here, the read threads have been stopped and all the
1694 * `host_definition_t' will be freed. */
1695 DEBUG ("snmp plugin: Destroying all data definitions.");
1697 data_this = data_head;
1699 while (data_this != NULL)
1701 data_next = data_this->next;
1703 sfree (data_this->name);
1704 sfree (data_this->type);
1705 sfree (data_this->values);
1708 data_this = data_next;
1712 } /* int csnmp_shutdown */
1714 void module_register (void)
1716 plugin_register_complex_config ("snmp", csnmp_config);
1717 plugin_register_init ("snmp", csnmp_init);
1718 plugin_register_shutdown ("snmp", csnmp_shutdown);
1719 } /* void module_register */
1722 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker