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

[PATCH 16/28] packed_ref_store: support iteration

From
Michael Haggerty <mhagger@alum.mit.edu>
Date
Jun 15, 2017, 14:47 UTC
Message-ID
<ca6b06eb7071305e5ddbd3803263285ca89785b3.1497534157.git.mhagger@alum.mit.edu>
In-Reply-To
<cover.1497534157.git.mhagger@alum.mit.edu>

Add the infrastructure to iterate over a `packed_ref_store`. It's a lot of boilerplate, but it's all part of a campaign to make `packed_ref_store` implement `ref_store`. In the future, this iterator will work much differently.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
 refs/files-backend.c | 107 ++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 98 insertions(+), 9 deletions(-)
diff --git a/refs/files-backend.c b/refs/files-backend.c
index 185d05e1d6..e57cdeba36 100644
--- a/refs/files-backend.c
+++ b/refs/files-backend.c
@@ -1062,10 +1062,102 @@ static int files_peel_ref(struct ref_store *ref_store,
 	return peel_object(base, sha1);
 }
 
+struct packed_ref_iterator {
+	struct ref_iterator base;
+
+	struct packed_ref_cache *cache;
+	struct ref_iterator *iter0;
+	unsigned int flags;
+};
+
+static int packed_ref_iterator_advance(struct ref_iterator *ref_iterator)
+{
+	struct packed_ref_iterator *iter =
+		(struct packed_ref_iterator *)ref_iterator;
+	int ok;
+
+	while ((ok = ref_iterator_advance(iter->iter0)) == ITER_OK) {
+		if (iter->flags & DO_FOR_EACH_PER_WORKTREE_ONLY &&
+		    ref_type(iter->iter0->refname) != REF_TYPE_PER_WORKTREE)
+			continue;
+
+		if (!(iter->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
+		    !ref_resolves_to_object(iter->iter0->refname,
+					    iter->iter0->oid,
+					    iter->iter0->flags))
+			continue;
+
+		iter->base.refname = iter->iter0->refname;
+		iter->base.oid = iter->iter0->oid;
+		iter->base.flags = iter->iter0->flags;
+		return ITER_OK;
+	}
+
+	iter->iter0 = NULL;
+	if (ref_iterator_abort(ref_iterator) != ITER_DONE)
+		ok = ITER_ERROR;
+
+	return ok;
+}
+
+static int packed_ref_iterator_peel(struct ref_iterator *ref_iterator,
+				   struct object_id *peeled)
+{
+	struct packed_ref_iterator *iter =
+		(struct packed_ref_iterator *)ref_iterator;
+
+	return ref_iterator_peel(iter->iter0, peeled);
+}
+
+static int packed_ref_iterator_abort(struct ref_iterator *ref_iterator)
+{
+	struct packed_ref_iterator *iter =
+		(struct packed_ref_iterator *)ref_iterator;
+	int ok = ITER_DONE;
+
+	if (iter->iter0)
+		ok = ref_iterator_abort(iter->iter0);
+
+	release_packed_ref_cache(iter->cache);
+	base_ref_iterator_free(ref_iterator);
+	return ok;
+}
+
+static struct ref_iterator_vtable packed_ref_iterator_vtable = {
+	packed_ref_iterator_advance,
+	packed_ref_iterator_peel,
+	packed_ref_iterator_abort
+};
+
+static struct ref_iterator *packed_ref_iterator_begin(
+		struct packed_ref_store *refs,
+		const char *prefix, unsigned int flags)
+{
+	struct packed_ref_iterator *iter;
+	struct ref_iterator *ref_iterator;
+
+	iter = xcalloc(1, sizeof(*iter));
+	ref_iterator = &iter->base;
+	base_ref_iterator_init(ref_iterator, &packed_ref_iterator_vtable);
+
+	/*
+	 * Note that get_packed_ref_cache() internally checks whether
+	 * the packed-ref cache is up to date with what is on disk,
+	 * and re-reads it if not.
+	 */
+
+	iter->cache = get_packed_ref_cache(refs);
+	acquire_packed_ref_cache(iter->cache);
+	iter->iter0 = cache_ref_iterator_begin(iter->cache->cache, prefix, 0);
+
+	iter->flags = flags;
+
+	return ref_iterator;
+}
+
 struct files_ref_iterator {
 	struct ref_iterator base;
 
-	struct packed_ref_cache *packed_ref_cache;
 	struct ref_iterator *iter0;
 	unsigned int flags;
 };
@@ -1118,7 +1210,6 @@ static int files_ref_iterator_abort(struct ref_iterator *ref_iterator)
 	if (iter->iter0)
 		ok = ref_iterator_abort(iter->iter0);
 
-	release_packed_ref_cache(iter->packed_ref_cache);
 	base_ref_iterator_free(ref_iterator);
 	return ok;
 }
@@ -1160,18 +1251,16 @@ static struct ref_iterator *files_ref_iterator_begin(
 	 * (If they've already been read, that's OK; we only need to
 	 * guarantee that they're read before the packed refs, not
 	 * *how much* before.) After that, we call
-	 * get_packed_ref_cache(), which internally checks whether the
-	 * packed-ref cache is up to date with what is on disk, and
-	 * re-reads it if not.
+	 * packed_ref_iterator_begin(), which internally checks
+	 * whether the packed-ref cache is up to date with what is on
+	 * disk, and re-reads it if not.
 	 */
 
 	loose_iter = cache_ref_iterator_begin(get_loose_ref_cache(refs),
 					      prefix, 1);
 
-	iter->packed_ref_cache = get_packed_ref_cache(refs->packed_ref_store);
-	acquire_packed_ref_cache(iter->packed_ref_cache);
-	packed_iter = cache_ref_iterator_begin(iter->packed_ref_cache->cache,
-					       prefix, 0);
+	packed_iter = packed_ref_iterator_begin(refs->packed_ref_store,
+						prefix, 0);
 
 	iter->iter0 = overlay_ref_iterator_begin(loose_iter, packed_iter);
 	iter->flags = flags;
-- 
2.11.0
Previous: Stefan BellerNext: Michael Haggerty
Message 20 of 52 in “Create a reference backend for packed refs”
  1. 00/28 Create a reference backend for packed refsMichael Haggerty, Jun 15, 2017
  2. 01/28 add_packed_ref(): teach function to overwrite existing refsMichael Haggerty, Jun 15, 2017
  3. 03/28 packed_ref_store: move `packed_refs_path` hereMichael Haggerty, Jun 15, 2017
  4. Stefan BellerJun 16, 2017
  5. 04/28 packed_ref_store: move `packed_refs_lock` member hereMichael Haggerty, Jun 15, 2017
  6. Stefan BellerJun 16, 2017
  7. Michael HaggertyJun 16, 2017
  8. Stefan BellerJun 16, 2017
  9. 07/28 get_packed_ref_cache(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  10. 08/28 get_packed_refs(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  11. 09/28 add_packed_ref(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  12. 10/28 lock_packed_refs(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  13. 11/28 commit_packed_refs(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  14. 13/28 get_packed_ref(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  15. 14/28 repack_without_refs(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  16. 15/28 packed_peel_ref(): new function, extracted from `files_peel_ref()`Michael Haggerty, Jun 15, 2017
  17. Stefan BellerJun 16, 2017
  18. Michael HaggertyJun 16, 2017
  19. Stefan BellerJun 16, 2017
  20. 16/28 packed_ref_store: support iterationMichael Haggerty, Jun 15, 2017
  21. 17/28 packed_read_raw_ref(): new function, replacing `resolve_packed_ref()`Michael Haggerty, Jun 15, 2017
  22. 19/28 packed_ref_store: make class into a subclass of `ref_store`Michael Haggerty, Jun 15, 2017
  23. 20/28 commit_packed_refs(): report errors rather than dyingMichael Haggerty, Jun 15, 2017
  24. 21/28 commit_packed_refs(): use a staging file separate from the lockfileMichael Haggerty, Jun 15, 2017
  25. Junio C HamanoJul 20, 2017
  26. Jonathan NiederJul 20, 2017
  27. Junio C HamanoJul 21, 2017
  28. Junio C HamanoJul 21, 2017
  29. Jeff KingJul 24, 2017
  30. Jonathan NiederJul 24, 2017
  31. Jeff KingJul 24, 2017
  32. Junio C HamanoJul 24, 2017
  33. Michael HaggertyJul 26, 2017
  34. 22/28 packed_refs_lock(): function renamed from lock_packed_refs()Michael Haggerty, Jun 15, 2017
  35. 18/28 packed-backend: new module for handling packed referencesMichael Haggerty, Jun 15, 2017
  36. Stefan BellerJun 16, 2017
  37. 24/28 packed_refs_unlock(), packed_refs_is_locked(): new functionsMichael Haggerty, Jun 15, 2017
  38. 26/28 commit_packed_refs(): remove call to `packed_refs_unlock()`Michael Haggerty, Jun 15, 2017
  39. 28/28 read_packed_refs(): die if `packed-refs` contains bogus dataMichael Haggerty, Jun 15, 2017
  40. 23/28 packed_refs_lock(): report errors via a `struct strbuf *err`Michael Haggerty, Jun 15, 2017
  41. 27/28 repack_without_refs(): don't lock or unlock the packed refsMichael Haggerty, Jun 15, 2017
  42. 25/28 clear_packed_ref_cache(): don't protest if the lock is heldMichael Haggerty, Jun 15, 2017
  43. 12/28 rollback_packed_refs(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  44. 02/28 packed_ref_store: new structMichael Haggerty, Jun 15, 2017
  45. 06/28 validate_packed_ref_cache(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  46. 05/28 clear_packed_ref_cache(): take a `packed_ref_store *` parameterMichael Haggerty, Jun 15, 2017
  47. Junio C HamanoJun 19, 2017
  48. Junio C HamanoJun 19, 2017
  49. Jeff KingJun 19, 2017
  50. Jeff KingJun 19, 2017
  51. Michael HaggertyJun 22, 2017
  52. Junio C HamanoJun 22, 2017

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.