From c6352056af8055701d0895e159d10e4a3fcdd3d0 Mon Sep 17 00:00:00 2001 From: Avra Sengupta Date: Fri, 26 Aug 2016 14:05:07 +0530 Subject: snapshot/eventsapi: Integrate snapshot events with eventsapi Backport of http://review.gluster.org/#/c/15329/ 1. EVENT_SNAPSHOT_CREATED : snapshot_name=snap1 volume_name=test_vol snapshot_uuid=26dd6c52-6021-40b1-a507-001a80401d70 2. EVENT_SNAPSHOT_CREATE_FAILED : snapshot_name=snap1 volume_name=test_vol error=Snapshot snap1 already exists 3. EVENT_SNAPSHOT_ACTIVATED : snapshot_name=snap1 snapshot_uuid=26dd6c52-6021-40b1-a507-001a80401d70 4. EVENT_SNAPSHOT_ACTIVATE_FAILED: snapshot_name=snap1 error=Snapshot snap1 is already activated. 5. EVENT_SNAPSHOT_DEACTIVATED : snapshot_name=snap1 snapshot_uuid=26dd6c52-6021-40b1-a507-001a80401d70 6. EVENT_SNAPSHOT_DEACTIVATE_FAILED : snapshot_name=snap3 error=Snapshot (snap3) does not exist. 7. EVENT_SNAPSHOT_SOFT_LIMIT_REACHED : volume_name=test_vol volume_id=2ace2616-5591-4b9b-be2a-38592dda5758 8. EVENT_SNAPSHOT_HARD_LIMIT_REACHED : volume_name=test_vol volume_id=2ace2616-5591-4b9b-be2a-38592dda5758 9. EVENT_SNAPSHOT_RESTORED : snapshot_name=snap1 volume_name=test_vol snapshot_uuid=3a840ec5-08da-4f2b-850d-1d5539a5d14d 10. EVENT_SNAPSHOT_RESTORE_FAILED : snapshot_name=snap10 error=Snapshot (snap10) does not exist 11. EVENT_SNAPSHOT_DELETED : snapshot_name=snap1 snapshot_uuid=d9ff3d4f-f579-4345-a4da-4f9353f0950c 12. EVENT_SNAPSHOT_DELETE_FAILED : snapshot_name=snap2 error=Snapshot (snap2) does not exist 13. EVENT_SNAPSHOT_CLONED : clone_uuid=93ba9f06-cb9c-4ace-aa52-2616e7f31022 snapshot_name=snap1 clone_name=clone2 14. EVENT_SNAPSHOT_CLONE_FAILED : snapshot_name=snap1 clone_name=clone2 error=Volume with name:clone2 already exists 15. EVENT_SNAPSHOT_CONFIG_UPDATED : auto-delete=enable config_type=system_config config_type=volume_config hard_limit=100 16. EVENT_SNAPSHOT_CONFIG_UPDATE_FAILED : error=Invalid snap-max-soft-limit 110. Expected range 1 - 100 17. EVENT_SNAPSHOT_SCHEDULER_INITIALISED : status=Success 18. EVENT_SNAPSHOT_SCHEDULER_INIT_FAILED 19. EVENT_SNAPSHOT_SCHEDULER_ENABLED : status=Successfuly Enabled 20. EVENT_SNAPSHOT_SCHEDULER_ENABLE_FAILED : error=Snapshot scheduler is already enabled. 21. EVENT_SNAPSHOT_SCHEDULER_SCHEDULE_ADDED : status=Successfuly added job job1 22. EVENT_SNAPSHOT_SCHEDULER_SCHEDULE_ADD_FAILED : status=Failed to add job job1 error=The job already exists. 23. EVENT_SNAPSHOT_SCHEDULER_SCHEDULE_EDITED : status=Successfuly edited job job1 24. EVENT_SNAPSHOT_SCHEDULER_SCHEDULE_EDIT_FAILED : status=Failed to edit job job2 error=The job cannot be found. 25. EVENT_SNAPSHOT_SCHEDULER_SCHEDULE_DELETED : status=Successfuly deleted job job1 26. EVENT_SNAPSHOT_SCHEDULER_SCHEDULE_DELETE_FAILED : status=Failed to delete job job1 error=The job cannot be found. 27. EVENT_SNAPSHOT_SCHEDULER_DISABLED : status=Successfuly Disabled 28. EVENT_SNAPSHOT_SCHEDULER_DISABLE_FAILED : error=Snapshot scheduler is already disabled. > Reviewed-on: http://review.gluster.org/15329 > Tested-by: Aravinda VK > Smoke: Gluster Build System > NetBSD-regression: NetBSD Build System > CentOS-regression: Gluster Build System > Reviewed-by: Rajesh Joseph (cherry picked from commit c1278de9a5fb6a64455f42b8b17a8d05b74c2420) Change-Id: I3479cc3fb7af3c76ded67cf289f99547d0a55d21 BUG: 1372278 Signed-off-by: Avra Sengupta Reviewed-on: http://review.gluster.org/15381 NetBSD-regression: NetBSD Build System CentOS-regression: Gluster Build System Smoke: Gluster Build System Reviewed-by: Atin Mukherjee --- cli/src/cli-rpc-ops.c | 384 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 355 insertions(+), 29 deletions(-) (limited to 'cli') diff --git a/cli/src/cli-rpc-ops.c b/cli/src/cli-rpc-ops.c index 12f54f61f23..d683457ed25 100644 --- a/cli/src/cli-rpc-ops.c +++ b/cli/src/cli-rpc-ops.c @@ -40,6 +40,7 @@ #include "cli-quotad-client.h" #include "run.h" #include "quota-common-utils.h" +#include "events.h" enum gf_task_types { GF_TASK_TYPE_REBALANCE, @@ -10317,6 +10318,334 @@ out: return ret; } +int +gf_cli_generate_snapshot_event (gf_cli_rsp *rsp, dict_t *dict, + int32_t type, char *snap_name, + char *volname, char *snap_uuid, + char *clone_name) +{ + int ret = -1; + int config_command = 0; + int32_t delete_cmd = -1; + uint64_t hard_limit = 0; + uint64_t soft_limit = 0; + char *auto_delete = NULL; + char *snap_activate = NULL; + char msg[PATH_MAX] = {0, }; + char option[PATH_MAX] = {0, }; + + GF_VALIDATE_OR_GOTO ("cli", dict, out); + GF_VALIDATE_OR_GOTO ("cli", rsp, out); + + switch (type) { + case GF_SNAP_OPTION_TYPE_CREATE: + if (!snap_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get snap name"); + goto out; + } + + if (!volname) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get volume name"); + goto out; + } + + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_CREATE_FAILED, + "snapshot_name=%s;volume_name=%s;error=%s", + snap_name, volname, + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + if (!snap_uuid) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get snap uuid"); + goto out; + } + + gf_event (EVENT_SNAPSHOT_CREATED, "snapshot_name=%s;" + "volume_name=%s;snapshot_uuid=%s", snap_name, + volname, snap_uuid); + + ret = 0; + break; + + case GF_SNAP_OPTION_TYPE_ACTIVATE: + if (!snap_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get snap name"); + goto out; + } + + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_ACTIVATE_FAILED, + "snapshot_name=%s;error=%s", snap_name, + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + if (!snap_uuid) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get snap uuid"); + goto out; + } + + gf_event (EVENT_SNAPSHOT_ACTIVATED, "snapshot_name=%s;" + "snapshot_uuid=%s", snap_name, snap_uuid); + + ret = 0; + break; + + case GF_SNAP_OPTION_TYPE_DEACTIVATE: + if (!snap_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get snap name"); + goto out; + } + + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_DEACTIVATE_FAILED, + "snapshot_name=%s;error=%s", snap_name, + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + if (!snap_uuid) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get snap uuid"); + goto out; + } + + gf_event (EVENT_SNAPSHOT_DEACTIVATED, "snapshot_name=%s;" + "snapshot_uuid=%s", snap_name, snap_uuid); + + ret = 0; + break; + + case GF_SNAP_OPTION_TYPE_RESTORE: + if (!snap_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get snap name"); + goto out; + } + + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_RESTORE_FAILED, + "snapshot_name=%s;error=%s", snap_name, + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + if (!snap_uuid) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get snap uuid"); + goto out; + } + + if (!volname) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get volname"); + goto out; + } + + gf_event (EVENT_SNAPSHOT_RESTORED, "snapshot_name=%s;" + "snapshot_uuid=%s;volume_name=%s", + snap_name, snap_uuid, volname); + + ret = 0; + break; + + case GF_SNAP_OPTION_TYPE_DELETE: + ret = dict_get_int32 (dict, "sub-cmd", &delete_cmd); + if (ret) { + gf_log ("cli", GF_LOG_ERROR, "Could not get sub-cmd"); + goto out; + } + + /* + * Need not generate any event (success or failure) for delete * + * all, as it will trigger individual delete for all snapshots * + */ + if (delete_cmd == GF_SNAP_DELETE_TYPE_ALL) { + ret = 0; + break; + } + + if (!snap_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get snap name"); + goto out; + } + + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_DELETE_FAILED, + "snapshot_name=%s;error=%s", snap_name, + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + if (!snap_uuid) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get snap uuid"); + goto out; + } + + gf_event (EVENT_SNAPSHOT_DELETED, "snapshot_name=%s;" + "snapshot_uuid=%s", snap_name, snap_uuid); + + ret = 0; + break; + + case GF_SNAP_OPTION_TYPE_CLONE: + if (!clone_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get clone name"); + goto out; + } + + if (!snap_name) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to get snapname name"); + goto out; + } + + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_CLONE_FAILED, + "snapshot_name=%s;clone_name=%s;" + "error=%s", snap_name, clone_name, + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + if (!snap_uuid) { + gf_log ("cli", GF_LOG_ERROR, "Failed to get snap uuid"); + goto out; + } + + gf_event (EVENT_SNAPSHOT_CLONED, "snapshot_name=%s;" + "clone_name=%s;clone_uuid=%s", + snap_name, clone_name, snap_uuid); + + ret = 0; + break; + + case GF_SNAP_OPTION_TYPE_CONFIG: + if (rsp->op_ret != 0) { + gf_event (EVENT_SNAPSHOT_CONFIG_UPDATE_FAILED, + "error=%s", + rsp->op_errstr ? rsp->op_errstr : + "Please check log file for details"); + ret = 0; + break; + } + + ret = dict_get_int32 (dict, "config-command", &config_command); + if (ret) { + gf_log ("cli", GF_LOG_ERROR, + "Could not fetch config type"); + goto out; + } + + if (config_command == GF_SNAP_CONFIG_DISPLAY) { + ret = 0; + break; + } + + /* These are optional parameters therefore ignore the error */ + ret = dict_get_uint64 (dict, "snap-max-hard-limit", + &hard_limit); + ret = dict_get_uint64 (dict, "snap-max-soft-limit", + &soft_limit); + ret = dict_get_str (dict, "auto-delete", + &auto_delete); + ret = dict_get_str (dict, "snap-activate-on-create", + &snap_activate); + + if (!hard_limit && !soft_limit && + !auto_delete && !snap_activate) { + ret = -1; + gf_log ("cli", GF_LOG_ERROR, "At least one option from " + "snap-max-hard-limit, snap-max-soft-limit, " + "auto-delete and snap-activate-on-create " + "should be set"); + goto out; + } + + volname = NULL; + ret = dict_get_str (dict, "volname", &volname); + + if (hard_limit || soft_limit) { + snprintf (option, sizeof(option), "%s=%"PRIu64, + hard_limit ? "hard_limit" : "soft_limit", + hard_limit ? hard_limit:soft_limit); + } else if (auto_delete || snap_activate) { + snprintf (option, sizeof(option), "%s=%s", + auto_delete ? "auto-delete" : "snap-activate", + auto_delete ? auto_delete:snap_activate); + } + + snprintf (msg, sizeof(msg), "config_type=%s;%s", + volname?"volume_config":"system_config", option); + + gf_event (EVENT_SNAPSHOT_CONFIG_UPDATED, "%s", msg); + + ret = 0; + break; + + default: + gf_log ("cli", GF_LOG_WARNING, + "Cannot generate event for unknown type."); + ret = 0; + goto out; + } + +out: + return ret; +} + +/* + * Fetch necessary data from dict at one place instead of * + * repeating the same code again and again. * + */ +int +gf_cli_snapshot_get_data_from_dict (dict_t *dict, char **snap_name, + char **volname, char **snap_uuid, + int8_t *soft_limit_flag, + char **clone_name) +{ + int ret = -1; + + GF_VALIDATE_OR_GOTO ("cli", dict, out); + + if (snap_name) + ret = dict_get_str (dict, "snapname", snap_name); + + if (volname) + ret = dict_get_str (dict, "volname1", volname); + + if (snap_uuid) + ret = dict_get_str (dict, "snapuuid", snap_uuid); + + if (soft_limit_flag) + ret = dict_get_int8 (dict, "soft-limit-reach", + soft_limit_flag); + + if (clone_name) + ret = dict_get_str (dict, "clonename", clone_name); + + ret = 0; +out: + return ret; +} + int gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, int count, void *myframe) @@ -10331,6 +10660,7 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, gf_boolean_t snap_driven = _gf_false; int8_t soft_limit_flag = -1; char *volname = NULL; + char *snap_uuid = NULL; GF_ASSERT (myframe); @@ -10365,6 +10695,24 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, goto out; } + ret = gf_cli_snapshot_get_data_from_dict (dict, &snap_name, &volname, + &snap_uuid, &soft_limit_flag, + &clone_name); + if (ret) { + gf_log ("cli", GF_LOG_ERROR, "Failed to fetch data from dict."); + goto out; + } + +#if (USE_EVENTS) + ret = gf_cli_generate_snapshot_event (&rsp, dict, type, snap_name, + volname, snap_uuid, clone_name); + if (ret) { + gf_log ("cli", GF_LOG_ERROR, + "Failed to generate snapshot event"); + goto out; + } +#endif + /* Snapshot status and delete command is handled separately */ if (global_state->mode & GLUSTER_MODE_XML && GF_SNAP_OPTION_TYPE_STATUS != type && @@ -10388,19 +10736,13 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, goto out; } - ret = dict_get_str (dict, "snapname", &snap_name); - if (ret) { + if (!snap_name) { gf_log ("cli", GF_LOG_ERROR, "Failed to get snap name"); goto out; } - /* TODO : Instead of using volname1 directly use - * volname$i in loop once snapshot of multiple - * volumes are supported - */ - ret = dict_get_str (dict, "volname1", &volname); - if (ret) { + if (!volname) { gf_log ("cli", GF_LOG_ERROR, "Failed to get volume name"); goto out; @@ -10409,8 +10751,6 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, cli_out ("snapshot create: success: Snap %s created " "successfully", snap_name); - ret = dict_get_int8 (dict, "soft-limit-reach", - &soft_limit_flag); if (soft_limit_flag == 1) { cli_out ("Warning: Soft-limit of volume (%s) is " "reached. Snapshot creation is not possible " @@ -10428,15 +10768,13 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, goto out; } - ret = dict_get_str (dict, "clonename", &clone_name); - if (ret) { + if (!clone_name) { gf_log ("cli", GF_LOG_ERROR, "Failed to get clone name"); goto out; } - ret = dict_get_str (dict, "snapname", &snap_name); - if (ret) { + if (!snap_name) { gf_log ("cli", GF_LOG_ERROR, "Failed to get snapname name"); goto out; @@ -10449,9 +10787,6 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, break; case GF_SNAP_OPTION_TYPE_RESTORE: - /* TODO: Check if rsp.op_ret needs to be checked here. Or is - * it ok to check this in the start of the function where we - * get rsp.*/ if (rsp.op_ret) { cli_err("snapshot restore: failed: %s", rsp.op_errstr ? rsp.op_errstr : @@ -10460,8 +10795,7 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, goto out; } - ret = dict_get_str (dict, "snapname", &snap_name); - if (ret) { + if (!snap_name) { gf_log ("cli", GF_LOG_ERROR, "Failed to get snap name"); goto out; @@ -10473,9 +10807,6 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, ret = 0; break; case GF_SNAP_OPTION_TYPE_ACTIVATE: - /* TODO: Check if rsp.op_ret needs to be checked here. Or is - * it ok to check this in the start of the function where we - * get rsp.*/ if (rsp.op_ret) { cli_err("snapshot activate: failed: %s", rsp.op_errstr ? rsp.op_errstr : @@ -10484,8 +10815,7 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, goto out; } - ret = dict_get_str (dict, "snapname", &snap_name); - if (ret) { + if (!snap_name) { gf_log ("cli", GF_LOG_ERROR, "Failed to get snap name"); goto out; @@ -10498,9 +10828,6 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, break; case GF_SNAP_OPTION_TYPE_DEACTIVATE: - /* TODO: Check if rsp.op_ret needs to be checked here. Or is - * it ok to check this in the start of the function where we - * get rsp.*/ if (rsp.op_ret) { cli_err("snapshot deactivate: failed: %s", rsp.op_errstr ? rsp.op_errstr : @@ -10509,8 +10836,7 @@ gf_cli_snapshot_cbk (struct rpc_req *req, struct iovec *iov, goto out; } - ret = dict_get_str (dict, "snapname", &snap_name); - if (ret) { + if (!snap_name) { gf_log ("cli", GF_LOG_ERROR, "Failed to get snap name"); goto out; -- cgit