lib/file: Add a comment on why sleeps for file locks are randomized

The randomization prevents lock cadence issues (thundering herds).

diff --git a/open-vm-tools/lib/file/fileLockPrimitive.c b/open-vm-tools/lib/file/fileLockPrimitive.c
index f1a3b5212e007c0a1132729ddd8c1048036bb549..2a64cc5b18ab1eef7365e148e6007a4461212a5a 100644 (file)
--- a/open-vm-tools/lib/file/fileLockPrimitive.c
+++ b/open-vm-tools/lib/file/fileLockPrimitive.c
@@ -148,6 +148,11 @@ FileLockSleeper(LockValues *myValues)  // IN/OUT:
       maxSleepTimeMsec = MIN(ageMsec / 10, 2000);
    }
 
+   /*
+    * Randomize the time slept. This will prevent any potential cadence issues
+    * (thundering herds).
+    */
+
    (void) FileSleeper(maxSleepTimeMsec / 10, maxSleepTimeMsec);
 
    return 0;