From: mhagger@alum.mit.edu
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>,
Jakub Narebski <jnareb@gmail.com>,
Heiko Voigt <hvoigt@hvoigt.net>,
Johan Herland <johan@herland.net>,
Michael Haggerty <mhagger@alum.mit.edu>
Subject: [PATCH 30/30] refs: read loose references lazily
Date: Wed, 25 Apr 2012 00:45:36 +0200 [thread overview]
Message-ID: <1335307536-26914-31-git-send-email-mhagger@alum.mit.edu> (raw)
In-Reply-To: <1335307536-26914-1-git-send-email-mhagger@alum.mit.edu>
From: Michael Haggerty <mhagger@alum.mit.edu>
Instead of reading the whole directory of loose references the first
time any are needed, only read them on demand, one directory at a
time.
Use a new ref_entry flag value REF_DIR_INCOMPLETE to indicate that the
entry represents a REF_DIR that hasn't been read yet. Whenever any
entries from such a directory are needed, read all of the loose
references from that directory.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
refs.c | 107 +++++++++++++++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 86 insertions(+), 21 deletions(-)
diff --git a/refs.c b/refs.c
index 869c9a7..d72208a 100644
--- a/refs.c
+++ b/refs.c
@@ -101,6 +101,12 @@ int check_refname_format(const char *refname, int flags)
struct ref_entry;
+/*
+ * Information used (along with the information in ref_entry) to
+ * describe a single cached reference. This data structure only
+ * occurs embedded in a union in struct ref_entry, and only when
+ * (ref_entry->flag & REF_DIR) is zero.
+ */
struct ref_value {
unsigned char sha1[20];
unsigned char peeled[20];
@@ -108,6 +114,34 @@ struct ref_value {
struct ref_cache;
+/*
+ * Information used (along with the information in ref_entry) to
+ * describe a level in the hierarchy of references. This data
+ * structure only occurs embedded in a union in struct ref_entry, and
+ * only when (ref_entry.flag & REF_DIR) is nonzero. In that case,
+ * (ref_entry.flag & REF_DIR) can take the following values:
+ *
+ * REF_DIR_COMPLETE -- a directory of loose or packed references,
+ * already read.
+ *
+ * REF_DIR_INCOMPLETE -- a directory of loose references that
+ * hasn't been read yet (nor has any of its subdirectories).
+ *
+ * Entries within a directory are stored within a growable array of
+ * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
+ * sorted are sorted by their component name in strcmp() order and the
+ * remaining entries are unsorted.
+ *
+ * Loose references are read lazily, one directory at a time. When a
+ * directory of loose references is read, then all of the references
+ * in that directory are stored, and REF_DIR_INCOMPLETE stubs are
+ * created for any subdirectories, but the subdirectories themselves
+ * are not read. The reading is triggered either by search_ref_dir()
+ * (called when single references are added or interrogated), by
+ * sort_ref_dir(), or by iteration over a subdirectory of references
+ * using one of the for_each_ref*() functions (because these functions
+ * call sort_ref_dir() for each subdirectory).
+ */
struct ref_dir {
int nr, alloc;
@@ -127,19 +161,33 @@ struct ref_dir {
/* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
#define REF_KNOWS_PEELED 0x08
-#define REF_DIR 0x10
+
+/* If any of these bits are set, the entry represents a directory: */
+#define REF_DIR 0x30
+
+/* A directory that has already been fully read. */
+#define REF_DIR_COMPLETE 0x10
+
+/* A directory of loose references that has not yet been fully read. */
+#define REF_DIR_INCOMPLETE 0x20
/*
* A ref_entry represents either a reference or a "subdirectory" of
- * references. Each directory in the reference namespace is
- * represented by a ref_entry with (flags & REF_DIR) set and
- * containing a subdir member that holds the entries in that
- * directory. References are represented by a ref_entry with (flags &
- * REF_DIR) unset and a value member that describes the reference's
- * value. The flag member is at the ref_entry level, but it is also
- * needed to interpret the contents of the value field (in other
- * words, a ref_value object is not very much use without the
- * enclosing ref_entry).
+ * references.
+ *
+ * Each directory in the reference namespace is represented by a
+ * ref_entry with (flags & REF_DIR) set and containing a subdir member
+ * that holds the entries in that directory that have been read so
+ * far. If (flags & REF_DIR) == REF_DIR_INCOMPLETE, then the
+ * directory and its subdirectories haven't been read yet.
+ * REF_DIR_INCOMPLETE is only used for loose references.
+ *
+ * References are represented by a ref_entry with (flags & REF_DIR) ==
+ * 0 and a value member that describes the reference's value. The
+ * flag member is at the ref_entry level, but it is also needed to
+ * interpret the contents of the value field (in other words, a
+ * ref_value object is not very much use without the enclosing
+ * ref_entry).
*
* Reference names cannot end with slash and directories' names are
* always stored with a trailing slash (except for the top-level
@@ -207,11 +255,13 @@ static void free_ref_entry(struct ref_entry *entry)
/*
* Add entry to the end of direntry, unsorted. entry is always stored
* directly in direntry; no recursion into subdirectories is done.
+ * direntry must already be REF_DIR_COMPLETE.
*/
static void add_entry(struct ref_entry *direntry, struct ref_entry *entry)
{
struct ref_dir *dir;
assert(direntry->flag & REF_DIR);
+ assert((direntry->flag & REF_DIR) == REF_DIR_COMPLETE);
dir = &direntry->u.subdir;
ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
dir->entries[dir->nr++] = entry;
@@ -256,10 +306,12 @@ static int ref_entry_cmp(const void *a, const void *b)
static void sort_ref_dir(struct ref_entry *direntry);
+static void read_loose_refs(struct ref_entry *direntry);
+
/*
* Return the entry with the given refname from direntry
- * (non-recursively), sorting direntry if necessary. Return NULL if
- * no such entry is found.
+ * (non-recursively), reading direntry if it is REF_DIR_INCOMPLETE and
+ * sorting it if necessary. Return NULL if no such entry is found.
*/
static struct ref_entry *search_ref_dir(struct ref_entry *direntry,
const char *refname)
@@ -269,6 +321,7 @@ static struct ref_entry *search_ref_dir(struct ref_entry *direntry,
struct ref_dir *dir;
assert(direntry->flag & REF_DIR);
+ read_loose_refs(direntry);
dir = &direntry->u.subdir;
if (refname == NULL || !dir->nr)
return NULL;
@@ -303,8 +356,14 @@ static struct ref_entry *search_for_subdir(struct ref_entry *direntry,
if (!entry) {
if (!mkdir)
return NULL;
+ /*
+ * If search_ref_dir() above didn't make the
+ * entry spring into existence, then this must
+ * not be an unread loose reference tree, so
+ * the correct flag is REF_DIR_COMPLETE.
+ */
entry = create_dir_entry(direntry->u.subdir.ref_cache,
- subdirname, REF_DIR);
+ subdirname, REF_DIR_COMPLETE);
add_entry(direntry, entry);
}
assert(entry->flag & REF_DIR);
@@ -395,7 +454,8 @@ static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2
/*
* Sort the entries in direntry non-recursively (if they are not
- * already sorted) and remove any duplicate entries.
+ * already sorted) and remove any duplicate entries. If direntry is
+ * REF_DIR_INCOMPLETE, read it from disk first.
*/
static void sort_ref_dir(struct ref_entry *direntry)
{
@@ -404,6 +464,7 @@ static void sort_ref_dir(struct ref_entry *direntry)
struct ref_dir *dir;
assert(direntry->flag & REF_DIR);
+ read_loose_refs(direntry);
dir = &direntry->u.subdir;
/*
* This check also prevents passing a zero-length array to qsort(),
@@ -768,7 +829,7 @@ static struct ref_entry *get_packed_refs(struct ref_cache *refs)
const char *packed_refs_file;
FILE *f;
- refs->packed = create_dir_entry(refs, "", REF_DIR);
+ refs->packed = create_dir_entry(refs, "", REF_DIR_COMPLETE);
if (*refs->name)
packed_refs_file = git_path_submodule(refs->name, "packed-refs");
else
@@ -797,12 +858,15 @@ static void read_loose_refs(struct ref_entry *direntry)
const char *path;
struct dirent *de;
const char *dirname = direntry->name;
- int dirnamelen = strlen(dirname);
+ int dirnamelen;
struct strbuf refname;
struct ref_cache *refs;
assert(direntry->flag & REF_DIR);
-
+ if ((direntry->flag & REF_DIR) != REF_DIR_INCOMPLETE)
+ return;
+ direntry->flag = REF_DIR_COMPLETE;
+ dirnamelen = strlen(dirname);
refs = direntry->u.subdir.ref_cache;
if (*refs->name)
path = git_path_submodule(refs->name, "%s", dirname);
@@ -834,8 +898,9 @@ static void read_loose_refs(struct ref_entry *direntry)
/* Silently ignore. */
} else if (S_ISDIR(st.st_mode)) {
strbuf_addch(&refname, '/');
- read_loose_refs(search_for_subdir(direntry,
- refname.buf, 1));
+ add_entry(direntry,
+ create_dir_entry(refs, refname.buf,
+ REF_DIR_INCOMPLETE));
} else {
if (*refs->name) {
hashclr(sha1);
@@ -860,8 +925,8 @@ static void read_loose_refs(struct ref_entry *direntry)
static struct ref_entry *get_loose_refs(struct ref_cache *refs)
{
if (!refs->loose) {
- refs->loose = create_dir_entry(refs, "", REF_DIR);
- read_loose_refs(search_for_subdir(refs->loose, "refs/", 1));
+ refs->loose = create_dir_entry(refs, "", REF_DIR_COMPLETE);
+ add_entry(refs->loose, create_dir_entry(refs, "refs/", REF_DIR_INCOMPLETE));
}
return refs->loose;
}
--
1.7.10
next prev parent reply other threads:[~2012-04-24 22:57 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-04-24 22:45 [PATCH 00/30] Read loose references lazily mhagger
2012-04-24 22:45 ` [PATCH 01/30] get_ref_dir(): return early if directory cannot be read mhagger
2012-04-24 22:45 ` [PATCH 02/30] get_ref_dir(): use a strbuf to hold refname mhagger
2012-04-24 22:45 ` [PATCH 03/30] get_ref_dir(): rename "base" parameter to "dirname" mhagger
2012-04-24 22:45 ` [PATCH 04/30] get_ref_dir(): require that the dirname argument ends in '/' mhagger
2012-04-24 22:45 ` [PATCH 05/30] refs.c: extract function search_for_subdir() mhagger
2012-04-24 22:45 ` [PATCH 06/30] get_ref_dir(): take the containing directory as argument mhagger
2012-04-24 22:45 ` [PATCH 07/30] do_for_each_reflog(): return early on error mhagger
2012-04-24 22:45 ` [PATCH 08/30] do_for_each_reflog(): use a strbuf to hold logfile name mhagger
2012-04-24 22:45 ` [PATCH 09/30] do_for_each_reflog(): reuse strbuf across recursive function calls mhagger
2012-04-24 22:45 ` [PATCH 10/30] refs: wrap top-level ref_dirs in ref_entries mhagger
2012-04-26 14:38 ` Michael Haggerty
2012-04-24 22:45 ` [PATCH 11/30] get_packed_refs(): return (ref_entry *) instead of (ref_dir *) mhagger
2012-04-24 22:45 ` [PATCH 12/30] get_loose_refs(): " mhagger
2012-04-24 22:45 ` [PATCH 13/30] is_refname_available(): take " mhagger
2012-04-24 22:45 ` [PATCH 14/30] find_ref(): " mhagger
2012-04-24 22:45 ` [PATCH 15/30] read_packed_refs(): " mhagger
2012-04-24 22:45 ` [PATCH 16/30] add_ref(): " mhagger
2012-04-24 22:45 ` [PATCH 17/30] find_containing_direntry(): use " mhagger
2012-04-24 22:45 ` [PATCH 18/30] get_ref_dir(): take " mhagger
2012-04-24 22:45 ` [PATCH 19/30] get_ref_dir(): remove dirname argument mhagger
2012-04-24 22:45 ` [PATCH 20/30] search_for_subdir(): take (ref_entry *) instead of (ref_dir *) mhagger
2012-04-24 22:45 ` [PATCH 21/30] search_ref_dir(): " mhagger
2012-04-24 22:45 ` [PATCH 22/30] add_entry(): " mhagger
2012-04-24 22:45 ` [PATCH 23/30] do_for_each_ref_in_dirs(): " mhagger
2012-04-24 22:45 ` [PATCH 24/30] do_for_each_ref_in_dir(): " mhagger
2012-04-24 22:45 ` [PATCH 25/30] sort_ref_dir(): " mhagger
2012-04-24 22:45 ` [PATCH 26/30] struct ref_dir: store a reference to the enclosing ref_cache mhagger
2012-04-24 22:45 ` [PATCH 27/30] read_loose_refs(): rename function from get_ref_dir() mhagger
2012-04-24 22:45 ` [PATCH 28/30] read_loose_refs(): access ref_cache via the ref_dir field mhagger
2012-04-24 22:45 ` [PATCH 29/30] create_dir_entry(): allow the flag value to be passed as an argument mhagger
2012-04-25 18:31 ` Junio C Hamano
2012-04-25 18:52 ` Junio C Hamano
2012-04-26 21:12 ` Michael Haggerty
2012-04-24 22:45 ` mhagger [this message]
2012-04-25 18:39 ` [PATCH 00/30] Read loose references lazily Junio C Hamano
2012-04-26 21:33 ` Michael Haggerty
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1335307536-26914-31-git-send-email-mhagger@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=hvoigt@hvoigt.net \
--cc=jnareb@gmail.com \
--cc=johan@herland.net \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).