features/locks: Add lock revocation functionality to posix locks translator

Summary:
- Motivation: Prevents cluster instability by mis-behaving clients
  causing bricks to OOM due to inode/entry lock pile-ups.
- Adds option to strip clients of entry/inode locks after N seconds
- Adds option to clear ALL locks should the revocation threshold get hit
- Adds option to clear all or granted locks should the max-blocked
  threshold get hit (can be used in combination w/ revocation-clear-all).
- Options are:
    features.locks-revocation-secs <integer; 0 to disable>
    features.locks-revocation-clear-all [on/off]
    features.locks-revocation-max-blocked <integer>
- Adds monkey-locking option to ignore 1% of unlock requests (dev only)
    features.locks-monkey-unlocking [on/off]
- Adds logging to indicate revocation event & reason

Test Plan:
First you will need TWO fuse mounts for this repro.  Call them /mnt/patchy1 & /mnt/patchy2.

1. Enable monkey unlocking on the volume:
gluster vol set patchy features.locks-monkey-unlocking on

2. From the "patchy1", use DD or some other utility to begin writing to a file,
   eventually the dd will hang due to the dropped unlocked requests.  This now
   simulates the broken client.  Run:

for i in {1..1000};do dd if=/dev/zero of=/mnt/patchy1/testfile bs=1k count=10;done'

...this will eventually hang as the unlock request has been lost.

3. Goto another window and setup the mount "patchy2" @ /mnt/patchy2, and
   observe that 'echo "hello" >> /mnt/patchy2/testfile" will hang due to the
   inability of the client to take out the required lock.

4. Next, re-start the test this time enabling lock revocation; use a timeout of
   2-5 seconds for testing:
   'gluster vol set patchy features.locks-revocation-secs <2-5>'

5. Wait 2-5 seconds before executing step 3 above this time.  Observe that this
   time the access to the file will succeed, and the writes on patchy1 will
   unblock until they hit another failed unlock request due to
   "monkey-unlocking".

BUG: 1350867
Change-Id: I814b9f635fec53834a26db634d1300d9a61057d8
Signed-off-by: Pranith Kumar K <pkarampu@redhat.com>
Reviewed-on: http://review.gluster.org/14816
NetBSD-regression: NetBSD Build System <jenkins@build.gluster.org>
Reviewed-by: Krutika Dhananjay <kdhananj@redhat.com>
CentOS-regression: Gluster Build System <jenkins@build.gluster.org>
Smoke: Gluster Build System <jenkins@build.gluster.org>

1 files changed, 56 insertions, 0 deletions

diff --git a/xlators/features/locks/src/posix.c b/xlators/features/locks/src/posix.c
index dff17e70aaf..8a142c9991a 100644
--- a/xlators/features/locks/src/posix.c
+++ b/xlators/features/locks/src/posix.c
@@ -3628,7 +3628,21 @@ reconfigure (xlator_t *this, dict_t *options)
 
         GF_OPTION_RECONF ("trace", priv->trace, options, bool, out);
 
+        GF_OPTION_RECONF ("monkey-unlocking", priv->monkey_unlocking, options,
+                          bool, out);
+
+        GF_OPTION_RECONF ("revocation-secs",
+                          priv->revocation_secs, options,
+                          uint32, out);
+
+        GF_OPTION_RECONF ("revocation-clear-all", priv->revocation_clear_all,
+                          options, bool, out);
+
+        GF_OPTION_RECONF ("revocation-max-blocked",
+                          priv->revocation_max_blocked, options,
+                          uint32, out);
         ret = 0;
+
 out:
         return ret;
 }
@@ -3679,6 +3693,18 @@ init (xlator_t *this)
 
         GF_OPTION_INIT ("trace", priv->trace, bool, out);
 
+        GF_OPTION_INIT ("monkey-unlocking", priv->monkey_unlocking,
+                        bool, out);
+
+        GF_OPTION_INIT ("revocation-secs", priv->revocation_secs,
+                        uint32, out);
+
+        GF_OPTION_INIT ("revocation-clear-all", priv->revocation_clear_all,
+                        bool, out);
+
+        GF_OPTION_INIT ("revocation-max-blocked", priv->revocation_max_blocked,
+                        uint32, out);
+
         this->local_pool = mem_pool_new (pl_local_t, 32);
         if (!this->local_pool) {
                 ret = -1;
@@ -3935,5 +3961,35 @@ struct volume_options options[] = {
           .description = "Trace the different lock requests "
                          "to logs."
         },
+        { .key  = { "monkey-unlocking" },
+          .type = GF_OPTION_TYPE_BOOL,
+          .default_value = "false",
+          .description = "Ignore a random number of unlock requests.  Useful "
+                         "for testing/creating robust lock recovery mechanisms."
+        },
+        { .key = {"revocation-secs"},
+          .type = GF_OPTION_TYPE_INT,
+          .min = 0,
+          .max = INT_MAX,
+          .default_value = "0",
+          .description = "Maximum time a lock can be taken out, before"
+                         "being revoked.",
+        },
+        { .key = {"revocation-clear-all"},
+          .type = GF_OPTION_TYPE_BOOL,
+          .default_value = "false",
+          .description = "If set to true, will revoke BOTH granted and blocked "
+                         "(pending) lock requests if a revocation threshold is "
+                         "hit.",
+        },
+        { .key = {"revocation-max-blocked"},
+          .type = GF_OPTION_TYPE_INT,
+          .min = 0,
+          .max = INT_MAX,
+          .default_value = "0",
+          .description = "A number of blocked lock requests after which a lock "
+                         "will be revoked to allow the others to proceed.  Can "
+                         "be used in conjunction w/ revocation-clear-all."
+        },
         { .key = {NULL} },
 };