refs/reftable: introduce "reftable.lockTimeout"

When multiple concurrent processes try to update references in a
repository they may try to lock the same lockfiles. This can happen even
when the updates are non-conflicting and can both be applied, so it
doesn't always make sense to abort the transaction immediately. Both the
"loose" and "packed" backends thus have a grace period that they wait
for the lock to be released that can be controlled via the config values
"core.filesRefLockTimeout" and "core.packedRefsTimeout", respectively.

The reftable backend doesn't have such a setting yet and instead fails
immediately when it sees such a lock. But the exact same concepts apply
here as they do apply to the other backends.

Introduce a new "reftable.lockTimeout" config that controls how long we
may wait for a "tables.list" lock to be released. The default value of
this config is 100ms, which is the same default as we have it for the
"loose" backend.

Note that even though we also lock individual tables, this config really
only applies to the "tables.list" file. This is because individual
tables are only ever locked when we already hold the "tables.list" lock
during compaction. When we observe such a lock we in fact do not want to
compact the table at all because it is already in the process of being
compacted by a concurrent process. So applying the same timeout here
would not make any sense and only delay progress.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config/reftable.txt b/Documentation/config/reftable.txt
index 0515727977833983085398e791b0f2788b538fdd..57087803a54c0665c087b674a7def4ed23658563 100644 (file)
--- a/Documentation/config/reftable.txt
+++ b/Documentation/config/reftable.txt
@@ -46,3 +46,11 @@ reftable.geometricFactor::
 By default, the geometric sequence uses a factor of 2, meaning that for any
 table, the next-biggest table must at least be twice as big. A maximum factor
 of 256 is supported.
+
+reftable.lockTimeout::
+       Whenever the reftable backend appends a new table to the stack, it has
+       to lock the central "tables.list" file before updating it. This config
+       controls how long the process will wait to acquire the lock in case
+       another process has already acquired it. Value 0 means not to retry at
+       all; -1 means to try indefinitely. Default is 100 (i.e., retry for
+       100ms).

diff --git a/refs/reftable-backend.c b/refs/reftable-backend.c
index 1c4b19e737fb3d136c0a91fbcedb71124fb5abc5..ca281e39a29b17537403aba523062a5170ec9479 100644 (file)
--- a/refs/reftable-backend.c
+++ b/refs/reftable-backend.c
@@ -256,6 +256,13 @@ static int reftable_be_config(const char *var, const char *value,
                if (factor > UINT8_MAX)
                        die("reftable geometric factor cannot exceed %u", (unsigned)UINT8_MAX);
                opts->auto_compaction_factor = factor;
+       } else if (!strcmp(var, "reftable.locktimeout")) {
+               int64_t lock_timeout = git_config_int64(var, value, ctx->kvi);
+               if (lock_timeout > LONG_MAX)
+                       die("reftable lock timeout cannot exceed %"PRIdMAX, (intmax_t)LONG_MAX);
+               if (lock_timeout < 0 && lock_timeout != -1)
+                       die("reftable lock timeout does not support negative values other than -1");
+               opts->lock_timeout_ms = lock_timeout;
        }
 
        return 0;
@@ -281,6 +288,7 @@ static struct ref_store *reftable_be_init(struct repository *repo,
        refs->write_options.default_permissions = calc_shared_perm(0666 & ~mask);
        refs->write_options.disable_auto_compact =
                !git_env_bool("GIT_TEST_REFTABLE_AUTOCOMPACTION", 1);
+       refs->write_options.lock_timeout_ms = 100;
 
        git_config(reftable_be_config, &refs->write_options);
 

diff --git a/reftable/reftable-writer.h b/reftable/reftable-writer.h
index 189b1f4144f22827e5fa293e02ecc4829ef2e8e4..f5e25cfda163d9ec1f0bd301d05de30d0688e576 100644 (file)
--- a/reftable/reftable-writer.h
+++ b/reftable/reftable-writer.h
@@ -51,6 +51,17 @@ struct reftable_write_options {
         * tables to compact. Defaults to 2 if unset.
         */
        uint8_t auto_compaction_factor;
+
+       /*
+        * The number of milliseconds to wait when trying to lock "tables.list".
+        * Note that this does not apply to locking individual tables, as these
+        * should only ever be locked when already holding the "tables.list"
+        * lock.
+        *
+        * Passing 0 will fail immediately when the file is locked, passing a
+        * negative value will cause us to block indefinitely.
+        */
+       long lock_timeout_ms;
 };
 
 /* reftable_block_stats holds statistics for a single block type */

diff --git a/reftable/stack.c b/reftable/stack.c
index ce0a35216bad6d0171120e286f8a43076818d3f8..5ccad2cff31c77e8aa2276f30e4f96e456905d2c 100644 (file)
--- a/reftable/stack.c
+++ b/reftable/stack.c
@@ -603,8 +603,10 @@ static int reftable_stack_init_addition(struct reftable_addition *add,
 
        add->stack = st;
 
-       err = hold_lock_file_for_update(&add->tables_list_lock, st->list_file,
-                                       LOCK_NO_DEREF);
+       err = hold_lock_file_for_update_timeout(&add->tables_list_lock,
+                                               st->list_file,
+                                               LOCK_NO_DEREF,
+                                               st->opts.lock_timeout_ms);
        if (err < 0) {
                if (errno == EEXIST) {
                        err = REFTABLE_LOCK_ERROR;
@@ -1056,8 +1058,10 @@ static int stack_compact_range(struct reftable_stack *st,
         * Hold the lock so that we can read "tables.list" and lock all tables
         * which are part of the user-specified range.
         */
-       err = hold_lock_file_for_update(&tables_list_lock, st->list_file,
-                                       LOCK_NO_DEREF);
+       err = hold_lock_file_for_update_timeout(&tables_list_lock,
+                                               st->list_file,
+                                               LOCK_NO_DEREF,
+                                               st->opts.lock_timeout_ms);
        if (err < 0) {
                if (errno == EEXIST)
                        err = REFTABLE_LOCK_ERROR;
@@ -1156,8 +1160,10 @@ static int stack_compact_range(struct reftable_stack *st,
         * "tables.list". We'll then replace the compacted range of tables with
         * the new table.
         */
-       err = hold_lock_file_for_update(&tables_list_lock, st->list_file,
-                                       LOCK_NO_DEREF);
+       err = hold_lock_file_for_update_timeout(&tables_list_lock,
+                                               st->list_file,
+                                               LOCK_NO_DEREF,
+                                               st->opts.lock_timeout_ms);
        if (err < 0) {
                if (errno == EEXIST)
                        err = REFTABLE_LOCK_ERROR;

diff --git a/t/t0610-reftable-basics.sh b/t/t0610-reftable-basics.sh
index 37510c2b2a513e2f49309abb4c1f3959bcf8dc6f..62da3e37823776168ac1c0ab8f3f708fcddc610b 100755 (executable)
--- a/t/t0610-reftable-basics.sh
+++ b/t/t0610-reftable-basics.sh
@@ -423,6 +423,33 @@ test_expect_success 'ref transaction: fails gracefully when auto compaction fail
        )
 '
 
+test_expect_success 'ref transaction: timeout acquiring tables.list lock' '
+       test_when_finished "rm -rf repo" &&
+       git init repo &&
+       (
+               cd repo &&
+               test_commit initial &&
+               >.git/reftable/tables.list.lock &&
+               test_must_fail git update-ref refs/heads/branch HEAD 2>err &&
+               test_grep "cannot lock references" err
+       )
+'
+
+test_expect_success 'ref transaction: retry acquiring tables.list lock' '
+       test_when_finished "rm -rf repo" &&
+       git init repo &&
+       (
+               cd repo &&
+               test_commit initial &&
+               LOCK=.git/reftable/tables.list.lock &&
+               >$LOCK &&
+               {
+                       ( sleep 1 && rm -f $LOCK ) &
+               } &&
+               git -c reftable.lockTimeout=5000 update-ref refs/heads/branch HEAD
+       )
+'
+
 test_expect_success 'pack-refs: compacts tables' '
        test_when_finished "rm -rf repo" &&
        git init repo &&