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>
28 #include <net-snmp/net-snmp-config.h>
29 #include <net-snmp/net-snmp-includes.h>
32 * Private data structes
39 typedef struct oid_s oid_t;
43 char string[DATA_MAX_NAME_LEN];
46 typedef union instance_u instance_t;
48 struct data_definition_s
50 char *name; /* used to reference this from the `Collect' option */
51 char *type; /* used to find the data_set */
54 char *instance_prefix;
59 struct data_definition_s *next;
61 typedef struct data_definition_s data_definition_t;
63 struct host_definition_s
72 data_definition_t **data_list;
74 enum /******************************************************/
76 STATE_IDLE, /* - just sits there until `next_update < interval_g' */
77 STATE_WAIT, /* - waits to be queried. */
78 STATE_BUSY /* - is currently being queried. */
79 } state; /******************************************************/
80 struct host_definition_s *next;
82 typedef struct host_definition_s host_definition_t;
84 /* These two types are used to cache values in `csnmp_read_table' to handle
86 struct csnmp_list_instances_s
89 char instance[DATA_MAX_NAME_LEN];
90 struct csnmp_list_instances_s *next;
92 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
94 struct csnmp_table_values_s
98 struct csnmp_table_values_s *next;
100 typedef struct csnmp_table_values_s csnmp_table_values_t;
105 static int do_shutdown = 0;
107 pthread_t *threads = NULL;
110 static data_definition_t *data_head = NULL;
111 static host_definition_t *host_head = NULL;
113 static pthread_mutex_t host_lock = PTHREAD_MUTEX_INITIALIZER;
114 static pthread_cond_t host_cond = PTHREAD_COND_INITIALIZER;
119 /* First there are many functions which do configuration stuff. It's a big
120 * bloated and messy, I'm afraid. */
123 * Callgraph for the config stuff:
125 * +-> call_snmp_init_once
126 * +-> csnmp_config_add_data
127 * ! +-> csnmp_config_add_data_type
128 * ! +-> csnmp_config_add_data_table
129 * ! +-> csnmp_config_add_data_instance
130 * ! +-> csnmp_config_add_data_instance_prefix
131 * ! +-> csnmp_config_add_data_values
132 * +-> csnmp_config_add_host
133 * +-> csnmp_config_add_host_address
134 * +-> csnmp_config_add_host_community
135 * +-> csnmp_config_add_host_version
136 * +-> csnmp_config_add_host_collect
137 * +-> csnmp_config_add_host_interval
139 static void call_snmp_init_once (void)
141 static int have_init = 0;
144 init_snmp (PACKAGE_NAME);
146 } /* void call_snmp_init_once */
148 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
150 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
152 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
157 dd->type = strdup (ci->values[0].value.string);
158 if (dd->type == NULL)
162 } /* int csnmp_config_add_data_type */
164 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
166 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
168 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
172 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
175 } /* int csnmp_config_add_data_table */
177 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
179 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
181 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
187 /* Instance is an OID */
188 dd->instance.oid.oid_len = MAX_OID_LEN;
190 if (!read_objid (ci->values[0].value.string,
191 dd->instance.oid.oid, &dd->instance.oid.oid_len))
193 ERROR ("snmp plugin: read_objid (%s) failed.",
194 ci->values[0].value.string);
200 /* Instance is a simple string */
201 sstrncpy (dd->instance.string, ci->values[0].value.string,
202 sizeof (dd->instance.string));
206 } /* int csnmp_config_add_data_instance */
208 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
211 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
213 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
219 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
220 "is set to `false'.", dd->name);
224 sfree (dd->instance_prefix);
225 dd->instance_prefix = strdup (ci->values[0].value.string);
226 if (dd->instance_prefix == NULL)
230 } /* int csnmp_config_add_data_instance_prefix */
232 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
236 if (ci->values_num < 1)
238 WARNING ("snmp plugin: `Values' needs at least one argument.");
242 for (i = 0; i < ci->values_num; i++)
243 if (ci->values[i].type != OCONFIG_TYPE_STRING)
245 WARNING ("snmp plugin: `Values' needs only string argument.");
251 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
252 if (dd->values == NULL)
254 dd->values_len = ci->values_num;
256 for (i = 0; i < ci->values_num; i++)
258 dd->values[i].oid_len = MAX_OID_LEN;
260 if (NULL == snmp_parse_oid (ci->values[i].value.string,
261 dd->values[i].oid, &dd->values[i].oid_len))
263 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
264 ci->values[i].value.string);
273 } /* int csnmp_config_add_data_instance */
275 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
277 if ((ci->values_num != 1)
278 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
280 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
284 dd->shift = ci->values[0].value.number;
287 } /* int csnmp_config_add_data_shift */
289 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
291 if ((ci->values_num != 1)
292 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
294 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
298 dd->scale = ci->values[0].value.number;
301 } /* int csnmp_config_add_data_scale */
303 static int csnmp_config_add_data (oconfig_item_t *ci)
305 data_definition_t *dd;
309 if ((ci->values_num != 1)
310 || (ci->values[0].type != OCONFIG_TYPE_STRING))
312 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
316 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
319 memset (dd, '\0', sizeof (data_definition_t));
321 dd->name = strdup (ci->values[0].value.string);
322 if (dd->name == NULL)
330 for (i = 0; i < ci->children_num; i++)
332 oconfig_item_t *option = ci->children + i;
335 if (strcasecmp ("Type", option->key) == 0)
336 status = csnmp_config_add_data_type (dd, option);
337 else if (strcasecmp ("Table", option->key) == 0)
338 status = csnmp_config_add_data_table (dd, option);
339 else if (strcasecmp ("Instance", option->key) == 0)
340 status = csnmp_config_add_data_instance (dd, option);
341 else if (strcasecmp ("InstancePrefix", option->key) == 0)
342 status = csnmp_config_add_data_instance_prefix (dd, option);
343 else if (strcasecmp ("Values", option->key) == 0)
344 status = csnmp_config_add_data_values (dd, option);
345 else if (strcasecmp ("Shift", option->key) == 0)
346 status = csnmp_config_add_data_shift (dd, option);
347 else if (strcasecmp ("Scale", option->key) == 0)
348 status = csnmp_config_add_data_scale (dd, option);
351 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
357 } /* for (ci->children) */
361 if (dd->type == NULL)
363 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
367 if (dd->values == NULL)
369 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
375 } /* while (status == 0) */
380 sfree (dd->instance_prefix);
386 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
387 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
389 if (data_head == NULL)
393 data_definition_t *last;
395 while (last->next != NULL)
401 } /* int csnmp_config_add_data */
403 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
405 if ((ci->values_num != 1)
406 || (ci->values[0].type != OCONFIG_TYPE_STRING))
408 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
412 if (hd->address == NULL)
415 hd->address = strdup (ci->values[0].value.string);
416 if (hd->address == NULL)
419 DEBUG ("snmp plugin: host = %s; host->address = %s;",
420 hd->name, hd->address);
423 } /* int csnmp_config_add_host_address */
425 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
427 if ((ci->values_num != 1)
428 || (ci->values[0].type != OCONFIG_TYPE_STRING))
430 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
434 if (hd->community == NULL)
435 free (hd->community);
437 hd->community = strdup (ci->values[0].value.string);
438 if (hd->community == NULL)
441 DEBUG ("snmp plugin: host = %s; host->community = %s;",
442 hd->name, hd->community);
445 } /* int csnmp_config_add_host_community */
447 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
451 if ((ci->values_num != 1)
452 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
454 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
458 version = (int) ci->values[0].value.number;
459 if ((version != 1) && (version != 2))
461 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
465 hd->version = version;
468 } /* int csnmp_config_add_host_address */
470 static int csnmp_config_add_host_collect (host_definition_t *host,
473 data_definition_t *data;
474 data_definition_t **data_list;
478 if (ci->values_num < 1)
480 WARNING ("snmp plugin: `Collect' needs at least one argument.");
484 for (i = 0; i < ci->values_num; i++)
485 if (ci->values[i].type != OCONFIG_TYPE_STRING)
487 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
491 data_list_len = host->data_list_len + ci->values_num;
492 data_list = (data_definition_t **) realloc (host->data_list,
493 sizeof (data_definition_t *) * data_list_len);
494 if (data_list == NULL)
496 host->data_list = data_list;
498 for (i = 0; i < ci->values_num; i++)
500 for (data = data_head; data != NULL; data = data->next)
501 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
506 WARNING ("snmp plugin: No such data configured: `%s'",
507 ci->values[i].value.string);
511 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
512 host->name, host->data_list_len, data->name);
514 host->data_list[host->data_list_len] = data;
515 host->data_list_len++;
516 } /* for (values_num) */
519 } /* int csnmp_config_add_host_collect */
521 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
523 if ((ci->values_num != 1)
524 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
526 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
530 hd->interval = (int) ci->values[0].value.number;
531 if (hd->interval < 0)
535 } /* int csnmp_config_add_host_interval */
537 static int csnmp_config_add_host (oconfig_item_t *ci)
539 host_definition_t *hd;
543 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
545 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
549 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
552 memset (hd, '\0', sizeof (host_definition_t));
555 hd->name = strdup (ci->values[0].value.string);
556 if (hd->name == NULL)
562 hd->sess_handle = NULL;
565 hd->state = STATE_IDLE;
567 for (i = 0; i < ci->children_num; i++)
569 oconfig_item_t *option = ci->children + i;
572 if (strcasecmp ("Address", option->key) == 0)
573 status = csnmp_config_add_host_address (hd, option);
574 else if (strcasecmp ("Community", option->key) == 0)
575 status = csnmp_config_add_host_community (hd, option);
576 else if (strcasecmp ("Version", option->key) == 0)
577 status = csnmp_config_add_host_version (hd, option);
578 else if (strcasecmp ("Collect", option->key) == 0)
579 csnmp_config_add_host_collect (hd, option);
580 else if (strcasecmp ("Interval", option->key) == 0)
581 csnmp_config_add_host_interval (hd, option);
584 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
590 } /* for (ci->children) */
594 if (hd->address == NULL)
596 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
600 if (hd->community == NULL)
602 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
608 } /* while (status == 0) */
617 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
618 hd->name, hd->address, hd->community, hd->version);
620 if (host_head == NULL)
624 host_definition_t *last;
626 while (last->next != NULL)
632 } /* int csnmp_config_add_host */
634 static int csnmp_config (oconfig_item_t *ci)
638 call_snmp_init_once ();
640 for (i = 0; i < ci->children_num; i++)
642 oconfig_item_t *child = ci->children + i;
643 if (strcasecmp ("Data", child->key) == 0)
644 csnmp_config_add_data (child);
645 else if (strcasecmp ("Host", child->key) == 0)
646 csnmp_config_add_host (child);
649 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
651 } /* for (ci->children) */
654 } /* int csnmp_config */
656 /* End of the config stuff. Now the interesting part begins */
658 static void csnmp_host_close_session (host_definition_t *host)
660 if (host->sess_handle == NULL)
663 snmp_sess_close (host->sess_handle);
664 host->sess_handle = NULL;
665 } /* void csnmp_host_close_session */
667 static void csnmp_host_open_session (host_definition_t *host)
669 struct snmp_session sess;
671 if (host->sess_handle != NULL)
672 csnmp_host_close_session (host);
674 snmp_sess_init (&sess);
675 sess.peername = host->address;
676 sess.community = (u_char *) host->community;
677 sess.community_len = strlen (host->community);
678 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
680 /* snmp_sess_open will copy the `struct snmp_session *'. */
681 host->sess_handle = snmp_sess_open (&sess);
683 if (host->sess_handle == NULL)
687 snmp_error (&sess, NULL, NULL, &errstr);
689 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
690 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
693 } /* void csnmp_host_open_session */
695 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
696 double scale, double shift)
702 if ((vl->type == ASN_INTEGER)
703 || (vl->type == ASN_UINTEGER)
704 || (vl->type == ASN_COUNTER)
706 || (vl->type == ASN_TIMETICKS)
708 || (vl->type == ASN_GAUGE))
710 temp = (uint32_t) *vl->val.integer;
711 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", temp);
713 else if (vl->type == ASN_COUNTER64)
715 temp = (uint32_t) vl->val.counter64->high;
717 temp += (uint32_t) vl->val.counter64->low;
718 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", temp);
720 else if (vl->type == ASN_OCTET_STR)
722 /* We'll handle this later.. */
726 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
730 if (vl->type == ASN_OCTET_STR)
735 string = (char *) vl->val.string;
740 if (type == DS_TYPE_COUNTER)
741 ret.counter = (counter_t) strtoll (string, &endptr, /* base = */ 0);
742 else if (type == DS_TYPE_GAUGE)
743 ret.gauge = (gauge_t) strtod (string, &endptr);
746 /* Check if an error occurred */
747 if ((string == NULL) || (endptr == string))
749 if (type == DS_TYPE_COUNTER)
751 else if (type == DS_TYPE_GAUGE)
755 else if (type == DS_TYPE_COUNTER)
759 else if (type == DS_TYPE_GAUGE)
763 ret.gauge = (scale * temp) + shift;
767 } /* value_t csnmp_value_list_to_value */
769 /* Returns true if all OIDs have left their subtree */
770 static int csnmp_check_res_left_subtree (const host_definition_t *host,
771 const data_definition_t *data,
772 struct snmp_pdu *res)
774 struct variable_list *vb;
776 int num_left_subtree;
784 num_left_subtree = 0;
786 /* check all the variables and count how many have left their subtree */
787 for (vb = res->variables, i = 0;
788 (vb != NULL) && (i < data->values_len);
789 vb = vb->next_variable, i++)
792 if (snmp_oid_ncompare (data->values[i].oid,
793 data->values[i].oid_len,
794 vb->name, vb->name_length,
795 data->values[i].oid_len) != 0)
799 /* check if enough variables have been returned */
800 if (i < data->values_len)
802 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
803 host->name, data->values_len, i);
807 if (data->instance.oid.oid_len > 0)
811 ERROR ("snmp plugin: host %s: Expected one more variable for "
812 "the instance..", host->name);
817 if (snmp_oid_ncompare (data->instance.oid.oid,
818 data->instance.oid.oid_len,
819 vb->name, vb->name_length,
820 data->instance.oid.oid_len) != 0)
824 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
825 "left their subtree",
826 num_left_subtree, num_checked);
827 if (num_left_subtree >= num_checked)
830 } /* int csnmp_check_res_left_subtree */
832 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
833 csnmp_list_instances_t **tail,
834 const struct snmp_pdu *res)
836 csnmp_list_instances_t *il;
837 struct variable_list *vb;
839 /* Set vb on the last variable */
840 for (vb = res->variables;
841 (vb != NULL) && (vb->next_variable != NULL);
842 vb = vb->next_variable)
847 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
850 ERROR ("snmp plugin: malloc failed.");
853 il->subid = vb->name[vb->name_length - 1];
856 /* Get instance name */
857 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
862 instance_len = sizeof (il->instance) - 1;
863 if (instance_len > vb->val_len)
864 instance_len = vb->val_len;
866 sstrncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
868 : vb->val.bitstring),
871 for (ptr = il->instance; *ptr != '\0'; ptr++)
873 if ((*ptr > 0) && (*ptr < 32))
875 else if (*ptr == '/')
878 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
882 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
883 ssnprintf (il->instance, sizeof (il->instance),
884 "%llu", val.counter);
887 /* TODO: Debugging output */
896 } /* int csnmp_instance_list_add */
898 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
899 csnmp_list_instances_t *instance_list,
900 csnmp_table_values_t **value_table)
902 const data_set_t *ds;
903 value_list_t vl = VALUE_LIST_INIT;
905 csnmp_list_instances_t *instance_list_ptr;
906 csnmp_table_values_t **value_table_ptr;
912 ds = plugin_get_ds (data->type);
915 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
918 assert (ds->ds_num == data->values_len);
920 instance_list_ptr = instance_list;
922 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
924 if (value_table_ptr == NULL)
926 for (i = 0; i < data->values_len; i++)
927 value_table_ptr[i] = value_table[i];
929 vl.values_len = ds->ds_num;
930 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
931 if (vl.values == NULL)
933 ERROR ("snmp plugin: malloc failed.");
934 sfree (value_table_ptr);
938 sstrncpy (vl.host, host->name, sizeof (vl.host));
939 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
941 vl.interval = host->interval;
942 vl.time = time (NULL);
947 while (have_more != 0)
949 if (instance_list != NULL)
951 while ((instance_list_ptr != NULL)
952 && (instance_list_ptr->subid < subid))
953 instance_list_ptr = instance_list_ptr->next;
955 if (instance_list_ptr == NULL)
960 else if (instance_list_ptr->subid > subid)
962 subid = instance_list_ptr->subid;
965 } /* if (instance_list != NULL) */
967 for (i = 0; i < data->values_len; i++)
969 while ((value_table_ptr[i] != NULL)
970 && (value_table_ptr[i]->subid < subid))
971 value_table_ptr[i] = value_table_ptr[i]->next;
973 if (value_table_ptr[i] == NULL)
978 else if (value_table_ptr[i]->subid > subid)
980 subid = value_table_ptr[i]->subid;
983 } /* for (i = 0; i < columns; i++) */
984 /* The subid has been increased - start scanning from the beginning
986 if (i < data->values_len)
989 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
990 * to the same subid. instance_list_ptr is either NULL or points to the
991 * same subid, too. */
993 for (i = 1; i < data->values_len; i++)
995 assert (value_table_ptr[i] != NULL);
996 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
998 assert ((instance_list_ptr == NULL)
999 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
1002 sstrncpy (vl.type, data->type, sizeof (vl.type));
1005 char temp[DATA_MAX_NAME_LEN];
1007 if (instance_list_ptr == NULL)
1008 ssnprintf (temp, sizeof (temp), "%u", (uint32_t) subid);
1010 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1012 if (data->instance_prefix == NULL)
1013 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1015 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1016 data->instance_prefix, temp);
1019 for (i = 0; i < data->values_len; i++)
1020 vl.values[i] = value_table_ptr[i]->value;
1022 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1023 plugin_dispatch_values (&vl);
1026 } /* while (have_more != 0) */
1029 sfree (value_table_ptr);
1032 } /* int csnmp_dispatch_table */
1034 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1036 struct snmp_pdu *req;
1037 struct snmp_pdu *res;
1038 struct variable_list *vb;
1040 const data_set_t *ds;
1042 uint32_t oid_list_len;
1047 /* `value_table' and `value_table_ptr' implement a linked list for each
1048 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1049 * instance names. This is used to jump gaps in the table. */
1050 csnmp_list_instances_t *instance_list;
1051 csnmp_list_instances_t *instance_list_ptr;
1052 csnmp_table_values_t **value_table;
1053 csnmp_table_values_t **value_table_ptr;
1055 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1056 host->name, data->name);
1058 if (host->sess_handle == NULL)
1060 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1064 ds = plugin_get_ds (data->type);
1067 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1071 if (ds->ds_num != data->values_len)
1073 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1074 data->type, ds->ds_num, data->values_len);
1078 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1079 oid_list_len = data->values_len + 1;
1080 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1081 if (oid_list == NULL)
1083 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1086 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1087 if (data->instance.oid.oid_len > 0)
1088 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1092 /* Allocate the `value_table' */
1093 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1094 * 2 * data->values_len);
1095 if (value_table == NULL)
1097 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1101 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1102 value_table_ptr = value_table + data->values_len;
1104 instance_list = NULL;
1105 instance_list_ptr = NULL;
1110 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1113 ERROR ("snmp plugin: snmp_pdu_create failed.");
1118 for (i = 0; i < oid_list_len; i++)
1119 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1122 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1124 if ((status != STAT_SUCCESS) || (res == NULL))
1126 char *errstr = NULL;
1128 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1129 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1130 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1133 snmp_free_pdu (res);
1137 csnmp_host_close_session (host);
1143 assert (res != NULL);
1145 vb = res->variables;
1149 snmp_free_pdu (res);
1156 /* Check if all values (and possibly the instance) have left their
1158 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1161 snmp_free_pdu (res);
1167 /* if an instance-OID is configured.. */
1168 if (data->instance.oid.oid_len > 0)
1170 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1171 * add it to the list */
1172 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1175 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1180 /* Set vb on the last variable */
1181 for (vb = res->variables;
1182 (vb != NULL) && (vb->next_variable != NULL);
1183 vb = vb->next_variable)
1191 /* Copy OID to oid_list[data->values_len] */
1192 memcpy (oid_list[data->values_len].oid, vb->name,
1193 sizeof (oid) * vb->name_length);
1194 oid_list[data->values_len].oid_len = vb->name_length;
1197 for (vb = res->variables, i = 0;
1198 (vb != NULL) && (i < data->values_len);
1199 vb = vb->next_variable, i++)
1201 csnmp_table_values_t *vt;
1203 /* Check if we left the subtree */
1204 if (snmp_oid_ncompare (data->values[i].oid,
1205 data->values[i].oid_len,
1206 vb->name, vb->name_length,
1207 data->values[i].oid_len) != 0)
1209 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1210 host->name, data->name, i);
1214 if ((value_table_ptr[i] != NULL)
1215 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1217 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1218 "SUBID is not increasing.",
1219 host->name, data->name, i);
1223 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1226 ERROR ("snmp plugin: malloc failed.");
1231 vt->subid = vb->name[vb->name_length - 1];
1232 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1233 data->scale, data->shift);
1236 if (value_table_ptr[i] == NULL)
1237 value_table[i] = vt;
1239 value_table_ptr[i]->next = vt;
1240 value_table_ptr[i] = vt;
1242 /* Copy OID to oid_list[i + 1] */
1243 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1244 oid_list[i].oid_len = vb->name_length;
1245 } /* for (i = data->values_len) */
1248 snmp_free_pdu (res);
1250 } /* while (status == 0) */
1253 csnmp_dispatch_table (host, data, instance_list, value_table);
1255 /* Free all allocated variables here */
1256 while (instance_list != NULL)
1258 instance_list_ptr = instance_list->next;
1259 sfree (instance_list);
1260 instance_list = instance_list_ptr;
1263 for (i = 0; i < data->values_len; i++)
1265 csnmp_table_values_t *tmp;
1266 while (value_table[i] != NULL)
1268 tmp = value_table[i]->next;
1269 sfree (value_table[i]);
1270 value_table[i] = tmp;
1274 sfree (value_table);
1278 } /* int csnmp_read_table */
1280 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1282 struct snmp_pdu *req;
1283 struct snmp_pdu *res;
1284 struct variable_list *vb;
1286 const data_set_t *ds;
1287 value_list_t vl = VALUE_LIST_INIT;
1292 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1293 host->name, data->name);
1295 if (host->sess_handle == NULL)
1297 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1301 ds = plugin_get_ds (data->type);
1304 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1308 if (ds->ds_num != data->values_len)
1310 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1311 data->type, ds->ds_num, data->values_len);
1315 vl.values_len = ds->ds_num;
1316 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1317 if (vl.values == NULL)
1319 for (i = 0; i < vl.values_len; i++)
1321 if (ds->ds[i].type == DS_TYPE_COUNTER)
1322 vl.values[i].counter = 0;
1324 vl.values[i].gauge = NAN;
1327 sstrncpy (vl.host, host->name, sizeof (vl.host));
1328 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1329 sstrncpy (vl.type, data->type, sizeof (vl.type));
1330 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1332 vl.interval = host->interval;
1334 req = snmp_pdu_create (SNMP_MSG_GET);
1337 ERROR ("snmp plugin: snmp_pdu_create failed.");
1342 for (i = 0; i < data->values_len; i++)
1343 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1346 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1348 if ((status != STAT_SUCCESS) || (res == NULL))
1350 char *errstr = NULL;
1352 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1353 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1354 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1357 snmp_free_pdu (res);
1361 csnmp_host_close_session (host);
1366 vl.time = time (NULL);
1368 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1372 snprint_variable (buffer, sizeof (buffer),
1373 vb->name, vb->name_length, vb);
1374 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1375 #endif /* COLLECT_DEBUG */
1377 for (i = 0; i < data->values_len; i++)
1378 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1379 vb->name, vb->name_length) == 0)
1380 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1381 data->scale, data->shift);
1382 } /* for (res->variables) */
1385 snmp_free_pdu (res);
1388 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1389 plugin_dispatch_values (&vl);
1393 } /* int csnmp_read_value */
1395 static int csnmp_read_host (host_definition_t *host)
1401 time_start = time (NULL);
1402 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1403 (unsigned int) time_start);
1405 if (host->sess_handle == NULL)
1406 csnmp_host_open_session (host);
1408 if (host->sess_handle == NULL)
1411 for (i = 0; i < host->data_list_len; i++)
1413 data_definition_t *data = host->data_list[i];
1416 csnmp_read_table (host, data);
1418 csnmp_read_value (host, data);
1421 time_end = time (NULL);
1422 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1423 (unsigned int) time_end);
1424 if ((time_end - time_start) > host->interval)
1426 WARNING ("snmp plugin: Host `%s' should be queried every %i seconds, "
1427 "but reading all values takes %u seconds.",
1428 host->name, host->interval, (unsigned int) (time_end - time_start));
1432 } /* int csnmp_read_host */
1434 static void *csnmp_read_thread (void *data)
1436 host_definition_t *host;
1438 pthread_mutex_lock (&host_lock);
1439 while (do_shutdown == 0)
1441 pthread_cond_wait (&host_cond, &host_lock);
1443 for (host = host_head; host != NULL; host = host->next)
1445 if (do_shutdown != 0)
1447 if (host->state != STATE_WAIT)
1450 host->state = STATE_BUSY;
1451 pthread_mutex_unlock (&host_lock);
1452 csnmp_read_host (host);
1453 pthread_mutex_lock (&host_lock);
1454 host->state = STATE_IDLE;
1456 } /* while (do_shutdown == 0) */
1457 pthread_mutex_unlock (&host_lock);
1459 pthread_exit ((void *) 0);
1460 return ((void *) 0);
1461 } /* void *csnmp_read_thread */
1463 static int csnmp_init (void)
1465 host_definition_t *host;
1468 if (host_head == NULL)
1470 NOTICE ("snmp plugin: No host has been defined.");
1474 call_snmp_init_once ();
1477 for (host = host_head; host != NULL; host = host->next)
1480 /* We need to initialize `interval' here, because `interval_g' isn't
1481 * initialized during `configure'. */
1482 host->next_update = time (NULL);
1483 if (host->interval == 0)
1485 host->interval = interval_g;
1487 else if (host->interval < interval_g)
1489 host->interval = interval_g;
1490 WARNING ("snmp plugin: Data for host `%s' will be collected every %i seconds.",
1491 host->name, host->interval);
1494 csnmp_host_open_session (host);
1497 /* Now start the reading threads */
1498 if (threads_num > 3)
1500 threads_num = 3 + ((threads_num - 3) / 10);
1501 if (threads_num > 10)
1505 threads = (pthread_t *) malloc (threads_num * sizeof (pthread_t));
1506 if (threads == NULL)
1508 ERROR ("snmp plugin: malloc failed.");
1511 memset (threads, '\0', threads_num * sizeof (pthread_t));
1513 for (i = 0; i < threads_num; i++)
1514 pthread_create (threads + i, NULL, csnmp_read_thread, (void *) 0);
1517 } /* int csnmp_init */
1519 static int csnmp_read (void)
1521 host_definition_t *host;
1524 if (host_head == NULL)
1526 INFO ("snmp plugin: No hosts configured.");
1532 pthread_mutex_lock (&host_lock);
1533 for (host = host_head; host != NULL; host = host->next)
1535 if (host->state != STATE_IDLE)
1538 /* Skip this host if the next or a later iteration will be sufficient. */
1539 if (host->next_update >= (now + interval_g))
1542 host->state = STATE_WAIT;
1543 host->next_update = now + host->interval;
1546 pthread_cond_broadcast (&host_cond);
1547 pthread_mutex_unlock (&host_lock);
1550 } /* int csnmp_read */
1552 static int csnmp_shutdown (void)
1554 host_definition_t *host_this;
1555 host_definition_t *host_next;
1557 data_definition_t *data_this;
1558 data_definition_t *data_next;
1562 pthread_mutex_lock (&host_lock);
1564 pthread_cond_broadcast (&host_cond);
1565 pthread_mutex_unlock (&host_lock);
1567 for (i = 0; i < threads_num; i++)
1568 pthread_join (threads[i], NULL);
1570 /* Now that all the threads have exited, let's free all the global variables.
1571 * This isn't really neccessary, I guess, but I think it's good stile to do
1573 host_this = host_head;
1575 while (host_this != NULL)
1577 host_next = host_this->next;
1579 csnmp_host_close_session (host_this);
1581 sfree (host_this->name);
1582 sfree (host_this->address);
1583 sfree (host_this->community);
1584 sfree (host_this->data_list);
1587 host_this = host_next;
1590 data_this = data_head;
1592 while (data_this != NULL)
1594 data_next = data_this->next;
1596 sfree (data_this->name);
1597 sfree (data_this->type);
1598 sfree (data_this->values);
1601 data_this = data_next;
1605 } /* int csnmp_shutdown */
1607 void module_register (void)
1609 plugin_register_complex_config ("snmp", csnmp_config);
1610 plugin_register_init ("snmp", csnmp_init);
1611 plugin_register_read ("snmp", csnmp_read);
1612 plugin_register_shutdown ("snmp", csnmp_shutdown);
1613 } /* void module_register */
1616 * vim: shiftwidth=2 softtabstop=2 tabstop=8