2 * collectd - src/snmp.c
3 * Copyright (C) 2007-2012 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
31 #include "utils_complain.h"
33 #include <net-snmp/net-snmp-config.h>
34 #include <net-snmp/net-snmp-includes.h>
39 * Private data structes
46 typedef struct oid_s oid_t;
50 char string[DATA_MAX_NAME_LEN];
53 typedef union instance_u instance_t;
55 struct data_definition_s
57 char *name; /* used to reference this from the `Collect' option */
58 char *type; /* used to find the data_set */
61 char *instance_prefix;
66 struct data_definition_s *next;
71 typedef struct data_definition_s data_definition_t;
73 struct host_definition_s
79 /* snmpv1/2 options */
82 /* snmpv3 security options */
85 size_t auth_protocol_len;
86 char *auth_passphrase;
88 size_t priv_protocol_len;
89 char *priv_passphrase;
94 c_complain_t complaint;
96 data_definition_t **data_list;
99 typedef struct host_definition_s host_definition_t;
101 /* These two types are used to cache values in `csnmp_read_table' to handle
103 struct csnmp_list_instances_s
106 char instance[DATA_MAX_NAME_LEN];
107 struct csnmp_list_instances_s *next;
109 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
111 struct csnmp_table_values_s
115 struct csnmp_table_values_s *next;
117 typedef struct csnmp_table_values_s csnmp_table_values_t;
122 static data_definition_t *data_head = NULL;
127 static int csnmp_read_host (user_data_t *ud);
132 static void csnmp_oid_init (oid_t *dst, oid const *src, size_t n)
134 assert (n <= STATIC_ARRAY_SIZE (dst->oid));
135 memcpy (dst->oid, src, sizeof (*src) * n);
139 static int csnmp_oid_compare (oid_t const *left, oid_t const *right)
141 return (snmp_oid_compare (left->oid, left->oid_len,
142 right->oid, right->oid_len));
145 static int csnmp_oid_suffix (oid_t *dst, oid_t const *src,
148 /* Make sure "src" is in "root"s subtree. */
149 if (src->oid_len <= root->oid_len)
151 if (snmp_oid_ncompare (root->oid, root->oid_len,
152 src->oid, src->oid_len,
153 /* n = */ root->oid_len) != 0)
156 memset (dst, 0, sizeof (*dst));
157 dst->oid_len = src->oid_len - root->oid_len;
158 memcpy (dst->oid, &src->oid[root->oid_len],
159 dst->oid_len * sizeof (dst->oid[0]));
163 static int csnmp_oid_to_string (char *buffer, size_t buffer_size,
166 char oid_str[MAX_OID_LEN][16];
167 char *oid_str_ptr[MAX_OID_LEN];
169 for (size_t i = 0; i < o->oid_len; i++)
171 ssnprintf (oid_str[i], sizeof (oid_str[i]), "%lu", (unsigned long) o->oid[i]);
172 oid_str_ptr[i] = oid_str[i];
175 return (strjoin (buffer, buffer_size,
176 oid_str_ptr, o->oid_len, /* separator = */ "."));
179 static void csnmp_host_close_session (host_definition_t *host) /* {{{ */
181 if (host->sess_handle == NULL)
184 snmp_sess_close (host->sess_handle);
185 host->sess_handle = NULL;
186 } /* }}} void csnmp_host_close_session */
188 static void csnmp_host_definition_destroy (void *arg) /* {{{ */
190 host_definition_t *hd;
197 if (hd->name != NULL)
199 DEBUG ("snmp plugin: Destroying host definition for host `%s'.",
203 csnmp_host_close_session (hd);
207 sfree (hd->community);
208 sfree (hd->username);
209 sfree (hd->auth_passphrase);
210 sfree (hd->priv_passphrase);
212 sfree (hd->data_list);
215 } /* }}} void csnmp_host_definition_destroy */
217 /* Many functions to handle the configuration. {{{ */
218 /* First there are many functions which do configuration stuff. It's a big
219 * bloated and messy, I'm afraid. */
222 * Callgraph for the config stuff:
224 * +-> call_snmp_init_once
225 * +-> csnmp_config_add_data
226 * ! +-> csnmp_config_add_data_instance
227 * ! +-> csnmp_config_add_data_instance_prefix
228 * ! +-> csnmp_config_add_data_values
229 * +-> csnmp_config_add_host
230 * +-> csnmp_config_add_host_version
231 * +-> csnmp_config_add_host_collect
232 * +-> csnmp_config_add_host_auth_protocol
233 * +-> csnmp_config_add_host_priv_protocol
234 * +-> csnmp_config_add_host_security_level
236 static void call_snmp_init_once (void)
238 static int have_init = 0;
241 init_snmp (PACKAGE_NAME);
243 } /* void call_snmp_init_once */
245 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
247 char buffer[DATA_MAX_NAME_LEN];
250 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
256 /* Instance is an OID */
257 dd->instance.oid.oid_len = MAX_OID_LEN;
259 if (!read_objid (buffer,
260 dd->instance.oid.oid, &dd->instance.oid.oid_len))
262 ERROR ("snmp plugin: read_objid (%s) failed.", buffer);
268 /* Instance is a simple string */
269 sstrncpy (dd->instance.string, buffer,
270 sizeof (dd->instance.string));
274 } /* int csnmp_config_add_data_instance */
276 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
283 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
284 "is set to `false'.", dd->name);
288 status = cf_util_get_string(ci, &dd->instance_prefix);
290 } /* int csnmp_config_add_data_instance_prefix */
292 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
294 if (ci->values_num < 1)
296 WARNING ("snmp plugin: `Values' needs at least one argument.");
300 for (int i = 0; i < ci->values_num; i++)
301 if (ci->values[i].type != OCONFIG_TYPE_STRING)
303 WARNING ("snmp plugin: `Values' needs only string argument.");
309 dd->values = malloc (sizeof (*dd->values) * ci->values_num);
310 if (dd->values == NULL)
312 dd->values_len = (size_t) ci->values_num;
314 for (int i = 0; i < ci->values_num; i++)
316 dd->values[i].oid_len = MAX_OID_LEN;
318 if (NULL == snmp_parse_oid (ci->values[i].value.string,
319 dd->values[i].oid, &dd->values[i].oid_len))
321 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
322 ci->values[i].value.string);
331 } /* int csnmp_config_add_data_instance */
333 static int csnmp_config_add_data_blacklist(data_definition_t *dd, oconfig_item_t *ci)
335 if (ci->values_num < 1)
338 for (int i = 0; i < ci->values_num; i++)
340 if (ci->values[i].type != OCONFIG_TYPE_STRING)
342 WARNING ("snmp plugin: `Ignore' needs only string argument.");
350 for (int i = 0; i < ci->values_num; ++i)
352 if (strarray_add(&(dd->ignores), &(dd->ignores_len), ci->values[i].value.string) != 0)
354 ERROR("snmp plugin: Can't allocate memory");
355 strarray_free(dd->ignores, dd->ignores_len);
360 } /* int csnmp_config_add_data_blacklist */
362 static int csnmp_config_add_data_blacklist_match_inverted(data_definition_t *dd, oconfig_item_t *ci)
364 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
366 WARNING ("snmp plugin: `InvertMatch' needs exactly one boolean argument.");
370 dd->invert_match = ci->values[0].value.boolean ? 1 : 0;
373 } /* int csnmp_config_add_data_blacklist_match_inverted */
375 static int csnmp_config_add_data (oconfig_item_t *ci)
377 data_definition_t *dd;
380 dd = calloc (1, sizeof (*dd));
384 status = cf_util_get_string(ci, &dd->name);
394 for (int i = 0; i < ci->children_num; i++)
396 oconfig_item_t *option = ci->children + i;
398 if (strcasecmp ("Type", option->key) == 0)
399 status = cf_util_get_string(option, &dd->type);
400 else if (strcasecmp ("Table", option->key) == 0)
401 status = cf_util_get_boolean(option, &dd->is_table);
402 else if (strcasecmp ("Instance", option->key) == 0)
403 status = csnmp_config_add_data_instance (dd, option);
404 else if (strcasecmp ("InstancePrefix", option->key) == 0)
405 status = csnmp_config_add_data_instance_prefix (dd, option);
406 else if (strcasecmp ("Values", option->key) == 0)
407 status = csnmp_config_add_data_values (dd, option);
408 else if (strcasecmp ("Shift", option->key) == 0)
409 status = cf_util_get_double(option, &dd->shift);
410 else if (strcasecmp ("Scale", option->key) == 0)
411 status = cf_util_get_double(option, &dd->scale);
412 else if (strcasecmp ("Ignore", option->key) == 0)
413 status = csnmp_config_add_data_blacklist(dd, option);
414 else if (strcasecmp ("InvertMatch", option->key) == 0)
415 status = csnmp_config_add_data_blacklist_match_inverted(dd, option);
418 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
424 } /* for (ci->children) */
428 if (dd->type == NULL)
430 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
434 if (dd->values == NULL)
436 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
442 } /* while (status == 0) */
447 sfree (dd->instance_prefix);
454 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %zu }",
455 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
457 if (data_head == NULL)
461 data_definition_t *last;
463 while (last->next != NULL)
469 } /* int csnmp_config_add_data */
471 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
475 if ((ci->values_num != 1)
476 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
478 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
482 version = (int) ci->values[0].value.number;
483 if ((version < 1) || (version > 3))
485 WARNING ("snmp plugin: `Version' must either be `1', `2', or `3'.");
489 hd->version = version;
492 } /* int csnmp_config_add_host_address */
494 static int csnmp_config_add_host_collect (host_definition_t *host,
497 data_definition_t *data;
498 data_definition_t **data_list;
501 if (ci->values_num < 1)
503 WARNING ("snmp plugin: `Collect' needs at least one argument.");
507 for (int i = 0; i < ci->values_num; i++)
508 if (ci->values[i].type != OCONFIG_TYPE_STRING)
510 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
514 data_list_len = host->data_list_len + ci->values_num;
515 data_list = realloc (host->data_list,
516 sizeof (data_definition_t *) * data_list_len);
517 if (data_list == NULL)
519 host->data_list = data_list;
521 for (int i = 0; i < ci->values_num; i++)
523 for (data = data_head; data != NULL; data = data->next)
524 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
529 WARNING ("snmp plugin: No such data configured: `%s'",
530 ci->values[i].value.string);
534 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
535 host->name, host->data_list_len, data->name);
537 host->data_list[host->data_list_len] = data;
538 host->data_list_len++;
539 } /* for (values_num) */
542 } /* int csnmp_config_add_host_collect */
544 static int csnmp_config_add_host_auth_protocol (host_definition_t *hd, oconfig_item_t *ci)
549 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
553 if (strcasecmp("MD5", buffer) == 0) {
554 hd->auth_protocol = usmHMACMD5AuthProtocol;
555 hd->auth_protocol_len = sizeof(usmHMACMD5AuthProtocol)/sizeof(oid);
557 else if (strcasecmp("SHA", buffer) == 0) {
558 hd->auth_protocol = usmHMACSHA1AuthProtocol;
559 hd->auth_protocol_len = sizeof(usmHMACSHA1AuthProtocol)/sizeof(oid);
563 WARNING ("snmp plugin: The `AuthProtocol' config option must be `MD5' or `SHA'.");
567 DEBUG ("snmp plugin: host = %s; host->auth_protocol = %s;",
568 hd->name, hd->auth_protocol == usmHMACMD5AuthProtocol ? "MD5" : "SHA");
571 } /* int csnmp_config_add_host_auth_protocol */
573 static int csnmp_config_add_host_priv_protocol (host_definition_t *hd, oconfig_item_t *ci)
578 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
582 if (strcasecmp("AES", buffer) == 0)
584 hd->priv_protocol = usmAESPrivProtocol;
585 hd->priv_protocol_len = sizeof(usmAESPrivProtocol)/sizeof(oid);
587 else if (strcasecmp("DES", buffer) == 0) {
588 hd->priv_protocol = usmDESPrivProtocol;
589 hd->priv_protocol_len = sizeof(usmDESPrivProtocol)/sizeof(oid);
593 WARNING ("snmp plugin: The `PrivProtocol' config option must be `AES' or `DES'.");
597 DEBUG ("snmp plugin: host = %s; host->priv_protocol = %s;",
598 hd->name, hd->priv_protocol == usmAESPrivProtocol ? "AES" : "DES");
601 } /* int csnmp_config_add_host_priv_protocol */
603 static int csnmp_config_add_host_security_level (host_definition_t *hd, oconfig_item_t *ci)
608 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
612 if (strcasecmp("noAuthNoPriv", buffer) == 0)
613 hd->security_level = SNMP_SEC_LEVEL_NOAUTH;
614 else if (strcasecmp("authNoPriv", buffer) == 0)
615 hd->security_level = SNMP_SEC_LEVEL_AUTHNOPRIV;
616 else if (strcasecmp("authPriv", buffer) == 0)
617 hd->security_level = SNMP_SEC_LEVEL_AUTHPRIV;
620 WARNING ("snmp plugin: The `SecurityLevel' config option must be `noAuthNoPriv', `authNoPriv', or `authPriv'.");
624 DEBUG ("snmp plugin: host = %s; host->security_level = %d;",
625 hd->name, hd->security_level);
628 } /* int csnmp_config_add_host_security_level */
630 static int csnmp_config_add_host (oconfig_item_t *ci)
632 host_definition_t *hd;
635 /* Registration stuff. */
636 char cb_name[DATA_MAX_NAME_LEN];
637 user_data_t cb_data = { 0 };
639 hd = calloc (1, sizeof (*hd));
643 C_COMPLAIN_INIT (&hd->complaint);
645 status = cf_util_get_string(ci, &hd->name);
652 hd->sess_handle = NULL;
655 for (int i = 0; i < ci->children_num; i++)
657 oconfig_item_t *option = ci->children + i;
660 if (strcasecmp ("Address", option->key) == 0)
661 status = cf_util_get_string(option, &hd->address);
662 else if (strcasecmp ("Community", option->key) == 0)
663 status = cf_util_get_string(option, &hd->community);
664 else if (strcasecmp ("Version", option->key) == 0)
665 status = csnmp_config_add_host_version (hd, option);
666 else if (strcasecmp ("Collect", option->key) == 0)
667 csnmp_config_add_host_collect (hd, option);
668 else if (strcasecmp ("Interval", option->key) == 0)
669 cf_util_get_cdtime (option, &hd->interval);
670 else if (strcasecmp ("Username", option->key) == 0)
671 status = cf_util_get_string(option, &hd->username);
672 else if (strcasecmp ("AuthProtocol", option->key) == 0)
673 status = csnmp_config_add_host_auth_protocol (hd, option);
674 else if (strcasecmp ("PrivacyProtocol", option->key) == 0)
675 status = csnmp_config_add_host_priv_protocol (hd, option);
676 else if (strcasecmp ("AuthPassphrase", option->key) == 0)
677 status = cf_util_get_string(option, &hd->auth_passphrase);
678 else if (strcasecmp ("PrivacyPassphrase", option->key) == 0)
679 status = cf_util_get_string(option, &hd->priv_passphrase);
680 else if (strcasecmp ("SecurityLevel", option->key) == 0)
681 status = csnmp_config_add_host_security_level (hd, option);
682 else if (strcasecmp ("Context", option->key) == 0)
683 status = cf_util_get_string(option, &hd->context);
686 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
692 } /* for (ci->children) */
696 if (hd->address == NULL)
698 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
702 if (hd->community == NULL && hd->version < 3)
704 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
708 if (hd->version == 3)
710 if (hd->username == NULL)
712 WARNING ("snmp plugin: `Username' not given for host `%s'", hd->name);
716 if (hd->security_level == 0)
718 WARNING ("snmp plugin: `SecurityLevel' not given for host `%s'", hd->name);
722 if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV || hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV)
724 if (hd->auth_protocol == NULL)
726 WARNING ("snmp plugin: `AuthProtocol' not given for host `%s'", hd->name);
730 if (hd->auth_passphrase == NULL)
732 WARNING ("snmp plugin: `AuthPassphrase' not given for host `%s'", hd->name);
737 if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV)
739 if (hd->priv_protocol == NULL)
741 WARNING ("snmp plugin: `PrivacyProtocol' not given for host `%s'", hd->name);
745 if (hd->priv_passphrase == NULL)
747 WARNING ("snmp plugin: `PrivacyPassphrase' not given for host `%s'", hd->name);
755 } /* while (status == 0) */
759 csnmp_host_definition_destroy (hd);
763 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
764 hd->name, hd->address, hd->community, hd->version);
766 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
769 cb_data.free_func = csnmp_host_definition_destroy;
771 status = plugin_register_complex_read (/* group = */ NULL, cb_name,
772 csnmp_read_host, hd->interval, /* user_data = */ &cb_data);
775 ERROR ("snmp plugin: Registering complex read function failed.");
776 csnmp_host_definition_destroy (hd);
781 } /* int csnmp_config_add_host */
783 static int csnmp_config (oconfig_item_t *ci)
785 call_snmp_init_once ();
787 for (int i = 0; i < ci->children_num; i++)
789 oconfig_item_t *child = ci->children + i;
790 if (strcasecmp ("Data", child->key) == 0)
791 csnmp_config_add_data (child);
792 else if (strcasecmp ("Host", child->key) == 0)
793 csnmp_config_add_host (child);
796 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
798 } /* for (ci->children) */
801 } /* int csnmp_config */
803 /* }}} End of the config stuff. Now the interesting part begins */
805 static void csnmp_host_open_session (host_definition_t *host)
807 struct snmp_session sess;
810 if (host->sess_handle != NULL)
811 csnmp_host_close_session (host);
813 snmp_sess_init (&sess);
814 sess.peername = host->address;
815 switch (host->version)
818 sess.version = SNMP_VERSION_1;
821 sess.version = SNMP_VERSION_3;
824 sess.version = SNMP_VERSION_2c;
828 if (host->version == 3)
830 sess.securityName = host->username;
831 sess.securityNameLen = strlen (host->username);
832 sess.securityLevel = host->security_level;
834 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV || sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV)
836 sess.securityAuthProto = host->auth_protocol;
837 sess.securityAuthProtoLen = host->auth_protocol_len;
838 sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
839 error = generate_Ku (sess.securityAuthProto,
840 sess.securityAuthProtoLen,
841 (u_char *) host->auth_passphrase,
842 strlen(host->auth_passphrase),
843 sess.securityAuthKey,
844 &sess.securityAuthKeyLen);
845 if (error != SNMPERR_SUCCESS) {
846 ERROR ("snmp plugin: host %s: Error generating Ku from auth_passphrase. (Error %d)", host->name, error);
850 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV)
852 sess.securityPrivProto = host->priv_protocol;
853 sess.securityPrivProtoLen = host->priv_protocol_len;
854 sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
855 error = generate_Ku (sess.securityAuthProto,
856 sess.securityAuthProtoLen,
857 (u_char *) host->priv_passphrase,
858 strlen(host->priv_passphrase),
859 sess.securityPrivKey,
860 &sess.securityPrivKeyLen);
861 if (error != SNMPERR_SUCCESS) {
862 ERROR ("snmp plugin: host %s: Error generating Ku from priv_passphrase. (Error %d)", host->name, error);
866 if (host->context != NULL)
868 sess.contextName = host->context;
869 sess.contextNameLen = strlen (host->context);
872 else /* SNMPv1/2 "authenticates" with community string */
874 sess.community = (u_char *) host->community;
875 sess.community_len = strlen (host->community);
878 /* snmp_sess_open will copy the `struct snmp_session *'. */
879 host->sess_handle = snmp_sess_open (&sess);
881 if (host->sess_handle == NULL)
885 snmp_error (&sess, NULL, NULL, &errstr);
887 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
888 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
891 } /* void csnmp_host_open_session */
893 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
894 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
895 double scale, double shift,
896 const char *host_name, const char *data_name)
899 uint64_t tmp_unsigned = 0;
900 int64_t tmp_signed = 0;
902 /* Set to true when the original SNMP type appears to have been signed. */
903 _Bool prefer_signed = 0;
905 if ((vl->type == ASN_INTEGER)
906 || (vl->type == ASN_UINTEGER)
907 || (vl->type == ASN_COUNTER)
909 || (vl->type == ASN_TIMETICKS)
911 || (vl->type == ASN_GAUGE))
913 tmp_unsigned = (uint32_t) *vl->val.integer;
914 tmp_signed = (int32_t) *vl->val.integer;
916 if (vl->type == ASN_INTEGER)
919 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", tmp_unsigned);
921 else if (vl->type == ASN_COUNTER64)
923 tmp_unsigned = (uint32_t) vl->val.counter64->high;
924 tmp_unsigned = tmp_unsigned << 32;
925 tmp_unsigned += (uint32_t) vl->val.counter64->low;
926 tmp_signed = (int64_t) tmp_unsigned;
927 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
929 else if (vl->type == ASN_OCTET_STR)
931 /* We'll handle this later.. */
935 char oid_buffer[1024] = { 0 };
937 snprint_objid (oid_buffer, sizeof (oid_buffer) - 1,
938 vl->name, vl->name_length);
941 if (vl->type == ASN_NULL)
942 INFO ("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)",
946 WARNING ("snmp plugin: I don't know the ASN type #%i "
947 "(OID: \"%s\", data block \"%s\", host block \"%s\")",
948 (int) vl->type, oid_buffer,
949 (data_name != NULL) ? data_name : "UNKNOWN",
950 (host_name != NULL) ? host_name : "UNKNOWN");
955 if (vl->type == ASN_OCTET_STR)
959 if (vl->val.string != NULL)
962 size_t string_length;
964 string_length = sizeof (string) - 1;
965 if (vl->val_len < string_length)
966 string_length = vl->val_len;
968 /* The strings we get from the Net-SNMP library may not be null
969 * terminated. That is why we're using `memcpy' here and not `strcpy'.
970 * `string_length' is set to `vl->val_len' which holds the length of the
972 memcpy (string, vl->val.string, string_length);
973 string[string_length] = 0;
975 status = parse_value (string, &ret, type);
978 ERROR ("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string as %s failed: %s",
979 (host_name != NULL) ? host_name : "UNKNOWN",
980 DS_TYPE_TO_STRING (type), string);
988 case DS_TYPE_COUNTER:
990 case DS_TYPE_ABSOLUTE:
991 memset (&ret, 0, sizeof (ret));
999 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
1000 "data source type: %i.", type);
1004 } /* if (vl->type == ASN_OCTET_STR) */
1005 else if (type == DS_TYPE_COUNTER)
1007 ret.counter = tmp_unsigned;
1009 else if (type == DS_TYPE_GAUGE)
1013 else if (prefer_signed)
1014 ret.gauge = (scale * tmp_signed) + shift;
1016 ret.gauge = (scale * tmp_unsigned) + shift;
1018 else if (type == DS_TYPE_DERIVE)
1021 ret.derive = (derive_t) tmp_signed;
1023 ret.derive = (derive_t) tmp_unsigned;
1025 else if (type == DS_TYPE_ABSOLUTE)
1027 ret.absolute = (absolute_t) tmp_unsigned;
1031 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
1037 } /* value_t csnmp_value_list_to_value */
1039 /* csnmp_strvbcopy_hexstring converts the bit string contained in "vb" to a hex
1040 * representation and writes it to dst. Returns zero on success and ENOMEM if
1041 * dst is not large enough to hold the string. dst is guaranteed to be
1042 * nul-terminated. */
1043 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
1044 const struct variable_list *vb, size_t dst_size)
1052 buffer_free = dst_size;
1054 for (size_t i = 0; i < vb->val_len; i++)
1058 status = snprintf (buffer_ptr, buffer_free,
1059 (i == 0) ? "%02x" : ":%02x", (unsigned int) vb->val.bitstring[i]);
1060 assert (status >= 0);
1062 if (((size_t) status) >= buffer_free) /* truncated */
1064 dst[dst_size - 1] = 0;
1067 else /* if (status < buffer_free) */
1069 buffer_ptr += (size_t) status;
1070 buffer_free -= (size_t) status;
1075 } /* }}} int csnmp_strvbcopy_hexstring */
1077 /* csnmp_strvbcopy copies the octet string or bit string contained in vb to
1078 * dst. If non-printable characters are detected, it will switch to a hex
1079 * representation of the string. Returns zero on success, EINVAL if vb does not
1080 * contain a string and ENOMEM if dst is not large enough to contain the
1082 static int csnmp_strvbcopy (char *dst, /* {{{ */
1083 const struct variable_list *vb, size_t dst_size)
1088 if (vb->type == ASN_OCTET_STR)
1089 src = (char *) vb->val.string;
1090 else if (vb->type == ASN_BIT_STR)
1091 src = (char *) vb->val.bitstring;
1092 else if (vb->type == ASN_IPADDRESS)
1094 return ssnprintf (dst, dst_size, "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8"",
1095 (uint8_t) vb->val.string[0],
1096 (uint8_t) vb->val.string[1],
1097 (uint8_t) vb->val.string[2],
1098 (uint8_t) vb->val.string[3]);
1106 num_chars = dst_size - 1;
1107 if (num_chars > vb->val_len)
1108 num_chars = vb->val_len;
1110 for (size_t i = 0; i < num_chars; i++)
1112 /* Check for control characters. */
1113 if ((unsigned char)src[i] < 32)
1114 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
1118 dst[dst_size - 1] = 0;
1120 if (dst_size <= vb->val_len)
1124 } /* }}} int csnmp_strvbcopy */
1126 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
1127 csnmp_list_instances_t **tail,
1128 const struct snmp_pdu *res,
1129 const host_definition_t *hd, const data_definition_t *dd)
1131 csnmp_list_instances_t *il;
1132 struct variable_list *vb;
1135 uint32_t is_matched;
1137 /* Set vb on the last variable */
1138 for (vb = res->variables;
1139 (vb != NULL) && (vb->next_variable != NULL);
1140 vb = vb->next_variable)
1145 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1147 il = calloc (1, sizeof (*il));
1150 ERROR ("snmp plugin: calloc failed.");
1155 status = csnmp_oid_suffix (&il->suffix, &vb_name, &dd->instance.oid);
1162 /* Get instance name */
1163 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR) || (vb->type == ASN_IPADDRESS))
1167 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
1169 for (uint32_t i = 0; i < dd->ignores_len; i++)
1171 status = fnmatch(dd->ignores[i], il->instance, 0);
1174 if (dd->invert_match == 0)
1186 if (dd->invert_match != 0 && is_matched == 0)
1191 for (ptr = il->instance; *ptr != '\0'; ptr++)
1193 if ((*ptr > 0) && (*ptr < 32))
1195 else if (*ptr == '/')
1198 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1202 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER,
1203 /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1204 ssnprintf (il->instance, sizeof (il->instance),
1205 "%llu", val.counter);
1208 /* TODO: Debugging output */
1217 } /* int csnmp_instance_list_add */
1219 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1220 csnmp_list_instances_t *instance_list,
1221 csnmp_table_values_t **value_table)
1223 const data_set_t *ds;
1224 value_list_t vl = VALUE_LIST_INIT;
1226 csnmp_list_instances_t *instance_list_ptr;
1227 csnmp_table_values_t **value_table_ptr;
1231 oid_t current_suffix;
1233 ds = plugin_get_ds (data->type);
1236 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1239 assert (ds->ds_num == data->values_len);
1240 assert (data->values_len > 0);
1242 instance_list_ptr = instance_list;
1244 value_table_ptr = calloc (data->values_len, sizeof (*value_table_ptr));
1245 if (value_table_ptr == NULL)
1247 for (i = 0; i < data->values_len; i++)
1248 value_table_ptr[i] = value_table[i];
1250 vl.values_len = data->values_len;
1251 vl.values = malloc (sizeof (*vl.values) * vl.values_len);
1252 if (vl.values == NULL)
1254 ERROR ("snmp plugin: malloc failed.");
1255 sfree (value_table_ptr);
1259 sstrncpy (vl.host, host->name, sizeof (vl.host));
1260 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1262 vl.interval = host->interval;
1267 _Bool suffix_skipped = 0;
1269 /* Determine next suffix to handle. */
1270 if (instance_list != NULL)
1272 if (instance_list_ptr == NULL)
1278 memcpy (¤t_suffix, &instance_list_ptr->suffix, sizeof (current_suffix));
1280 else /* no instance configured */
1282 csnmp_table_values_t *ptr = value_table_ptr[0];
1289 memcpy (¤t_suffix, &ptr->suffix, sizeof (current_suffix));
1292 /* Update all the value_table_ptr to point at the entry with the same
1293 * trailing partial OID */
1294 for (i = 0; i < data->values_len; i++)
1296 while ((value_table_ptr[i] != NULL)
1297 && (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) < 0))
1298 value_table_ptr[i] = value_table_ptr[i]->next;
1300 if (value_table_ptr[i] == NULL)
1305 else if (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) > 0)
1307 /* This suffix is missing in the subtree. Indicate this with the
1308 * "suffix_skipped" flag and try the next instance / suffix. */
1312 } /* for (i = 0; i < columns; i++) */
1317 /* Matching the values failed. Start from the beginning again. */
1320 if (instance_list != NULL)
1321 instance_list_ptr = instance_list_ptr->next;
1323 value_table_ptr[0] = value_table_ptr[0]->next;
1328 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1329 * to the same subid. instance_list_ptr is either NULL or points to the
1330 * same subid, too. */
1332 for (i = 1; i < data->values_len; i++)
1334 assert (value_table_ptr[i] != NULL);
1335 assert (csnmp_oid_compare (&value_table_ptr[i-1]->suffix,
1336 &value_table_ptr[i]->suffix) == 0);
1338 assert ((instance_list_ptr == NULL)
1339 || (csnmp_oid_compare (&instance_list_ptr->suffix,
1340 &value_table_ptr[0]->suffix) == 0));
1343 sstrncpy (vl.type, data->type, sizeof (vl.type));
1346 char temp[DATA_MAX_NAME_LEN];
1348 if (instance_list_ptr == NULL)
1349 csnmp_oid_to_string (temp, sizeof (temp), ¤t_suffix);
1351 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1353 if (data->instance_prefix == NULL)
1354 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1356 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1357 data->instance_prefix, temp);
1360 for (i = 0; i < data->values_len; i++)
1361 vl.values[i] = value_table_ptr[i]->value;
1363 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1364 plugin_dispatch_values (&vl);
1366 if (instance_list != NULL)
1367 instance_list_ptr = instance_list_ptr->next;
1369 value_table_ptr[0] = value_table_ptr[0]->next;
1370 } /* while (have_more) */
1373 sfree (value_table_ptr);
1376 } /* int csnmp_dispatch_table */
1378 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1380 struct snmp_pdu *req;
1381 struct snmp_pdu *res = NULL;
1382 struct variable_list *vb;
1384 const data_set_t *ds;
1386 size_t oid_list_len = data->values_len + 1;
1387 /* Holds the last OID returned by the device. We use this in the GETNEXT
1388 * request to proceed. */
1389 oid_t oid_list[oid_list_len];
1390 /* Set to false when an OID has left its subtree so we don't re-request it
1392 _Bool oid_list_todo[oid_list_len];
1397 /* `value_list_head' and `value_list_tail' implement a linked list for each
1398 * value. `instance_list_head' and `instance_list_tail' implement a linked list of
1399 * instance names. This is used to jump gaps in the table. */
1400 csnmp_list_instances_t *instance_list_head;
1401 csnmp_list_instances_t *instance_list_tail;
1402 csnmp_table_values_t **value_list_head;
1403 csnmp_table_values_t **value_list_tail;
1405 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1406 host->name, data->name);
1408 if (host->sess_handle == NULL)
1410 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1414 ds = plugin_get_ds (data->type);
1417 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1421 if (ds->ds_num != data->values_len)
1423 ERROR ("snmp plugin: DataSet `%s' requires %zu values, but config talks about %zu",
1424 data->type, ds->ds_num, data->values_len);
1427 assert (data->values_len > 0);
1429 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1430 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1431 if (data->instance.oid.oid_len > 0)
1432 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1433 else /* no InstanceFrom option specified. */
1436 for (i = 0; i < oid_list_len; i++)
1437 oid_list_todo[i] = 1;
1439 /* We're going to construct n linked lists, one for each "value".
1440 * value_list_head will contain pointers to the heads of these linked lists,
1441 * value_list_tail will contain pointers to the tail of the lists. */
1442 value_list_head = calloc (data->values_len, sizeof (*value_list_head));
1443 value_list_tail = calloc (data->values_len, sizeof (*value_list_tail));
1444 if ((value_list_head == NULL) || (value_list_tail == NULL))
1446 ERROR ("snmp plugin: csnmp_read_table: calloc failed.");
1447 sfree (value_list_head);
1448 sfree (value_list_tail);
1452 instance_list_head = NULL;
1453 instance_list_tail = NULL;
1458 int oid_list_todo_num;
1460 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1463 ERROR ("snmp plugin: snmp_pdu_create failed.");
1468 oid_list_todo_num = 0;
1469 for (i = 0; i < oid_list_len; i++)
1471 /* Do not rerequest already finished OIDs */
1472 if (!oid_list_todo[i])
1474 oid_list_todo_num++;
1475 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1478 if (oid_list_todo_num == 0)
1480 /* The request is still empty - so we are finished */
1481 DEBUG ("snmp plugin: all variables have left their subtree");
1487 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1488 if ((status != STAT_SUCCESS) || (res == NULL))
1490 char *errstr = NULL;
1492 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1494 c_complain (LOG_ERR, &host->complaint,
1495 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1496 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1499 snmp_free_pdu (res);
1502 /* snmp_synch_response already freed our PDU */
1505 csnmp_host_close_session (host);
1512 assert (res != NULL);
1513 c_release (LOG_INFO, &host->complaint,
1514 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1517 vb = res->variables;
1524 for (vb = res->variables, i = 0; (vb != NULL); vb = vb->next_variable, i++)
1526 /* Calculate value index from todo list */
1527 while ((i < oid_list_len) && !oid_list_todo[i])
1530 /* An instance is configured and the res variable we process is the
1531 * instance value (last index) */
1532 if ((data->instance.oid.oid_len > 0) && (i == data->values_len))
1534 if ((vb->type == SNMP_ENDOFMIBVIEW)
1535 || (snmp_oid_ncompare (data->instance.oid.oid,
1536 data->instance.oid.oid_len,
1537 vb->name, vb->name_length,
1538 data->instance.oid.oid_len) != 0))
1540 DEBUG ("snmp plugin: host = %s; data = %s; Instance left its subtree.",
1541 host->name, data->name);
1542 oid_list_todo[i] = 0;
1546 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1547 * add it to the list */
1548 if (csnmp_instance_list_add (&instance_list_head, &instance_list_tail,
1549 res, host, data) != 0)
1551 ERROR ("snmp plugin: host %s: csnmp_instance_list_add failed.",
1557 else /* The variable we are processing is a normal value */
1559 csnmp_table_values_t *vt;
1564 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1566 /* Calculate the current suffix. This is later used to check that the
1567 * suffix is increasing. This also checks if we left the subtree */
1568 ret = csnmp_oid_suffix (&suffix, &vb_name, data->values + i);
1571 DEBUG ("snmp plugin: host = %s; data = %s; i = %zu; "
1572 "Value probably left its subtree.",
1573 host->name, data->name, i);
1574 oid_list_todo[i] = 0;
1578 /* Make sure the OIDs returned by the agent are increasing. Otherwise our
1579 * table matching algorithm will get confused. */
1580 if ((value_list_tail[i] != NULL)
1581 && (csnmp_oid_compare (&suffix, &value_list_tail[i]->suffix) <= 0))
1583 DEBUG ("snmp plugin: host = %s; data = %s; i = %zu; "
1584 "Suffix is not increasing.",
1585 host->name, data->name, i);
1586 oid_list_todo[i] = 0;
1590 vt = calloc (1, sizeof (*vt));
1593 ERROR ("snmp plugin: calloc failed.");
1598 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1599 data->scale, data->shift, host->name, data->name);
1600 memcpy (&vt->suffix, &suffix, sizeof (vt->suffix));
1603 if (value_list_tail[i] == NULL)
1604 value_list_head[i] = vt;
1606 value_list_tail[i]->next = vt;
1607 value_list_tail[i] = vt;
1610 /* Copy OID to oid_list[i] */
1611 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1612 oid_list[i].oid_len = vb->name_length;
1614 } /* for (vb = res->variables ...) */
1617 snmp_free_pdu (res);
1619 } /* while (status == 0) */
1622 snmp_free_pdu (res);
1626 snmp_free_pdu (req);
1630 csnmp_dispatch_table (host, data, instance_list_head, value_list_head);
1632 /* Free all allocated variables here */
1633 while (instance_list_head != NULL)
1635 csnmp_list_instances_t *next = instance_list_head->next;
1636 sfree (instance_list_head);
1637 instance_list_head = next;
1640 for (i = 0; i < data->values_len; i++)
1642 while (value_list_head[i] != NULL)
1644 csnmp_table_values_t *next = value_list_head[i]->next;
1645 sfree (value_list_head[i]);
1646 value_list_head[i] = next;
1650 sfree (value_list_head);
1651 sfree (value_list_tail);
1654 } /* int csnmp_read_table */
1656 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1658 struct snmp_pdu *req;
1659 struct snmp_pdu *res = NULL;
1660 struct variable_list *vb;
1662 const data_set_t *ds;
1663 value_list_t vl = VALUE_LIST_INIT;
1668 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1669 host->name, data->name);
1671 if (host->sess_handle == NULL)
1673 DEBUG ("snmp plugin: csnmp_read_value: host->sess_handle == NULL");
1677 ds = plugin_get_ds (data->type);
1680 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1684 if (ds->ds_num != data->values_len)
1686 ERROR ("snmp plugin: DataSet `%s' requires %zu values, but config talks about %zu",
1687 data->type, ds->ds_num, data->values_len);
1691 vl.values_len = ds->ds_num;
1692 vl.values = malloc (sizeof (*vl.values) * vl.values_len);
1693 if (vl.values == NULL)
1695 for (i = 0; i < vl.values_len; i++)
1697 if (ds->ds[i].type == DS_TYPE_COUNTER)
1698 vl.values[i].counter = 0;
1700 vl.values[i].gauge = NAN;
1703 sstrncpy (vl.host, host->name, sizeof (vl.host));
1704 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1705 sstrncpy (vl.type, data->type, sizeof (vl.type));
1706 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1708 vl.interval = host->interval;
1710 req = snmp_pdu_create (SNMP_MSG_GET);
1713 ERROR ("snmp plugin: snmp_pdu_create failed.");
1718 for (i = 0; i < data->values_len; i++)
1719 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1721 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1723 if ((status != STAT_SUCCESS) || (res == NULL))
1725 char *errstr = NULL;
1727 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1728 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1729 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1732 snmp_free_pdu (res);
1736 csnmp_host_close_session (host);
1742 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1746 snprint_variable (buffer, sizeof (buffer),
1747 vb->name, vb->name_length, vb);
1748 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1749 #endif /* COLLECT_DEBUG */
1751 for (i = 0; i < data->values_len; i++)
1752 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1753 vb->name, vb->name_length) == 0)
1754 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1755 data->scale, data->shift, host->name, data->name);
1756 } /* for (res->variables) */
1758 snmp_free_pdu (res);
1760 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1761 plugin_dispatch_values (&vl);
1765 } /* int csnmp_read_value */
1767 static int csnmp_read_host (user_data_t *ud)
1769 host_definition_t *host;
1776 if (host->interval == 0)
1777 host->interval = plugin_get_interval ();
1779 if (host->sess_handle == NULL)
1780 csnmp_host_open_session (host);
1782 if (host->sess_handle == NULL)
1786 for (i = 0; i < host->data_list_len; i++)
1788 data_definition_t *data = host->data_list[i];
1791 status = csnmp_read_table (host, data);
1793 status = csnmp_read_value (host, data);
1803 } /* int csnmp_read_host */
1805 static int csnmp_init (void)
1807 call_snmp_init_once ();
1810 } /* int csnmp_init */
1812 static int csnmp_shutdown (void)
1814 data_definition_t *data_this;
1815 data_definition_t *data_next;
1817 /* When we get here, the read threads have been stopped and all the
1818 * `host_definition_t' will be freed. */
1819 DEBUG ("snmp plugin: Destroying all data definitions.");
1821 data_this = data_head;
1823 while (data_this != NULL)
1825 data_next = data_this->next;
1827 sfree (data_this->name);
1828 sfree (data_this->type);
1829 sfree (data_this->values);
1830 sfree (data_this->ignores);
1833 data_this = data_next;
1837 } /* int csnmp_shutdown */
1839 void module_register (void)
1841 plugin_register_complex_config ("snmp", csnmp_config);
1842 plugin_register_init ("snmp", csnmp_init);
1843 plugin_register_shutdown ("snmp", csnmp_shutdown);
1844 } /* void module_register */
1847 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker