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
45 typedef struct oid_s oid_t;
48 char string[DATA_MAX_NAME_LEN];
51 typedef union instance_u instance_t;
53 struct data_definition_s {
54 char *name; /* used to reference this from the `Collect' option */
55 char *type; /* used to find the data_set */
58 char *instance_prefix;
63 struct data_definition_s *next;
68 typedef struct data_definition_s data_definition_t;
70 struct host_definition_s {
75 /* snmpv1/2 options */
78 /* snmpv3 security options */
81 size_t auth_protocol_len;
82 char *auth_passphrase;
84 size_t priv_protocol_len;
85 char *priv_passphrase;
90 c_complain_t complaint;
92 data_definition_t **data_list;
95 typedef struct host_definition_s host_definition_t;
97 /* These two types are used to cache values in `csnmp_read_table' to handle
99 struct csnmp_list_instances_s {
101 char instance[DATA_MAX_NAME_LEN];
102 struct csnmp_list_instances_s *next;
104 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
106 struct csnmp_table_values_s {
109 struct csnmp_table_values_s *next;
111 typedef struct csnmp_table_values_s csnmp_table_values_t;
116 static data_definition_t *data_head = NULL;
121 static int csnmp_read_host(user_data_t *ud);
126 static void csnmp_oid_init(oid_t *dst, oid const *src, size_t n) {
127 assert(n <= STATIC_ARRAY_SIZE(dst->oid));
128 memcpy(dst->oid, src, sizeof(*src) * n);
132 static int csnmp_oid_compare(oid_t const *left, oid_t const *right) {
133 return snmp_oid_compare(left->oid, left->oid_len, right->oid,
137 static int csnmp_oid_suffix(oid_t *dst, oid_t const *src, oid_t const *root) {
138 /* Make sure "src" is in "root"s subtree. */
139 if (src->oid_len <= root->oid_len)
141 if (snmp_oid_ncompare(root->oid, root->oid_len, src->oid, src->oid_len,
142 /* n = */ root->oid_len) != 0)
145 memset(dst, 0, sizeof(*dst));
146 dst->oid_len = src->oid_len - root->oid_len;
147 memcpy(dst->oid, &src->oid[root->oid_len],
148 dst->oid_len * sizeof(dst->oid[0]));
152 static int csnmp_oid_to_string(char *buffer, size_t buffer_size,
154 char oid_str[MAX_OID_LEN][16];
155 char *oid_str_ptr[MAX_OID_LEN];
157 for (size_t i = 0; i < o->oid_len; i++) {
158 snprintf(oid_str[i], sizeof(oid_str[i]), "%lu", (unsigned long)o->oid[i]);
159 oid_str_ptr[i] = oid_str[i];
162 return strjoin(buffer, buffer_size, oid_str_ptr, o->oid_len, ".");
165 static void csnmp_host_close_session(host_definition_t *host) /* {{{ */
167 if (host->sess_handle == NULL)
170 snmp_sess_close(host->sess_handle);
171 host->sess_handle = NULL;
172 } /* }}} void csnmp_host_close_session */
174 static void csnmp_host_definition_destroy(void *arg) /* {{{ */
176 host_definition_t *hd;
183 if (hd->name != NULL) {
184 DEBUG("snmp plugin: Destroying host definition for host `%s'.", hd->name);
187 csnmp_host_close_session(hd);
191 sfree(hd->community);
193 sfree(hd->auth_passphrase);
194 sfree(hd->priv_passphrase);
196 sfree(hd->data_list);
199 } /* }}} void csnmp_host_definition_destroy */
201 /* Many functions to handle the configuration. {{{ */
202 /* First there are many functions which do configuration stuff. It's a big
203 * bloated and messy, I'm afraid. */
206 * Callgraph for the config stuff:
208 * +-> call_snmp_init_once
209 * +-> csnmp_config_add_data
210 * ! +-> csnmp_config_add_data_instance
211 * ! +-> csnmp_config_add_data_instance_prefix
212 * ! +-> csnmp_config_add_data_values
213 * +-> csnmp_config_add_host
214 * +-> csnmp_config_add_host_version
215 * +-> csnmp_config_add_host_collect
216 * +-> csnmp_config_add_host_auth_protocol
217 * +-> csnmp_config_add_host_priv_protocol
218 * +-> csnmp_config_add_host_security_level
220 static void call_snmp_init_once(void) {
221 static int have_init = 0;
224 init_snmp(PACKAGE_NAME);
226 } /* void call_snmp_init_once */
228 static int csnmp_config_add_data_instance(data_definition_t *dd,
229 oconfig_item_t *ci) {
230 char buffer[DATA_MAX_NAME_LEN];
233 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
238 /* Instance is an OID */
239 dd->instance.oid.oid_len = MAX_OID_LEN;
241 if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) {
242 ERROR("snmp plugin: read_objid (%s) failed.", buffer);
246 /* Instance is a simple string */
247 sstrncpy(dd->instance.string, buffer, sizeof(dd->instance.string));
251 } /* int csnmp_config_add_data_instance */
253 static int csnmp_config_add_data_instance_prefix(data_definition_t *dd,
254 oconfig_item_t *ci) {
258 WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
259 "is set to `false'.",
264 status = cf_util_get_string(ci, &dd->instance_prefix);
266 } /* int csnmp_config_add_data_instance_prefix */
268 static int csnmp_config_add_data_values(data_definition_t *dd,
269 oconfig_item_t *ci) {
270 if (ci->values_num < 1) {
271 WARNING("snmp plugin: `Values' needs at least one argument.");
275 for (int i = 0; i < ci->values_num; i++)
276 if (ci->values[i].type != OCONFIG_TYPE_STRING) {
277 WARNING("snmp plugin: `Values' needs only string argument.");
283 dd->values = malloc(sizeof(*dd->values) * ci->values_num);
284 if (dd->values == NULL)
286 dd->values_len = (size_t)ci->values_num;
288 for (int i = 0; i < ci->values_num; i++) {
289 dd->values[i].oid_len = MAX_OID_LEN;
291 if (NULL == snmp_parse_oid(ci->values[i].value.string, dd->values[i].oid,
292 &dd->values[i].oid_len)) {
293 ERROR("snmp plugin: snmp_parse_oid (%s) failed.",
294 ci->values[i].value.string);
303 } /* int csnmp_config_add_data_instance */
305 static int csnmp_config_add_data_blacklist(data_definition_t *dd,
306 oconfig_item_t *ci) {
307 if (ci->values_num < 1)
310 for (int i = 0; i < ci->values_num; i++) {
311 if (ci->values[i].type != OCONFIG_TYPE_STRING) {
312 WARNING("snmp plugin: `Ignore' needs only string argument.");
320 for (int i = 0; i < ci->values_num; ++i) {
321 if (strarray_add(&(dd->ignores), &(dd->ignores_len),
322 ci->values[i].value.string) != 0) {
323 ERROR("snmp plugin: Can't allocate memory");
324 strarray_free(dd->ignores, dd->ignores_len);
329 } /* int csnmp_config_add_data_blacklist */
331 static int csnmp_config_add_data_blacklist_match_inverted(data_definition_t *dd,
332 oconfig_item_t *ci) {
333 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN)) {
334 WARNING("snmp plugin: `InvertMatch' needs exactly one boolean argument.");
338 dd->invert_match = ci->values[0].value.boolean ? 1 : 0;
341 } /* int csnmp_config_add_data_blacklist_match_inverted */
343 static int csnmp_config_add_data(oconfig_item_t *ci) {
344 data_definition_t *dd;
347 dd = calloc(1, sizeof(*dd));
351 status = cf_util_get_string(ci, &dd->name);
360 for (int i = 0; i < ci->children_num; i++) {
361 oconfig_item_t *option = ci->children + i;
363 if (strcasecmp("Type", option->key) == 0)
364 status = cf_util_get_string(option, &dd->type);
365 else if (strcasecmp("Table", option->key) == 0)
366 status = cf_util_get_boolean(option, &dd->is_table);
367 else if (strcasecmp("Instance", option->key) == 0)
368 status = csnmp_config_add_data_instance(dd, option);
369 else if (strcasecmp("InstancePrefix", option->key) == 0)
370 status = csnmp_config_add_data_instance_prefix(dd, option);
371 else if (strcasecmp("Values", option->key) == 0)
372 status = csnmp_config_add_data_values(dd, option);
373 else if (strcasecmp("Shift", option->key) == 0)
374 status = cf_util_get_double(option, &dd->shift);
375 else if (strcasecmp("Scale", option->key) == 0)
376 status = cf_util_get_double(option, &dd->scale);
377 else if (strcasecmp("Ignore", option->key) == 0)
378 status = csnmp_config_add_data_blacklist(dd, option);
379 else if (strcasecmp("InvertMatch", option->key) == 0)
380 status = csnmp_config_add_data_blacklist_match_inverted(dd, option);
382 WARNING("snmp plugin: Option `%s' not allowed here.", option->key);
388 } /* for (ci->children) */
390 while (status == 0) {
391 if (dd->type == NULL) {
392 WARNING("snmp plugin: `Type' not given for data `%s'", dd->name);
396 if (dd->values == NULL) {
397 WARNING("snmp plugin: No `Value' given for data `%s'", dd->name);
403 } /* while (status == 0) */
407 sfree(dd->instance_prefix);
414 DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = "
416 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false",
419 if (data_head == NULL)
422 data_definition_t *last;
424 while (last->next != NULL)
430 } /* int csnmp_config_add_data */
432 static int csnmp_config_add_host_version(host_definition_t *hd,
433 oconfig_item_t *ci) {
436 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
437 WARNING("snmp plugin: The `Version' config option needs exactly one number "
442 version = (int)ci->values[0].value.number;
443 if ((version < 1) || (version > 3)) {
444 WARNING("snmp plugin: `Version' must either be `1', `2', or `3'.");
448 hd->version = version;
451 } /* int csnmp_config_add_host_address */
453 static int csnmp_config_add_host_collect(host_definition_t *host,
454 oconfig_item_t *ci) {
455 data_definition_t *data;
456 data_definition_t **data_list;
459 if (ci->values_num < 1) {
460 WARNING("snmp plugin: `Collect' needs at least one argument.");
464 for (int i = 0; i < ci->values_num; i++)
465 if (ci->values[i].type != OCONFIG_TYPE_STRING) {
466 WARNING("snmp plugin: All arguments to `Collect' must be strings.");
470 data_list_len = host->data_list_len + ci->values_num;
472 realloc(host->data_list, sizeof(data_definition_t *) * data_list_len);
473 if (data_list == NULL)
475 host->data_list = data_list;
477 for (int i = 0; i < ci->values_num; i++) {
478 for (data = data_head; data != NULL; data = data->next)
479 if (strcasecmp(ci->values[i].value.string, data->name) == 0)
483 WARNING("snmp plugin: No such data configured: `%s'",
484 ci->values[i].value.string);
488 DEBUG("snmp plugin: Collect: host = %s, data[%i] = %s;", host->name,
489 host->data_list_len, data->name);
491 host->data_list[host->data_list_len] = data;
492 host->data_list_len++;
493 } /* for (values_num) */
496 } /* int csnmp_config_add_host_collect */
498 static int csnmp_config_add_host_auth_protocol(host_definition_t *hd,
499 oconfig_item_t *ci) {
503 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
507 if (strcasecmp("MD5", buffer) == 0) {
508 hd->auth_protocol = usmHMACMD5AuthProtocol;
509 hd->auth_protocol_len = sizeof(usmHMACMD5AuthProtocol) / sizeof(oid);
510 } else if (strcasecmp("SHA", buffer) == 0) {
511 hd->auth_protocol = usmHMACSHA1AuthProtocol;
512 hd->auth_protocol_len = sizeof(usmHMACSHA1AuthProtocol) / sizeof(oid);
514 WARNING("snmp plugin: The `AuthProtocol' config option must be `MD5' or "
519 DEBUG("snmp plugin: host = %s; host->auth_protocol = %s;", hd->name,
520 hd->auth_protocol == usmHMACMD5AuthProtocol ? "MD5" : "SHA");
523 } /* int csnmp_config_add_host_auth_protocol */
525 static int csnmp_config_add_host_priv_protocol(host_definition_t *hd,
526 oconfig_item_t *ci) {
530 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
534 if (strcasecmp("AES", buffer) == 0) {
535 hd->priv_protocol = usmAESPrivProtocol;
536 hd->priv_protocol_len = sizeof(usmAESPrivProtocol) / sizeof(oid);
537 } else if (strcasecmp("DES", buffer) == 0) {
538 hd->priv_protocol = usmDESPrivProtocol;
539 hd->priv_protocol_len = sizeof(usmDESPrivProtocol) / sizeof(oid);
541 WARNING("snmp plugin: The `PrivProtocol' config option must be `AES' or "
546 DEBUG("snmp plugin: host = %s; host->priv_protocol = %s;", hd->name,
547 hd->priv_protocol == usmAESPrivProtocol ? "AES" : "DES");
550 } /* int csnmp_config_add_host_priv_protocol */
552 static int csnmp_config_add_host_security_level(host_definition_t *hd,
553 oconfig_item_t *ci) {
557 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
561 if (strcasecmp("noAuthNoPriv", buffer) == 0)
562 hd->security_level = SNMP_SEC_LEVEL_NOAUTH;
563 else if (strcasecmp("authNoPriv", buffer) == 0)
564 hd->security_level = SNMP_SEC_LEVEL_AUTHNOPRIV;
565 else if (strcasecmp("authPriv", buffer) == 0)
566 hd->security_level = SNMP_SEC_LEVEL_AUTHPRIV;
568 WARNING("snmp plugin: The `SecurityLevel' config option must be "
569 "`noAuthNoPriv', `authNoPriv', or `authPriv'.");
573 DEBUG("snmp plugin: host = %s; host->security_level = %d;", hd->name,
577 } /* int csnmp_config_add_host_security_level */
579 static int csnmp_config_add_host(oconfig_item_t *ci) {
580 host_definition_t *hd;
583 /* Registration stuff. */
584 char cb_name[DATA_MAX_NAME_LEN];
586 hd = calloc(1, sizeof(*hd));
590 C_COMPLAIN_INIT(&hd->complaint);
592 status = cf_util_get_string(ci, &hd->name);
598 hd->sess_handle = NULL;
601 for (int i = 0; i < ci->children_num; i++) {
602 oconfig_item_t *option = ci->children + i;
605 if (strcasecmp("Address", option->key) == 0)
606 status = cf_util_get_string(option, &hd->address);
607 else if (strcasecmp("Community", option->key) == 0)
608 status = cf_util_get_string(option, &hd->community);
609 else if (strcasecmp("Version", option->key) == 0)
610 status = csnmp_config_add_host_version(hd, option);
611 else if (strcasecmp("Collect", option->key) == 0)
612 csnmp_config_add_host_collect(hd, option);
613 else if (strcasecmp("Interval", option->key) == 0)
614 cf_util_get_cdtime(option, &hd->interval);
615 else if (strcasecmp("Username", option->key) == 0)
616 status = cf_util_get_string(option, &hd->username);
617 else if (strcasecmp("AuthProtocol", option->key) == 0)
618 status = csnmp_config_add_host_auth_protocol(hd, option);
619 else if (strcasecmp("PrivacyProtocol", option->key) == 0)
620 status = csnmp_config_add_host_priv_protocol(hd, option);
621 else if (strcasecmp("AuthPassphrase", option->key) == 0)
622 status = cf_util_get_string(option, &hd->auth_passphrase);
623 else if (strcasecmp("PrivacyPassphrase", option->key) == 0)
624 status = cf_util_get_string(option, &hd->priv_passphrase);
625 else if (strcasecmp("SecurityLevel", option->key) == 0)
626 status = csnmp_config_add_host_security_level(hd, option);
627 else if (strcasecmp("Context", option->key) == 0)
628 status = cf_util_get_string(option, &hd->context);
631 "snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.",
638 } /* for (ci->children) */
640 while (status == 0) {
641 if (hd->address == NULL) {
642 WARNING("snmp plugin: `Address' not given for host `%s'", hd->name);
646 if (hd->community == NULL && hd->version < 3) {
647 WARNING("snmp plugin: `Community' not given for host `%s'", hd->name);
651 if (hd->version == 3) {
652 if (hd->username == NULL) {
653 WARNING("snmp plugin: `Username' not given for host `%s'", hd->name);
657 if (hd->security_level == 0) {
658 WARNING("snmp plugin: `SecurityLevel' not given for host `%s'",
663 if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV ||
664 hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
665 if (hd->auth_protocol == NULL) {
666 WARNING("snmp plugin: `AuthProtocol' not given for host `%s'",
671 if (hd->auth_passphrase == NULL) {
672 WARNING("snmp plugin: `AuthPassphrase' not given for host `%s'",
678 if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
679 if (hd->priv_protocol == NULL) {
680 WARNING("snmp plugin: `PrivacyProtocol' not given for host `%s'",
685 if (hd->priv_passphrase == NULL) {
686 WARNING("snmp plugin: `PrivacyPassphrase' not given for host `%s'",
695 } /* while (status == 0) */
698 csnmp_host_definition_destroy(hd);
702 DEBUG("snmp plugin: hd = { name = %s, address = %s, community = %s, version "
704 hd->name, hd->address, hd->community, hd->version);
706 snprintf(cb_name, sizeof(cb_name), "snmp-%s", hd->name);
708 status = plugin_register_complex_read(
709 /* group = */ NULL, cb_name, csnmp_read_host, hd->interval,
711 .data = hd, .free_func = csnmp_host_definition_destroy,
714 ERROR("snmp plugin: Registering complex read function failed.");
715 csnmp_host_definition_destroy(hd);
720 } /* int csnmp_config_add_host */
722 static int csnmp_config(oconfig_item_t *ci) {
723 call_snmp_init_once();
725 for (int i = 0; i < ci->children_num; i++) {
726 oconfig_item_t *child = ci->children + i;
727 if (strcasecmp("Data", child->key) == 0)
728 csnmp_config_add_data(child);
729 else if (strcasecmp("Host", child->key) == 0)
730 csnmp_config_add_host(child);
732 WARNING("snmp plugin: Ignoring unknown config option `%s'.", child->key);
734 } /* for (ci->children) */
737 } /* int csnmp_config */
739 /* }}} End of the config stuff. Now the interesting part begins */
741 static void csnmp_host_open_session(host_definition_t *host) {
742 struct snmp_session sess;
745 if (host->sess_handle != NULL)
746 csnmp_host_close_session(host);
748 snmp_sess_init(&sess);
749 sess.peername = host->address;
750 switch (host->version) {
752 sess.version = SNMP_VERSION_1;
755 sess.version = SNMP_VERSION_3;
758 sess.version = SNMP_VERSION_2c;
762 if (host->version == 3) {
763 sess.securityName = host->username;
764 sess.securityNameLen = strlen(host->username);
765 sess.securityLevel = host->security_level;
767 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV ||
768 sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
769 sess.securityAuthProto = host->auth_protocol;
770 sess.securityAuthProtoLen = host->auth_protocol_len;
771 sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
772 error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
773 (u_char *)host->auth_passphrase,
774 strlen(host->auth_passphrase), sess.securityAuthKey,
775 &sess.securityAuthKeyLen);
776 if (error != SNMPERR_SUCCESS) {
777 ERROR("snmp plugin: host %s: Error generating Ku from auth_passphrase. "
783 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
784 sess.securityPrivProto = host->priv_protocol;
785 sess.securityPrivProtoLen = host->priv_protocol_len;
786 sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
787 error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
788 (u_char *)host->priv_passphrase,
789 strlen(host->priv_passphrase), sess.securityPrivKey,
790 &sess.securityPrivKeyLen);
791 if (error != SNMPERR_SUCCESS) {
792 ERROR("snmp plugin: host %s: Error generating Ku from priv_passphrase. "
798 if (host->context != NULL) {
799 sess.contextName = host->context;
800 sess.contextNameLen = strlen(host->context);
802 } else /* SNMPv1/2 "authenticates" with community string */
804 sess.community = (u_char *)host->community;
805 sess.community_len = strlen(host->community);
808 /* snmp_sess_open will copy the `struct snmp_session *'. */
809 host->sess_handle = snmp_sess_open(&sess);
811 if (host->sess_handle == NULL) {
814 snmp_error(&sess, NULL, NULL, &errstr);
816 ERROR("snmp plugin: host %s: snmp_sess_open failed: %s", host->name,
817 (errstr == NULL) ? "Unknown problem" : errstr);
820 } /* void csnmp_host_open_session */
822 /* TODO: Check if negative values wrap around. Problem: negative temperatures.
824 static value_t csnmp_value_list_to_value(struct variable_list *vl, int type,
825 double scale, double shift,
826 const char *host_name,
827 const char *data_name) {
829 uint64_t tmp_unsigned = 0;
830 int64_t tmp_signed = 0;
832 /* Set to true when the original SNMP type appears to have been signed. */
833 _Bool prefer_signed = 0;
835 if ((vl->type == ASN_INTEGER) || (vl->type == ASN_UINTEGER) ||
836 (vl->type == ASN_COUNTER)
838 || (vl->type == ASN_TIMETICKS)
840 || (vl->type == ASN_GAUGE)) {
841 tmp_unsigned = (uint32_t)*vl->val.integer;
842 tmp_signed = (int32_t)*vl->val.integer;
844 if (vl->type == ASN_INTEGER)
847 DEBUG("snmp plugin: Parsed int32 value is %" PRIu64 ".", tmp_unsigned);
848 } else if (vl->type == ASN_COUNTER64) {
849 tmp_unsigned = (uint32_t)vl->val.counter64->high;
850 tmp_unsigned = tmp_unsigned << 32;
851 tmp_unsigned += (uint32_t)vl->val.counter64->low;
852 tmp_signed = (int64_t)tmp_unsigned;
853 DEBUG("snmp plugin: Parsed int64 value is %" PRIu64 ".", tmp_unsigned);
854 } else if (vl->type == ASN_OCTET_STR) {
855 /* We'll handle this later.. */
857 char oid_buffer[1024] = {0};
859 snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vl->name,
863 if (vl->type == ASN_NULL)
864 INFO("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)", oid_buffer);
867 WARNING("snmp plugin: I don't know the ASN type #%i "
868 "(OID: \"%s\", data block \"%s\", host block \"%s\")",
869 (int)vl->type, oid_buffer,
870 (data_name != NULL) ? data_name : "UNKNOWN",
871 (host_name != NULL) ? host_name : "UNKNOWN");
876 if (vl->type == ASN_OCTET_STR) {
879 if (vl->val.string != NULL) {
881 size_t string_length;
883 string_length = sizeof(string) - 1;
884 if (vl->val_len < string_length)
885 string_length = vl->val_len;
887 /* The strings we get from the Net-SNMP library may not be null
888 * terminated. That is why we're using `memcpy' here and not `strcpy'.
889 * `string_length' is set to `vl->val_len' which holds the length of the
891 memcpy(string, vl->val.string, string_length);
892 string[string_length] = 0;
894 status = parse_value(string, &ret, type);
896 ERROR("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string "
898 (host_name != NULL) ? host_name : "UNKNOWN",
899 DS_TYPE_TO_STRING(type), string);
905 case DS_TYPE_COUNTER:
907 case DS_TYPE_ABSOLUTE:
908 memset(&ret, 0, sizeof(ret));
916 ERROR("snmp plugin: csnmp_value_list_to_value: Unknown "
917 "data source type: %i.",
922 } /* if (vl->type == ASN_OCTET_STR) */
923 else if (type == DS_TYPE_COUNTER) {
924 ret.counter = tmp_unsigned;
925 } else if (type == DS_TYPE_GAUGE) {
928 else if (prefer_signed)
929 ret.gauge = (scale * tmp_signed) + shift;
931 ret.gauge = (scale * tmp_unsigned) + shift;
932 } else if (type == DS_TYPE_DERIVE) {
934 ret.derive = (derive_t)tmp_signed;
936 ret.derive = (derive_t)tmp_unsigned;
937 } else if (type == DS_TYPE_ABSOLUTE) {
938 ret.absolute = (absolute_t)tmp_unsigned;
940 ERROR("snmp plugin: csnmp_value_list_to_value: Unknown data source "
947 } /* value_t csnmp_value_list_to_value */
949 /* csnmp_strvbcopy_hexstring converts the bit string contained in "vb" to a hex
950 * representation and writes it to dst. Returns zero on success and ENOMEM if
951 * dst is not large enough to hold the string. dst is guaranteed to be
953 static int csnmp_strvbcopy_hexstring(char *dst, /* {{{ */
954 const struct variable_list *vb,
962 buffer_free = dst_size;
964 for (size_t i = 0; i < vb->val_len; i++) {
967 status = snprintf(buffer_ptr, buffer_free, (i == 0) ? "%02x" : ":%02x",
968 (unsigned int)vb->val.bitstring[i]);
971 if (((size_t)status) >= buffer_free) /* truncated */
973 dst[dst_size - 1] = 0;
975 } else /* if (status < buffer_free) */
977 buffer_ptr += (size_t)status;
978 buffer_free -= (size_t)status;
983 } /* }}} int csnmp_strvbcopy_hexstring */
985 /* csnmp_strvbcopy copies the octet string or bit string contained in vb to
986 * dst. If non-printable characters are detected, it will switch to a hex
987 * representation of the string. Returns zero on success, EINVAL if vb does not
988 * contain a string and ENOMEM if dst is not large enough to contain the
990 static int csnmp_strvbcopy(char *dst, /* {{{ */
991 const struct variable_list *vb, size_t dst_size) {
995 if (vb->type == ASN_OCTET_STR)
996 src = (char *)vb->val.string;
997 else if (vb->type == ASN_BIT_STR)
998 src = (char *)vb->val.bitstring;
999 else if (vb->type == ASN_IPADDRESS) {
1000 return snprintf(dst, dst_size,
1001 "%" PRIu8 ".%" PRIu8 ".%" PRIu8 ".%" PRIu8 "",
1002 (uint8_t)vb->val.string[0], (uint8_t)vb->val.string[1],
1003 (uint8_t)vb->val.string[2], (uint8_t)vb->val.string[3]);
1009 num_chars = dst_size - 1;
1010 if (num_chars > vb->val_len)
1011 num_chars = vb->val_len;
1013 for (size_t i = 0; i < num_chars; i++) {
1014 /* Check for control characters. */
1015 if ((unsigned char)src[i] < 32)
1016 return csnmp_strvbcopy_hexstring(dst, vb, dst_size);
1020 dst[dst_size - 1] = 0;
1022 if (dst_size <= vb->val_len)
1026 } /* }}} int csnmp_strvbcopy */
1028 static int csnmp_instance_list_add(csnmp_list_instances_t **head,
1029 csnmp_list_instances_t **tail,
1030 const struct snmp_pdu *res,
1031 const host_definition_t *hd,
1032 const data_definition_t *dd) {
1033 csnmp_list_instances_t *il;
1034 struct variable_list *vb;
1037 uint32_t is_matched;
1039 /* Set vb on the last variable */
1040 for (vb = res->variables; (vb != NULL) && (vb->next_variable != NULL);
1041 vb = vb->next_variable)
1046 csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1048 il = calloc(1, sizeof(*il));
1050 ERROR("snmp plugin: calloc failed.");
1055 status = csnmp_oid_suffix(&il->suffix, &vb_name, &dd->instance.oid);
1061 /* Get instance name */
1062 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR) ||
1063 (vb->type == ASN_IPADDRESS)) {
1066 csnmp_strvbcopy(il->instance, vb, sizeof(il->instance));
1068 for (uint32_t i = 0; i < dd->ignores_len; i++) {
1069 status = fnmatch(dd->ignores[i], il->instance, 0);
1071 if (dd->invert_match == 0) {
1080 if (dd->invert_match != 0 && is_matched == 0) {
1084 for (ptr = il->instance; *ptr != '\0'; ptr++) {
1085 if ((*ptr > 0) && (*ptr < 32))
1087 else if (*ptr == '/')
1090 DEBUG("snmp plugin: il->instance = `%s';", il->instance);
1092 value_t val = csnmp_value_list_to_value(
1093 vb, DS_TYPE_COUNTER,
1094 /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1095 snprintf(il->instance, sizeof(il->instance), "%llu", val.counter);
1098 /* TODO: Debugging output */
1107 } /* int csnmp_instance_list_add */
1109 static int csnmp_dispatch_table(host_definition_t *host,
1110 data_definition_t *data,
1111 csnmp_list_instances_t *instance_list,
1112 csnmp_table_values_t **value_table) {
1113 const data_set_t *ds;
1114 value_list_t vl = VALUE_LIST_INIT;
1116 csnmp_list_instances_t *instance_list_ptr;
1117 csnmp_table_values_t *value_table_ptr[data->values_len];
1121 oid_t current_suffix;
1123 ds = plugin_get_ds(data->type);
1125 ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1128 assert(ds->ds_num == data->values_len);
1129 assert(data->values_len > 0);
1131 instance_list_ptr = instance_list;
1133 for (i = 0; i < data->values_len; i++)
1134 value_table_ptr[i] = value_table[i];
1136 sstrncpy(vl.host, host->name, sizeof(vl.host));
1137 sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
1139 vl.interval = host->interval;
1143 _Bool suffix_skipped = 0;
1145 /* Determine next suffix to handle. */
1146 if (instance_list != NULL) {
1147 if (instance_list_ptr == NULL) {
1152 memcpy(¤t_suffix, &instance_list_ptr->suffix,
1153 sizeof(current_suffix));
1155 /* no instance configured */
1156 csnmp_table_values_t *ptr = value_table_ptr[0];
1162 memcpy(¤t_suffix, &ptr->suffix, sizeof(current_suffix));
1165 /* Update all the value_table_ptr to point at the entry with the same
1166 * trailing partial OID */
1167 for (i = 0; i < data->values_len; i++) {
1169 (value_table_ptr[i] != NULL) &&
1170 (csnmp_oid_compare(&value_table_ptr[i]->suffix, ¤t_suffix) < 0))
1171 value_table_ptr[i] = value_table_ptr[i]->next;
1173 if (value_table_ptr[i] == NULL) {
1176 } else if (csnmp_oid_compare(&value_table_ptr[i]->suffix,
1177 ¤t_suffix) > 0) {
1178 /* This suffix is missing in the subtree. Indicate this with the
1179 * "suffix_skipped" flag and try the next instance / suffix. */
1183 } /* for (i = 0; i < columns; i++) */
1188 /* Matching the values failed. Start from the beginning again. */
1189 if (suffix_skipped) {
1190 if (instance_list != NULL)
1191 instance_list_ptr = instance_list_ptr->next;
1193 value_table_ptr[0] = value_table_ptr[0]->next;
1198 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1199 * to the same subid. instance_list_ptr is either NULL or points to the
1200 * same subid, too. */
1202 for (i = 1; i < data->values_len; i++) {
1203 assert(value_table_ptr[i] != NULL);
1204 assert(csnmp_oid_compare(&value_table_ptr[i - 1]->suffix,
1205 &value_table_ptr[i]->suffix) == 0);
1207 assert((instance_list_ptr == NULL) ||
1208 (csnmp_oid_compare(&instance_list_ptr->suffix,
1209 &value_table_ptr[0]->suffix) == 0));
1212 sstrncpy(vl.type, data->type, sizeof(vl.type));
1215 char temp[DATA_MAX_NAME_LEN];
1217 if (instance_list_ptr == NULL)
1218 csnmp_oid_to_string(temp, sizeof(temp), ¤t_suffix);
1220 sstrncpy(temp, instance_list_ptr->instance, sizeof(temp));
1222 if (data->instance_prefix == NULL)
1223 sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance));
1225 snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s",
1226 data->instance_prefix, temp);
1229 vl.values_len = data->values_len;
1230 value_t values[vl.values_len];
1233 for (i = 0; i < data->values_len; i++)
1234 vl.values[i] = value_table_ptr[i]->value;
1236 /* If we get here `vl.type_instance' and all `vl.values' have been set
1237 * vl.type_instance can be empty, i.e. a blank port description on a
1238 * switch if you're using IF-MIB::ifDescr as Instance.
1240 if (vl.type_instance[0] != '\0')
1241 plugin_dispatch_values(&vl);
1243 /* prevent leakage of pointer to local variable. */
1247 if (instance_list != NULL)
1248 instance_list_ptr = instance_list_ptr->next;
1250 value_table_ptr[0] = value_table_ptr[0]->next;
1251 } /* while (have_more) */
1254 } /* int csnmp_dispatch_table */
1256 static int csnmp_read_table(host_definition_t *host, data_definition_t *data) {
1257 struct snmp_pdu *req;
1258 struct snmp_pdu *res = NULL;
1259 struct variable_list *vb;
1261 const data_set_t *ds;
1263 size_t oid_list_len = data->values_len + 1;
1264 /* Holds the last OID returned by the device. We use this in the GETNEXT
1265 * request to proceed. */
1266 oid_t oid_list[oid_list_len];
1267 /* Set to false when an OID has left its subtree so we don't re-request it
1269 _Bool oid_list_todo[oid_list_len];
1274 /* `value_list_head' and `value_list_tail' implement a linked list for each
1275 * value. `instance_list_head' and `instance_list_tail' implement a linked
1277 * instance names. This is used to jump gaps in the table. */
1278 csnmp_list_instances_t *instance_list_head;
1279 csnmp_list_instances_t *instance_list_tail;
1280 csnmp_table_values_t **value_list_head;
1281 csnmp_table_values_t **value_list_tail;
1283 DEBUG("snmp plugin: csnmp_read_table (host = %s, data = %s)", host->name,
1286 if (host->sess_handle == NULL) {
1287 DEBUG("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1291 ds = plugin_get_ds(data->type);
1293 ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1297 if (ds->ds_num != data->values_len) {
1298 ERROR("snmp plugin: DataSet `%s' requires %zu values, but config talks "
1300 data->type, ds->ds_num, data->values_len);
1303 assert(data->values_len > 0);
1305 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1306 memcpy(oid_list, data->values, data->values_len * sizeof(oid_t));
1307 if (data->instance.oid.oid_len > 0)
1308 memcpy(oid_list + data->values_len, &data->instance.oid, sizeof(oid_t));
1309 else /* no InstanceFrom option specified. */
1312 for (i = 0; i < oid_list_len; i++)
1313 oid_list_todo[i] = 1;
1315 /* We're going to construct n linked lists, one for each "value".
1316 * value_list_head will contain pointers to the heads of these linked lists,
1317 * value_list_tail will contain pointers to the tail of the lists. */
1318 value_list_head = calloc(data->values_len, sizeof(*value_list_head));
1319 value_list_tail = calloc(data->values_len, sizeof(*value_list_tail));
1320 if ((value_list_head == NULL) || (value_list_tail == NULL)) {
1321 ERROR("snmp plugin: csnmp_read_table: calloc failed.");
1322 sfree(value_list_head);
1323 sfree(value_list_tail);
1327 instance_list_head = NULL;
1328 instance_list_tail = NULL;
1331 while (status == 0) {
1332 int oid_list_todo_num;
1334 req = snmp_pdu_create(SNMP_MSG_GETNEXT);
1336 ERROR("snmp plugin: snmp_pdu_create failed.");
1341 oid_list_todo_num = 0;
1342 for (i = 0; i < oid_list_len; i++) {
1343 /* Do not rerequest already finished OIDs */
1344 if (!oid_list_todo[i])
1346 oid_list_todo_num++;
1347 snmp_add_null_var(req, oid_list[i].oid, oid_list[i].oid_len);
1350 if (oid_list_todo_num == 0) {
1351 /* The request is still empty - so we are finished */
1352 DEBUG("snmp plugin: all variables have left their subtree");
1358 status = snmp_sess_synch_response(host->sess_handle, req, &res);
1359 if ((status != STAT_SUCCESS) || (res == NULL)) {
1360 char *errstr = NULL;
1362 snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1364 c_complain(LOG_ERR, &host->complaint,
1365 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1366 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1372 /* snmp_synch_response already freed our PDU */
1375 csnmp_host_close_session(host);
1382 assert(res != NULL);
1383 c_release(LOG_INFO, &host->complaint,
1384 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1387 vb = res->variables;
1393 for (vb = res->variables, i = 0; (vb != NULL);
1394 vb = vb->next_variable, i++) {
1395 /* Calculate value index from todo list */
1396 while ((i < oid_list_len) && !oid_list_todo[i])
1399 /* An instance is configured and the res variable we process is the
1400 * instance value (last index) */
1401 if ((data->instance.oid.oid_len > 0) && (i == data->values_len)) {
1402 if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1404 data->instance.oid.oid, data->instance.oid.oid_len, vb->name,
1405 vb->name_length, data->instance.oid.oid_len) != 0)) {
1406 DEBUG("snmp plugin: host = %s; data = %s; Instance left its subtree.",
1407 host->name, data->name);
1408 oid_list_todo[i] = 0;
1412 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1413 * add it to the list */
1414 if (csnmp_instance_list_add(&instance_list_head, &instance_list_tail,
1415 res, host, data) != 0) {
1416 ERROR("snmp plugin: host %s: csnmp_instance_list_add failed.",
1421 } else /* The variable we are processing is a normal value */
1423 csnmp_table_values_t *vt;
1428 csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1430 /* Calculate the current suffix. This is later used to check that the
1431 * suffix is increasing. This also checks if we left the subtree */
1432 ret = csnmp_oid_suffix(&suffix, &vb_name, data->values + i);
1434 DEBUG("snmp plugin: host = %s; data = %s; i = %zu; "
1435 "Value probably left its subtree.",
1436 host->name, data->name, i);
1437 oid_list_todo[i] = 0;
1441 /* Make sure the OIDs returned by the agent are increasing. Otherwise
1443 * table matching algorithm will get confused. */
1444 if ((value_list_tail[i] != NULL) &&
1445 (csnmp_oid_compare(&suffix, &value_list_tail[i]->suffix) <= 0)) {
1446 DEBUG("snmp plugin: host = %s; data = %s; i = %zu; "
1447 "Suffix is not increasing.",
1448 host->name, data->name, i);
1449 oid_list_todo[i] = 0;
1453 vt = calloc(1, sizeof(*vt));
1455 ERROR("snmp plugin: calloc failed.");
1461 csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1462 data->shift, host->name, data->name);
1463 memcpy(&vt->suffix, &suffix, sizeof(vt->suffix));
1466 if (value_list_tail[i] == NULL)
1467 value_list_head[i] = vt;
1469 value_list_tail[i]->next = vt;
1470 value_list_tail[i] = vt;
1473 /* Copy OID to oid_list[i] */
1474 memcpy(oid_list[i].oid, vb->name, sizeof(oid) * vb->name_length);
1475 oid_list[i].oid_len = vb->name_length;
1477 } /* for (vb = res->variables ...) */
1482 } /* while (status == 0) */
1493 csnmp_dispatch_table(host, data, instance_list_head, value_list_head);
1495 /* Free all allocated variables here */
1496 while (instance_list_head != NULL) {
1497 csnmp_list_instances_t *next = instance_list_head->next;
1498 sfree(instance_list_head);
1499 instance_list_head = next;
1502 for (i = 0; i < data->values_len; i++) {
1503 while (value_list_head[i] != NULL) {
1504 csnmp_table_values_t *next = value_list_head[i]->next;
1505 sfree(value_list_head[i]);
1506 value_list_head[i] = next;
1510 sfree(value_list_head);
1511 sfree(value_list_tail);
1514 } /* int csnmp_read_table */
1516 static int csnmp_read_value(host_definition_t *host, data_definition_t *data) {
1517 struct snmp_pdu *req;
1518 struct snmp_pdu *res = NULL;
1519 struct variable_list *vb;
1521 const data_set_t *ds;
1522 value_list_t vl = VALUE_LIST_INIT;
1527 DEBUG("snmp plugin: csnmp_read_value (host = %s, data = %s)", host->name,
1530 if (host->sess_handle == NULL) {
1531 DEBUG("snmp plugin: csnmp_read_value: host->sess_handle == NULL");
1535 ds = plugin_get_ds(data->type);
1537 ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1541 if (ds->ds_num != data->values_len) {
1542 ERROR("snmp plugin: DataSet `%s' requires %zu values, but config talks "
1544 data->type, ds->ds_num, data->values_len);
1548 vl.values_len = ds->ds_num;
1549 vl.values = malloc(sizeof(*vl.values) * vl.values_len);
1550 if (vl.values == NULL)
1552 for (i = 0; i < vl.values_len; i++) {
1553 if (ds->ds[i].type == DS_TYPE_COUNTER)
1554 vl.values[i].counter = 0;
1556 vl.values[i].gauge = NAN;
1559 sstrncpy(vl.host, host->name, sizeof(vl.host));
1560 sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
1561 sstrncpy(vl.type, data->type, sizeof(vl.type));
1562 sstrncpy(vl.type_instance, data->instance.string, sizeof(vl.type_instance));
1564 vl.interval = host->interval;
1566 req = snmp_pdu_create(SNMP_MSG_GET);
1568 ERROR("snmp plugin: snmp_pdu_create failed.");
1573 for (i = 0; i < data->values_len; i++)
1574 snmp_add_null_var(req, data->values[i].oid, data->values[i].oid_len);
1576 status = snmp_sess_synch_response(host->sess_handle, req, &res);
1578 if ((status != STAT_SUCCESS) || (res == NULL)) {
1579 char *errstr = NULL;
1581 snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1582 ERROR("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1583 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1590 csnmp_host_close_session(host);
1595 for (vb = res->variables; vb != NULL; vb = vb->next_variable) {
1598 snprint_variable(buffer, sizeof(buffer), vb->name, vb->name_length, vb);
1599 DEBUG("snmp plugin: Got this variable: %s", buffer);
1600 #endif /* COLLECT_DEBUG */
1602 for (i = 0; i < data->values_len; i++)
1603 if (snmp_oid_compare(data->values[i].oid, data->values[i].oid_len,
1604 vb->name, vb->name_length) == 0)
1606 csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1607 data->shift, host->name, data->name);
1608 } /* for (res->variables) */
1612 DEBUG("snmp plugin: -> plugin_dispatch_values (&vl);");
1613 plugin_dispatch_values(&vl);
1617 } /* int csnmp_read_value */
1619 static int csnmp_read_host(user_data_t *ud) {
1620 host_definition_t *host;
1627 if (host->interval == 0)
1628 host->interval = plugin_get_interval();
1630 if (host->sess_handle == NULL)
1631 csnmp_host_open_session(host);
1633 if (host->sess_handle == NULL)
1637 for (i = 0; i < host->data_list_len; i++) {
1638 data_definition_t *data = host->data_list[i];
1641 status = csnmp_read_table(host, data);
1643 status = csnmp_read_value(host, data);
1653 } /* int csnmp_read_host */
1655 static int csnmp_init(void) {
1656 call_snmp_init_once();
1659 } /* int csnmp_init */
1661 static int csnmp_shutdown(void) {
1662 data_definition_t *data_this;
1663 data_definition_t *data_next;
1665 /* When we get here, the read threads have been stopped and all the
1666 * `host_definition_t' will be freed. */
1667 DEBUG("snmp plugin: Destroying all data definitions.");
1669 data_this = data_head;
1671 while (data_this != NULL) {
1672 data_next = data_this->next;
1674 sfree(data_this->name);
1675 sfree(data_this->type);
1676 sfree(data_this->values);
1677 sfree(data_this->ignores);
1680 data_this = data_next;
1684 } /* int csnmp_shutdown */
1686 void module_register(void) {
1687 plugin_register_complex_config("snmp", csnmp_config);
1688 plugin_register_init("snmp", csnmp_init);
1689 plugin_register_shutdown("snmp", csnmp_shutdown);
1690 } /* void module_register */