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;
74 data_definition_t **data_list;
76 enum /******************************************************/
78 STATE_IDLE, /* - just sits there until `next_update < interval_g' */
79 STATE_WAIT, /* - waits to be queried. */
80 STATE_BUSY /* - is currently being queried. */
81 } state; /******************************************************/
82 struct host_definition_s *next;
84 typedef struct host_definition_s host_definition_t;
86 /* These two types are used to cache values in `csnmp_read_table' to handle
88 struct csnmp_list_instances_s
91 char instance[DATA_MAX_NAME_LEN];
92 struct csnmp_list_instances_s *next;
94 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
96 struct csnmp_table_values_s
100 struct csnmp_table_values_s *next;
102 typedef struct csnmp_table_values_s csnmp_table_values_t;
107 static int do_shutdown = 0;
109 pthread_t *threads = NULL;
112 static data_definition_t *data_head = NULL;
113 static host_definition_t *host_head = NULL;
115 static pthread_mutex_t host_lock = PTHREAD_MUTEX_INITIALIZER;
116 static pthread_cond_t host_cond = PTHREAD_COND_INITIALIZER;
121 /* Many functions to handle the configuration. {{{ */
122 /* First there are many functions which do configuration stuff. It's a big
123 * bloated and messy, I'm afraid. */
126 * Callgraph for the config stuff:
128 * +-> call_snmp_init_once
129 * +-> csnmp_config_add_data
130 * ! +-> csnmp_config_add_data_type
131 * ! +-> csnmp_config_add_data_table
132 * ! +-> csnmp_config_add_data_instance
133 * ! +-> csnmp_config_add_data_instance_prefix
134 * ! +-> csnmp_config_add_data_values
135 * +-> csnmp_config_add_host
136 * +-> csnmp_config_add_host_address
137 * +-> csnmp_config_add_host_community
138 * +-> csnmp_config_add_host_version
139 * +-> csnmp_config_add_host_collect
140 * +-> csnmp_config_add_host_interval
142 static void call_snmp_init_once (void)
144 static int have_init = 0;
147 init_snmp (PACKAGE_NAME);
149 } /* void call_snmp_init_once */
151 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
153 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
155 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
160 dd->type = strdup (ci->values[0].value.string);
161 if (dd->type == NULL)
165 } /* int csnmp_config_add_data_type */
167 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
169 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
171 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
175 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
178 } /* int csnmp_config_add_data_table */
180 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
182 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
184 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
190 /* Instance is an OID */
191 dd->instance.oid.oid_len = MAX_OID_LEN;
193 if (!read_objid (ci->values[0].value.string,
194 dd->instance.oid.oid, &dd->instance.oid.oid_len))
196 ERROR ("snmp plugin: read_objid (%s) failed.",
197 ci->values[0].value.string);
203 /* Instance is a simple string */
204 sstrncpy (dd->instance.string, ci->values[0].value.string,
205 sizeof (dd->instance.string));
209 } /* int csnmp_config_add_data_instance */
211 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
214 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
216 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
222 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
223 "is set to `false'.", dd->name);
227 sfree (dd->instance_prefix);
228 dd->instance_prefix = strdup (ci->values[0].value.string);
229 if (dd->instance_prefix == NULL)
233 } /* int csnmp_config_add_data_instance_prefix */
235 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
239 if (ci->values_num < 1)
241 WARNING ("snmp plugin: `Values' needs at least one argument.");
245 for (i = 0; i < ci->values_num; i++)
246 if (ci->values[i].type != OCONFIG_TYPE_STRING)
248 WARNING ("snmp plugin: `Values' needs only string argument.");
254 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
255 if (dd->values == NULL)
257 dd->values_len = ci->values_num;
259 for (i = 0; i < ci->values_num; i++)
261 dd->values[i].oid_len = MAX_OID_LEN;
263 if (NULL == snmp_parse_oid (ci->values[i].value.string,
264 dd->values[i].oid, &dd->values[i].oid_len))
266 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
267 ci->values[i].value.string);
276 } /* int csnmp_config_add_data_instance */
278 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
280 if ((ci->values_num != 1)
281 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
283 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
287 dd->shift = ci->values[0].value.number;
290 } /* int csnmp_config_add_data_shift */
292 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
294 if ((ci->values_num != 1)
295 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
297 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
301 dd->scale = ci->values[0].value.number;
304 } /* int csnmp_config_add_data_scale */
306 static int csnmp_config_add_data (oconfig_item_t *ci)
308 data_definition_t *dd;
312 if ((ci->values_num != 1)
313 || (ci->values[0].type != OCONFIG_TYPE_STRING))
315 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
319 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
322 memset (dd, '\0', sizeof (data_definition_t));
324 dd->name = strdup (ci->values[0].value.string);
325 if (dd->name == NULL)
333 for (i = 0; i < ci->children_num; i++)
335 oconfig_item_t *option = ci->children + i;
338 if (strcasecmp ("Type", option->key) == 0)
339 status = csnmp_config_add_data_type (dd, option);
340 else if (strcasecmp ("Table", option->key) == 0)
341 status = csnmp_config_add_data_table (dd, option);
342 else if (strcasecmp ("Instance", option->key) == 0)
343 status = csnmp_config_add_data_instance (dd, option);
344 else if (strcasecmp ("InstancePrefix", option->key) == 0)
345 status = csnmp_config_add_data_instance_prefix (dd, option);
346 else if (strcasecmp ("Values", option->key) == 0)
347 status = csnmp_config_add_data_values (dd, option);
348 else if (strcasecmp ("Shift", option->key) == 0)
349 status = csnmp_config_add_data_shift (dd, option);
350 else if (strcasecmp ("Scale", option->key) == 0)
351 status = csnmp_config_add_data_scale (dd, option);
354 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
360 } /* for (ci->children) */
364 if (dd->type == NULL)
366 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
370 if (dd->values == NULL)
372 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
378 } /* while (status == 0) */
383 sfree (dd->instance_prefix);
389 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
390 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
392 if (data_head == NULL)
396 data_definition_t *last;
398 while (last->next != NULL)
404 } /* int csnmp_config_add_data */
406 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
408 if ((ci->values_num != 1)
409 || (ci->values[0].type != OCONFIG_TYPE_STRING))
411 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
415 if (hd->address == NULL)
418 hd->address = strdup (ci->values[0].value.string);
419 if (hd->address == NULL)
422 DEBUG ("snmp plugin: host = %s; host->address = %s;",
423 hd->name, hd->address);
426 } /* int csnmp_config_add_host_address */
428 static int csnmp_config_add_host_community (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 `Community' config option needs exactly one string argument.");
437 if (hd->community == NULL)
438 free (hd->community);
440 hd->community = strdup (ci->values[0].value.string);
441 if (hd->community == NULL)
444 DEBUG ("snmp plugin: host = %s; host->community = %s;",
445 hd->name, hd->community);
448 } /* int csnmp_config_add_host_community */
450 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
454 if ((ci->values_num != 1)
455 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
457 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
461 version = (int) ci->values[0].value.number;
462 if ((version != 1) && (version != 2))
464 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
468 hd->version = version;
471 } /* int csnmp_config_add_host_address */
473 static int csnmp_config_add_host_collect (host_definition_t *host,
476 data_definition_t *data;
477 data_definition_t **data_list;
481 if (ci->values_num < 1)
483 WARNING ("snmp plugin: `Collect' needs at least one argument.");
487 for (i = 0; i < ci->values_num; i++)
488 if (ci->values[i].type != OCONFIG_TYPE_STRING)
490 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
494 data_list_len = host->data_list_len + ci->values_num;
495 data_list = (data_definition_t **) realloc (host->data_list,
496 sizeof (data_definition_t *) * data_list_len);
497 if (data_list == NULL)
499 host->data_list = data_list;
501 for (i = 0; i < ci->values_num; i++)
503 for (data = data_head; data != NULL; data = data->next)
504 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
509 WARNING ("snmp plugin: No such data configured: `%s'",
510 ci->values[i].value.string);
514 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
515 host->name, host->data_list_len, data->name);
517 host->data_list[host->data_list_len] = data;
518 host->data_list_len++;
519 } /* for (values_num) */
522 } /* int csnmp_config_add_host_collect */
524 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
526 if ((ci->values_num != 1)
527 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
529 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
533 hd->interval = ci->values[0].value.number >= 0
534 ? (uint32_t) ci->values[0].value.number
538 } /* int csnmp_config_add_host_interval */
540 static int csnmp_config_add_host (oconfig_item_t *ci)
542 host_definition_t *hd;
546 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
548 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
552 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
555 memset (hd, '\0', sizeof (host_definition_t));
557 C_COMPLAIN_INIT (&hd->complaint);
559 hd->name = strdup (ci->values[0].value.string);
560 if (hd->name == NULL)
566 hd->sess_handle = NULL;
569 hd->state = STATE_IDLE;
571 for (i = 0; i < ci->children_num; i++)
573 oconfig_item_t *option = ci->children + i;
576 if (strcasecmp ("Address", option->key) == 0)
577 status = csnmp_config_add_host_address (hd, option);
578 else if (strcasecmp ("Community", option->key) == 0)
579 status = csnmp_config_add_host_community (hd, option);
580 else if (strcasecmp ("Version", option->key) == 0)
581 status = csnmp_config_add_host_version (hd, option);
582 else if (strcasecmp ("Collect", option->key) == 0)
583 csnmp_config_add_host_collect (hd, option);
584 else if (strcasecmp ("Interval", option->key) == 0)
585 csnmp_config_add_host_interval (hd, option);
588 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
594 } /* for (ci->children) */
598 if (hd->address == NULL)
600 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
604 if (hd->community == NULL)
606 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
612 } /* while (status == 0) */
621 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
622 hd->name, hd->address, hd->community, hd->version);
624 if (host_head == NULL)
628 host_definition_t *last;
630 while (last->next != NULL)
636 } /* int csnmp_config_add_host */
638 static int csnmp_config (oconfig_item_t *ci)
642 call_snmp_init_once ();
644 for (i = 0; i < ci->children_num; i++)
646 oconfig_item_t *child = ci->children + i;
647 if (strcasecmp ("Data", child->key) == 0)
648 csnmp_config_add_data (child);
649 else if (strcasecmp ("Host", child->key) == 0)
650 csnmp_config_add_host (child);
653 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
655 } /* for (ci->children) */
658 } /* int csnmp_config */
660 /* }}} End of the config stuff. Now the interesting part begins */
662 static void csnmp_host_close_session (host_definition_t *host)
664 if (host->sess_handle == NULL)
667 snmp_sess_close (host->sess_handle);
668 host->sess_handle = NULL;
669 } /* void csnmp_host_close_session */
671 static void csnmp_host_open_session (host_definition_t *host)
673 struct snmp_session sess;
675 if (host->sess_handle != NULL)
676 csnmp_host_close_session (host);
678 snmp_sess_init (&sess);
679 sess.peername = host->address;
680 sess.community = (u_char *) host->community;
681 sess.community_len = strlen (host->community);
682 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
684 /* snmp_sess_open will copy the `struct snmp_session *'. */
685 host->sess_handle = snmp_sess_open (&sess);
687 if (host->sess_handle == NULL)
691 snmp_error (&sess, NULL, NULL, &errstr);
693 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
694 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
697 } /* void csnmp_host_open_session */
699 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
700 double scale, double shift)
706 if ((vl->type == ASN_INTEGER)
707 || (vl->type == ASN_UINTEGER)
708 || (vl->type == ASN_COUNTER)
710 || (vl->type == ASN_TIMETICKS)
712 || (vl->type == ASN_GAUGE))
714 temp = (uint32_t) *vl->val.integer;
715 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", temp);
717 else if (vl->type == ASN_COUNTER64)
719 temp = (uint32_t) vl->val.counter64->high;
721 temp += (uint32_t) vl->val.counter64->low;
722 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", temp);
724 else if (vl->type == ASN_OCTET_STR)
726 /* We'll handle this later.. */
730 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
734 if (vl->type == ASN_OCTET_STR)
739 if (vl->val.string != NULL)
742 size_t string_length;
744 string_length = sizeof (string) - 1;
745 if (vl->val_len < string_length)
746 string_length = vl->val_len;
748 /* The strings we get from the Net-SNMP library may not be null
749 * terminated. That is why we're using `membpy' here and not `strcpy'.
750 * `string_length' is set to `vl->val_len' which holds the length of the
752 memcpy (string, vl->val.string, string_length);
753 string[string_length] = 0;
755 if (type == DS_TYPE_COUNTER)
757 ret.counter = (counter_t) strtoll (string, &endptr, /* base = */ 0);
758 DEBUG ("snmp plugin: csnmp_value_list_to_value: String to counter: %s -> %llu",
759 string, (unsigned long long) ret.counter);
761 else if (type == DS_TYPE_GAUGE)
763 ret.gauge = (gauge_t) strtod (string, &endptr);
764 DEBUG ("snmp plugin: csnmp_value_list_to_value: String to gauge: %s -> %g",
765 string, (double) ret.gauge);
769 /* Check if an error occurred */
770 if ((vl->val.string == NULL) || (endptr == (char *) vl->val.string))
772 if (type == DS_TYPE_COUNTER)
774 else if (type == DS_TYPE_GAUGE)
778 else if (type == DS_TYPE_COUNTER)
782 else if (type == DS_TYPE_GAUGE)
786 ret.gauge = (scale * temp) + shift;
790 } /* value_t csnmp_value_list_to_value */
792 /* Returns true if all OIDs have left their subtree */
793 static int csnmp_check_res_left_subtree (const host_definition_t *host,
794 const data_definition_t *data,
795 struct snmp_pdu *res)
797 struct variable_list *vb;
799 int num_left_subtree;
807 num_left_subtree = 0;
809 /* check all the variables and count how many have left their subtree */
810 for (vb = res->variables, i = 0;
811 (vb != NULL) && (i < data->values_len);
812 vb = vb->next_variable, i++)
815 if (snmp_oid_ncompare (data->values[i].oid,
816 data->values[i].oid_len,
817 vb->name, vb->name_length,
818 data->values[i].oid_len) != 0)
822 /* check if enough variables have been returned */
823 if (i < data->values_len)
825 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
826 host->name, data->values_len, i);
830 if (data->instance.oid.oid_len > 0)
834 ERROR ("snmp plugin: host %s: Expected one more variable for "
835 "the instance..", host->name);
840 if (snmp_oid_ncompare (data->instance.oid.oid,
841 data->instance.oid.oid_len,
842 vb->name, vb->name_length,
843 data->instance.oid.oid_len) != 0)
847 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
848 "left their subtree",
849 num_left_subtree, num_checked);
850 if (num_left_subtree >= num_checked)
853 } /* int csnmp_check_res_left_subtree */
855 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
856 csnmp_list_instances_t **tail,
857 const struct snmp_pdu *res)
859 csnmp_list_instances_t *il;
860 struct variable_list *vb;
862 /* Set vb on the last variable */
863 for (vb = res->variables;
864 (vb != NULL) && (vb->next_variable != NULL);
865 vb = vb->next_variable)
870 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
873 ERROR ("snmp plugin: malloc failed.");
876 il->subid = vb->name[vb->name_length - 1];
879 /* Get instance name */
880 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
885 memset (il->instance, 0, sizeof (il->instance));
886 instance_len = sizeof (il->instance) - 1;
887 if (instance_len > vb->val_len)
888 instance_len = vb->val_len;
890 sstrncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
892 : vb->val.bitstring),
895 for (ptr = il->instance; *ptr != '\0'; ptr++)
897 if ((*ptr > 0) && (*ptr < 32))
899 else if (*ptr == '/')
902 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
906 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
907 ssnprintf (il->instance, sizeof (il->instance),
908 "%llu", val.counter);
911 /* TODO: Debugging output */
920 } /* int csnmp_instance_list_add */
922 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
923 csnmp_list_instances_t *instance_list,
924 csnmp_table_values_t **value_table)
926 const data_set_t *ds;
927 value_list_t vl = VALUE_LIST_INIT;
929 csnmp_list_instances_t *instance_list_ptr;
930 csnmp_table_values_t **value_table_ptr;
936 ds = plugin_get_ds (data->type);
939 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
942 assert (ds->ds_num == data->values_len);
944 instance_list_ptr = instance_list;
946 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
948 if (value_table_ptr == NULL)
950 for (i = 0; i < data->values_len; i++)
951 value_table_ptr[i] = value_table[i];
953 vl.values_len = ds->ds_num;
954 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
955 if (vl.values == NULL)
957 ERROR ("snmp plugin: malloc failed.");
958 sfree (value_table_ptr);
962 sstrncpy (vl.host, host->name, sizeof (vl.host));
963 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
965 vl.interval = host->interval;
970 while (have_more != 0)
972 if (instance_list != NULL)
974 while ((instance_list_ptr != NULL)
975 && (instance_list_ptr->subid < subid))
976 instance_list_ptr = instance_list_ptr->next;
978 if (instance_list_ptr == NULL)
983 else if (instance_list_ptr->subid > subid)
985 subid = instance_list_ptr->subid;
988 } /* if (instance_list != NULL) */
990 for (i = 0; i < data->values_len; i++)
992 while ((value_table_ptr[i] != NULL)
993 && (value_table_ptr[i]->subid < subid))
994 value_table_ptr[i] = value_table_ptr[i]->next;
996 if (value_table_ptr[i] == NULL)
1001 else if (value_table_ptr[i]->subid > subid)
1003 subid = value_table_ptr[i]->subid;
1006 } /* for (i = 0; i < columns; i++) */
1007 /* The subid has been increased - start scanning from the beginning
1009 if (i < data->values_len)
1012 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1013 * to the same subid. instance_list_ptr is either NULL or points to the
1014 * same subid, too. */
1016 for (i = 1; i < data->values_len; i++)
1018 assert (value_table_ptr[i] != NULL);
1019 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
1021 assert ((instance_list_ptr == NULL)
1022 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
1025 sstrncpy (vl.type, data->type, sizeof (vl.type));
1028 char temp[DATA_MAX_NAME_LEN];
1030 if (instance_list_ptr == NULL)
1031 ssnprintf (temp, sizeof (temp), "%u", (uint32_t) subid);
1033 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1035 if (data->instance_prefix == NULL)
1036 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1038 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1039 data->instance_prefix, temp);
1042 for (i = 0; i < data->values_len; i++)
1043 vl.values[i] = value_table_ptr[i]->value;
1045 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1046 plugin_dispatch_values (&vl);
1049 } /* while (have_more != 0) */
1052 sfree (value_table_ptr);
1055 } /* int csnmp_dispatch_table */
1057 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1059 struct snmp_pdu *req;
1060 struct snmp_pdu *res;
1061 struct variable_list *vb;
1063 const data_set_t *ds;
1065 uint32_t oid_list_len;
1070 /* `value_table' and `value_table_ptr' implement a linked list for each
1071 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1072 * instance names. This is used to jump gaps in the table. */
1073 csnmp_list_instances_t *instance_list;
1074 csnmp_list_instances_t *instance_list_ptr;
1075 csnmp_table_values_t **value_table;
1076 csnmp_table_values_t **value_table_ptr;
1078 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1079 host->name, data->name);
1081 if (host->sess_handle == NULL)
1083 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1087 ds = plugin_get_ds (data->type);
1090 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1094 if (ds->ds_num != data->values_len)
1096 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1097 data->type, ds->ds_num, data->values_len);
1101 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1102 oid_list_len = data->values_len + 1;
1103 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1104 if (oid_list == NULL)
1106 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1109 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1110 if (data->instance.oid.oid_len > 0)
1111 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1115 /* Allocate the `value_table' */
1116 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1117 * 2 * data->values_len);
1118 if (value_table == NULL)
1120 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1124 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1125 value_table_ptr = value_table + data->values_len;
1127 instance_list = NULL;
1128 instance_list_ptr = NULL;
1133 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1136 ERROR ("snmp plugin: snmp_pdu_create failed.");
1141 for (i = 0; (uint32_t) i < oid_list_len; i++)
1142 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1145 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1147 if ((status != STAT_SUCCESS) || (res == NULL))
1149 char *errstr = NULL;
1151 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1153 c_complain (LOG_ERR, &host->complaint,
1154 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1155 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1158 snmp_free_pdu (res);
1162 csnmp_host_close_session (host);
1168 assert (res != NULL);
1169 c_release (LOG_INFO, &host->complaint,
1170 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1173 vb = res->variables;
1180 /* Check if all values (and possibly the instance) have left their
1182 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1188 /* if an instance-OID is configured.. */
1189 if (data->instance.oid.oid_len > 0)
1191 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1192 * add it to the list */
1193 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1196 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1201 /* Set vb on the last variable */
1202 for (vb = res->variables;
1203 (vb != NULL) && (vb->next_variable != NULL);
1204 vb = vb->next_variable)
1206 assert (vb != NULL);
1208 /* Copy OID to oid_list[data->values_len] */
1209 memcpy (oid_list[data->values_len].oid, vb->name,
1210 sizeof (oid) * vb->name_length);
1211 oid_list[data->values_len].oid_len = vb->name_length;
1214 for (vb = res->variables, i = 0;
1215 (vb != NULL) && (i < data->values_len);
1216 vb = vb->next_variable, i++)
1218 csnmp_table_values_t *vt;
1220 /* Check if we left the subtree */
1221 if (snmp_oid_ncompare (data->values[i].oid,
1222 data->values[i].oid_len,
1223 vb->name, vb->name_length,
1224 data->values[i].oid_len) != 0)
1226 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1227 host->name, data->name, i);
1231 if ((value_table_ptr[i] != NULL)
1232 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1234 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1235 "SUBID is not increasing.",
1236 host->name, data->name, i);
1240 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1243 ERROR ("snmp plugin: malloc failed.");
1248 vt->subid = vb->name[vb->name_length - 1];
1249 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1250 data->scale, data->shift);
1253 if (value_table_ptr[i] == NULL)
1254 value_table[i] = vt;
1256 value_table_ptr[i]->next = vt;
1257 value_table_ptr[i] = vt;
1259 /* Copy OID to oid_list[i + 1] */
1260 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1261 oid_list[i].oid_len = vb->name_length;
1262 } /* for (i = data->values_len) */
1265 snmp_free_pdu (res);
1267 } /* while (status == 0) */
1270 snmp_free_pdu (res);
1274 csnmp_dispatch_table (host, data, instance_list, value_table);
1276 /* Free all allocated variables here */
1277 while (instance_list != NULL)
1279 instance_list_ptr = instance_list->next;
1280 sfree (instance_list);
1281 instance_list = instance_list_ptr;
1284 for (i = 0; i < data->values_len; i++)
1286 csnmp_table_values_t *tmp;
1287 while (value_table[i] != NULL)
1289 tmp = value_table[i]->next;
1290 sfree (value_table[i]);
1291 value_table[i] = tmp;
1295 sfree (value_table);
1299 } /* int csnmp_read_table */
1301 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1303 struct snmp_pdu *req;
1304 struct snmp_pdu *res;
1305 struct variable_list *vb;
1307 const data_set_t *ds;
1308 value_list_t vl = VALUE_LIST_INIT;
1313 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1314 host->name, data->name);
1316 if (host->sess_handle == NULL)
1318 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1322 ds = plugin_get_ds (data->type);
1325 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1329 if (ds->ds_num != data->values_len)
1331 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1332 data->type, ds->ds_num, data->values_len);
1336 vl.values_len = ds->ds_num;
1337 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1338 if (vl.values == NULL)
1340 for (i = 0; i < vl.values_len; i++)
1342 if (ds->ds[i].type == DS_TYPE_COUNTER)
1343 vl.values[i].counter = 0;
1345 vl.values[i].gauge = NAN;
1348 sstrncpy (vl.host, host->name, sizeof (vl.host));
1349 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1350 sstrncpy (vl.type, data->type, sizeof (vl.type));
1351 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1353 vl.interval = host->interval;
1355 req = snmp_pdu_create (SNMP_MSG_GET);
1358 ERROR ("snmp plugin: snmp_pdu_create failed.");
1363 for (i = 0; i < data->values_len; i++)
1364 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1367 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1369 if ((status != STAT_SUCCESS) || (res == NULL))
1371 char *errstr = NULL;
1373 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1374 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1375 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1378 snmp_free_pdu (res);
1382 csnmp_host_close_session (host);
1388 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1392 snprint_variable (buffer, sizeof (buffer),
1393 vb->name, vb->name_length, vb);
1394 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1395 #endif /* COLLECT_DEBUG */
1397 for (i = 0; i < data->values_len; i++)
1398 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1399 vb->name, vb->name_length) == 0)
1400 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1401 data->scale, data->shift);
1402 } /* for (res->variables) */
1405 snmp_free_pdu (res);
1408 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1409 plugin_dispatch_values (&vl);
1413 } /* int csnmp_read_value */
1415 static int csnmp_read_host (host_definition_t *host)
1421 time_start = time (NULL);
1422 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1423 (unsigned int) time_start);
1425 if (host->sess_handle == NULL)
1426 csnmp_host_open_session (host);
1428 if (host->sess_handle == NULL)
1431 for (i = 0; i < host->data_list_len; i++)
1433 data_definition_t *data = host->data_list[i];
1436 csnmp_read_table (host, data);
1438 csnmp_read_value (host, data);
1441 time_end = time (NULL);
1442 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1443 (unsigned int) time_end);
1444 if ((uint32_t) (time_end - time_start) > host->interval)
1446 WARNING ("snmp plugin: Host `%s' should be queried every %i seconds, "
1447 "but reading all values takes %u seconds.",
1448 host->name, host->interval, (unsigned int) (time_end - time_start));
1452 } /* int csnmp_read_host */
1454 static void *csnmp_read_thread (void __attribute__((unused)) *data)
1456 host_definition_t *host;
1458 pthread_mutex_lock (&host_lock);
1459 while (do_shutdown == 0)
1461 pthread_cond_wait (&host_cond, &host_lock);
1463 for (host = host_head; host != NULL; host = host->next)
1465 if (do_shutdown != 0)
1467 if (host->state != STATE_WAIT)
1470 host->state = STATE_BUSY;
1471 pthread_mutex_unlock (&host_lock);
1472 csnmp_read_host (host);
1473 pthread_mutex_lock (&host_lock);
1474 host->state = STATE_IDLE;
1476 } /* while (do_shutdown == 0) */
1477 pthread_mutex_unlock (&host_lock);
1479 pthread_exit ((void *) 0);
1480 return ((void *) 0);
1481 } /* void *csnmp_read_thread */
1483 static int csnmp_init (void)
1485 host_definition_t *host;
1488 if (host_head == NULL)
1490 NOTICE ("snmp plugin: No host has been defined.");
1494 call_snmp_init_once ();
1497 for (host = host_head; host != NULL; host = host->next)
1500 /* We need to initialize `interval' here, because `interval_g' isn't
1501 * initialized during `configure'. */
1502 host->next_update = time (NULL);
1503 if (host->interval == 0)
1505 host->interval = interval_g;
1507 else if (host->interval < (uint32_t) interval_g)
1509 host->interval = interval_g;
1510 WARNING ("snmp plugin: Data for host `%s' will be collected every %i seconds.",
1511 host->name, host->interval);
1514 csnmp_host_open_session (host);
1517 /* Now start the reading threads */
1518 if (threads_num > 3)
1520 threads_num = 3 + ((threads_num - 3) / 10);
1521 if (threads_num > 10)
1525 threads = (pthread_t *) malloc (threads_num * sizeof (pthread_t));
1526 if (threads == NULL)
1528 ERROR ("snmp plugin: malloc failed.");
1531 memset (threads, '\0', threads_num * sizeof (pthread_t));
1533 for (i = 0; i < threads_num; i++)
1534 pthread_create (threads + i, NULL, csnmp_read_thread, (void *) 0);
1537 } /* int csnmp_init */
1539 static int csnmp_read (void)
1541 host_definition_t *host;
1544 if (host_head == NULL)
1546 INFO ("snmp plugin: No hosts configured.");
1552 pthread_mutex_lock (&host_lock);
1553 for (host = host_head; host != NULL; host = host->next)
1555 if (host->state != STATE_IDLE)
1558 /* Skip this host if the next or a later iteration will be sufficient. */
1559 if (host->next_update >= (now + interval_g))
1562 host->state = STATE_WAIT;
1563 host->next_update = now + host->interval;
1566 pthread_cond_broadcast (&host_cond);
1567 pthread_mutex_unlock (&host_lock);
1570 } /* int csnmp_read */
1572 static int csnmp_shutdown (void)
1574 host_definition_t *host_this;
1575 host_definition_t *host_next;
1577 data_definition_t *data_this;
1578 data_definition_t *data_next;
1582 pthread_mutex_lock (&host_lock);
1584 pthread_cond_broadcast (&host_cond);
1585 pthread_mutex_unlock (&host_lock);
1587 for (i = 0; i < threads_num; i++)
1588 pthread_join (threads[i], NULL);
1590 /* Now that all the threads have exited, let's free all the global variables.
1591 * This isn't really neccessary, I guess, but I think it's good stile to do
1593 host_this = host_head;
1595 while (host_this != NULL)
1597 host_next = host_this->next;
1599 csnmp_host_close_session (host_this);
1601 sfree (host_this->name);
1602 sfree (host_this->address);
1603 sfree (host_this->community);
1604 sfree (host_this->data_list);
1607 host_this = host_next;
1610 data_this = data_head;
1612 while (data_this != NULL)
1614 data_next = data_this->next;
1616 sfree (data_this->name);
1617 sfree (data_this->type);
1618 sfree (data_this->values);
1621 data_this = data_next;
1625 } /* int csnmp_shutdown */
1627 void module_register (void)
1629 plugin_register_complex_config ("snmp", csnmp_config);
1630 plugin_register_init ("snmp", csnmp_init);
1631 plugin_register_read ("snmp", csnmp_read);
1632 plugin_register_shutdown ("snmp", csnmp_shutdown);
1633 } /* void module_register */
1636 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker