3 #include "refs-internal.h"
5 #include "../iterator.h"
7 void add_entry_to_dir(struct ref_dir
*dir
, struct ref_entry
*entry
)
9 ALLOC_GROW(dir
->entries
, dir
->nr
+ 1, dir
->alloc
);
10 dir
->entries
[dir
->nr
++] = entry
;
11 /* optimize for the case that entries are added in order */
13 (dir
->nr
== dir
->sorted
+ 1 &&
14 strcmp(dir
->entries
[dir
->nr
- 2]->name
,
15 dir
->entries
[dir
->nr
- 1]->name
) < 0))
16 dir
->sorted
= dir
->nr
;
19 struct ref_dir
*get_ref_dir(struct ref_entry
*entry
)
22 assert(entry
->flag
& REF_DIR
);
23 dir
= &entry
->u
.subdir
;
24 if (entry
->flag
& REF_INCOMPLETE
) {
25 if (!dir
->cache
->fill_ref_dir
)
26 BUG("incomplete ref_store without fill_ref_dir function");
28 dir
->cache
->fill_ref_dir(dir
->cache
->ref_store
, dir
, entry
->name
);
29 entry
->flag
&= ~REF_INCOMPLETE
;
34 struct ref_entry
*create_ref_entry(const char *refname
,
35 const struct object_id
*oid
, int flag
)
37 struct ref_entry
*ref
;
39 FLEX_ALLOC_STR(ref
, name
, refname
);
40 oidcpy(&ref
->u
.value
.oid
, oid
);
45 struct ref_cache
*create_ref_cache(struct ref_store
*refs
,
46 fill_ref_dir_fn
*fill_ref_dir
)
48 struct ref_cache
*ret
= xcalloc(1, sizeof(*ret
));
50 ret
->ref_store
= refs
;
51 ret
->fill_ref_dir
= fill_ref_dir
;
52 ret
->root
= create_dir_entry(ret
, "", 0);
56 static void clear_ref_dir(struct ref_dir
*dir
);
58 static void free_ref_entry(struct ref_entry
*entry
)
60 if (entry
->flag
& REF_DIR
) {
62 * Do not use get_ref_dir() here, as that might
63 * trigger the reading of loose refs.
65 clear_ref_dir(&entry
->u
.subdir
);
70 void free_ref_cache(struct ref_cache
*cache
)
72 free_ref_entry(cache
->root
);
77 * Clear and free all entries in dir, recursively.
79 static void clear_ref_dir(struct ref_dir
*dir
)
82 for (i
= 0; i
< dir
->nr
; i
++)
83 free_ref_entry(dir
->entries
[i
]);
84 FREE_AND_NULL(dir
->entries
);
85 dir
->sorted
= dir
->nr
= dir
->alloc
= 0;
88 struct ref_entry
*create_dir_entry(struct ref_cache
*cache
,
89 const char *dirname
, size_t len
)
91 struct ref_entry
*direntry
;
93 FLEX_ALLOC_MEM(direntry
, name
, dirname
, len
);
94 direntry
->u
.subdir
.cache
= cache
;
95 direntry
->flag
= REF_DIR
| REF_INCOMPLETE
;
99 static int ref_entry_cmp(const void *a
, const void *b
)
101 struct ref_entry
*one
= *(struct ref_entry
**)a
;
102 struct ref_entry
*two
= *(struct ref_entry
**)b
;
103 return strcmp(one
->name
, two
->name
);
106 static void sort_ref_dir(struct ref_dir
*dir
);
108 struct string_slice
{
113 static int ref_entry_cmp_sslice(const void *key_
, const void *ent_
)
115 const struct string_slice
*key
= key_
;
116 const struct ref_entry
*ent
= *(const struct ref_entry
* const *)ent_
;
117 int cmp
= strncmp(key
->str
, ent
->name
, key
->len
);
120 return '\0' - (unsigned char)ent
->name
[key
->len
];
123 int search_ref_dir(struct ref_dir
*dir
, const char *refname
, size_t len
)
125 struct ref_entry
**r
;
126 struct string_slice key
;
128 if (refname
== NULL
|| !dir
->nr
)
134 r
= bsearch(&key
, dir
->entries
, dir
->nr
, sizeof(*dir
->entries
),
135 ref_entry_cmp_sslice
);
140 return r
- dir
->entries
;
144 * Search for a directory entry directly within dir (without
145 * recursing). Sort dir if necessary. subdirname must be a directory
146 * name (i.e., end in '/'). Returns NULL if the desired
147 * directory cannot be found. dir must already be complete.
149 static struct ref_dir
*search_for_subdir(struct ref_dir
*dir
,
150 const char *subdirname
, size_t len
)
152 int entry_index
= search_ref_dir(dir
, subdirname
, len
);
153 struct ref_entry
*entry
;
155 if (entry_index
== -1)
158 entry
= dir
->entries
[entry_index
];
159 return get_ref_dir(entry
);
163 * If refname is a reference name, find the ref_dir within the dir
164 * tree that should hold refname. If refname is a directory name
165 * (i.e., it ends in '/'), then return that ref_dir itself. dir must
166 * represent the top-level directory and must already be complete.
167 * Sort ref_dirs and recurse into subdirectories as necessary. Will
168 * return NULL if the desired directory cannot be found.
170 static struct ref_dir
*find_containing_dir(struct ref_dir
*dir
,
174 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
175 size_t dirnamelen
= slash
- refname
+ 1;
176 struct ref_dir
*subdir
;
177 subdir
= search_for_subdir(dir
, refname
, dirnamelen
);
188 struct ref_entry
*find_ref_entry(struct ref_dir
*dir
, const char *refname
)
191 struct ref_entry
*entry
;
192 dir
= find_containing_dir(dir
, refname
);
195 entry_index
= search_ref_dir(dir
, refname
, strlen(refname
));
196 if (entry_index
== -1)
198 entry
= dir
->entries
[entry_index
];
199 return (entry
->flag
& REF_DIR
) ? NULL
: entry
;
203 * Emit a warning and return true iff ref1 and ref2 have the same name
204 * and the same oid. Die if they have the same name but different
207 static int is_dup_ref(const struct ref_entry
*ref1
, const struct ref_entry
*ref2
)
209 if (strcmp(ref1
->name
, ref2
->name
))
212 /* Duplicate name; make sure that they don't conflict: */
214 if ((ref1
->flag
& REF_DIR
) || (ref2
->flag
& REF_DIR
))
215 /* This is impossible by construction */
216 die("Reference directory conflict: %s", ref1
->name
);
218 if (!oideq(&ref1
->u
.value
.oid
, &ref2
->u
.value
.oid
))
219 die("Duplicated ref, and SHA1s don't match: %s", ref1
->name
);
221 warning("Duplicated ref: %s", ref1
->name
);
226 * Sort the entries in dir non-recursively (if they are not already
227 * sorted) and remove any duplicate entries.
229 static void sort_ref_dir(struct ref_dir
*dir
)
232 struct ref_entry
*last
= NULL
;
235 * This check also prevents passing a zero-length array to qsort(),
236 * which is a problem on some platforms.
238 if (dir
->sorted
== dir
->nr
)
241 QSORT(dir
->entries
, dir
->nr
, ref_entry_cmp
);
243 /* Remove any duplicates: */
244 for (i
= 0, j
= 0; j
< dir
->nr
; j
++) {
245 struct ref_entry
*entry
= dir
->entries
[j
];
246 if (last
&& is_dup_ref(last
, entry
))
247 free_ref_entry(entry
);
249 last
= dir
->entries
[i
++] = entry
;
251 dir
->sorted
= dir
->nr
= i
;
255 /* All refs within the directory would match prefix: */
258 /* Some, but not all, refs within the directory might match prefix: */
261 /* No refs within the directory could possibly match prefix: */
266 * Return a `prefix_state` constant describing the relationship
267 * between the directory with the specified `dirname` and `prefix`.
269 static enum prefix_state
overlaps_prefix(const char *dirname
,
272 while (*prefix
&& *dirname
== *prefix
) {
277 return PREFIX_CONTAINS_DIR
;
279 return PREFIX_WITHIN_DIR
;
281 return PREFIX_EXCLUDES_DIR
;
285 * Load all of the refs from `dir` (recursively) that could possibly
286 * contain references matching `prefix` into our in-memory cache. If
287 * `prefix` is NULL, prime unconditionally.
289 static void prime_ref_dir(struct ref_dir
*dir
, const char *prefix
)
292 * The hard work of loading loose refs is done by get_ref_dir(), so we
293 * just need to recurse through all of the sub-directories. We do not
294 * even need to care about sorting, as traversal order does not matter
298 for (i
= 0; i
< dir
->nr
; i
++) {
299 struct ref_entry
*entry
= dir
->entries
[i
];
300 if (!(entry
->flag
& REF_DIR
)) {
301 /* Not a directory; no need to recurse. */
302 } else if (!prefix
) {
303 /* Recurse in any case: */
304 prime_ref_dir(get_ref_dir(entry
), NULL
);
306 switch (overlaps_prefix(entry
->name
, prefix
)) {
307 case PREFIX_CONTAINS_DIR
:
309 * Recurse, and from here down we
310 * don't have to check the prefix
313 prime_ref_dir(get_ref_dir(entry
), NULL
);
315 case PREFIX_WITHIN_DIR
:
316 prime_ref_dir(get_ref_dir(entry
), prefix
);
318 case PREFIX_EXCLUDES_DIR
:
319 /* No need to prime this directory. */
327 * A level in the reference hierarchy that is currently being iterated
330 struct cache_ref_iterator_level
{
332 * The ref_dir being iterated over at this level. The ref_dir
333 * is sorted before being stored here.
337 enum prefix_state prefix_state
;
340 * The index of the current entry within dir (which might
341 * itself be a directory). If index == -1, then the iteration
342 * hasn't yet begun. If index == dir->nr, then the iteration
343 * through this level is over.
349 * Represent an iteration through a ref_dir in the memory cache. The
350 * iteration recurses through subdirectories.
352 struct cache_ref_iterator
{
353 struct ref_iterator base
;
356 * The number of levels currently on the stack. This is always
357 * at least 1, because when it becomes zero the iteration is
358 * ended and this struct is freed.
362 /* The number of levels that have been allocated on the stack */
366 * Only include references with this prefix in the iteration.
367 * The prefix is matched textually, without regard for path
368 * component boundaries.
373 * A stack of levels. levels[0] is the uppermost level that is
374 * being iterated over in this iteration. (This is not
375 * necessary the top level in the references hierarchy. If we
376 * are iterating through a subtree, then levels[0] will hold
377 * the ref_dir for that subtree, and subsequent levels will go
380 struct cache_ref_iterator_level
*levels
;
382 struct repository
*repo
;
385 static int cache_ref_iterator_advance(struct ref_iterator
*ref_iterator
)
387 struct cache_ref_iterator
*iter
=
388 (struct cache_ref_iterator
*)ref_iterator
;
391 struct cache_ref_iterator_level
*level
=
392 &iter
->levels
[iter
->levels_nr
- 1];
393 struct ref_dir
*dir
= level
->dir
;
394 struct ref_entry
*entry
;
395 enum prefix_state entry_prefix_state
;
397 if (level
->index
== -1)
400 if (++level
->index
== level
->dir
->nr
) {
401 /* This level is exhausted; pop up a level */
402 if (--iter
->levels_nr
== 0)
403 return ref_iterator_abort(ref_iterator
);
408 entry
= dir
->entries
[level
->index
];
410 if (level
->prefix_state
== PREFIX_WITHIN_DIR
) {
411 entry_prefix_state
= overlaps_prefix(entry
->name
, iter
->prefix
);
412 if (entry_prefix_state
== PREFIX_EXCLUDES_DIR
)
415 entry_prefix_state
= level
->prefix_state
;
418 if (entry
->flag
& REF_DIR
) {
419 /* push down a level */
420 ALLOC_GROW(iter
->levels
, iter
->levels_nr
+ 1,
423 level
= &iter
->levels
[iter
->levels_nr
++];
424 level
->dir
= get_ref_dir(entry
);
425 level
->prefix_state
= entry_prefix_state
;
428 iter
->base
.refname
= entry
->name
;
429 iter
->base
.oid
= &entry
->u
.value
.oid
;
430 iter
->base
.flags
= entry
->flag
;
436 static int cache_ref_iterator_peel(struct ref_iterator
*ref_iterator
,
437 struct object_id
*peeled
)
439 struct cache_ref_iterator
*iter
=
440 (struct cache_ref_iterator
*)ref_iterator
;
442 if (iter
->repo
!= the_repository
)
443 BUG("peeling for non-the_repository is not supported");
444 return peel_object(ref_iterator
->oid
, peeled
) ? -1 : 0;
447 static int cache_ref_iterator_abort(struct ref_iterator
*ref_iterator
)
449 struct cache_ref_iterator
*iter
=
450 (struct cache_ref_iterator
*)ref_iterator
;
452 free((char *)iter
->prefix
);
454 base_ref_iterator_free(ref_iterator
);
458 static struct ref_iterator_vtable cache_ref_iterator_vtable
= {
459 cache_ref_iterator_advance
,
460 cache_ref_iterator_peel
,
461 cache_ref_iterator_abort
464 struct ref_iterator
*cache_ref_iterator_begin(struct ref_cache
*cache
,
466 struct repository
*repo
,
470 struct cache_ref_iterator
*iter
;
471 struct ref_iterator
*ref_iterator
;
472 struct cache_ref_iterator_level
*level
;
474 dir
= get_ref_dir(cache
->root
);
475 if (prefix
&& *prefix
)
476 dir
= find_containing_dir(dir
, prefix
);
478 /* There's nothing to iterate over. */
479 return empty_ref_iterator_begin();
482 prime_ref_dir(dir
, prefix
);
484 CALLOC_ARRAY(iter
, 1);
485 ref_iterator
= &iter
->base
;
486 base_ref_iterator_init(ref_iterator
, &cache_ref_iterator_vtable
, 1);
487 ALLOC_GROW(iter
->levels
, 10, iter
->levels_alloc
);
490 level
= &iter
->levels
[0];
494 if (prefix
&& *prefix
) {
495 iter
->prefix
= xstrdup(prefix
);
496 level
->prefix_state
= PREFIX_WITHIN_DIR
;
498 level
->prefix_state
= PREFIX_CONTAINS_DIR
;