git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v5 22/30] fetch.c: use a single ref transaction for all ref updates

From
Ronnie Sahlberg <sahlberg@google.com>
Date
Apr 29, 2014, 22:19 UTC
Message-ID
<1398809955-32008-23-git-send-email-sahlberg@google.com>
In-Reply-To
<1398809955-32008-1-git-send-email-sahlberg@google.com>

Change store_updated_refs to use a single ref transaction for all refs that are updated during the fetch. This makes the fetch more atomic when update failures occur.

Since ref update failures will now no longer occur in the code path for updating a single ref in s_update_ref, we no longer have as detailed error message logging the exact reference and the ref log action as in the old cod Instead since we fail the entire transaction we log a much more generic message. But since we commit the transaction using MSG_ON_ERR we will log an error containing the ref name if either locking of writing the ref would so the regression in the log message is minor.

This will also change the order in which errors are checked for and logged which may alter which error will be logged if there are multiple errors occuring during a fetch.

For example, assume we have a fetch for two refs that both would fail.
Where the first ref would fail with ENOTDIR due to a directory in the ref
path not existing, and the second ref in the fetch would fail due to
the check in update_logical_ref():
        if (current_branch &&
            !strcmp(ref->name, current_branch->name) &&
            !(update_head_ok || is_bare_repository()) &&
            !is_null_sha1(ref->old_sha1)) {
                /*
                 * If this is the head, and it's not okay to update
                 * the head, and the old value of the head isn't empty...
                 */

In the old code since we would update the refs one ref at a time we would first fail the ENOTDIR and then fail the second update of HEAD as well. But since the first ref failed with ENOTDIR we would eventually fail the who fetch with STORE_REF_ERROR_DF_CONFLICT

In the new code, since we defer committing the transaction until all refs have been processed, we would now detect that the second ref was bad and rollback the transaction before we would even try start writing the update t disk and thus we would not return STORE_REF_ERROR_DF_CONFLICT for this case.

I think this new behaviour is more correct, since if there was a problem we would not even try to commit the transaction but need to highlight this change in how/what errors are reported. This change in what error is returned only occurs if there are multiple refs that fail to update and only some, but not all, of them fail due to ENOTDIR.

Signed-off-by: Ronnie Sahlberg <sahlberg@google.com>
---
 builtin/fetch.c | 34 ++++++++++++++++------------------
 1 file changed, 16 insertions(+), 18 deletions(-)
diff --git a/builtin/fetch.c b/builtin/fetch.c
index b41d7b7..5dbd0f0 100644
--- a/builtin/fetch.c
+++ b/builtin/fetch.c
@@ -45,6 +45,7 @@ static struct transport *gsecondary;
 static const char *submodule_prefix = "";
 static const char *recurse_submodules_default;
 static int shown_url;
+struct ref_transaction *transaction;
 
 static int option_parse_recurse_submodules(const struct option *opt,
 				   const char *arg, int unset)
@@ -373,27 +374,13 @@ static int s_update_ref(const char *action,
 			struct ref *ref,
 			int check_old)
 {
-	char msg[1024];
-	char *rla = getenv("GIT_REFLOG_ACTION");
-	struct ref_transaction *transaction;
-
 	if (dry_run)
 		return 0;
-	if (!rla)
-		rla = default_rla.buf;
-	snprintf(msg, sizeof(msg), "%s: %s", rla, action);
 
-	errno = 0;
-	transaction = ref_transaction_begin();
-	if (!transaction ||
-	    ref_transaction_update(transaction, ref->name, ref->new_sha1,
-				   ref->old_sha1, 0, check_old) ||
-	    ref_transaction_commit(transaction, msg, NULL)) {
-		ref_transaction_rollback(transaction);
-		return errno == ENOTDIR ? STORE_REF_ERROR_DF_CONFLICT :
-					  STORE_REF_ERROR_OTHER;
-	}
-	ref_transaction_free(transaction);
+	if (ref_transaction_update(transaction, ref->name, ref->new_sha1,
+			       ref->old_sha1, 0, check_old))
+		return STORE_REF_ERROR_OTHER;
+
 	return 0;
 }
 
@@ -565,6 +552,13 @@ static int store_updated_refs(const char *raw_url, const char *remote_name,
 		goto abort;
 	}
 
+	errno = 0;
+	transaction = ref_transaction_begin();
+	if (!transaction) {
+		rc = error(_("cannot start ref transaction\n"));
+		goto abort;
+	}
+
 	/*
 	 * We do a pass for each fetch_head_status type in their enum order, so
 	 * merged entries are written before not-for-merge. That lets readers
@@ -676,6 +670,10 @@ static int store_updated_refs(const char *raw_url, const char *remote_name,
 			}
 		}
 	}
+	if (ref_transaction_commit(transaction, "fetch_ref transaction", NULL))
+		rc |= errno == ENOTDIR ? STORE_REF_ERROR_DF_CONFLICT :
+		  STORE_REF_ERROR_OTHER;
+	ref_transaction_free(transaction);
 
 	if (rc & STORE_REF_ERROR_DF_CONFLICT)
 		error(_("some local refs could not be updated; try running\n"
-- 
1.9.1.532.gf8485a6
Previous: Ronnie SahlbergNext: Ronnie Sahlberg
Message 23 of 31 in “Use ref transactions for all ref updates”
  1. 00/30 Use ref transactions for all ref updatesRonnie Sahlberg, Apr 29, 2014
  2. 01/30 refs.c: constify the sha arguments for ref_transaction_create|delete|updateRonnie Sahlberg, Apr 29, 2014
  3. 02/30 refs.c: allow passing NULL to ref_transaction_freeRonnie Sahlberg, Apr 29, 2014
  4. 03/30 refs.c: add a strbuf argument to ref_transaction_commit for error loggingRonnie Sahlberg, Apr 29, 2014
  5. 04/30 refs.c: make ref_update_reject_duplicates take a strbuf argument for errorsRonnie Sahlberg, Apr 29, 2014
  6. 05/30 update-ref.c: log transaction error from the update_refRonnie Sahlberg, Apr 29, 2014
  7. 06/30 refs.c: make update_ref_write update a strbuf on failureRonnie Sahlberg, Apr 29, 2014
  8. 07/30 refs.c: remove the onerr argument to ref_transaction_commitRonnie Sahlberg, Apr 29, 2014
  9. 08/30 refs.c: change ref_transaction_update() to do error checking and return statusRonnie Sahlberg, Apr 29, 2014
  10. 09/30 refs.c: change ref_transaction_create to do error checking and return statusRonnie Sahlberg, Apr 29, 2014
  11. 10/30 refs.c: ref_transaction_delete to check for error and return statusRonnie Sahlberg, Apr 29, 2014
  12. 11/30 tag.c: use ref transactions when doing updatesRonnie Sahlberg, Apr 29, 2014
  13. 12/30 replace.c: use the ref transaction functions for updatesRonnie Sahlberg, Apr 29, 2014
  14. 13/30 commit.c: use ref transactions for updatesRonnie Sahlberg, Apr 29, 2014
  15. 14/30 sequencer.c: use ref transactions for all ref updatesRonnie Sahlberg, Apr 29, 2014
  16. 15/30 fast-import.c: change update_branch to use ref transactionsRonnie Sahlberg, Apr 29, 2014
  17. 16/30 branch.c: use ref transaction for all ref updatesRonnie Sahlberg, Apr 29, 2014
  18. 17/30 refs.c: change update_ref to use a transactionRonnie Sahlberg, Apr 29, 2014
  19. 18/30 refs.c: free the transaction before returning when number of updates is 0Ronnie Sahlberg, Apr 29, 2014
  20. 19/30 refs.c: ref_transaction_commit should not free the transactionRonnie Sahlberg, Apr 29, 2014
  21. 20/30 fetch.c: clear errno before calling functions that might set itRonnie Sahlberg, Apr 29, 2014
  22. 21/30 fetch.c: change s_update_ref to use a ref transactionRonnie Sahlberg, Apr 29, 2014
  23. 22/30 fetch.c: use a single ref transaction for all ref updatesRonnie Sahlberg, Apr 29, 2014
  24. 23/30 receive-pack.c: use a reference transaction for updating the refsRonnie Sahlberg, Apr 29, 2014
  25. 24/30 fast-import.c: use a ref transaction when dumping tagsRonnie Sahlberg, Apr 29, 2014
  26. 25/30 walker.c: use ref transaction for ref updatesRonnie Sahlberg, Apr 29, 2014
  27. 26/30 refs.c: make write_ref_sha1 staticRonnie Sahlberg, Apr 29, 2014
  28. 27/30 refs.c: make lock_ref_sha1 staticRonnie Sahlberg, Apr 29, 2014
  29. 28/30 refs.c: add transaction.status and track OPEN/CLOSED/ERRORRonnie Sahlberg, Apr 29, 2014
  30. 29/30 refs.c: remove the update_ref_lock functionRonnie Sahlberg, Apr 29, 2014
  31. 30/30 refs.c: remove the update_ref_write functionRonnie Sahlberg, Apr 29, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.