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,
755 const char *host_name, const char *data_name)
758 uint64_t tmp_unsigned = 0;
759 int64_t tmp_signed = 0;
761 /* Set to true when the original SNMP type appears to have been signed. */
762 _Bool prefer_signed = 0;
764 if ((vl->type == ASN_INTEGER)
765 || (vl->type == ASN_UINTEGER)
766 || (vl->type == ASN_COUNTER)
768 || (vl->type == ASN_TIMETICKS)
770 || (vl->type == ASN_GAUGE))
772 tmp_unsigned = (uint32_t) *vl->val.integer;
773 tmp_signed = (int32_t) *vl->val.integer;
775 if ((vl->type == ASN_INTEGER)
776 || (vl->type == ASN_GAUGE))
779 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", tmp_unsigned);
781 else if (vl->type == ASN_COUNTER64)
783 tmp_unsigned = (uint32_t) vl->val.counter64->high;
784 tmp_unsigned = tmp_unsigned << 32;
785 tmp_unsigned += (uint32_t) vl->val.counter64->low;
786 tmp_signed = (int64_t) tmp_unsigned;
787 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
789 else if (vl->type == ASN_OCTET_STR)
791 /* We'll handle this later.. */
795 char oid_buffer[1024];
797 memset (oid_buffer, 0, sizeof (oid_buffer));
798 snprint_objid (oid_buffer, sizeof (oid_buffer) - 1,
799 vl->name, vl->name_length);
802 if (vl->type == ASN_NULL)
803 INFO ("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)",
807 WARNING ("snmp plugin: I don't know the ASN type #%i "
808 "(OID: \"%s\", data block \"%s\", host block \"%s\")",
809 (int) vl->type, oid_buffer,
810 (data_name != NULL) ? data_name : "UNKNOWN",
811 (host_name != NULL) ? host_name : "UNKNOWN");
816 if (vl->type == ASN_OCTET_STR)
820 if (vl->val.string != NULL)
823 size_t string_length;
825 string_length = sizeof (string) - 1;
826 if (vl->val_len < string_length)
827 string_length = vl->val_len;
829 /* The strings we get from the Net-SNMP library may not be null
830 * terminated. That is why we're using `memcpy' here and not `strcpy'.
831 * `string_length' is set to `vl->val_len' which holds the length of the
833 memcpy (string, vl->val.string, string_length);
834 string[string_length] = 0;
836 status = parse_value (string, &ret, type);
839 ERROR ("snmp plugin: csnmp_value_list_to_value: Parsing string as %s failed: %s",
840 DS_TYPE_TO_STRING (type), string);
848 case DS_TYPE_COUNTER:
850 case DS_TYPE_ABSOLUTE:
851 memset (&ret, 0, sizeof (ret));
859 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
860 "data source type: %i.", type);
864 } /* if (vl->type == ASN_OCTET_STR) */
865 else if (type == DS_TYPE_COUNTER)
867 ret.counter = tmp_unsigned;
869 else if (type == DS_TYPE_GAUGE)
873 else if (prefer_signed)
874 ret.gauge = (scale * tmp_signed) + shift;
876 ret.gauge = (scale * tmp_unsigned) + shift;
878 else if (type == DS_TYPE_DERIVE)
881 ret.derive = (derive_t) tmp_signed;
883 ret.derive = (derive_t) tmp_unsigned;
885 else if (type == DS_TYPE_ABSOLUTE)
887 ret.absolute = (absolute_t) tmp_unsigned;
891 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
897 } /* value_t csnmp_value_list_to_value */
899 /* Returns true if all OIDs have left their subtree */
900 static int csnmp_check_res_left_subtree (const host_definition_t *host,
901 const data_definition_t *data,
902 struct snmp_pdu *res)
904 struct variable_list *vb;
906 int num_left_subtree;
914 num_left_subtree = 0;
916 /* check all the variables and count how many have left their subtree */
917 for (vb = res->variables, i = 0;
918 (vb != NULL) && (i < data->values_len);
919 vb = vb->next_variable, i++)
923 if ((vb->type == SNMP_ENDOFMIBVIEW)
924 || (snmp_oid_ncompare (data->values[i].oid,
925 data->values[i].oid_len,
926 vb->name, vb->name_length,
927 data->values[i].oid_len) != 0))
931 /* check if enough variables have been returned */
932 if (i < data->values_len)
934 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
935 host->name, data->values_len, i);
939 if (data->instance.oid.oid_len > 0)
943 ERROR ("snmp plugin: host %s: Expected one more variable for "
944 "the instance..", host->name);
949 if (snmp_oid_ncompare (data->instance.oid.oid,
950 data->instance.oid.oid_len,
951 vb->name, vb->name_length,
952 data->instance.oid.oid_len) != 0)
956 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
957 "left their subtree",
958 num_left_subtree, num_checked);
959 if (num_left_subtree >= num_checked)
962 } /* int csnmp_check_res_left_subtree */
964 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
965 const struct variable_list *vb, size_t dst_size)
972 buffer_free = dst_size;
974 for (i = 0; i < vb->val_len; i++)
978 status = snprintf (buffer_ptr, buffer_free,
979 (i == 0) ? "%02x" : ":%02x", (unsigned int) vb->val.bitstring[i]);
981 if (status >= buffer_free)
983 buffer_ptr += (buffer_free - 1);
985 return (dst_size + (buffer_free - status));
987 else /* if (status < buffer_free) */
989 buffer_ptr += status;
990 buffer_free -= status;
994 return ((int) (dst_size - buffer_free));
995 } /* }}} int csnmp_strvbcopy_hexstring */
997 static int csnmp_strvbcopy (char *dst, /* {{{ */
998 const struct variable_list *vb, size_t dst_size)
1004 if (vb->type == ASN_OCTET_STR)
1005 src = (char *) vb->val.string;
1006 else if (vb->type == ASN_BIT_STR)
1007 src = (char *) vb->val.bitstring;
1014 num_chars = dst_size - 1;
1015 if (num_chars > vb->val_len)
1016 num_chars = vb->val_len;
1018 for (i = 0; i < num_chars; i++)
1020 /* Check for control characters. */
1021 if ((unsigned char)src[i] < 32)
1022 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
1027 return ((int) vb->val_len);
1028 } /* }}} int csnmp_strvbcopy */
1030 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
1031 csnmp_list_instances_t **tail,
1032 const struct snmp_pdu *res,
1033 const host_definition_t *hd, const data_definition_t *dd)
1035 csnmp_list_instances_t *il;
1036 struct variable_list *vb;
1040 /* Set vb on the last variable */
1041 for (vb = res->variables;
1042 (vb != NULL) && (vb->next_variable != NULL);
1043 vb = vb->next_variable)
1048 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1050 il = malloc (sizeof (*il));
1053 ERROR ("snmp plugin: malloc failed.");
1056 memset (il, 0, sizeof (*il));
1059 status = csnmp_oid_suffix (&il->suffix, &vb_name, &dd->instance.oid);
1066 /* Get instance name */
1067 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
1071 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
1073 for (ptr = il->instance; *ptr != '\0'; ptr++)
1075 if ((*ptr > 0) && (*ptr < 32))
1077 else if (*ptr == '/')
1080 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1084 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER,
1085 /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1086 ssnprintf (il->instance, sizeof (il->instance),
1087 "%llu", val.counter);
1090 /* TODO: Debugging output */
1099 } /* int csnmp_instance_list_add */
1101 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1102 csnmp_list_instances_t *instance_list,
1103 csnmp_table_values_t **value_table)
1105 const data_set_t *ds;
1106 value_list_t vl = VALUE_LIST_INIT;
1108 csnmp_list_instances_t *instance_list_ptr;
1109 csnmp_table_values_t **value_table_ptr;
1113 oid_t current_suffix;
1115 ds = plugin_get_ds (data->type);
1118 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1121 assert (ds->ds_num == data->values_len);
1123 instance_list_ptr = instance_list;
1125 value_table_ptr = malloc (sizeof (*value_table_ptr) * data->values_len);
1126 if (value_table_ptr == NULL)
1128 for (i = 0; i < data->values_len; i++)
1129 value_table_ptr[i] = value_table[i];
1131 vl.values_len = ds->ds_num;
1132 vl.values = malloc (sizeof (*vl.values) * vl.values_len);
1133 if (vl.values == NULL)
1135 ERROR ("snmp plugin: malloc failed.");
1136 sfree (value_table_ptr);
1140 sstrncpy (vl.host, host->name, sizeof (vl.host));
1141 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1143 vl.interval = host->interval;
1146 memset (¤t_suffix, 0, sizeof (current_suffix));
1149 _Bool suffix_skipped = 0;
1151 /* Determine next suffix to handle. */
1152 if (instance_list != NULL)
1154 if (instance_list_ptr == NULL)
1160 memcpy (¤t_suffix, &instance_list_ptr->suffix, sizeof (current_suffix));
1162 else /* no instance configured */
1164 csnmp_table_values_t *ptr = value_table_ptr[0];
1171 memcpy (¤t_suffix, &ptr->suffix, sizeof (current_suffix));
1174 /* Update all the value_table_ptr to point at the entry with the same
1175 * trailing partial OID */
1176 for (i = 0; i < data->values_len; i++)
1178 while ((value_table_ptr[i] != NULL)
1179 && (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) < 0))
1180 value_table_ptr[i] = value_table_ptr[i]->next;
1182 if (value_table_ptr[i] == NULL)
1187 else if (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) > 0)
1189 /* This suffix is missing in the subtree. Indicate this with the
1190 * "suffix_skipped" flag and try the next instance / suffix. */
1194 } /* for (i = 0; i < columns; i++) */
1199 /* Matching the values failed. Start from the beginning again. */
1202 if (instance_list != NULL)
1203 instance_list_ptr = instance_list_ptr->next;
1205 value_table_ptr[0] = value_table_ptr[0]->next;
1210 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1211 * to the same subid. instance_list_ptr is either NULL or points to the
1212 * same subid, too. */
1214 for (i = 1; i < data->values_len; i++)
1216 assert (value_table_ptr[i] != NULL);
1217 assert (csnmp_oid_compare (&value_table_ptr[i-1]->suffix,
1218 &value_table_ptr[i]->suffix) == 0);
1220 assert ((instance_list_ptr == NULL)
1221 || (csnmp_oid_compare (&instance_list_ptr->suffix,
1222 &value_table_ptr[0]->suffix) == 0));
1225 sstrncpy (vl.type, data->type, sizeof (vl.type));
1228 char temp[DATA_MAX_NAME_LEN];
1230 if (instance_list_ptr == NULL)
1231 csnmp_oid_to_string (temp, sizeof (temp), ¤t_suffix);
1233 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1235 if (data->instance_prefix == NULL)
1236 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1238 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1239 data->instance_prefix, temp);
1242 for (i = 0; i < data->values_len; i++)
1243 vl.values[i] = value_table_ptr[i]->value;
1245 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1246 plugin_dispatch_values (&vl);
1248 if (instance_list != NULL)
1249 instance_list_ptr = instance_list_ptr->next;
1251 value_table_ptr[0] = value_table_ptr[0]->next;
1252 } /* while (have_more) */
1255 sfree (value_table_ptr);
1258 } /* int csnmp_dispatch_table */
1260 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1262 struct snmp_pdu *req;
1263 struct snmp_pdu *res;
1264 struct variable_list *vb;
1266 const data_set_t *ds;
1268 uint32_t oid_list_len;
1273 /* `value_list_head' and `value_list_tail' implement a linked list for each
1274 * value. `instance_list_head' and `instance_list_tail' implement a linked list of
1275 * instance names. This is used to jump gaps in the table. */
1276 csnmp_list_instances_t *instance_list_head;
1277 csnmp_list_instances_t *instance_list_tail;
1278 csnmp_table_values_t **value_list_head;
1279 csnmp_table_values_t **value_list_tail;
1281 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1282 host->name, data->name);
1284 if (host->sess_handle == NULL)
1286 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1290 ds = plugin_get_ds (data->type);
1293 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1297 if (ds->ds_num != data->values_len)
1299 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1300 data->type, ds->ds_num, data->values_len);
1304 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1305 oid_list_len = data->values_len + 1;
1306 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1307 if (oid_list == NULL)
1309 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1312 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1313 if (data->instance.oid.oid_len > 0)
1314 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1318 /* We're going to construct n linked lists, one for each "value".
1319 * value_list_head will contain pointers to the heads of these linked lists,
1320 * value_list_tail will contain pointers to the tail of the lists. */
1321 value_list_head = calloc (data->values_len, sizeof (*value_list_head));
1322 value_list_tail = calloc (data->values_len, sizeof (*value_list_tail));
1323 if ((value_list_head == NULL) || (value_list_tail == NULL))
1325 ERROR ("snmp plugin: csnmp_read_table: calloc failed.");
1327 sfree (value_list_head);
1328 sfree (value_list_tail);
1332 instance_list_head = NULL;
1333 instance_list_tail = NULL;
1338 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1341 ERROR ("snmp plugin: snmp_pdu_create failed.");
1346 for (i = 0; (uint32_t) i < oid_list_len; i++)
1347 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1350 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1352 if ((status != STAT_SUCCESS) || (res == NULL))
1354 char *errstr = NULL;
1356 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1358 c_complain (LOG_ERR, &host->complaint,
1359 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1360 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1363 snmp_free_pdu (res);
1367 csnmp_host_close_session (host);
1373 assert (res != NULL);
1374 c_release (LOG_INFO, &host->complaint,
1375 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1378 vb = res->variables;
1385 /* Check if all values (and possibly the instance) have left their
1387 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1393 /* Copy the OID of the value used as instance to oid_list, if an instance
1395 if (data->instance.oid.oid_len > 0)
1397 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1398 * add it to the list */
1399 if (csnmp_instance_list_add (&instance_list_head, &instance_list_tail,
1400 res, host, data) != 0)
1402 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1407 /* The instance OID is added to the list of OIDs to GET from the
1408 * snmp agent last, so set vb on the last variable returned and copy
1410 for (vb = res->variables;
1411 (vb != NULL) && (vb->next_variable != NULL);
1412 vb = vb->next_variable)
1414 assert (vb != NULL);
1416 /* Copy the OID of the instance value to oid_list[data->values_len].
1417 * "oid_list" is used for the next GETNEXT request. */
1418 memcpy (oid_list[data->values_len].oid, vb->name,
1419 sizeof (oid) * vb->name_length);
1420 oid_list[data->values_len].oid_len = vb->name_length;
1423 /* Iterate over all the (non-instance) values returned by the agent. The
1424 * (i < value_len) check will make sure we're not handling the instance OID
1426 for (vb = res->variables, i = 0;
1427 (vb != NULL) && (i < data->values_len);
1428 vb = vb->next_variable, i++)
1430 csnmp_table_values_t *vt;
1434 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1436 /* Calculate the current suffix. This is later used to check that the
1437 * suffix is increasing. This also checks if we left the subtree */
1438 status = csnmp_oid_suffix (&suffix, &vb_name, data->values + i);
1441 DEBUG ("snmp plugin: host = %s; data = %s; Value %i failed. "
1442 "It probably left its subtree.",
1443 host->name, data->name, i);
1447 /* Make sure the OIDs returned by the agent are increasing. Otherwise our
1448 * table matching algorithm will get confused. */
1449 if ((value_list_tail[i] != NULL)
1450 && (csnmp_oid_compare (&suffix, &value_list_tail[i]->suffix) <= 0))
1452 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1453 "Suffix is not increasing.",
1454 host->name, data->name, i);
1458 vt = malloc (sizeof (*vt));
1461 ERROR ("snmp plugin: malloc failed.");
1465 memset (vt, 0, sizeof (*vt));
1467 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1468 data->scale, data->shift, host->name, data->name);
1469 memcpy (&vt->suffix, &suffix, sizeof (vt->suffix));
1472 if (value_list_tail[i] == NULL)
1473 value_list_head[i] = vt;
1475 value_list_tail[i]->next = vt;
1476 value_list_tail[i] = vt;
1478 /* Copy OID to oid_list[i + 1] */
1479 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1480 oid_list[i].oid_len = vb->name_length;
1481 } /* for (i = data->values_len) */
1484 snmp_free_pdu (res);
1486 } /* while (status == 0) */
1489 snmp_free_pdu (res);
1493 csnmp_dispatch_table (host, data, instance_list_head, value_list_head);
1495 /* Free all allocated variables here */
1496 while (instance_list_head != NULL)
1498 csnmp_list_instances_t *next = instance_list_head->next;
1499 sfree (instance_list_head);
1500 instance_list_head = next;
1503 for (i = 0; i < data->values_len; i++)
1505 while (value_list_head[i] != NULL)
1507 csnmp_table_values_t *next = value_list_head[i]->next;
1508 sfree (value_list_head[i]);
1509 value_list_head[i] = next;
1513 sfree (value_list_head);
1514 sfree (value_list_tail);
1518 } /* int csnmp_read_table */
1520 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1522 struct snmp_pdu *req;
1523 struct snmp_pdu *res;
1524 struct variable_list *vb;
1526 const data_set_t *ds;
1527 value_list_t vl = VALUE_LIST_INIT;
1532 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1533 host->name, data->name);
1535 if (host->sess_handle == NULL)
1537 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1541 ds = plugin_get_ds (data->type);
1544 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1548 if (ds->ds_num != data->values_len)
1550 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1551 data->type, ds->ds_num, data->values_len);
1555 vl.values_len = ds->ds_num;
1556 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1557 if (vl.values == NULL)
1559 for (i = 0; i < vl.values_len; i++)
1561 if (ds->ds[i].type == DS_TYPE_COUNTER)
1562 vl.values[i].counter = 0;
1564 vl.values[i].gauge = NAN;
1567 sstrncpy (vl.host, host->name, sizeof (vl.host));
1568 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1569 sstrncpy (vl.type, data->type, sizeof (vl.type));
1570 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1572 vl.interval = host->interval;
1574 req = snmp_pdu_create (SNMP_MSG_GET);
1577 ERROR ("snmp plugin: snmp_pdu_create failed.");
1582 for (i = 0; i < data->values_len; i++)
1583 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1586 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1588 if ((status != STAT_SUCCESS) || (res == NULL))
1590 char *errstr = NULL;
1592 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1593 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1594 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1597 snmp_free_pdu (res);
1601 csnmp_host_close_session (host);
1607 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1611 snprint_variable (buffer, sizeof (buffer),
1612 vb->name, vb->name_length, vb);
1613 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1614 #endif /* COLLECT_DEBUG */
1616 for (i = 0; i < data->values_len; i++)
1617 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1618 vb->name, vb->name_length) == 0)
1619 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1620 data->scale, data->shift, host->name, data->name);
1621 } /* for (res->variables) */
1624 snmp_free_pdu (res);
1627 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1628 plugin_dispatch_values (&vl);
1632 } /* int csnmp_read_value */
1634 static int csnmp_read_host (user_data_t *ud)
1636 host_definition_t *host;
1637 cdtime_t time_start;
1645 if (host->interval == 0)
1646 host->interval = interval_g;
1648 time_start = cdtime ();
1650 if (host->sess_handle == NULL)
1651 csnmp_host_open_session (host);
1653 if (host->sess_handle == NULL)
1657 for (i = 0; i < host->data_list_len; i++)
1659 data_definition_t *data = host->data_list[i];
1662 status = csnmp_read_table (host, data);
1664 status = csnmp_read_value (host, data);
1670 time_end = cdtime ();
1671 if ((time_end - time_start) > host->interval)
1673 WARNING ("snmp plugin: Host `%s' should be queried every %.3f "
1674 "seconds, but reading all values takes %.3f seconds.",
1676 CDTIME_T_TO_DOUBLE (host->interval),
1677 CDTIME_T_TO_DOUBLE (time_end - time_start));
1684 } /* int csnmp_read_host */
1686 static int csnmp_init (void)
1688 call_snmp_init_once ();
1691 } /* int csnmp_init */
1693 static int csnmp_shutdown (void)
1695 data_definition_t *data_this;
1696 data_definition_t *data_next;
1698 /* When we get here, the read threads have been stopped and all the
1699 * `host_definition_t' will be freed. */
1700 DEBUG ("snmp plugin: Destroying all data definitions.");
1702 data_this = data_head;
1704 while (data_this != NULL)
1706 data_next = data_this->next;
1708 sfree (data_this->name);
1709 sfree (data_this->type);
1710 sfree (data_this->values);
1713 data_this = data_next;
1717 } /* int csnmp_shutdown */
1719 void module_register (void)
1721 plugin_register_complex_config ("snmp", csnmp_config);
1722 plugin_register_init ("snmp", csnmp_init);
1723 plugin_register_shutdown ("snmp", csnmp_shutdown);
1724 } /* void module_register */
1727 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker