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

[PATCH v6 22/32] refs: always handle non-normal refs in files backend

From
David Turner <dturner@twopensource.com>
Date
Feb 24, 2016, 22:58 UTC
Message-ID
<1456354744-8022-23-git-send-email-dturner@twopensource.com>
In-Reply-To
<1456354744-8022-1-git-send-email-dturner@twopensource.com>

Always handle non-normal (per-worktree or pseudo) refs in the files backend instead of alternate backends.

Sometimes a ref transaction will update both a per-worktree ref and a normal ref. For instance, an ordinary commit might update refs/heads/master and HEAD (or at least HEAD's reflog).

Updates to normal refs continue to go through the chosen backend.

Updates to non-normal refs are moved to a separate files backend transaction.

Signed-off-by: David Turner <dturner@twopensource.com>
---
 refs.c | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 90 insertions(+), 20 deletions(-)
diff --git a/refs.c b/refs.c
index bdde808..b2acf0e 100644
--- a/refs.c
+++ b/refs.c
@@ -9,6 +9,11 @@
 #include "object.h"
 #include "tag.h"
 
+static const char split_transaction_fail_warning[] = N_(
+	"A ref transaction was split across two refs backends.  Part of the "
+	"transaction succeeded, but then the update to the per-worktree refs "
+	"failed.  Your repository may be in an inconsistent state.");
+
 /*
  * We always have a files backend and it is the default.
  */
@@ -791,6 +796,13 @@ void ref_transaction_free(struct ref_transaction *transaction)
 	free(transaction);
 }
 
+static void add_update_obj(struct ref_transaction *transaction,
+			   struct ref_update *update)
+{
+	ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
+	transaction->updates[transaction->nr++] = update;
+}
+
 static struct ref_update *add_update(struct ref_transaction *transaction,
 				     const char *refname)
 {
@@ -798,8 +810,7 @@ static struct ref_update *add_update(struct ref_transaction *transaction,
 	struct ref_update *update = xcalloc(1, sizeof(*update) + len);
 
 	memcpy((char *)update->refname, refname, len); /* includes NUL */
-	ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
-	transaction->updates[transaction->nr++] = update;
+	add_update_obj(transaction, update);
 	return update;
 }
 
@@ -1416,11 +1427,37 @@ static int dereference_symrefs(struct ref_transaction *transaction,
 	return 0;
 }
 
-int ref_transaction_commit(struct ref_transaction *transaction,
-			   struct strbuf *err)
+/*
+ * Move all non-normal ref updates into a specially-created
+ * files-backend transaction
+ */
+static int move_abnormal_ref_updates(struct ref_transaction *transaction,
+				     struct ref_transaction *files_transaction,
+				     struct strbuf *err)
+{
+	int i, normal_nr = 0;
+
+	for (i = 0; i < transaction->nr; i++) {
+		struct ref_update *update = transaction->updates[i];
+
+		if (ref_type(update->refname) == REF_TYPE_NORMAL)
+			transaction->updates[normal_nr++] = update;
+		else
+			add_update_obj(files_transaction, update);
+	}
+
+	transaction->nr = normal_nr;
+	return 0;
+}
+
+static int do_ref_transaction_commit(struct ref_transaction *transaction,
+				     struct strbuf *err,
+				     ref_transaction_commit_fn *commit_fn)
 {
 	int ret = -1;
 	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
+	struct string_list files_affected_refnames = STRING_LIST_INIT_NODUP;
+	struct ref_transaction *files_transaction = NULL;
 
 	assert(err);
 
@@ -1436,18 +1473,60 @@ int ref_transaction_commit(struct ref_transaction *transaction,
 	if (ret)
 		goto done;
 
+	if (the_refs_backend != &refs_be_files) {
+		files_transaction = ref_transaction_begin(err);
+		if (!files_transaction)
+			goto done;
+
+		ret = move_abnormal_ref_updates(transaction, files_transaction,
+						err);
+		if (ret)
+			goto done;
+
+		/* files backend commit */
+		if (get_affected_refnames(files_transaction,
+						 &files_affected_refnames,
+						 err)) {
+			ret = TRANSACTION_GENERIC_ERROR;
+			goto done;
+		}
+	}
+
+	/* main backend commit */
 	if (get_affected_refnames(transaction, &affected_refnames, err)) {
 		ret = TRANSACTION_GENERIC_ERROR;
 		goto done;
 	}
 
-	ret = the_refs_backend->transaction_commit(transaction,
-						   &affected_refnames, err);
+	ret = commit_fn(transaction, &affected_refnames, err);
+	if (ret)
+		goto done;
+
+	if (files_transaction) {
+		ret = refs_be_files.transaction_commit(files_transaction,
+						       &files_affected_refnames,
+						       err);
+		if (ret) {
+			warning(split_transaction_fail_warning);
+			goto done;
+		}
+	}
+
 done:
 	string_list_clear(&affected_refnames, 0);
+	string_list_clear(&files_affected_refnames, 0);
+	if (files_transaction)
+		ref_transaction_free(files_transaction);
 	return ret;
 }
 
+int ref_transaction_commit(struct ref_transaction *transaction,
+			   struct strbuf *err)
+{
+	return do_ref_transaction_commit(transaction, err,
+					 the_refs_backend->transaction_commit);
+}
+
 int verify_refname_available(const char *refname, struct string_list *extra,
 			     struct string_list *skip, struct strbuf *err)
 {
@@ -1467,6 +1546,9 @@ int peel_ref(const char *refname, unsigned char *sha1)
 int create_symref(const char *ref_target, const char *refs_heads_master,
 		  const char *logmsg)
 {
+	if (ref_type(ref_target) != REF_TYPE_NORMAL)
+		return refs_be_files.create_symref(ref_target, refs_heads_master,
+						   logmsg);
 	return the_refs_backend->create_symref(ref_target, refs_heads_master,
 					       logmsg);
 }
@@ -1526,20 +1608,8 @@ int reflog_expire(const char *refname, const unsigned char *sha1,
 int initial_ref_transaction_commit(struct ref_transaction *transaction,
 				   struct strbuf *err)
 {
-	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
-	int ret;
-
-	if (get_affected_refnames(transaction,
-				  &affected_refnames, err)) {
-		ret = TRANSACTION_GENERIC_ERROR;
-		goto done;
-	}
-	ret = the_refs_backend->initial_transaction_commit(transaction,
-							   &affected_refnames,
-							   err);
-done:
-	string_list_clear(&affected_refnames, 0);
-	return ret;
+	return do_ref_transaction_commit(transaction, err,
+					 the_refs_backend->initial_transaction_commit);
 }
 
 int delete_refs(struct string_list *refnames)
-- 
2.4.2.767.g62658d5-twtrsrc
Previous: David TurnerNext: David Turner
Message 30 of 56 in “refs backend”
  1. 00/32 refs backendDavid Turner, Feb 24, 2016
  2. 01/32 refs: move head_ref{,_submodule} to the common codeDavid Turner, Feb 24, 2016
  3. 02/32 refs: move for_each_*ref* functions into common codeDavid Turner, Feb 24, 2016
  4. 03/32 files-backend: break out ref readingDavid Turner, Feb 24, 2016
  5. Junio C HamanoFeb 25, 2016
  6. Junio C HamanoFeb 25, 2016
  7. David TurnerFeb 25, 2016
  8. Junio C HamanoFeb 25, 2016
  9. 04/32 refs: move resolve_ref_unsafe into common codeDavid Turner, Feb 24, 2016
  10. Junio C HamanoFeb 25, 2016
  11. 05/32 refs: add a backend method structure with transaction functionsDavid Turner, Feb 24, 2016
  12. Jeff KingFeb 27, 2016
  13. David TurnerFeb 29, 2016
  14. 06/32 refs: add methods for misc ref operationsDavid Turner, Feb 24, 2016
  15. 07/32 refs: add method for do_for_each_refDavid Turner, Feb 24, 2016
  16. 08/32 refs: reduce the visibility of do_for_each_ref()David Turner, Feb 24, 2016
  17. 09/32 refs: add do_for_each_per_worktree_refDavid Turner, Feb 24, 2016
  18. 10/32 refs: add methods for reflogDavid Turner, Feb 24, 2016
  19. 11/32 refs: add method for initial ref transaction commitDavid Turner, Feb 24, 2016
  20. 12/32 refs: add method for delete_refsDavid Turner, Feb 24, 2016
  21. 13/32 refs: add methods to init refs dbDavid Turner, Feb 24, 2016
  22. 14/32 refs: add method to rename refsDavid Turner, Feb 24, 2016
  23. 15/32 refs: handle non-normal ref renamesDavid Turner, Feb 24, 2016
  24. 16/32 refs: make lock genericDavid Turner, Feb 24, 2016
  25. 17/32 refs: move duplicate check to common codeDavid Turner, Feb 24, 2016
  26. 18/32 refs: allow log-only updatesDavid Turner, Feb 24, 2016
  27. 19/32 refs: don't dereference on renameDavid Turner, Feb 24, 2016
  28. 20/32 refs: on symref reflog expire, lock symref not referrentDavid Turner, Feb 24, 2016
  29. 21/32 refs: resolve symbolic refs firstDavid Turner, Feb 24, 2016
  30. 22/32 refs: always handle non-normal refs in files backendDavid Turner, Feb 24, 2016
  31. 23/32 init: allow alternate ref strorage to be set for new reposDavid Turner, Feb 24, 2016
  32. 24/32 refs: check submodules' ref storage configDavid Turner, Feb 24, 2016
  33. 25/32 clone: allow ref storage backend to be set for cloneDavid Turner, Feb 24, 2016
  34. 26/32 svn: learn ref-storage argumentDavid Turner, Feb 24, 2016
  35. 27/32 refs: register ref storage backendsDavid Turner, Feb 24, 2016
  36. 28/32 config: read ref storage config on startupDavid Turner, Feb 24, 2016
  37. Jeff KingFeb 27, 2016
  38. Jeff KingFeb 27, 2016
  39. David TurnerFeb 29, 2016
  40. Jeff KingFeb 29, 2016
  41. David TurnerFeb 29, 2016
  42. Jeff KingFeb 29, 2016
  43. Jeff KingFeb 29, 2016
  44. David TurnerFeb 29, 2016
  45. 29/32 refs: break out resolve_ref_unsafe_submoduleDavid Turner, Feb 24, 2016
  46. 30/32 refs: add LMDB refs storage backendDavid Turner, Feb 24, 2016
  47. 31/32 refs: tests for lmdb backendDavid Turner, Feb 24, 2016
  48. 32/32 tests: add ref-storage argumentDavid Turner, Feb 24, 2016
  49. SZEDER GáborFeb 29, 2016
  50. David TurnerFeb 29, 2016
  51. Ramsay JonesFeb 25, 2016
  52. David TurnerFeb 25, 2016
  53. Duy NguyenFeb 25, 2016
  54. David TurnerFeb 25, 2016
  55. Stefan BellerFeb 25, 2016
  56. Duy NguyenFeb 25, 2016

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.