glusterd/snapshot : Provide enable/disable option for snapshot auto-delete feature.

This patch provides an interface to enable or disable
the auto-delete feature.
Syntax : gluster snapshot config auto-delete <enable/disable>

DETAILS :

1) When auto-delete feature is disabled, If the the soft-limit is
reached then user is given a warning about exceeding soft-limit
along with successful snapshot creation message (oldest snapshot is
not deleted). And upon reaching hard-limit further snapshot creation
is not allowed.

Example :
------------------------------------------------------------------
|Case - 1: Upon reaching soft-limit
|
|Snapshot create : snap successfully created.
|Warning : soft-limit of volume (vol) is reached. Snapshot creation
|is not possible once hard-limit is reached.
|
|-----------------------------------------------------
|Case - 2: Upon reaching hard-limit
|
|Snapshot create : snap creation failed.
|Error : hard-limit of volume (vol) is reached, Hence it is not
|possible to take further snapshots. Please delete few snapshots
|of the volume (vol) before taking another snapshot.
------------------------------------------------------------------

2) When auto-delete feature is enabled, then as soon as the soft-limit
is reached the oldest snapshot is deleted for every successful snapshot
creation (same as existing method), With this it is made sure that
number of snapshot created is not more than snap-max-hard-limit.

Change-Id: Ie3ca64bbd2c763371f541cd2e378314e73b695b4
BUG: 1105415
Signed-off-by: Sachin Pandit <spandit@redhat.com>
Reviewed-on: http://review.gluster.org/8017
Tested-by: Justin Clift <justin@gluster.org>
Reviewed-by: Rajesh Joseph <rjoseph@redhat.com>
Reviewed-by: Krishnan Parthasarathi <kparthas@redhat.com>
Tested-by: Krishnan Parthasarathi <kparthas@redhat.com>
Reviewed-by: Raghavendra Bhat <raghavendra@redhat.com>
Reviewed-by: Vijay Bellur <vbellur@redhat.com>

4 files changed, 226 insertions, 20 deletions

diff --git a/xlators/mgmt/glusterd/src/glusterd-snapshot.c b/xlators/mgmt/glusterd/src/glusterd-snapshot.c
index 456f23abe4b..af4cf171aff 100644
--- a/xlators/mgmt/glusterd/src/glusterd-snapshot.c
+++ b/xlators/mgmt/glusterd/src/glusterd-snapshot.c
@@ -203,7 +203,7 @@ out:
 
 int
 snap_max_limits_display_commit (dict_t *rsp_dict, char *volname,
-                                char *op_errstr)
+                                char *op_errstr, int len)
 {
         char                err_str[PATH_MAX]    = "";
         char                buf[PATH_MAX]        = "";
@@ -217,6 +217,7 @@ snap_max_limits_display_commit (dict_t *rsp_dict, char *volname,
         xlator_t           *this                 = NULL;
         uint64_t            opt_hard_max         = 0;
         uint64_t            opt_soft_max         = 0;
+        char               *auto_delete          = NULL;
 
         this = THIS;
 
@@ -312,8 +313,8 @@ snap_max_limits_display_commit (dict_t *rsp_dict, char *volname,
                 /*  For one volume */
                 ret = glusterd_volinfo_find (volname, &volinfo);
                 if (ret) {
-                        snprintf (err_str, PATH_MAX, "Failed to get the"
-                                   " volinfo for volume %s", volname);
+                        snprintf (err_str, PATH_MAX, "Volume (%s) does not "
+                                  "exist", volname);
                         goto out;
                 }
 
@@ -392,10 +393,30 @@ snap_max_limits_display_commit (dict_t *rsp_dict, char *volname,
                 goto out;
         }
 
+        ret = dict_get_str (conf->opts,
+                            GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                            &auto_delete);
+        if (ret) {
+                gf_log (this->name, GF_LOG_ERROR, "Failed to get "
+                        "%s from options",
+                        GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE);
+                goto out;
+        }
+
+        ret = dict_set_dynstr_with_alloc (rsp_dict,
+                                     GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                                     auto_delete);
+        if (ret) {
+                gf_log (this->name, GF_LOG_ERROR, "Failed to set "
+                        "%s in response dictionary",
+                        GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE);
+                goto out;
+        }
+
         ret = 0;
 out:
         if (ret) {
-                op_errstr = gf_strdup (err_str);
+                strncpy (op_errstr, err_str, len);
                 gf_log (this->name, GF_LOG_ERROR, "%s", err_str);
         }
         return ret;
@@ -1056,6 +1077,8 @@ glusterd_snapshot_config_prevalidate (dict_t *dict, char **op_errstr)
         uint64_t            soft_limit          = 0;
         gf_loglevel_t       loglevel            = GF_LOG_ERROR;
         uint64_t            max_limit           = GLUSTERD_SNAPS_MAX_HARD_LIMIT;
+        char               *req_auto_delete     = NULL;
+        char               *cur_auto_delete     = NULL;
 
         this = THIS;
 
@@ -1078,6 +1101,9 @@ glusterd_snapshot_config_prevalidate (dict_t *dict, char **op_errstr)
 
         ret = dict_get_uint64 (dict, "snap-max-soft-limit", &soft_limit);
 
+        ret = dict_get_str (dict, GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                           &req_auto_delete);
+
         ret = dict_get_str (dict, "volname", &volname);
 
         if (volname) {
@@ -1115,6 +1141,24 @@ glusterd_snapshot_config_prevalidate (dict_t *dict, char **op_errstr)
                         }
                         break;
                 }
+
+                if (req_auto_delete) {
+                        ret = dict_get_str (conf->opts,
+                                         GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                                         &cur_auto_delete);
+                        if (ret) {
+                                gf_log (this->name, GF_LOG_ERROR, "Failed to "
+                                        "get auto-delete value from options");
+                                goto out;
+                        }
+
+                        if (strcmp (req_auto_delete, cur_auto_delete) == 0) {
+                                ret = -1;
+                                snprintf (err_str, PATH_MAX, "auto-delete "
+                                          "is already %sd", req_auto_delete);
+                                goto out;
+                        }
+                }
         default:
                 break;
         }
@@ -1185,13 +1229,14 @@ glusterd_handle_snapshot_config (rpcsvc_request_t *req, glusterd_op_t op,
         case GF_SNAP_CONFIG_DISPLAY:
                 /* Reading data from local node only */
                 ret = snap_max_limits_display_commit (dict, volname,
-                                                      err_str);
+                                                      err_str, len);
                 if (ret) {
                         gf_log (this->name, GF_LOG_ERROR,
                                 "snap-max-limit "
                                 "display commit failed.");
                         goto out;
                 }
+
                 /* If everything is successful then send the response
                  * back to cli
                  */
@@ -1325,7 +1370,6 @@ glusterd_snap_create_pre_val_use_rsp_dict (dict_t *dst, dict_t *src)
                         brick_online = 0;
                 }
         }
-
         ret = 0;
 out:
 
@@ -1638,11 +1682,13 @@ glusterd_snapshot_create_prevalidate (dict_t *dict, char **op_errstr,
                         effective_max_limit = opt_hard_max;
 
                 if (volinfo->snap_count >= effective_max_limit) {
+                        ret = -1;
                         snprintf (err_str, sizeof (err_str),
                                   "The number of existing snaps has reached "
-                                  "the effective maximum limit of %"PRIu64" ,"
-                                  "for the volume %s", effective_max_limit,
-                                  volname);
+                                  "the effective maximum limit of %"PRIu64", "
+                                  "for the volume (%s). Please delete few "
+                                  "snapshots before taking further snapshots.",
+                                  effective_max_limit, volname);
                         loglevel = GF_LOG_WARNING;
                         goto out;
                 }
@@ -5133,6 +5179,17 @@ glusterd_snapshot_create_commit (dict_t *dict, char **op_errstr,
                         goto out;
                 }
 
+                if (is_origin_glusterd (dict)) {
+                        ret = glusterd_is_snap_soft_limit_reached (origin_vol,
+                                                                   rsp_dict);
+                        if (ret) {
+                                gf_log (this->name, GF_LOG_ERROR, "Failed to "
+                                        "check soft limit exceeded or not, "
+                                        "for volume %s ", origin_vol->volname);
+                                goto out;
+                        }
+                }
+
                 snap_vol = glusterd_do_snap_vol (origin_vol, snap, dict,
                                                  rsp_dict, i);
                 if (!snap_vol) {
@@ -5285,6 +5342,7 @@ glusterd_snapshot_config_commit (dict_t *dict, char **op_errstr,
         uint64_t            hard_limit           = 0;
         uint64_t            soft_limit           = 0;
         char               *next_version         = NULL;
+        char               *auto_delete          = NULL;
 
         this = THIS;
 
@@ -5312,6 +5370,9 @@ glusterd_snapshot_config_commit (dict_t *dict, char **op_errstr,
 
         ret = dict_get_uint64 (dict, "snap-max-soft-limit", &soft_limit);
 
+        ret = dict_get_str (dict, GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                            &auto_delete);
+
         switch (config_command) {
         case GF_SNAP_CONFIG_TYPE_SET:
                 if (hard_limit) {
@@ -5359,6 +5420,32 @@ glusterd_snapshot_config_commit (dict_t *dict, char **op_errstr,
                                 goto out;
                         }
                 }
+
+                if (auto_delete) {
+                        ret = glusterd_get_next_global_opt_version_str
+                                                (conf->opts, &next_version);
+                        if (ret) {
+                                gf_log (this->name, GF_LOG_ERROR, "Failed to "
+                                        "get next global opt-version");
+                                goto out;
+                        }
+
+                        ret = dict_set_dynstr_with_alloc (conf->opts,
+                                GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                                auto_delete);
+                        if (ret) {
+                                gf_log (this->name, GF_LOG_ERROR, "Could not "
+                                        "save auto-delete value in conf->opts");
+                                goto out;
+                        }
+
+                        ret = glusterd_store_options (this, conf->opts);
+                        if (ret) {
+                                gf_log (this->name, GF_LOG_ERROR, "Failed to "
+                                        "store options");
+                                goto out;
+                        }
+                }
                 break;
 
         default:
@@ -6096,19 +6183,19 @@ glusterd_handle_snap_limit (dict_t *dict, dict_t *rsp_dict)
                         goto out;
                 }
 
-                /* The minimum of the 2 limits i.e system wide limit and
-                   volume wide limit will be considered
-                */
-
                 ret = dict_get_uint64 (priv->opts,
                                        GLUSTERD_STORE_KEY_SNAP_MAX_HARD_LIMIT,
                                        &opt_max_hard);
                 if (ret) {
                         gf_log (this->name, GF_LOG_ERROR, "Failed to get "
-                                "%s", GLUSTERD_STORE_KEY_SNAP_MAX_HARD_LIMIT);
+                                "%s from opts dictionary",
+                                GLUSTERD_STORE_KEY_SNAP_MAX_HARD_LIMIT);
                         goto out;
                 }
 
+                /* The minimum of the 2 limits i.e system wide limit and
+                   volume wide limit will be considered
+                */
                 if (volinfo->snap_max_hard_limit < opt_max_hard)
                         effective_max_limit = volinfo->snap_max_hard_limit;
                 else
@@ -6170,6 +6257,7 @@ glusterd_snapshot_create_postvalidate (dict_t *dict, int32_t op_ret,
         int32_t          cleanup        = 0;
         glusterd_snap_t *snap           = NULL;
         char            *snapname       = NULL;
+        char            *auto_delete    = NULL;
 
         this = THIS;
 
@@ -6188,9 +6276,14 @@ glusterd_snapshot_create_postvalidate (dict_t *dict, int32_t op_ret,
                         if (ret) {
                                 gf_log (this->name, GF_LOG_WARNING, "cleanup "
                                         "operation failed");
-                                goto out;
                         }
                 }
+                /* Irrespective of status of cleanup its better
+                 * to return from this function. As the functions
+                 * following this block is not required to be
+                 * executed in case of failure scenario.
+                 */
+                goto out;
         }
 
         ret = dict_get_str (dict, "snapname", &snapname);
@@ -6224,8 +6317,17 @@ glusterd_snapshot_create_postvalidate (dict_t *dict, int32_t op_ret,
                 goto out;
         }
 
+        ret = dict_get_str (priv->opts, GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                           &auto_delete);
+        if (ret) {
+                gf_log (this->name, GF_LOG_ERROR, "Failed to get "
+                        "the value of auto-delete from options");
+                goto out;
+        }
+
         //ignore the errors of autodelete
-        ret = glusterd_handle_snap_limit (dict, rsp_dict);
+        if (strcmp (auto_delete, "enable") == 0)
+                ret = glusterd_handle_snap_limit (dict, rsp_dict);
 
         ret = 0;
 out:
diff --git a/xlators/mgmt/glusterd/src/glusterd-store.h b/xlators/mgmt/glusterd/src/glusterd-store.h
index dd5c6ec0dd7..ba3662bc7b2 100644
--- a/xlators/mgmt/glusterd/src/glusterd-store.h
+++ b/xlators/mgmt/glusterd/src/glusterd-store.h
@@ -69,6 +69,7 @@ typedef enum glusterd_store_ver_ac_{
 #define GLUSTERD_STORE_KEY_SNAP_STATUS          "status"
 #define GLUSTERD_STORE_KEY_SNAP_RESTORED        "snap-restored"
 #define GLUSTERD_STORE_KEY_SNAP_MAX_HARD_LIMIT  "snap-max-hard-limit"
+#define GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE     "auto-delete"
 #define GLUSTERD_STORE_KEY_SNAP_MAX_SOFT_LIMIT  "snap-max-soft-limit"
 
 #define GLUSTERD_STORE_KEY_BRICK_HOSTNAME       "hostname"
diff --git a/xlators/mgmt/glusterd/src/glusterd-utils.c b/xlators/mgmt/glusterd/src/glusterd-utils.c
index d79ff249535..776278ff6c3 100644
--- a/xlators/mgmt/glusterd/src/glusterd-utils.c
+++ b/xlators/mgmt/glusterd/src/glusterd-utils.c
@@ -10612,6 +10612,7 @@ glusterd_snap_create_use_rsp_dict (dict_t *dst, dict_t *src)
         int32_t        src_missed_snap_count    = -1;
         int32_t        dst_missed_snap_count    = -1;
         xlator_t      *this                     = NULL;
+        int8_t         soft_limit_flag          = -1;
 
         this = THIS;
         GF_ASSERT (this);
@@ -10629,6 +10630,18 @@ glusterd_snap_create_use_rsp_dict (dict_t *dst, dict_t *src)
                 goto out;
         }
 
+        /* set in dst dictionary soft-limit-reach only if soft-limit-reach
+         * is present src dictionary */
+        ret = dict_get_int8 (src, "soft-limit-reach", &soft_limit_flag);
+        if (!ret) {
+                ret = dict_set_int8 (dst, "soft-limit-reach", soft_limit_flag);
+                if (ret) {
+                        gf_log (this->name, GF_LOG_ERROR, "Failed to set "
+                                "soft_limit_flag");
+                        goto out;
+                }
+        }
+
         ret = dict_get_int32 (src, "missed_snap_count",
                               &src_missed_snap_count);
         if (ret) {
@@ -13433,10 +13446,11 @@ out:
 int32_t
 glusterd_check_and_set_config_limit (glusterd_conf_t *priv)
 {
-        int32_t         ret     =       -1;
-        xlator_t        *this   =       NULL;
-        uint64_t        hard_limit = 0;
-        uint64_t        soft_limit = 0;
+        int32_t         ret          = -1;
+        xlator_t        *this        = NULL;
+        uint64_t        hard_limit   = 0;
+        uint64_t        soft_limit   = 0;
+        char            *auto_delete = NULL;
 
         GF_ASSERT (priv);
         this = THIS;
@@ -13472,6 +13486,21 @@ glusterd_check_and_set_config_limit (glusterd_conf_t *priv)
                         goto out;
                 }
         }
+
+        ret = dict_get_str (priv->opts,
+                            GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                            &auto_delete);
+        if (ret) {
+                ret = dict_set_dynstr_with_alloc (priv->opts, "auto-delete",
+                                                  "disable");
+                if (ret) {
+                        gf_log (this->name, GF_LOG_ERROR, "Failed to store "
+                                "auto-delete value as disabled during "
+                                "glusterd init");
+                        goto out;
+                }
+        }
+
         ret = glusterd_store_options (this, priv->opts);
         if (ret) {
                 gf_log (this->name, GF_LOG_ERROR,
@@ -13481,3 +13510,73 @@ glusterd_check_and_set_config_limit (glusterd_conf_t *priv)
 out:
         return ret;
 }
+
+int32_t
+glusterd_is_snap_soft_limit_reached (glusterd_volinfo_t *volinfo, dict_t *dict)
+{
+        int32_t         ret                 = -1;
+        uint64_t        opt_max_hard        = 0;
+        uint64_t        opt_max_soft        = 0;
+        uint64_t        limit               = 0;
+        char            *auto_delete        = NULL;
+        uint64_t        effective_max_limit = 0;
+        xlator_t        *this               = NULL;
+        glusterd_conf_t *priv               = NULL;
+
+        GF_ASSERT (volinfo);
+        GF_ASSERT (dict);
+
+        this = THIS;
+        GF_ASSERT (this);
+        priv = this->private;
+        GF_ASSERT (priv);
+
+        ret = dict_get_uint64 (priv->opts,
+                               GLUSTERD_STORE_KEY_SNAP_MAX_HARD_LIMIT,
+                               &opt_max_hard);
+        if (ret) {
+                gf_log (this->name, GF_LOG_ERROR, "Failed to get "
+                        "%s", GLUSTERD_STORE_KEY_SNAP_MAX_HARD_LIMIT);
+                goto out;
+        }
+
+        if (volinfo->snap_max_hard_limit < opt_max_hard)
+                effective_max_limit = volinfo->snap_max_hard_limit;
+        else
+                effective_max_limit = opt_max_hard;
+
+        ret = dict_get_uint64 (priv->opts,
+                               GLUSTERD_STORE_KEY_SNAP_MAX_SOFT_LIMIT,
+                               &opt_max_soft);
+        if (ret) {
+                gf_log (this->name, GF_LOG_ERROR, "Failed to get "
+                        "%s from opts dictionary",
+                        GLUSTERD_STORE_KEY_SNAP_MAX_SOFT_LIMIT);
+                goto out;
+        }
+
+        ret = dict_get_str (priv->opts,
+                            GLUSTERD_STORE_KEY_SNAP_AUTO_DELETE,
+                            &auto_delete);
+        if (ret) {
+                gf_log (this->name, GF_LOG_ERROR, "Failed to get "
+                        "auto-delete from options dictionary");
+                goto out;
+        }
+
+        limit = (opt_max_soft * effective_max_limit)/100;
+
+        if (volinfo->snap_count >= limit &&
+                (strcmp (auto_delete, "enable") != 0)) {
+                ret = dict_set_int8 (dict, "soft-limit-reach",
+                                     _gf_true);
+                if (ret) {
+                        gf_log (this->name, GF_LOG_ERROR, "Failed to "
+                                "set soft limit exceed flag in "
+                                "response dictionary");
+                }
+                goto out;
+        }
+out :
+        return ret;
+}
diff --git a/xlators/mgmt/glusterd/src/glusterd-utils.h b/xlators/mgmt/glusterd/src/glusterd-utils.h
index 2d7c4269d34..9e0400cf86a 100644
--- a/xlators/mgmt/glusterd/src/glusterd-utils.h
+++ b/xlators/mgmt/glusterd/src/glusterd-utils.h
@@ -893,5 +893,9 @@ glusterd_restart_snapds (glusterd_conf_t *priv);
 
 int32_t
 glusterd_check_and_set_config_limit (glusterd_conf_t *priv);
+
+int32_t
+glusterd_is_snap_soft_limit_reached (glusterd_volinfo_t *volinfo,
+                                     dict_t *dict);
 /* End snapd functions */
 #endif