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

[PATCH v9 21/44] refs.c: ref_transaction_commit should not free the transaction

From
Ronnie Sahlberg <sahlberg@google.com>
Date
May 15, 2014, 23:15 UTC
Message-ID
<1400195741-22996-22-git-send-email-sahlberg@google.com>
In-Reply-To
<1400195741-22996-1-git-send-email-sahlberg@google.com>

Change ref_transaction_commit so that it does not free the transaction. Instead require that a caller will end a transaction by either calling ref_transaction_rollback or ref_transaction_free.

By having the transaction object remaining valid after _commit returns allows
us to write much nicer code and still be able to call ref_transaction_rollback
safely. Instead of this horribleness
	t = ref_transaction_begin();
	if ((!t ||
	    ref_transaction_update(t, refname, sha1, oldval, flags,
				   !!oldval)) ||
	    (ref_transaction_commit(t, action, &err) && !(t = NULL))) {
		ref_transaction_rollback(t);
we can now just do the much nicer
	t = ref_transaction_begin();
	if (!t ||
	    ref_transaction_update(t, refname, sha1, oldval, flags,
				   !!oldval) ||
	    ref_transaction_commit(&t, action, &err)) {
		ref_transaction_rollback(t);
		... die/return ...
	ref_transaction_free(transaction);
Signed-off-by: Ronnie Sahlberg <sahlberg@google.com>
---
 branch.c             |  1 +
 builtin/commit.c     |  1 +
 builtin/replace.c    |  1 +
 builtin/tag.c        |  1 +
 builtin/update-ref.c |  1 +
 fast-import.c        |  4 ++--
 refs.c               | 14 ++++++--------
 refs.h               | 14 +++++++++-----
 sequencer.c          |  4 ++--
 9 files changed, 24 insertions(+), 17 deletions(-)
diff --git a/branch.c b/branch.c
index 8bf7588..f78a28b 100644
--- a/branch.c
+++ b/branch.c
@@ -304,6 +304,7 @@ void create_branch(const char *head,
 					   null_sha1, 0, !forcing, &err) ||
 		    ref_transaction_commit(transaction, msg, &err))
 			die("%s", err.buf);
+		ref_transaction_free(transaction);
 	}
 
 	if (real_ref && track)
diff --git a/builtin/commit.c b/builtin/commit.c
index c429216..6b888f2 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -1726,6 +1726,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
 		rollback_index_files();
 		die("%s", err.buf);
 	}
+	ref_transaction_free(transaction);
 
 	unlink(git_path("CHERRY_PICK_HEAD"));
 	unlink(git_path("REVERT_HEAD"));
diff --git a/builtin/replace.c b/builtin/replace.c
index e8932cd..af7f72d 100644
--- a/builtin/replace.c
+++ b/builtin/replace.c
@@ -164,6 +164,7 @@ static int replace_object_sha1(const char *object_ref,
 	    ref_transaction_commit(transaction, NULL, &err))
 		die("%s", err.buf);
 
+	ref_transaction_free(transaction);
 	return 0;
 }
 
diff --git a/builtin/tag.c b/builtin/tag.c
index b05f9a5..30b471c 100644
--- a/builtin/tag.c
+++ b/builtin/tag.c
@@ -708,6 +708,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
 				   0, !is_null_sha1(prev), &err) ||
 	    ref_transaction_commit(transaction, NULL, &err))
 		die("%s", err.buf);
+	ref_transaction_free(transaction);
 	if (force && !is_null_sha1(prev) && hashcmp(prev, object))
 		printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
 
diff --git a/builtin/update-ref.c b/builtin/update-ref.c
index cdb71a8..4c2145e 100644
--- a/builtin/update-ref.c
+++ b/builtin/update-ref.c
@@ -373,6 +373,7 @@ int cmd_update_ref(int argc, const char **argv, const char *prefix)
 		update_refs_stdin();
 		if (ref_transaction_commit(transaction, msg, &err))
 			die("%s", err.buf);
+		ref_transaction_free(transaction);
 		return 0;
 	}
 
diff --git a/fast-import.c b/fast-import.c
index bac799c..6b186ce 100644
--- a/fast-import.c
+++ b/fast-import.c
@@ -1710,13 +1710,13 @@ static int update_branch(struct branch *b)
 	if (!transaction ||
 	    ref_transaction_update(transaction, b->name, b->sha1, old_sha1,
 				   0, 1, &err) ||
-	    (ref_transaction_commit(transaction, msg, &err) &&
-	     !(transaction = NULL))) {
+	    ref_transaction_commit(transaction, msg, &err)) {
 		ref_transaction_rollback(transaction);
 		error("%s", err.buf);
 		strbuf_release(&err);
 		return -1;
 	}
+	ref_transaction_free(transaction);
 	return 0;
 }
 
diff --git a/refs.c b/refs.c
index b4c7d04..016206b 100644
--- a/refs.c
+++ b/refs.c
@@ -3350,7 +3350,7 @@ struct ref_transaction *ref_transaction_begin(void)
 	return xcalloc(1, sizeof(struct ref_transaction));
 }
 
-static void ref_transaction_free(struct ref_transaction *transaction)
+void ref_transaction_free(struct ref_transaction *transaction)
 {
 	int i;
 
@@ -3451,10 +3451,10 @@ int update_ref(const char *action, const char *refname,
 	struct strbuf err = STRBUF_INIT;
 
 	t = ref_transaction_begin();
-	if ((!t ||
+	if (!t ||
 	    ref_transaction_update(t, refname, sha1, oldval, flags,
-				   !!oldval, &err)) ||
-	    (ref_transaction_commit(t, action, &err) && !(t = NULL))) {
+				   !!oldval, &err) ||
+	    ref_transaction_commit(t, action, &err)) {
 		const char *str = "update_ref failed for ref '%s': %s";
 
 		ref_transaction_rollback(t);
@@ -3468,6 +3468,7 @@ int update_ref(const char *action, const char *refname,
 		strbuf_release(&err);
 		return 1;
 	}
+	ref_transaction_free(t);
 	return 0;
 }
 
@@ -3502,10 +3503,8 @@ int ref_transaction_commit(struct ref_transaction *transaction,
 	int n = transaction->nr;
 	struct ref_update **updates = transaction->updates;
 
-	if (!n) {
-		ref_transaction_free(transaction);
+	if (!n)
 		return 0;
-	}
 
 	/* Allocate work space */
 	delnames = xmalloc(sizeof(*delnames) * n);
@@ -3572,7 +3571,6 @@ cleanup:
 		if (updates[i]->lock)
 			unlock_ref(updates[i]->lock);
 	free(delnames);
-	ref_transaction_free(transaction);
 	return ret;
 }
 
diff --git a/refs.h b/refs.h
index 2c2e694..608ca10 100644
--- a/refs.h
+++ b/refs.h
@@ -216,8 +216,8 @@ enum action_on_err {
 
 /*
  * Begin a reference transaction.  The reference transaction must
- * eventually be commited using ref_transaction_commit() or rolled
- * back using ref_transaction_rollback().
+ * eventually be freed by either calling ref_transaction_rollback()
+ * or ref_transaction_free().
  */
 struct ref_transaction *ref_transaction_begin(void);
 
@@ -285,13 +285,17 @@ int ref_transaction_delete(struct ref_transaction *transaction,
 /*
  * Commit all of the changes that have been queued in transaction, as
  * atomically as possible.  Return a nonzero value if there is a
- * problem.  The ref_transaction is freed by this function.
- * If err is non-NULL we will add an error string to it to explain why
- * the transaction failed. The string does not end in newline.
+ * problem. If err is non-NULL we will add an error string to it to explain
+ * why the transaction failed. The string does not end in newline.
  */
 int ref_transaction_commit(struct ref_transaction *transaction,
 			   const char *msg, struct strbuf *err);
 
+/*
+ * Free an existing transaction.
+ */
+void ref_transaction_free(struct ref_transaction *transaction);
+
 /** Lock a ref and then write its file */
 int update_ref(const char *action, const char *refname,
 		const unsigned char *sha1, const unsigned char *oldval,
diff --git a/sequencer.c b/sequencer.c
index e6b3bbc..f6f1536 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -286,14 +286,14 @@ static int fast_forward_to(const unsigned char *to, const unsigned char *from,
 	if (!transaction ||
 	    ref_transaction_update(transaction, "HEAD", to, from,
 				   0, !unborn, &err) ||
-	    (ref_transaction_commit(transaction, sb.buf, &err) &&
-	     !(transaction = NULL))) {
+	    ref_transaction_commit(transaction, sb.buf, &err)) {
 		ref_transaction_rollback(transaction);
 		error("%s", err.buf);
 		strbuf_release(&sb);
 		strbuf_release(&err);
 		return -1;
 	}
+	ref_transaction_free(transaction);
 
 	strbuf_release(&sb);
 	return 0;

-- 
2.0.0.rc3.477.gffe78a2
Previous: Ronnie SahlbergNext: Ronnie Sahlberg
Message 22 of 45 in “Use ref transactions for all ref updates”
  1. 00/44 Use ref transactions for all ref updatesRonnie Sahlberg, May 15, 2014
  2. 01/44 refs.c: constify the sha arguments for ref_transaction_create|delete|updateRonnie Sahlberg, May 15, 2014
  3. 02/44 refs.c: allow passing NULL to ref_transaction_freeRonnie Sahlberg, May 15, 2014
  4. 03/44 refs.c: add a strbuf argument to ref_transaction_commit for error loggingRonnie Sahlberg, May 15, 2014
  5. 04/44 refs.c: add an err argument to repack_without_refsRonnie Sahlberg, May 15, 2014
  6. 05/44 refs.c: make ref_update_reject_duplicates take a strbuf argument for errorsRonnie Sahlberg, May 15, 2014
  7. 06/44 refs.c: add an err argument to delete_ref_looseRonnie Sahlberg, May 15, 2014
  8. 07/44 refs.c: make update_ref_write update a strbuf on failureRonnie Sahlberg, May 15, 2014
  9. 08/44 update-ref.c: log transaction error from the update_refRonnie Sahlberg, May 15, 2014
  10. 09/44 refs.c: remove the onerr argument to ref_transaction_commitRonnie Sahlberg, May 15, 2014
  11. 10/44 refs.c: change ref_transaction_update() to do error checking and return statusRonnie Sahlberg, May 15, 2014
  12. 11/44 refs.c: change ref_transaction_create to do error checking and return statusRonnie Sahlberg, May 15, 2014
  13. 12/44 refs.c: ref_transaction_delete to check for error and return statusRonnie Sahlberg, May 15, 2014
  14. 13/44 tag.c: use ref transactions when doing updatesRonnie Sahlberg, May 15, 2014
  15. 14/44 replace.c: use the ref transaction functions for updatesRonnie Sahlberg, May 15, 2014
  16. 15/44 commit.c: use ref transactions for updatesRonnie Sahlberg, May 15, 2014
  17. 16/44 sequencer.c: use ref transactions for all ref updatesRonnie Sahlberg, May 15, 2014
  18. 17/44 fast-import.c: change update_branch to use ref transactionsRonnie Sahlberg, May 15, 2014
  19. 18/44 branch.c: use ref transaction for all ref updatesRonnie Sahlberg, May 15, 2014
  20. 19/44 refs.c: change update_ref to use a transactionRonnie Sahlberg, May 15, 2014
  21. 20/44 refs.c: free the transaction before returning when number of updates is 0Ronnie Sahlberg, May 15, 2014
  22. 21/44 refs.c: ref_transaction_commit should not free the transactionRonnie Sahlberg, May 15, 2014
  23. 22/44 fetch.c: clear errno before calling functions that might set itRonnie Sahlberg, May 15, 2014
  24. 23/44 fetch.c: change s_update_ref to use a ref transactionRonnie Sahlberg, May 15, 2014
  25. 24/44 fetch.c: use a single ref transaction for all ref updatesRonnie Sahlberg, May 15, 2014
  26. 25/44 receive-pack.c: use a reference transaction for updating the refsRonnie Sahlberg, May 15, 2014
  27. 26/44 fast-import.c: use a ref transaction when dumping tagsRonnie Sahlberg, May 15, 2014
  28. 27/44 walker.c: use ref transaction for ref updatesRonnie Sahlberg, May 15, 2014
  29. 28/44 refs.c: make write_ref_sha1 staticRonnie Sahlberg, May 15, 2014
  30. 29/44 refs.c: make lock_ref_sha1 staticRonnie Sahlberg, May 15, 2014
  31. 30/44 refs.c: add transaction.status and track OPEN/CLOSED/ERRORRonnie Sahlberg, May 15, 2014
  32. 31/44 refs.c: remove the update_ref_lock functionRonnie Sahlberg, May 15, 2014
  33. 32/44 refs.c: remove the update_ref_write functionRonnie Sahlberg, May 15, 2014
  34. 33/44 refs.c: remove lock_ref_sha1Ronnie Sahlberg, May 15, 2014
  35. 34/44 refs.c: make prune_ref use a transaction to delete the refRonnie Sahlberg, May 15, 2014
  36. 35/44 refs.c: make delete_ref use a transactionRonnie Sahlberg, May 15, 2014
  37. 36/44 refs.c: pass the ref log message to _create/delete/update instead of _commitRonnie Sahlberg, May 15, 2014
  38. 37/44 refs.c: pass NULL as *flags to read_ref_fullRonnie Sahlberg, May 15, 2014
  39. 38/44 refs.c: pack all refs before we start to rename a refRonnie Sahlberg, May 15, 2014
  40. 39/44 refs.c: move the check for valid refname to lock_ref_sha1_basicRonnie Sahlberg, May 15, 2014
  41. 40/44 refs.c: call lock_ref_sha1_basic directly from commitRonnie Sahlberg, May 15, 2014
  42. 41/44 refs.c: add a new flag for transaction delete for refs we know are packed onlyRonnie Sahlberg, May 15, 2014
  43. 42/44 refs.c: pass a skip list to name_conflict_fnRonnie Sahlberg, May 15, 2014
  44. 43/44 refs.c: make rename_ref use a transactionRonnie Sahlberg, May 15, 2014
  45. 44/44 refs.c: remove forward declaration of write_ref_sha1Ronnie Sahlberg, May 15, 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.