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
163 static void call_snmp_init_once (void)
165 static int have_init = 0;
168 init_snmp (PACKAGE_NAME);
170 } /* void call_snmp_init_once */
172 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
174 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
176 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
181 dd->type = strdup (ci->values[0].value.string);
182 if (dd->type == NULL)
186 } /* int csnmp_config_add_data_type */
188 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
190 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
192 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
196 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
199 } /* int csnmp_config_add_data_table */
201 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
203 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
205 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
211 /* Instance is an OID */
212 dd->instance.oid.oid_len = MAX_OID_LEN;
214 if (!read_objid (ci->values[0].value.string,
215 dd->instance.oid.oid, &dd->instance.oid.oid_len))
217 ERROR ("snmp plugin: read_objid (%s) failed.",
218 ci->values[0].value.string);
224 /* Instance is a simple string */
225 sstrncpy (dd->instance.string, ci->values[0].value.string,
226 sizeof (dd->instance.string));
230 } /* int csnmp_config_add_data_instance */
232 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
235 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
237 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
243 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
244 "is set to `false'.", dd->name);
248 sfree (dd->instance_prefix);
249 dd->instance_prefix = strdup (ci->values[0].value.string);
250 if (dd->instance_prefix == NULL)
254 } /* int csnmp_config_add_data_instance_prefix */
256 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
260 if (ci->values_num < 1)
262 WARNING ("snmp plugin: `Values' needs at least one argument.");
266 for (i = 0; i < ci->values_num; i++)
267 if (ci->values[i].type != OCONFIG_TYPE_STRING)
269 WARNING ("snmp plugin: `Values' needs only string argument.");
275 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
276 if (dd->values == NULL)
278 dd->values_len = ci->values_num;
280 for (i = 0; i < ci->values_num; i++)
282 dd->values[i].oid_len = MAX_OID_LEN;
284 if (NULL == snmp_parse_oid (ci->values[i].value.string,
285 dd->values[i].oid, &dd->values[i].oid_len))
287 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
288 ci->values[i].value.string);
297 } /* int csnmp_config_add_data_instance */
299 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
301 if ((ci->values_num != 1)
302 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
304 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
308 dd->shift = ci->values[0].value.number;
311 } /* int csnmp_config_add_data_shift */
313 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
315 if ((ci->values_num != 1)
316 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
318 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
322 dd->scale = ci->values[0].value.number;
325 } /* int csnmp_config_add_data_scale */
327 static int csnmp_config_add_data (oconfig_item_t *ci)
329 data_definition_t *dd;
333 if ((ci->values_num != 1)
334 || (ci->values[0].type != OCONFIG_TYPE_STRING))
336 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
340 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
343 memset (dd, '\0', sizeof (data_definition_t));
345 dd->name = strdup (ci->values[0].value.string);
346 if (dd->name == NULL)
354 for (i = 0; i < ci->children_num; i++)
356 oconfig_item_t *option = ci->children + i;
359 if (strcasecmp ("Type", option->key) == 0)
360 status = csnmp_config_add_data_type (dd, option);
361 else if (strcasecmp ("Table", option->key) == 0)
362 status = csnmp_config_add_data_table (dd, option);
363 else if (strcasecmp ("Instance", option->key) == 0)
364 status = csnmp_config_add_data_instance (dd, option);
365 else if (strcasecmp ("InstancePrefix", option->key) == 0)
366 status = csnmp_config_add_data_instance_prefix (dd, option);
367 else if (strcasecmp ("Values", option->key) == 0)
368 status = csnmp_config_add_data_values (dd, option);
369 else if (strcasecmp ("Shift", option->key) == 0)
370 status = csnmp_config_add_data_shift (dd, option);
371 else if (strcasecmp ("Scale", option->key) == 0)
372 status = csnmp_config_add_data_scale (dd, option);
375 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
381 } /* for (ci->children) */
385 if (dd->type == NULL)
387 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
391 if (dd->values == NULL)
393 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
399 } /* while (status == 0) */
404 sfree (dd->instance_prefix);
410 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
411 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
413 if (data_head == NULL)
417 data_definition_t *last;
419 while (last->next != NULL)
425 } /* int csnmp_config_add_data */
427 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
429 if ((ci->values_num != 1)
430 || (ci->values[0].type != OCONFIG_TYPE_STRING))
432 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
436 if (hd->address == NULL)
439 hd->address = strdup (ci->values[0].value.string);
440 if (hd->address == NULL)
443 DEBUG ("snmp plugin: host = %s; host->address = %s;",
444 hd->name, hd->address);
447 } /* int csnmp_config_add_host_address */
449 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
451 if ((ci->values_num != 1)
452 || (ci->values[0].type != OCONFIG_TYPE_STRING))
454 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
458 if (hd->community == NULL)
459 free (hd->community);
461 hd->community = strdup (ci->values[0].value.string);
462 if (hd->community == NULL)
465 DEBUG ("snmp plugin: host = %s; host->community = %s;",
466 hd->name, hd->community);
469 } /* int csnmp_config_add_host_community */
471 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
475 if ((ci->values_num != 1)
476 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
478 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
482 version = (int) ci->values[0].value.number;
483 if ((version != 1) && (version != 2))
485 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
489 hd->version = version;
492 } /* int csnmp_config_add_host_address */
494 static int csnmp_config_add_host_collect (host_definition_t *host,
497 data_definition_t *data;
498 data_definition_t **data_list;
502 if (ci->values_num < 1)
504 WARNING ("snmp plugin: `Collect' needs at least one argument.");
508 for (i = 0; i < ci->values_num; i++)
509 if (ci->values[i].type != OCONFIG_TYPE_STRING)
511 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
515 data_list_len = host->data_list_len + ci->values_num;
516 data_list = (data_definition_t **) realloc (host->data_list,
517 sizeof (data_definition_t *) * data_list_len);
518 if (data_list == NULL)
520 host->data_list = data_list;
522 for (i = 0; i < ci->values_num; i++)
524 for (data = data_head; data != NULL; data = data->next)
525 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
530 WARNING ("snmp plugin: No such data configured: `%s'",
531 ci->values[i].value.string);
535 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
536 host->name, host->data_list_len, data->name);
538 host->data_list[host->data_list_len] = data;
539 host->data_list_len++;
540 } /* for (values_num) */
543 } /* int csnmp_config_add_host_collect */
545 static int csnmp_config_add_host (oconfig_item_t *ci)
547 host_definition_t *hd;
551 /* Registration stuff. */
552 char cb_name[DATA_MAX_NAME_LEN];
554 struct timespec cb_interval;
556 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
558 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
562 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
565 memset (hd, '\0', sizeof (host_definition_t));
567 C_COMPLAIN_INIT (&hd->complaint);
569 hd->name = strdup (ci->values[0].value.string);
570 if (hd->name == NULL)
576 hd->sess_handle = NULL;
579 for (i = 0; i < ci->children_num; i++)
581 oconfig_item_t *option = ci->children + i;
584 if (strcasecmp ("Address", option->key) == 0)
585 status = csnmp_config_add_host_address (hd, option);
586 else if (strcasecmp ("Community", option->key) == 0)
587 status = csnmp_config_add_host_community (hd, option);
588 else if (strcasecmp ("Version", option->key) == 0)
589 status = csnmp_config_add_host_version (hd, option);
590 else if (strcasecmp ("Collect", option->key) == 0)
591 csnmp_config_add_host_collect (hd, option);
592 else if (strcasecmp ("Interval", option->key) == 0)
593 cf_util_get_cdtime (option, &hd->interval);
596 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
602 } /* for (ci->children) */
606 if (hd->address == NULL)
608 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
612 if (hd->community == NULL)
614 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
620 } /* while (status == 0) */
624 csnmp_host_definition_destroy (hd);
628 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
629 hd->name, hd->address, hd->community, hd->version);
631 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
633 memset (&cb_data, 0, sizeof (cb_data));
635 cb_data.free_func = csnmp_host_definition_destroy;
637 CDTIME_T_TO_TIMESPEC (hd->interval, &cb_interval);
639 status = plugin_register_complex_read (/* group = */ NULL, cb_name,
640 csnmp_read_host, /* interval = */ &cb_interval,
641 /* user_data = */ &cb_data);
644 ERROR ("snmp plugin: Registering complex read function failed.");
645 csnmp_host_definition_destroy (hd);
650 } /* int csnmp_config_add_host */
652 static int csnmp_config (oconfig_item_t *ci)
656 call_snmp_init_once ();
658 for (i = 0; i < ci->children_num; i++)
660 oconfig_item_t *child = ci->children + i;
661 if (strcasecmp ("Data", child->key) == 0)
662 csnmp_config_add_data (child);
663 else if (strcasecmp ("Host", child->key) == 0)
664 csnmp_config_add_host (child);
667 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
669 } /* for (ci->children) */
672 } /* int csnmp_config */
674 /* }}} End of the config stuff. Now the interesting part begins */
676 static void csnmp_host_open_session (host_definition_t *host)
678 struct snmp_session sess;
680 if (host->sess_handle != NULL)
681 csnmp_host_close_session (host);
683 snmp_sess_init (&sess);
684 sess.peername = host->address;
685 sess.community = (u_char *) host->community;
686 sess.community_len = strlen (host->community);
687 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
689 /* snmp_sess_open will copy the `struct snmp_session *'. */
690 host->sess_handle = snmp_sess_open (&sess);
692 if (host->sess_handle == NULL)
696 snmp_error (&sess, NULL, NULL, &errstr);
698 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
699 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
702 } /* void csnmp_host_open_session */
704 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
705 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
706 double scale, double shift)
709 uint64_t tmp_unsigned = 0;
710 int64_t tmp_signed = 0;
712 /* Set to true when the original SNMP type appears to have been signed. */
713 _Bool prefer_signed = 0;
715 if ((vl->type == ASN_INTEGER)
716 || (vl->type == ASN_UINTEGER)
717 || (vl->type == ASN_COUNTER)
719 || (vl->type == ASN_TIMETICKS)
721 || (vl->type == ASN_GAUGE))
723 tmp_unsigned = (uint32_t) *vl->val.integer;
724 tmp_signed = (int32_t) *vl->val.integer;
726 if ((vl->type == ASN_INTEGER)
727 || (vl->type == ASN_GAUGE))
730 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", tmp_unsigned);
732 else if (vl->type == ASN_COUNTER64)
734 tmp_unsigned = (uint32_t) vl->val.counter64->high;
735 tmp_unsigned = tmp_unsigned << 32;
736 tmp_unsigned += (uint32_t) vl->val.counter64->low;
737 tmp_signed = (int64_t) tmp_unsigned;
738 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
740 else if (vl->type == ASN_OCTET_STR)
742 /* We'll handle this later.. */
746 char oid_buffer[1024];
748 memset (oid_buffer, 0, sizeof (oid_buffer));
749 snprint_objid (oid_buffer, sizeof (oid_buffer) - 1,
750 vl->name, vl->name_length);
753 if (vl->type == ASN_NULL)
754 INFO ("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)",
758 WARNING ("snmp plugin: I don't know the ASN type \"%i\" (OID: %s)",
759 (int) vl->type, oid_buffer);
764 if (vl->type == ASN_OCTET_STR)
768 if (vl->val.string != NULL)
771 size_t string_length;
773 string_length = sizeof (string) - 1;
774 if (vl->val_len < string_length)
775 string_length = vl->val_len;
777 /* The strings we get from the Net-SNMP library may not be null
778 * terminated. That is why we're using `memcpy' here and not `strcpy'.
779 * `string_length' is set to `vl->val_len' which holds the length of the
781 memcpy (string, vl->val.string, string_length);
782 string[string_length] = 0;
784 status = parse_value (string, &ret, type);
787 ERROR ("snmp plugin: csnmp_value_list_to_value: Parsing string as %s failed: %s",
788 DS_TYPE_TO_STRING (type), string);
796 case DS_TYPE_COUNTER:
798 case DS_TYPE_ABSOLUTE:
799 memset (&ret, 0, sizeof (ret));
807 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
808 "data source type: %i.", type);
812 } /* if (vl->type == ASN_OCTET_STR) */
813 else if (type == DS_TYPE_COUNTER)
815 ret.counter = tmp_unsigned;
817 else if (type == DS_TYPE_GAUGE)
821 else if (prefer_signed)
822 ret.gauge = (scale * tmp_signed) + shift;
824 ret.gauge = (scale * tmp_unsigned) + shift;
826 else if (type == DS_TYPE_DERIVE)
829 ret.derive = (derive_t) tmp_signed;
831 ret.derive = (derive_t) tmp_unsigned;
833 else if (type == DS_TYPE_ABSOLUTE)
835 ret.absolute = (absolute_t) tmp_unsigned;
839 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
845 } /* value_t csnmp_value_list_to_value */
847 /* Returns true if all OIDs have left their subtree */
848 static int csnmp_check_res_left_subtree (const host_definition_t *host,
849 const data_definition_t *data,
850 struct snmp_pdu *res)
852 struct variable_list *vb;
854 int num_left_subtree;
862 num_left_subtree = 0;
864 /* check all the variables and count how many have left their subtree */
865 for (vb = res->variables, i = 0;
866 (vb != NULL) && (i < data->values_len);
867 vb = vb->next_variable, i++)
870 if (snmp_oid_ncompare (data->values[i].oid,
871 data->values[i].oid_len,
872 vb->name, vb->name_length,
873 data->values[i].oid_len) != 0)
877 /* check if enough variables have been returned */
878 if (i < data->values_len)
880 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
881 host->name, data->values_len, i);
885 if (data->instance.oid.oid_len > 0)
889 ERROR ("snmp plugin: host %s: Expected one more variable for "
890 "the instance..", host->name);
895 if (snmp_oid_ncompare (data->instance.oid.oid,
896 data->instance.oid.oid_len,
897 vb->name, vb->name_length,
898 data->instance.oid.oid_len) != 0)
902 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
903 "left their subtree",
904 num_left_subtree, num_checked);
905 if (num_left_subtree >= num_checked)
908 } /* int csnmp_check_res_left_subtree */
910 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
911 const struct variable_list *vb, size_t dst_size)
918 buffer_free = dst_size;
920 for (i = 0; i < vb->val_len; i++)
924 status = snprintf (buffer_ptr, buffer_free,
925 (i == 0) ? "%02x" : ":%02x", (unsigned int) vb->val.bitstring[i]);
927 if (status >= buffer_free)
929 buffer_ptr += (buffer_free - 1);
931 return (dst_size + (buffer_free - status));
933 else /* if (status < buffer_free) */
935 buffer_ptr += status;
936 buffer_free -= status;
940 return ((int) (dst_size - buffer_free));
941 } /* }}} int csnmp_strvbcopy_hexstring */
943 static int csnmp_strvbcopy (char *dst, /* {{{ */
944 const struct variable_list *vb, size_t dst_size)
950 if (vb->type == ASN_OCTET_STR)
951 src = (char *) vb->val.string;
952 else if (vb->type == ASN_BIT_STR)
953 src = (char *) vb->val.bitstring;
960 num_chars = dst_size - 1;
961 if (num_chars > vb->val_len)
962 num_chars = vb->val_len;
964 for (i = 0; i < num_chars; i++)
966 /* Check for control characters. */
967 if ((unsigned char)src[i] < 32)
968 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
973 return ((int) vb->val_len);
974 } /* }}} int csnmp_strvbcopy */
976 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
977 csnmp_list_instances_t **tail,
978 const struct snmp_pdu *res)
980 csnmp_list_instances_t *il;
981 struct variable_list *vb;
983 /* Set vb on the last variable */
984 for (vb = res->variables;
985 (vb != NULL) && (vb->next_variable != NULL);
986 vb = vb->next_variable)
991 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
994 ERROR ("snmp plugin: malloc failed.");
997 il->subid = vb->name[vb->name_length - 1];
1000 /* Get instance name */
1001 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
1005 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
1007 for (ptr = il->instance; *ptr != '\0'; ptr++)
1009 if ((*ptr > 0) && (*ptr < 32))
1011 else if (*ptr == '/')
1014 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1018 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
1019 ssnprintf (il->instance, sizeof (il->instance),
1020 "%llu", val.counter);
1023 /* TODO: Debugging output */
1032 } /* int csnmp_instance_list_add */
1034 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1035 csnmp_list_instances_t *instance_list,
1036 csnmp_table_values_t **value_table)
1038 const data_set_t *ds;
1039 value_list_t vl = VALUE_LIST_INIT;
1041 csnmp_list_instances_t *instance_list_ptr;
1042 csnmp_table_values_t **value_table_ptr;
1048 ds = plugin_get_ds (data->type);
1051 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1054 assert (ds->ds_num == data->values_len);
1056 instance_list_ptr = instance_list;
1058 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1059 * data->values_len);
1060 if (value_table_ptr == NULL)
1062 for (i = 0; i < data->values_len; i++)
1063 value_table_ptr[i] = value_table[i];
1065 vl.values_len = ds->ds_num;
1066 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1067 if (vl.values == NULL)
1069 ERROR ("snmp plugin: malloc failed.");
1070 sfree (value_table_ptr);
1074 sstrncpy (vl.host, host->name, sizeof (vl.host));
1075 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1077 vl.interval = host->interval;
1082 while (have_more != 0)
1084 if (instance_list != NULL)
1086 while ((instance_list_ptr != NULL)
1087 && (instance_list_ptr->subid < subid))
1088 instance_list_ptr = instance_list_ptr->next;
1090 if (instance_list_ptr == NULL)
1095 else if (instance_list_ptr->subid > subid)
1097 subid = instance_list_ptr->subid;
1100 } /* if (instance_list != NULL) */
1102 for (i = 0; i < data->values_len; i++)
1104 while ((value_table_ptr[i] != NULL)
1105 && (value_table_ptr[i]->subid < subid))
1106 value_table_ptr[i] = value_table_ptr[i]->next;
1108 if (value_table_ptr[i] == NULL)
1113 else if (value_table_ptr[i]->subid > subid)
1115 subid = value_table_ptr[i]->subid;
1118 } /* for (i = 0; i < columns; i++) */
1119 /* The subid has been increased - start scanning from the beginning
1121 if (i < data->values_len)
1124 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1125 * to the same subid. instance_list_ptr is either NULL or points to the
1126 * same subid, too. */
1128 for (i = 1; i < data->values_len; i++)
1130 assert (value_table_ptr[i] != NULL);
1131 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
1133 assert ((instance_list_ptr == NULL)
1134 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
1137 sstrncpy (vl.type, data->type, sizeof (vl.type));
1140 char temp[DATA_MAX_NAME_LEN];
1142 if (instance_list_ptr == NULL)
1143 ssnprintf (temp, sizeof (temp), "%"PRIu32, (uint32_t) subid);
1145 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1147 if (data->instance_prefix == NULL)
1148 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1150 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1151 data->instance_prefix, temp);
1154 for (i = 0; i < data->values_len; i++)
1155 vl.values[i] = value_table_ptr[i]->value;
1157 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1158 plugin_dispatch_values (&vl);
1161 } /* while (have_more != 0) */
1164 sfree (value_table_ptr);
1167 } /* int csnmp_dispatch_table */
1169 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1171 struct snmp_pdu *req;
1172 struct snmp_pdu *res;
1173 struct variable_list *vb;
1175 const data_set_t *ds;
1177 uint32_t oid_list_len;
1182 /* `value_table' and `value_table_ptr' implement a linked list for each
1183 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1184 * instance names. This is used to jump gaps in the table. */
1185 csnmp_list_instances_t *instance_list;
1186 csnmp_list_instances_t *instance_list_ptr;
1187 csnmp_table_values_t **value_table;
1188 csnmp_table_values_t **value_table_ptr;
1190 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1191 host->name, data->name);
1193 if (host->sess_handle == NULL)
1195 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1199 ds = plugin_get_ds (data->type);
1202 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1206 if (ds->ds_num != data->values_len)
1208 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1209 data->type, ds->ds_num, data->values_len);
1213 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1214 oid_list_len = data->values_len + 1;
1215 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1216 if (oid_list == NULL)
1218 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1221 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1222 if (data->instance.oid.oid_len > 0)
1223 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1227 /* Allocate the `value_table' */
1228 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1229 * 2 * data->values_len);
1230 if (value_table == NULL)
1232 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1236 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1237 value_table_ptr = value_table + data->values_len;
1239 instance_list = NULL;
1240 instance_list_ptr = NULL;
1245 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1248 ERROR ("snmp plugin: snmp_pdu_create failed.");
1253 for (i = 0; (uint32_t) i < oid_list_len; i++)
1254 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1257 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1259 if ((status != STAT_SUCCESS) || (res == NULL))
1261 char *errstr = NULL;
1263 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1265 c_complain (LOG_ERR, &host->complaint,
1266 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1267 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1270 snmp_free_pdu (res);
1274 csnmp_host_close_session (host);
1280 assert (res != NULL);
1281 c_release (LOG_INFO, &host->complaint,
1282 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1285 vb = res->variables;
1292 /* Check if all values (and possibly the instance) have left their
1294 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1300 /* if an instance-OID is configured.. */
1301 if (data->instance.oid.oid_len > 0)
1303 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1304 * add it to the list */
1305 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1308 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1313 /* Set vb on the last variable */
1314 for (vb = res->variables;
1315 (vb != NULL) && (vb->next_variable != NULL);
1316 vb = vb->next_variable)
1318 assert (vb != NULL);
1320 /* Copy OID to oid_list[data->values_len] */
1321 memcpy (oid_list[data->values_len].oid, vb->name,
1322 sizeof (oid) * vb->name_length);
1323 oid_list[data->values_len].oid_len = vb->name_length;
1326 for (vb = res->variables, i = 0;
1327 (vb != NULL) && (i < data->values_len);
1328 vb = vb->next_variable, i++)
1330 csnmp_table_values_t *vt;
1332 /* Check if we left the subtree */
1333 if (snmp_oid_ncompare (data->values[i].oid,
1334 data->values[i].oid_len,
1335 vb->name, vb->name_length,
1336 data->values[i].oid_len) != 0)
1338 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1339 host->name, data->name, i);
1343 if ((value_table_ptr[i] != NULL)
1344 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1346 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1347 "SUBID is not increasing.",
1348 host->name, data->name, i);
1352 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1355 ERROR ("snmp plugin: malloc failed.");
1360 vt->subid = vb->name[vb->name_length - 1];
1361 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1362 data->scale, data->shift);
1365 if (value_table_ptr[i] == NULL)
1366 value_table[i] = vt;
1368 value_table_ptr[i]->next = vt;
1369 value_table_ptr[i] = vt;
1371 /* Copy OID to oid_list[i + 1] */
1372 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1373 oid_list[i].oid_len = vb->name_length;
1374 } /* for (i = data->values_len) */
1377 snmp_free_pdu (res);
1379 } /* while (status == 0) */
1382 snmp_free_pdu (res);
1386 csnmp_dispatch_table (host, data, instance_list, value_table);
1388 /* Free all allocated variables here */
1389 while (instance_list != NULL)
1391 instance_list_ptr = instance_list->next;
1392 sfree (instance_list);
1393 instance_list = instance_list_ptr;
1396 for (i = 0; i < data->values_len; i++)
1398 csnmp_table_values_t *tmp;
1399 while (value_table[i] != NULL)
1401 tmp = value_table[i]->next;
1402 sfree (value_table[i]);
1403 value_table[i] = tmp;
1407 sfree (value_table);
1411 } /* int csnmp_read_table */
1413 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1415 struct snmp_pdu *req;
1416 struct snmp_pdu *res;
1417 struct variable_list *vb;
1419 const data_set_t *ds;
1420 value_list_t vl = VALUE_LIST_INIT;
1425 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1426 host->name, data->name);
1428 if (host->sess_handle == NULL)
1430 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1434 ds = plugin_get_ds (data->type);
1437 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1441 if (ds->ds_num != data->values_len)
1443 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1444 data->type, ds->ds_num, data->values_len);
1448 vl.values_len = ds->ds_num;
1449 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1450 if (vl.values == NULL)
1452 for (i = 0; i < vl.values_len; i++)
1454 if (ds->ds[i].type == DS_TYPE_COUNTER)
1455 vl.values[i].counter = 0;
1457 vl.values[i].gauge = NAN;
1460 sstrncpy (vl.host, host->name, sizeof (vl.host));
1461 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1462 sstrncpy (vl.type, data->type, sizeof (vl.type));
1463 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1465 vl.interval = host->interval;
1467 req = snmp_pdu_create (SNMP_MSG_GET);
1470 ERROR ("snmp plugin: snmp_pdu_create failed.");
1475 for (i = 0; i < data->values_len; i++)
1476 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1479 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1481 if ((status != STAT_SUCCESS) || (res == NULL))
1483 char *errstr = NULL;
1485 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1486 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1487 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1490 snmp_free_pdu (res);
1494 csnmp_host_close_session (host);
1500 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1504 snprint_variable (buffer, sizeof (buffer),
1505 vb->name, vb->name_length, vb);
1506 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1507 #endif /* COLLECT_DEBUG */
1509 for (i = 0; i < data->values_len; i++)
1510 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1511 vb->name, vb->name_length) == 0)
1512 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1513 data->scale, data->shift);
1514 } /* for (res->variables) */
1517 snmp_free_pdu (res);
1520 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1521 plugin_dispatch_values (&vl);
1525 } /* int csnmp_read_value */
1527 static int csnmp_read_host (user_data_t *ud)
1529 host_definition_t *host;
1530 cdtime_t time_start;
1538 if (host->interval == 0)
1539 host->interval = interval_g;
1541 time_start = cdtime ();
1543 if (host->sess_handle == NULL)
1544 csnmp_host_open_session (host);
1546 if (host->sess_handle == NULL)
1550 for (i = 0; i < host->data_list_len; i++)
1552 data_definition_t *data = host->data_list[i];
1555 status = csnmp_read_table (host, data);
1557 status = csnmp_read_value (host, data);
1563 time_end = cdtime ();
1564 if ((time_end - time_start) > host->interval)
1566 WARNING ("snmp plugin: Host `%s' should be queried every %.3f "
1567 "seconds, but reading all values takes %.3f seconds.",
1569 CDTIME_T_TO_DOUBLE (host->interval),
1570 CDTIME_T_TO_DOUBLE (time_end - time_start));
1577 } /* int csnmp_read_host */
1579 static int csnmp_init (void)
1581 call_snmp_init_once ();
1584 } /* int csnmp_init */
1586 static int csnmp_shutdown (void)
1588 data_definition_t *data_this;
1589 data_definition_t *data_next;
1591 /* When we get here, the read threads have been stopped and all the
1592 * `host_definition_t' will be freed. */
1593 DEBUG ("snmp plugin: Destroying all data definitions.");
1595 data_this = data_head;
1597 while (data_this != NULL)
1599 data_next = data_this->next;
1601 sfree (data_this->name);
1602 sfree (data_this->type);
1603 sfree (data_this->values);
1606 data_this = data_next;
1610 } /* int csnmp_shutdown */
1612 void module_register (void)
1614 plugin_register_complex_config ("snmp", csnmp_config);
1615 plugin_register_init ("snmp", csnmp_init);
1616 plugin_register_shutdown ("snmp", csnmp_shutdown);
1617 } /* void module_register */
1620 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker