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

[PATCH v3 38/44] refs: move duplicate check to common code

From
David Turner <dturner@twopensource.com>
Date
Oct 12, 2015, 21:51 UTC
Message-ID
<1444686725-27660-40-git-send-email-dturner@twopensource.com>
In-Reply-To
<1444686725-27660-1-git-send-email-dturner@twopensource.com>

The check for duplicate refnames in a transaction is needed for all backends, so move it to the common code.

ref_transaction_commit_fn gains a new argument, the sorted string_list of affected refnames.

Signed-off-by: David Turner <dturner@twopensource.com>
---
 refs-be-files.c | 57 ++++-----------------------------------------
 refs.c          | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 refs.h          |  1 +
 3 files changed, 75 insertions(+), 54 deletions(-)
diff --git a/refs-be-files.c b/refs-be-files.c
index dd2c42e..b89bd5c 100644
--- a/refs-be-files.c
+++ b/refs-be-files.c
@@ -3104,24 +3104,8 @@ static int files_for_each_reflog(each_ref_fn fn, void *cb_data)
 	return retval;
 }
 
-static int ref_update_reject_duplicates(struct string_list *refnames,
-					struct strbuf *err)
-{
-	int i, n = refnames->nr;
-
-	assert(err);
-
-	for (i = 1; i < n; i++)
-		if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {
-			strbuf_addf(err,
-				    "Multiple updates for ref '%s' not allowed.",
-				    refnames->items[i].string);
-			return 1;
-		}
-	return 0;
-}
-
 static int files_transaction_commit(struct ref_transaction *transaction,
+				    struct string_list *affected_refnames,
 				    struct strbuf *err)
 {
 	int ret = 0, i;
@@ -3129,26 +3113,6 @@ static int files_transaction_commit(struct ref_transaction *transaction,
 	struct ref_update **updates = transaction->updates;
 	struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;
 	struct string_list_item *ref_to_delete;
-	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
-
-	assert(err);
-
-	if (transaction->state != REF_TRANSACTION_OPEN)
-		die("BUG: commit called for transaction that is not open");
-
-	if (!n) {
-		transaction->state = REF_TRANSACTION_CLOSED;
-		return 0;
-	}
-
-	/* Fail if a refname appears more than once in the transaction: */
-	for (i = 0; i < n; i++)
-		string_list_append(&affected_refnames, updates[i]->refname);
-	string_list_sort(&affected_refnames);
-	if (ref_update_reject_duplicates(&affected_refnames, err)) {
-		ret = TRANSACTION_GENERIC_ERROR;
-		goto cleanup;
-	}
 
 	/*
 	 * Acquire all locks, verify old values if provided, check
@@ -3167,7 +3131,7 @@ static int files_transaction_commit(struct ref_transaction *transaction,
 				update->refname,
 				((update->flags & REF_HAVE_OLD) ?
 				 update->old_sha1 : NULL),
-				&affected_refnames, NULL,
+				affected_refnames, NULL,
 				update->flags,
 				&update->type,
 				err);
@@ -3279,7 +3243,6 @@ cleanup:
 		if (updates[i]->backend_data)
 			unlock_ref(updates[i]->backend_data);
 	string_list_clear(&refs_to_delete, 0);
-	string_list_clear(&affected_refnames, 0);
 	return ret;
 }
 
@@ -3297,27 +3260,18 @@ void files_init_backend(void *data)
 }
 
 static int files_initial_transaction_commit(struct ref_transaction *transaction,
+					    struct string_list *affected_refnames,
 					    struct strbuf *err)
 {
 	int ret = 0, i;
 	int n = transaction->nr;
 	struct ref_update **updates = transaction->updates;
-	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
 
 	assert(err);
 
 	if (transaction->state != REF_TRANSACTION_OPEN)
 		die("BUG: commit called for transaction that is not open");
 
-	/* Fail if a refname appears more than once in the transaction: */
-	for (i = 0; i < n; i++)
-		string_list_append(&affected_refnames, updates[i]->refname);
-	string_list_sort(&affected_refnames);
-	if (ref_update_reject_duplicates(&affected_refnames, err)) {
-		ret = TRANSACTION_GENERIC_ERROR;
-		goto cleanup;
-	}
-
 	/*
 	 * It's really undefined to call this function in an active
 	 * repository or when there are existing references: we are
@@ -3330,7 +3284,7 @@ static int files_initial_transaction_commit(struct ref_transaction *transaction,
 	 * so here we really only check that none of the references
 	 * that we are creating already exists.
 	 */
-	if (for_each_rawref(ref_present, &affected_refnames))
+	if (for_each_rawref(ref_present, affected_refnames))
 		die("BUG: initial ref transaction called with existing refs");
 
 	for (i = 0; i < n; i++) {
@@ -3340,7 +3294,7 @@ static int files_initial_transaction_commit(struct ref_transaction *transaction,
 		    !is_null_sha1(update->old_sha1))
 			die("BUG: initial ref transaction with old_sha1 set");
 		if (verify_refname_available(update->refname,
-					     &affected_refnames, NULL,
+					     affected_refnames, NULL,
 					     err)) {
 			ret = TRANSACTION_NAME_CONFLICT;
 			goto cleanup;
@@ -3371,7 +3325,6 @@ static int files_initial_transaction_commit(struct ref_transaction *transaction,
 
 cleanup:
 	transaction->state = REF_TRANSACTION_CLOSED;
-	string_list_clear(&affected_refnames, 0);
 	return ret;
 }
 
diff --git a/refs.c b/refs.c
index 3ae0274..b00f910 100644
--- a/refs.c
+++ b/refs.c
@@ -1123,6 +1123,37 @@ const char *find_descendant_ref(const char *refname,
 	return NULL;
 }
 
+/*
+ * Return 1 if there are any duplicate refnames in the updates in
+ * `transaction`, and fill in err with an appropriate error message.
+ * Fill in `refnames` with the refnames from the transaction.
+ */
+
+static int ref_update_reject_duplicates(struct ref_transaction *transaction,
+					struct string_list *refnames,
+					struct strbuf *err)
+{
+	int i, n = transaction->nr;
+	struct ref_update **updates;
+
+	assert(err);
+
+	updates = transaction->updates;
+	/* Fail if a refname appears more than once in the transaction: */
+	for (i = 0; i < n; i++)
+		string_list_append(refnames, updates[i]->refname);
+	string_list_sort(refnames);
+
+	for (i = 1; i < n; i++)
+		if (!strcmp(refnames->items[i - 1].string, refnames->items[i].string)) {
+			strbuf_addf(err,
+				    "Multiple updates for ref '%s' not allowed.",
+				    refnames->items[i].string);
+			return 1;
+		}
+	return 0;
+}
+
 /* backend functions */
 int refs_initdb(struct strbuf *err, int shared)
 {
@@ -1132,7 +1163,29 @@ int refs_initdb(struct strbuf *err, int shared)
 int ref_transaction_commit(struct ref_transaction *transaction,
 			   struct strbuf *err)
 {
-	return the_refs_backend->transaction_commit(transaction, err);
+	int ret = -1;
+	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
+
+	assert(err);
+
+	if (transaction->state != REF_TRANSACTION_OPEN)
+		die("BUG: commit called for transaction that is not open");
+
+	if (!transaction->nr) {
+		transaction->state = REF_TRANSACTION_CLOSED;
+		return 0;
+	}
+
+	if (ref_update_reject_duplicates(transaction, &affected_refnames, err)) {
+		ret = TRANSACTION_GENERIC_ERROR;
+		goto done;
+	}
+
+	ret = the_refs_backend->transaction_commit(transaction,
+						   &affected_refnames, err);
+done:
+	string_list_clear(&affected_refnames, 0);
+	return ret;
 }
 
 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
@@ -1302,5 +1355,19 @@ int reflog_expire(const char *refname, const unsigned char *sha1,
 int initial_ref_transaction_commit(struct ref_transaction *transaction,
 				   struct strbuf *err)
 {
-	return the_refs_backend->initial_transaction_commit(transaction, err);
+
+	struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
+	int ret;
+
+	if (ref_update_reject_duplicates(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;
 }
diff --git a/refs.h b/refs.h
index f8becea..a9fdbf0 100644
--- a/refs.h
+++ b/refs.h
@@ -695,6 +695,7 @@ extern int reflog_expire(const char *refname, const unsigned char *sha1,
 typedef void ref_backend_init_fn(void *data);
 typedef int ref_backend_initdb_fn(struct strbuf *err, int shared);
 typedef int ref_transaction_commit_fn(struct ref_transaction *transaction,
+				      struct string_list *affected_refnames,
 				      struct strbuf *err);
 typedef void ref_transaction_free_fn(struct ref_transaction *transaction);
 

-- 
2.4.2.644.g97b850b-twtrsrc
Previous: David TurnerNext: David Turner
Message 65 of 71 in “alternate refs backends”
  1. 00/44 alternate refs backendsDavid Turner, Oct 12, 2015
  2. 01/44 refs.c: create a public version of verify_refname_availableDavid Turner, Oct 12, 2015
  3. Michael HaggertyOct 13, 2015
  4. 02/44 refs: make repack_without_refs and is_branch publicDavid Turner, Oct 12, 2015
  5. Michael HaggertyOct 13, 2015
  6. Michael HaggertyOct 13, 2015
  7. David TurnerOct 13, 2015
  8. 03/44 refs-be-files.c: rename refs to refs-be-filesDavid Turner, Oct 12, 2015
  9. 04/44 refs.c: add a new refs.c file to hold all common refs codeDavid Turner, Oct 12, 2015
  10. 05/44 refs.c: move update_ref to refs.cDavid Turner, Oct 12, 2015
  11. Michael HaggertyOct 13, 2015
  12. David TurnerOct 13, 2015
  13. David TurnerOct 14, 2015
  14. 06/44 refs.c: move delete_ref and delete_refs to the common codeDavid Turner, Oct 12, 2015
  15. Michael HaggertyOct 13, 2015
  16. 07/44 refs.c: move read_ref_at to the common refs fileDavid Turner, Oct 12, 2015
  17. 08/44 refs.c: move the hidden refs functions to the common codeDavid Turner, Oct 12, 2015
  18. 09/44 refs.c: move dwim and friend functions to the common refs codeDavid Turner, Oct 12, 2015
  19. 10/44 refs.c: move warn_if_dangling_symref* to the common codeDavid Turner, Oct 12, 2015
  20. 11/44 refs.c: move read_ref, read_ref_full and ref_exists to the common codeDavid Turner, Oct 12, 2015
  21. 12/44 refs.c: move resolve_refdup to commonDavid Turner, Oct 12, 2015
  22. 13/44 refs.c: move check_refname_format to the common codeDavid Turner, Oct 12, 2015
  23. 14/44 refs.c: move is_branch to the common codeDavid Turner, Oct 12, 2015
  24. 15/44 refs.c: move prettify_refname to the common codeDavid Turner, Oct 12, 2015
  25. 16/44 refs.c: move ref iterators to the common codeDavid Turner, Oct 12, 2015
  26. Michael HaggertyOct 13, 2015
  27. 17/44 refs.c: move head_ref_namespaced to the common codeDavid Turner, Oct 12, 2015
  28. 18/44 refs: move transaction functions into common codeDavid Turner, Oct 12, 2015
  29. Michael HaggertyOct 13, 2015
  30. Michael HaggertyOct 13, 2015
  31. David TurnerOct 13, 2015
  32. David TurnerOct 13, 2015
  33. 19/44 refs: add a backend method structure with transaction functionsDavid Turner, Oct 12, 2015
  34. 19/44 refs-be-files.c: add a backend method structure with transaction functionsDavid Turner, Oct 12, 2015
  35. David TurnerOct 12, 2015
  36. Michael HaggertyOct 13, 2015
  37. David TurnerOct 13, 2015
  38. Michael HaggertyOct 13, 2015
  39. 20/44 refs-be-files.c: add methods for misc ref operationsDavid Turner, Oct 12, 2015
  40. Michael HaggertyOct 13, 2015
  41. 21/44 refs-be-files.c: add methods for the ref iteratorsDavid Turner, Oct 12, 2015
  42. 22/44 refs-be-files.c: add method for for_each_reftype_...David Turner, Oct 12, 2015
  43. 23/44 refs-be-files.c: add do_for_each_per_worktree_refDavid Turner, Oct 12, 2015
  44. 24/44 refs.c: move refname_is_safe to the common codeDavid Turner, Oct 12, 2015
  45. 25/44 refs.h: document make refname_is_safe and add it to headerDavid Turner, Oct 12, 2015
  46. Michael HaggertyOct 13, 2015
  47. Michael HaggertyOct 13, 2015
  48. David TurnerOct 13, 2015
  49. 26/44 refs.c: move copy_msg to the common codeDavid Turner, Oct 12, 2015
  50. Michael HaggertyOct 13, 2015
  51. 27/44 refs.c: move peel_object to the common codeDavid Turner, Oct 12, 2015
  52. Michael HaggertyOct 13, 2015
  53. 28/44 refs.c: move should_autocreate_reflog to common codeDavid Turner, Oct 12, 2015
  54. 29/44 refs.c: add ref backend init functionDavid Turner, Oct 12, 2015
  55. 30/44 refs.c: add methods for reflogDavid Turner, Oct 12, 2015
  56. 31/44 refs.c: add method for initial ref transaction commitDavid Turner, Oct 12, 2015
  57. 32/44 initdb: move safe_create_dir into common codeDavid Turner, Oct 12, 2015
  58. 33/44 refs.c: add method for initializing refs dbDavid Turner, Oct 12, 2015
  59. 34/44 refs-be-files.c: add method to rename refsDavid Turner, Oct 12, 2015
  60. 35/44 refs: make lock genericDavid Turner, Oct 12, 2015
  61. 36/44 refs: make files_log_ref_write functions publicDavid Turner, Oct 12, 2015
  62. 37/44 refs: break out a ref conflict checkDavid Turner, Oct 12, 2015
  63. Michael HaggertyOct 13, 2015
  64. David TurnerOct 13, 2015
  65. 38/44 refs: move duplicate check to common codeDavid Turner, Oct 12, 2015
  66. 39/44 refs: always handle non-normal refs in files backendDavid Turner, Oct 12, 2015
  67. 40/44 refs: allow ref backend to be set for cloneDavid Turner, Oct 12, 2015
  68. 41/44 refs: add register_refs_backendDavid Turner, Oct 12, 2015
  69. 42/44 introduce "extensions" form of core.repositoryformatversionDavid Turner, Oct 12, 2015
  70. 43/44 refs: add LMDB refs backendDavid Turner, Oct 12, 2015
  71. 44/44 refs: tests for db backendDavid Turner, Oct 12, 2015

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.