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