add object_as_type helper for casting objects
[git/git.git] / refs.c
CommitLineData
95fc7512 1#include "cache.h"
85023577 2#include "refs.h"
cf0adba7
JH
3#include "object.h"
4#include "tag.h"
7155b727 5#include "dir.h"
daebaa78 6#include "string-list.h"
95fc7512 7
bc5fd6d3 8/*
dde8a902
DT
9 * How to handle various characters in refnames:
10 * 0: An acceptable character for refs
11 * 1: End-of-component
12 * 2: ., look for a preceding . to reject .. in refs
13 * 3: {, look for a preceding @ to reject @{ in refs
14 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
15 */
16static unsigned char refname_disposition[256] = {
17 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
18 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
19 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
20 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
21 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
22 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
23 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
24 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
25};
26
27/*
28 * Try to read one refname component from the front of refname.
29 * Return the length of the component found, or -1 if the component is
30 * not legal. It is legal if it is something reasonable to have under
31 * ".git/refs/"; We do not like it if:
bc5fd6d3
MH
32 *
33 * - any path component of it begins with ".", or
34 * - it has double dots "..", or
35 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
36 * - it ends with a "/".
37 * - it ends with ".lock"
38 * - it contains a "\" (backslash)
39 */
bc5fd6d3
MH
40static int check_refname_component(const char *refname, int flags)
41{
42 const char *cp;
43 char last = '\0';
44
45 for (cp = refname; ; cp++) {
dde8a902
DT
46 int ch = *cp & 255;
47 unsigned char disp = refname_disposition[ch];
48 switch (disp) {
49 case 1:
50 goto out;
51 case 2:
52 if (last == '.')
53 return -1; /* Refname contains "..". */
54 break;
55 case 3:
56 if (last == '@')
57 return -1; /* Refname contains "@{". */
bc5fd6d3 58 break;
dde8a902
DT
59 case 4:
60 return -1;
61 }
bc5fd6d3
MH
62 last = ch;
63 }
dde8a902 64out:
bc5fd6d3 65 if (cp == refname)
dac529e4 66 return 0; /* Component has zero length. */
bc5fd6d3
MH
67 if (refname[0] == '.') {
68 if (!(flags & REFNAME_DOT_COMPONENT))
69 return -1; /* Component starts with '.'. */
70 /*
71 * Even if leading dots are allowed, don't allow "."
72 * as a component (".." is prevented by a rule above).
73 */
74 if (refname[1] == '\0')
75 return -1; /* Component equals ".". */
76 }
77 if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
78 return -1; /* Refname ends with ".lock". */
79 return cp - refname;
80}
81
82int check_refname_format(const char *refname, int flags)
83{
84 int component_len, component_count = 0;
85
9ba89f48
FC
86 if (!strcmp(refname, "@"))
87 /* Refname is a single character '@'. */
88 return -1;
89
bc5fd6d3
MH
90 while (1) {
91 /* We are at the start of a path component. */
92 component_len = check_refname_component(refname, flags);
dac529e4 93 if (component_len <= 0) {
bc5fd6d3
MH
94 if ((flags & REFNAME_REFSPEC_PATTERN) &&
95 refname[0] == '*' &&
96 (refname[1] == '\0' || refname[1] == '/')) {
97 /* Accept one wildcard as a full refname component. */
98 flags &= ~REFNAME_REFSPEC_PATTERN;
99 component_len = 1;
100 } else {
101 return -1;
102 }
103 }
104 component_count++;
105 if (refname[component_len] == '\0')
106 break;
107 /* Skip to next component. */
108 refname += component_len + 1;
109 }
110
111 if (refname[component_len - 1] == '.')
112 return -1; /* Refname ends with '.'. */
113 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
114 return -1; /* Refname has only one component. */
115 return 0;
116}
117
118struct ref_entry;
e1e22e37 119
28e6a34e
MH
120/*
121 * Information used (along with the information in ref_entry) to
122 * describe a single cached reference. This data structure only
123 * occurs embedded in a union in struct ref_entry, and only when
124 * (ref_entry->flag & REF_DIR) is zero.
125 */
593f1bb8 126struct ref_value {
6c6f58df
MH
127 /*
128 * The name of the object to which this reference resolves
129 * (which may be a tag object). If REF_ISBROKEN, this is
130 * null. If REF_ISSYMREF, then this is the name of the object
131 * referred to by the last reference in the symlink chain.
132 */
593f1bb8 133 unsigned char sha1[20];
6c6f58df
MH
134
135 /*
136 * If REF_KNOWS_PEELED, then this field holds the peeled value
137 * of this reference, or null if the reference is known not to
2312a793
MH
138 * be peelable. See the documentation for peel_ref() for an
139 * exact definition of "peelable".
6c6f58df 140 */
593f1bb8
MH
141 unsigned char peeled[20];
142};
143
f006c42a
MH
144struct ref_cache;
145
28e6a34e
MH
146/*
147 * Information used (along with the information in ref_entry) to
148 * describe a level in the hierarchy of references. This data
149 * structure only occurs embedded in a union in struct ref_entry, and
150 * only when (ref_entry.flag & REF_DIR) is set. In that case,
151 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
152 * in the directory have already been read:
153 *
154 * (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
155 * or packed references, already read.
156 *
157 * (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
158 * references that hasn't been read yet (nor has any of its
159 * subdirectories).
160 *
161 * Entries within a directory are stored within a growable array of
162 * pointers to ref_entries (entries, nr, alloc). Entries 0 <= i <
163 * sorted are sorted by their component name in strcmp() order and the
164 * remaining entries are unsorted.
165 *
166 * Loose references are read lazily, one directory at a time. When a
167 * directory of loose references is read, then all of the references
168 * in that directory are stored, and REF_INCOMPLETE stubs are created
169 * for any subdirectories, but the subdirectories themselves are not
170 * read. The reading is triggered by get_ref_dir().
171 */
d3177275 172struct ref_dir {
e9c4c111 173 int nr, alloc;
e6ed3ca6
MH
174
175 /*
176 * Entries with index 0 <= i < sorted are sorted by name. New
177 * entries are appended to the list unsorted, and are sorted
178 * only when required; thus we avoid the need to sort the list
179 * after the addition of every reference.
180 */
181 int sorted;
182
f006c42a
MH
183 /* A pointer to the ref_cache that contains this ref_dir. */
184 struct ref_cache *ref_cache;
185
d3177275 186 struct ref_entry **entries;
e9c4c111
JP
187};
188
89df9c84
MH
189/*
190 * Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
191 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
192 * refs.h.
193 */
194
195/*
196 * The field ref_entry->u.value.peeled of this value entry contains
197 * the correct peeled value for the reference, which might be
198 * null_sha1 if the reference is not a tag or if it is broken.
199 */
432ad41e 200#define REF_KNOWS_PEELED 0x08
28e6a34e
MH
201
202/* ref_entry represents a directory of references */
432ad41e 203#define REF_DIR 0x10
cf0adba7 204
28e6a34e
MH
205/*
206 * Entry has not yet been read from disk (used only for REF_DIR
207 * entries representing loose references)
208 */
209#define REF_INCOMPLETE 0x20
210
432ad41e
MH
211/*
212 * A ref_entry represents either a reference or a "subdirectory" of
28e6a34e
MH
213 * references.
214 *
215 * Each directory in the reference namespace is represented by a
216 * ref_entry with (flags & REF_DIR) set and containing a subdir member
217 * that holds the entries in that directory that have been read so
218 * far. If (flags & REF_INCOMPLETE) is set, then the directory and
219 * its subdirectories haven't been read yet. REF_INCOMPLETE is only
220 * used for loose reference directories.
221 *
222 * References are represented by a ref_entry with (flags & REF_DIR)
223 * unset and a value member that describes the reference's value. The
224 * flag member is at the ref_entry level, but it is also needed to
225 * interpret the contents of the value field (in other words, a
226 * ref_value object is not very much use without the enclosing
227 * ref_entry).
432ad41e
MH
228 *
229 * Reference names cannot end with slash and directories' names are
230 * always stored with a trailing slash (except for the top-level
231 * directory, which is always denoted by ""). This has two nice
232 * consequences: (1) when the entries in each subdir are sorted
233 * lexicographically by name (as they usually are), the references in
234 * a whole tree can be generated in lexicographic order by traversing
235 * the tree in left-to-right, depth-first order; (2) the names of
236 * references and subdirectories cannot conflict, and therefore the
237 * presence of an empty subdirectory does not block the creation of a
238 * similarly-named reference. (The fact that reference names with the
239 * same leading components can conflict *with each other* is a
240 * separate issue that is regulated by is_refname_available().)
241 *
242 * Please note that the name field contains the fully-qualified
243 * reference (or subdirectory) name. Space could be saved by only
244 * storing the relative names. But that would require the full names
245 * to be generated on the fly when iterating in do_for_each_ref(), and
246 * would break callback functions, who have always been able to assume
247 * that the name strings that they are passed will not be freed during
248 * the iteration.
249 */
bc5fd6d3
MH
250struct ref_entry {
251 unsigned char flag; /* ISSYMREF? ISPACKED? */
593f1bb8 252 union {
432ad41e
MH
253 struct ref_value value; /* if not (flags&REF_DIR) */
254 struct ref_dir subdir; /* if (flags&REF_DIR) */
593f1bb8 255 } u;
432ad41e
MH
256 /*
257 * The full name of the reference (e.g., "refs/heads/master")
258 * or the full name of the directory with a trailing slash
259 * (e.g., "refs/heads/"):
260 */
bc5fd6d3
MH
261 char name[FLEX_ARRAY];
262};
e1e22e37 263
28e6a34e
MH
264static void read_loose_refs(const char *dirname, struct ref_dir *dir);
265
d7826d54
MH
266static struct ref_dir *get_ref_dir(struct ref_entry *entry)
267{
28e6a34e 268 struct ref_dir *dir;
d7826d54 269 assert(entry->flag & REF_DIR);
28e6a34e
MH
270 dir = &entry->u.subdir;
271 if (entry->flag & REF_INCOMPLETE) {
272 read_loose_refs(entry->name, dir);
273 entry->flag &= ~REF_INCOMPLETE;
274 }
275 return dir;
d7826d54
MH
276}
277
cddc4258
MH
278static struct ref_entry *create_ref_entry(const char *refname,
279 const unsigned char *sha1, int flag,
280 int check_name)
e1e22e37
LT
281{
282 int len;
cddc4258 283 struct ref_entry *ref;
e1e22e37 284
09116a1c 285 if (check_name &&
dfefa935
MH
286 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
287 die("Reference has invalid format: '%s'", refname);
cddc4258
MH
288 len = strlen(refname) + 1;
289 ref = xmalloc(sizeof(struct ref_entry) + len);
593f1bb8
MH
290 hashcpy(ref->u.value.sha1, sha1);
291 hashclr(ref->u.value.peeled);
cddc4258
MH
292 memcpy(ref->name, refname, len);
293 ref->flag = flag;
294 return ref;
295}
296
432ad41e
MH
297static void clear_ref_dir(struct ref_dir *dir);
298
732134ed
MH
299static void free_ref_entry(struct ref_entry *entry)
300{
27b5587c
MH
301 if (entry->flag & REF_DIR) {
302 /*
303 * Do not use get_ref_dir() here, as that might
304 * trigger the reading of loose refs.
305 */
306 clear_ref_dir(&entry->u.subdir);
307 }
732134ed
MH
308 free(entry);
309}
310
432ad41e
MH
311/*
312 * Add a ref_entry to the end of dir (unsorted). Entry is always
313 * stored directly in dir; no recursion into subdirectories is
314 * done.
315 */
316static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
cddc4258 317{
432ad41e
MH
318 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
319 dir->entries[dir->nr++] = entry;
654ad400
MH
320 /* optimize for the case that entries are added in order */
321 if (dir->nr == 1 ||
322 (dir->nr == dir->sorted + 1 &&
323 strcmp(dir->entries[dir->nr - 2]->name,
324 dir->entries[dir->nr - 1]->name) < 0))
325 dir->sorted = dir->nr;
c774aab9
JP
326}
327
432ad41e
MH
328/*
329 * Clear and free all entries in dir, recursively.
330 */
d3177275 331static void clear_ref_dir(struct ref_dir *dir)
bc5fd6d3
MH
332{
333 int i;
d3177275
MH
334 for (i = 0; i < dir->nr; i++)
335 free_ref_entry(dir->entries[i]);
336 free(dir->entries);
337 dir->sorted = dir->nr = dir->alloc = 0;
338 dir->entries = NULL;
bc5fd6d3
MH
339}
340
432ad41e
MH
341/*
342 * Create a struct ref_entry object for the specified dirname.
343 * dirname is the name of the directory with a trailing slash (e.g.,
344 * "refs/heads/") or "" for the top-level directory.
345 */
f006c42a 346static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
b9146f51
RS
347 const char *dirname, size_t len,
348 int incomplete)
432ad41e
MH
349{
350 struct ref_entry *direntry;
432ad41e 351 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
b9146f51
RS
352 memcpy(direntry->name, dirname, len);
353 direntry->name[len] = '\0';
f006c42a 354 direntry->u.subdir.ref_cache = ref_cache;
28e6a34e 355 direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
432ad41e
MH
356 return direntry;
357}
358
e9c4c111 359static int ref_entry_cmp(const void *a, const void *b)
c774aab9 360{
e9c4c111
JP
361 struct ref_entry *one = *(struct ref_entry **)a;
362 struct ref_entry *two = *(struct ref_entry **)b;
363 return strcmp(one->name, two->name);
364}
c774aab9 365
d3177275 366static void sort_ref_dir(struct ref_dir *dir);
bc5fd6d3 367
e1980c9d
JH
368struct string_slice {
369 size_t len;
370 const char *str;
371};
372
373static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
374{
c971ddfd
RS
375 const struct string_slice *key = key_;
376 const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
377 int cmp = strncmp(key->str, ent->name, key->len);
e1980c9d
JH
378 if (cmp)
379 return cmp;
c971ddfd 380 return '\0' - (unsigned char)ent->name[key->len];
e1980c9d
JH
381}
382
432ad41e 383/*
9fc0a648
MH
384 * Return the index of the entry with the given refname from the
385 * ref_dir (non-recursively), sorting dir if necessary. Return -1 if
386 * no such entry is found. dir must already be complete.
432ad41e 387 */
9fc0a648 388static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
bc5fd6d3 389{
e1980c9d
JH
390 struct ref_entry **r;
391 struct string_slice key;
bc5fd6d3 392
432ad41e 393 if (refname == NULL || !dir->nr)
9fc0a648 394 return -1;
bc5fd6d3 395
d3177275 396 sort_ref_dir(dir);
e1980c9d
JH
397 key.len = len;
398 key.str = refname;
399 r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
400 ref_entry_cmp_sslice);
bc5fd6d3
MH
401
402 if (r == NULL)
9fc0a648 403 return -1;
bc5fd6d3 404
9fc0a648 405 return r - dir->entries;
bc5fd6d3
MH
406}
407
f348ac92
MH
408/*
409 * Search for a directory entry directly within dir (without
410 * recursing). Sort dir if necessary. subdirname must be a directory
411 * name (i.e., end in '/'). If mkdir is set, then create the
412 * directory if it is missing; otherwise, return NULL if the desired
28e6a34e 413 * directory cannot be found. dir must already be complete.
f348ac92 414 */
3f3aa1bc 415static struct ref_dir *search_for_subdir(struct ref_dir *dir,
dd02e728
RS
416 const char *subdirname, size_t len,
417 int mkdir)
f348ac92 418{
9fc0a648
MH
419 int entry_index = search_ref_dir(dir, subdirname, len);
420 struct ref_entry *entry;
421 if (entry_index == -1) {
f348ac92
MH
422 if (!mkdir)
423 return NULL;
28e6a34e
MH
424 /*
425 * Since dir is complete, the absence of a subdir
426 * means that the subdir really doesn't exist;
427 * therefore, create an empty record for it but mark
428 * the record complete.
429 */
b9146f51 430 entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
f348ac92 431 add_entry_to_dir(dir, entry);
9fc0a648
MH
432 } else {
433 entry = dir->entries[entry_index];
f348ac92 434 }
3f3aa1bc 435 return get_ref_dir(entry);
f348ac92
MH
436}
437
432ad41e
MH
438/*
439 * If refname is a reference name, find the ref_dir within the dir
440 * tree that should hold refname. If refname is a directory name
441 * (i.e., ends in '/'), then return that ref_dir itself. dir must
28e6a34e
MH
442 * represent the top-level directory and must already be complete.
443 * Sort ref_dirs and recurse into subdirectories as necessary. If
444 * mkdir is set, then create any missing directories; otherwise,
445 * return NULL if the desired directory cannot be found.
432ad41e
MH
446 */
447static struct ref_dir *find_containing_dir(struct ref_dir *dir,
448 const char *refname, int mkdir)
449{
5fa04418 450 const char *slash;
5fa04418 451 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
dd02e728 452 size_t dirnamelen = slash - refname + 1;
3f3aa1bc 453 struct ref_dir *subdir;
dd02e728 454 subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
663c1295
JH
455 if (!subdir) {
456 dir = NULL;
f348ac92 457 break;
432ad41e 458 }
3f3aa1bc 459 dir = subdir;
432ad41e
MH
460 }
461
432ad41e
MH
462 return dir;
463}
464
465/*
466 * Find the value entry with the given name in dir, sorting ref_dirs
467 * and recursing into subdirectories as necessary. If the name is not
468 * found or it corresponds to a directory entry, return NULL.
469 */
470static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
471{
9fc0a648 472 int entry_index;
432ad41e
MH
473 struct ref_entry *entry;
474 dir = find_containing_dir(dir, refname, 0);
475 if (!dir)
476 return NULL;
9fc0a648
MH
477 entry_index = search_ref_dir(dir, refname, strlen(refname));
478 if (entry_index == -1)
479 return NULL;
480 entry = dir->entries[entry_index];
481 return (entry->flag & REF_DIR) ? NULL : entry;
432ad41e
MH
482}
483
506a760d
MH
484/*
485 * Remove the entry with the given name from dir, recursing into
486 * subdirectories as necessary. If refname is the name of a directory
487 * (i.e., ends with '/'), then remove the directory and its contents.
488 * If the removal was successful, return the number of entries
489 * remaining in the directory entry that contained the deleted entry.
490 * If the name was not found, return -1. Please note that this
491 * function only deletes the entry from the cache; it does not delete
492 * it from the filesystem or ensure that other cache entries (which
493 * might be symbolic references to the removed entry) are updated.
494 * Nor does it remove any containing dir entries that might be made
495 * empty by the removal. dir must represent the top-level directory
496 * and must already be complete.
497 */
498static int remove_entry(struct ref_dir *dir, const char *refname)
499{
500 int refname_len = strlen(refname);
501 int entry_index;
502 struct ref_entry *entry;
503 int is_dir = refname[refname_len - 1] == '/';
504 if (is_dir) {
505 /*
506 * refname represents a reference directory. Remove
507 * the trailing slash; otherwise we will get the
508 * directory *representing* refname rather than the
509 * one *containing* it.
510 */
511 char *dirname = xmemdupz(refname, refname_len - 1);
512 dir = find_containing_dir(dir, dirname, 0);
513 free(dirname);
514 } else {
515 dir = find_containing_dir(dir, refname, 0);
516 }
517 if (!dir)
518 return -1;
519 entry_index = search_ref_dir(dir, refname, refname_len);
520 if (entry_index == -1)
521 return -1;
522 entry = dir->entries[entry_index];
523
524 memmove(&dir->entries[entry_index],
525 &dir->entries[entry_index + 1],
526 (dir->nr - entry_index - 1) * sizeof(*dir->entries)
527 );
528 dir->nr--;
529 if (dir->sorted > entry_index)
530 dir->sorted--;
531 free_ref_entry(entry);
532 return dir->nr;
432ad41e
MH
533}
534
535/*
536 * Add a ref_entry to the ref_dir (unsorted), recursing into
537 * subdirectories as necessary. dir must represent the top-level
538 * directory. Return 0 on success.
539 */
540static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
541{
542 dir = find_containing_dir(dir, ref->name, 1);
543 if (!dir)
544 return -1;
545 add_entry_to_dir(dir, ref);
546 return 0;
547}
548
202a56a9
MH
549/*
550 * Emit a warning and return true iff ref1 and ref2 have the same name
551 * and the same sha1. Die if they have the same name but different
552 * sha1s.
553 */
554static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
555{
432ad41e 556 if (strcmp(ref1->name, ref2->name))
202a56a9 557 return 0;
432ad41e
MH
558
559 /* Duplicate name; make sure that they don't conflict: */
560
561 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
562 /* This is impossible by construction */
563 die("Reference directory conflict: %s", ref1->name);
564
565 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
566 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
567
568 warning("Duplicated ref: %s", ref1->name);
569 return 1;
202a56a9
MH
570}
571
e6ed3ca6 572/*
432ad41e
MH
573 * Sort the entries in dir non-recursively (if they are not already
574 * sorted) and remove any duplicate entries.
e6ed3ca6 575 */
d3177275 576static void sort_ref_dir(struct ref_dir *dir)
e9c4c111 577{
202a56a9 578 int i, j;
81a79d8e 579 struct ref_entry *last = NULL;
c774aab9 580
e6ed3ca6
MH
581 /*
582 * This check also prevents passing a zero-length array to qsort(),
583 * which is a problem on some platforms.
584 */
d3177275 585 if (dir->sorted == dir->nr)
e9c4c111 586 return;
c774aab9 587
d3177275 588 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
c774aab9 589
81a79d8e
MH
590 /* Remove any duplicates: */
591 for (i = 0, j = 0; j < dir->nr; j++) {
592 struct ref_entry *entry = dir->entries[j];
593 if (last && is_dup_ref(last, entry))
594 free_ref_entry(entry);
595 else
596 last = dir->entries[i++] = entry;
e9c4c111 597 }
81a79d8e 598 dir->sorted = dir->nr = i;
e9c4c111 599}
c774aab9 600
fcce1703
MH
601/* Include broken references in a do_for_each_ref*() iteration: */
602#define DO_FOR_EACH_INCLUDE_BROKEN 0x01
c774aab9 603
662428f4
MH
604/*
605 * Return true iff the reference described by entry can be resolved to
606 * an object in the database. Emit a warning if the referred-to
607 * object does not exist.
608 */
609static int ref_resolves_to_object(struct ref_entry *entry)
610{
611 if (entry->flag & REF_ISBROKEN)
612 return 0;
613 if (!has_sha1_file(entry->u.value.sha1)) {
614 error("%s does not point to a valid object!", entry->name);
615 return 0;
616 }
617 return 1;
618}
c774aab9 619
7d76fdc8
MH
620/*
621 * current_ref is a performance hack: when iterating over references
622 * using the for_each_ref*() functions, current_ref is set to the
623 * current reference's entry before calling the callback function. If
624 * the callback function calls peel_ref(), then peel_ref() first
625 * checks whether the reference to be peeled is the current reference
626 * (it usually is) and if so, returns that reference's peeled version
627 * if it is available. This avoids a refname lookup in a common case.
628 */
bc5fd6d3 629static struct ref_entry *current_ref;
c774aab9 630
624cac35
MH
631typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);
632
633struct ref_entry_cb {
634 const char *base;
635 int trim;
636 int flags;
637 each_ref_fn *fn;
638 void *cb_data;
639};
640
fcce1703 641/*
624cac35
MH
642 * Handle one reference in a do_for_each_ref*()-style iteration,
643 * calling an each_ref_fn for each entry.
fcce1703 644 */
624cac35 645static int do_one_ref(struct ref_entry *entry, void *cb_data)
bc5fd6d3 646{
624cac35 647 struct ref_entry_cb *data = cb_data;
d0cf51e9 648 struct ref_entry *old_current_ref;
429213e4 649 int retval;
d0cf51e9 650
59556548 651 if (!starts_with(entry->name, data->base))
bc5fd6d3 652 return 0;
c774aab9 653
624cac35 654 if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
662428f4 655 !ref_resolves_to_object(entry))
bc5fd6d3 656 return 0;
c774aab9 657
d0cf51e9
MH
658 /* Store the old value, in case this is a recursive call: */
659 old_current_ref = current_ref;
bc5fd6d3 660 current_ref = entry;
624cac35
MH
661 retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
662 entry->flag, data->cb_data);
d0cf51e9 663 current_ref = old_current_ref;
429213e4 664 return retval;
bc5fd6d3 665}
c774aab9 666
c36b5bc2 667/*
d3177275 668 * Call fn for each reference in dir that has index in the range
432ad41e
MH
669 * offset <= index < dir->nr. Recurse into subdirectories that are in
670 * that index range, sorting them before iterating. This function
624cac35
MH
671 * does not sort dir itself; it should be sorted beforehand. fn is
672 * called for all references, including broken ones.
c36b5bc2 673 */
624cac35
MH
674static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
675 each_ref_entry_fn fn, void *cb_data)
c36b5bc2
MH
676{
677 int i;
d3177275
MH
678 assert(dir->sorted == dir->nr);
679 for (i = offset; i < dir->nr; i++) {
432ad41e
MH
680 struct ref_entry *entry = dir->entries[i];
681 int retval;
682 if (entry->flag & REF_DIR) {
d7826d54
MH
683 struct ref_dir *subdir = get_ref_dir(entry);
684 sort_ref_dir(subdir);
624cac35 685 retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
432ad41e 686 } else {
624cac35 687 retval = fn(entry, cb_data);
432ad41e 688 }
c36b5bc2
MH
689 if (retval)
690 return retval;
691 }
692 return 0;
693}
694
b3fd060f 695/*
d3177275 696 * Call fn for each reference in the union of dir1 and dir2, in order
432ad41e
MH
697 * by refname. Recurse into subdirectories. If a value entry appears
698 * in both dir1 and dir2, then only process the version that is in
699 * dir2. The input dirs must already be sorted, but subdirs will be
624cac35
MH
700 * sorted as needed. fn is called for all references, including
701 * broken ones.
b3fd060f 702 */
624cac35
MH
703static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
704 struct ref_dir *dir2,
705 each_ref_entry_fn fn, void *cb_data)
b3fd060f
MH
706{
707 int retval;
708 int i1 = 0, i2 = 0;
709
d3177275
MH
710 assert(dir1->sorted == dir1->nr);
711 assert(dir2->sorted == dir2->nr);
432ad41e
MH
712 while (1) {
713 struct ref_entry *e1, *e2;
714 int cmp;
715 if (i1 == dir1->nr) {
624cac35 716 return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
432ad41e
MH
717 }
718 if (i2 == dir2->nr) {
624cac35 719 return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
432ad41e
MH
720 }
721 e1 = dir1->entries[i1];
722 e2 = dir2->entries[i2];
723 cmp = strcmp(e1->name, e2->name);
724 if (cmp == 0) {
725 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
726 /* Both are directories; descend them in parallel. */
d7826d54
MH
727 struct ref_dir *subdir1 = get_ref_dir(e1);
728 struct ref_dir *subdir2 = get_ref_dir(e2);
729 sort_ref_dir(subdir1);
730 sort_ref_dir(subdir2);
624cac35
MH
731 retval = do_for_each_entry_in_dirs(
732 subdir1, subdir2, fn, cb_data);
432ad41e
MH
733 i1++;
734 i2++;
735 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
736 /* Both are references; ignore the one from dir1. */
624cac35 737 retval = fn(e2, cb_data);
432ad41e
MH
738 i1++;
739 i2++;
740 } else {
741 die("conflict between reference and directory: %s",
742 e1->name);
743 }
b3fd060f 744 } else {
432ad41e
MH
745 struct ref_entry *e;
746 if (cmp < 0) {
747 e = e1;
b3fd060f 748 i1++;
432ad41e
MH
749 } else {
750 e = e2;
751 i2++;
752 }
753 if (e->flag & REF_DIR) {
d7826d54
MH
754 struct ref_dir *subdir = get_ref_dir(e);
755 sort_ref_dir(subdir);
624cac35
MH
756 retval = do_for_each_entry_in_dir(
757 subdir, 0, fn, cb_data);
432ad41e 758 } else {
624cac35 759 retval = fn(e, cb_data);
b3fd060f
MH
760 }
761 }
762 if (retval)
763 return retval;
764 }
b3fd060f
MH
765}
766
98eeb09e
JK
767/*
768 * Load all of the refs from the dir into our in-memory cache. The hard work
769 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
770 * through all of the sub-directories. We do not even need to care about
771 * sorting, as traversal order does not matter to us.
772 */
773static void prime_ref_dir(struct ref_dir *dir)
774{
775 int i;
776 for (i = 0; i < dir->nr; i++) {
777 struct ref_entry *entry = dir->entries[i];
778 if (entry->flag & REF_DIR)
779 prime_ref_dir(get_ref_dir(entry));
780 }
781}
d66da478
MH
782/*
783 * Return true iff refname1 and refname2 conflict with each other.
784 * Two reference names conflict if one of them exactly matches the
785 * leading components of the other; e.g., "foo/bar" conflicts with
786 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
787 * "foo/barbados".
788 */
789static int names_conflict(const char *refname1, const char *refname2)
790{
5a4d4947
MH
791 for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
792 ;
793 return (*refname1 == '\0' && *refname2 == '/')
794 || (*refname1 == '/' && *refname2 == '\0');
795}
796
797struct name_conflict_cb {
798 const char *refname;
799 const char *oldrefname;
800 const char *conflicting_refname;
801};
802
624cac35 803static int name_conflict_fn(struct ref_entry *entry, void *cb_data)
5a4d4947
MH
804{
805 struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
624cac35 806 if (data->oldrefname && !strcmp(data->oldrefname, entry->name))
5a4d4947 807 return 0;
624cac35
MH
808 if (names_conflict(data->refname, entry->name)) {
809 data->conflicting_refname = entry->name;
5a4d4947 810 return 1;
d66da478 811 }
5a4d4947 812 return 0;
d66da478
MH
813}
814
bc5fd6d3
MH
815/*
816 * Return true iff a reference named refname could be created without
624cac35 817 * conflicting with the name of an existing reference in dir. If
5a4d4947
MH
818 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
819 * (e.g., because oldrefname is scheduled for deletion in the same
bc5fd6d3
MH
820 * operation).
821 */
822static int is_refname_available(const char *refname, const char *oldrefname,
d3177275 823 struct ref_dir *dir)
bc5fd6d3 824{
5a4d4947
MH
825 struct name_conflict_cb data;
826 data.refname = refname;
827 data.oldrefname = oldrefname;
828 data.conflicting_refname = NULL;
829
d3177275 830 sort_ref_dir(dir);
624cac35 831 if (do_for_each_entry_in_dir(dir, 0, name_conflict_fn, &data)) {
5a4d4947
MH
832 error("'%s' exists; cannot create '%s'",
833 data.conflicting_refname, refname);
834 return 0;
bc5fd6d3
MH
835 }
836 return 1;
e1e22e37
LT
837}
838
2fff7812
MH
839struct packed_ref_cache {
840 struct ref_entry *root;
9f69d297 841
5f5e2a88
MH
842 /*
843 * Count of references to the data structure in this instance,
844 * including the pointer from ref_cache::packed if any. The
845 * data will not be freed as long as the reference count is
846 * nonzero.
847 */
848 unsigned int referrers;
849
9f69d297
MH
850 /*
851 * Iff the packed-refs file associated with this instance is
852 * currently locked for writing, this points at the associated
4f6b83e3
MH
853 * lock (which is owned by somebody else). The referrer count
854 * is also incremented when the file is locked and decremented
855 * when it is unlocked.
9f69d297
MH
856 */
857 struct lock_file *lock;
ca919930
JK
858
859 /* The metadata from when this packed-refs cache was read */
860 struct stat_validity validity;
2fff7812
MH
861};
862
5e290ff7
JH
863/*
864 * Future: need to be in "struct repository"
865 * when doing a full libification.
866 */
79c7ca54
MH
867static struct ref_cache {
868 struct ref_cache *next;
d12229f5 869 struct ref_entry *loose;
2fff7812 870 struct packed_ref_cache *packed;
9da31cb0
MH
871 /*
872 * The submodule name, or "" for the main repo. We allocate
873 * length 1 rather than FLEX_ARRAY so that the main ref_cache
874 * is initialized correctly.
875 */
876 char name[1];
877} ref_cache, *submodule_ref_caches;
0e88c130 878
9f69d297
MH
879/* Lock used for the main packed-refs file: */
880static struct lock_file packlock;
881
5f5e2a88
MH
882/*
883 * Increment the reference count of *packed_refs.
884 */
885static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
886{
887 packed_refs->referrers++;
888}
889
890/*
891 * Decrease the reference count of *packed_refs. If it goes to zero,
892 * free *packed_refs and return true; otherwise return false.
893 */
894static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
895{
896 if (!--packed_refs->referrers) {
897 free_ref_entry(packed_refs->root);
ca919930 898 stat_validity_clear(&packed_refs->validity);
5f5e2a88
MH
899 free(packed_refs);
900 return 1;
901 } else {
902 return 0;
903 }
904}
905
760c4512 906static void clear_packed_ref_cache(struct ref_cache *refs)
e1e22e37 907{
d12229f5 908 if (refs->packed) {
5f5e2a88
MH
909 struct packed_ref_cache *packed_refs = refs->packed;
910
911 if (packed_refs->lock)
9f69d297 912 die("internal error: packed-ref cache cleared while locked");
d12229f5 913 refs->packed = NULL;
5f5e2a88 914 release_packed_ref_cache(packed_refs);
d12229f5 915 }
5e290ff7 916}
e1e22e37 917
760c4512
MH
918static void clear_loose_ref_cache(struct ref_cache *refs)
919{
d12229f5
MH
920 if (refs->loose) {
921 free_ref_entry(refs->loose);
922 refs->loose = NULL;
923 }
760c4512
MH
924}
925
79c7ca54 926static struct ref_cache *create_ref_cache(const char *submodule)
e5dbf605 927{
ce40979c 928 int len;
79c7ca54 929 struct ref_cache *refs;
ce40979c
MH
930 if (!submodule)
931 submodule = "";
932 len = strlen(submodule) + 1;
79c7ca54 933 refs = xcalloc(1, sizeof(struct ref_cache) + len);
ce40979c 934 memcpy(refs->name, submodule, len);
e5dbf605
MH
935 return refs;
936}
937
4349a668 938/*
79c7ca54 939 * Return a pointer to a ref_cache for the specified submodule. For
4349a668
MH
940 * the main repository, use submodule==NULL. The returned structure
941 * will be allocated and initialized but not necessarily populated; it
942 * should not be freed.
943 */
79c7ca54 944static struct ref_cache *get_ref_cache(const char *submodule)
4349a668 945{
9da31cb0
MH
946 struct ref_cache *refs;
947
948 if (!submodule || !*submodule)
949 return &ref_cache;
950
951 for (refs = submodule_ref_caches; refs; refs = refs->next)
0e88c130
MH
952 if (!strcmp(submodule, refs->name))
953 return refs;
0e88c130 954
79c7ca54 955 refs = create_ref_cache(submodule);
9da31cb0
MH
956 refs->next = submodule_ref_caches;
957 submodule_ref_caches = refs;
0e88c130 958 return refs;
4349a668
MH
959}
960
3feb4f0c
MH
961/* The length of a peeled reference line in packed-refs, including EOL: */
962#define PEELED_LINE_LENGTH 42
963
694b7a19
MH
964/*
965 * The packed-refs header line that we write out. Perhaps other
966 * traits will be added later. The trailing space is required.
967 */
968static const char PACKED_REFS_HEADER[] =
969 "# pack-refs with: peeled fully-peeled \n";
970
bc5fd6d3
MH
971/*
972 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
973 * Return a pointer to the refname within the line (null-terminated),
974 * or NULL if there was a problem.
975 */
976static const char *parse_ref_line(char *line, unsigned char *sha1)
977{
978 /*
979 * 42: the answer to everything.
980 *
981 * In this case, it happens to be the answer to
982 * 40 (length of sha1 hex representation)
983 * +1 (space in between hex and name)
984 * +1 (newline at the end of the line)
985 */
986 int len = strlen(line) - 42;
987
988 if (len <= 0)
989 return NULL;
990 if (get_sha1_hex(line, sha1) < 0)
991 return NULL;
992 if (!isspace(line[40]))
993 return NULL;
994 line += 41;
995 if (isspace(*line))
996 return NULL;
997 if (line[len] != '\n')
998 return NULL;
999 line[len] = 0;
1000
1001 return line;
1002}
1003
c29c46fa
MH
1004/*
1005 * Read f, which is a packed-refs file, into dir.
1006 *
1007 * A comment line of the form "# pack-refs with: " may contain zero or
1008 * more traits. We interpret the traits as follows:
1009 *
1010 * No traits:
1011 *
1012 * Probably no references are peeled. But if the file contains a
1013 * peeled value for a reference, we will use it.
1014 *
1015 * peeled:
1016 *
1017 * References under "refs/tags/", if they *can* be peeled, *are*
1018 * peeled in this file. References outside of "refs/tags/" are
1019 * probably not peeled even if they could have been, but if we find
1020 * a peeled value for such a reference we will use it.
1021 *
1022 * fully-peeled:
1023 *
1024 * All references in the file that can be peeled are peeled.
1025 * Inversely (and this is more important), any references in the
1026 * file for which no peeled value is recorded is not peelable. This
1027 * trait should typically be written alongside "peeled" for
1028 * compatibility with older clients, but we do not require it
1029 * (i.e., "peeled" is a no-op if "fully-peeled" is set).
1030 */
d3177275 1031static void read_packed_refs(FILE *f, struct ref_dir *dir)
f4204ab9 1032{
e9c4c111 1033 struct ref_entry *last = NULL;
f4204ab9 1034 char refline[PATH_MAX];
c29c46fa 1035 enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
f4204ab9
JH
1036
1037 while (fgets(refline, sizeof(refline), f)) {
1038 unsigned char sha1[20];
dfefa935 1039 const char *refname;
f4204ab9
JH
1040 static const char header[] = "# pack-refs with:";
1041
1042 if (!strncmp(refline, header, sizeof(header)-1)) {
1043 const char *traits = refline + sizeof(header) - 1;
c29c46fa
MH
1044 if (strstr(traits, " fully-peeled "))
1045 peeled = PEELED_FULLY;
1046 else if (strstr(traits, " peeled "))
1047 peeled = PEELED_TAGS;
f4204ab9
JH
1048 /* perhaps other traits later as well */
1049 continue;
1050 }
1051
dfefa935
MH
1052 refname = parse_ref_line(refline, sha1);
1053 if (refname) {
c29c46fa
MH
1054 last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
1055 if (peeled == PEELED_FULLY ||
59556548 1056 (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
c29c46fa 1057 last->flag |= REF_KNOWS_PEELED;
d3177275 1058 add_ref(dir, last);
f4204ab9
JH
1059 continue;
1060 }
1061 if (last &&
1062 refline[0] == '^' &&
3feb4f0c
MH
1063 strlen(refline) == PEELED_LINE_LENGTH &&
1064 refline[PEELED_LINE_LENGTH - 1] == '\n' &&
c29c46fa 1065 !get_sha1_hex(refline + 1, sha1)) {
593f1bb8 1066 hashcpy(last->u.value.peeled, sha1);
c29c46fa
MH
1067 /*
1068 * Regardless of what the file header said,
1069 * we definitely know the value of *this*
1070 * reference:
1071 */
1072 last->flag |= REF_KNOWS_PEELED;
1073 }
f4204ab9 1074 }
f4204ab9
JH
1075}
1076
2fff7812
MH
1077/*
1078 * Get the packed_ref_cache for the specified ref_cache, creating it
1079 * if necessary.
1080 */
1081static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
5e290ff7 1082{
ca919930
JK
1083 const char *packed_refs_file;
1084
1085 if (*refs->name)
1086 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
1087 else
1088 packed_refs_file = git_path("packed-refs");
1089
1090 if (refs->packed &&
1091 !stat_validity_check(&refs->packed->validity, packed_refs_file))
1092 clear_packed_ref_cache(refs);
1093
d12229f5 1094 if (!refs->packed) {
4349a668 1095 FILE *f;
0bad611b 1096
2fff7812 1097 refs->packed = xcalloc(1, sizeof(*refs->packed));
5f5e2a88 1098 acquire_packed_ref_cache(refs->packed);
2fff7812 1099 refs->packed->root = create_dir_entry(refs, "", 0, 0);
4349a668 1100 f = fopen(packed_refs_file, "r");
e1e22e37 1101 if (f) {
ca919930 1102 stat_validity_update(&refs->packed->validity, fileno(f));
2fff7812 1103 read_packed_refs(f, get_ref_dir(refs->packed->root));
e1e22e37 1104 fclose(f);
e1e22e37 1105 }
e1e22e37 1106 }
2fff7812
MH
1107 return refs->packed;
1108}
1109
1110static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
1111{
1112 return get_ref_dir(packed_ref_cache->root);
1113}
1114
1115static struct ref_dir *get_packed_refs(struct ref_cache *refs)
1116{
1117 return get_packed_ref_dir(get_packed_ref_cache(refs));
e1e22e37
LT
1118}
1119
30249ee6
MH
1120void add_packed_ref(const char *refname, const unsigned char *sha1)
1121{
9f69d297
MH
1122 struct packed_ref_cache *packed_ref_cache =
1123 get_packed_ref_cache(&ref_cache);
1124
1125 if (!packed_ref_cache->lock)
1126 die("internal error: packed refs not locked");
1127 add_ref(get_packed_ref_dir(packed_ref_cache),
9da31cb0 1128 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
30249ee6
MH
1129}
1130
abc39098 1131/*
28e6a34e
MH
1132 * Read the loose references from the namespace dirname into dir
1133 * (without recursing). dirname must end with '/'. dir must be the
1134 * directory entry corresponding to dirname.
abc39098 1135 */
423a1afc 1136static void read_loose_refs(const char *dirname, struct ref_dir *dir)
e1e22e37 1137{
423a1afc 1138 struct ref_cache *refs = dir->ref_cache;
d3177275 1139 DIR *d;
0bad611b 1140 const char *path;
d5fdae67 1141 struct dirent *de;
abc39098 1142 int dirnamelen = strlen(dirname);
72b64b44 1143 struct strbuf refname;
0bad611b 1144
3b124823 1145 if (*refs->name)
66a3d20b 1146 path = git_path_submodule(refs->name, "%s", dirname);
0bad611b 1147 else
66a3d20b 1148 path = git_path("%s", dirname);
0bad611b 1149
d3177275 1150 d = opendir(path);
d5fdae67
MH
1151 if (!d)
1152 return;
1153
66a3d20b
MH
1154 strbuf_init(&refname, dirnamelen + 257);
1155 strbuf_add(&refname, dirname, dirnamelen);
d5fdae67
MH
1156
1157 while ((de = readdir(d)) != NULL) {
1158 unsigned char sha1[20];
1159 struct stat st;
1160 int flag;
d5fdae67
MH
1161 const char *refdir;
1162
1163 if (de->d_name[0] == '.')
1164 continue;
d5fdae67
MH
1165 if (has_extension(de->d_name, ".lock"))
1166 continue;
72b64b44 1167 strbuf_addstr(&refname, de->d_name);
d5fdae67 1168 refdir = *refs->name
72b64b44
MH
1169 ? git_path_submodule(refs->name, "%s", refname.buf)
1170 : git_path("%s", refname.buf);
1171 if (stat(refdir, &st) < 0) {
1172 ; /* silently ignore */
1173 } else if (S_ISDIR(st.st_mode)) {
abc39098 1174 strbuf_addch(&refname, '/');
28e6a34e 1175 add_entry_to_dir(dir,
b9146f51
RS
1176 create_dir_entry(refs, refname.buf,
1177 refname.len, 1));
72b64b44 1178 } else {
3b124823 1179 if (*refs->name) {
f8948e2f 1180 hashclr(sha1);
0bad611b 1181 flag = 0;
72b64b44 1182 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
0bad611b 1183 hashclr(sha1);
98ac34b2 1184 flag |= REF_ISBROKEN;
0bad611b 1185 }
72b64b44 1186 } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
09116a1c
JH
1187 hashclr(sha1);
1188 flag |= REF_ISBROKEN;
1189 }
9f2fb4a3
MH
1190 add_entry_to_dir(dir,
1191 create_ref_entry(refname.buf, sha1, flag, 1));
e1e22e37 1192 }
66a3d20b 1193 strbuf_setlen(&refname, dirnamelen);
e1e22e37 1194 }
72b64b44 1195 strbuf_release(&refname);
d5fdae67 1196 closedir(d);
e1e22e37
LT
1197}
1198
d3177275 1199static struct ref_dir *get_loose_refs(struct ref_cache *refs)
e1e22e37 1200{
d12229f5 1201 if (!refs->loose) {
28e6a34e
MH
1202 /*
1203 * Mark the top-level directory complete because we
1204 * are about to read the only subdirectory that can
1205 * hold references:
1206 */
b9146f51 1207 refs->loose = create_dir_entry(refs, "", 0, 0);
28e6a34e
MH
1208 /*
1209 * Create an incomplete entry for "refs/":
1210 */
1211 add_entry_to_dir(get_ref_dir(refs->loose),
b9146f51 1212 create_dir_entry(refs, "refs/", 5, 1));
e1e22e37 1213 }
d7826d54 1214 return get_ref_dir(refs->loose);
e1e22e37
LT
1215}
1216
ca8db142
LT
1217/* We allow "recursive" symbolic refs. Only within reason, though */
1218#define MAXDEPTH 5
0ebde32c
LT
1219#define MAXREFLEN (1024)
1220
e5fa45c1
JH
1221/*
1222 * Called by resolve_gitlink_ref_recursive() after it failed to read
b0626608
MH
1223 * from the loose refs in ref_cache refs. Find <refname> in the
1224 * packed-refs file for the submodule.
e5fa45c1 1225 */
b0626608 1226static int resolve_gitlink_packed_ref(struct ref_cache *refs,
85be1fe3 1227 const char *refname, unsigned char *sha1)
0ebde32c 1228{
2c5c66be 1229 struct ref_entry *ref;
d3177275 1230 struct ref_dir *dir = get_packed_refs(refs);
0ebde32c 1231
432ad41e 1232 ref = find_ref(dir, refname);
b0626608
MH
1233 if (ref == NULL)
1234 return -1;
1235
50546b15 1236 hashcpy(sha1, ref->u.value.sha1);
b0626608 1237 return 0;
0ebde32c
LT
1238}
1239
b0626608 1240static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
85be1fe3 1241 const char *refname, unsigned char *sha1,
dfefa935 1242 int recursion)
0ebde32c 1243{
064d51dc 1244 int fd, len;
0ebde32c 1245 char buffer[128], *p;
064d51dc 1246 char *path;
0ebde32c 1247
064d51dc 1248 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
0ebde32c 1249 return -1;
064d51dc
MH
1250 path = *refs->name
1251 ? git_path_submodule(refs->name, "%s", refname)
1252 : git_path("%s", refname);
1253 fd = open(path, O_RDONLY);
0ebde32c 1254 if (fd < 0)
b0626608 1255 return resolve_gitlink_packed_ref(refs, refname, sha1);
0ebde32c
LT
1256
1257 len = read(fd, buffer, sizeof(buffer)-1);
1258 close(fd);
1259 if (len < 0)
1260 return -1;
1261 while (len && isspace(buffer[len-1]))
1262 len--;
1263 buffer[len] = 0;
1264
1265 /* Was it a detached head or an old-fashioned symlink? */
85be1fe3 1266 if (!get_sha1_hex(buffer, sha1))
0ebde32c
LT
1267 return 0;
1268
1269 /* Symref? */
1270 if (strncmp(buffer, "ref:", 4))
1271 return -1;
1272 p = buffer + 4;
1273 while (isspace(*p))
1274 p++;
1275
064d51dc 1276 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
0ebde32c
LT
1277}
1278
85be1fe3 1279int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
0ebde32c
LT
1280{
1281 int len = strlen(path), retval;
064d51dc 1282 char *submodule;
b0626608 1283 struct ref_cache *refs;
0ebde32c
LT
1284
1285 while (len && path[len-1] == '/')
1286 len--;
1287 if (!len)
1288 return -1;
b0626608
MH
1289 submodule = xstrndup(path, len);
1290 refs = get_ref_cache(submodule);
1291 free(submodule);
1292
064d51dc 1293 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
0ebde32c
LT
1294 return retval;
1295}
ca8db142 1296
4886b89f 1297/*
63331581
MH
1298 * Return the ref_entry for the given refname from the packed
1299 * references. If it does not exist, return NULL.
4886b89f 1300 */
63331581 1301static struct ref_entry *get_packed_ref(const char *refname)
c224ca7f 1302{
9da31cb0 1303 return find_ref(get_packed_refs(&ref_cache), refname);
c224ca7f
MH
1304}
1305
47f534bf
MH
1306/*
1307 * A loose ref file doesn't exist; check for a packed ref. The
1308 * options are forwarded from resolve_safe_unsafe().
1309 */
1310static const char *handle_missing_loose_ref(const char *refname,
1311 unsigned char *sha1,
1312 int reading,
1313 int *flag)
1314{
1315 struct ref_entry *entry;
1316
1317 /*
1318 * The loose reference file does not exist; check for a packed
1319 * reference.
1320 */
1321 entry = get_packed_ref(refname);
1322 if (entry) {
1323 hashcpy(sha1, entry->u.value.sha1);
1324 if (flag)
1325 *flag |= REF_ISPACKED;
1326 return refname;
1327 }
1328 /* The reference is not a packed reference, either. */
1329 if (reading) {
1330 return NULL;
1331 } else {
1332 hashclr(sha1);
1333 return refname;
1334 }
1335}
1336
8d68493f 1337const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
8a65ff76 1338{
0104ca09
HO
1339 int depth = MAXDEPTH;
1340 ssize_t len;
a876ed83 1341 char buffer[256];
dfefa935 1342 static char refname_buffer[256];
ca8db142 1343
8da19775
JH
1344 if (flag)
1345 *flag = 0;
1346
dfefa935 1347 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
8384d788
MH
1348 return NULL;
1349
a876ed83 1350 for (;;) {
55956350 1351 char path[PATH_MAX];
a876ed83
JH
1352 struct stat st;
1353 char *buf;
1354 int fd;
8a65ff76 1355
a876ed83
JH
1356 if (--depth < 0)
1357 return NULL;
ca8db142 1358
dfefa935 1359 git_snpath(path, sizeof(path), "%s", refname);
c224ca7f 1360
fcb7c762
MH
1361 /*
1362 * We might have to loop back here to avoid a race
1363 * condition: first we lstat() the file, then we try
1364 * to read it as a link or as a file. But if somebody
1365 * changes the type of the file (file <-> directory
1366 * <-> symlink) between the lstat() and reading, then
1367 * we don't want to report that as an error but rather
1368 * try again starting with the lstat().
1369 */
1370 stat_ref:
a876ed83 1371 if (lstat(path, &st) < 0) {
47f534bf
MH
1372 if (errno == ENOENT)
1373 return handle_missing_loose_ref(refname, sha1,
1374 reading, flag);
1375 else
a876ed83 1376 return NULL;
a876ed83 1377 }
ca8db142 1378
a876ed83
JH
1379 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1380 if (S_ISLNK(st.st_mode)) {
1381 len = readlink(path, buffer, sizeof(buffer)-1);
fcb7c762
MH
1382 if (len < 0) {
1383 if (errno == ENOENT || errno == EINVAL)
1384 /* inconsistent with lstat; retry */
1385 goto stat_ref;
1386 else
1387 return NULL;
1388 }
b54cb795 1389 buffer[len] = 0;
59556548 1390 if (starts_with(buffer, "refs/") &&
1f58a038 1391 !check_refname_format(buffer, 0)) {
dfefa935
MH
1392 strcpy(refname_buffer, buffer);
1393 refname = refname_buffer;
8da19775
JH
1394 if (flag)
1395 *flag |= REF_ISSYMREF;
a876ed83
JH
1396 continue;
1397 }
ca8db142 1398 }
a876ed83 1399
7a21632f
DS
1400 /* Is it a directory? */
1401 if (S_ISDIR(st.st_mode)) {
1402 errno = EISDIR;
1403 return NULL;
1404 }
1405
a876ed83
JH
1406 /*
1407 * Anything else, just open it and try to use it as
1408 * a ref
1409 */
1410 fd = open(path, O_RDONLY);
fcb7c762
MH
1411 if (fd < 0) {
1412 if (errno == ENOENT)
1413 /* inconsistent with lstat; retry */
1414 goto stat_ref;
1415 else
1416 return NULL;
1417 }
93d26e4c 1418 len = read_in_full(fd, buffer, sizeof(buffer)-1);
a876ed83 1419 close(fd);
28775050
MH
1420 if (len < 0)
1421 return NULL;
1422 while (len && isspace(buffer[len-1]))
1423 len--;
1424 buffer[len] = '\0';
a876ed83
JH
1425
1426 /*
1427 * Is it a symbolic ref?
1428 */
59556548 1429 if (!starts_with(buffer, "ref:")) {
2884c06a
MH
1430 /*
1431 * Please note that FETCH_HEAD has a second
1432 * line containing other data.
1433 */
1434 if (get_sha1_hex(buffer, sha1) ||
1435 (buffer[40] != '\0' && !isspace(buffer[40]))) {
1436 if (flag)
1437 *flag |= REF_ISBROKEN;
1438 return NULL;
1439 }
1440 return refname;
1441 }
55956350
JH
1442 if (flag)
1443 *flag |= REF_ISSYMREF;
a876ed83 1444 buf = buffer + 4;
28775050
MH
1445 while (isspace(*buf))
1446 buf++;
313fb010 1447 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
55956350
JH
1448 if (flag)
1449 *flag |= REF_ISBROKEN;
313fb010
MH
1450 return NULL;
1451 }
dfefa935 1452 refname = strcpy(refname_buffer, buf);
8a65ff76 1453 }
a876ed83
JH
1454}
1455
96ec7b1e
NTND
1456char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1457{
8cad4744 1458 const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
96ec7b1e
NTND
1459 return ret ? xstrdup(ret) : NULL;
1460}
1461
d08bae7e
IL
1462/* The argument to filter_refs */
1463struct ref_filter {
1464 const char *pattern;
1465 each_ref_fn *fn;
1466 void *cb_data;
1467};
1468
dfefa935 1469int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
a876ed83 1470{
8d68493f 1471 if (resolve_ref_unsafe(refname, sha1, reading, flags))
a876ed83
JH
1472 return 0;
1473 return -1;
8a65ff76
LT
1474}
1475
dfefa935 1476int read_ref(const char *refname, unsigned char *sha1)
c6893323 1477{
dfefa935 1478 return read_ref_full(refname, sha1, 1, NULL);
c6893323
NTND
1479}
1480
bc5fd6d3 1481int ref_exists(const char *refname)
ef06b918 1482{
bc5fd6d3
MH
1483 unsigned char sha1[20];
1484 return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
ef06b918
JH
1485}
1486
85be1fe3 1487static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
dfefa935 1488 void *data)
d08bae7e
IL
1489{
1490 struct ref_filter *filter = (struct ref_filter *)data;
eb07894f 1491 if (wildmatch(filter->pattern, refname, 0, NULL))
d08bae7e 1492 return 0;
85be1fe3 1493 return filter->fn(refname, sha1, flags, filter->cb_data);
d08bae7e
IL
1494}
1495
68cf8703
MH
1496enum peel_status {
1497 /* object was peeled successfully: */
1498 PEEL_PEELED = 0,
1499
1500 /*
1501 * object cannot be peeled because the named object (or an
1502 * object referred to by a tag in the peel chain), does not
1503 * exist.
1504 */
1505 PEEL_INVALID = -1,
1506
1507 /* object cannot be peeled because it is not a tag: */
9a489f3c
MH
1508 PEEL_NON_TAG = -2,
1509
1510 /* ref_entry contains no peeled value because it is a symref: */
1511 PEEL_IS_SYMREF = -3,
1512
1513 /*
1514 * ref_entry cannot be peeled because it is broken (i.e., the
1515 * symbolic reference cannot even be resolved to an object
1516 * name):
1517 */
1518 PEEL_BROKEN = -4
68cf8703
MH
1519};
1520
cb2ae1c4
MH
1521/*
1522 * Peel the named object; i.e., if the object is a tag, resolve the
68cf8703
MH
1523 * tag recursively until a non-tag is found. If successful, store the
1524 * result to sha1 and return PEEL_PEELED. If the object is not a tag
1525 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
1526 * and leave sha1 unchanged.
cb2ae1c4 1527 */
68cf8703 1528static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
cb2ae1c4
MH
1529{
1530 struct object *o = lookup_unknown_object(name);
1531
1532 if (o->type == OBJ_NONE) {
1533 int type = sha1_object_info(name, NULL);
8ff226a9 1534 if (type < 0 || !object_as_type(o, type, 0))
68cf8703 1535 return PEEL_INVALID;
cb2ae1c4
MH
1536 }
1537
1538 if (o->type != OBJ_TAG)
68cf8703 1539 return PEEL_NON_TAG;
cb2ae1c4
MH
1540
1541 o = deref_tag_noverify(o);
1542 if (!o)
68cf8703 1543 return PEEL_INVALID;
cb2ae1c4
MH
1544
1545 hashcpy(sha1, o->sha1);
68cf8703 1546 return PEEL_PEELED;
cb2ae1c4
MH
1547}
1548
9a489f3c 1549/*
f85354b5
MH
1550 * Peel the entry (if possible) and return its new peel_status. If
1551 * repeel is true, re-peel the entry even if there is an old peeled
1552 * value that is already stored in it.
694b7a19
MH
1553 *
1554 * It is OK to call this function with a packed reference entry that
1555 * might be stale and might even refer to an object that has since
1556 * been garbage-collected. In such a case, if the entry has
1557 * REF_KNOWS_PEELED then leave the status unchanged and return
1558 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
9a489f3c 1559 */
f85354b5 1560static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
9a489f3c
MH
1561{
1562 enum peel_status status;
1563
f85354b5
MH
1564 if (entry->flag & REF_KNOWS_PEELED) {
1565 if (repeel) {
1566 entry->flag &= ~REF_KNOWS_PEELED;
1567 hashclr(entry->u.value.peeled);
1568 } else {
1569 return is_null_sha1(entry->u.value.peeled) ?
1570 PEEL_NON_TAG : PEEL_PEELED;
1571 }
1572 }
9a489f3c
MH
1573 if (entry->flag & REF_ISBROKEN)
1574 return PEEL_BROKEN;
1575 if (entry->flag & REF_ISSYMREF)
1576 return PEEL_IS_SYMREF;
1577
1578 status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
1579 if (status == PEEL_PEELED || status == PEEL_NON_TAG)
1580 entry->flag |= REF_KNOWS_PEELED;
1581 return status;
1582}
1583
dfefa935 1584int peel_ref(const char *refname, unsigned char *sha1)
cf0adba7
JH
1585{
1586 int flag;
1587 unsigned char base[20];
cf0adba7 1588
dfefa935 1589 if (current_ref && (current_ref->name == refname
9a489f3c 1590 || !strcmp(current_ref->name, refname))) {
f85354b5 1591 if (peel_entry(current_ref, 0))
9a489f3c
MH
1592 return -1;
1593 hashcpy(sha1, current_ref->u.value.peeled);
1594 return 0;
0ae91be0
SP
1595 }
1596
dfefa935 1597 if (read_ref_full(refname, base, 1, &flag))
cf0adba7
JH
1598 return -1;
1599
9a489f3c
MH
1600 /*
1601 * If the reference is packed, read its ref_entry from the
1602 * cache in the hope that we already know its peeled value.
1603 * We only try this optimization on packed references because
1604 * (a) forcing the filling of the loose reference cache could
1605 * be expensive and (b) loose references anyway usually do not
1606 * have REF_KNOWS_PEELED.
1607 */
1608 if (flag & REF_ISPACKED) {
f361baeb 1609 struct ref_entry *r = get_packed_ref(refname);
9a489f3c 1610 if (r) {
f85354b5 1611 if (peel_entry(r, 0))
9a489f3c 1612 return -1;
593f1bb8 1613 hashcpy(sha1, r->u.value.peeled);
e9c4c111 1614 return 0;
cf0adba7 1615 }
cf0adba7
JH
1616 }
1617
cb2ae1c4 1618 return peel_object(base, sha1);
cf0adba7
JH
1619}
1620
bc5fd6d3
MH
1621struct warn_if_dangling_data {
1622 FILE *fp;
1623 const char *refname;
e6bea66d 1624 const struct string_list *refnames;
bc5fd6d3
MH
1625 const char *msg_fmt;
1626};
1627
1628static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1629 int flags, void *cb_data)
1630{
1631 struct warn_if_dangling_data *d = cb_data;
1632 const char *resolves_to;
1633 unsigned char junk[20];
1634
1635 if (!(flags & REF_ISSYMREF))
1636 return 0;
1637
1638 resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
e6bea66d
JL
1639 if (!resolves_to
1640 || (d->refname
1641 ? strcmp(resolves_to, d->refname)
1642 : !string_list_has_string(d->refnames, resolves_to))) {
bc5fd6d3 1643 return 0;
e6bea66d 1644 }
bc5fd6d3
MH
1645
1646 fprintf(d->fp, d->msg_fmt, refname);
1be65eda 1647 fputc('\n', d->fp);
bc5fd6d3
MH
1648 return 0;
1649}
1650
1651void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1652{
1653 struct warn_if_dangling_data data;
1654
1655 data.fp = fp;
1656 data.refname = refname;
e6bea66d
JL
1657 data.refnames = NULL;
1658 data.msg_fmt = msg_fmt;
1659 for_each_rawref(warn_if_dangling_symref, &data);
1660}
1661
1662void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
1663{
1664 struct warn_if_dangling_data data;
1665
1666 data.fp = fp;
1667 data.refname = NULL;
1668 data.refnames = refnames;
bc5fd6d3
MH
1669 data.msg_fmt = msg_fmt;
1670 for_each_rawref(warn_if_dangling_symref, &data);
1671}
1672
fcce1703 1673/*
65cf102b 1674 * Call fn for each reference in the specified ref_cache, omitting
624cac35
MH
1675 * references not in the containing_dir of base. fn is called for all
1676 * references, including broken ones. If fn ever returns a non-zero
fcce1703
MH
1677 * value, stop the iteration and return that value; otherwise, return
1678 * 0.
1679 */
65cf102b 1680static int do_for_each_entry(struct ref_cache *refs, const char *base,
624cac35 1681 each_ref_entry_fn fn, void *cb_data)
8a65ff76 1682{
98eeb09e
JK
1683 struct packed_ref_cache *packed_ref_cache;
1684 struct ref_dir *loose_dir;
1685 struct ref_dir *packed_dir;
933ac036
MH
1686 int retval = 0;
1687
98eeb09e
JK
1688 /*
1689 * We must make sure that all loose refs are read before accessing the
1690 * packed-refs file; this avoids a race condition in which loose refs
1691 * are migrated to the packed-refs file by a simultaneous process, but
1692 * our in-memory view is from before the migration. get_packed_ref_cache()
1693 * takes care of making sure our view is up to date with what is on
1694 * disk.
1695 */
1696 loose_dir = get_loose_refs(refs);
933ac036 1697 if (base && *base) {
933ac036
MH
1698 loose_dir = find_containing_dir(loose_dir, base, 0);
1699 }
98eeb09e
JK
1700 if (loose_dir)
1701 prime_ref_dir(loose_dir);
1702
1703 packed_ref_cache = get_packed_ref_cache(refs);
8baf2bb9 1704 acquire_packed_ref_cache(packed_ref_cache);
98eeb09e 1705 packed_dir = get_packed_ref_dir(packed_ref_cache);
933ac036
MH
1706 if (base && *base) {
1707 packed_dir = find_containing_dir(packed_dir, base, 0);
933ac036
MH
1708 }
1709
1710 if (packed_dir && loose_dir) {
1711 sort_ref_dir(packed_dir);
1712 sort_ref_dir(loose_dir);
624cac35
MH
1713 retval = do_for_each_entry_in_dirs(
1714 packed_dir, loose_dir, fn, cb_data);
933ac036
MH
1715 } else if (packed_dir) {
1716 sort_ref_dir(packed_dir);
624cac35
MH
1717 retval = do_for_each_entry_in_dir(
1718 packed_dir, 0, fn, cb_data);
933ac036
MH
1719 } else if (loose_dir) {
1720 sort_ref_dir(loose_dir);
624cac35
MH
1721 retval = do_for_each_entry_in_dir(
1722 loose_dir, 0, fn, cb_data);
933ac036
MH
1723 }
1724
8baf2bb9 1725 release_packed_ref_cache(packed_ref_cache);
933ac036 1726 return retval;
8a65ff76
LT
1727}
1728
624cac35 1729/*
65cf102b 1730 * Call fn for each reference in the specified ref_cache for which the
624cac35
MH
1731 * refname begins with base. If trim is non-zero, then trim that many
1732 * characters off the beginning of each refname before passing the
1733 * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
1734 * broken references in the iteration. If fn ever returns a non-zero
1735 * value, stop the iteration and return that value; otherwise, return
1736 * 0.
1737 */
65cf102b
MH
1738static int do_for_each_ref(struct ref_cache *refs, const char *base,
1739 each_ref_fn fn, int trim, int flags, void *cb_data)
624cac35
MH
1740{
1741 struct ref_entry_cb data;
1742 data.base = base;
1743 data.trim = trim;
1744 data.flags = flags;
1745 data.fn = fn;
1746 data.cb_data = cb_data;
1747
65cf102b 1748 return do_for_each_entry(refs, base, do_one_ref, &data);
624cac35
MH
1749}
1750
0bad611b 1751static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
723c31fe
LT
1752{
1753 unsigned char sha1[20];
8da19775
JH
1754 int flag;
1755
0bad611b
HV
1756 if (submodule) {
1757 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1758 return fn("HEAD", sha1, 0, cb_data);
1759
1760 return 0;
1761 }
1762
c6893323 1763 if (!read_ref_full("HEAD", sha1, 1, &flag))
8da19775 1764 return fn("HEAD", sha1, flag, cb_data);
0bad611b 1765
2f34ba32 1766 return 0;
723c31fe
LT
1767}
1768
0bad611b
HV
1769int head_ref(each_ref_fn fn, void *cb_data)
1770{
1771 return do_head_ref(NULL, fn, cb_data);
1772}
1773
9ef6aeb0
HV
1774int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1775{
1776 return do_head_ref(submodule, fn, cb_data);
1777}
1778
cb5d709f 1779int for_each_ref(each_ref_fn fn, void *cb_data)
8a65ff76 1780{
9da31cb0 1781 return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
a62be77f
SE
1782}
1783
9ef6aeb0
HV
1784int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1785{
65cf102b 1786 return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
a62be77f
SE
1787}
1788
2a8177b6
CC
1789int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1790{
9da31cb0 1791 return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
2a8177b6
CC
1792}
1793
9ef6aeb0
HV
1794int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1795 each_ref_fn fn, void *cb_data)
1796{
65cf102b 1797 return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
2a8177b6
CC
1798}
1799
cb5d709f 1800int for_each_tag_ref(each_ref_fn fn, void *cb_data)
a62be77f 1801{
2a8177b6 1802 return for_each_ref_in("refs/tags/", fn, cb_data);
a62be77f
SE
1803}
1804
9ef6aeb0
HV
1805int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1806{
1807 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1808}
1809
cb5d709f 1810int for_each_branch_ref(each_ref_fn fn, void *cb_data)
a62be77f 1811{
2a8177b6 1812 return for_each_ref_in("refs/heads/", fn, cb_data);
a62be77f
SE
1813}
1814
9ef6aeb0
HV
1815int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1816{
1817 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1818}
1819
cb5d709f 1820int for_each_remote_ref(each_ref_fn fn, void *cb_data)
a62be77f 1821{
2a8177b6 1822 return for_each_ref_in("refs/remotes/", fn, cb_data);
f8948e2f
JH
1823}
1824
9ef6aeb0
HV
1825int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1826{
1827 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1828}
1829
29268700
CC
1830int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1831{
9da31cb0 1832 return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
29268700
CC
1833}
1834
a1bea2c1
JT
1835int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1836{
1837 struct strbuf buf = STRBUF_INIT;
1838 int ret = 0;
1839 unsigned char sha1[20];
1840 int flag;
1841
1842 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
c6893323 1843 if (!read_ref_full(buf.buf, sha1, 1, &flag))
a1bea2c1
JT
1844 ret = fn(buf.buf, sha1, flag, cb_data);
1845 strbuf_release(&buf);
1846
1847 return ret;
1848}
1849
1850int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1851{
1852 struct strbuf buf = STRBUF_INIT;
1853 int ret;
1854 strbuf_addf(&buf, "%srefs/", get_git_namespace());
9da31cb0 1855 ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
a1bea2c1
JT
1856 strbuf_release(&buf);
1857 return ret;
1858}
1859
b09fe971
IL
1860int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1861 const char *prefix, void *cb_data)
d08bae7e
IL
1862{
1863 struct strbuf real_pattern = STRBUF_INIT;
1864 struct ref_filter filter;
d08bae7e
IL
1865 int ret;
1866
59556548 1867 if (!prefix && !starts_with(pattern, "refs/"))
d08bae7e 1868 strbuf_addstr(&real_pattern, "refs/");
b09fe971
IL
1869 else if (prefix)
1870 strbuf_addstr(&real_pattern, prefix);
d08bae7e
IL
1871 strbuf_addstr(&real_pattern, pattern);
1872
894a9d33 1873 if (!has_glob_specials(pattern)) {
9517e6b8 1874 /* Append implied '/' '*' if not present. */
d08bae7e
IL
1875 if (real_pattern.buf[real_pattern.len - 1] != '/')
1876 strbuf_addch(&real_pattern, '/');
1877 /* No need to check for '*', there is none. */
1878 strbuf_addch(&real_pattern, '*');
1879 }
1880
1881 filter.pattern = real_pattern.buf;
1882 filter.fn = fn;
1883 filter.cb_data = cb_data;
1884 ret = for_each_ref(filter_refs, &filter);
1885
1886 strbuf_release(&real_pattern);
1887 return ret;
1888}
1889
b09fe971
IL
1890int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1891{
1892 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1893}
1894
f8948e2f
JH
1895int for_each_rawref(each_ref_fn fn, void *cb_data)
1896{
9da31cb0 1897 return do_for_each_ref(&ref_cache, "", fn, 0,
f8948e2f 1898 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
8a65ff76
LT
1899}
1900
4577e483 1901const char *prettify_refname(const char *name)
a9c37a72 1902{
a9c37a72 1903 return name + (
59556548
CC
1904 starts_with(name, "refs/heads/") ? 11 :
1905 starts_with(name, "refs/tags/") ? 10 :
1906 starts_with(name, "refs/remotes/") ? 13 :
a9c37a72
DB
1907 0);
1908}
1909
54457fe5 1910static const char *ref_rev_parse_rules[] = {
79803322
SP
1911 "%.*s",
1912 "refs/%.*s",
1913 "refs/tags/%.*s",
1914 "refs/heads/%.*s",
1915 "refs/remotes/%.*s",
1916 "refs/remotes/%.*s/HEAD",
1917 NULL
1918};
1919
54457fe5 1920int refname_match(const char *abbrev_name, const char *full_name)
79803322
SP
1921{
1922 const char **p;
1923 const int abbrev_name_len = strlen(abbrev_name);
1924
54457fe5 1925 for (p = ref_rev_parse_rules; *p; p++) {
79803322
SP
1926 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1927 return 1;
1928 }
1929 }
1930
1931 return 0;
1932}
1933
e5f38ec3 1934static struct ref_lock *verify_lock(struct ref_lock *lock,
4bd18c43
SP
1935 const unsigned char *old_sha1, int mustexist)
1936{
c6893323 1937 if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
434cd0cd 1938 error("Can't verify ref %s", lock->ref_name);
4bd18c43
SP
1939 unlock_ref(lock);
1940 return NULL;
1941 }
a89fccd2 1942 if (hashcmp(lock->old_sha1, old_sha1)) {
434cd0cd 1943 error("Ref %s is at %s but expected %s", lock->ref_name,
4bd18c43
SP
1944 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1945 unlock_ref(lock);
1946 return NULL;
1947 }
1948 return lock;
1949}
1950
7155b727 1951static int remove_empty_directories(const char *file)
bc7127ef
JH
1952{
1953 /* we want to create a file but there is a directory there;
1954 * if that is an empty directory (or a directory that contains
1955 * only empty directories), remove them.
1956 */
7155b727
JS
1957 struct strbuf path;
1958 int result;
bc7127ef 1959
7155b727
JS
1960 strbuf_init(&path, 20);
1961 strbuf_addstr(&path, file);
1962
a0f4afbe 1963 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
7155b727
JS
1964
1965 strbuf_release(&path);
1966
1967 return result;
bc7127ef
JH
1968}
1969
ff74f7f1
JH
1970/*
1971 * *string and *len will only be substituted, and *string returned (for
1972 * later free()ing) if the string passed in is a magic short-hand form
1973 * to name a branch.
1974 */
1975static char *substitute_branch_name(const char **string, int *len)
1976{
1977 struct strbuf buf = STRBUF_INIT;
cf99a761 1978 int ret = interpret_branch_name(*string, *len, &buf);
ff74f7f1
JH
1979
1980 if (ret == *len) {
1981 size_t size;
1982 *string = strbuf_detach(&buf, &size);
1983 *len = size;
1984 return (char *)*string;
1985 }
1986
1987 return NULL;
1988}
1989
1990int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1991{
1992 char *last_branch = substitute_branch_name(&str, &len);
1993 const char **p, *r;
1994 int refs_found = 0;
1995
1996 *ref = NULL;
1997 for (p = ref_rev_parse_rules; *p; p++) {
1998 char fullref[PATH_MAX];
1999 unsigned char sha1_from_ref[20];
2000 unsigned char *this_result;
2001 int flag;
2002
2003 this_result = refs_found ? sha1_from_ref : sha1;
2004 mksnpath(fullref, sizeof(fullref), *p, len, str);
8cad4744 2005 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
ff74f7f1
JH
2006 if (r) {
2007 if (!refs_found++)
2008 *ref = xstrdup(r);
2009 if (!warn_ambiguous_refs)
2010 break;
55956350 2011 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
ff74f7f1 2012 warning("ignoring dangling symref %s.", fullref);
55956350
JH
2013 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
2014 warning("ignoring broken ref %s.", fullref);
2015 }
ff74f7f1
JH
2016 }
2017 free(last_branch);
2018 return refs_found;
2019}
2020
2021int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
2022{
2023 char *last_branch = substitute_branch_name(&str, &len);
2024 const char **p;
2025 int logs_found = 0;
2026
2027 *log = NULL;
2028 for (p = ref_rev_parse_rules; *p; p++) {
ff74f7f1
JH
2029 unsigned char hash[20];
2030 char path[PATH_MAX];
2031 const char *ref, *it;
2032
2033 mksnpath(path, sizeof(path), *p, len, str);
8cad4744 2034 ref = resolve_ref_unsafe(path, hash, 1, NULL);
ff74f7f1
JH
2035 if (!ref)
2036 continue;
4da58835 2037 if (reflog_exists(path))
ff74f7f1 2038 it = path;
4da58835 2039 else if (strcmp(ref, path) && reflog_exists(ref))
ff74f7f1
JH
2040 it = ref;
2041 else
2042 continue;
2043 if (!logs_found++) {
2044 *log = xstrdup(it);
2045 hashcpy(sha1, hash);
2046 }
2047 if (!warn_ambiguous_refs)
2048 break;
2049 }
2050 free(last_branch);
2051 return logs_found;
2052}
2053
dfefa935
MH
2054static struct ref_lock *lock_ref_sha1_basic(const char *refname,
2055 const unsigned char *old_sha1,
2056 int flags, int *type_p)
4bd18c43 2057{
434cd0cd 2058 char *ref_file;
dfefa935 2059 const char *orig_refname = refname;
4bd18c43 2060 struct ref_lock *lock;
5cc3cef9 2061 int last_errno = 0;
acd3b9ec 2062 int type, lflags;
4431fcc4 2063 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
5bdd8d4a 2064 int missing = 0;
c4c61c76 2065 int attempts_remaining = 3;
4bd18c43
SP
2066
2067 lock = xcalloc(1, sizeof(struct ref_lock));
2068 lock->lock_fd = -1;
2069
8d68493f 2070 refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
dfefa935 2071 if (!refname && errno == EISDIR) {
bc7127ef
JH
2072 /* we are trying to lock foo but we used to
2073 * have foo/bar which now does not exist;
2074 * it is normal for the empty directory 'foo'
2075 * to remain.
2076 */
dfefa935 2077 ref_file = git_path("%s", orig_refname);
5cc3cef9
JH
2078 if (remove_empty_directories(ref_file)) {
2079 last_errno = errno;
dfefa935 2080 error("there are still refs under '%s'", orig_refname);
5cc3cef9
JH
2081 goto error_return;
2082 }
8d68493f 2083 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
bc7127ef 2084 }
68db31cc
SV
2085 if (type_p)
2086 *type_p = type;
dfefa935 2087 if (!refname) {
5cc3cef9 2088 last_errno = errno;
818f477c 2089 error("unable to resolve reference %s: %s",
dfefa935 2090 orig_refname, strerror(errno));
5cc3cef9 2091 goto error_return;
4bd18c43 2092 }
5bdd8d4a 2093 missing = is_null_sha1(lock->old_sha1);
c976d415
LH
2094 /* When the ref did not exist and we are creating it,
2095 * make sure there is no existing ref that is packed
2096 * whose name begins with our refname, nor a ref whose
2097 * name is a proper prefix of our refname.
2098 */
5bdd8d4a 2099 if (missing &&
9da31cb0 2100 !is_refname_available(refname, NULL, get_packed_refs(&ref_cache))) {
f475e08e 2101 last_errno = ENOTDIR;
c976d415 2102 goto error_return;
f475e08e 2103 }
22a3844e 2104
c33d5174 2105 lock->lk = xcalloc(1, sizeof(struct lock_file));
4bd18c43 2106
e5c223e9 2107 lflags = 0;
acd3b9ec 2108 if (flags & REF_NODEREF) {
dfefa935 2109 refname = orig_refname;
acd3b9ec
JH
2110 lflags |= LOCK_NODEREF;
2111 }
dfefa935
MH
2112 lock->ref_name = xstrdup(refname);
2113 lock->orig_ref_name = xstrdup(orig_refname);
2114 ref_file = git_path("%s", refname);
5bdd8d4a 2115 if (missing)
68db31cc
SV
2116 lock->force_write = 1;
2117 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
2118 lock->force_write = 1;
4bd18c43 2119
c4c61c76
MH
2120 retry:
2121 switch (safe_create_leading_directories(ref_file)) {
2122 case SCLD_OK:
2123 break; /* success */
2124 case SCLD_VANISHED:
2125 if (--attempts_remaining > 0)
2126 goto retry;
2127 /* fall through */
2128 default:
5cc3cef9
JH
2129 last_errno = errno;
2130 error("unable to create directory for %s", ref_file);
2131 goto error_return;
2132 }
4bd18c43 2133
acd3b9ec 2134 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
e5c223e9
MH
2135 if (lock->lock_fd < 0) {
2136 if (errno == ENOENT && --attempts_remaining > 0)
2137 /*
2138 * Maybe somebody just deleted one of the
2139 * directories leading to ref_file. Try
2140 * again:
2141 */
2142 goto retry;
2143 else
2144 unable_to_lock_index_die(ref_file, errno);
2145 }
4bd18c43 2146 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
5cc3cef9
JH
2147
2148 error_return:
2149 unlock_ref(lock);
2150 errno = last_errno;
2151 return NULL;
4bd18c43
SP
2152}
2153
dfefa935 2154struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
95fc7512 2155{
53cce84c 2156 char refpath[PATH_MAX];
dfefa935 2157 if (check_refname_format(refname, 0))
4bd18c43 2158 return NULL;
dfefa935 2159 strcpy(refpath, mkpath("refs/%s", refname));
68db31cc 2160 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
4bd18c43
SP
2161}
2162
dfefa935 2163struct ref_lock *lock_any_ref_for_update(const char *refname,
9bbb0fa1
BK
2164 const unsigned char *old_sha1,
2165 int flags, int *type_p)
4bd18c43 2166{
dfefa935 2167 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
257f3020 2168 return NULL;
9bbb0fa1 2169 return lock_ref_sha1_basic(refname, old_sha1, flags, type_p);
c0277d15
JH
2170}
2171
fec3137f
MH
2172/*
2173 * Write an entry to the packed-refs file for the specified refname.
2174 * If peeled is non-NULL, write it as the entry's peeled value.
2175 */
2176static void write_packed_entry(int fd, char *refname, unsigned char *sha1,
2177 unsigned char *peeled)
d66da478 2178{
d66da478
MH
2179 char line[PATH_MAX + 100];
2180 int len;
2181
d66da478
MH
2182 len = snprintf(line, sizeof(line), "%s %s\n",
2183 sha1_to_hex(sha1), refname);
2184 /* this should not happen but just being defensive */
2185 if (len > sizeof(line))
2186 die("too long a refname '%s'", refname);
fec3137f
MH
2187 write_or_die(fd, line, len);
2188
2189 if (peeled) {
2190 if (snprintf(line, sizeof(line), "^%s\n",
2191 sha1_to_hex(peeled)) != PEELED_LINE_LENGTH)
2192 die("internal error");
2193 write_or_die(fd, line, PEELED_LINE_LENGTH);
2194 }
2195}
2196
7b40d396
MH
2197/*
2198 * An each_ref_entry_fn that writes the entry to a packed-refs file.
2199 */
2200static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
2201{
2202 int *fd = cb_data;
2203 enum peel_status peel_status = peel_entry(entry, 0);
2204
2205 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2206 error("internal error: %s is not a valid packed reference!",
2207 entry->name);
2208 write_packed_entry(*fd, entry->name, entry->u.value.sha1,
2209 peel_status == PEEL_PEELED ?
2210 entry->u.value.peeled : NULL);
2211 return 0;
2212}
2213
9f69d297
MH
2214int lock_packed_refs(int flags)
2215{
2216 struct packed_ref_cache *packed_ref_cache;
2217
9f69d297
MH
2218 if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)
2219 return -1;
5d478f5c
MH
2220 /*
2221 * Get the current packed-refs while holding the lock. If the
2222 * packed-refs file has been modified since we last read it,
2223 * this will automatically invalidate the cache and re-read
2224 * the packed-refs file.
2225 */
9f69d297
MH
2226 packed_ref_cache = get_packed_ref_cache(&ref_cache);
2227 packed_ref_cache->lock = &packlock;
4f6b83e3
MH
2228 /* Increment the reference count to prevent it from being freed: */
2229 acquire_packed_ref_cache(packed_ref_cache);
9f69d297
MH
2230 return 0;
2231}
2232
2233int commit_packed_refs(void)
2234{
2235 struct packed_ref_cache *packed_ref_cache =
2236 get_packed_ref_cache(&ref_cache);
2237 int error = 0;
2238
2239 if (!packed_ref_cache->lock)
2240 die("internal error: packed-refs not locked");
2241 write_or_die(packed_ref_cache->lock->fd,
2242 PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
2243
2244 do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2245 0, write_packed_entry_fn,
2246 &packed_ref_cache->lock->fd);
2247 if (commit_lock_file(packed_ref_cache->lock))
2248 error = -1;
2249 packed_ref_cache->lock = NULL;
4f6b83e3 2250 release_packed_ref_cache(packed_ref_cache);
9f69d297
MH
2251 return error;
2252}
2253
2254void rollback_packed_refs(void)
2255{
2256 struct packed_ref_cache *packed_ref_cache =
2257 get_packed_ref_cache(&ref_cache);
2258
2259 if (!packed_ref_cache->lock)
2260 die("internal error: packed-refs not locked");
2261 rollback_lock_file(packed_ref_cache->lock);
2262 packed_ref_cache->lock = NULL;
4f6b83e3 2263 release_packed_ref_cache(packed_ref_cache);
9f69d297
MH
2264 clear_packed_ref_cache(&ref_cache);
2265}
2266
32d462ce
MH
2267struct ref_to_prune {
2268 struct ref_to_prune *next;
2269 unsigned char sha1[20];
2270 char name[FLEX_ARRAY];
2271};
2272
2273struct pack_refs_cb_data {
2274 unsigned int flags;
267f9a8c 2275 struct ref_dir *packed_refs;
32d462ce 2276 struct ref_to_prune *ref_to_prune;
32d462ce
MH
2277};
2278
267f9a8c
MH
2279/*
2280 * An each_ref_entry_fn that is run over loose references only. If
2281 * the loose reference can be packed, add an entry in the packed ref
2282 * cache. If the reference should be pruned, also add it to
2283 * ref_to_prune in the pack_refs_cb_data.
2284 */
2285static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
32d462ce
MH
2286{
2287 struct pack_refs_cb_data *cb = cb_data;
f85354b5 2288 enum peel_status peel_status;
267f9a8c 2289 struct ref_entry *packed_entry;
59556548 2290 int is_tag_ref = starts_with(entry->name, "refs/tags/");
32d462ce 2291
267f9a8c
MH
2292 /* ALWAYS pack tags */
2293 if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
32d462ce
MH
2294 return 0;
2295
b2a8226d
MH
2296 /* Do not pack symbolic or broken refs: */
2297 if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
2298 return 0;
2299
267f9a8c 2300 /* Add a packed ref cache entry equivalent to the loose entry. */
f85354b5 2301 peel_status = peel_entry(entry, 1);
0f29920f 2302 if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
f85354b5
MH
2303 die("internal error peeling reference %s (%s)",
2304 entry->name, sha1_to_hex(entry->u.value.sha1));
267f9a8c
MH
2305 packed_entry = find_ref(cb->packed_refs, entry->name);
2306 if (packed_entry) {
2307 /* Overwrite existing packed entry with info from loose entry */
2308 packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
2309 hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
2310 } else {
2311 packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
2312 REF_ISPACKED | REF_KNOWS_PEELED, 0);
2313 add_ref(cb->packed_refs, packed_entry);
2314 }
2315 hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
32d462ce 2316
267f9a8c
MH
2317 /* Schedule the loose reference for pruning if requested. */
2318 if ((cb->flags & PACK_REFS_PRUNE)) {
12e77559 2319 int namelen = strlen(entry->name) + 1;
32d462ce 2320 struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
12e77559
MH
2321 hashcpy(n->sha1, entry->u.value.sha1);
2322 strcpy(n->name, entry->name);
32d462ce
MH
2323 n->next = cb->ref_to_prune;
2324 cb->ref_to_prune = n;
2325 }
d66da478
MH
2326 return 0;
2327}
2328
32d462ce
MH
2329/*
2330 * Remove empty parents, but spare refs/ and immediate subdirs.
2331 * Note: munges *name.
2332 */
2333static void try_remove_empty_parents(char *name)
2334{
2335 char *p, *q;
2336 int i;
2337 p = name;
2338 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
2339 while (*p && *p != '/')
2340 p++;
2341 /* tolerate duplicate slashes; see check_refname_format() */
2342 while (*p == '/')
2343 p++;
2344 }
2345 for (q = p; *q; q++)
2346 ;
2347 while (1) {
2348 while (q > p && *q != '/')
2349 q--;
2350 while (q > p && *(q-1) == '/')
2351 q--;
2352 if (q == p)
2353 break;
2354 *q = '\0';
2355 if (rmdir(git_path("%s", name)))
2356 break;
2357 }
2358}
2359
2360/* make sure nobody touched the ref, and unlink */
2361static void prune_ref(struct ref_to_prune *r)
2362{
2363 struct ref_lock *lock = lock_ref_sha1(r->name + 5, r->sha1);
2364
2365 if (lock) {
2366 unlink_or_warn(git_path("%s", r->name));
2367 unlock_ref(lock);
2368 try_remove_empty_parents(r->name);
2369 }
2370}
2371
2372static void prune_refs(struct ref_to_prune *r)
2373{
2374 while (r) {
2375 prune_ref(r);
2376 r = r->next;
2377 }
2378}
2379
32d462ce
MH
2380int pack_refs(unsigned int flags)
2381{
32d462ce
MH
2382 struct pack_refs_cb_data cbdata;
2383
2384 memset(&cbdata, 0, sizeof(cbdata));
2385 cbdata.flags = flags;
2386
9f69d297 2387 lock_packed_refs(LOCK_DIE_ON_ERROR);
267f9a8c 2388 cbdata.packed_refs = get_packed_refs(&ref_cache);
32d462ce 2389
267f9a8c
MH
2390 do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
2391 pack_if_possible_fn, &cbdata);
32d462ce 2392
9f69d297 2393 if (commit_packed_refs())
32d462ce 2394 die_errno("unable to overwrite old ref-pack file");
9f69d297 2395
32d462ce
MH
2396 prune_refs(cbdata.ref_to_prune);
2397 return 0;
2398}
2399
7b40d396
MH
2400/*
2401 * If entry is no longer needed in packed-refs, add it to the string
2402 * list pointed to by cb_data. Reasons for deleting entries:
2403 *
2404 * - Entry is broken.
2405 * - Entry is overridden by a loose ref.
2406 * - Entry does not point at a valid object.
2407 *
2408 * In the first and third cases, also emit an error message because these
2409 * are indications of repository corruption.
2410 */
2411static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
c0277d15 2412{
7b40d396 2413 struct string_list *refs_to_delete = cb_data;
fec3137f 2414
ab292bc4
MH
2415 if (entry->flag & REF_ISBROKEN) {
2416 /* This shouldn't happen to packed refs. */
2417 error("%s is broken!", entry->name);
7b40d396 2418 string_list_append(refs_to_delete, entry->name);
c0277d15 2419 return 0;
ab292bc4
MH
2420 }
2421 if (!has_sha1_file(entry->u.value.sha1)) {
2422 unsigned char sha1[20];
2423 int flags;
2424
2425 if (read_ref_full(entry->name, sha1, 0, &flags))
2426 /* We should at least have found the packed ref. */
2427 die("Internal error");
7b40d396 2428 if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
ab292bc4
MH
2429 /*
2430 * This packed reference is overridden by a
2431 * loose reference, so it is OK that its value
2432 * is no longer valid; for example, it might
2433 * refer to an object that has been garbage
2434 * collected. For this purpose we don't even
2435 * care whether the loose reference itself is
2436 * invalid, broken, symbolic, etc. Silently
7b40d396 2437 * remove the packed reference.
ab292bc4 2438 */
7b40d396 2439 string_list_append(refs_to_delete, entry->name);
ab292bc4 2440 return 0;
7b40d396 2441 }
ab292bc4
MH
2442 /*
2443 * There is no overriding loose reference, so the fact
2444 * that this reference doesn't refer to a valid object
2445 * indicates some kind of repository corruption.
2446 * Report the problem, then omit the reference from
2447 * the output.
2448 */
2449 error("%s does not point to a valid object!", entry->name);
7b40d396 2450 string_list_append(refs_to_delete, entry->name);
ab292bc4
MH
2451 return 0;
2452 }
2453
d66da478
MH
2454 return 0;
2455}
2456
c9e768bb 2457int repack_without_refs(const char **refnames, int n)
c0277d15 2458{
7618fd80 2459 struct ref_dir *packed;
7b40d396
MH
2460 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
2461 struct string_list_item *ref_to_delete;
61cee0db
BK
2462 int i, removed = 0;
2463
2464 /* Look for a packed ref */
2465 for (i = 0; i < n; i++)
2466 if (get_packed_ref(refnames[i]))
2467 break;
7618fd80 2468
61cee0db
BK
2469 /* Avoid locking if we have nothing to do */
2470 if (i == n)
2471 return 0; /* no refname exists in packed refs */
7618fd80 2472
9f69d297 2473 if (lock_packed_refs(0)) {
1b018fd9 2474 unable_to_lock_error(git_path("packed-refs"), errno);
61cee0db 2475 return error("cannot delete '%s' from packed refs", refnames[i]);
1b018fd9 2476 }
9da31cb0 2477 packed = get_packed_refs(&ref_cache);
7b40d396 2478
61cee0db
BK
2479 /* Remove refnames from the cache */
2480 for (i = 0; i < n; i++)
2481 if (remove_entry(packed, refnames[i]) != -1)
2482 removed = 1;
2483 if (!removed) {
506a760d 2484 /*
61cee0db 2485 * All packed entries disappeared while we were
506a760d
MH
2486 * acquiring the lock.
2487 */
9f69d297 2488 rollback_packed_refs();
506a760d
MH
2489 return 0;
2490 }
7b40d396 2491
61cee0db 2492 /* Remove any other accumulated cruft */
7b40d396
MH
2493 do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
2494 for_each_string_list_item(ref_to_delete, &refs_to_delete) {
2495 if (remove_entry(packed, ref_to_delete->string) == -1)
2496 die("internal error");
2497 }
2498
61cee0db 2499 /* Write what remains */
9f69d297 2500 return commit_packed_refs();
c0277d15
JH
2501}
2502
61cee0db 2503static int repack_without_ref(const char *refname)
c0277d15 2504{
61cee0db
BK
2505 return repack_without_refs(&refname, 1);
2506}
c0277d15 2507
2ddb5d17
BK
2508static int delete_ref_loose(struct ref_lock *lock, int flag)
2509{
045a476f 2510 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
c0277d15 2511 /* loose */
2ddb5d17
BK
2512 int err, i = strlen(lock->lk->filename) - 5; /* .lock */
2513
547d058f
RS
2514 lock->lk->filename[i] = 0;
2515 err = unlink_or_warn(lock->lk->filename);
547d058f 2516 lock->lk->filename[i] = '.';
2ddb5d17
BK
2517 if (err && errno != ENOENT)
2518 return 1;
c0277d15 2519 }
2ddb5d17
BK
2520 return 0;
2521}
2522
eca35a25 2523int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
c0277d15
JH
2524{
2525 struct ref_lock *lock;
2ddb5d17 2526 int ret = 0, flag = 0;
c0277d15 2527
547d058f 2528 lock = lock_ref_sha1_basic(refname, sha1, delopt, &flag);
c0277d15
JH
2529 if (!lock)
2530 return 1;
2ddb5d17 2531 ret |= delete_ref_loose(lock, flag);
691f1a28 2532
c0277d15
JH
2533 /* removing the loose one could have resurrected an earlier
2534 * packed one. Also, if it was not loose we need to repack
2535 * without it.
2536 */
b274a714 2537 ret |= repack_without_ref(lock->ref_name);
c0277d15 2538
691f1a28 2539 unlink_or_warn(git_path("logs/%s", lock->ref_name));
9da31cb0 2540 clear_loose_ref_cache(&ref_cache);
c0277d15
JH
2541 unlock_ref(lock);
2542 return ret;
4bd18c43
SP
2543}
2544
765c2258
PH
2545/*
2546 * People using contrib's git-new-workdir have .git/logs/refs ->
2547 * /some/other/path/.git/logs/refs, and that may live on another device.
2548 *
2549 * IOW, to avoid cross device rename errors, the temporary renamed log must
2550 * live into logs/refs.
2551 */
2552#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
2553
fa59ae79
MH
2554static int rename_tmp_log(const char *newrefname)
2555{
f1e9e9a4 2556 int attempts_remaining = 4;
ae4a283e
MH
2557
2558 retry:
08f555cb
MH
2559 switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {
2560 case SCLD_OK:
2561 break; /* success */
2562 case SCLD_VANISHED:
2563 if (--attempts_remaining > 0)
2564 goto retry;
2565 /* fall through */
2566 default:
fa59ae79
MH
2567 error("unable to create directory for %s", newrefname);
2568 return -1;
2569 }
2570
fa59ae79 2571 if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
f1e9e9a4 2572 if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
fa59ae79
MH
2573 /*
2574 * rename(a, b) when b is an existing
2575 * directory ought to result in ISDIR, but
2576 * Solaris 5.8 gives ENOTDIR. Sheesh.
2577 */
2578 if (remove_empty_directories(git_path("logs/%s", newrefname))) {
2579 error("Directory not empty: logs/%s", newrefname);
2580 return -1;
2581 }
2582 goto retry;
ae4a283e
MH
2583 } else if (errno == ENOENT && --attempts_remaining > 0) {
2584 /*
2585 * Maybe another process just deleted one of
2586 * the directories in the path to newrefname.
2587 * Try again from the beginning.
2588 */
2589 goto retry;
fa59ae79
MH
2590 } else {
2591 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2592 newrefname, strerror(errno));
2593 return -1;
2594 }
2595 }
2596 return 0;
2597}
2598
dfefa935 2599int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
c976d415 2600{
c976d415
LH
2601 unsigned char sha1[20], orig_sha1[20];
2602 int flag = 0, logmoved = 0;
2603 struct ref_lock *lock;
c976d415 2604 struct stat loginfo;
dfefa935 2605 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
eca35a25 2606 const char *symref = NULL;
c976d415 2607
450d4c0f 2608 if (log && S_ISLNK(loginfo.st_mode))
dfefa935 2609 return error("reflog for %s is a symlink", oldrefname);
c976d415 2610
8d68493f 2611 symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
eca35a25 2612 if (flag & REF_ISSYMREF)
fa58186c 2613 return error("refname %s is a symbolic ref, renaming it is not supported",
dfefa935 2614 oldrefname);
eca35a25 2615 if (!symref)
dfefa935 2616 return error("refname %s not found", oldrefname);
c976d415 2617
9da31cb0 2618 if (!is_refname_available(newrefname, oldrefname, get_packed_refs(&ref_cache)))
c976d415
LH
2619 return 1;
2620
9da31cb0 2621 if (!is_refname_available(newrefname, oldrefname, get_loose_refs(&ref_cache)))
c976d415
LH
2622 return 1;
2623
dfefa935 2624 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
765c2258 2625 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
dfefa935 2626 oldrefname, strerror(errno));
c976d415 2627
dfefa935
MH
2628 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
2629 error("unable to delete old %s", oldrefname);
c976d415
LH
2630 goto rollback;
2631 }
2632
dfefa935
MH
2633 if (!read_ref_full(newrefname, sha1, 1, &flag) &&
2634 delete_ref(newrefname, sha1, REF_NODEREF)) {
c976d415 2635 if (errno==EISDIR) {
dfefa935
MH
2636 if (remove_empty_directories(git_path("%s", newrefname))) {
2637 error("Directory not empty: %s", newrefname);
c976d415
LH
2638 goto rollback;
2639 }
2640 } else {
dfefa935 2641 error("unable to delete existing %s", newrefname);
c976d415
LH
2642 goto rollback;
2643 }
2644 }
2645
fa59ae79 2646 if (log && rename_tmp_log(newrefname))
c976d415 2647 goto rollback;
c976d415 2648
c976d415
LH
2649 logmoved = log;
2650
dfefa935 2651 lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
c976d415 2652 if (!lock) {
dfefa935 2653 error("unable to lock %s for update", newrefname);
c976d415
LH
2654 goto rollback;
2655 }
c976d415
LH
2656 lock->force_write = 1;
2657 hashcpy(lock->old_sha1, orig_sha1);
678d0f4c 2658 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
dfefa935 2659 error("unable to write current sha1 into %s", newrefname);
c976d415
LH
2660 goto rollback;
2661 }
2662
2663 return 0;
2664
2665 rollback:
dfefa935 2666 lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
c976d415 2667 if (!lock) {
dfefa935 2668 error("unable to lock %s for rollback", oldrefname);
c976d415
LH
2669 goto rollbacklog;
2670 }
2671
2672 lock->force_write = 1;
2673 flag = log_all_ref_updates;
2674 log_all_ref_updates = 0;
2675 if (write_ref_sha1(lock, orig_sha1, NULL))
dfefa935 2676 error("unable to write current sha1 into %s", oldrefname);
c976d415
LH
2677 log_all_ref_updates = flag;
2678
2679 rollbacklog:
dfefa935 2680 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
c976d415 2681 error("unable to restore logfile %s from %s: %s",
dfefa935 2682 oldrefname, newrefname, strerror(errno));
c976d415 2683 if (!logmoved && log &&
dfefa935 2684 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
765c2258 2685 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
dfefa935 2686 oldrefname, strerror(errno));
c976d415
LH
2687
2688 return 1;
2689}
2690
435fc852 2691int close_ref(struct ref_lock *lock)
b531394d
BC
2692{
2693 if (close_lock_file(lock->lk))
2694 return -1;
2695 lock->lock_fd = -1;
2696 return 0;
2697}
2698
435fc852 2699int commit_ref(struct ref_lock *lock)
b531394d
BC
2700{
2701 if (commit_lock_file(lock->lk))
2702 return -1;
2703 lock->lock_fd = -1;
2704 return 0;
2705}
2706
e5f38ec3 2707void unlock_ref(struct ref_lock *lock)
4bd18c43 2708{
4ed7cd3a
BC
2709 /* Do not free lock->lk -- atexit() still looks at them */
2710 if (lock->lk)
2711 rollback_lock_file(lock->lk);
434cd0cd 2712 free(lock->ref_name);
1655707c 2713 free(lock->orig_ref_name);
4bd18c43
SP
2714 free(lock);
2715}
2716
0ec29a47
JH
2717/*
2718 * copy the reflog message msg to buf, which has been allocated sufficiently
2719 * large, while cleaning up the whitespaces. Especially, convert LF to space,
2720 * because reflog file is one line per entry.
2721 */
2722static int copy_msg(char *buf, const char *msg)
2723{
2724 char *cp = buf;
2725 char c;
2726 int wasspace = 1;
2727
2728 *cp++ = '\t';
2729 while ((c = *msg++)) {
2730 if (wasspace && isspace(c))
2731 continue;
2732 wasspace = isspace(c);
2733 if (wasspace)
2734 c = ' ';
2735 *cp++ = c;
2736 }
2737 while (buf < cp && isspace(cp[-1]))
2738 cp--;
2739 *cp++ = '\n';
2740 return cp - buf;
2741}
2742
dfefa935 2743int log_ref_setup(const char *refname, char *logfile, int bufsize)
6de08ae6 2744{
859c3017 2745 int logfd, oflags = O_APPEND | O_WRONLY;
9a13f0b7 2746
dfefa935 2747 git_snpath(logfile, bufsize, "logs/%s", refname);
4057deb5 2748 if (log_all_ref_updates &&
59556548
CC
2749 (starts_with(refname, "refs/heads/") ||
2750 starts_with(refname, "refs/remotes/") ||
2751 starts_with(refname, "refs/notes/") ||
dfefa935 2752 !strcmp(refname, "HEAD"))) {
157aaea5 2753 if (safe_create_leading_directories(logfile) < 0)
6de08ae6 2754 return error("unable to create directory for %s",
157aaea5 2755 logfile);
6de08ae6
SP
2756 oflags |= O_CREAT;
2757 }
2758
157aaea5 2759 logfd = open(logfile, oflags, 0666);
6de08ae6 2760 if (logfd < 0) {
1974bf62 2761 if (!(oflags & O_CREAT) && errno == ENOENT)
6de08ae6 2762 return 0;
3b463c3f
JH
2763
2764 if ((oflags & O_CREAT) && errno == EISDIR) {
157aaea5 2765 if (remove_empty_directories(logfile)) {
3b463c3f 2766 return error("There are still logs under '%s'",
157aaea5 2767 logfile);
3b463c3f 2768 }
157aaea5 2769 logfd = open(logfile, oflags, 0666);
3b463c3f
JH
2770 }
2771
2772 if (logfd < 0)
2773 return error("Unable to append to %s: %s",
157aaea5 2774 logfile, strerror(errno));
6de08ae6
SP
2775 }
2776
157aaea5 2777 adjust_shared_perm(logfile);
859c3017
EM
2778 close(logfd);
2779 return 0;
2780}
443b92b6 2781
dfefa935 2782static int log_ref_write(const char *refname, const unsigned char *old_sha1,
859c3017
EM
2783 const unsigned char *new_sha1, const char *msg)
2784{
2785 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
2786 unsigned maxlen, len;
2787 int msglen;
157aaea5 2788 char log_file[PATH_MAX];
859c3017
EM
2789 char *logrec;
2790 const char *committer;
2791
2792 if (log_all_ref_updates < 0)
2793 log_all_ref_updates = !is_bare_repository();
2794
dfefa935 2795 result = log_ref_setup(refname, log_file, sizeof(log_file));
859c3017
EM
2796 if (result)
2797 return result;
2798
2799 logfd = open(log_file, oflags);
2800 if (logfd < 0)
2801 return 0;
0ec29a47 2802 msglen = msg ? strlen(msg) : 0;
774751a8 2803 committer = git_committer_info(0);
8ac65937
JH
2804 maxlen = strlen(committer) + msglen + 100;
2805 logrec = xmalloc(maxlen);
2806 len = sprintf(logrec, "%s %s %s\n",
9a13f0b7
NP
2807 sha1_to_hex(old_sha1),
2808 sha1_to_hex(new_sha1),
8ac65937
JH
2809 committer);
2810 if (msglen)
0ec29a47 2811 len += copy_msg(logrec + len - 1, msg) - 1;
93822c22 2812 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
6de08ae6 2813 free(logrec);
91c8d590 2814 if (close(logfd) != 0 || written != len)
9a13f0b7 2815 return error("Unable to append to %s", log_file);
6de08ae6
SP
2816 return 0;
2817}
2818
c3b0dec5
LT
2819static int is_branch(const char *refname)
2820{
59556548 2821 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
c3b0dec5
LT
2822}
2823
4bd18c43
SP
2824int write_ref_sha1(struct ref_lock *lock,
2825 const unsigned char *sha1, const char *logmsg)
2826{
2827 static char term = '\n';
c3b0dec5 2828 struct object *o;
4bd18c43
SP
2829
2830 if (!lock)
95fc7512 2831 return -1;
a89fccd2 2832 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
4bd18c43
SP
2833 unlock_ref(lock);
2834 return 0;
95fc7512 2835 }
c3b0dec5
LT
2836 o = parse_object(sha1);
2837 if (!o) {
7be8b3ba 2838 error("Trying to write ref %s with nonexistent object %s",
c3b0dec5
LT
2839 lock->ref_name, sha1_to_hex(sha1));
2840 unlock_ref(lock);
2841 return -1;
2842 }
2843 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2844 error("Trying to write non-commit object %s to branch %s",
2845 sha1_to_hex(sha1), lock->ref_name);
2846 unlock_ref(lock);
2847 return -1;
2848 }
93822c22
AW
2849 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2850 write_in_full(lock->lock_fd, &term, 1) != 1
b531394d 2851 || close_ref(lock) < 0) {
c33d5174 2852 error("Couldn't write %s", lock->lk->filename);
4bd18c43
SP
2853 unlock_ref(lock);
2854 return -1;
2855 }
9da31cb0 2856 clear_loose_ref_cache(&ref_cache);
bd104db1
NP
2857 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2858 (strcmp(lock->ref_name, lock->orig_ref_name) &&
2859 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
6de08ae6
SP
2860 unlock_ref(lock);
2861 return -1;
2862 }
605fac8b
NP
2863 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2864 /*
2865 * Special hack: If a branch is updated directly and HEAD
2866 * points to it (may happen on the remote side of a push
2867 * for example) then logically the HEAD reflog should be
2868 * updated too.
2869 * A generic solution implies reverse symref information,
2870 * but finding all symrefs pointing to the given branch
2871 * would be rather costly for this rare event (the direct
2872 * update of a branch) to be worth it. So let's cheat and
2873 * check with HEAD only which should cover 99% of all usage
2874 * scenarios (even 100% of the default ones).
2875 */
2876 unsigned char head_sha1[20];
2877 int head_flag;
2878 const char *head_ref;
8cad4744 2879 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
605fac8b
NP
2880 if (head_ref && (head_flag & REF_ISSYMREF) &&
2881 !strcmp(head_ref, lock->ref_name))
2882 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2883 }
b531394d 2884 if (commit_ref(lock)) {
434cd0cd 2885 error("Couldn't set %s", lock->ref_name);
4bd18c43
SP
2886 unlock_ref(lock);
2887 return -1;
2888 }
4bd18c43
SP
2889 unlock_ref(lock);
2890 return 0;
95fc7512 2891}
d556fae2 2892
8b5157e4
NP
2893int create_symref(const char *ref_target, const char *refs_heads_master,
2894 const char *logmsg)
41b625b0
NP
2895{
2896 const char *lockpath;
2897 char ref[1000];
2898 int fd, len, written;
a4f34cbb 2899 char *git_HEAD = git_pathdup("%s", ref_target);
8b5157e4
NP
2900 unsigned char old_sha1[20], new_sha1[20];
2901
2902 if (logmsg && read_ref(ref_target, old_sha1))
2903 hashclr(old_sha1);
41b625b0 2904
d48744d1
JH
2905 if (safe_create_leading_directories(git_HEAD) < 0)
2906 return error("unable to create directory for %s", git_HEAD);
2907
41b625b0
NP
2908#ifndef NO_SYMLINK_HEAD
2909 if (prefer_symlink_refs) {
2910 unlink(git_HEAD);
2911 if (!symlink(refs_heads_master, git_HEAD))
8b5157e4 2912 goto done;
41b625b0
NP
2913 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2914 }
2915#endif
2916
2917 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2918 if (sizeof(ref) <= len) {
2919 error("refname too long: %s", refs_heads_master);
47fc52e2 2920 goto error_free_return;
41b625b0
NP
2921 }
2922 lockpath = mkpath("%s.lock", git_HEAD);
2923 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2924 if (fd < 0) {
2925 error("Unable to open %s for writing", lockpath);
47fc52e2 2926 goto error_free_return;
41b625b0
NP
2927 }
2928 written = write_in_full(fd, ref, len);
91c8d590 2929 if (close(fd) != 0 || written != len) {
41b625b0 2930 error("Unable to write to %s", lockpath);
47fc52e2 2931 goto error_unlink_return;
41b625b0
NP
2932 }
2933 if (rename(lockpath, git_HEAD) < 0) {
41b625b0 2934 error("Unable to create %s", git_HEAD);
47fc52e2 2935 goto error_unlink_return;
41b625b0
NP
2936 }
2937 if (adjust_shared_perm(git_HEAD)) {
41b625b0 2938 error("Unable to fix permissions on %s", lockpath);
47fc52e2 2939 error_unlink_return:
691f1a28 2940 unlink_or_warn(lockpath);
47fc52e2
JH
2941 error_free_return:
2942 free(git_HEAD);
2943 return -1;
41b625b0 2944 }
8b5157e4 2945
ee96d11b 2946#ifndef NO_SYMLINK_HEAD
8b5157e4 2947 done:
ee96d11b 2948#endif
8b5157e4
NP
2949 if (logmsg && !read_ref(refs_heads_master, new_sha1))
2950 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2951
47fc52e2 2952 free(git_HEAD);
41b625b0
NP
2953 return 0;
2954}
2955
4207ed28
RS
2956struct read_ref_at_cb {
2957 const char *refname;
2958 unsigned long at_time;
2959 int cnt;
2960 int reccnt;
2961 unsigned char *sha1;
2962 int found_it;
2963
2964 unsigned char osha1[20];
2965 unsigned char nsha1[20];
2966 int tz;
2967 unsigned long date;
2968 char **msg;
2969 unsigned long *cutoff_time;
2970 int *cutoff_tz;
2971 int *cutoff_cnt;
2972};
2973
2974static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,
2975 const char *email, unsigned long timestamp, int tz,
2976 const char *message, void *cb_data)
2977{
2978 struct read_ref_at_cb *cb = cb_data;
2979
2980 cb->reccnt++;
2981 cb->tz = tz;
2982 cb->date = timestamp;
2983
2984 if (timestamp <= cb->at_time || cb->cnt == 0) {
2985 if (cb->msg)
2986 *cb->msg = xstrdup(message);
2987 if (cb->cutoff_time)
2988 *cb->cutoff_time = timestamp;
2989 if (cb->cutoff_tz)
2990 *cb->cutoff_tz = tz;
2991 if (cb->cutoff_cnt)
2992 *cb->cutoff_cnt = cb->reccnt - 1;
2993 /*
2994 * we have not yet updated cb->[n|o]sha1 so they still
2995 * hold the values for the previous record.
2996 */
2997 if (!is_null_sha1(cb->osha1)) {
2998 hashcpy(cb->sha1, nsha1);
2999 if (hashcmp(cb->osha1, nsha1))
3000 warning("Log for ref %s has gap after %s.",
3001 cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));
3002 }
3003 else if (cb->date == cb->at_time)
3004 hashcpy(cb->sha1, nsha1);
3005 else if (hashcmp(nsha1, cb->sha1))
3006 warning("Log for ref %s unexpectedly ended on %s.",
3007 cb->refname, show_date(cb->date, cb->tz,
3008 DATE_RFC2822));
3009 hashcpy(cb->osha1, osha1);
3010 hashcpy(cb->nsha1, nsha1);
3011 cb->found_it = 1;
3012 return 1;
3013 }
3014 hashcpy(cb->osha1, osha1);
3015 hashcpy(cb->nsha1, nsha1);
3016 if (cb->cnt > 0)
3017 cb->cnt--;
3018 return 0;
3019}
3020
3021static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,
3022 const char *email, unsigned long timestamp,
3023 int tz, const char *message, void *cb_data)
3024{
3025 struct read_ref_at_cb *cb = cb_data;
3026
3027 if (cb->msg)
3028 *cb->msg = xstrdup(message);
3029 if (cb->cutoff_time)
3030 *cb->cutoff_time = timestamp;
3031 if (cb->cutoff_tz)
3032 *cb->cutoff_tz = tz;
3033 if (cb->cutoff_cnt)
3034 *cb->cutoff_cnt = cb->reccnt;
3035 hashcpy(cb->sha1, osha1);
3036 if (is_null_sha1(cb->sha1))
3037 hashcpy(cb->sha1, nsha1);
3038 /* We just want the first entry */
3039 return 1;
16d7cc90
JH
3040}
3041
dfefa935
MH
3042int read_ref_at(const char *refname, unsigned long at_time, int cnt,
3043 unsigned char *sha1, char **msg,
3044 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
d556fae2 3045{
4207ed28 3046 struct read_ref_at_cb cb;
d556fae2 3047
4207ed28
RS
3048 memset(&cb, 0, sizeof(cb));
3049 cb.refname = refname;
3050 cb.at_time = at_time;
3051 cb.cnt = cnt;
3052 cb.msg = msg;
3053 cb.cutoff_time = cutoff_time;
3054 cb.cutoff_tz = cutoff_tz;
3055 cb.cutoff_cnt = cutoff_cnt;
3056 cb.sha1 = sha1;
3057
3058 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
3059
3060 if (!cb.reccnt)
3061 die("Log for %s is empty.", refname);
3062 if (cb.found_it)
3063 return 0;
3064
3065 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
d556fae2 3066
16d7cc90 3067 return 1;
d556fae2 3068}
2ff81662 3069
4da58835
RS
3070int reflog_exists(const char *refname)
3071{
3072 struct stat st;
3073
3074 return !lstat(git_path("logs/%s", refname), &st) &&
3075 S_ISREG(st.st_mode);
3076}
3077
3078int delete_reflog(const char *refname)
3079{
3080 return remove_path(git_path("logs/%s", refname));
3081}
3082
9a7a183b
JH
3083static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
3084{
3085 unsigned char osha1[20], nsha1[20];
3086 char *email_end, *message;
3087 unsigned long timestamp;
3088 int tz;
3089
3090 /* old SP new SP name <email> SP time TAB msg LF */
3091 if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
3092 get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
3093 get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
3094 !(email_end = strchr(sb->buf + 82, '>')) ||
3095 email_end[1] != ' ' ||
3096 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
3097 !message || message[0] != ' ' ||
3098 (message[1] != '+' && message[1] != '-') ||
3099 !isdigit(message[2]) || !isdigit(message[3]) ||
3100 !isdigit(message[4]) || !isdigit(message[5]))
3101 return 0; /* corrupt? */
3102 email_end[1] = '\0';
3103 tz = strtol(message + 1, NULL, 10);
3104 if (message[6] != '\t')
3105 message += 6;
3106 else
3107 message += 7;
3108 return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
3109}
3110
98f85ff4
JH
3111static char *find_beginning_of_line(char *bob, char *scan)
3112{
3113 while (bob < scan && *(--scan) != '\n')
3114 ; /* keep scanning backwards */
3115 /*
3116 * Return either beginning of the buffer, or LF at the end of
3117 * the previous line.
3118 */
3119 return scan;
3120}
3121
3122int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2ff81662 3123{
8ca78803 3124 struct strbuf sb = STRBUF_INIT;
98f85ff4
JH
3125 FILE *logfp;
3126 long pos;
3127 int ret = 0, at_tail = 1;
2ff81662 3128
7ae07c1b 3129 logfp = fopen(git_path("logs/%s", refname), "r");
2ff81662 3130 if (!logfp)
883d60fa 3131 return -1;
101d15e0 3132
98f85ff4
JH
3133 /* Jump to the end */
3134 if (fseek(logfp, 0, SEEK_END) < 0)
3135 return error("cannot seek back reflog for %s: %s",
3136 refname, strerror(errno));
3137 pos = ftell(logfp);
3138 while (!ret && 0 < pos) {
3139 int cnt;
3140 size_t nread;
3141 char buf[BUFSIZ];
3142 char *endp, *scanp;
3143
3144 /* Fill next block from the end */
3145 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
3146 if (fseek(logfp, pos - cnt, SEEK_SET))
3147 return error("cannot seek back reflog for %s: %s",
3148 refname, strerror(errno));
3149 nread = fread(buf, cnt, 1, logfp);
e4ca819a 3150 if (nread != 1)
98f85ff4
JH
3151 return error("cannot read %d bytes from reflog for %s: %s",
3152 cnt, refname, strerror(errno));
3153 pos -= cnt;
3154
3155 scanp = endp = buf + cnt;
3156 if (at_tail && scanp[-1] == '\n')
3157 /* Looking at the final LF at the end of the file */
3158 scanp--;
3159 at_tail = 0;
3160
3161 while (buf < scanp) {
3162 /*
3163 * terminating LF of the previous line, or the beginning
3164 * of the buffer.
3165 */
3166 char *bp;
3167
3168 bp = find_beginning_of_line(buf, scanp);
3169
3170 if (*bp != '\n') {
3171 strbuf_splice(&sb, 0, 0, buf, endp - buf);
3172 if (pos)
3173 break; /* need to fill another block */
3174 scanp = buf - 1; /* leave loop */
3175 } else {
3176 /*
3177 * (bp + 1) thru endp is the beginning of the
3178 * current line we have in sb
3179 */
3180 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
3181 scanp = bp;
3182 endp = bp + 1;
3183 }
3184 ret = show_one_reflog_ent(&sb, fn, cb_data);
3185 strbuf_reset(&sb);
3186 if (ret)
3187 break;
9d33f7c2 3188 }
101d15e0 3189
2ff81662 3190 }
98f85ff4 3191 if (!ret && sb.len)
9a7a183b 3192 ret = show_one_reflog_ent(&sb, fn, cb_data);
98f85ff4 3193
2ff81662 3194 fclose(logfp);
8ca78803 3195 strbuf_release(&sb);
2266bf27 3196 return ret;
2ff81662 3197}
e29cb53a 3198
dfefa935 3199int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
101d15e0 3200{
98f85ff4
JH
3201 FILE *logfp;
3202 struct strbuf sb = STRBUF_INIT;
3203 int ret = 0;
3204
3205 logfp = fopen(git_path("logs/%s", refname), "r");
3206 if (!logfp)
3207 return -1;
101d15e0 3208
98f85ff4
JH
3209 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
3210 ret = show_one_reflog_ent(&sb, fn, cb_data);
3211 fclose(logfp);
3212 strbuf_release(&sb);
3213 return ret;
3214}
989c0e5d
MH
3215/*
3216 * Call fn for each reflog in the namespace indicated by name. name
3217 * must be empty or end with '/'. Name will be used as a scratch
3218 * space, but its contents will be restored before return.
3219 */
3220static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
eb8381c8 3221{
989c0e5d 3222 DIR *d = opendir(git_path("logs/%s", name->buf));
fcee5a14 3223 int retval = 0;
93c603fc 3224 struct dirent *de;
989c0e5d 3225 int oldlen = name->len;
eb8381c8 3226
93c603fc 3227 if (!d)
989c0e5d 3228 return name->len ? errno : 0;
eb8381c8 3229
93c603fc
MH
3230 while ((de = readdir(d)) != NULL) {
3231 struct stat st;
eb8381c8 3232
93c603fc
MH
3233 if (de->d_name[0] == '.')
3234 continue;
93c603fc
MH
3235 if (has_extension(de->d_name, ".lock"))
3236 continue;
989c0e5d
MH
3237 strbuf_addstr(name, de->d_name);
3238 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
3239 ; /* silently ignore */
93c603fc 3240 } else {
eb8381c8 3241 if (S_ISDIR(st.st_mode)) {
989c0e5d
MH
3242 strbuf_addch(name, '/');
3243 retval = do_for_each_reflog(name, fn, cb_data);
eb8381c8
NP
3244 } else {
3245 unsigned char sha1[20];
989c0e5d
MH
3246 if (read_ref_full(name->buf, sha1, 0, NULL))
3247 retval = error("bad ref for %s", name->buf);
eb8381c8 3248 else
989c0e5d 3249 retval = fn(name->buf, sha1, 0, cb_data);
eb8381c8
NP
3250 }
3251 if (retval)
3252 break;
3253 }
989c0e5d 3254 strbuf_setlen(name, oldlen);
eb8381c8 3255 }
93c603fc 3256 closedir(d);
eb8381c8
NP
3257 return retval;
3258}
3259
3260int for_each_reflog(each_ref_fn fn, void *cb_data)
3261{
989c0e5d
MH
3262 int retval;
3263 struct strbuf name;
3264 strbuf_init(&name, PATH_MAX);
3265 retval = do_for_each_reflog(&name, fn, cb_data);
3266 strbuf_release(&name);
3267 return retval;
eb8381c8 3268}
3d9f037c 3269
4738a333
BK
3270static struct ref_lock *update_ref_lock(const char *refname,
3271 const unsigned char *oldval,
3272 int flags, int *type_p,
3273 enum action_on_err onerr)
3d9f037c 3274{
4738a333
BK
3275 struct ref_lock *lock;
3276 lock = lock_any_ref_for_update(refname, oldval, flags, type_p);
3d9f037c
CR
3277 if (!lock) {
3278 const char *str = "Cannot lock the ref '%s'.";
3279 switch (onerr) {
f4124112
MH
3280 case UPDATE_REFS_MSG_ON_ERR: error(str, refname); break;
3281 case UPDATE_REFS_DIE_ON_ERR: die(str, refname); break;
3282 case UPDATE_REFS_QUIET_ON_ERR: break;
3d9f037c 3283 }
3d9f037c 3284 }
4738a333
BK
3285 return lock;
3286}
3287
3288static int update_ref_write(const char *action, const char *refname,
3289 const unsigned char *sha1, struct ref_lock *lock,
3290 enum action_on_err onerr)
3291{
3d9f037c
CR
3292 if (write_ref_sha1(lock, sha1, action) < 0) {
3293 const char *str = "Cannot update the ref '%s'.";
3294 switch (onerr) {
f4124112
MH
3295 case UPDATE_REFS_MSG_ON_ERR: error(str, refname); break;
3296 case UPDATE_REFS_DIE_ON_ERR: die(str, refname); break;
3297 case UPDATE_REFS_QUIET_ON_ERR: break;
3d9f037c
CR
3298 }
3299 return 1;
3300 }
3301 return 0;
3302}
cda69f48 3303
b5c8ea2a
MH
3304/**
3305 * Information needed for a single ref update. Set new_sha1 to the
3306 * new value or to zero to delete the ref. To check the old value
3307 * while locking the ref, set have_old to 1 and set old_sha1 to the
3308 * value or to zero to ensure the ref does not exist before update.
3309 */
3310struct ref_update {
b5c8ea2a
MH
3311 unsigned char new_sha1[20];
3312 unsigned char old_sha1[20];
3313 int flags; /* REF_NODEREF? */
3314 int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
81c960e4 3315 struct ref_lock *lock;
84178db7 3316 int type;
88615910 3317 const char refname[FLEX_ARRAY];
b5c8ea2a
MH
3318};
3319
caa4046c
MH
3320/*
3321 * Data structure for holding a reference transaction, which can
3322 * consist of checks and updates to multiple references, carried out
3323 * as atomically as possible. This structure is opaque to callers.
3324 */
3325struct ref_transaction {
3326 struct ref_update **updates;
3327 size_t alloc;
3328 size_t nr;
3329};
3330
3331struct ref_transaction *ref_transaction_begin(void)
3332{
3333 return xcalloc(1, sizeof(struct ref_transaction));
3334}
3335
3336static void ref_transaction_free(struct ref_transaction *transaction)
3337{
3338 int i;
3339
88615910
MH
3340 for (i = 0; i < transaction->nr; i++)
3341 free(transaction->updates[i]);
caa4046c
MH
3342
3343 free(transaction->updates);
3344 free(transaction);
3345}
3346
3347void ref_transaction_rollback(struct ref_transaction *transaction)
3348{
3349 ref_transaction_free(transaction);
3350}
3351
3352static struct ref_update *add_update(struct ref_transaction *transaction,
3353 const char *refname)
3354{
88615910
MH
3355 size_t len = strlen(refname);
3356 struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);
caa4046c 3357
88615910 3358 strcpy((char *)update->refname, refname);
caa4046c
MH
3359 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
3360 transaction->updates[transaction->nr++] = update;
3361 return update;
3362}
3363
3364void ref_transaction_update(struct ref_transaction *transaction,
3365 const char *refname,
3366 unsigned char *new_sha1, unsigned char *old_sha1,
3367 int flags, int have_old)
3368{
3369 struct ref_update *update = add_update(transaction, refname);
3370
3371 hashcpy(update->new_sha1, new_sha1);
3372 update->flags = flags;
3373 update->have_old = have_old;
3374 if (have_old)
3375 hashcpy(update->old_sha1, old_sha1);
3376}
3377
3378void ref_transaction_create(struct ref_transaction *transaction,
3379 const char *refname,
3380 unsigned char *new_sha1,
3381 int flags)
3382{
3383 struct ref_update *update = add_update(transaction, refname);
3384
3385 assert(!is_null_sha1(new_sha1));
3386 hashcpy(update->new_sha1, new_sha1);
3387 hashclr(update->old_sha1);
3388 update->flags = flags;
3389 update->have_old = 1;
3390}
3391
3392void ref_transaction_delete(struct ref_transaction *transaction,
3393 const char *refname,
3394 unsigned char *old_sha1,
3395 int flags, int have_old)
3396{
3397 struct ref_update *update = add_update(transaction, refname);
3398
3399 update->flags = flags;
3400 update->have_old = have_old;
3401 if (have_old) {
3402 assert(!is_null_sha1(old_sha1));
3403 hashcpy(update->old_sha1, old_sha1);
3404 }
3405}
3406
4738a333
BK
3407int update_ref(const char *action, const char *refname,
3408 const unsigned char *sha1, const unsigned char *oldval,
3409 int flags, enum action_on_err onerr)
3410{
3411 struct ref_lock *lock;
ce1e8462 3412 lock = update_ref_lock(refname, oldval, flags, NULL, onerr);
4738a333
BK
3413 if (!lock)
3414 return 1;
3415 return update_ref_write(action, refname, sha1, lock, onerr);
3416}
3417
98aee92d
BK
3418static int ref_update_compare(const void *r1, const void *r2)
3419{
3420 const struct ref_update * const *u1 = r1;
3421 const struct ref_update * const *u2 = r2;
5524e241 3422 return strcmp((*u1)->refname, (*u2)->refname);
98aee92d
BK
3423}
3424
3425static int ref_update_reject_duplicates(struct ref_update **updates, int n,
3426 enum action_on_err onerr)
3427{
3428 int i;
3429 for (i = 1; i < n; i++)
5524e241 3430 if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {
98aee92d
BK
3431 const char *str =
3432 "Multiple updates for ref '%s' not allowed.";
3433 switch (onerr) {
f4124112 3434 case UPDATE_REFS_MSG_ON_ERR:
5524e241 3435 error(str, updates[i]->refname); break;
f4124112 3436 case UPDATE_REFS_DIE_ON_ERR:
5524e241 3437 die(str, updates[i]->refname); break;
f4124112 3438 case UPDATE_REFS_QUIET_ON_ERR:
98aee92d
BK
3439 break;
3440 }
3441 return 1;
3442 }
3443 return 0;
3444}
3445
b5c8ea2a
MH
3446int ref_transaction_commit(struct ref_transaction *transaction,
3447 const char *msg, enum action_on_err onerr)
98aee92d
BK
3448{
3449 int ret = 0, delnum = 0, i;
98aee92d 3450 const char **delnames;
b5c8ea2a 3451 int n = transaction->nr;
6a402338 3452 struct ref_update **updates = transaction->updates;
98aee92d 3453
b5c8ea2a 3454 if (!n)
98aee92d
BK
3455 return 0;
3456
3457 /* Allocate work space */
98aee92d
BK
3458 delnames = xmalloc(sizeof(*delnames) * n);
3459
3460 /* Copy, sort, and reject duplicate refs */
98aee92d
BK
3461 qsort(updates, n, sizeof(*updates), ref_update_compare);
3462 ret = ref_update_reject_duplicates(updates, n, onerr);
3463 if (ret)
3464 goto cleanup;
3465
3466 /* Acquire all locks while verifying old values */
3467 for (i = 0; i < n; i++) {
cb198d21
MH
3468 struct ref_update *update = updates[i];
3469
81c960e4
MH
3470 update->lock = update_ref_lock(update->refname,
3471 (update->have_old ?
3472 update->old_sha1 : NULL),
3473 update->flags,
84178db7 3474 &update->type, onerr);
81c960e4 3475 if (!update->lock) {
98aee92d
BK
3476 ret = 1;
3477 goto cleanup;
3478 }
3479 }
3480
3481 /* Perform updates first so live commits remain referenced */
cb198d21
MH
3482 for (i = 0; i < n; i++) {
3483 struct ref_update *update = updates[i];
3484
3485 if (!is_null_sha1(update->new_sha1)) {
b5c8ea2a 3486 ret = update_ref_write(msg,
cb198d21
MH
3487 update->refname,
3488 update->new_sha1,
81c960e4
MH
3489 update->lock, onerr);
3490 update->lock = NULL; /* freed by update_ref_write */
98aee92d
BK
3491 if (ret)
3492 goto cleanup;
3493 }
cb198d21 3494 }
98aee92d
BK
3495
3496 /* Perform deletes now that updates are safely completed */
81c960e4
MH
3497 for (i = 0; i < n; i++) {
3498 struct ref_update *update = updates[i];
3499
3500 if (update->lock) {
3501 delnames[delnum++] = update->lock->ref_name;
84178db7 3502 ret |= delete_ref_loose(update->lock, update->type);
98aee92d 3503 }
81c960e4
MH
3504 }
3505
98aee92d
BK
3506 ret |= repack_without_refs(delnames, delnum);
3507 for (i = 0; i < delnum; i++)
3508 unlink_or_warn(git_path("logs/%s", delnames[i]));
3509 clear_loose_ref_cache(&ref_cache);
3510
3511cleanup:
3512 for (i = 0; i < n; i++)
81c960e4
MH
3513 if (updates[i]->lock)
3514 unlock_ref(updates[i]->lock);
98aee92d 3515 free(delnames);
caa4046c
MH
3516 ref_transaction_free(transaction);
3517 return ret;
3518}
3519
dfefa935 3520char *shorten_unambiguous_ref(const char *refname, int strict)
7c2b3029
JK
3521{
3522 int i;
3523 static char **scanf_fmts;
3524 static int nr_rules;
3525 char *short_name;
3526
7c2b3029 3527 if (!nr_rules) {
4346663a
MH
3528 /*
3529 * Pre-generate scanf formats from ref_rev_parse_rules[].
3530 * Generate a format suitable for scanf from a
3531 * ref_rev_parse_rules rule by interpolating "%s" at the
3532 * location of the "%.*s".
3533 */
7c2b3029 3534 size_t total_len = 0;
84d5633f 3535 size_t offset = 0;
7c2b3029
JK
3536
3537 /* the rule list is NULL terminated, count them first */
a4165851 3538 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
7902fe03
MH
3539 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
3540 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
7c2b3029
JK
3541
3542 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
3543
84d5633f 3544 offset = 0;
7c2b3029 3545 for (i = 0; i < nr_rules; i++) {
4346663a 3546 assert(offset < total_len);
84d5633f 3547 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
4346663a
MH
3548 offset += snprintf(scanf_fmts[i], total_len - offset,
3549 ref_rev_parse_rules[i], 2, "%s") + 1;
7c2b3029
JK
3550 }
3551 }
3552
3553 /* bail out if there are no rules */
3554 if (!nr_rules)
dfefa935 3555 return xstrdup(refname);
7c2b3029 3556
dfefa935
MH
3557 /* buffer for scanf result, at most refname must fit */
3558 short_name = xstrdup(refname);
7c2b3029
JK
3559
3560 /* skip first rule, it will always match */
3561 for (i = nr_rules - 1; i > 0 ; --i) {
3562 int j;
6e7b3309 3563 int rules_to_fail = i;
7c2b3029
JK
3564 int short_name_len;
3565
dfefa935 3566 if (1 != sscanf(refname, scanf_fmts[i], short_name))
7c2b3029
JK
3567 continue;
3568
3569 short_name_len = strlen(short_name);
3570
6e7b3309
BW
3571 /*
3572 * in strict mode, all (except the matched one) rules
3573 * must fail to resolve to a valid non-ambiguous ref
3574 */
3575 if (strict)
3576 rules_to_fail = nr_rules;
3577
7c2b3029
JK
3578 /*
3579 * check if the short name resolves to a valid ref,
3580 * but use only rules prior to the matched one
3581 */
6e7b3309 3582 for (j = 0; j < rules_to_fail; j++) {
7c2b3029 3583 const char *rule = ref_rev_parse_rules[j];
7c2b3029
JK
3584 char refname[PATH_MAX];
3585
6e7b3309
BW
3586 /* skip matched rule */
3587 if (i == j)
3588 continue;
3589
7c2b3029
JK
3590 /*
3591 * the short name is ambiguous, if it resolves
3592 * (with this previous rule) to a valid ref
3593 * read_ref() returns 0 on success
3594 */
3595 mksnpath(refname, sizeof(refname),
3596 rule, short_name_len, short_name);
c6893323 3597 if (ref_exists(refname))
7c2b3029
JK
3598 break;
3599 }
3600
3601 /*
3602 * short name is non-ambiguous if all previous rules
3603 * haven't resolved to a valid ref
3604 */
6e7b3309 3605 if (j == rules_to_fail)
7c2b3029
JK
3606 return short_name;
3607 }
3608
3609 free(short_name);
dfefa935 3610 return xstrdup(refname);
7c2b3029 3611}
daebaa78
JH
3612
3613static struct string_list *hide_refs;
3614
3615int parse_hide_refs_config(const char *var, const char *value, const char *section)
3616{
3617 if (!strcmp("transfer.hiderefs", var) ||
3618 /* NEEDSWORK: use parse_config_key() once both are merged */
59556548 3619 (starts_with(var, section) && var[strlen(section)] == '.' &&
daebaa78
JH
3620 !strcmp(var + strlen(section), ".hiderefs"))) {
3621 char *ref;
3622 int len;
3623
3624 if (!value)
3625 return config_error_nonbool(var);
3626 ref = xstrdup(value);
3627 len = strlen(ref);
3628 while (len && ref[len - 1] == '/')
3629 ref[--len] = '\0';
3630 if (!hide_refs) {
3631 hide_refs = xcalloc(1, sizeof(*hide_refs));
3632 hide_refs->strdup_strings = 1;
3633 }
3634 string_list_append(hide_refs, ref);
3635 }
3636 return 0;
3637}
3638
3639int ref_is_hidden(const char *refname)
3640{
3641 struct string_list_item *item;
3642
3643 if (!hide_refs)
3644 return 0;
3645 for_each_string_list_item(item, hide_refs) {
3646 int len;
59556548 3647 if (!starts_with(refname, item->string))
daebaa78
JH
3648 continue;