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 /* First there are many functions which do configuration stuff. It's a big
122 * bloated and messy, I'm afraid. */
125 * Callgraph for the config stuff:
127 * +-> call_snmp_init_once
128 * +-> csnmp_config_add_data
129 * ! +-> csnmp_config_add_data_type
130 * ! +-> csnmp_config_add_data_table
131 * ! +-> csnmp_config_add_data_instance
132 * ! +-> csnmp_config_add_data_instance_prefix
133 * ! +-> csnmp_config_add_data_values
134 * +-> csnmp_config_add_host
135 * +-> csnmp_config_add_host_address
136 * +-> csnmp_config_add_host_community
137 * +-> csnmp_config_add_host_version
138 * +-> csnmp_config_add_host_collect
139 * +-> csnmp_config_add_host_interval
141 static void call_snmp_init_once (void)
143 static int have_init = 0;
146 init_snmp (PACKAGE_NAME);
148 } /* void call_snmp_init_once */
150 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
152 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
154 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
159 dd->type = strdup (ci->values[0].value.string);
160 if (dd->type == NULL)
164 } /* int csnmp_config_add_data_type */
166 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
168 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
170 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
174 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
177 } /* int csnmp_config_add_data_table */
179 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
181 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
183 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
189 /* Instance is an OID */
190 dd->instance.oid.oid_len = MAX_OID_LEN;
192 if (!read_objid (ci->values[0].value.string,
193 dd->instance.oid.oid, &dd->instance.oid.oid_len))
195 ERROR ("snmp plugin: read_objid (%s) failed.",
196 ci->values[0].value.string);
202 /* Instance is a simple string */
203 sstrncpy (dd->instance.string, ci->values[0].value.string,
204 sizeof (dd->instance.string));
208 } /* int csnmp_config_add_data_instance */
210 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
213 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
215 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
221 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
222 "is set to `false'.", dd->name);
226 sfree (dd->instance_prefix);
227 dd->instance_prefix = strdup (ci->values[0].value.string);
228 if (dd->instance_prefix == NULL)
232 } /* int csnmp_config_add_data_instance_prefix */
234 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
238 if (ci->values_num < 1)
240 WARNING ("snmp plugin: `Values' needs at least one argument.");
244 for (i = 0; i < ci->values_num; i++)
245 if (ci->values[i].type != OCONFIG_TYPE_STRING)
247 WARNING ("snmp plugin: `Values' needs only string argument.");
253 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
254 if (dd->values == NULL)
256 dd->values_len = ci->values_num;
258 for (i = 0; i < ci->values_num; i++)
260 dd->values[i].oid_len = MAX_OID_LEN;
262 if (NULL == snmp_parse_oid (ci->values[i].value.string,
263 dd->values[i].oid, &dd->values[i].oid_len))
265 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
266 ci->values[i].value.string);
275 } /* int csnmp_config_add_data_instance */
277 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
279 if ((ci->values_num != 1)
280 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
282 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
286 dd->shift = ci->values[0].value.number;
289 } /* int csnmp_config_add_data_shift */
291 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
293 if ((ci->values_num != 1)
294 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
296 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
300 dd->scale = ci->values[0].value.number;
303 } /* int csnmp_config_add_data_scale */
305 static int csnmp_config_add_data (oconfig_item_t *ci)
307 data_definition_t *dd;
311 if ((ci->values_num != 1)
312 || (ci->values[0].type != OCONFIG_TYPE_STRING))
314 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
318 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
321 memset (dd, '\0', sizeof (data_definition_t));
323 dd->name = strdup (ci->values[0].value.string);
324 if (dd->name == NULL)
332 for (i = 0; i < ci->children_num; i++)
334 oconfig_item_t *option = ci->children + i;
337 if (strcasecmp ("Type", option->key) == 0)
338 status = csnmp_config_add_data_type (dd, option);
339 else if (strcasecmp ("Table", option->key) == 0)
340 status = csnmp_config_add_data_table (dd, option);
341 else if (strcasecmp ("Instance", option->key) == 0)
342 status = csnmp_config_add_data_instance (dd, option);
343 else if (strcasecmp ("InstancePrefix", option->key) == 0)
344 status = csnmp_config_add_data_instance_prefix (dd, option);
345 else if (strcasecmp ("Values", option->key) == 0)
346 status = csnmp_config_add_data_values (dd, option);
347 else if (strcasecmp ("Shift", option->key) == 0)
348 status = csnmp_config_add_data_shift (dd, option);
349 else if (strcasecmp ("Scale", option->key) == 0)
350 status = csnmp_config_add_data_scale (dd, option);
353 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
359 } /* for (ci->children) */
363 if (dd->type == NULL)
365 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
369 if (dd->values == NULL)
371 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
377 } /* while (status == 0) */
382 sfree (dd->instance_prefix);
388 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
389 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
391 if (data_head == NULL)
395 data_definition_t *last;
397 while (last->next != NULL)
403 } /* int csnmp_config_add_data */
405 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
407 if ((ci->values_num != 1)
408 || (ci->values[0].type != OCONFIG_TYPE_STRING))
410 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
414 if (hd->address == NULL)
417 hd->address = strdup (ci->values[0].value.string);
418 if (hd->address == NULL)
421 DEBUG ("snmp plugin: host = %s; host->address = %s;",
422 hd->name, hd->address);
425 } /* int csnmp_config_add_host_address */
427 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
429 if ((ci->values_num != 1)
430 || (ci->values[0].type != OCONFIG_TYPE_STRING))
432 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
436 if (hd->community == NULL)
437 free (hd->community);
439 hd->community = strdup (ci->values[0].value.string);
440 if (hd->community == NULL)
443 DEBUG ("snmp plugin: host = %s; host->community = %s;",
444 hd->name, hd->community);
447 } /* int csnmp_config_add_host_community */
449 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
453 if ((ci->values_num != 1)
454 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
456 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
460 version = (int) ci->values[0].value.number;
461 if ((version != 1) && (version != 2))
463 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
467 hd->version = version;
470 } /* int csnmp_config_add_host_address */
472 static int csnmp_config_add_host_collect (host_definition_t *host,
475 data_definition_t *data;
476 data_definition_t **data_list;
480 if (ci->values_num < 1)
482 WARNING ("snmp plugin: `Collect' needs at least one argument.");
486 for (i = 0; i < ci->values_num; i++)
487 if (ci->values[i].type != OCONFIG_TYPE_STRING)
489 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
493 data_list_len = host->data_list_len + ci->values_num;
494 data_list = (data_definition_t **) realloc (host->data_list,
495 sizeof (data_definition_t *) * data_list_len);
496 if (data_list == NULL)
498 host->data_list = data_list;
500 for (i = 0; i < ci->values_num; i++)
502 for (data = data_head; data != NULL; data = data->next)
503 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
508 WARNING ("snmp plugin: No such data configured: `%s'",
509 ci->values[i].value.string);
513 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
514 host->name, host->data_list_len, data->name);
516 host->data_list[host->data_list_len] = data;
517 host->data_list_len++;
518 } /* for (values_num) */
521 } /* int csnmp_config_add_host_collect */
523 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
525 if ((ci->values_num != 1)
526 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
528 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
532 hd->interval = (int) ci->values[0].value.number;
533 if (hd->interval < 0)
537 } /* int csnmp_config_add_host_interval */
539 static int csnmp_config_add_host (oconfig_item_t *ci)
541 host_definition_t *hd;
545 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
547 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
551 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
554 memset (hd, '\0', sizeof (host_definition_t));
556 C_COMPLAIN_INIT (&hd->complaint);
558 hd->name = strdup (ci->values[0].value.string);
559 if (hd->name == NULL)
565 hd->sess_handle = NULL;
568 hd->state = STATE_IDLE;
570 for (i = 0; i < ci->children_num; i++)
572 oconfig_item_t *option = ci->children + i;
575 if (strcasecmp ("Address", option->key) == 0)
576 status = csnmp_config_add_host_address (hd, option);
577 else if (strcasecmp ("Community", option->key) == 0)
578 status = csnmp_config_add_host_community (hd, option);
579 else if (strcasecmp ("Version", option->key) == 0)
580 status = csnmp_config_add_host_version (hd, option);
581 else if (strcasecmp ("Collect", option->key) == 0)
582 csnmp_config_add_host_collect (hd, option);
583 else if (strcasecmp ("Interval", option->key) == 0)
584 csnmp_config_add_host_interval (hd, option);
587 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
593 } /* for (ci->children) */
597 if (hd->address == NULL)
599 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
603 if (hd->community == NULL)
605 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
611 } /* while (status == 0) */
620 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
621 hd->name, hd->address, hd->community, hd->version);
623 if (host_head == NULL)
627 host_definition_t *last;
629 while (last->next != NULL)
635 } /* int csnmp_config_add_host */
637 static int csnmp_config (oconfig_item_t *ci)
641 call_snmp_init_once ();
643 for (i = 0; i < ci->children_num; i++)
645 oconfig_item_t *child = ci->children + i;
646 if (strcasecmp ("Data", child->key) == 0)
647 csnmp_config_add_data (child);
648 else if (strcasecmp ("Host", child->key) == 0)
649 csnmp_config_add_host (child);
652 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
654 } /* for (ci->children) */
657 } /* int csnmp_config */
659 /* End of the config stuff. Now the interesting part begins */
661 static void csnmp_host_close_session (host_definition_t *host)
663 if (host->sess_handle == NULL)
666 snmp_sess_close (host->sess_handle);
667 host->sess_handle = NULL;
668 } /* void csnmp_host_close_session */
670 static void csnmp_host_open_session (host_definition_t *host)
672 struct snmp_session sess;
674 if (host->sess_handle != NULL)
675 csnmp_host_close_session (host);
677 snmp_sess_init (&sess);
678 sess.peername = host->address;
679 sess.community = (u_char *) host->community;
680 sess.community_len = strlen (host->community);
681 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
683 /* snmp_sess_open will copy the `struct snmp_session *'. */
684 host->sess_handle = snmp_sess_open (&sess);
686 if (host->sess_handle == NULL)
690 snmp_error (&sess, NULL, NULL, &errstr);
692 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
693 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
696 } /* void csnmp_host_open_session */
698 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
699 double scale, double shift)
705 if ((vl->type == ASN_INTEGER)
706 || (vl->type == ASN_UINTEGER)
707 || (vl->type == ASN_COUNTER)
709 || (vl->type == ASN_TIMETICKS)
711 || (vl->type == ASN_GAUGE))
713 temp = (uint32_t) *vl->val.integer;
714 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", temp);
716 else if (vl->type == ASN_COUNTER64)
718 temp = (uint32_t) vl->val.counter64->high;
720 temp += (uint32_t) vl->val.counter64->low;
721 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", temp);
723 else if (vl->type == ASN_OCTET_STR)
725 /* We'll handle this later.. */
729 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
733 if (vl->type == ASN_OCTET_STR)
738 if (vl->val.string != NULL)
741 size_t string_length;
743 string_length = sizeof (string) - 1;
744 if (vl->val_len < string_length)
745 string_length = vl->val_len;
747 /* The strings we get from the Net-SNMP library may not be null
748 * terminated. That is why we're using `membpy' here and not `strcpy'.
749 * `string_length' is set to `vl->val_len' which holds the length of the
751 memcpy (string, vl->val.string, string_length);
752 string[string_length] = 0;
754 if (type == DS_TYPE_COUNTER)
756 ret.counter = (counter_t) strtoll (string, &endptr, /* base = */ 0);
757 DEBUG ("snmp plugin: csnmp_value_list_to_value: String to counter: %s -> %llu",
758 string, (unsigned long long) ret.counter);
760 else if (type == DS_TYPE_GAUGE)
762 ret.gauge = (gauge_t) strtod (string, &endptr);
763 DEBUG ("snmp plugin: csnmp_value_list_to_value: String to gauge: %s -> %g",
764 string, (double) ret.gauge);
768 /* Check if an error occurred */
769 if ((vl->val.string == NULL) || (endptr == (char *) vl->val.string))
771 if (type == DS_TYPE_COUNTER)
773 else if (type == DS_TYPE_GAUGE)
777 else if (type == DS_TYPE_COUNTER)
781 else if (type == DS_TYPE_GAUGE)
785 ret.gauge = (scale * temp) + shift;
789 } /* value_t csnmp_value_list_to_value */
791 /* Returns true if all OIDs have left their subtree */
792 static int csnmp_check_res_left_subtree (const host_definition_t *host,
793 const data_definition_t *data,
794 struct snmp_pdu *res)
796 struct variable_list *vb;
798 int num_left_subtree;
806 num_left_subtree = 0;
808 /* check all the variables and count how many have left their subtree */
809 for (vb = res->variables, i = 0;
810 (vb != NULL) && (i < data->values_len);
811 vb = vb->next_variable, i++)
814 if (snmp_oid_ncompare (data->values[i].oid,
815 data->values[i].oid_len,
816 vb->name, vb->name_length,
817 data->values[i].oid_len) != 0)
821 /* check if enough variables have been returned */
822 if (i < data->values_len)
824 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
825 host->name, data->values_len, i);
829 if (data->instance.oid.oid_len > 0)
833 ERROR ("snmp plugin: host %s: Expected one more variable for "
834 "the instance..", host->name);
839 if (snmp_oid_ncompare (data->instance.oid.oid,
840 data->instance.oid.oid_len,
841 vb->name, vb->name_length,
842 data->instance.oid.oid_len) != 0)
846 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
847 "left their subtree",
848 num_left_subtree, num_checked);
849 if (num_left_subtree >= num_checked)
852 } /* int csnmp_check_res_left_subtree */
854 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
855 csnmp_list_instances_t **tail,
856 const struct snmp_pdu *res)
858 csnmp_list_instances_t *il;
859 struct variable_list *vb;
861 /* Set vb on the last variable */
862 for (vb = res->variables;
863 (vb != NULL) && (vb->next_variable != NULL);
864 vb = vb->next_variable)
869 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
872 ERROR ("snmp plugin: malloc failed.");
875 il->subid = vb->name[vb->name_length - 1];
878 /* Get instance name */
879 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
884 memset (il->instance, 0, sizeof (il->instance));
885 instance_len = sizeof (il->instance) - 1;
886 if (instance_len > vb->val_len)
887 instance_len = vb->val_len;
889 sstrncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
891 : vb->val.bitstring),
894 for (ptr = il->instance; *ptr != '\0'; ptr++)
896 if ((*ptr > 0) && (*ptr < 32))
898 else if (*ptr == '/')
901 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
905 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
906 ssnprintf (il->instance, sizeof (il->instance),
907 "%llu", val.counter);
910 /* TODO: Debugging output */
919 } /* int csnmp_instance_list_add */
921 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
922 csnmp_list_instances_t *instance_list,
923 csnmp_table_values_t **value_table)
925 const data_set_t *ds;
926 value_list_t vl = VALUE_LIST_INIT;
928 csnmp_list_instances_t *instance_list_ptr;
929 csnmp_table_values_t **value_table_ptr;
935 ds = plugin_get_ds (data->type);
938 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
941 assert (ds->ds_num == data->values_len);
943 instance_list_ptr = instance_list;
945 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
947 if (value_table_ptr == NULL)
949 for (i = 0; i < data->values_len; i++)
950 value_table_ptr[i] = value_table[i];
952 vl.values_len = ds->ds_num;
953 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
954 if (vl.values == NULL)
956 ERROR ("snmp plugin: malloc failed.");
957 sfree (value_table_ptr);
961 sstrncpy (vl.host, host->name, sizeof (vl.host));
962 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
964 vl.interval = host->interval;
965 vl.time = time (NULL);
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; 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);
1387 vl.time = time (NULL);
1389 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1393 snprint_variable (buffer, sizeof (buffer),
1394 vb->name, vb->name_length, vb);
1395 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1396 #endif /* COLLECT_DEBUG */
1398 for (i = 0; i < data->values_len; i++)
1399 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1400 vb->name, vb->name_length) == 0)
1401 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1402 data->scale, data->shift);
1403 } /* for (res->variables) */
1406 snmp_free_pdu (res);
1409 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1410 plugin_dispatch_values (&vl);
1414 } /* int csnmp_read_value */
1416 static int csnmp_read_host (host_definition_t *host)
1422 time_start = time (NULL);
1423 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1424 (unsigned int) time_start);
1426 if (host->sess_handle == NULL)
1427 csnmp_host_open_session (host);
1429 if (host->sess_handle == NULL)
1432 for (i = 0; i < host->data_list_len; i++)
1434 data_definition_t *data = host->data_list[i];
1437 csnmp_read_table (host, data);
1439 csnmp_read_value (host, data);
1442 time_end = time (NULL);
1443 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1444 (unsigned int) time_end);
1445 if ((time_end - time_start) > host->interval)
1447 WARNING ("snmp plugin: Host `%s' should be queried every %i seconds, "
1448 "but reading all values takes %u seconds.",
1449 host->name, host->interval, (unsigned int) (time_end - time_start));
1453 } /* int csnmp_read_host */
1455 static void *csnmp_read_thread (void *data)
1457 host_definition_t *host;
1459 pthread_mutex_lock (&host_lock);
1460 while (do_shutdown == 0)
1462 pthread_cond_wait (&host_cond, &host_lock);
1464 for (host = host_head; host != NULL; host = host->next)
1466 if (do_shutdown != 0)
1468 if (host->state != STATE_WAIT)
1471 host->state = STATE_BUSY;
1472 pthread_mutex_unlock (&host_lock);
1473 csnmp_read_host (host);
1474 pthread_mutex_lock (&host_lock);
1475 host->state = STATE_IDLE;
1477 } /* while (do_shutdown == 0) */
1478 pthread_mutex_unlock (&host_lock);
1480 pthread_exit ((void *) 0);
1481 return ((void *) 0);
1482 } /* void *csnmp_read_thread */
1484 static int csnmp_init (void)
1486 host_definition_t *host;
1489 if (host_head == NULL)
1491 NOTICE ("snmp plugin: No host has been defined.");
1495 call_snmp_init_once ();
1498 for (host = host_head; host != NULL; host = host->next)
1501 /* We need to initialize `interval' here, because `interval_g' isn't
1502 * initialized during `configure'. */
1503 host->next_update = time (NULL);
1504 if (host->interval == 0)
1506 host->interval = interval_g;
1508 else if (host->interval < interval_g)
1510 host->interval = interval_g;
1511 WARNING ("snmp plugin: Data for host `%s' will be collected every %i seconds.",
1512 host->name, host->interval);
1515 csnmp_host_open_session (host);
1518 /* Now start the reading threads */
1519 if (threads_num > 3)
1521 threads_num = 3 + ((threads_num - 3) / 10);
1522 if (threads_num > 10)
1526 threads = (pthread_t *) malloc (threads_num * sizeof (pthread_t));
1527 if (threads == NULL)
1529 ERROR ("snmp plugin: malloc failed.");
1532 memset (threads, '\0', threads_num * sizeof (pthread_t));
1534 for (i = 0; i < threads_num; i++)
1535 pthread_create (threads + i, NULL, csnmp_read_thread, (void *) 0);
1538 } /* int csnmp_init */
1540 static int csnmp_read (void)
1542 host_definition_t *host;
1545 if (host_head == NULL)
1547 INFO ("snmp plugin: No hosts configured.");
1553 pthread_mutex_lock (&host_lock);
1554 for (host = host_head; host != NULL; host = host->next)
1556 if (host->state != STATE_IDLE)
1559 /* Skip this host if the next or a later iteration will be sufficient. */
1560 if (host->next_update >= (now + interval_g))
1563 host->state = STATE_WAIT;
1564 host->next_update = now + host->interval;
1567 pthread_cond_broadcast (&host_cond);
1568 pthread_mutex_unlock (&host_lock);
1571 } /* int csnmp_read */
1573 static int csnmp_shutdown (void)
1575 host_definition_t *host_this;
1576 host_definition_t *host_next;
1578 data_definition_t *data_this;
1579 data_definition_t *data_next;
1583 pthread_mutex_lock (&host_lock);
1585 pthread_cond_broadcast (&host_cond);
1586 pthread_mutex_unlock (&host_lock);
1588 for (i = 0; i < threads_num; i++)
1589 pthread_join (threads[i], NULL);
1591 /* Now that all the threads have exited, let's free all the global variables.
1592 * This isn't really neccessary, I guess, but I think it's good stile to do
1594 host_this = host_head;
1596 while (host_this != NULL)
1598 host_next = host_this->next;
1600 csnmp_host_close_session (host_this);
1602 sfree (host_this->name);
1603 sfree (host_this->address);
1604 sfree (host_this->community);
1605 sfree (host_this->data_list);
1608 host_this = host_next;
1611 data_this = data_head;
1613 while (data_this != NULL)
1615 data_next = data_this->next;
1617 sfree (data_this->name);
1618 sfree (data_this->type);
1619 sfree (data_this->values);
1622 data_this = data_next;
1626 } /* int csnmp_shutdown */
1628 void module_register (void)
1630 plugin_register_complex_config ("snmp", csnmp_config);
1631 plugin_register_init ("snmp", csnmp_init);
1632 plugin_register_read ("snmp", csnmp_read);
1633 plugin_register_shutdown ("snmp", csnmp_shutdown);
1634 } /* void module_register */
1637 * vim: shiftwidth=2 softtabstop=2 tabstop=8