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