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

[PATCH v20 20/48] refs.c: change ref_transaction_create to do error checking and return status

From
Ronnie Sahlberg <sahlberg@google.com>
Date
Jun 20, 2014, 14:43 UTC
Message-ID
<1403275409-28173-21-git-send-email-sahlberg@google.com>
In-Reply-To
<1403275409-28173-1-git-send-email-sahlberg@google.com>

Do basic error checking in ref_transaction_create() and make it return non-zero on error. Update all callers to check the result of ref_transaction_create(). There are currently no conditions in _create that will return error but there will be in the future. Add an err argument that will be updated on failure.

Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Ronnie Sahlberg <sahlberg@google.com>
---
 builtin/update-ref.c |  4 +++-
 refs.c               | 18 +++++++++++------
 refs.h               | 55 +++++++++++++++++++++++++++++++++++++++++++++-------
 3 files changed, 63 insertions(+), 14 deletions(-)
diff --git a/builtin/update-ref.c b/builtin/update-ref.c
index 3067b11..41121fa 100644
--- a/builtin/update-ref.c
+++ b/builtin/update-ref.c
@@ -226,7 +226,9 @@ static const char *parse_cmd_create(struct strbuf *input, const char *next)
 	if (*next != line_termination)
 		die("create %s: extra input: %s", refname, next);
 
-	ref_transaction_create(transaction, refname, new_sha1, update_flags);
+	if (ref_transaction_create(transaction, refname, new_sha1,
+				   update_flags, &err))
+		die("%s", err.buf);
 
 	update_flags = 0;
 	free(refname);
diff --git a/refs.c b/refs.c
index 3f05e88..c49f1c6 100644
--- a/refs.c
+++ b/refs.c
@@ -3449,18 +3449,24 @@ int ref_transaction_update(struct ref_transaction *transaction,
 	return 0;
 }
 
-void ref_transaction_create(struct ref_transaction *transaction,
-			    const char *refname,
-			    const unsigned char *new_sha1,
-			    int flags)
+int ref_transaction_create(struct ref_transaction *transaction,
+			   const char *refname,
+			   const unsigned char *new_sha1,
+			   int flags,
+			   struct strbuf *err)
 {
-	struct ref_update *update = add_update(transaction, refname);
+	struct ref_update *update;
+
+	if (!new_sha1 || is_null_sha1(new_sha1))
+		die("BUG: create ref with null new_sha1");
+
+	update = add_update(transaction, refname);
 
-	assert(!is_null_sha1(new_sha1));
 	hashcpy(update->new_sha1, new_sha1);
 	hashclr(update->old_sha1);
 	update->flags = flags;
 	update->have_old = 1;
+	return 0;
 }
 
 void ref_transaction_delete(struct ref_transaction *transaction,
diff --git a/refs.h b/refs.h
index c5376ce..33b4383 100644
--- a/refs.h
+++ b/refs.h
@@ -10,6 +10,45 @@ struct ref_lock {
 	int force_write;
 };
 
+/*
+ * A ref_transaction represents a collection of ref updates
+ * that should succeed or fail together.
+ *
+ * Calling sequence
+ * ----------------
+ * - Allocate and initialize a `struct ref_transaction` by calling
+ *   `ref_transaction_begin()`.
+ *
+ * - List intended ref updates by calling functions like
+ *   `ref_transaction_update()` and `ref_transaction_create()`.
+ *
+ * - Call `ref_transaction_commit()` to execute the transaction.
+ *   If this succeeds, the ref updates will have taken place and
+ *   the transaction cannot be rolled back.
+ *
+ * - At any time call `ref_transaction_free()` to discard the
+ *   transaction and free associated resources.  In particular,
+ *   this rolls back the transaction if it has not been
+ *   successfully committed.
+ *
+ * Error handling
+ * --------------
+ *
+ * On error, transaction functions append a message about what
+ * went wrong to the 'err' argument.  The message mentions what
+ * ref was being updated (if any) when the error occurred so it
+ * can be passed to 'die' or 'error' as-is.
+ *
+ * The message is appended to err without first clearing err.
+ * This allows the caller to prepare preamble text to the generated
+ * error message:
+ *
+ *     strbuf_addf(&err, "Error while doing foo-bar: ");
+ *     if (ref_transaction_update(..., &err)) {
+ *         ret = error("%s", err.buf);
+ *         goto cleanup;
+ *     }
+ */
 struct ref_transaction;
 
 /*
@@ -248,7 +287,7 @@ struct ref_transaction *ref_transaction_begin(void);
  * it must not have existed beforehand.
  * Function returns 0 on success and non-zero on failure. A failure to update
  * means that the transaction as a whole has failed and will need to be
- * rolled back. On failure the err buffer will be updated.
+ * rolled back.
  */
 int ref_transaction_update(struct ref_transaction *transaction,
 			   const char *refname,
@@ -262,11 +301,15 @@ int ref_transaction_update(struct ref_transaction *transaction,
  * that the reference should have after the update; it must not be the
  * null SHA-1.  It is verified that the reference does not exist
  * already.
+ * Function returns 0 on success and non-zero on failure. A failure to create
+ * means that the transaction as a whole has failed and will need to be
+ * rolled back.
  */
-void ref_transaction_create(struct ref_transaction *transaction,
-			    const char *refname,
-			    const unsigned char *new_sha1,
-			    int flags);
+int ref_transaction_create(struct ref_transaction *transaction,
+			   const char *refname,
+			   const unsigned char *new_sha1,
+			   int flags,
+			   struct strbuf *err);
 
 /*
  * Add a reference deletion to transaction.  If have_old is true, then
@@ -282,8 +325,6 @@ void 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.
- * 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);

-- 
2.0.0.420.g181e020.dirty
Previous: Ronnie SahlbergNext: Michael Haggerty
Message 23 of 99 in “Use ref transactions”
  1. 00/48 Use ref transactionsRonnie Sahlberg, Jun 20, 2014
  2. 01/48 refs.c: remove ref_transaction_rollbackRonnie Sahlberg, Jun 20, 2014
  3. 02/48 refs.c: ref_transaction_commit should not free the transactionRonnie Sahlberg, Jun 20, 2014
  4. 03/48 refs.c: constify the sha arguments for ref_transaction_create|delete|updateRonnie Sahlberg, Jun 20, 2014
  5. 04/48 refs.c: allow passing NULL to ref_transaction_freeRonnie Sahlberg, Jun 20, 2014
  6. 05/48 refs.c: add a strbuf argument to ref_transaction_commit for error loggingRonnie Sahlberg, Jun 20, 2014
  7. 06/48 lockfile.c: add a new public function unable_to_lock_messageRonnie Sahlberg, Jun 20, 2014
  8. 07/48 lockfile.c: make lock_file return a meaningful errno on failureiRonnie Sahlberg, Jun 20, 2014
  9. Michael HaggertyJul 8, 2014
  10. 08/48 refs.c: add an err argument to repack_without_refsRonnie Sahlberg, Jun 20, 2014
  11. 09/48 refs.c: make sure log_ref_setup returns a meaningful errnoRonnie Sahlberg, Jun 20, 2014
  12. 10/48 refs.c: verify_lock should set errno to something meaningfulRonnie Sahlberg, Jun 20, 2014
  13. 11/48 refs.c: make remove_empty_directories always set errno to something saneRonnie Sahlberg, Jun 20, 2014
  14. 12/48 refs.c: commit_packed_refs to return a meaningful errno on failureRonnie Sahlberg, Jun 20, 2014
  15. 13/48 refs.c: make resolve_ref_unsafe set errno to something meaningful on errorRonnie Sahlberg, Jun 20, 2014
  16. Karsten BleesJun 26, 2014
  17. 14/48 refs.c: log_ref_write should try to return meaningful errnoRonnie Sahlberg, Jun 20, 2014
  18. 15/48 refs.c: make ref_update_reject_duplicates take a strbuf argument for errorsRonnie Sahlberg, Jun 20, 2014
  19. 16/48 refs.c: make update_ref_write update a strbuf on failureRonnie Sahlberg, Jun 20, 2014
  20. 17/48 update-ref: use err argument to get error from ref_transaction_commitRonnie Sahlberg, Jun 20, 2014
  21. 18/48 refs.c: remove the onerr argument to ref_transaction_commitRonnie Sahlberg, Jun 20, 2014
  22. 19/48 refs.c: change ref_transaction_update() to do error checking and return statusRonnie Sahlberg, Jun 20, 2014
  23. 20/48 refs.c: change ref_transaction_create to do error checking and return statusRonnie Sahlberg, Jun 20, 2014
  24. Michael HaggertyJul 8, 2014
  25. Ronnie SahlbergJul 14, 2014
  26. 21/48 refs.c: update ref_transaction_delete to check for error and return statusRonnie Sahlberg, Jun 20, 2014
  27. 22/48 refs.c: make ref_transaction_begin take an err argumentRonnie Sahlberg, Jun 20, 2014
  28. Michael HaggertyJul 8, 2014
  29. Ronnie SahlbergJul 14, 2014
  30. 23/48 refs.c: add transaction.status and track OPEN/CLOSED/ERRORRonnie Sahlberg, Jun 20, 2014
  31. Michael HaggertyJul 8, 2014
  32. Ronnie SahlbergJul 14, 2014
  33. 24/48 tag.c: use ref transactions when doing updatesRonnie Sahlberg, Jun 20, 2014
  34. Michael HaggertyJul 8, 2014
  35. 25/48 replace.c: use the ref transaction functions for updatesRonnie Sahlberg, Jun 20, 2014
  36. Michael HaggertyJul 8, 2014
  37. Ronnie SahlbergJul 14, 2014
  38. 26/48 commit.c: use ref transactions for updatesRonnie Sahlberg, Jun 20, 2014
  39. 27/48 sequencer.c: use ref transactions for all ref updatesRonnie Sahlberg, Jun 20, 2014
  40. Michael HaggertyJul 8, 2014
  41. Ronnie SahlbergJul 14, 2014
  42. 28/48 fast-import.c: change update_branch to use ref transactionsRonnie Sahlberg, Jun 20, 2014
  43. 29/48 branch.c: use ref transaction for all ref updatesRonnie Sahlberg, Jun 20, 2014
  44. 30/48 refs.c: change update_ref to use a transactionRonnie Sahlberg, Jun 20, 2014
  45. Michael HaggertyJul 8, 2014
  46. Ronnie SahlbergJul 14, 2014
  47. 31/48 receive-pack.c: use a reference transaction for updating the refsRonnie Sahlberg, Jun 20, 2014
  48. Michael HaggertyJul 8, 2014
  49. Ronnie SahlbergJul 14, 2014
  50. 32/48 fast-import.c: use a ref transaction when dumping tagsRonnie Sahlberg, Jun 20, 2014
  51. 33/48 walker.c: use ref transaction for ref updatesRonnie Sahlberg, Jun 20, 2014
  52. Michael HaggertyJul 8, 2014
  53. Ronnie SahlbergJul 14, 2014
  54. 34/48 refs.c: make lock_ref_sha1 staticRonnie Sahlberg, Jun 20, 2014
  55. 35/48 refs.c: remove the update_ref_lock functionRonnie Sahlberg, Jun 20, 2014
  56. 36/48 refs.c: remove the update_ref_write functionRonnie Sahlberg, Jun 20, 2014
  57. 37/48 refs.c: remove lock_ref_sha1Ronnie Sahlberg, Jun 20, 2014
  58. Michael HaggertyJul 8, 2014
  59. 38/48 refs.c: make prune_ref use a transaction to delete the refRonnie Sahlberg, Jun 20, 2014
  60. 39/48 refs.c: make delete_ref use a transactionRonnie Sahlberg, Jun 20, 2014
  61. Michael HaggertyJul 8, 2014
  62. Ronnie SahlbergJul 14, 2014
  63. 40/48 refs.c: add an err argument to delete_ref_looseRonnie Sahlberg, Jun 20, 2014
  64. Michael HaggertyJul 8, 2014
  65. Ronnie SahlbergJul 16, 2014
  66. 41/48 refs.c: pass the ref log message to _create/delete/update instead of _commitRonnie Sahlberg, Jun 20, 2014
  67. Michael HaggertyJul 8, 2014
  68. 42/48 refs.c: pass NULL as *flags to read_ref_fullRonnie Sahlberg, Jun 20, 2014
  69. 43/48 refs.c: move the check for valid refname to lock_ref_sha1_basicRonnie Sahlberg, Jun 20, 2014
  70. Michael HaggertyJul 8, 2014
  71. Ronnie SahlbergJul 15, 2014
  72. Jonathan NiederJul 15, 2014
  73. Jonathan NiederJul 15, 2014
  74. Junio C HamanoJul 15, 2014
  75. Ronnie SahlbergJul 15, 2014
  76. Ronnie SahlbergJul 15, 2014
  77. Ronnie SahlbergJul 15, 2014
  78. Michael HaggertyAug 20, 2014
  79. Ronnie SahlbergAug 20, 2014
  80. Jonathan NiederAug 20, 2014
  81. Ronnie SahlbergAug 20, 2014
  82. Michael HaggertyAug 20, 2014
  83. Ronnie SahlbergAug 21, 2014
  84. Junio C HamanoAug 20, 2014
  85. Michael HaggertyAug 20, 2014
  86. Junio C HamanoAug 20, 2014
  87. Ronnie SahlbergAug 20, 2014
  88. Michael HaggertyAug 22, 2014
  89. 44/48 refs.c: call lock_ref_sha1_basic directly from commitRonnie Sahlberg, Jun 20, 2014
  90. Michael HaggertyJul 8, 2014
  91. 45/48 refs.c: pass a skip list to name_conflict_fnRonnie Sahlberg, Jun 20, 2014
  92. 46/48 refs.c: propagate any errno==ENOTDIR from _commit back to the callersRonnie Sahlberg, Jun 20, 2014
  93. 47/48 fetch.c: change s_update_ref to use a ref transactionRonnie Sahlberg, Jun 20, 2014
  94. 48/48 refs.c: make write_ref_sha1 staticRonnie Sahlberg, Jun 20, 2014
  95. Michael HaggertyJul 8, 2014
  96. Junio C HamanoJul 8, 2014
  97. Jeff KingJul 9, 2014
  98. Ronnie SahlbergJul 14, 2014
  99. Ronnie SahlbergJul 14, 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.