X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fovs_events.c;h=afa11997cfc3a1ec8fadd50a29db39c1d0ecd7b3;hb=e746ad785774de37a30302fef65f1c4aaf8698ab;hp=d9735913af77a8386b9945c58d5c7efcacf49d69;hpb=39035180c502a9a609c92946226459b49fe0fbe8;p=collectd.git diff --git a/src/ovs_events.c b/src/ovs_events.c index d9735913..afa11997 100644 --- a/src/ovs_events.c +++ b/src/ovs_events.c @@ -3,14 +3,17 @@ * * 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 @@ -25,6 +28,8 @@ * Volodymyr Mytnyk **/ +#include "collectd.h" + #include "common.h" /* auxiliary functions */ #include "utils_ovs.h" /* OVS helpers */ @@ -33,15 +38,9 @@ #define OVS_EVENTS_IFACE_UUID_SIZE 64 #define OVS_EVENTS_EXT_IFACE_ID_SIZE 64 #define OVS_EVENTS_EXT_VM_UUID_SIZE 64 -#define OVS_EVENTS_OVS_DB_URL_SIZE 64 #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 }; @@ -67,9 +66,11 @@ typedef struct ovs_events_iface_list_s ovs_events_iface_list_t; /* OVS events configuration data */ struct ovs_events_config_s { - _Bool send_notification; /* sent notification to collectd? */ - char ovs_db_server_url[OVS_EVENTS_OVS_DB_URL_SIZE]; /* OVS DB server URL */ - ovs_events_iface_list_t *ifaces; /* interface info */ + _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_events_iface_list_t *ifaces; /* interface info */ }; typedef struct ovs_events_config_s ovs_events_config_t; @@ -88,28 +89,28 @@ typedef struct ovs_events_ctx_s ovs_events_ctx_t; */ static ovs_events_ctx_t ovs_events_ctx = { .mutex = PTHREAD_MUTEX_INITIALIZER, - .config = {.send_notification = 0, /* do not send notification */ - .ovs_db_server_url = - "tcp:127.0.0.1:6640", /* use default OVS DB URL */ - .ifaces = NULL}, - .ovs_db_select_params = NULL, - .is_db_available = 0, - .ovs_db = NULL}; + .config = {.send_notification = 1, /* 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 inline int ovs_events_ctx_lock() { +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). * It always returns 0 when context is unlocked. */ -static inline int ovs_events_ctx_unlock() { +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 @@ -123,7 +124,8 @@ static int ovs_events_config_iface_exists(const char *ifname) { /* check if given interface exists */ for (ovs_events_iface_list_t *iface = ovs_events_ctx.config.ifaces; iface; iface = iface->next) - return (strcmp(ifname, iface->name) == 0); + if (strcmp(ifname, iface->name) == 0) + return 1; return 0; } @@ -131,56 +133,58 @@ static int ovs_events_config_iface_exists(const char *ifname) { /* Get OVS DB select parameter request based on rfc7047, * "Transact" & "Select" section */ -static inline char *ovs_events_get_select_params() { - int ret = 0; +static char *ovs_events_get_select_params() { size_t buff_size = 0; - size_t offset = 0; - char *buff = NULL; - char *new_buff = NULL; - const char params_fmt[] = "[\"Open_vSwitch\"%s]"; - const char option_fmt[] = ",{\"op\":\"select\",\"table\":\"Interface\"," - "\"where\":[[\"name\",\"==\",\"%s\"]]," - "\"columns\":[\"link_state\",\"external_ids\"," - "\"name\",\"_uuid\"]}"; - const char default_opt[] = ",{\"op\":\"select\",\"table\":\"Interface\"," - "\"where\":[],\"columns\":[\"link_state\"," - "\"external_ids\",\"name\",\"_uuid\"]}"; + size_t buff_off = 0; + char *opt_buff = NULL; + static const char params_fmt[] = "[\"Open_vSwitch\"%s]"; + static const char option_fmt[] = + ",{\"op\":\"select\",\"table\":\"Interface\"," + "\"where\":[[\"name\",\"==\",\"%s\"]]," + "\"columns\":[\"link_state\",\"external_ids\"," + "\"name\",\"_uuid\"]}"; + static const char default_opt[] = + ",{\"op\":\"select\",\"table\":\"Interface\"," + "\"where\":[],\"columns\":[\"link_state\"," + "\"external_ids\",\"name\",\"_uuid\"]}"; /* setup OVS DB interface condition */ for (ovs_events_iface_list_t *iface = ovs_events_ctx.config.ifaces; iface; - iface = iface->next, offset += ret) { + iface = iface->next) { /* allocate new buffer (format size + ifname len is good enough) */ - buff_size += (sizeof(option_fmt) + strlen(iface->name)); - new_buff = realloc(buff, buff_size); - if (new_buff == NULL) - goto failure; - buff = new_buff; - ret = ssnprintf(buff + offset, buff_size, option_fmt, iface->name); - if (ret < 0) - goto failure; + buff_size += sizeof(option_fmt) + strlen(iface->name); + char *new_buff = realloc(opt_buff, buff_size); + if (new_buff == NULL) { + sfree(opt_buff); + return NULL; + } + opt_buff = new_buff; + int ret = snprintf(opt_buff + buff_off, buff_size - buff_off, option_fmt, + iface->name); + if (ret < 0) { + sfree(opt_buff); + return NULL; + } + buff_off += ret; } /* if no interfaces are configured, use default params */ - if (buff == NULL) { - buff = strdup(default_opt); - offset = strlen(default_opt); - } + if (opt_buff == NULL) + if ((opt_buff = strdup(default_opt)) == NULL) + return NULL; /* allocate memory for OVS DB select params */ - buff_size = offset + sizeof(params_fmt); - new_buff = malloc(buff_size); - if (new_buff == NULL) - goto failure; + size_t params_size = sizeof(params_fmt) + strlen(opt_buff); + char *params_buff = calloc(1, params_size); + if (params_buff == NULL) { + sfree(opt_buff); + return NULL; + } /* create OVS DB select params */ - if (ssnprintf(new_buff, buff_size, params_fmt, buff) < 0) - goto failure; + if (snprintf(params_buff, params_size, params_fmt, opt_buff) < 0) + sfree(params_buff); - sfree(buff); - return new_buff; - -failure: - sfree(new_buff); - sfree(buff); - return NULL; + sfree(opt_buff); + return params_buff; } /* Release memory allocated for configuration data */ @@ -194,56 +198,100 @@ static void ovs_events_config_free() { } } +/* 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 = 0; 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); - } else if (strcasecmp("OvsDbServerUrl", child->key) == 0) { + if (cf_util_get_boolean(child, + &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_server_url, - sizeof(ovs_events_ctx.config.ovs_db_server_url)) < 0) - OVS_EVENTS_CONFIG_ERROR(child->key); + child, ovs_events_ctx.config.ovs_db_node, + sizeof(ovs_events_ctx.config.ovs_db_node)) != 0) { + ovs_events_config_free(); + return -1; + } + } else if (strcasecmp("Port", child->key) == 0) { + char *service = NULL; + if (cf_util_get_service(child, &service) != 0) { + ovs_events_config_free(); + return -1; + } + strncpy(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_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 */ @@ -274,24 +322,26 @@ ovs_events_dispatch_notification(const ovs_events_iface_info_t *ifinfo) { 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)); @@ -352,12 +402,15 @@ static int ovs_events_get_iface_info(yajl_val jobject, /* check YAJL type */ if (!YAJL_IS_OBJECT(jobject)) - return (-1); + return -1; + + /* zero the interface info structure */ + memset(ifinfo, 0, sizeof(*ifinfo)); /* 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; /* get iface-id from external_ids field */ jvalue = ovs_utils_get_map_value(jexternal_ids, "iface-id"); @@ -375,16 +428,16 @@ static int ovs_events_get_iface_info(yajl_val jobject, 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 */ @@ -396,7 +449,7 @@ static int ovs_events_get_iface_info(yajl_val jobject, 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) @@ -439,7 +492,7 @@ static void ovs_events_table_update_cb(yajl_val jupdates) { 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]; @@ -455,15 +508,18 @@ static void ovs_events_table_update_cb(yajl_val jupdates) { " :unexpected interface information data received"); return; } - if (ovs_events_config_iface_exists(ifinfo.name) != 0) + if (ovs_events_config_iface_exists(ifinfo.name) != 0) { + DEBUG("name=%s, uuid=%s, ext_iface_id=%s, ext_vm_uuid=%s", ifinfo.name, + ifinfo.uuid, ifinfo.ext_iface_id, ifinfo.ext_vm_uuid); /* dispatch notification */ ovs_events_dispatch_notification(&ifinfo); + } } } -/* OVD DB reply callback. It parses reply, receives +/* OVS DB reply callback. It parses reply, receives * interface information and dispatches the info to - * collecd + * collectd */ static void ovs_events_poll_result_cb(yajl_val jresult, yajl_val jerror) { yajl_val *jvalues = NULL; @@ -483,15 +539,14 @@ static void ovs_events_poll_result_cb(yajl_val jresult, yajl_val jerror) { /* 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++) { - memset(&ifinfo, 0, sizeof(ifinfo)); + 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 @@ -509,22 +564,21 @@ static void ovs_events_poll_result_cb(yajl_val jresult, yajl_val jerror) { * to receive link status event(s). */ static void ovs_events_conn_initialize(ovs_db_t *pdb) { - int ret = 0; const char tb_name[] = "Interface"; const char *columns[] = {"_uuid", "external_ids", "name", "link_state", NULL}; /* register update link status event if needed */ if (ovs_events_ctx.config.send_notification) { - ret = ovs_db_table_cb_register(pdb, tb_name, columns, - ovs_events_table_update_cb, NULL, - OVS_DB_TABLE_CB_FLAG_MODIFY); + int ret = ovs_db_table_cb_register(pdb, tb_name, columns, + ovs_events_table_update_cb, NULL, + OVS_DB_TABLE_CB_FLAG_MODIFY); if (ret < 0) { ERROR(OVS_EVENTS_PLUGIN ": register OVS DB update callback failed"); return; } } OVS_EVENTS_CTX_LOCK { ovs_events_ctx.is_db_available = 1; } - DEBUG(OVS_EVENTS_PLUGIN ": OVS DB has been initialized"); + DEBUG(OVS_EVENTS_PLUGIN ": OVS DB connection has been initialized"); } /* OVS DB terminate connection notification callback */ @@ -545,9 +599,9 @@ static int ovs_events_plugin_read(__attribute__((unused)) user_data_t *u) { 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 */ @@ -556,8 +610,9 @@ static int ovs_events_plugin_init(void) { ovs_db_callback_t cb = {.post_conn_init = ovs_events_conn_initialize, .post_conn_terminate = ovs_events_conn_terminate}; - DEBUG(OVS_EVENTS_PLUGIN ": OVS DB url = %s", - ovs_events_ctx.config.ovs_db_server_url); + DEBUG(OVS_EVENTS_PLUGIN ": OVS DB address=%s, service=%s, unix=%s", + ovs_events_ctx.config.ovs_db_node, ovs_events_ctx.config.ovs_db_serv, + ovs_events_ctx.config.ovs_db_unix); /* generate OVS DB select condition based on list on configured interfaces */ ovs_events_ctx.ovs_db_select_params = ovs_events_get_select_params(); @@ -567,7 +622,9 @@ static int ovs_events_plugin_init(void) { } /* initialize OVS DB */ - ovs_db = ovs_db_init(ovs_events_ctx.config.ovs_db_server_url, &cb); + ovs_db = ovs_db_init(ovs_events_ctx.config.ovs_db_node, + ovs_events_ctx.config.ovs_db_serv, + ovs_events_ctx.config.ovs_db_unix, &cb); if (ovs_db == NULL) { ERROR(OVS_EVENTS_PLUGIN ": fail to connect to OVS DB server"); goto ovs_events_failure; @@ -577,13 +634,13 @@ static int ovs_events_plugin_init(void) { 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 */ @@ -596,14 +653,12 @@ static int ovs_events_plugin_shutdown(void) { 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); }