refs: rename struct ref_cache to files_ref_store

The greater goal of this patch series is to develop the concept of a
reference store, which is a place that references, their values, and
their reflogs are stored, and to virtualize the reference interface so
that different types of ref_stores can be implemented. We will then, for
example, use ref_store instances to access submodule references and
worktree references.

Currently, we keep a ref_cache for each submodule that has had its
references iterated over. It is a far cry from a ref_store, but they are
stored the way we will want to store ref_stores, and ref_stores will
eventually have to hold the reference caches. So let's treat ref_caches
as embryo ref_stores, and build them out from there.

As the first step, simply rename `ref_cache` to `files_ref_store`, and
rename some functions and attributes correspondingly.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Michael Haggerty 2016-09-04 18:08:09 +02:00 committed by Junio C Hamano
parent ff3a299c45
commit 65a0a8e5fa
1 changed files with 63 additions and 63 deletions

View File

@ -39,7 +39,7 @@ struct ref_value {
struct object_id peeled; struct object_id peeled;
}; };


struct ref_cache; struct files_ref_store;


/* /*
* Information used (along with the information in ref_entry) to * Information used (along with the information in ref_entry) to
@ -78,8 +78,8 @@ struct ref_dir {
*/ */
int sorted; int sorted;


/* A pointer to the ref_cache that contains this ref_dir. */ /* A pointer to the files_ref_store that contains this ref_dir. */
struct ref_cache *ref_cache; struct files_ref_store *ref_store;


struct ref_entry **entries; struct ref_entry **entries;
}; };
@ -161,7 +161,7 @@ struct ref_entry {


static void read_loose_refs(const char *dirname, struct ref_dir *dir); static void read_loose_refs(const char *dirname, struct ref_dir *dir);
static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len); static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len);
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache, static struct ref_entry *create_dir_entry(struct files_ref_store *ref_store,
const char *dirname, size_t len, const char *dirname, size_t len,
int incomplete); int incomplete);
static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry); static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry);
@ -183,7 +183,7 @@ static struct ref_dir *get_ref_dir(struct ref_entry *entry)
int pos = search_ref_dir(dir, "refs/bisect/", 12); int pos = search_ref_dir(dir, "refs/bisect/", 12);
if (pos < 0) { if (pos < 0) {
struct ref_entry *child_entry; struct ref_entry *child_entry;
child_entry = create_dir_entry(dir->ref_cache, child_entry = create_dir_entry(dir->ref_store,
"refs/bisect/", "refs/bisect/",
12, 1); 12, 1);
add_entry_to_dir(dir, child_entry); add_entry_to_dir(dir, child_entry);
@ -261,13 +261,13 @@ static void clear_ref_dir(struct ref_dir *dir)
* dirname is the name of the directory with a trailing slash (e.g., * dirname is the name of the directory with a trailing slash (e.g.,
* "refs/heads/") or "" for the top-level directory. * "refs/heads/") or "" for the top-level directory.
*/ */
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache, static struct ref_entry *create_dir_entry(struct files_ref_store *ref_store,
const char *dirname, size_t len, const char *dirname, size_t len,
int incomplete) int incomplete)
{ {
struct ref_entry *direntry; struct ref_entry *direntry;
FLEX_ALLOC_MEM(direntry, name, dirname, len); FLEX_ALLOC_MEM(direntry, name, dirname, len);
direntry->u.subdir.ref_cache = ref_cache; direntry->u.subdir.ref_store = ref_store;
direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0); direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
return direntry; return direntry;
} }
@ -343,7 +343,7 @@ static struct ref_dir *search_for_subdir(struct ref_dir *dir,
* therefore, create an empty record for it but mark * therefore, create an empty record for it but mark
* the record complete. * the record complete.
*/ */
entry = create_dir_entry(dir->ref_cache, subdirname, len, 0); entry = create_dir_entry(dir->ref_store, subdirname, len, 0);
add_entry_to_dir(dir, entry); add_entry_to_dir(dir, entry);
} else { } else {
entry = dir->entries[entry_index]; entry = dir->entries[entry_index];
@ -887,9 +887,9 @@ struct packed_ref_cache {


/* /*
* Count of references to the data structure in this instance, * Count of references to the data structure in this instance,
* including the pointer from ref_cache::packed if any. The * including the pointer from files_ref_store::packed if any.
* data will not be freed as long as the reference count is * The data will not be freed as long as the reference count
* nonzero. * is nonzero.
*/ */
unsigned int referrers; unsigned int referrers;


@ -910,17 +910,17 @@ struct packed_ref_cache {
* Future: need to be in "struct repository" * Future: need to be in "struct repository"
* when doing a full libification. * when doing a full libification.
*/ */
static struct ref_cache { static struct files_ref_store {
struct ref_cache *next; struct files_ref_store *next;
struct ref_entry *loose; struct ref_entry *loose;
struct packed_ref_cache *packed; struct packed_ref_cache *packed;
/* /*
* The submodule name, or "" for the main repo. We allocate * The submodule name, or "" for the main repo. We allocate
* length 1 rather than FLEX_ARRAY so that the main ref_cache * length 1 rather than FLEX_ARRAY so that the main
* is initialized correctly. * files_ref_store is initialized correctly.
*/ */
char name[1]; char name[1];
} ref_cache, *submodule_ref_caches; } ref_store, *submodule_ref_stores;


/* Lock used for the main packed-refs file: */ /* Lock used for the main packed-refs file: */
static struct lock_file packlock; static struct lock_file packlock;
@ -949,7 +949,7 @@ static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
} }
} }


static void clear_packed_ref_cache(struct ref_cache *refs) static void clear_packed_ref_cache(struct files_ref_store *refs)
{ {
if (refs->packed) { if (refs->packed) {
struct packed_ref_cache *packed_refs = refs->packed; struct packed_ref_cache *packed_refs = refs->packed;
@ -961,7 +961,7 @@ static void clear_packed_ref_cache(struct ref_cache *refs)
} }
} }


static void clear_loose_ref_cache(struct ref_cache *refs) static void clear_loose_ref_cache(struct files_ref_store *refs)
{ {
if (refs->loose) { if (refs->loose) {
free_ref_entry(refs->loose); free_ref_entry(refs->loose);
@ -973,32 +973,32 @@ static void clear_loose_ref_cache(struct ref_cache *refs)
* Create a new submodule ref cache and add it to the internal * Create a new submodule ref cache and add it to the internal
* set of caches. * set of caches.
*/ */
static struct ref_cache *create_ref_cache(const char *submodule) static struct files_ref_store *create_ref_store(const char *submodule)
{ {
struct ref_cache *refs; struct files_ref_store *refs;
if (!submodule) if (!submodule)
submodule = ""; submodule = "";
FLEX_ALLOC_STR(refs, name, submodule); FLEX_ALLOC_STR(refs, name, submodule);
refs->next = submodule_ref_caches; refs->next = submodule_ref_stores;
submodule_ref_caches = refs; submodule_ref_stores = refs;
return refs; return refs;
} }


static struct ref_cache *lookup_ref_cache(const char *submodule) static struct files_ref_store *lookup_ref_store(const char *submodule)
{ {
struct ref_cache *refs; struct files_ref_store *refs;


if (!submodule || !*submodule) if (!submodule || !*submodule)
return &ref_cache; return &ref_store;


for (refs = submodule_ref_caches; refs; refs = refs->next) for (refs = submodule_ref_stores; refs; refs = refs->next)
if (!strcmp(submodule, refs->name)) if (!strcmp(submodule, refs->name))
return refs; return refs;
return NULL; return NULL;
} }


/* /*
* Return a pointer to a ref_cache for the specified submodule. For * Return a pointer to a files_ref_store for the specified submodule. For
* the main repository, use submodule==NULL; such a call cannot fail. * the main repository, use submodule==NULL; such a call cannot fail.
* For a submodule, the submodule must exist and be a nonbare * For a submodule, the submodule must exist and be a nonbare
* repository, otherwise return NULL. * repository, otherwise return NULL.
@ -1006,16 +1006,16 @@ static struct ref_cache *lookup_ref_cache(const char *submodule)
* The returned structure will be allocated and initialized but not * The returned structure will be allocated and initialized but not
* necessarily populated; it should not be freed. * necessarily populated; it should not be freed.
*/ */
static struct ref_cache *get_ref_cache(const char *submodule) static struct files_ref_store *get_ref_store(const char *submodule)
{ {
struct ref_cache *refs = lookup_ref_cache(submodule); struct files_ref_store *refs = lookup_ref_store(submodule);


if (!refs) { if (!refs) {
struct strbuf submodule_sb = STRBUF_INIT; struct strbuf submodule_sb = STRBUF_INIT;


strbuf_addstr(&submodule_sb, submodule); strbuf_addstr(&submodule_sb, submodule);
if (is_nonbare_repository_dir(&submodule_sb)) if (is_nonbare_repository_dir(&submodule_sb))
refs = create_ref_cache(submodule); refs = create_ref_store(submodule);
strbuf_release(&submodule_sb); strbuf_release(&submodule_sb);
} }


@ -1151,10 +1151,10 @@ static void read_packed_refs(FILE *f, struct ref_dir *dir)
} }


/* /*
* Get the packed_ref_cache for the specified ref_cache, creating it * Get the packed_ref_cache for the specified files_ref_store,
* if necessary. * creating it if necessary.
*/ */
static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs) static struct packed_ref_cache *get_packed_ref_cache(struct files_ref_store *refs)
{ {
char *packed_refs_file; char *packed_refs_file;


@ -1189,7 +1189,7 @@ static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_ca
return get_ref_dir(packed_ref_cache->root); return get_ref_dir(packed_ref_cache->root);
} }


static struct ref_dir *get_packed_refs(struct ref_cache *refs) static struct ref_dir *get_packed_refs(struct files_ref_store *refs)
{ {
return get_packed_ref_dir(get_packed_ref_cache(refs)); return get_packed_ref_dir(get_packed_ref_cache(refs));
} }
@ -1203,7 +1203,7 @@ static struct ref_dir *get_packed_refs(struct ref_cache *refs)
static void add_packed_ref(const char *refname, const unsigned char *sha1) static void add_packed_ref(const char *refname, const unsigned char *sha1)
{ {
struct packed_ref_cache *packed_ref_cache = struct packed_ref_cache *packed_ref_cache =
get_packed_ref_cache(&ref_cache); get_packed_ref_cache(&ref_store);


if (!packed_ref_cache->lock) if (!packed_ref_cache->lock)
die("internal error: packed refs not locked"); die("internal error: packed refs not locked");
@ -1218,7 +1218,7 @@ static void add_packed_ref(const char *refname, const unsigned char *sha1)
*/ */
static void read_loose_refs(const char *dirname, struct ref_dir *dir) static void read_loose_refs(const char *dirname, struct ref_dir *dir)
{ {
struct ref_cache *refs = dir->ref_cache; struct files_ref_store *refs = dir->ref_store;
DIR *d; DIR *d;
struct dirent *de; struct dirent *de;
int dirnamelen = strlen(dirname); int dirnamelen = strlen(dirname);
@ -1306,7 +1306,7 @@ static void read_loose_refs(const char *dirname, struct ref_dir *dir)
closedir(d); closedir(d);
} }


static struct ref_dir *get_loose_refs(struct ref_cache *refs) static struct ref_dir *get_loose_refs(struct files_ref_store *refs)
{ {
if (!refs->loose) { if (!refs->loose) {
/* /*
@ -1328,10 +1328,10 @@ static struct ref_dir *get_loose_refs(struct ref_cache *refs)


/* /*
* Called by resolve_gitlink_ref_recursive() after it failed to read * Called by resolve_gitlink_ref_recursive() after it failed to read
* from the loose refs in ref_cache refs. Find <refname> in the * from the loose refs in refs. Find <refname> in the packed-refs file
* packed-refs file for the submodule. * for the submodule.
*/ */
static int resolve_gitlink_packed_ref(struct ref_cache *refs, static int resolve_gitlink_packed_ref(struct files_ref_store *refs,
const char *refname, unsigned char *sha1) const char *refname, unsigned char *sha1)
{ {
struct ref_entry *ref; struct ref_entry *ref;
@ -1345,7 +1345,7 @@ static int resolve_gitlink_packed_ref(struct ref_cache *refs,
return 0; return 0;
} }


static int resolve_gitlink_ref_recursive(struct ref_cache *refs, static int resolve_gitlink_ref_recursive(struct files_ref_store *refs,
const char *refname, unsigned char *sha1, const char *refname, unsigned char *sha1,
int recursion) int recursion)
{ {
@ -1389,7 +1389,7 @@ int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sh
{ {
int len = strlen(path); int len = strlen(path);
struct strbuf submodule = STRBUF_INIT; struct strbuf submodule = STRBUF_INIT;
struct ref_cache *refs; struct files_ref_store *refs;


while (len && path[len-1] == '/') while (len && path[len-1] == '/')
len--; len--;
@ -1397,7 +1397,7 @@ int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sh
return -1; return -1;


strbuf_add(&submodule, path, len); strbuf_add(&submodule, path, len);
refs = get_ref_cache(submodule.buf); refs = get_ref_store(submodule.buf);
if (!refs) { if (!refs) {
strbuf_release(&submodule); strbuf_release(&submodule);
return -1; return -1;
@ -1413,7 +1413,7 @@ int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sh
*/ */
static struct ref_entry *get_packed_ref(const char *refname) static struct ref_entry *get_packed_ref(const char *refname)
{ {
return find_ref(get_packed_refs(&ref_cache), refname); return find_ref(get_packed_refs(&ref_store), refname);
} }


/* /*
@ -1745,7 +1745,7 @@ retry:
REMOVE_DIR_EMPTY_ONLY)) { REMOVE_DIR_EMPTY_ONLY)) {
if (verify_refname_available_dir( if (verify_refname_available_dir(
refname, extras, skip, refname, extras, skip,
get_loose_refs(&ref_cache), get_loose_refs(&ref_store),
err)) { err)) {
/* /*
* The error message set by * The error message set by
@ -1784,7 +1784,7 @@ retry:
*/ */
if (verify_refname_available_dir( if (verify_refname_available_dir(
refname, extras, skip, refname, extras, skip,
get_packed_refs(&ref_cache), get_packed_refs(&ref_store),
err)) { err)) {
goto error_return; goto error_return;
} }
@ -1942,7 +1942,7 @@ struct ref_iterator *files_ref_iterator_begin(
const char *submodule, const char *submodule,
const char *prefix, unsigned int flags) const char *prefix, unsigned int flags)
{ {
struct ref_cache *refs = get_ref_cache(submodule); struct files_ref_store *refs = get_ref_store(submodule);
struct ref_dir *loose_dir, *packed_dir; struct ref_dir *loose_dir, *packed_dir;
struct ref_iterator *loose_iter, *packed_iter; struct ref_iterator *loose_iter, *packed_iter;
struct files_ref_iterator *iter; struct files_ref_iterator *iter;
@ -2096,7 +2096,7 @@ static struct ref_lock *lock_ref_sha1_basic(const char *refname,
if (remove_empty_directories(&ref_file)) { if (remove_empty_directories(&ref_file)) {
last_errno = errno; last_errno = errno;
if (!verify_refname_available_dir(refname, extras, skip, if (!verify_refname_available_dir(refname, extras, skip,
get_loose_refs(&ref_cache), err)) get_loose_refs(&ref_store), err))
strbuf_addf(err, "there are still refs under '%s'", strbuf_addf(err, "there are still refs under '%s'",
refname); refname);
goto error_return; goto error_return;
@ -2108,7 +2108,7 @@ static struct ref_lock *lock_ref_sha1_basic(const char *refname,
last_errno = errno; last_errno = errno;
if (last_errno != ENOTDIR || if (last_errno != ENOTDIR ||
!verify_refname_available_dir(refname, extras, skip, !verify_refname_available_dir(refname, extras, skip,
get_loose_refs(&ref_cache), err)) get_loose_refs(&ref_store), err))
strbuf_addf(err, "unable to resolve reference '%s': %s", strbuf_addf(err, "unable to resolve reference '%s': %s",
refname, strerror(last_errno)); refname, strerror(last_errno));


@ -2123,7 +2123,7 @@ static struct ref_lock *lock_ref_sha1_basic(const char *refname,
*/ */
if (is_null_oid(&lock->old_oid) && if (is_null_oid(&lock->old_oid) &&
verify_refname_available_dir(refname, extras, skip, verify_refname_available_dir(refname, extras, skip,
get_packed_refs(&ref_cache), err)) { get_packed_refs(&ref_store), err)) {
last_errno = ENOTDIR; last_errno = ENOTDIR;
goto error_return; goto error_return;
} }
@ -2232,7 +2232,7 @@ static int lock_packed_refs(int flags)
* this will automatically invalidate the cache and re-read * this will automatically invalidate the cache and re-read
* the packed-refs file. * the packed-refs file.
*/ */
packed_ref_cache = get_packed_ref_cache(&ref_cache); packed_ref_cache = get_packed_ref_cache(&ref_store);
packed_ref_cache->lock = &packlock; packed_ref_cache->lock = &packlock;
/* Increment the reference count to prevent it from being freed: */ /* Increment the reference count to prevent it from being freed: */
acquire_packed_ref_cache(packed_ref_cache); acquire_packed_ref_cache(packed_ref_cache);
@ -2248,7 +2248,7 @@ static int lock_packed_refs(int flags)
static int commit_packed_refs(void) static int commit_packed_refs(void)
{ {
struct packed_ref_cache *packed_ref_cache = struct packed_ref_cache *packed_ref_cache =
get_packed_ref_cache(&ref_cache); get_packed_ref_cache(&ref_store);
int error = 0; int error = 0;
int save_errno = 0; int save_errno = 0;
FILE *out; FILE *out;
@ -2282,14 +2282,14 @@ static int commit_packed_refs(void)
static void rollback_packed_refs(void) static void rollback_packed_refs(void)
{ {
struct packed_ref_cache *packed_ref_cache = struct packed_ref_cache *packed_ref_cache =
get_packed_ref_cache(&ref_cache); get_packed_ref_cache(&ref_store);


if (!packed_ref_cache->lock) if (!packed_ref_cache->lock)
die("internal error: packed-refs not locked"); die("internal error: packed-refs not locked");
rollback_lock_file(packed_ref_cache->lock); rollback_lock_file(packed_ref_cache->lock);
packed_ref_cache->lock = NULL; packed_ref_cache->lock = NULL;
release_packed_ref_cache(packed_ref_cache); release_packed_ref_cache(packed_ref_cache);
clear_packed_ref_cache(&ref_cache); clear_packed_ref_cache(&ref_store);
} }


struct ref_to_prune { struct ref_to_prune {
@ -2428,9 +2428,9 @@ int pack_refs(unsigned int flags)
cbdata.flags = flags; cbdata.flags = flags;


lock_packed_refs(LOCK_DIE_ON_ERROR); lock_packed_refs(LOCK_DIE_ON_ERROR);
cbdata.packed_refs = get_packed_refs(&ref_cache); cbdata.packed_refs = get_packed_refs(&ref_store);


do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0, do_for_each_entry_in_dir(get_loose_refs(&ref_store), 0,
pack_if_possible_fn, &cbdata); pack_if_possible_fn, &cbdata);


if (commit_packed_refs()) if (commit_packed_refs())
@ -2471,7 +2471,7 @@ static int repack_without_refs(struct string_list *refnames, struct strbuf *err)
unable_to_lock_message(git_path("packed-refs"), errno, err); unable_to_lock_message(git_path("packed-refs"), errno, err);
return -1; return -1;
} }
packed = get_packed_refs(&ref_cache); packed = get_packed_refs(&ref_store);


/* Remove refnames from the cache */ /* Remove refnames from the cache */
for_each_string_list_item(refname, refnames) for_each_string_list_item(refname, refnames)
@ -2616,8 +2616,8 @@ int verify_refname_available(const char *newname,
const struct string_list *skip, const struct string_list *skip,
struct strbuf *err) struct strbuf *err)
{ {
struct ref_dir *packed_refs = get_packed_refs(&ref_cache); struct ref_dir *packed_refs = get_packed_refs(&ref_store);
struct ref_dir *loose_refs = get_loose_refs(&ref_cache); struct ref_dir *loose_refs = get_loose_refs(&ref_store);


if (verify_refname_available_dir(newname, extras, skip, if (verify_refname_available_dir(newname, extras, skip,
packed_refs, err) || packed_refs, err) ||
@ -2968,7 +2968,7 @@ static int commit_ref_update(struct ref_lock *lock,
const unsigned char *sha1, const char *logmsg, const unsigned char *sha1, const char *logmsg,
struct strbuf *err) struct strbuf *err)
{ {
clear_loose_ref_cache(&ref_cache); clear_loose_ref_cache(&ref_store);
if (log_ref_write(lock->ref_name, lock->old_oid.hash, sha1, logmsg, 0, err)) { if (log_ref_write(lock->ref_name, lock->old_oid.hash, sha1, logmsg, 0, err)) {
char *old_msg = strbuf_detach(err, NULL); char *old_msg = strbuf_detach(err, NULL);
strbuf_addf(err, "cannot update the ref '%s': %s", strbuf_addf(err, "cannot update the ref '%s': %s",
@ -3790,7 +3790,7 @@ int ref_transaction_commit(struct ref_transaction *transaction,
} }
} }
if (update->flags & REF_NEEDS_COMMIT) { if (update->flags & REF_NEEDS_COMMIT) {
clear_loose_ref_cache(&ref_cache); clear_loose_ref_cache(&ref_store);
if (commit_ref(lock)) { if (commit_ref(lock)) {
strbuf_addf(err, "couldn't set '%s'", lock->ref_name); strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
unlock_ref(lock); unlock_ref(lock);
@ -3823,7 +3823,7 @@ int ref_transaction_commit(struct ref_transaction *transaction,
} }
for_each_string_list_item(ref_to_delete, &refs_to_delete) for_each_string_list_item(ref_to_delete, &refs_to_delete)
unlink_or_warn(git_path("logs/%s", ref_to_delete->string)); unlink_or_warn(git_path("logs/%s", ref_to_delete->string));
clear_loose_ref_cache(&ref_cache); clear_loose_ref_cache(&ref_store);


cleanup: cleanup:
transaction->state = REF_TRANSACTION_CLOSED; transaction->state = REF_TRANSACTION_CLOSED;