Skip to content
  • Michael Haggerty's avatar
    files_transaction_prepare(): fix handling of ref lock failure · da5267f1
    Michael Haggerty authored and Junio C Hamano's avatar Junio C Hamano committed
    Since dc39e099 (files_ref_store: use a transaction to update packed
    refs, 2017-09-08), failure to lock a reference has been handled
    incorrectly by `files_transaction_prepare()`. If
    `lock_ref_for_update()` fails in the lock-acquisition loop of that
    function, it sets `ret` then breaks out of that loop. Prior to
    dc39e099, that was OK, because the only thing following the loop was
    the cleanup code. But dc39e099
    
     added another blurb of code between
    the loop and the cleanup. That blurb sometimes resets `ret` to zero,
    making the cleanup code think that the locking was successful.
    
    Specifically, whenever
    
    * One or more reference deletions have been processed successfully in
      the lock-acquisition loop. (Processing the first such reference
      causes a packed-ref transaction to be initialized.)
    
    * Then `lock_ref_for_update()` fails for a subsequent reference. Such
      a failure can happen for a number of reasons, such as the old SHA-1
      not being correct, lock contention, etc. This causes a `break` out
      of the lock-acquisition loop.
    
    * The `packed-refs` lock is acquired successfully and
      `ref_transaction_prepare()` succeeds for the packed-ref transaction.
      This has the effect of resetting `ret` back to 0, and making the
      cleanup code think that lock acquisition was successful.
    
    In that case, any reference updates that were processed prior to
    breaking out of the loop would be carried out (loose and packed), but
    the reference that couldn't be locked and any subsequent references
    would silently be ignored.
    
    This can easily cause data loss if, for example, the user was trying
    to push a new name for an existing branch while deleting the old name.
    After the push, the branch could be left unreachable, and could even
    subsequently be garbage-collected.
    
    This problem was noticed in the context of deleting one reference and
    creating another in a single transaction, when the two references D/F
    conflict with each other, like
    
        git update-ref --stdin <<EOF
        delete refs/foo
        create refs/foo/bar HEAD
        EOF
    
    This triggers the above bug because the deletion is processed
    successfully for `refs/foo`, then the D/F conflict causes
    `lock_ref_for_update()` to fail when `refs/foo/bar` is processed. In
    this case the transaction *should* fail, but instead it causes
    `refs/foo` to be deleted without creating `refs/foo`. This could
    easily result in data loss.
    
    The fix is simple: instead of just breaking out of the loop, jump
    directly to the cleanup code. This fixes some tests in t1404 that were
    added in the previous commit.
    
    Signed-off-by: default avatarMichael Haggerty <mhagger@alum.mit.edu>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    da5267f1