X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fsnmp.c;h=f591600423dbd53ec43ce047d0b8ea92b2eda99b;hb=ff7ec9fa808848d52adb39d3a444dc58918af8c3;hp=1ac65c8e4565352e73d4ea4daaaebfa0ea667915;hpb=aecd05a0a0ec4d745506a67a937de6d1d6b33db5;p=collectd.git diff --git a/src/snmp.c b/src/snmp.c index 1ac65c8e..f5916004 100644 --- a/src/snmp.c +++ b/src/snmp.c @@ -44,18 +44,23 @@ 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 hostname_oid; oid_t *values; size_t values_len; double scale; @@ -63,7 +68,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; @@ -71,6 +76,8 @@ struct host_definition_s { char *name; char *address; int version; + cdtime_t timeout; + int retries; /* snmpv1/2 options */ char *community; @@ -96,24 +103,31 @@ typedef struct host_definition_s host_definition_t; /* These two types are used to cache values in `csnmp_read_table' to handle * gaps in tables. */ -struct csnmp_list_instances_s { +struct csnmp_cell_char_s { oid_t suffix; - char instance[DATA_MAX_NAME_LEN]; - struct csnmp_list_instances_s *next; + char value[DATA_MAX_NAME_LEN]; + struct csnmp_cell_char_s *next; }; -typedef struct csnmp_list_instances_s csnmp_list_instances_t; +typedef struct csnmp_cell_char_s csnmp_cell_char_t; -struct csnmp_table_values_s { +struct csnmp_cell_value_s { oid_t suffix; value_t value; - struct csnmp_table_values_s *next; + struct csnmp_cell_value_s *next; }; -typedef struct csnmp_table_values_s csnmp_table_values_t; +typedef struct csnmp_cell_value_s csnmp_cell_value_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 @@ -207,7 +221,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 @@ -217,52 +230,66 @@ 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; - status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer)); + int status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer)); if (status != 0) return status; - if (dd->is_table) { - /* Instance is an OID */ - dd->instance.oid.oid_len = MAX_OID_LEN; + if (dd->instance.configured) { + ERROR("snmp plugin: Only one of options `TypeInstanceOID', " + "`PluginInstanceOID' or `Instance' can be used in `Data' block."); + return -1; + } + + dd->instance.is_plugin = is_plugin; + dd->instance.configured = true; - 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 (strlen(buffer) == 0) { + return 0; + } + + 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; } return 0; -} /* int csnmp_config_add_data_instance */ +} /* int csnmp_config_add_data_instance_oid */ -static int csnmp_config_add_data_instance_prefix(data_definition_t *dd, - oconfig_item_t *ci) { - int status; +static int csnmp_config_add_data_hostname_oid(data_definition_t *dd, + oconfig_item_t *ci) { + char buffer[DATA_MAX_NAME_LEN]; - if (!dd->is_table) { - WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' " - "is set to `false'.", - dd->name); + int status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer)); + if (status != 0) + return status; + + if (strlen(buffer) == 0) { + return 0; + } + + dd->hostname_oid.oid_len = MAX_OID_LEN; + + if (!read_objid(buffer, dd->hostname_oid.oid, &dd->hostname_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_hostname_oid */ static int csnmp_config_add_data_values(data_definition_t *dd, oconfig_item_t *ci) { @@ -313,9 +340,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) { @@ -327,34 +351,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; @@ -363,10 +380,37 @@ 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("HostnameOID", option->key) == 0) + status = csnmp_config_add_data_hostname_oid(dd, option); else if (strcasecmp("Values", option->key) == 0) status = csnmp_config_add_data_values(dd, option); else if (strcasecmp("Shift", option->key) == 0) @@ -376,7 +420,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; @@ -387,6 +431,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; @@ -403,6 +478,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); @@ -411,9 +490,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; @@ -597,9 +682,12 @@ static int csnmp_config_add_host(oconfig_item_t *ci) { hd->sess_handle = NULL; hd->interval = 0; + /* These mean that we have not set a timeout or retry value */ + hd->timeout = 0; + hd->retries = -1; + 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); @@ -607,10 +695,14 @@ static int csnmp_config_add_host(oconfig_item_t *ci) { status = cf_util_get_string(option, &hd->community); else if (strcasecmp("Version", option->key) == 0) status = csnmp_config_add_host_version(hd, option); + else if (strcasecmp("Timeout", option->key) == 0) + status = cf_util_get_cdtime(option, &hd->timeout); + else if (strcasecmp("Retries", option->key) == 0) + 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) @@ -803,6 +895,15 @@ static void csnmp_host_open_session(host_definition_t *host) { sess.community_len = strlen(host->community); } + /* Set timeout & retries, if they have been changed from the default */ + if (host->timeout != 0) { + /* net-snmp expects microseconds */ + sess.timeout = CDTIME_T_TO_US(host->timeout); + } + if (host->retries >= 0) { + sess.retries = host->retries; + } + /* snmp_sess_open will copy the `struct snmp_session *'. */ host->sess_handle = snmp_sess_open(&sess); @@ -819,16 +920,16 @@ static void csnmp_host_open_session(host_definition_t *host) { /* TODO: Check if negative values wrap around. Problem: negative temperatures. */ -static value_t csnmp_value_list_to_value(struct variable_list *vl, int type, - double scale, double shift, +static value_t csnmp_value_list_to_value(const struct variable_list *vl, + int type, double scale, double shift, const char *host_name, const char *data_name) { 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) @@ -1023,99 +1124,89 @@ static int csnmp_strvbcopy(char *dst, /* {{{ */ return 0; } /* }}} int csnmp_strvbcopy */ -static int csnmp_instance_list_add(csnmp_list_instances_t **head, - csnmp_list_instances_t **tail, - const struct snmp_pdu *res, - const host_definition_t *hd, - const data_definition_t *dd) { - csnmp_list_instances_t *il; - struct variable_list *vb; - oid_t vb_name; - int status; - uint32_t is_matched; +static csnmp_cell_char_t *csnmp_get_char_cell(const struct variable_list *vb, + const oid_t *root_oid, + const host_definition_t *hd, + const data_definition_t *dd) { - /* Set vb on the last variable */ - for (vb = res->variables; (vb != NULL) && (vb->next_variable != NULL); - vb = vb->next_variable) - /* do nothing */; if (vb == NULL) - return -1; + return NULL; - csnmp_oid_init(&vb_name, vb->name, vb->name_length); - - il = calloc(1, sizeof(*il)); + csnmp_cell_char_t *il = calloc(1, sizeof(*il)); if (il == NULL) { ERROR("snmp plugin: calloc failed."); - return -1; + return NULL; } il->next = NULL; - status = csnmp_oid_suffix(&il->suffix, &vb_name, &dd->instance.oid); - if (status != 0) { + oid_t vb_name; + csnmp_oid_init(&vb_name, vb->name, vb->name_length); + + if (csnmp_oid_suffix(&il->suffix, &vb_name, root_oid) != 0) { sfree(il); - return status; + return NULL; } - /* Get instance name */ + /* Get value */ if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR) || (vb->type == ASN_IPADDRESS)) { - char *ptr; - - csnmp_strvbcopy(il->instance, vb, sizeof(il->instance)); - 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) { - sfree(il); - return 0; - } else { - is_matched = 1; - break; - } - } - } - if (dd->invert_match != 0 && is_matched == 0) { - sfree(il); - return 0; - } - for (ptr = il->instance; *ptr != '\0'; ptr++) { - if ((*ptr > 0) && (*ptr < 32)) - *ptr = ' '; - else if (*ptr == '/') - *ptr = '_'; - } - DEBUG("snmp plugin: il->instance = `%s';", il->instance); + + csnmp_strvbcopy(il->value, vb, sizeof(il->value)); + } else { 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->value, sizeof(il->value), "%" PRIu64, (uint64_t)val.counter); } - /* TODO: Debugging output */ + return il; +} /* csnmp_cell_char_t csnmp_get_char_cell */ +static void csnmp_cells_append(csnmp_cell_char_t **head, + csnmp_cell_char_t **tail, + csnmp_cell_char_t *il) { if (*head == NULL) *head = il; else (*tail)->next = il; *tail = il; - +} /* void csnmp_cells_append */ + +static bool csnmp_ignore_instance(csnmp_cell_char_t *cell, + const data_definition_t *dd) { + bool is_matched = 0; + for (uint32_t i = 0; i < dd->ignores_len; i++) { + int status = fnmatch(dd->ignores[i], cell->value, 0); + if (status == 0) { + if (!dd->invert_match) { + return 1; + } else { + is_matched = 1; + break; + } + } + } + if (dd->invert_match && !is_matched) { + return 1; + } return 0; -} /* int csnmp_instance_list_add */ +} /* bool csnmp_ignore_instance */ static int csnmp_dispatch_table(host_definition_t *host, data_definition_t *data, - csnmp_list_instances_t *instance_list, - csnmp_table_values_t **value_table) { + csnmp_cell_char_t *instance_cells, + csnmp_cell_char_t *hostname_cells, + csnmp_cell_value_t **value_cells) { const data_set_t *ds; value_list_t vl = VALUE_LIST_INIT; - csnmp_list_instances_t *instance_list_ptr; - csnmp_table_values_t *value_table_ptr[data->values_len]; + csnmp_cell_char_t *instance_cell_ptr; + csnmp_cell_char_t *hostname_cell_ptr; + csnmp_cell_value_t *value_cell_ptr[data->values_len]; size_t i; - _Bool have_more; + bool have_more; oid_t current_suffix; ds = plugin_get_ds(data->type); @@ -1126,32 +1217,32 @@ static int csnmp_dispatch_table(host_definition_t *host, assert(ds->ds_num == data->values_len); assert(data->values_len > 0); - instance_list_ptr = instance_list; + instance_cell_ptr = instance_cells; + hostname_cell_ptr = hostname_cells; for (i = 0; i < data->values_len; i++) - value_table_ptr[i] = value_table[i]; + value_cell_ptr[i] = value_cells[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) { - if (instance_list_ptr == NULL) { + if (instance_cells != NULL) { + if (instance_cell_ptr == NULL) { have_more = 0; continue; } - memcpy(¤t_suffix, &instance_list_ptr->suffix, + memcpy(¤t_suffix, &instance_cell_ptr->suffix, sizeof(current_suffix)); } else { /* no instance configured */ - csnmp_table_values_t *ptr = value_table_ptr[0]; + csnmp_cell_value_t *ptr = value_cell_ptr[0]; if (ptr == NULL) { have_more = 0; continue; @@ -1160,22 +1251,52 @@ static int csnmp_dispatch_table(host_definition_t *host, memcpy(¤t_suffix, &ptr->suffix, sizeof(current_suffix)); } - /* Update all the value_table_ptr to point at the entry with the same + /* + char oid_buffer[1024] = {0}; + snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, current_suffix.oid, + current_suffix.oid_len); + DEBUG("SNMP PLUGIN: SUFFIX %s", oid_buffer); + */ + + /* Update hostname_cell_ptr to point expected suffix */ + if (hostname_cells != NULL) { + while ( + (hostname_cell_ptr != NULL) && + (csnmp_oid_compare(&hostname_cell_ptr->suffix, ¤t_suffix) < 0)) + hostname_cell_ptr = hostname_cell_ptr->next; + + if (hostname_cell_ptr == NULL) { + have_more = 0; + continue; + } + + if (csnmp_oid_compare(&hostname_cell_ptr->suffix, ¤t_suffix) > 0) { + /* This suffix is missing in the subtree. Indicate this with the + * "suffix_skipped" flag and try the next instance / suffix. */ + suffix_skipped = 1; + NOTICE( + "snmp plugin: suffix skipped, variable not found for HostnameOID."); + } + } + + /* Update all the value_cell_ptr to point at the entry with the same * trailing partial OID */ for (i = 0; i < data->values_len; i++) { while ( - (value_table_ptr[i] != NULL) && - (csnmp_oid_compare(&value_table_ptr[i]->suffix, ¤t_suffix) < 0)) - value_table_ptr[i] = value_table_ptr[i]->next; + (value_cell_ptr[i] != NULL) && + (csnmp_oid_compare(&value_cell_ptr[i]->suffix, ¤t_suffix) < 0)) + value_cell_ptr[i] = value_cell_ptr[i]->next; - if (value_table_ptr[i] == NULL) { + if (value_cell_ptr[i] == NULL) { have_more = 0; break; - } else if (csnmp_oid_compare(&value_table_ptr[i]->suffix, + } else if (csnmp_oid_compare(&value_cell_ptr[i]->suffix, ¤t_suffix) > 0) { /* This suffix is missing in the subtree. Indicate this with the * "suffix_skipped" flag and try the next instance / suffix. */ suffix_skipped = 1; + NOTICE( + "snmp plugin: suffix skipped, variable not found for Value OID."); break; } } /* for (i = 0; i < columns; i++) */ @@ -1185,43 +1306,68 @@ static int csnmp_dispatch_table(host_definition_t *host, /* Matching the values failed. Start from the beginning again. */ if (suffix_skipped) { - if (instance_list != NULL) - instance_list_ptr = instance_list_ptr->next; + if (instance_cells != NULL) + instance_cell_ptr = instance_cell_ptr->next; else - value_table_ptr[0] = value_table_ptr[0]->next; + value_cell_ptr[0] = value_cell_ptr[0]->next; continue; } -/* if we reach this line, all value_table_ptr[i] are non-NULL and are set - * to the same subid. instance_list_ptr is either NULL or points to the +/* if we reach this line, all value_cell_ptr[i] are non-NULL and are set + * to the same subid. instance_cell_ptr is either NULL or points to the * same subid, too. */ #if COLLECT_DEBUG for (i = 1; i < data->values_len; i++) { - assert(value_table_ptr[i] != NULL); - assert(csnmp_oid_compare(&value_table_ptr[i - 1]->suffix, - &value_table_ptr[i]->suffix) == 0); + assert(value_cell_ptr[i] != NULL); + assert(csnmp_oid_compare(&value_cell_ptr[i - 1]->suffix, + &value_cell_ptr[i]->suffix) == 0); } - assert((instance_list_ptr == NULL) || - (csnmp_oid_compare(&instance_list_ptr->suffix, - &value_table_ptr[0]->suffix) == 0)); + assert((instance_cell_ptr == NULL) || + (csnmp_oid_compare(&instance_cell_ptr->suffix, + &value_cell_ptr[0]->suffix) == 0)); + assert((hostname_cell_ptr == NULL) || + (csnmp_oid_compare(&hostname_cell_ptr->suffix, + &value_cell_ptr[0]->suffix) == 0)); #endif sstrncpy(vl.type, data->type, sizeof(vl.type)); + if (hostname_cell_ptr) { + sstrncpy(vl.host, hostname_cell_ptr->value, sizeof(vl.host)); + } else { + sstrncpy(vl.host, host->name, sizeof(vl.host)); + } + { char temp[DATA_MAX_NAME_LEN]; - if (instance_list_ptr == NULL) + if (instance_cell_ptr == NULL) csnmp_oid_to_string(temp, sizeof(temp), ¤t_suffix); else - sstrncpy(temp, instance_list_ptr->instance, sizeof(temp)); + sstrncpy(temp, instance_cell_ptr->value, 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; @@ -1229,23 +1375,18 @@ static int csnmp_dispatch_table(host_definition_t *host, vl.values = values; for (i = 0; i < data->values_len; i++) - vl.values[i] = value_table_ptr[i]->value; + vl.values[i] = value_cell_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; vl.values = NULL; - if (instance_list != NULL) - instance_list_ptr = instance_list_ptr->next; + if (instance_cells != NULL) + instance_cell_ptr = instance_cell_ptr->next; else - value_table_ptr[0] = value_table_ptr[0]->next; + value_cell_ptr[0] = value_cell_ptr[0]->next; } /* while (have_more) */ return (0); @@ -1258,25 +1399,33 @@ 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++; + + if (data->hostname_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; - /* `value_list_head' and `value_list_tail' implement a linked list for each - * value. `instance_list_head' and `instance_list_tail' implement a linked - * list of - * instance names. This is used to jump gaps in the table. */ - csnmp_list_instances_t *instance_list_head; - csnmp_list_instances_t *instance_list_tail; - csnmp_table_values_t **value_list_head; - csnmp_table_values_t **value_list_tail; + /* `value_list_head' and `value_cells_tail' implement a linked list for each + * value. `instance_cells_head' and `instance_cells_tail' implement a linked + * list of instance names. This is used to jump gaps in the table. */ + csnmp_cell_char_t *instance_cells_head = NULL; + csnmp_cell_char_t *instance_cells_tail = NULL; + csnmp_cell_char_t *hostname_cells_head = NULL; + csnmp_cell_char_t *hostname_cells_tail = NULL; + csnmp_cell_value_t **value_cells_head; + csnmp_cell_value_t **value_cells_tail; DEBUG("snmp plugin: csnmp_read_table (host = %s, data = %s)", host->name, data->name); @@ -1293,38 +1442,44 @@ 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; + i++; + } + + if (data->hostname_oid.oid_len > 0) { + memcpy(oid_list + i, &data->hostname_oid, sizeof(oid_t)); + oid_list_todo[i] = OID_TYPE_HOST; + i++; + } /* 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, - * value_list_tail will contain pointers to the tail of the lists. */ - value_list_head = calloc(data->values_len, sizeof(*value_list_head)); - value_list_tail = calloc(data->values_len, sizeof(*value_list_tail)); - if ((value_list_head == NULL) || (value_list_tail == NULL)) { + * value_cells_head will contain pointers to the heads of these linked lists, + * value_cells_tail will contain pointers to the tail of the lists. */ + value_cells_head = calloc(data->values_len, sizeof(*value_cells_head)); + value_cells_tail = calloc(data->values_len, sizeof(*value_cells_tail)); + if ((value_cells_head == NULL) || (value_cells_tail == NULL)) { ERROR("snmp plugin: csnmp_read_table: calloc failed."); - sfree(value_list_head); - sfree(value_list_tail); + sfree(value_cells_head); + sfree(value_cells_tail); return -1; } - instance_list_head = NULL; - instance_list_tail = NULL; - status = 0; while (status == 0) { req = snmp_pdu_create(SNMP_MSG_GETNEXT); @@ -1429,12 +1584,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, @@ -1445,29 +1604,76 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { continue; } - /* Allocate a new `csnmp_list_instances_t', insert the instance name and + /* Allocate a new `csnmp_cell_char_t', insert the instance name and + * add it to the list */ + csnmp_cell_char_t *cell = + csnmp_get_char_cell(vb, &data->instance.oid, host, data); + if (cell == NULL) { + ERROR("snmp plugin: host %s: csnmp_get_char_cell() failed.", + host->name); + status = -1; + break; + } + + if (csnmp_ignore_instance(cell, data)) { + sfree(cell); + } else { + /**/ + for (char *ptr = cell->value; *ptr != '\0'; ptr++) { + if ((*ptr > 0) && (*ptr < 32)) + *ptr = ' '; + else if (*ptr == '/') + *ptr = '_'; + } + + DEBUG("snmp plugin: il->instance = `%s';", cell->value); + csnmp_cells_append(&instance_cells_head, &instance_cells_tail, cell); + } + } else if (oid_list_todo[i] == OID_TYPE_HOST) { + if ((vb->type == SNMP_ENDOFMIBVIEW) || + (snmp_oid_ncompare( + data->hostname_oid.oid, data->hostname_oid.oid_len, vb->name, + vb->name_length, data->hostname_oid.oid_len) != 0)) { + DEBUG("snmp plugin: host = %s; data = %s; Instance left its subtree.", + host->name, data->name); + oid_list_todo[i] = 0; + continue; + } + + /* Allocate a new `csnmp_cell_char_t', insert the instance name and * add it to the list */ - if (csnmp_instance_list_add(&instance_list_head, &instance_list_tail, - res, host, data) != 0) { - ERROR("snmp plugin: host %s: csnmp_instance_list_add failed.", + csnmp_cell_char_t *cell = + csnmp_get_char_cell(vb, &data->hostname_oid, host, data); + if (cell == NULL) { + ERROR("snmp plugin: host %s: csnmp_get_char_cell() failed.", host->name); status = -1; break; } + + DEBUG("snmp plugin: il->hostname = `%s';", cell->value); + csnmp_cells_append(&hostname_cells_head, &hostname_cells_tail, cell); } else /* The variable we are processing is a normal value */ { - csnmp_table_values_t *vt; + assert(oid_list_todo[i] == OID_TYPE_VARIABLE); + + csnmp_cell_value_t *vt; oid_t vb_name; oid_t suffix; int ret; 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; @@ -1475,11 +1681,10 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { } /* Make sure the OIDs returned by the agent are increasing. Otherwise - * our - * 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; " + * our table matching algorithm will get confused. */ + if ((value_cells_tail[i] != NULL) && + (csnmp_oid_compare(&suffix, &value_cells_tail[i]->suffix) <= 0)) { + DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; " "Suffix is not increasing.", host->name, data->name, i); oid_list_todo[i] = 0; @@ -1499,11 +1704,11 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { memcpy(&vt->suffix, &suffix, sizeof(vt->suffix)); vt->next = NULL; - if (value_list_tail[i] == NULL) - value_list_head[i] = vt; + if (value_cells_tail[i] == NULL) + value_cells_head[i] = vt; else - value_list_tail[i]->next = vt; - value_list_tail[i] = vt; + value_cells_tail[i]->next = vt; + value_cells_tail[i] = vt; } /* Copy OID to oid_list[i] */ @@ -1521,27 +1726,33 @@ static int csnmp_read_table(host_definition_t *host, data_definition_t *data) { snmp_free_pdu(res); res = NULL; - if (status == 0) - csnmp_dispatch_table(host, data, instance_list_head, value_list_head); + csnmp_dispatch_table(host, data, instance_cells_head, hostname_cells_head, + value_cells_head); /* Free all allocated variables here */ - while (instance_list_head != NULL) { - csnmp_list_instances_t *next = instance_list_head->next; - sfree(instance_list_head); - instance_list_head = next; + while (instance_cells_head != NULL) { + csnmp_cell_char_t *next = instance_cells_head->next; + sfree(instance_cells_head); + instance_cells_head = next; + } + + while (hostname_cells_head != NULL) { + csnmp_cell_char_t *next = hostname_cells_head->next; + sfree(hostname_cells_head); + hostname_cells_head = next; } for (i = 0; i < data->values_len; i++) { - while (value_list_head[i] != NULL) { - csnmp_table_values_t *next = value_list_head[i]->next; - sfree(value_list_head[i]); - value_list_head[i] = next; + while (value_cells_head[i] != NULL) { + csnmp_cell_value_t *next = value_cells_head[i]->next; + sfree(value_cells_head[i]); + value_cells_head[i] = next; } } - sfree(value_list_head); - sfree(value_list_tail); + sfree(value_cells_head); + sfree(value_cells_tail); return 0; } /* int csnmp_read_table */ @@ -1572,8 +1783,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; } @@ -1590,9 +1802,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; @@ -1706,6 +1922,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);