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