2 * collectd - src/snmp.c
3 * Copyright (C) 2007 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
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_host_close_session (host_definition_t *host) /* {{{ */
111 if (host->sess_handle == NULL)
114 snmp_sess_close (host->sess_handle);
115 host->sess_handle = NULL;
116 } /* }}} void csnmp_host_close_session */
118 static void csnmp_host_definition_destroy (void *arg) /* {{{ */
120 host_definition_t *hd;
127 if (hd->name != NULL)
129 DEBUG ("snmp plugin: Destroying host definition for host `%s'.",
133 csnmp_host_close_session (hd);
137 sfree (hd->community);
138 sfree (hd->data_list);
141 } /* }}} void csnmp_host_definition_destroy */
143 /* Many functions to handle the configuration. {{{ */
144 /* First there are many functions which do configuration stuff. It's a big
145 * bloated and messy, I'm afraid. */
148 * Callgraph for the config stuff:
150 * +-> call_snmp_init_once
151 * +-> csnmp_config_add_data
152 * ! +-> csnmp_config_add_data_type
153 * ! +-> csnmp_config_add_data_table
154 * ! +-> csnmp_config_add_data_instance
155 * ! +-> csnmp_config_add_data_instance_prefix
156 * ! +-> csnmp_config_add_data_values
157 * +-> csnmp_config_add_host
158 * +-> csnmp_config_add_host_address
159 * +-> csnmp_config_add_host_community
160 * +-> csnmp_config_add_host_version
161 * +-> csnmp_config_add_host_collect
162 * +-> csnmp_config_add_host_interval
164 static void call_snmp_init_once (void)
166 static int have_init = 0;
169 init_snmp (PACKAGE_NAME);
171 } /* void call_snmp_init_once */
173 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
175 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
177 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
182 dd->type = strdup (ci->values[0].value.string);
183 if (dd->type == NULL)
187 } /* int csnmp_config_add_data_type */
189 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
191 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
193 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
197 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
200 } /* int csnmp_config_add_data_table */
202 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
204 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
206 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
212 /* Instance is an OID */
213 dd->instance.oid.oid_len = MAX_OID_LEN;
215 if (!read_objid (ci->values[0].value.string,
216 dd->instance.oid.oid, &dd->instance.oid.oid_len))
218 ERROR ("snmp plugin: read_objid (%s) failed.",
219 ci->values[0].value.string);
225 /* Instance is a simple string */
226 sstrncpy (dd->instance.string, ci->values[0].value.string,
227 sizeof (dd->instance.string));
231 } /* int csnmp_config_add_data_instance */
233 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
236 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
238 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
244 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
245 "is set to `false'.", dd->name);
249 sfree (dd->instance_prefix);
250 dd->instance_prefix = strdup (ci->values[0].value.string);
251 if (dd->instance_prefix == NULL)
255 } /* int csnmp_config_add_data_instance_prefix */
257 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
261 if (ci->values_num < 1)
263 WARNING ("snmp plugin: `Values' needs at least one argument.");
267 for (i = 0; i < ci->values_num; i++)
268 if (ci->values[i].type != OCONFIG_TYPE_STRING)
270 WARNING ("snmp plugin: `Values' needs only string argument.");
276 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
277 if (dd->values == NULL)
279 dd->values_len = ci->values_num;
281 for (i = 0; i < ci->values_num; i++)
283 dd->values[i].oid_len = MAX_OID_LEN;
285 if (NULL == snmp_parse_oid (ci->values[i].value.string,
286 dd->values[i].oid, &dd->values[i].oid_len))
288 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
289 ci->values[i].value.string);
298 } /* int csnmp_config_add_data_instance */
300 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
302 if ((ci->values_num != 1)
303 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
305 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
309 dd->shift = ci->values[0].value.number;
312 } /* int csnmp_config_add_data_shift */
314 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
316 if ((ci->values_num != 1)
317 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
319 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
323 dd->scale = ci->values[0].value.number;
326 } /* int csnmp_config_add_data_scale */
328 static int csnmp_config_add_data (oconfig_item_t *ci)
330 data_definition_t *dd;
334 if ((ci->values_num != 1)
335 || (ci->values[0].type != OCONFIG_TYPE_STRING))
337 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
341 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
344 memset (dd, '\0', sizeof (data_definition_t));
346 dd->name = strdup (ci->values[0].value.string);
347 if (dd->name == NULL)
355 for (i = 0; i < ci->children_num; i++)
357 oconfig_item_t *option = ci->children + i;
360 if (strcasecmp ("Type", option->key) == 0)
361 status = csnmp_config_add_data_type (dd, option);
362 else if (strcasecmp ("Table", option->key) == 0)
363 status = csnmp_config_add_data_table (dd, option);
364 else if (strcasecmp ("Instance", option->key) == 0)
365 status = csnmp_config_add_data_instance (dd, option);
366 else if (strcasecmp ("InstancePrefix", option->key) == 0)
367 status = csnmp_config_add_data_instance_prefix (dd, option);
368 else if (strcasecmp ("Values", option->key) == 0)
369 status = csnmp_config_add_data_values (dd, option);
370 else if (strcasecmp ("Shift", option->key) == 0)
371 status = csnmp_config_add_data_shift (dd, option);
372 else if (strcasecmp ("Scale", option->key) == 0)
373 status = csnmp_config_add_data_scale (dd, option);
376 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
382 } /* for (ci->children) */
386 if (dd->type == NULL)
388 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
392 if (dd->values == NULL)
394 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
400 } /* while (status == 0) */
405 sfree (dd->instance_prefix);
411 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
412 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
414 if (data_head == NULL)
418 data_definition_t *last;
420 while (last->next != NULL)
426 } /* int csnmp_config_add_data */
428 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
430 if ((ci->values_num != 1)
431 || (ci->values[0].type != OCONFIG_TYPE_STRING))
433 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
437 if (hd->address == NULL)
440 hd->address = strdup (ci->values[0].value.string);
441 if (hd->address == NULL)
444 DEBUG ("snmp plugin: host = %s; host->address = %s;",
445 hd->name, hd->address);
448 } /* int csnmp_config_add_host_address */
450 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
452 if ((ci->values_num != 1)
453 || (ci->values[0].type != OCONFIG_TYPE_STRING))
455 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
459 if (hd->community == NULL)
460 free (hd->community);
462 hd->community = strdup (ci->values[0].value.string);
463 if (hd->community == NULL)
466 DEBUG ("snmp plugin: host = %s; host->community = %s;",
467 hd->name, hd->community);
470 } /* int csnmp_config_add_host_community */
472 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
476 if ((ci->values_num != 1)
477 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
479 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
483 version = (int) ci->values[0].value.number;
484 if ((version != 1) && (version != 2))
486 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
490 hd->version = version;
493 } /* int csnmp_config_add_host_address */
495 static int csnmp_config_add_host_collect (host_definition_t *host,
498 data_definition_t *data;
499 data_definition_t **data_list;
503 if (ci->values_num < 1)
505 WARNING ("snmp plugin: `Collect' needs at least one argument.");
509 for (i = 0; i < ci->values_num; i++)
510 if (ci->values[i].type != OCONFIG_TYPE_STRING)
512 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
516 data_list_len = host->data_list_len + ci->values_num;
517 data_list = (data_definition_t **) realloc (host->data_list,
518 sizeof (data_definition_t *) * data_list_len);
519 if (data_list == NULL)
521 host->data_list = data_list;
523 for (i = 0; i < ci->values_num; i++)
525 for (data = data_head; data != NULL; data = data->next)
526 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
531 WARNING ("snmp plugin: No such data configured: `%s'",
532 ci->values[i].value.string);
536 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
537 host->name, host->data_list_len, data->name);
539 host->data_list[host->data_list_len] = data;
540 host->data_list_len++;
541 } /* for (values_num) */
544 } /* int csnmp_config_add_host_collect */
546 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
548 if ((ci->values_num != 1)
549 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
551 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
555 hd->interval = ci->values[0].value.number >= 0
556 ? (uint32_t) ci->values[0].value.number
560 } /* int csnmp_config_add_host_interval */
562 static int csnmp_config_add_host (oconfig_item_t *ci)
564 host_definition_t *hd;
568 /* Registration stuff. */
569 char cb_name[DATA_MAX_NAME_LEN];
571 struct timespec cb_interval;
573 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
575 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
579 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
582 memset (hd, '\0', sizeof (host_definition_t));
584 C_COMPLAIN_INIT (&hd->complaint);
586 hd->name = strdup (ci->values[0].value.string);
587 if (hd->name == NULL)
593 hd->sess_handle = NULL;
596 for (i = 0; i < ci->children_num; i++)
598 oconfig_item_t *option = ci->children + i;
601 if (strcasecmp ("Address", option->key) == 0)
602 status = csnmp_config_add_host_address (hd, option);
603 else if (strcasecmp ("Community", option->key) == 0)
604 status = csnmp_config_add_host_community (hd, option);
605 else if (strcasecmp ("Version", option->key) == 0)
606 status = csnmp_config_add_host_version (hd, option);
607 else if (strcasecmp ("Collect", option->key) == 0)
608 csnmp_config_add_host_collect (hd, option);
609 else if (strcasecmp ("Interval", option->key) == 0)
610 csnmp_config_add_host_interval (hd, option);
613 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
619 } /* for (ci->children) */
623 if (hd->address == NULL)
625 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
629 if (hd->community == NULL)
631 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
637 } /* while (status == 0) */
641 csnmp_host_definition_destroy (hd);
645 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
646 hd->name, hd->address, hd->community, hd->version);
648 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
650 memset (&cb_data, 0, sizeof (cb_data));
652 cb_data.free_func = csnmp_host_definition_destroy;
654 memset (&cb_interval, 0, sizeof (cb_interval));
655 if (hd->interval != 0)
656 cb_interval.tv_sec = (time_t) hd->interval;
658 status = plugin_register_complex_read (/* group = */ NULL, cb_name,
659 csnmp_read_host, /* interval = */ &cb_interval,
660 /* user_data = */ &cb_data);
663 ERROR ("snmp plugin: Registering complex read function failed.");
664 csnmp_host_definition_destroy (hd);
669 } /* int csnmp_config_add_host */
671 static int csnmp_config (oconfig_item_t *ci)
675 call_snmp_init_once ();
677 for (i = 0; i < ci->children_num; i++)
679 oconfig_item_t *child = ci->children + i;
680 if (strcasecmp ("Data", child->key) == 0)
681 csnmp_config_add_data (child);
682 else if (strcasecmp ("Host", child->key) == 0)
683 csnmp_config_add_host (child);
686 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
688 } /* for (ci->children) */
691 } /* int csnmp_config */
693 /* }}} End of the config stuff. Now the interesting part begins */
695 static void csnmp_host_open_session (host_definition_t *host)
697 struct snmp_session sess;
699 if (host->sess_handle != NULL)
700 csnmp_host_close_session (host);
702 snmp_sess_init (&sess);
703 sess.peername = host->address;
704 sess.community = (u_char *) host->community;
705 sess.community_len = strlen (host->community);
706 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
708 /* snmp_sess_open will copy the `struct snmp_session *'. */
709 host->sess_handle = snmp_sess_open (&sess);
711 if (host->sess_handle == NULL)
715 snmp_error (&sess, NULL, NULL, &errstr);
717 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
718 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
721 } /* void csnmp_host_open_session */
723 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
724 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
725 double scale, double shift)
728 uint64_t tmp_unsigned = 0;
729 int64_t tmp_signed = 0;
732 if ((vl->type == ASN_INTEGER)
733 || (vl->type == ASN_UINTEGER)
734 || (vl->type == ASN_COUNTER)
736 || (vl->type == ASN_TIMETICKS)
738 || (vl->type == ASN_GAUGE))
740 tmp_unsigned = (uint32_t) *vl->val.integer;
741 tmp_signed = (int32_t) *vl->val.integer;
742 DEBUG ("snmp plugin: Parsed int32 value is %"PRIi64".", tmp_signed);
744 else if (vl->type == ASN_COUNTER64)
746 tmp_unsigned = (uint32_t) vl->val.counter64->high;
747 tmp_unsigned = tmp_unsigned << 32;
748 tmp_unsigned += (uint32_t) vl->val.counter64->low;
749 tmp_signed = (int64_t) tmp_unsigned;
750 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
752 else if (vl->type == ASN_OCTET_STR)
754 /* We'll handle this later.. */
758 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
762 if (vl->type == ASN_OCTET_STR)
766 if (vl->val.string != NULL)
769 size_t string_length;
771 string_length = sizeof (string) - 1;
772 if (vl->val_len < string_length)
773 string_length = vl->val_len;
775 /* The strings we get from the Net-SNMP library may not be null
776 * terminated. That is why we're using `memcpy' here and not `strcpy'.
777 * `string_length' is set to `vl->val_len' which holds the length of the
779 memcpy (string, vl->val.string, string_length);
780 string[string_length] = 0;
782 status = parse_value (string, &ret, type);
785 ERROR ("snmp plugin: csnmp_value_list_to_value: Parsing string as %s failed: %s",
786 DS_TYPE_TO_STRING (type), string);
794 case DS_TYPE_COUNTER:
796 case DS_TYPE_ABSOLUTE:
797 memset (&ret, 0, sizeof (ret));
805 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
806 "data source type: %i.", type);
810 } /* if (vl->type == ASN_OCTET_STR) */
811 else if (type == DS_TYPE_COUNTER)
813 ret.counter = tmp_unsigned;
815 else if (type == DS_TYPE_GAUGE)
819 ret.gauge = (scale * tmp_signed) + shift;
821 else if (type == DS_TYPE_DERIVE)
822 ret.derive = (derive_t) tmp_signed;
823 else if (type == DS_TYPE_ABSOLUTE)
824 ret.absolute = (absolute_t) tmp_unsigned;
827 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
833 } /* value_t csnmp_value_list_to_value */
835 /* Returns true if all OIDs have left their subtree */
836 static int csnmp_check_res_left_subtree (const host_definition_t *host,
837 const data_definition_t *data,
838 struct snmp_pdu *res)
840 struct variable_list *vb;
842 int num_left_subtree;
850 num_left_subtree = 0;
852 /* check all the variables and count how many have left their subtree */
853 for (vb = res->variables, i = 0;
854 (vb != NULL) && (i < data->values_len);
855 vb = vb->next_variable, i++)
858 if (snmp_oid_ncompare (data->values[i].oid,
859 data->values[i].oid_len,
860 vb->name, vb->name_length,
861 data->values[i].oid_len) != 0)
865 /* check if enough variables have been returned */
866 if (i < data->values_len)
868 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
869 host->name, data->values_len, i);
873 if (data->instance.oid.oid_len > 0)
877 ERROR ("snmp plugin: host %s: Expected one more variable for "
878 "the instance..", host->name);
883 if (snmp_oid_ncompare (data->instance.oid.oid,
884 data->instance.oid.oid_len,
885 vb->name, vb->name_length,
886 data->instance.oid.oid_len) != 0)
890 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
891 "left their subtree",
892 num_left_subtree, num_checked);
893 if (num_left_subtree >= num_checked)
896 } /* int csnmp_check_res_left_subtree */
898 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
899 const struct variable_list *vb, size_t dst_size)
906 buffer_free = dst_size;
908 for (i = 0; i < vb->val_len; i++)
912 status = snprintf (buffer_ptr, buffer_free,
913 (i == 0) ? "%02x" : ":%02x", (unsigned int) vb->val.bitstring[i]);
915 if (status >= buffer_free)
917 buffer_ptr += (buffer_free - 1);
919 return (dst_size + (buffer_free - status));
921 else /* if (status < buffer_free) */
923 buffer_ptr += status;
924 buffer_free -= status;
928 return ((int) (dst_size - buffer_free));
929 } /* }}} int csnmp_strvbcopy_hexstring */
931 static int csnmp_strvbcopy (char *dst, /* {{{ */
932 const struct variable_list *vb, size_t dst_size)
938 if (vb->type == ASN_OCTET_STR)
939 src = (char *) vb->val.string;
940 else if (vb->type == ASN_BIT_STR)
941 src = (char *) vb->val.bitstring;
948 num_chars = dst_size - 1;
949 if (num_chars > vb->val_len)
950 num_chars = vb->val_len;
952 for (i = 0; i < num_chars; i++)
954 /* Check for control characters. */
955 if ((src[i] >= 0) && (src[i] < 32))
956 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
961 return ((int) vb->val_len);
962 } /* }}} int csnmp_strvbcopy */
964 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
965 csnmp_list_instances_t **tail,
966 const struct snmp_pdu *res)
968 csnmp_list_instances_t *il;
969 struct variable_list *vb;
971 /* Set vb on the last variable */
972 for (vb = res->variables;
973 (vb != NULL) && (vb->next_variable != NULL);
974 vb = vb->next_variable)
979 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
982 ERROR ("snmp plugin: malloc failed.");
985 il->subid = vb->name[vb->name_length - 1];
988 /* Get instance name */
989 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
993 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
995 for (ptr = il->instance; *ptr != '\0'; ptr++)
997 if ((*ptr > 0) && (*ptr < 32))
999 else if (*ptr == '/')
1002 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1006 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
1007 ssnprintf (il->instance, sizeof (il->instance),
1008 "%llu", val.counter);
1011 /* TODO: Debugging output */
1020 } /* int csnmp_instance_list_add */
1022 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1023 csnmp_list_instances_t *instance_list,
1024 csnmp_table_values_t **value_table)
1026 const data_set_t *ds;
1027 value_list_t vl = VALUE_LIST_INIT;
1029 csnmp_list_instances_t *instance_list_ptr;
1030 csnmp_table_values_t **value_table_ptr;
1036 ds = plugin_get_ds (data->type);
1039 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1042 assert (ds->ds_num == data->values_len);
1044 instance_list_ptr = instance_list;
1046 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1047 * data->values_len);
1048 if (value_table_ptr == NULL)
1050 for (i = 0; i < data->values_len; i++)
1051 value_table_ptr[i] = value_table[i];
1053 vl.values_len = ds->ds_num;
1054 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1055 if (vl.values == NULL)
1057 ERROR ("snmp plugin: malloc failed.");
1058 sfree (value_table_ptr);
1062 sstrncpy (vl.host, host->name, sizeof (vl.host));
1063 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1065 vl.interval = host->interval;
1070 while (have_more != 0)
1072 if (instance_list != NULL)
1074 while ((instance_list_ptr != NULL)
1075 && (instance_list_ptr->subid < subid))
1076 instance_list_ptr = instance_list_ptr->next;
1078 if (instance_list_ptr == NULL)
1083 else if (instance_list_ptr->subid > subid)
1085 subid = instance_list_ptr->subid;
1088 } /* if (instance_list != NULL) */
1090 for (i = 0; i < data->values_len; i++)
1092 while ((value_table_ptr[i] != NULL)
1093 && (value_table_ptr[i]->subid < subid))
1094 value_table_ptr[i] = value_table_ptr[i]->next;
1096 if (value_table_ptr[i] == NULL)
1101 else if (value_table_ptr[i]->subid > subid)
1103 subid = value_table_ptr[i]->subid;
1106 } /* for (i = 0; i < columns; i++) */
1107 /* The subid has been increased - start scanning from the beginning
1109 if (i < data->values_len)
1112 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1113 * to the same subid. instance_list_ptr is either NULL or points to the
1114 * same subid, too. */
1116 for (i = 1; i < data->values_len; i++)
1118 assert (value_table_ptr[i] != NULL);
1119 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
1121 assert ((instance_list_ptr == NULL)
1122 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
1125 sstrncpy (vl.type, data->type, sizeof (vl.type));
1128 char temp[DATA_MAX_NAME_LEN];
1130 if (instance_list_ptr == NULL)
1131 ssnprintf (temp, sizeof (temp), "%"PRIu32, (uint32_t) subid);
1133 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1135 if (data->instance_prefix == NULL)
1136 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1138 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1139 data->instance_prefix, temp);
1142 for (i = 0; i < data->values_len; i++)
1143 vl.values[i] = value_table_ptr[i]->value;
1145 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1146 plugin_dispatch_values (&vl);
1149 } /* while (have_more != 0) */
1152 sfree (value_table_ptr);
1155 } /* int csnmp_dispatch_table */
1157 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1159 struct snmp_pdu *req;
1160 struct snmp_pdu *res;
1161 struct variable_list *vb;
1163 const data_set_t *ds;
1165 uint32_t oid_list_len;
1170 /* `value_table' and `value_table_ptr' implement a linked list for each
1171 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1172 * instance names. This is used to jump gaps in the table. */
1173 csnmp_list_instances_t *instance_list;
1174 csnmp_list_instances_t *instance_list_ptr;
1175 csnmp_table_values_t **value_table;
1176 csnmp_table_values_t **value_table_ptr;
1178 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1179 host->name, data->name);
1181 if (host->sess_handle == NULL)
1183 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1187 ds = plugin_get_ds (data->type);
1190 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1194 if (ds->ds_num != data->values_len)
1196 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1197 data->type, ds->ds_num, data->values_len);
1201 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1202 oid_list_len = data->values_len + 1;
1203 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1204 if (oid_list == NULL)
1206 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1209 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1210 if (data->instance.oid.oid_len > 0)
1211 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1215 /* Allocate the `value_table' */
1216 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1217 * 2 * data->values_len);
1218 if (value_table == NULL)
1220 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1224 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1225 value_table_ptr = value_table + data->values_len;
1227 instance_list = NULL;
1228 instance_list_ptr = NULL;
1233 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1236 ERROR ("snmp plugin: snmp_pdu_create failed.");
1241 for (i = 0; (uint32_t) i < oid_list_len; i++)
1242 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1245 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1247 if ((status != STAT_SUCCESS) || (res == NULL))
1249 char *errstr = NULL;
1251 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1253 c_complain (LOG_ERR, &host->complaint,
1254 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1255 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1258 snmp_free_pdu (res);
1262 csnmp_host_close_session (host);
1268 assert (res != NULL);
1269 c_release (LOG_INFO, &host->complaint,
1270 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1273 vb = res->variables;
1280 /* Check if all values (and possibly the instance) have left their
1282 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1288 /* if an instance-OID is configured.. */
1289 if (data->instance.oid.oid_len > 0)
1291 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1292 * add it to the list */
1293 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1296 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1301 /* Set vb on the last variable */
1302 for (vb = res->variables;
1303 (vb != NULL) && (vb->next_variable != NULL);
1304 vb = vb->next_variable)
1306 assert (vb != NULL);
1308 /* Copy OID to oid_list[data->values_len] */
1309 memcpy (oid_list[data->values_len].oid, vb->name,
1310 sizeof (oid) * vb->name_length);
1311 oid_list[data->values_len].oid_len = vb->name_length;
1314 for (vb = res->variables, i = 0;
1315 (vb != NULL) && (i < data->values_len);
1316 vb = vb->next_variable, i++)
1318 csnmp_table_values_t *vt;
1320 /* Check if we left the subtree */
1321 if (snmp_oid_ncompare (data->values[i].oid,
1322 data->values[i].oid_len,
1323 vb->name, vb->name_length,
1324 data->values[i].oid_len) != 0)
1326 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1327 host->name, data->name, i);
1331 if ((value_table_ptr[i] != NULL)
1332 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1334 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1335 "SUBID is not increasing.",
1336 host->name, data->name, i);
1340 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1343 ERROR ("snmp plugin: malloc failed.");
1348 vt->subid = vb->name[vb->name_length - 1];
1349 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1350 data->scale, data->shift);
1353 if (value_table_ptr[i] == NULL)
1354 value_table[i] = vt;
1356 value_table_ptr[i]->next = vt;
1357 value_table_ptr[i] = vt;
1359 /* Copy OID to oid_list[i + 1] */
1360 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1361 oid_list[i].oid_len = vb->name_length;
1362 } /* for (i = data->values_len) */
1365 snmp_free_pdu (res);
1367 } /* while (status == 0) */
1370 snmp_free_pdu (res);
1374 csnmp_dispatch_table (host, data, instance_list, value_table);
1376 /* Free all allocated variables here */
1377 while (instance_list != NULL)
1379 instance_list_ptr = instance_list->next;
1380 sfree (instance_list);
1381 instance_list = instance_list_ptr;
1384 for (i = 0; i < data->values_len; i++)
1386 csnmp_table_values_t *tmp;
1387 while (value_table[i] != NULL)
1389 tmp = value_table[i]->next;
1390 sfree (value_table[i]);
1391 value_table[i] = tmp;
1395 sfree (value_table);
1399 } /* int csnmp_read_table */
1401 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1403 struct snmp_pdu *req;
1404 struct snmp_pdu *res;
1405 struct variable_list *vb;
1407 const data_set_t *ds;
1408 value_list_t vl = VALUE_LIST_INIT;
1413 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1414 host->name, data->name);
1416 if (host->sess_handle == NULL)
1418 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1422 ds = plugin_get_ds (data->type);
1425 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1429 if (ds->ds_num != data->values_len)
1431 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1432 data->type, ds->ds_num, data->values_len);
1436 vl.values_len = ds->ds_num;
1437 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1438 if (vl.values == NULL)
1440 for (i = 0; i < vl.values_len; i++)
1442 if (ds->ds[i].type == DS_TYPE_COUNTER)
1443 vl.values[i].counter = 0;
1445 vl.values[i].gauge = NAN;
1448 sstrncpy (vl.host, host->name, sizeof (vl.host));
1449 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1450 sstrncpy (vl.type, data->type, sizeof (vl.type));
1451 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1453 vl.interval = host->interval;
1455 req = snmp_pdu_create (SNMP_MSG_GET);
1458 ERROR ("snmp plugin: snmp_pdu_create failed.");
1463 for (i = 0; i < data->values_len; i++)
1464 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1467 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1469 if ((status != STAT_SUCCESS) || (res == NULL))
1471 char *errstr = NULL;
1473 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1474 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1475 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1478 snmp_free_pdu (res);
1482 csnmp_host_close_session (host);
1488 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1492 snprint_variable (buffer, sizeof (buffer),
1493 vb->name, vb->name_length, vb);
1494 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1495 #endif /* COLLECT_DEBUG */
1497 for (i = 0; i < data->values_len; i++)
1498 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1499 vb->name, vb->name_length) == 0)
1500 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1501 data->scale, data->shift);
1502 } /* for (res->variables) */
1505 snmp_free_pdu (res);
1508 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1509 plugin_dispatch_values (&vl);
1513 } /* int csnmp_read_value */
1515 static int csnmp_read_host (user_data_t *ud)
1517 host_definition_t *host;
1526 if (host->interval == 0)
1527 host->interval = interval_g;
1529 time_start = time (NULL);
1530 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1531 (unsigned int) time_start);
1533 if (host->sess_handle == NULL)
1534 csnmp_host_open_session (host);
1536 if (host->sess_handle == NULL)
1540 for (i = 0; i < host->data_list_len; i++)
1542 data_definition_t *data = host->data_list[i];
1545 status = csnmp_read_table (host, data);
1547 status = csnmp_read_value (host, data);
1553 time_end = time (NULL);
1554 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1555 (unsigned int) time_end);
1556 if ((uint32_t) (time_end - time_start) > host->interval)
1558 WARNING ("snmp plugin: Host `%s' should be queried every %"PRIu32
1559 " seconds, but reading all values takes %u seconds.",
1560 host->name, host->interval, (unsigned int) (time_end - time_start));
1567 } /* int csnmp_read_host */
1569 static int csnmp_init (void)
1571 call_snmp_init_once ();
1574 } /* int csnmp_init */
1576 static int csnmp_shutdown (void)
1578 data_definition_t *data_this;
1579 data_definition_t *data_next;
1581 /* When we get here, the read threads have been stopped and all the
1582 * `host_definition_t' will be freed. */
1583 DEBUG ("snmp plugin: Destroying all data definitions.");
1585 data_this = data_head;
1587 while (data_this != NULL)
1589 data_next = data_this->next;
1591 sfree (data_this->name);
1592 sfree (data_this->type);
1593 sfree (data_this->values);
1596 data_this = data_next;
1600 } /* int csnmp_shutdown */
1602 void module_register (void)
1604 plugin_register_complex_config ("snmp", csnmp_config);
1605 plugin_register_init ("snmp", csnmp_init);
1606 plugin_register_shutdown ("snmp", csnmp_shutdown);
1607 } /* void module_register */
1610 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker