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

[PATCH v17 43/48] refs.c: move the check for valid refname to lock_ref_sha1_basic

From
Ronnie Sahlberg <sahlberg@google.com>
Date
Jun 16, 2014, 18:04 UTC
Message-ID
<1402941859-29354-44-git-send-email-sahlberg@google.com>
In-Reply-To
<1402941859-29354-1-git-send-email-sahlberg@google.com>

Move the check for check_refname_format from lock_any_ref_for_update to lock_ref_sha1_basic. At some later stage we will get rid of lock_any_ref_for_update completely.

If lock_ref_sha1_basic fails the check_refname_format test, set errno to EINVAL before returning NULL. This to guarantee that we will not return an error without updating errno.

This leaves lock_any_ref_for_updates as a no-op wrapper which could be removed. But this wrapper is also called from an external caller and we will soon make changes to the signature to lock_ref_sha1_basic that we do not want to expose to that caller.

This changes semantics for lock_ref_sha1_basic slightly. With this change it is no longer possible to open a ref that has a badly name which breaks any codepaths that tries to open and repair badly named refs. The normal refs API should not allow neither creating nor accessing refs with invalid names. If we need such recovery code we could add it as an option to git fsck and have git fsck be the only sanctioned way of bypassing the normal API and checks.

Signed-off-by: Ronnie Sahlberg <sahlberg@google.com>
---
 refs.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/refs.c b/refs.c
index 7b80bb3..69815d9 100644
--- a/refs.c
+++ b/refs.c
@@ -2062,6 +2062,11 @@ static struct ref_lock *lock_ref_sha1_basic(const char *refname,
 	int missing = 0;
 	int attempts_remaining = 3;
 
+	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
+		errno = EINVAL;
+		return NULL;
+	}
+
 	lock = xcalloc(1, sizeof(struct ref_lock));
 	lock->lock_fd = -1;
 
@@ -2153,8 +2158,6 @@ struct ref_lock *lock_any_ref_for_update(const char *refname,
 					 const unsigned char *old_sha1,
 					 int flags, int *type_p)
 {
-	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
-		return NULL;
 	return lock_ref_sha1_basic(refname, old_sha1, flags, type_p);
 }
 

-- 
2.0.0.282.g3799eda.dirty
Previous: Ronnie SahlbergNext: Ronnie Sahlberg
Message 48 of 53 in “Use ref transactions”
  1. 00/48 Use ref transactionsRonnie Sahlberg, Jun 16, 2014
  2. 01/48 refs.c: remove ref_transaction_rollbackRonnie Sahlberg, Jun 16, 2014
  3. 02/48 refs.c: ref_transaction_commit should not free the transactionRonnie Sahlberg, Jun 16, 2014
  4. 03/48 refs.c: constify the sha arguments for ref_transaction_create|delete|updateRonnie Sahlberg, Jun 16, 2014
  5. 04/48 refs.c: allow passing NULL to ref_transaction_freeRonnie Sahlberg, Jun 16, 2014
  6. 05/48 refs.c: add a strbuf argument to ref_transaction_commit for error loggingRonnie Sahlberg, Jun 16, 2014
  7. 06/48 lockfile.c: add a new public function unable_to_lock_messageRonnie Sahlberg, Jun 16, 2014
  8. 07/48 lockfile.c: make lock_file return a meaningful errno on failureiRonnie Sahlberg, Jun 16, 2014
  9. 08/48 refs.c: add an err argument to repack_without_refsRonnie Sahlberg, Jun 16, 2014
  10. 09/48 refs.c: make sure log_ref_setup returns a meaningful errnoRonnie Sahlberg, Jun 16, 2014
  11. 10/48 refs.c: verify_lock should set errno to something meaningfulRonnie Sahlberg, Jun 16, 2014
  12. 11/48 refs.c: make remove_empty_directories alwasy set errno to something saneRonnie Sahlberg, Jun 16, 2014
  13. 12/48 refs.c: commit_packed_refs to return a meaningful errno on failureRonnie Sahlberg, Jun 16, 2014
  14. 13/48 refs.c: make resolve_ref_unsafe set errno to something meaningful on errorRonnie Sahlberg, Jun 16, 2014
  15. 14/48 refs.c: log_ref_write should try to return meaningful errnoRonnie Sahlberg, Jun 16, 2014
  16. 15/48 refs.c: make ref_update_reject_duplicates take a strbuf argument for errorsRonnie Sahlberg, Jun 16, 2014
  17. 16/48 refs.c: add an err argument to delete_ref_looseRonnie Sahlberg, Jun 16, 2014
  18. Junio C HamanoJun 17, 2014
  19. Ronnie SahlbergJun 17, 2014
  20. Ronnie SahlbergJun 17, 2014
  21. Junio C HamanoJun 17, 2014
  22. 17/48 refs.c: make update_ref_write update a strbuf on failureRonnie Sahlberg, Jun 16, 2014
  23. 18/48 update-ref: use err argument to get error from ref_transaction_commitRonnie Sahlberg, Jun 16, 2014
  24. 19/48 refs.c: remove the onerr argument to ref_transaction_commitRonnie Sahlberg, Jun 16, 2014
  25. 20/48 refs.c: change ref_transaction_update() to do error checking and return statusRonnie Sahlberg, Jun 16, 2014
  26. 21/48 refs.c: change ref_transaction_create to do error checking and return statusRonnie Sahlberg, Jun 16, 2014
  27. 22/48 refs.c: update ref_transaction_delete to check for error and return statusRonnie Sahlberg, Jun 16, 2014
  28. 23/48 refs.c: make ref_transaction_begin take an err argumentRonnie Sahlberg, Jun 16, 2014
  29. 24/48 refs.c: add transaction.status and track OPEN/CLOSED/ERRORRonnie Sahlberg, Jun 16, 2014
  30. 25/48 tag.c: use ref transactions when doing updatesRonnie Sahlberg, Jun 16, 2014
  31. 26/48 replace.c: use the ref transaction functions for updatesRonnie Sahlberg, Jun 16, 2014
  32. 27/48 commit.c: use ref transactions for updatesRonnie Sahlberg, Jun 16, 2014
  33. 28/48 sequencer.c: use ref transactions for all ref updatesRonnie Sahlberg, Jun 16, 2014
  34. 29/48 fast-import.c: change update_branch to use ref transactionsRonnie Sahlberg, Jun 16, 2014
  35. 30/48 branch.c: use ref transaction for all ref updatesRonnie Sahlberg, Jun 16, 2014
  36. 31/48 refs.c: change update_ref to use a transactionRonnie Sahlberg, Jun 16, 2014
  37. 32/48 receive-pack.c: use a reference transaction for updating the refsRonnie Sahlberg, Jun 16, 2014
  38. 33/48 fast-import.c: use a ref transaction when dumping tagsRonnie Sahlberg, Jun 16, 2014
  39. 34/48 walker.c: use ref transaction for ref updatesRonnie Sahlberg, Jun 16, 2014
  40. 35/48 refs.c: make lock_ref_sha1 staticRonnie Sahlberg, Jun 16, 2014
  41. 36/48 refs.c: remove the update_ref_lock functionRonnie Sahlberg, Jun 16, 2014
  42. 37/48 refs.c: remove the update_ref_write functionRonnie Sahlberg, Jun 16, 2014
  43. 38/48 refs.c: remove lock_ref_sha1Ronnie Sahlberg, Jun 16, 2014
  44. 39/48 refs.c: make prune_ref use a transaction to delete the refRonnie Sahlberg, Jun 16, 2014
  45. 40/48 refs.c: make delete_ref use a transactionRonnie Sahlberg, Jun 16, 2014
  46. 41/48 refs.c: pass the ref log message to _create/delete/update instead of _commitRonnie Sahlberg, Jun 16, 2014
  47. 42/48 refs.c: pass NULL as *flags to read_ref_fullRonnie Sahlberg, Jun 16, 2014
  48. 43/48 refs.c: move the check for valid refname to lock_ref_sha1_basicRonnie Sahlberg, Jun 16, 2014
  49. 44/48 refs.c: call lock_ref_sha1_basic directly from commitRonnie Sahlberg, Jun 16, 2014
  50. 45/48 refs.c: pass a skip list to name_conflict_fnRonnie Sahlberg, Jun 16, 2014
  51. 46/48 refs.c: propagate any errno==ENOTDIR from _commit back to the callersRonnie Sahlberg, Jun 16, 2014
  52. 47/48 fetch.c: change s_update_ref to use a ref transactionRonnie Sahlberg, Jun 16, 2014
  53. 48/48 refs.c: make write_ref_sha1 staticRonnie Sahlberg, Jun 16, 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.