*
* Copyright(c) 2016 Intel Corporation. All rights reserved.
*
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ *of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
- * of the Software, and to permit persons to whom the Software is furnished to do
+ * of the Software, and to permit persons to whom the Software is furnished to
+ *do
* so, subject to the following conditions:
*
- * The above copyright notice and this permission notice shall be included in all
+ * The above copyright notice and this permission notice shall be included in
+ *all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#define OVS_EVENTS_PLUGIN "ovs_events"
#define OVS_EVENTS_CTX_LOCK \
for (int __i = ovs_events_ctx_lock(); __i != 0; __i = ovs_events_ctx_unlock())
-#define OVS_EVENTS_CONFIG_ERROR(option) \
- do { \
- ERROR(OVS_EVENTS_PLUGIN ": read '%s' config option failed", option); \
- goto failure; \
- } while (0)
/* Link status type */
enum ovs_events_link_status_e { DOWN, UP };
/* OVS events configuration data */
struct ovs_events_config_s {
- _Bool send_notification; /* sent notification to collectd? */
+ bool send_notification; /* sent notification to collectd? */
char ovs_db_node[OVS_DB_ADDR_NODE_SIZE]; /* OVS DB node */
char ovs_db_serv[OVS_DB_ADDR_SERVICE_SIZE]; /* OVS DB service */
char ovs_db_unix[OVS_DB_ADDR_UNIX_SIZE]; /* OVS DB unix socket path */
ovs_db_t *ovs_db; /* pointer to OVS DB instance */
ovs_events_config_t config; /* plugin config */
char *ovs_db_select_params; /* OVS DB select parameter request */
- _Bool is_db_available; /* specify whether OVS DB is available */
+ bool is_db_available; /* specify whether OVS DB is available */
};
typedef struct ovs_events_ctx_s ovs_events_ctx_t;
*/
static ovs_events_ctx_t ovs_events_ctx = {
.mutex = PTHREAD_MUTEX_INITIALIZER,
- .config = {.ovs_db_node = "localhost", /* use default OVS DB node */
+ .config = {.send_notification = true, /* send notification by default */
+ .ovs_db_node = "localhost", /* use default OVS DB node */
.ovs_db_serv = "6640"} /* use default OVS DB service */
};
+/* Forward declaration */
+static int ovs_events_plugin_read(user_data_t *u);
+
/* This function is used only by "OVS_EVENTS_CTX_LOCK" define (see above).
* It always returns 1 when context is locked.
*/
static int ovs_events_ctx_lock() {
pthread_mutex_lock(&ovs_events_ctx.mutex);
- return (1);
+ return 1;
}
/* This function is used only by "OVS_EVENTS_CTX_LOCK" define (see above).
*/
static int ovs_events_ctx_unlock() {
pthread_mutex_unlock(&ovs_events_ctx.mutex);
- return (0);
+ return 0;
}
/* Check if given interface name exists in configuration file. It
*/
static int ovs_events_config_iface_exists(const char *ifname) {
if (ovs_events_ctx.config.ifaces == NULL)
- return (-1);
+ return -1;
/* check if given interface exists */
for (ovs_events_iface_list_t *iface = ovs_events_ctx.config.ifaces; iface;
iface = iface->next)
if (strcmp(ifname, iface->name) == 0)
- return (1);
+ return 1;
- return (0);
+ return 0;
}
/* Get OVS DB select parameter request based on rfc7047,
return NULL;
}
opt_buff = new_buff;
- int ret = ssnprintf(opt_buff + buff_off, buff_size - buff_off, option_fmt,
- iface->name);
+ int ret = snprintf(opt_buff + buff_off, buff_size - buff_off, option_fmt,
+ iface->name);
if (ret < 0) {
sfree(opt_buff);
return NULL;
/* allocate memory for OVS DB select params */
size_t params_size = sizeof(params_fmt) + strlen(opt_buff);
- char *params_buff = malloc(params_size);
+ char *params_buff = calloc(1, params_size);
if (params_buff == NULL) {
sfree(opt_buff);
return NULL;
}
/* create OVS DB select params */
- if (ssnprintf(params_buff, params_size, params_fmt, opt_buff) < 0)
+ if (snprintf(params_buff, params_size, params_fmt, opt_buff) < 0)
sfree(params_buff);
sfree(opt_buff);
}
}
+/* Parse/process "Interfaces" configuration option. Returns 0 if success
+ * otherwise -1 (error)
+ */
+static int ovs_events_config_get_interfaces(const oconfig_item_t *ci) {
+ for (int j = 0; j < ci->values_num; j++) {
+ /* check interface name type */
+ if (ci->values[j].type != OCONFIG_TYPE_STRING) {
+ ERROR(OVS_EVENTS_PLUGIN ": given interface name is not a string [idx=%d]",
+ j);
+ return -1;
+ }
+ /* allocate memory for configured interface */
+ ovs_events_iface_list_t *new_iface = calloc(1, sizeof(*new_iface));
+ if (new_iface == NULL) {
+ ERROR(OVS_EVENTS_PLUGIN ": calloc () copy interface name fail");
+ return -1;
+ } else {
+ /* store interface name */
+ sstrncpy(new_iface->name, ci->values[j].value.string,
+ sizeof(new_iface->name));
+ new_iface->next = ovs_events_ctx.config.ifaces;
+ ovs_events_ctx.config.ifaces = new_iface;
+ DEBUG(OVS_EVENTS_PLUGIN ": found monitored interface \"%s\"",
+ new_iface->name);
+ }
+ }
+ return 0;
+}
+
/* Parse plugin configuration file and store the config
* in allocated memory. Returns negative value in case of error.
*/
static int ovs_events_plugin_config(oconfig_item_t *ci) {
- ovs_events_iface_list_t *new_iface;
-
+ bool dispatch_values = false;
for (int i = 0; i < ci->children_num; i++) {
oconfig_item_t *child = ci->children + i;
if (strcasecmp("SendNotification", child->key) == 0) {
if (cf_util_get_boolean(child,
- &ovs_events_ctx.config.send_notification) != 0)
- OVS_EVENTS_CONFIG_ERROR(child->key);
+ &ovs_events_ctx.config.send_notification) != 0) {
+ ovs_events_config_free();
+ return -1;
+ }
} else if (strcasecmp("Address", child->key) == 0) {
if (cf_util_get_string_buffer(
child, ovs_events_ctx.config.ovs_db_node,
- sizeof(ovs_events_ctx.config.ovs_db_node)) != 0)
- OVS_EVENTS_CONFIG_ERROR(child->key);
+ sizeof(ovs_events_ctx.config.ovs_db_node)) != 0) {
+ ovs_events_config_free();
+ return -1;
+ }
} else if (strcasecmp("Port", child->key) == 0) {
- if (cf_util_get_string_buffer(
- child, ovs_events_ctx.config.ovs_db_serv,
- sizeof(ovs_events_ctx.config.ovs_db_serv)) != 0)
- OVS_EVENTS_CONFIG_ERROR(child->key);
+ char *service = NULL;
+ if (cf_util_get_service(child, &service) != 0) {
+ ovs_events_config_free();
+ return -1;
+ }
+ sstrncpy(ovs_events_ctx.config.ovs_db_serv, service,
+ sizeof(ovs_events_ctx.config.ovs_db_serv));
+ sfree(service);
} else if (strcasecmp("Socket", child->key) == 0) {
if (cf_util_get_string_buffer(
child, ovs_events_ctx.config.ovs_db_unix,
- sizeof(ovs_events_ctx.config.ovs_db_unix)) != 0)
- OVS_EVENTS_CONFIG_ERROR(child->key);
+ sizeof(ovs_events_ctx.config.ovs_db_unix)) != 0) {
+ ovs_events_config_free();
+ return -1;
+ }
} else if (strcasecmp("Interfaces", child->key) == 0) {
- for (int j = 0; j < child->values_num; j++) {
- /* check value type */
- if (child->values[j].type != OCONFIG_TYPE_STRING) {
- ERROR(OVS_EVENTS_PLUGIN
- ": given interface name is not a string [idx=%d]",
- j);
- goto failure;
- }
- /* allocate memory for configured interface */
- if ((new_iface = malloc(sizeof(*new_iface))) == NULL) {
- ERROR(OVS_EVENTS_PLUGIN ": malloc () copy interface name fail");
- goto failure;
- } else {
- /* store interface name */
- sstrncpy(new_iface->name, child->values[j].value.string,
- sizeof(new_iface->name));
- new_iface->next = ovs_events_ctx.config.ifaces;
- ovs_events_ctx.config.ifaces = new_iface;
- DEBUG(OVS_EVENTS_PLUGIN ": found monitored interface \"%s\"",
- new_iface->name);
- }
+ if (ovs_events_config_get_interfaces(child) != 0) {
+ ovs_events_config_free();
+ return -1;
+ }
+ } else if (strcasecmp("DispatchValues", child->key) == 0) {
+ if (cf_util_get_boolean(child, &dispatch_values) != 0) {
+ ovs_events_config_free();
+ return -1;
}
} else {
ERROR(OVS_EVENTS_PLUGIN ": option '%s' is not allowed here", child->key);
- goto failure;
+ ovs_events_config_free();
+ return -1;
}
}
- return (0);
+ /* Check and warn about invalid configuration */
+ if (!ovs_events_ctx.config.send_notification && !dispatch_values) {
+ WARNING(OVS_EVENTS_PLUGIN
+ ": send notification and dispatch values "
+ "options are disabled. No information will be dispatched by the "
+ "plugin. Please check your configuration");
+ }
+ /* Dispatch link status values if configured */
+ if (dispatch_values)
+ return plugin_register_complex_read(NULL, OVS_EVENTS_PLUGIN,
+ ovs_events_plugin_read, 0, NULL);
-failure:
- ovs_events_config_free();
- return (-1);
+ return 0;
}
/* Dispatch OVS interface link status event to collectd */
-static void ovs_events_dispatch_notification(const ovs_events_iface_info_t *ifinfo) {
+static void
+ovs_events_dispatch_notification(const ovs_events_iface_info_t *ifinfo) {
const char *msg_link_status = NULL;
notification_t n = {
NOTIF_FAILURE, cdtime(), "", "", OVS_EVENTS_PLUGIN, "", "", "", NULL};
return;
}
- if (strlen(ifinfo->ext_vm_uuid) > 0)
+ if (strlen(ifinfo->ext_vm_uuid) > 0) {
if (plugin_notification_meta_add_string(&n, "vm-uuid",
ifinfo->ext_vm_uuid) < 0) {
ERROR(OVS_EVENTS_PLUGIN ": add interface vm-uuid meta data failed");
return;
}
+ }
- if (strlen(ifinfo->ext_iface_id) > 0)
+ if (strlen(ifinfo->ext_iface_id) > 0) {
if (plugin_notification_meta_add_string(&n, "iface-id",
ifinfo->ext_iface_id) < 0) {
ERROR(OVS_EVENTS_PLUGIN ": add interface iface-id meta data failed");
return;
}
+ }
/* fill the notification data */
- ssnprintf(n.message, sizeof(n.message),
- "link state of \"%s\" interface has been changed to \"%s\"",
- ifinfo->name, msg_link_status);
+ snprintf(n.message, sizeof(n.message),
+ "link state of \"%s\" interface has been changed to \"%s\"",
+ ifinfo->name, msg_link_status);
sstrncpy(n.host, hostname_g, sizeof(n.host));
sstrncpy(n.plugin_instance, ifinfo->name, sizeof(n.plugin_instance));
sstrncpy(n.type, "gauge", sizeof(n.type));
}
/* Dispatch OVS interface link status value to collectd */
-static void ovs_events_link_status_submit(const ovs_events_iface_info_t *ifinfo) {
+static void
+ovs_events_link_status_submit(const ovs_events_iface_info_t *ifinfo) {
value_list_t vl = VALUE_LIST_INIT;
meta_data_t *meta = NULL;
/* check YAJL type */
if (!YAJL_IS_OBJECT(jobject))
- return (-1);
-
- /* zero the interface info structure */
- memset(ifinfo, 0, sizeof(*ifinfo));
+ return -1;
/* try to find external_ids, name and link_state fields */
jexternal_ids = ovs_utils_get_value_by_key(jobject, "external_ids");
if (jexternal_ids == NULL || ifinfo == NULL)
- return (-1);
+ return -1;
+
+ /* zero the interface info structure */
+ memset(ifinfo, 0, sizeof(*ifinfo));
/* get iface-id from external_ids field */
jvalue = ovs_utils_get_map_value(jexternal_ids, "iface-id");
jvalue = ovs_utils_get_value_by_key(jobject, "_uuid");
if (jvalue == NULL || !YAJL_IS_ARRAY(jvalue) ||
YAJL_GET_ARRAY(jvalue)->len != 2)
- return (-1);
+ return -1;
juuid = YAJL_GET_ARRAY(jvalue)->values[1];
if (juuid == NULL || !YAJL_IS_STRING(juuid))
- return (-1);
+ return -1;
sstrncpy(ifinfo->uuid, YAJL_GET_STRING(juuid), sizeof(ifinfo->uuid));
/* get interface name */
jvalue = ovs_utils_get_value_by_key(jobject, "name");
if (jvalue == NULL || !YAJL_IS_STRING(jvalue))
- return (-1);
+ return -1;
sstrncpy(ifinfo->name, YAJL_GET_STRING(jvalue), sizeof(ifinfo->name));
/* get OVS DB interface link status */
else if (strcmp(state, "down") == 0)
ifinfo->link_status = DOWN;
}
- return (0);
+ return 0;
}
/* Process OVS DB update table event. It handles link status update event(s)
return;
}
/* go through all row updates */
- for (int row_index = 0; row_index < YAJL_GET_OBJECT(jupdate)->len;
+ for (size_t row_index = 0; row_index < YAJL_GET_OBJECT(jupdate)->len;
++row_index) {
jrow_update = YAJL_GET_OBJECT(jupdate)->values[row_index];
/* go through all rows and get interface info */
jvalues = YAJL_GET_ARRAY(jresult)->values;
- for (int i = 0; i < YAJL_GET_ARRAY(jresult)->len; i++) {
+ for (size_t i = 0; i < YAJL_GET_ARRAY(jresult)->len; i++) {
jvalue = ovs_utils_get_value_by_key(jvalues[i], "rows");
if (jvalue == NULL || !YAJL_IS_ARRAY(jvalue)) {
ERROR(OVS_EVENTS_PLUGIN "invalid data (array of rows is expected)");
return;
}
/* get interfaces info */
- for (int j = 0; j < YAJL_GET_ARRAY(jvalue)->len; j++) {
+ for (size_t j = 0; j < YAJL_GET_ARRAY(jvalue)->len; j++) {
if (ovs_events_get_iface_info(YAJL_GET_ARRAY(jvalue)->values[j],
&ifinfo) < 0) {
ERROR(OVS_EVENTS_PLUGIN
return;
}
}
- OVS_EVENTS_CTX_LOCK { ovs_events_ctx.is_db_available = 1; }
+ OVS_EVENTS_CTX_LOCK { ovs_events_ctx.is_db_available = true; }
DEBUG(OVS_EVENTS_PLUGIN ": OVS DB connection has been initialized");
}
if (ovs_events_ctx.config.send_notification)
ovs_events_dispatch_terminate_notification(msg);
WARNING(OVS_EVENTS_PLUGIN ": %s", msg);
- OVS_EVENTS_CTX_LOCK { ovs_events_ctx.is_db_available = 0; }
+ OVS_EVENTS_CTX_LOCK { ovs_events_ctx.is_db_available = false; }
}
/* Read OVS DB interface link status callback */
static int ovs_events_plugin_read(__attribute__((unused)) user_data_t *u) {
- _Bool is_connected = 0;
+ bool is_connected = false;
OVS_EVENTS_CTX_LOCK { is_connected = ovs_events_ctx.is_db_available; }
if (is_connected)
if (ovs_db_send_request(ovs_events_ctx.ovs_db, "transact",
ovs_events_ctx.ovs_db_select_params,
ovs_events_poll_result_cb) < 0) {
ERROR(OVS_EVENTS_PLUGIN ": get interface info failed");
- return (-1);
+ return -1;
}
- return (0);
+ return 0;
}
/* Initialize OVS plugin */
OVS_EVENTS_CTX_LOCK { ovs_events_ctx.ovs_db = ovs_db; }
DEBUG(OVS_EVENTS_PLUGIN ": plugin has been initialized");
- return (0);
+ return 0;
ovs_events_failure:
ERROR(OVS_EVENTS_PLUGIN ": plugin initialize failed");
/* release allocated memory */
ovs_events_config_free();
- return (-1);
+ return -1;
}
/* Shutdown OVS plugin */
ovs_events_config_free();
DEBUG(OVS_EVENTS_PLUGIN ": plugin has been destroyed");
- return (0);
+ return 0;
}
/* Register OVS plugin callbacks */
void module_register(void) {
plugin_register_complex_config(OVS_EVENTS_PLUGIN, ovs_events_plugin_config);
plugin_register_init(OVS_EVENTS_PLUGIN, ovs_events_plugin_init);
- plugin_register_complex_read(NULL, OVS_EVENTS_PLUGIN, ovs_events_plugin_read,
- 0, NULL);
plugin_register_shutdown(OVS_EVENTS_PLUGIN, ovs_events_plugin_shutdown);
}
projects / collectd.git / blobdiff