};
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;
instance_t instance;
+ char *plugin_name;
+ char *plugin_instance;
+ char *type_instance;
char *instance_prefix;
oid_t *values;
size_t values_len;
};
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
*/
* +-> 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
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;
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;
+ }
- if (!dd->is_table) {
- WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
- "is set to `false'.",
- dd->name);
+ 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;
}
- 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) {
}
}
- 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) {
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;
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)
} /* 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;
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);
}
DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = "
- "%" PRIsz " }",
+ "%" 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;
else {
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);
/* 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;
static int csnmp_instance_list_add(csnmp_list_instances_t **head,
csnmp_list_instances_t **tail,
- const struct snmp_pdu *res,
+ const struct variable_list *vb,
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;
- /* 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;
+ oid_t vb_name;
csnmp_oid_init(&vb_name, vb->name, vb->name_length);
- il = calloc(1, sizeof(*il));
+ csnmp_list_instances_t *il = calloc(1, sizeof(*il));
if (il == NULL) {
ERROR("snmp plugin: calloc failed.");
return -1;
}
il->next = NULL;
- status = csnmp_oid_suffix(&il->suffix, &vb_name, &dd->instance.oid);
+ int status = csnmp_oid_suffix(&il->suffix, &vb_name, &dd->instance.oid);
if (status != 0) {
sfree(il);
return status;
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;
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;
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;
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;
}
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,
}
/* 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,
/* Allocate a new `csnmp_list_instances_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) {
+ vb, host, data) != 0) {
ERROR("snmp plugin: host %s: csnmp_instance_list_add failed.",
host->name);
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;
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);
}
/* Make sure the OIDs returned by the agent are increasing. Otherwise
- * our
- * table matching algorithm will get confused. */
+ * 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 = %" PRIsz "; "
}
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;
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);