X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fsnmp.c;h=ccb6bfe9df0df82c0fdd2882dfe88a352501b732;hb=67e31002ea24f05d00eb59551d1a8e53557c9178;hp=38141e49c924fae2073f865eab80098734aba429;hpb=26c92dc860161955d5e6222aee954ff9fb3ab9b3;p=collectd.git diff --git a/src/snmp.c b/src/snmp.c index 38141e49..ccb6bfe9 100644 --- a/src/snmp.c +++ b/src/snmp.c @@ -44,17 +44,21 @@ struct oid_s { }; typedef struct oid_s oid_t; -union instance_u { - char string[DATA_MAX_NAME_LEN]; +struct instance_s { + bool configured; + bool is_plugin; oid_t oid; }; -typedef union instance_u instance_t; +typedef struct instance_s instance_t; struct data_definition_s { char *name; /* used to reference this from the `Collect' option */ char *type; /* used to find the data_set */ - _Bool is_table; + bool is_table; instance_t instance; + char *plugin_name; + char *plugin_instance; + char *type_instance; char *instance_prefix; oid_t *values; size_t values_len; @@ -63,7 +67,7 @@ struct data_definition_s { struct data_definition_s *next; char **ignores; size_t ignores_len; - int invert_match; + bool invert_match; }; typedef struct data_definition_s data_definition_t; @@ -112,10 +116,17 @@ struct csnmp_table_values_s { }; typedef struct csnmp_table_values_s csnmp_table_values_t; +typedef enum { + OID_TYPE_SKIP = 0, + OID_TYPE_VARIABLE, + OID_TYPE_INSTANCE, + OID_TYPE_HOST, +} csnmp_oid_type_t; + /* * Private variables */ -static data_definition_t *data_head = NULL; +static data_definition_t *data_head; /* * Prototypes @@ -209,7 +220,6 @@ static void csnmp_host_definition_destroy(void *arg) /* {{{ */ * +-> call_snmp_init_once * +-> csnmp_config_add_data * ! +-> csnmp_config_add_data_instance - * ! +-> csnmp_config_add_data_instance_prefix * ! +-> csnmp_config_add_data_values * +-> csnmp_config_add_host * +-> csnmp_config_add_host_version @@ -219,15 +229,16 @@ static void csnmp_host_definition_destroy(void *arg) /* {{{ */ * +-> csnmp_config_add_host_security_level */ static void call_snmp_init_once(void) { - static int have_init = 0; + static int have_init; if (have_init == 0) init_snmp(PACKAGE_NAME); have_init = 1; } /* void call_snmp_init_once */ -static int csnmp_config_add_data_instance(data_definition_t *dd, - oconfig_item_t *ci) { +static int csnmp_config_add_data_instance_oid(data_definition_t *dd, + oconfig_item_t *ci, + bool is_plugin) { char buffer[DATA_MAX_NAME_LEN]; int status; @@ -235,36 +246,28 @@ static int csnmp_config_add_data_instance(data_definition_t *dd, if (status != 0) return status; - if (dd->is_table) { - /* Instance is an OID */ - dd->instance.oid.oid_len = MAX_OID_LEN; - - if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) { - ERROR("snmp plugin: read_objid (%s) failed.", buffer); - return -1; - } - } else { - /* Instance is a simple string */ - sstrncpy(dd->instance.string, buffer, sizeof(dd->instance.string)); + if (dd->instance.configured) { + ERROR("snmp plugin: Only one of options `TypeInstanceOID', " + "`PluginInstanceOID' or `Instance' can be used in `Data' block."); + return -1; } - return 0; -} /* int csnmp_config_add_data_instance */ + dd->instance.is_plugin = is_plugin; + dd->instance.configured = true; -static int csnmp_config_add_data_instance_prefix(data_definition_t *dd, - oconfig_item_t *ci) { - int status; + if (strlen(buffer) == 0) { + return 0; + } + + dd->instance.oid.oid_len = MAX_OID_LEN; - if (!dd->is_table) { - WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' " - "is set to `false'.", - dd->name); + if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) { + ERROR("snmp plugin: read_objid (%s) failed.", buffer); return -1; } - status = cf_util_get_string(ci, &dd->instance_prefix); - return status; -} /* int csnmp_config_add_data_instance_prefix */ + return 0; +} /* int csnmp_config_add_data_instance_oid */ static int csnmp_config_add_data_values(data_definition_t *dd, oconfig_item_t *ci) { @@ -315,9 +318,6 @@ static int csnmp_config_add_data_blacklist(data_definition_t *dd, } } - dd->ignores_len = 0; - dd->ignores = NULL; - for (int i = 0; i < ci->values_num; ++i) { if (strarray_add(&(dd->ignores), &(dd->ignores_len), ci->values[i].value.string) != 0) { @@ -329,34 +329,27 @@ static int csnmp_config_add_data_blacklist(data_definition_t *dd, return 0; } /* int csnmp_config_add_data_blacklist */ -static int csnmp_config_add_data_blacklist_match_inverted(data_definition_t *dd, - oconfig_item_t *ci) { - if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN)) { - WARNING("snmp plugin: `InvertMatch' needs exactly one boolean argument."); - return -1; - } - - dd->invert_match = ci->values[0].value.boolean ? 1 : 0; - - return 0; -} /* int csnmp_config_add_data_blacklist_match_inverted */ - static int csnmp_config_add_data(oconfig_item_t *ci) { - data_definition_t *dd; - int status = 0; - - dd = calloc(1, sizeof(*dd)); + data_definition_t *dd = calloc(1, sizeof(*dd)); if (dd == NULL) return -1; - status = cf_util_get_string(ci, &dd->name); + int status = cf_util_get_string(ci, &dd->name); if (status != 0) { - free(dd); + sfree(dd); return -1; } dd->scale = 1.0; dd->shift = 0.0; + dd->ignores_len = 0; + dd->ignores = NULL; + + dd->plugin_name = strdup("snmp"); + if (dd->plugin_name == NULL) { + ERROR("snmp plugin: Can't allocate memory"); + return ENOMEM; + } for (int i = 0; i < ci->children_num; i++) { oconfig_item_t *option = ci->children + i; @@ -365,10 +358,35 @@ static int csnmp_config_add_data(oconfig_item_t *ci) { status = cf_util_get_string(option, &dd->type); else if (strcasecmp("Table", option->key) == 0) status = cf_util_get_boolean(option, &dd->is_table); - else if (strcasecmp("Instance", option->key) == 0) - status = csnmp_config_add_data_instance(dd, option); + else if (strcasecmp("Plugin", option->key) == 0) + status = cf_util_get_string(option, &dd->plugin_name); + else if (strcasecmp("Instance", option->key) == 0) { + if (dd->is_table) { + /* Instance is OID */ + WARNING("snmp plugin: Option `Instance' is deprecated, please update " + "Data \"%s\" block to use option `TypeInstanceOID'.", + dd->name); + status = csnmp_config_add_data_instance_oid(dd, option, + false /* type instance */); + } else { + /* Instance is a simple string */ + WARNING("snmp plugin: Option `Instance' is deprecated, please update " + "Data \"%s\" block to use option `TypeInstance'.", + dd->name); + status = cf_util_get_string(option, &dd->type_instance); + } + } else if (strcasecmp("PluginInstance", option->key) == 0) + status = cf_util_get_string(option, &dd->plugin_instance); + else if (strcasecmp("TypeInstance", option->key) == 0) + status = cf_util_get_string(option, &dd->type_instance); + else if (strcasecmp("PluginInstanceOID", option->key) == 0) + status = csnmp_config_add_data_instance_oid(dd, option, + true /* plugin instance */); + else if (strcasecmp("TypeInstanceOID", option->key) == 0) + status = csnmp_config_add_data_instance_oid(dd, option, + false /* type instance */); else if (strcasecmp("InstancePrefix", option->key) == 0) - status = csnmp_config_add_data_instance_prefix(dd, option); + status = cf_util_get_string(option, &dd->instance_prefix); else if (strcasecmp("Values", option->key) == 0) status = csnmp_config_add_data_values(dd, option); else if (strcasecmp("Shift", option->key) == 0) @@ -378,7 +396,7 @@ static int csnmp_config_add_data(oconfig_item_t *ci) { else if (strcasecmp("Ignore", option->key) == 0) status = csnmp_config_add_data_blacklist(dd, option); else if (strcasecmp("InvertMatch", option->key) == 0) - status = csnmp_config_add_data_blacklist_match_inverted(dd, option); + status = cf_util_get_boolean(option, &dd->invert_match); else { WARNING("snmp plugin: Option `%s' not allowed here.", option->key); status = -1; @@ -389,6 +407,37 @@ static int csnmp_config_add_data(oconfig_item_t *ci) { } /* for (ci->children) */ while (status == 0) { + if (dd->is_table) { + if (dd->plugin_instance && dd->instance.is_plugin) { + WARNING("snmp plugin: Option `PluginInstance' will be ignored for " + "Data `%s'", + dd->name); + } + if (dd->type_instance && !dd->instance.is_plugin) { + WARNING("snmp plugin: Option `TypeInstance' will be ignored for Data " + "`%s'", + dd->name); + } + } else { + if (dd->instance.configured) { + if (dd->instance.is_plugin) { + WARNING("snmp plugin: Option `PluginInstanceOID' will be ignored for " + "Data `%s'", + dd->name); + } else { + WARNING("snmp plugin: Option `TypeInstanceOID' will be ignored for " + "Data `%s'", + dd->name); + } + } + + if (dd->instance_prefix) { + WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' " + "is set to `false'.", + dd->name); + } + } + if (dd->type == NULL) { WARNING("snmp plugin: `Type' not given for data `%s'", dd->name); status = -1; @@ -405,6 +454,10 @@ static int csnmp_config_add_data(oconfig_item_t *ci) { if (status != 0) { sfree(dd->name); + sfree(dd->type); + sfree(dd->plugin_name); + sfree(dd->plugin_instance); + sfree(dd->type_instance); sfree(dd->instance_prefix); sfree(dd->values); sfree(dd->ignores); @@ -413,9 +466,15 @@ static int csnmp_config_add_data(oconfig_item_t *ci) { } DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = " - "%zu }", - dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", - dd->values_len); + "%" PRIsz ",", + dd->name, dd->type, (dd->is_table) ? "true" : "false", dd->values_len); + + DEBUG("snmp plugin: plugin_instance = %s, type_instance = %s,", + dd->plugin_instance, dd->type_instance); + + DEBUG("snmp plugin: instance_by_oid = %s, to_plugin_instance = %s }", + (dd->instance.oid.oid_len > 0) ? "true" : "SUBID", + (dd->instance.is_plugin) ? "true" : "false"); if (data_head == NULL) data_head = dd; @@ -605,7 +664,6 @@ static int csnmp_config_add_host(oconfig_item_t *ci) { for (int i = 0; i < ci->children_num; i++) { oconfig_item_t *option = ci->children + i; - status = 0; if (strcasecmp("Address", option->key) == 0) status = cf_util_get_string(option, &hd->address); @@ -614,13 +672,13 @@ static int csnmp_config_add_host(oconfig_item_t *ci) { else if (strcasecmp("Version", option->key) == 0) status = csnmp_config_add_host_version(hd, option); else if (strcasecmp("Timeout", option->key) == 0) - cf_util_get_cdtime(option, &hd->timeout); + status = cf_util_get_cdtime(option, &hd->timeout); else if (strcasecmp("Retries", option->key) == 0) - cf_util_get_int(option, &hd->retries); + status = cf_util_get_int(option, &hd->retries); else if (strcasecmp("Collect", option->key) == 0) - csnmp_config_add_host_collect(hd, option); + status = csnmp_config_add_host_collect(hd, option); else if (strcasecmp("Interval", option->key) == 0) - cf_util_get_cdtime(option, &hd->interval); + status = cf_util_get_cdtime(option, &hd->interval); else if (strcasecmp("Username", option->key) == 0) status = cf_util_get_string(option, &hd->username); else if (strcasecmp("AuthProtocol", option->key) == 0) @@ -845,9 +903,9 @@ static value_t csnmp_value_list_to_value(struct variable_list *vl, int type, value_t ret; uint64_t tmp_unsigned = 0; int64_t tmp_signed = 0; - _Bool defined = 1; + bool defined = 1; /* Set to true when the original SNMP type appears to have been signed. */ - _Bool prefer_signed = 0; + bool prefer_signed = 0; if ((vl->type == ASN_INTEGER) || (vl->type == ASN_UINTEGER) || (vl->type == ASN_COUNTER) @@ -1051,7 +1109,6 @@ static int csnmp_instance_list_add(csnmp_list_instances_t **head, struct variable_list *vb; oid_t vb_name; int status; - uint32_t is_matched; /* Set vb on the last variable */ for (vb = res->variables; (vb != NULL) && (vb->next_variable != NULL); @@ -1081,11 +1138,11 @@ static int csnmp_instance_list_add(csnmp_list_instances_t **head, char *ptr; csnmp_strvbcopy(il->instance, vb, sizeof(il->instance)); - is_matched = 0; + bool is_matched = 0; for (uint32_t i = 0; i < dd->ignores_len; i++) { status = fnmatch(dd->ignores[i], il->instance, 0); if (status == 0) { - if (dd->invert_match == 0) { + if (!dd->invert_match) { sfree(il); return 0; } else { @@ -1094,7 +1151,7 @@ static int csnmp_instance_list_add(csnmp_list_instances_t **head, } } } - if (dd->invert_match != 0 && is_matched == 0) { + if (dd->invert_match && !is_matched) { sfree(il); return 0; } @@ -1109,7 +1166,8 @@ static int csnmp_instance_list_add(csnmp_list_instances_t **head, value_t val = csnmp_value_list_to_value( vb, DS_TYPE_COUNTER, /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name); - snprintf(il->instance, sizeof(il->instance), "%llu", val.counter); + snprintf(il->instance, sizeof(il->instance), "%" PRIu64, + (uint64_t)val.counter); } /* TODO: Debugging output */ @@ -1134,7 +1192,7 @@ static int csnmp_dispatch_table(host_definition_t *host, csnmp_table_values_t *value_table_ptr[data->values_len]; size_t i; - _Bool have_more; + bool have_more; oid_t current_suffix; ds = plugin_get_ds(data->type); @@ -1151,13 +1209,13 @@ static int csnmp_dispatch_table(host_definition_t *host, value_table_ptr[i] = value_table[i]; sstrncpy(vl.host, host->name, sizeof(vl.host)); - sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin)); + sstrncpy(vl.plugin, data->plugin_name, sizeof(vl.plugin)); vl.interval = host->interval; have_more = 1; while (have_more) { - _Bool suffix_skipped = 0; + bool suffix_skipped = 0; /* Determine next suffix to handle. */ if (instance_list != NULL) { @@ -1236,11 +1294,27 @@ static int csnmp_dispatch_table(host_definition_t *host, else sstrncpy(temp, instance_list_ptr->instance, sizeof(temp)); - if (data->instance_prefix == NULL) - sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance)); - else - snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s", - data->instance_prefix, temp); + if (data->instance.is_plugin) { + if (data->instance_prefix == NULL) + sstrncpy(vl.plugin_instance, temp, sizeof(vl.plugin_instance)); + else + snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s%s", + data->instance_prefix, temp); + + if (data->type_instance) + sstrncpy(vl.type_instance, data->type_instance, + sizeof(vl.type_instance)); + } else { + if (data->instance_prefix == NULL) + sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance)); + else + snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s", + data->instance_prefix, temp); + + if (data->plugin_instance) + sstrncpy(vl.plugin_instance, data->plugin_instance, + sizeof(vl.plugin_instance)); + } } vl.values_len = data->values_len; @@ -1250,12 +1324,7 @@ static int csnmp_dispatch_table(host_definition_t *host, for (i = 0; i < data->values_len; i++) vl.values[i] = value_table_ptr[i]->value; - /* If we get here `vl.type_instance' and all `vl.values' have been set - * vl.type_instance can be empty, i.e. a blank port description on a - * switch if you're using IF-MIB::ifDescr as Instance. - */ - if (vl.type_instance[0] != '\0') - plugin_dispatch_values(&vl); + plugin_dispatch_values(&vl); /* prevent leakage of pointer to local variable. */ vl.values_len = 0; @@ -1277,13 +1346,17 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { const data_set_t *ds; - size_t oid_list_len = data->values_len + 1; + size_t oid_list_len = data->values_len; + + if (data->instance.oid.oid_len > 0) + oid_list_len++; + /* Holds the last OID returned by the device. We use this in the GETNEXT * request to proceed. */ oid_t oid_list[oid_list_len]; /* Set to false when an OID has left its subtree so we don't re-request it * again. */ - _Bool oid_list_todo[oid_list_len]; + csnmp_oid_type_t oid_list_todo[oid_list_len]; int status; size_t i; @@ -1312,22 +1385,24 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { } if (ds->ds_num != data->values_len) { - ERROR("snmp plugin: DataSet `%s' requires %zu values, but config talks " - "about %zu", + ERROR("snmp plugin: DataSet `%s' requires %" PRIsz + " values, but config talks " + "about %" PRIsz, data->type, ds->ds_num, data->values_len); return -1; } assert(data->values_len > 0); + for (i = 0; i < data->values_len; i++) + oid_list_todo[i] = OID_TYPE_VARIABLE; + /* We need a copy of all the OIDs, because GETNEXT will destroy them. */ memcpy(oid_list, data->values, data->values_len * sizeof(oid_t)); - if (data->instance.oid.oid_len > 0) - memcpy(oid_list + data->values_len, &data->instance.oid, sizeof(oid_t)); - else /* no InstanceFrom option specified. */ - oid_list_len--; - for (i = 0; i < oid_list_len; i++) - oid_list_todo[i] = 1; + if (data->instance.oid.oid_len > 0) { + memcpy(oid_list + i, &data->instance.oid, sizeof(oid_t)); + oid_list_todo[i] = OID_TYPE_INSTANCE; + } /* We're going to construct n linked lists, one for each "value". * value_list_head will contain pointers to the heads of these linked lists, @@ -1448,12 +1523,16 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { for (vb = res->variables, i = 0; (vb != NULL); vb = vb->next_variable, i++) { /* Calculate value index from todo list */ - while ((i < oid_list_len) && !oid_list_todo[i]) + while ((i < oid_list_len) && !oid_list_todo[i]) { i++; + } + if (i >= oid_list_len) { + break; + } /* An instance is configured and the res variable we process is the - * instance value (last index) */ - if ((data->instance.oid.oid_len > 0) && (i == data->values_len)) { + * instance value */ + if (oid_list_todo[i] == OID_TYPE_INSTANCE) { if ((vb->type == SNMP_ENDOFMIBVIEW) || (snmp_oid_ncompare( data->instance.oid.oid, data->instance.oid.oid_len, vb->name, @@ -1473,8 +1552,13 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { status = -1; break; } + } else if (oid_list_todo[i] == OID_TYPE_HOST) { + /* todo */ + assert(1 == 0); } else /* The variable we are processing is a normal value */ { + assert(oid_list_todo[i] == OID_TYPE_VARIABLE); + csnmp_table_values_t *vt; oid_t vb_name; oid_t suffix; @@ -1482,11 +1566,16 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { csnmp_oid_init(&vb_name, vb->name, vb->name_length); + DEBUG( + "snmp plugin: src.oid_len = %d root.oid_len = %d is_endofmib = %s", + vb_name.oid_len, (data->values + i)->oid_len, + (vb->type == SNMP_ENDOFMIBVIEW) ? "true" : "false"); + /* Calculate the current suffix. This is later used to check that the * suffix is increasing. This also checks if we left the subtree */ ret = csnmp_oid_suffix(&suffix, &vb_name, data->values + i); if (ret != 0) { - DEBUG("snmp plugin: host = %s; data = %s; i = %zu; " + DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; " "Value probably left its subtree.", host->name, data->name, i); oid_list_todo[i] = 0; @@ -1498,7 +1587,7 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { * table matching algorithm will get confused. */ if ((value_list_tail[i] != NULL) && (csnmp_oid_compare(&suffix, &value_list_tail[i]->suffix) <= 0)) { - DEBUG("snmp plugin: host = %s; data = %s; i = %zu; " + DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; " "Suffix is not increasing.", host->name, data->name, i); oid_list_todo[i] = 0; @@ -1590,8 +1679,9 @@ static int csnmp_read_value(host_definition_t *host, data_definition_t *data) { } if (ds->ds_num != data->values_len) { - ERROR("snmp plugin: DataSet `%s' requires %zu values, but config talks " - "about %zu", + ERROR("snmp plugin: DataSet `%s' requires %" PRIsz + " values, but config talks " + "about %" PRIsz, data->type, ds->ds_num, data->values_len); return -1; } @@ -1608,9 +1698,13 @@ static int csnmp_read_value(host_definition_t *host, data_definition_t *data) { } sstrncpy(vl.host, host->name, sizeof(vl.host)); - sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin)); + sstrncpy(vl.plugin, data->plugin_name, sizeof(vl.plugin)); sstrncpy(vl.type, data->type, sizeof(vl.type)); - sstrncpy(vl.type_instance, data->instance.string, sizeof(vl.type_instance)); + if (data->type_instance) + sstrncpy(vl.type_instance, data->type_instance, sizeof(vl.type_instance)); + if (data->plugin_instance) + sstrncpy(vl.plugin_instance, data->plugin_instance, + sizeof(vl.plugin_instance)); vl.interval = host->interval; @@ -1724,6 +1818,10 @@ static int csnmp_shutdown(void) { sfree(data_this->name); sfree(data_this->type); + sfree(data_this->plugin_name); + sfree(data_this->plugin_instance); + sfree(data_this->type_instance); + sfree(data_this->instance_prefix); sfree(data_this->values); sfree(data_this->ignores); sfree(data_this);