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

[PATCH 23/24] refs: move resolve_ref_unsafe into common code

From
David Turner <dturner@twopensource.com>
Date
Apr 7, 2016, 19:03 UTC
Message-ID
<1460055791-23313-24-git-send-email-dturner@twopensource.com>
In-Reply-To
<1460055791-23313-1-git-send-email-dturner@twopensource.com>

Now that resolve_ref_unsafe's only interaction with the backend is through read_raw_ref, we can move it into the common code. Later, we'll replace read_raw_ref with a backend function.

Signed-off-by: David Turner <dturner@twopensource.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 refs.c               | 74 +++++++++++++++++++++++++++++++++++++++++++++++
 refs/files-backend.c | 82 ++--------------------------------------------------
 refs/refs-internal.h |  6 ++++
 3 files changed, 83 insertions(+), 79 deletions(-)
diff --git a/refs.c b/refs.c
index f0feff7..87dc82f 100644
--- a/refs.c
+++ b/refs.c
@@ -1155,3 +1155,77 @@ int for_each_rawref(each_ref_fn fn, void *cb_data)
 	return do_for_each_ref(NULL, "", fn, 0,
 			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
 }
+
+/* This function needs to return a meaningful errno on failure */
+const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
+			       unsigned char *sha1, int *flags)
+{
+	static struct strbuf sb_refname = STRBUF_INIT;
+	int unused_flags;
+	int symref_count;
+
+	if (!flags)
+		flags = &unused_flags;
+
+	*flags = 0;
+
+	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
+		if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
+		    !refname_is_safe(refname)) {
+			errno = EINVAL;
+			return NULL;
+		}
+
+		/*
+		 * dwim_ref() uses REF_ISBROKEN to distinguish between
+		 * missing refs and refs that were present but invalid,
+		 * to complain about the latter to stderr.
+		 *
+		 * We don't know whether the ref exists, so don't set
+		 * REF_ISBROKEN yet.
+		 */
+		*flags |= REF_BAD_NAME;
+	}
+
+	for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
+		unsigned int read_flags = 0;
+
+		if (read_raw_ref(refname, sha1, &sb_refname, &read_flags)) {
+			*flags |= read_flags;
+			if (errno != ENOENT || (resolve_flags & RESOLVE_REF_READING))
+				return NULL;
+			hashclr(sha1);
+			if (*flags & REF_BAD_NAME)
+				*flags |= REF_ISBROKEN;
+			return refname;
+		}
+
+		*flags |= read_flags;
+
+		if (!(read_flags & REF_ISSYMREF)) {
+			if (*flags & REF_BAD_NAME) {
+				hashclr(sha1);
+				*flags |= REF_ISBROKEN;
+			}
+			return refname;
+		}
+
+		refname = sb_refname.buf;
+		if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
+			hashclr(sha1);
+			return refname;
+		}
+		if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
+			if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
+			    !refname_is_safe(refname)) {
+				errno = EINVAL;
+				return NULL;
+			}
+
+			*flags |= REF_ISBROKEN | REF_BAD_NAME;
+		}
+	}
+
+	errno = ELOOP;
+	return NULL;
+}
diff --git a/refs/files-backend.c b/refs/files-backend.c
index a15986c..71848ab 100644
--- a/refs/files-backend.c
+++ b/refs/files-backend.c
@@ -1269,8 +1269,6 @@ static struct ref_dir *get_loose_refs(struct ref_cache *refs)
 	return get_ref_dir(refs->loose);
 }
 
-/* We allow "recursive" symbolic refs. Only within reason, though */
-#define MAXDEPTH 5
 #define MAXREFLEN (1024)
 
 /*
@@ -1300,7 +1298,7 @@ static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
 	char buffer[128], *p;
 	char *path;
 
-	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
+	if (recursion > SYMREF_MAXDEPTH || strlen(refname) > MAXREFLEN)
 		return -1;
 	path = *refs->name
 		? git_pathdup_submodule(refs->name, "%s", refname)
@@ -1420,8 +1418,8 @@ static int resolve_missing_loose_ref(const char *refname,
  * - in all other cases, symref will be untouched, and therefore
  *   refname will still be valid and unchanged.
  */
-static int read_raw_ref(const char *refname, unsigned char *sha1,
-			struct strbuf *symref, unsigned int *flags)
+int read_raw_ref(const char *refname, unsigned char *sha1,
+		 struct strbuf *symref, unsigned int *flags)
 {
 	struct strbuf sb_contents = STRBUF_INIT;
 	struct strbuf sb_path = STRBUF_INIT;
@@ -1538,80 +1536,6 @@ out:
 	return ret;
 }
 
-/* This function needs to return a meaningful errno on failure */
-const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
-			       unsigned char *sha1, int *flags)
-{
-	static struct strbuf sb_refname = STRBUF_INIT;
-	int unused_flags;
-	int symref_count;
-
-	if (!flags)
-		flags = &unused_flags;
-
-	*flags = 0;
-
-	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
-		if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
-		    !refname_is_safe(refname)) {
-			errno = EINVAL;
-			return NULL;
-		}
-
-		/*
-		 * dwim_ref() uses REF_ISBROKEN to distinguish between
-		 * missing refs and refs that were present but invalid,
-		 * to complain about the latter to stderr.
-		 *
-		 * We don't know whether the ref exists, so don't set
-		 * REF_ISBROKEN yet.
-		 */
-		*flags |= REF_BAD_NAME;
-	}
-
-	for (symref_count = 0; symref_count < MAXDEPTH; symref_count++) {
-		unsigned int read_flags = 0;
-
-		if (read_raw_ref(refname, sha1, &sb_refname, &read_flags)) {
-			*flags |= read_flags;
-			if (errno != ENOENT || (resolve_flags & RESOLVE_REF_READING))
-				return NULL;
-			hashclr(sha1);
-			if (*flags & REF_BAD_NAME)
-				*flags |= REF_ISBROKEN;
-			return refname;
-		}
-
-		*flags |= read_flags;
-
-		if (!(read_flags & REF_ISSYMREF)) {
-			if (*flags & REF_BAD_NAME) {
-				hashclr(sha1);
-				*flags |= REF_ISBROKEN;
-			}
-			return refname;
-		}
-
-		refname = sb_refname.buf;
-		if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
-			hashclr(sha1);
-			return refname;
-		}
-		if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
-			if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
-			    !refname_is_safe(refname)) {
-				errno = EINVAL;
-				return NULL;
-			}
-
-			*flags |= REF_ISBROKEN | REF_BAD_NAME;
-		}
-	}
-
-	errno = ELOOP;
-	return NULL;
-}
-
 /*
  * Peel the entry (if possible) and return its new peel_status.  If
  * repeel is true, re-peel the entry even if there is an old peeled
diff --git a/refs/refs-internal.h b/refs/refs-internal.h
index 92aae80..3a4f634 100644
--- a/refs/refs-internal.h
+++ b/refs/refs-internal.h
@@ -197,6 +197,8 @@ const char *find_descendant_ref(const char *dirname,
 
 int rename_ref_available(const char *oldname, const char *newname);
 
+/* We allow "recursive" symbolic refs. Only within reason, though */
+#define SYMREF_MAXDEPTH 5
 
 /* Include broken references in a do_for_each_ref*() iteration: */
 #define DO_FOR_EACH_INCLUDE_BROKEN 0x01
@@ -206,4 +208,8 @@ int rename_ref_available(const char *oldname, const char *newname);
  */
 int do_for_each_ref(const char *submodule, const char *base,
 		    each_ref_fn fn, int trim, int flags, void *cb_data);
+
+int read_raw_ref(const char *refname, unsigned char *sha1,
+		 struct strbuf *symref, unsigned int *flags);
+
 #endif /* REFS_REFS_INTERNAL_H */

-- 
2.4.2.767.g62658d5-twtrsrc
Previous: David TurnerNext: David Turner
Message 28 of 32 in “Yet another pre-refs-backend series”
  1. 00/24 Yet another pre-refs-backend seriesDavid Turner, Apr 7, 2016
  2. 01/24 refs: move head_ref{,_submodule} to the common codeDavid Turner, Apr 7, 2016
  3. 02/24 refs: move for_each_*ref* functions into common codeDavid Turner, Apr 7, 2016
  4. 03/24 t1430: test the output and error of some commands more carefullyDavid Turner, Apr 7, 2016
  5. Michael HaggertyApr 8, 2016
  6. David TurnerApr 8, 2016
  7. Junio C HamanoApr 8, 2016
  8. David TurnerApr 8, 2016
  9. 04/24 t1430: clean up broken refs/tags/shadowDavid Turner, Apr 7, 2016
  10. 05/24 t1430: don't rely on symbolic-ref for creating broken symrefsDavid Turner, Apr 7, 2016
  11. 06/24 t1430: test for-each-ref in the presence of badly-named refsDavid Turner, Apr 7, 2016
  12. 07/24 t1430: improve test coverage of deletion of badly-named refsDavid Turner, Apr 7, 2016
  13. 08/24 resolve_missing_loose_ref(): simplify semanticsDavid Turner, Apr 7, 2016
  14. 09/24 resolve_ref_unsafe(): use for loop to count up to MAXDEPTHDavid Turner, Apr 7, 2016
  15. 10/24 resolve_ref_unsafe(): ensure flags is always setDavid Turner, Apr 7, 2016
  16. 11/24 resolve_ref_1(): eliminate local variableDavid Turner, Apr 7, 2016
  17. 12/24 resolve_ref_1(): reorder codeDavid Turner, Apr 7, 2016
  18. 13/24 resolve_ref_1(): eliminate local variable "bad_name"David Turner, Apr 7, 2016
  19. 14/24 files-backend: break out ref readingDavid Turner, Apr 7, 2016
  20. 15/24 read_raw_ref(): manage own scratch spaceDavid Turner, Apr 7, 2016
  21. 16/24 Inline resolve_ref_1() into resolve_ref_unsafe()David Turner, Apr 7, 2016
  22. 17/24 read_raw_ref(): change flags parameter to unsigned intDavid Turner, Apr 7, 2016
  23. 18/24 fsck_head_link(): remove unneeded flag variableDavid Turner, Apr 7, 2016
  24. 19/24 cmd_merge(): remove unneeded flag variableDavid Turner, Apr 7, 2016
  25. 20/24 checkout_paths(): remove unneeded flag variableDavid Turner, Apr 7, 2016
  26. 21/24 check_aliased_update(): check that dst_name is non-NULLDavid Turner, Apr 7, 2016
  27. 22/24 show_head_ref(): check the result of resolve_ref_namespace()David Turner, Apr 7, 2016
  28. 23/24 refs: move resolve_ref_unsafe into common codeDavid Turner, Apr 7, 2016
  29. 24/24 refs: on symref reflog expire, lock symref not referrentDavid Turner, Apr 7, 2016
  30. Junio C HamanoApr 7, 2016
  31. Michael HaggertyApr 9, 2016
  32. Junio C HamanoApr 10, 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.