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 strncpy (dd->instance.string, ci->values[0].value.string, DATA_MAX_NAME_LEN - 1);
205 } /* int csnmp_config_add_data_instance */
207 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
210 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
212 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
218 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
219 "is set to `false'.", dd->name);
223 sfree (dd->instance_prefix);
224 dd->instance_prefix = strdup (ci->values[0].value.string);
225 if (dd->instance_prefix == NULL)
229 } /* int csnmp_config_add_data_instance_prefix */
231 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
235 if (ci->values_num < 1)
237 WARNING ("snmp plugin: `Values' needs at least one argument.");
241 for (i = 0; i < ci->values_num; i++)
242 if (ci->values[i].type != OCONFIG_TYPE_STRING)
244 WARNING ("snmp plugin: `Values' needs only string argument.");
250 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
251 if (dd->values == NULL)
253 dd->values_len = ci->values_num;
255 for (i = 0; i < ci->values_num; i++)
257 dd->values[i].oid_len = MAX_OID_LEN;
259 if (NULL == snmp_parse_oid (ci->values[i].value.string,
260 dd->values[i].oid, &dd->values[i].oid_len))
262 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
263 ci->values[i].value.string);
272 } /* int csnmp_config_add_data_instance */
274 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
276 if ((ci->values_num != 1)
277 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
279 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
283 dd->shift = ci->values[0].value.number;
286 } /* int csnmp_config_add_data_shift */
288 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
290 if ((ci->values_num != 1)
291 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
293 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
297 dd->scale = ci->values[0].value.number;
300 } /* int csnmp_config_add_data_scale */
302 static int csnmp_config_add_data (oconfig_item_t *ci)
304 data_definition_t *dd;
308 if ((ci->values_num != 1)
309 || (ci->values[0].type != OCONFIG_TYPE_STRING))
311 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
315 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
318 memset (dd, '\0', sizeof (data_definition_t));
320 dd->name = strdup (ci->values[0].value.string);
321 if (dd->name == NULL)
329 for (i = 0; i < ci->children_num; i++)
331 oconfig_item_t *option = ci->children + i;
334 if (strcasecmp ("Type", option->key) == 0)
335 status = csnmp_config_add_data_type (dd, option);
336 else if (strcasecmp ("Table", option->key) == 0)
337 status = csnmp_config_add_data_table (dd, option);
338 else if (strcasecmp ("Instance", option->key) == 0)
339 status = csnmp_config_add_data_instance (dd, option);
340 else if (strcasecmp ("InstancePrefix", option->key) == 0)
341 status = csnmp_config_add_data_instance_prefix (dd, option);
342 else if (strcasecmp ("Values", option->key) == 0)
343 status = csnmp_config_add_data_values (dd, option);
344 else if (strcasecmp ("Shift", option->key) == 0)
345 status = csnmp_config_add_data_shift (dd, option);
346 else if (strcasecmp ("Scale", option->key) == 0)
347 status = csnmp_config_add_data_scale (dd, option);
350 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
356 } /* for (ci->children) */
360 if (dd->type == NULL)
362 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
366 if (dd->values == NULL)
368 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
374 } /* while (status == 0) */
379 sfree (dd->instance_prefix);
385 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
386 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
388 if (data_head == NULL)
392 data_definition_t *last;
394 while (last->next != NULL)
400 } /* int csnmp_config_add_data */
402 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
404 if ((ci->values_num != 1)
405 || (ci->values[0].type != OCONFIG_TYPE_STRING))
407 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
411 if (hd->address == NULL)
414 hd->address = strdup (ci->values[0].value.string);
415 if (hd->address == NULL)
418 DEBUG ("snmp plugin: host = %s; host->address = %s;",
419 hd->name, hd->address);
422 } /* int csnmp_config_add_host_address */
424 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
426 if ((ci->values_num != 1)
427 || (ci->values[0].type != OCONFIG_TYPE_STRING))
429 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
433 if (hd->community == NULL)
434 free (hd->community);
436 hd->community = strdup (ci->values[0].value.string);
437 if (hd->community == NULL)
440 DEBUG ("snmp plugin: host = %s; host->community = %s;",
441 hd->name, hd->community);
444 } /* int csnmp_config_add_host_community */
446 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
450 if ((ci->values_num != 1)
451 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
453 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
457 version = (int) ci->values[0].value.number;
458 if ((version != 1) && (version != 2))
460 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
464 hd->version = version;
467 } /* int csnmp_config_add_host_address */
469 static int csnmp_config_add_host_collect (host_definition_t *host,
472 data_definition_t *data;
473 data_definition_t **data_list;
477 if (ci->values_num < 1)
479 WARNING ("snmp plugin: `Collect' needs at least one argument.");
483 for (i = 0; i < ci->values_num; i++)
484 if (ci->values[i].type != OCONFIG_TYPE_STRING)
486 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
490 data_list_len = host->data_list_len + ci->values_num;
491 data_list = (data_definition_t **) realloc (host->data_list,
492 sizeof (data_definition_t *) * data_list_len);
493 if (data_list == NULL)
495 host->data_list = data_list;
497 for (i = 0; i < ci->values_num; i++)
499 for (data = data_head; data != NULL; data = data->next)
500 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
505 WARNING ("snmp plugin: No such data configured: `%s'",
506 ci->values[i].value.string);
510 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
511 host->name, host->data_list_len, data->name);
513 host->data_list[host->data_list_len] = data;
514 host->data_list_len++;
515 } /* for (values_num) */
518 } /* int csnmp_config_add_host_collect */
520 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
522 if ((ci->values_num != 1)
523 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
525 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
529 hd->interval = (int) ci->values[0].value.number;
530 if (hd->interval < 0)
534 } /* int csnmp_config_add_host_interval */
536 static int csnmp_config_add_host (oconfig_item_t *ci)
538 host_definition_t *hd;
542 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
544 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
548 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
551 memset (hd, '\0', sizeof (host_definition_t));
554 hd->name = strdup (ci->values[0].value.string);
555 if (hd->name == NULL)
561 hd->sess_handle = NULL;
564 hd->state = STATE_IDLE;
566 for (i = 0; i < ci->children_num; i++)
568 oconfig_item_t *option = ci->children + i;
571 if (strcasecmp ("Address", option->key) == 0)
572 status = csnmp_config_add_host_address (hd, option);
573 else if (strcasecmp ("Community", option->key) == 0)
574 status = csnmp_config_add_host_community (hd, option);
575 else if (strcasecmp ("Version", option->key) == 0)
576 status = csnmp_config_add_host_version (hd, option);
577 else if (strcasecmp ("Collect", option->key) == 0)
578 csnmp_config_add_host_collect (hd, option);
579 else if (strcasecmp ("Interval", option->key) == 0)
580 csnmp_config_add_host_interval (hd, option);
583 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
589 } /* for (ci->children) */
593 if (hd->address == NULL)
595 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
599 if (hd->community == NULL)
601 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
607 } /* while (status == 0) */
616 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
617 hd->name, hd->address, hd->community, hd->version);
619 if (host_head == NULL)
623 host_definition_t *last;
625 while (last->next != NULL)
631 } /* int csnmp_config_add_host */
633 static int csnmp_config (oconfig_item_t *ci)
637 call_snmp_init_once ();
639 for (i = 0; i < ci->children_num; i++)
641 oconfig_item_t *child = ci->children + i;
642 if (strcasecmp ("Data", child->key) == 0)
643 csnmp_config_add_data (child);
644 else if (strcasecmp ("Host", child->key) == 0)
645 csnmp_config_add_host (child);
648 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
650 } /* for (ci->children) */
653 } /* int csnmp_config */
655 /* End of the config stuff. Now the interesting part begins */
657 static void csnmp_host_close_session (host_definition_t *host)
661 if (host->sess_handle == NULL)
664 status = snmp_sess_close (host->sess_handle);
670 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
672 ERROR ("snmp plugin: host %s: snmp_sess_close failed: %s",
673 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
677 host->sess_handle = NULL;
678 } /* void csnmp_host_close_session */
680 static void csnmp_host_open_session (host_definition_t *host)
682 struct snmp_session sess;
684 if (host->sess_handle != NULL)
685 csnmp_host_close_session (host);
687 snmp_sess_init (&sess);
688 sess.peername = host->address;
689 sess.community = (u_char *) host->community;
690 sess.community_len = strlen (host->community);
691 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
693 /* snmp_sess_open will copy the `struct snmp_session *'. */
694 host->sess_handle = snmp_sess_open (&sess);
696 if (host->sess_handle == NULL)
700 snmp_error (&sess, NULL, NULL, &errstr);
702 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
703 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
706 } /* void csnmp_host_open_session */
708 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
709 double scale, double shift)
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 temp = (uint32_t) *vl->val.integer;
724 DEBUG ("snmp plugin: Parsed int32 value is %llu.", temp);
726 else if (vl->type == ASN_COUNTER64)
728 temp = (uint32_t) vl->val.counter64->high;
730 temp += (uint32_t) vl->val.counter64->low;
731 DEBUG ("snmp plugin: Parsed int64 value is %llu.", temp);
735 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
739 if (type == DS_TYPE_COUNTER)
743 else if (type == DS_TYPE_GAUGE)
747 ret.gauge = (scale * temp) + shift;
751 } /* value_t csnmp_value_list_to_value */
753 /* Returns true if all OIDs have left their subtree */
754 static int csnmp_check_res_left_subtree (const host_definition_t *host,
755 const data_definition_t *data,
756 struct snmp_pdu *res)
758 struct variable_list *vb;
760 int num_left_subtree;
768 num_left_subtree = 0;
770 /* check all the variables and count how many have left their subtree */
771 for (vb = res->variables, i = 0;
772 (vb != NULL) && (i < data->values_len);
773 vb = vb->next_variable, i++)
776 if (snmp_oid_ncompare (data->values[i].oid,
777 data->values[i].oid_len,
778 vb->name, vb->name_length,
779 data->values[i].oid_len) != 0)
783 /* check if enough variables have been returned */
784 if (i < data->values_len)
786 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
787 host->name, data->values_len, i);
791 if (data->instance.oid.oid_len > 0)
795 ERROR ("snmp plugin: host %s: Expected one more variable for "
801 if (snmp_oid_ncompare (data->instance.oid.oid,
802 data->instance.oid.oid_len,
803 vb->name, vb->name_length,
804 data->instance.oid.oid_len) != 0)
808 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
809 "left their subtree",
810 num_left_subtree, num_checked);
811 if (num_left_subtree >= num_checked)
814 } /* int csnmp_check_res_left_subtree */
816 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
817 csnmp_list_instances_t **tail,
818 const struct snmp_pdu *res)
820 csnmp_list_instances_t *il;
821 struct variable_list *vb;
823 /* Set vb on the last variable */
824 for (vb = res->variables;
825 (vb != NULL) && (vb->next_variable != NULL);
826 vb = vb->next_variable)
831 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
834 ERROR ("snmp plugin: malloc failed.");
837 il->subid = vb->name[vb->name_length - 1];
840 /* Get instance name */
841 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
846 instance_len = sizeof (il->instance) - 1;
847 if (instance_len > vb->val_len)
848 instance_len = vb->val_len;
850 strncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
852 : vb->val.bitstring),
854 il->instance[instance_len] = '\0';
856 for (ptr = il->instance; *ptr != '\0'; ptr++)
858 if ((*ptr > 0) && (*ptr < 32))
860 else if (*ptr == '/')
863 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
867 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
868 snprintf (il->instance, sizeof (il->instance),
869 "%llu", val.counter);
871 il->instance[sizeof (il->instance) - 1] = '\0';
873 /* TODO: Debugging output */
882 } /* int csnmp_instance_list_add */
884 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
885 csnmp_list_instances_t *instance_list,
886 csnmp_table_values_t **value_table)
888 const data_set_t *ds;
889 value_list_t vl = VALUE_LIST_INIT;
891 csnmp_list_instances_t *instance_list_ptr;
892 csnmp_table_values_t **value_table_ptr;
898 ds = plugin_get_ds (data->type);
901 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
904 assert (ds->ds_num == data->values_len);
906 instance_list_ptr = instance_list;
908 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
910 if (value_table_ptr == NULL)
912 for (i = 0; i < data->values_len; i++)
913 value_table_ptr[i] = value_table[i];
915 vl.values_len = ds->ds_num;
916 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
917 if (vl.values == NULL)
919 ERROR ("snmp plugin: malloc failed.");
920 sfree (value_table_ptr);
924 strncpy (vl.host, host->name, sizeof (vl.host));
925 vl.host[sizeof (vl.host) - 1] = '\0';
926 strcpy (vl.plugin, "snmp");
928 vl.interval = host->interval;
929 vl.time = time (NULL);
934 while (have_more != 0)
936 if (instance_list != NULL)
938 while ((instance_list_ptr != NULL)
939 && (instance_list_ptr->subid < subid))
940 instance_list_ptr = instance_list_ptr->next;
942 if (instance_list_ptr == NULL)
947 else if (instance_list_ptr->subid > subid)
949 subid = instance_list_ptr->subid;
952 } /* if (instance_list != NULL) */
954 for (i = 0; i < data->values_len; i++)
956 while ((value_table_ptr[i] != NULL)
957 && (value_table_ptr[i]->subid < subid))
958 value_table_ptr[i] = value_table_ptr[i]->next;
960 if (value_table_ptr[i] == NULL)
965 else if (value_table_ptr[i]->subid > subid)
967 subid = value_table_ptr[i]->subid;
970 } /* for (i = 0; i < columns; i++) */
971 /* The subid has been increased - start scanning from the beginning
973 if (i < data->values_len)
976 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
977 * to the same subid. instance_list_ptr is either NULL or points to the
978 * same subid, too. */
980 for (i = 1; i < data->values_len; i++)
982 assert (value_table_ptr[i] != NULL);
983 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
985 assert ((instance_list_ptr == NULL)
986 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
990 char temp[DATA_MAX_NAME_LEN];
992 if (instance_list_ptr == NULL)
993 snprintf (temp, sizeof (temp), "%u",
996 strncpy (temp, instance_list_ptr->instance,
998 temp[sizeof (temp) - 1] = '\0';
1000 if (data->instance_prefix == NULL)
1001 strncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1003 snprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1004 data->instance_prefix, temp);
1005 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
1008 for (i = 0; i < data->values_len; i++)
1009 vl.values[i] = value_table_ptr[i]->value;
1011 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1012 plugin_dispatch_values (data->type, &vl);
1015 } /* while (have_more != 0) */
1018 sfree (value_table_ptr);
1021 } /* int csnmp_dispatch_table */
1023 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1025 struct snmp_pdu *req;
1026 struct snmp_pdu *res;
1027 struct variable_list *vb;
1029 const data_set_t *ds;
1031 uint32_t oid_list_len;
1036 /* `value_table' and `value_table_ptr' implement a linked list for each
1037 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1038 * instance names. This is used to jump gaps in the table. */
1039 csnmp_list_instances_t *instance_list;
1040 csnmp_list_instances_t *instance_list_ptr;
1041 csnmp_table_values_t **value_table;
1042 csnmp_table_values_t **value_table_ptr;
1044 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1045 host->name, data->name);
1047 if (host->sess_handle == NULL)
1049 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1053 ds = plugin_get_ds (data->type);
1056 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1060 if (ds->ds_num != data->values_len)
1062 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1063 data->type, ds->ds_num, data->values_len);
1067 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1068 oid_list_len = data->values_len + 1;
1069 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1070 if (oid_list == NULL)
1072 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1075 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1076 if (data->instance.oid.oid_len > 0)
1077 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1081 /* Allocate the `value_table' */
1082 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1083 * 2 * data->values_len);
1084 if (value_table == NULL)
1086 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1090 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1091 value_table_ptr = value_table + data->values_len;
1093 instance_list = NULL;
1094 instance_list_ptr = NULL;
1099 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1102 ERROR ("snmp plugin: snmp_pdu_create failed.");
1107 for (i = 0; i < oid_list_len; i++)
1108 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1110 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1112 if (status != STAT_SUCCESS)
1114 char *errstr = NULL;
1116 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1117 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1118 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1119 csnmp_host_close_session (host);
1125 assert (res != NULL);
1127 vb = res->variables;
1134 /* Check if all values (and possibly the instance) have left their
1136 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1139 /* if an instance-OID is configured.. */
1140 if (data->instance.oid.oid_len > 0)
1142 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1143 * add it to the list */
1144 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1147 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1152 /* Set vb on the last variable */
1153 for (vb = res->variables;
1154 (vb != NULL) && (vb->next_variable != NULL);
1155 vb = vb->next_variable)
1163 /* Copy OID to oid_list[data->values_len] */
1164 memcpy (oid_list[data->values_len].oid, vb->name,
1165 sizeof (oid) * vb->name_length);
1166 oid_list[data->values_len].oid_len = vb->name_length;
1169 for (vb = res->variables, i = 0;
1170 (vb != NULL) && (i < data->values_len);
1171 vb = vb->next_variable, i++)
1173 csnmp_table_values_t *vt;
1175 /* Check if we left the subtree */
1176 if (snmp_oid_ncompare (data->values[i].oid,
1177 data->values[i].oid_len,
1178 vb->name, vb->name_length,
1179 data->values[i].oid_len) != 0)
1181 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1182 host->name, data->name, i);
1186 if ((value_table_ptr[i] != NULL)
1187 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1189 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1190 "SUBID is not increasing.",
1191 host->name, data->name, i);
1195 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1198 ERROR ("snmp plugin: malloc failed.");
1203 vt->subid = vb->name[vb->name_length - 1];
1204 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1205 data->scale, data->shift);
1208 if (value_table_ptr[i] == NULL)
1209 value_table[i] = vt;
1211 value_table_ptr[i]->next = vt;
1212 value_table_ptr[i] = vt;
1214 /* Copy OID to oid_list[i + 1] */
1215 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1216 oid_list[i].oid_len = vb->name_length;
1217 } /* for (i = data->values_len) */
1220 snmp_free_pdu (res);
1222 } /* while (status == 0) */
1225 csnmp_dispatch_table (host, data, instance_list, value_table);
1227 /* Free all allocated variables here */
1228 while (instance_list != NULL)
1230 instance_list_ptr = instance_list->next;
1231 sfree (instance_list);
1232 instance_list = instance_list_ptr;
1235 for (i = 0; i < data->values_len; i++)
1237 csnmp_table_values_t *tmp;
1238 while (value_table[i] != NULL)
1240 tmp = value_table[i]->next;
1241 sfree (value_table[i]);
1242 value_table[i] = tmp;
1246 sfree (value_table);
1250 } /* int csnmp_read_table */
1252 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1254 struct snmp_pdu *req;
1255 struct snmp_pdu *res;
1256 struct variable_list *vb;
1258 const data_set_t *ds;
1259 value_list_t vl = VALUE_LIST_INIT;
1264 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1265 host->name, data->name);
1267 if (host->sess_handle == NULL)
1269 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1273 ds = plugin_get_ds (data->type);
1276 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1280 if (ds->ds_num != data->values_len)
1282 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1283 data->type, ds->ds_num, data->values_len);
1287 vl.values_len = ds->ds_num;
1288 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1289 if (vl.values == NULL)
1291 for (i = 0; i < vl.values_len; i++)
1293 if (ds->ds[i].type == DS_TYPE_COUNTER)
1294 vl.values[i].counter = 0;
1296 vl.values[i].gauge = NAN;
1299 strncpy (vl.host, host->name, sizeof (vl.host));
1300 vl.host[sizeof (vl.host) - 1] = '\0';
1301 strcpy (vl.plugin, "snmp");
1302 strncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1303 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
1305 vl.interval = host->interval;
1307 req = snmp_pdu_create (SNMP_MSG_GET);
1310 ERROR ("snmp plugin: snmp_pdu_create failed.");
1315 for (i = 0; i < data->values_len; i++)
1316 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1317 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1319 if (status != STAT_SUCCESS)
1321 char *errstr = NULL;
1323 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1324 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1325 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1326 csnmp_host_close_session (host);
1332 vl.time = time (NULL);
1334 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1338 snprint_variable (buffer, sizeof (buffer),
1339 vb->name, vb->name_length, vb);
1340 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1341 #endif /* COLLECT_DEBUG */
1343 for (i = 0; i < data->values_len; i++)
1344 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1345 vb->name, vb->name_length) == 0)
1346 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1347 data->scale, data->shift);
1348 } /* for (res->variables) */
1350 snmp_free_pdu (res);
1352 DEBUG ("snmp plugin: -> plugin_dispatch_values (%s, &vl);", data->type);
1353 plugin_dispatch_values (data->type, &vl);
1357 } /* int csnmp_read_value */
1359 static int csnmp_read_host (host_definition_t *host)
1365 time_start = time (NULL);
1366 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1367 (unsigned int) time_start);
1369 if (host->sess_handle == NULL)
1370 csnmp_host_open_session (host);
1372 if (host->sess_handle == NULL)
1375 for (i = 0; i < host->data_list_len; i++)
1377 data_definition_t *data = host->data_list[i];
1380 csnmp_read_table (host, data);
1382 csnmp_read_value (host, data);
1385 time_end = time (NULL);
1386 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1387 (unsigned int) time_end);
1388 if ((time_end - time_start) > host->interval)
1390 WARNING ("snmp plugin: Host `%s' should be queried every %i seconds, "
1391 "but reading all values takes %i seconds.",
1392 host->name, host->interval, time_end - time_start);
1396 } /* int csnmp_read_host */
1398 static void *csnmp_read_thread (void *data)
1400 host_definition_t *host;
1402 pthread_mutex_lock (&host_lock);
1403 while (do_shutdown == 0)
1405 pthread_cond_wait (&host_cond, &host_lock);
1407 for (host = host_head; host != NULL; host = host->next)
1409 if (do_shutdown != 0)
1411 if (host->state != STATE_WAIT)
1414 host->state = STATE_BUSY;
1415 pthread_mutex_unlock (&host_lock);
1416 csnmp_read_host (host);
1417 pthread_mutex_lock (&host_lock);
1418 host->state = STATE_IDLE;
1420 } /* while (do_shutdown == 0) */
1421 pthread_mutex_unlock (&host_lock);
1423 pthread_exit ((void *) 0);
1424 return ((void *) 0);
1425 } /* void *csnmp_read_thread */
1427 static int csnmp_init (void)
1429 host_definition_t *host;
1432 if (host_head == NULL)
1434 NOTICE ("snmp plugin: No host has been defined.");
1438 call_snmp_init_once ();
1441 for (host = host_head; host != NULL; host = host->next)
1444 /* We need to initialize `interval' here, because `interval_g' isn't
1445 * initialized during `configure'. */
1446 host->next_update = time (NULL);
1447 if (host->interval == 0)
1449 host->interval = interval_g;
1451 else if (host->interval < interval_g)
1453 host->interval = interval_g;
1454 WARNING ("snmp plugin: Data for host `%s' will be collected every %i seconds.",
1455 host->name, host->interval);
1458 csnmp_host_open_session (host);
1461 /* Now start the reading threads */
1462 if (threads_num > 3)
1464 threads_num = 3 + ((threads_num - 3) / 10);
1465 if (threads_num > 10)
1469 threads = (pthread_t *) malloc (threads_num * sizeof (pthread_t));
1470 if (threads == NULL)
1472 ERROR ("snmp plugin: malloc failed.");
1475 memset (threads, '\0', threads_num * sizeof (pthread_t));
1477 for (i = 0; i < threads_num; i++)
1478 pthread_create (threads + i, NULL, csnmp_read_thread, (void *) 0);
1481 } /* int csnmp_init */
1483 static int csnmp_read (void)
1485 host_definition_t *host;
1488 if (host_head == NULL)
1490 INFO ("snmp plugin: No hosts configured.");
1496 pthread_mutex_lock (&host_lock);
1497 for (host = host_head; host != NULL; host = host->next)
1499 if (host->state != STATE_IDLE)
1502 /* Skip this host if the next or a later iteration will be sufficient. */
1503 if (host->next_update >= (now + interval_g))
1506 host->state = STATE_WAIT;
1507 host->next_update = now + host->interval;
1510 pthread_cond_broadcast (&host_cond);
1511 pthread_mutex_unlock (&host_lock);
1514 } /* int csnmp_read */
1516 static int csnmp_shutdown (void)
1518 host_definition_t *host_this;
1519 host_definition_t *host_next;
1521 data_definition_t *data_this;
1522 data_definition_t *data_next;
1526 pthread_mutex_lock (&host_lock);
1528 pthread_cond_broadcast (&host_cond);
1529 pthread_mutex_unlock (&host_lock);
1531 for (i = 0; i < threads_num; i++)
1532 pthread_join (threads[i], NULL);
1534 /* Now that all the threads have exited, let's free all the global variables.
1535 * This isn't really neccessary, I guess, but I think it's good stile to do
1537 host_this = host_head;
1539 while (host_this != NULL)
1541 host_next = host_this->next;
1543 csnmp_host_close_session (host_this);
1545 sfree (host_this->name);
1546 sfree (host_this->address);
1547 sfree (host_this->community);
1548 sfree (host_this->data_list);
1551 host_this = host_next;
1554 data_this = data_head;
1556 while (data_this != NULL)
1558 data_next = data_this->next;
1560 sfree (data_this->name);
1561 sfree (data_this->type);
1562 sfree (data_this->values);
1565 data_this = data_next;
1569 } /* int csnmp_shutdown */
1571 void module_register (void)
1573 plugin_register_complex_config ("snmp", csnmp_config);
1574 plugin_register_init ("snmp", csnmp_init);
1575 plugin_register_read ("snmp", csnmp_read);
1576 plugin_register_shutdown ("snmp", csnmp_shutdown);
1577 } /* void module_register */
1580 * vim: shiftwidth=2 softtabstop=2 tabstop=8