refs.con commit Merge branch 'kk/revwalk-slop-too-many-commit-within-a-second' into maint-1.8.1 (6437980)
   1#include "cache.h"
   2#include "refs.h"
   3#include "object.h"
   4#include "tag.h"
   5#include "dir.h"
   6
   7/*
   8 * Make sure "ref" is something reasonable to have under ".git/refs/";
   9 * We do not like it if:
  10 *
  11 * - any path component of it begins with ".", or
  12 * - it has double dots "..", or
  13 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
  14 * - it ends with a "/".
  15 * - it ends with ".lock"
  16 * - it contains a "\" (backslash)
  17 */
  18
  19/* Return true iff ch is not allowed in reference names. */
  20static inline int bad_ref_char(int ch)
  21{
  22        if (((unsigned) ch) <= ' ' || ch == 0x7f ||
  23            ch == '~' || ch == '^' || ch == ':' || ch == '\\')
  24                return 1;
  25        /* 2.13 Pattern Matching Notation */
  26        if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
  27                return 1;
  28        return 0;
  29}
  30
  31/*
  32 * Try to read one refname component from the front of refname.  Return
  33 * the length of the component found, or -1 if the component is not
  34 * legal.
  35 */
  36static int check_refname_component(const char *refname, int flags)
  37{
  38        const char *cp;
  39        char last = '\0';
  40
  41        for (cp = refname; ; cp++) {
  42                char ch = *cp;
  43                if (ch == '\0' || ch == '/')
  44                        break;
  45                if (bad_ref_char(ch))
  46                        return -1; /* Illegal character in refname. */
  47                if (last == '.' && ch == '.')
  48                        return -1; /* Refname contains "..". */
  49                if (last == '@' && ch == '{')
  50                        return -1; /* Refname contains "@{". */
  51                last = ch;
  52        }
  53        if (cp == refname)
  54                return 0; /* Component has zero length. */
  55        if (refname[0] == '.') {
  56                if (!(flags & REFNAME_DOT_COMPONENT))
  57                        return -1; /* Component starts with '.'. */
  58                /*
  59                 * Even if leading dots are allowed, don't allow "."
  60                 * as a component (".." is prevented by a rule above).
  61                 */
  62                if (refname[1] == '\0')
  63                        return -1; /* Component equals ".". */
  64        }
  65        if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
  66                return -1; /* Refname ends with ".lock". */
  67        return cp - refname;
  68}
  69
  70int check_refname_format(const char *refname, int flags)
  71{
  72        int component_len, component_count = 0;
  73
  74        while (1) {
  75                /* We are at the start of a path component. */
  76                component_len = check_refname_component(refname, flags);
  77                if (component_len <= 0) {
  78                        if ((flags & REFNAME_REFSPEC_PATTERN) &&
  79                                        refname[0] == '*' &&
  80                                        (refname[1] == '\0' || refname[1] == '/')) {
  81                                /* Accept one wildcard as a full refname component. */
  82                                flags &= ~REFNAME_REFSPEC_PATTERN;
  83                                component_len = 1;
  84                        } else {
  85                                return -1;
  86                        }
  87                }
  88                component_count++;
  89                if (refname[component_len] == '\0')
  90                        break;
  91                /* Skip to next component. */
  92                refname += component_len + 1;
  93        }
  94
  95        if (refname[component_len - 1] == '.')
  96                return -1; /* Refname ends with '.'. */
  97        if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
  98                return -1; /* Refname has only one component. */
  99        return 0;
 100}
 101
 102struct ref_entry;
 103
 104/*
 105 * Information used (along with the information in ref_entry) to
 106 * describe a single cached reference.  This data structure only
 107 * occurs embedded in a union in struct ref_entry, and only when
 108 * (ref_entry->flag & REF_DIR) is zero.
 109 */
 110struct ref_value {
 111        unsigned char sha1[20];
 112        unsigned char peeled[20];
 113};
 114
 115struct ref_cache;
 116
 117/*
 118 * Information used (along with the information in ref_entry) to
 119 * describe a level in the hierarchy of references.  This data
 120 * structure only occurs embedded in a union in struct ref_entry, and
 121 * only when (ref_entry.flag & REF_DIR) is set.  In that case,
 122 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
 123 * in the directory have already been read:
 124 *
 125 *     (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
 126 *         or packed references, already read.
 127 *
 128 *     (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
 129 *         references that hasn't been read yet (nor has any of its
 130 *         subdirectories).
 131 *
 132 * Entries within a directory are stored within a growable array of
 133 * pointers to ref_entries (entries, nr, alloc).  Entries 0 <= i <
 134 * sorted are sorted by their component name in strcmp() order and the
 135 * remaining entries are unsorted.
 136 *
 137 * Loose references are read lazily, one directory at a time.  When a
 138 * directory of loose references is read, then all of the references
 139 * in that directory are stored, and REF_INCOMPLETE stubs are created
 140 * for any subdirectories, but the subdirectories themselves are not
 141 * read.  The reading is triggered by get_ref_dir().
 142 */
 143struct ref_dir {
 144        int nr, alloc;
 145
 146        /*
 147         * Entries with index 0 <= i < sorted are sorted by name.  New
 148         * entries are appended to the list unsorted, and are sorted
 149         * only when required; thus we avoid the need to sort the list
 150         * after the addition of every reference.
 151         */
 152        int sorted;
 153
 154        /* A pointer to the ref_cache that contains this ref_dir. */
 155        struct ref_cache *ref_cache;
 156
 157        struct ref_entry **entries;
 158};
 159
 160/* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
 161#define REF_KNOWS_PEELED 0x08
 162
 163/* ref_entry represents a directory of references */
 164#define REF_DIR 0x10
 165
 166/*
 167 * Entry has not yet been read from disk (used only for REF_DIR
 168 * entries representing loose references)
 169 */
 170#define REF_INCOMPLETE 0x20
 171
 172/*
 173 * A ref_entry represents either a reference or a "subdirectory" of
 174 * references.
 175 *
 176 * Each directory in the reference namespace is represented by a
 177 * ref_entry with (flags & REF_DIR) set and containing a subdir member
 178 * that holds the entries in that directory that have been read so
 179 * far.  If (flags & REF_INCOMPLETE) is set, then the directory and
 180 * its subdirectories haven't been read yet.  REF_INCOMPLETE is only
 181 * used for loose reference directories.
 182 *
 183 * References are represented by a ref_entry with (flags & REF_DIR)
 184 * unset and a value member that describes the reference's value.  The
 185 * flag member is at the ref_entry level, but it is also needed to
 186 * interpret the contents of the value field (in other words, a
 187 * ref_value object is not very much use without the enclosing
 188 * ref_entry).
 189 *
 190 * Reference names cannot end with slash and directories' names are
 191 * always stored with a trailing slash (except for the top-level
 192 * directory, which is always denoted by "").  This has two nice
 193 * consequences: (1) when the entries in each subdir are sorted
 194 * lexicographically by name (as they usually are), the references in
 195 * a whole tree can be generated in lexicographic order by traversing
 196 * the tree in left-to-right, depth-first order; (2) the names of
 197 * references and subdirectories cannot conflict, and therefore the
 198 * presence of an empty subdirectory does not block the creation of a
 199 * similarly-named reference.  (The fact that reference names with the
 200 * same leading components can conflict *with each other* is a
 201 * separate issue that is regulated by is_refname_available().)
 202 *
 203 * Please note that the name field contains the fully-qualified
 204 * reference (or subdirectory) name.  Space could be saved by only
 205 * storing the relative names.  But that would require the full names
 206 * to be generated on the fly when iterating in do_for_each_ref(), and
 207 * would break callback functions, who have always been able to assume
 208 * that the name strings that they are passed will not be freed during
 209 * the iteration.
 210 */
 211struct ref_entry {
 212        unsigned char flag; /* ISSYMREF? ISPACKED? */
 213        union {
 214                struct ref_value value; /* if not (flags&REF_DIR) */
 215                struct ref_dir subdir; /* if (flags&REF_DIR) */
 216        } u;
 217        /*
 218         * The full name of the reference (e.g., "refs/heads/master")
 219         * or the full name of the directory with a trailing slash
 220         * (e.g., "refs/heads/"):
 221         */
 222        char name[FLEX_ARRAY];
 223};
 224
 225static void read_loose_refs(const char *dirname, struct ref_dir *dir);
 226
 227static struct ref_dir *get_ref_dir(struct ref_entry *entry)
 228{
 229        struct ref_dir *dir;
 230        assert(entry->flag & REF_DIR);
 231        dir = &entry->u.subdir;
 232        if (entry->flag & REF_INCOMPLETE) {
 233                read_loose_refs(entry->name, dir);
 234                entry->flag &= ~REF_INCOMPLETE;
 235        }
 236        return dir;
 237}
 238
 239static struct ref_entry *create_ref_entry(const char *refname,
 240                                          const unsigned char *sha1, int flag,
 241                                          int check_name)
 242{
 243        int len;
 244        struct ref_entry *ref;
 245
 246        if (check_name &&
 247            check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
 248                die("Reference has invalid format: '%s'", refname);
 249        len = strlen(refname) + 1;
 250        ref = xmalloc(sizeof(struct ref_entry) + len);
 251        hashcpy(ref->u.value.sha1, sha1);
 252        hashclr(ref->u.value.peeled);
 253        memcpy(ref->name, refname, len);
 254        ref->flag = flag;
 255        return ref;
 256}
 257
 258static void clear_ref_dir(struct ref_dir *dir);
 259
 260static void free_ref_entry(struct ref_entry *entry)
 261{
 262        if (entry->flag & REF_DIR) {
 263                /*
 264                 * Do not use get_ref_dir() here, as that might
 265                 * trigger the reading of loose refs.
 266                 */
 267                clear_ref_dir(&entry->u.subdir);
 268        }
 269        free(entry);
 270}
 271
 272/*
 273 * Add a ref_entry to the end of dir (unsorted).  Entry is always
 274 * stored directly in dir; no recursion into subdirectories is
 275 * done.
 276 */
 277static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
 278{
 279        ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
 280        dir->entries[dir->nr++] = entry;
 281        /* optimize for the case that entries are added in order */
 282        if (dir->nr == 1 ||
 283            (dir->nr == dir->sorted + 1 &&
 284             strcmp(dir->entries[dir->nr - 2]->name,
 285                    dir->entries[dir->nr - 1]->name) < 0))
 286                dir->sorted = dir->nr;
 287}
 288
 289/*
 290 * Clear and free all entries in dir, recursively.
 291 */
 292static void clear_ref_dir(struct ref_dir *dir)
 293{
 294        int i;
 295        for (i = 0; i < dir->nr; i++)
 296                free_ref_entry(dir->entries[i]);
 297        free(dir->entries);
 298        dir->sorted = dir->nr = dir->alloc = 0;
 299        dir->entries = NULL;
 300}
 301
 302/*
 303 * Create a struct ref_entry object for the specified dirname.
 304 * dirname is the name of the directory with a trailing slash (e.g.,
 305 * "refs/heads/") or "" for the top-level directory.
 306 */
 307static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
 308                                          const char *dirname, size_t len,
 309                                          int incomplete)
 310{
 311        struct ref_entry *direntry;
 312        direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
 313        memcpy(direntry->name, dirname, len);
 314        direntry->name[len] = '\0';
 315        direntry->u.subdir.ref_cache = ref_cache;
 316        direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
 317        return direntry;
 318}
 319
 320static int ref_entry_cmp(const void *a, const void *b)
 321{
 322        struct ref_entry *one = *(struct ref_entry **)a;
 323        struct ref_entry *two = *(struct ref_entry **)b;
 324        return strcmp(one->name, two->name);
 325}
 326
 327static void sort_ref_dir(struct ref_dir *dir);
 328
 329struct string_slice {
 330        size_t len;
 331        const char *str;
 332};
 333
 334static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
 335{
 336        struct string_slice *key = (struct string_slice *)key_;
 337        struct ref_entry *ent = *(struct ref_entry **)ent_;
 338        int entlen = strlen(ent->name);
 339        int cmplen = key->len < entlen ? key->len : entlen;
 340        int cmp = memcmp(key->str, ent->name, cmplen);
 341        if (cmp)
 342                return cmp;
 343        return key->len - entlen;
 344}
 345
 346/*
 347 * Return the entry with the given refname from the ref_dir
 348 * (non-recursively), sorting dir if necessary.  Return NULL if no
 349 * such entry is found.  dir must already be complete.
 350 */
 351static struct ref_entry *search_ref_dir(struct ref_dir *dir,
 352                                        const char *refname, size_t len)
 353{
 354        struct ref_entry **r;
 355        struct string_slice key;
 356
 357        if (refname == NULL || !dir->nr)
 358                return NULL;
 359
 360        sort_ref_dir(dir);
 361        key.len = len;
 362        key.str = refname;
 363        r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
 364                    ref_entry_cmp_sslice);
 365
 366        if (r == NULL)
 367                return NULL;
 368
 369        return *r;
 370}
 371
 372/*
 373 * Search for a directory entry directly within dir (without
 374 * recursing).  Sort dir if necessary.  subdirname must be a directory
 375 * name (i.e., end in '/').  If mkdir is set, then create the
 376 * directory if it is missing; otherwise, return NULL if the desired
 377 * directory cannot be found.  dir must already be complete.
 378 */
 379static struct ref_dir *search_for_subdir(struct ref_dir *dir,
 380                                         const char *subdirname, size_t len,
 381                                         int mkdir)
 382{
 383        struct ref_entry *entry = search_ref_dir(dir, subdirname, len);
 384        if (!entry) {
 385                if (!mkdir)
 386                        return NULL;
 387                /*
 388                 * Since dir is complete, the absence of a subdir
 389                 * means that the subdir really doesn't exist;
 390                 * therefore, create an empty record for it but mark
 391                 * the record complete.
 392                 */
 393                entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
 394                add_entry_to_dir(dir, entry);
 395        }
 396        return get_ref_dir(entry);
 397}
 398
 399/*
 400 * If refname is a reference name, find the ref_dir within the dir
 401 * tree that should hold refname.  If refname is a directory name
 402 * (i.e., ends in '/'), then return that ref_dir itself.  dir must
 403 * represent the top-level directory and must already be complete.
 404 * Sort ref_dirs and recurse into subdirectories as necessary.  If
 405 * mkdir is set, then create any missing directories; otherwise,
 406 * return NULL if the desired directory cannot be found.
 407 */
 408static struct ref_dir *find_containing_dir(struct ref_dir *dir,
 409                                           const char *refname, int mkdir)
 410{
 411        const char *slash;
 412        for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
 413                size_t dirnamelen = slash - refname + 1;
 414                struct ref_dir *subdir;
 415                subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
 416                if (!subdir) {
 417                        dir = NULL;
 418                        break;
 419                }
 420                dir = subdir;
 421        }
 422
 423        return dir;
 424}
 425
 426/*
 427 * Find the value entry with the given name in dir, sorting ref_dirs
 428 * and recursing into subdirectories as necessary.  If the name is not
 429 * found or it corresponds to a directory entry, return NULL.
 430 */
 431static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
 432{
 433        struct ref_entry *entry;
 434        dir = find_containing_dir(dir, refname, 0);
 435        if (!dir)
 436                return NULL;
 437        entry = search_ref_dir(dir, refname, strlen(refname));
 438        return (entry && !(entry->flag & REF_DIR)) ? entry : NULL;
 439}
 440
 441/*
 442 * Add a ref_entry to the ref_dir (unsorted), recursing into
 443 * subdirectories as necessary.  dir must represent the top-level
 444 * directory.  Return 0 on success.
 445 */
 446static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
 447{
 448        dir = find_containing_dir(dir, ref->name, 1);
 449        if (!dir)
 450                return -1;
 451        add_entry_to_dir(dir, ref);
 452        return 0;
 453}
 454
 455/*
 456 * Emit a warning and return true iff ref1 and ref2 have the same name
 457 * and the same sha1.  Die if they have the same name but different
 458 * sha1s.
 459 */
 460static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
 461{
 462        if (strcmp(ref1->name, ref2->name))
 463                return 0;
 464
 465        /* Duplicate name; make sure that they don't conflict: */
 466
 467        if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
 468                /* This is impossible by construction */
 469                die("Reference directory conflict: %s", ref1->name);
 470
 471        if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
 472                die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
 473
 474        warning("Duplicated ref: %s", ref1->name);
 475        return 1;
 476}
 477
 478/*
 479 * Sort the entries in dir non-recursively (if they are not already
 480 * sorted) and remove any duplicate entries.
 481 */
 482static void sort_ref_dir(struct ref_dir *dir)
 483{
 484        int i, j;
 485        struct ref_entry *last = NULL;
 486
 487        /*
 488         * This check also prevents passing a zero-length array to qsort(),
 489         * which is a problem on some platforms.
 490         */
 491        if (dir->sorted == dir->nr)
 492                return;
 493
 494        qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
 495
 496        /* Remove any duplicates: */
 497        for (i = 0, j = 0; j < dir->nr; j++) {
 498                struct ref_entry *entry = dir->entries[j];
 499                if (last && is_dup_ref(last, entry))
 500                        free_ref_entry(entry);
 501                else
 502                        last = dir->entries[i++] = entry;
 503        }
 504        dir->sorted = dir->nr = i;
 505}
 506
 507#define DO_FOR_EACH_INCLUDE_BROKEN 01
 508
 509static struct ref_entry *current_ref;
 510
 511static int do_one_ref(const char *base, each_ref_fn fn, int trim,
 512                      int flags, void *cb_data, struct ref_entry *entry)
 513{
 514        int retval;
 515        if (prefixcmp(entry->name, base))
 516                return 0;
 517
 518        if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
 519                if (entry->flag & REF_ISBROKEN)
 520                        return 0; /* ignore broken refs e.g. dangling symref */
 521                if (!has_sha1_file(entry->u.value.sha1)) {
 522                        error("%s does not point to a valid object!", entry->name);
 523                        return 0;
 524                }
 525        }
 526        current_ref = entry;
 527        retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
 528        current_ref = NULL;
 529        return retval;
 530}
 531
 532/*
 533 * Call fn for each reference in dir that has index in the range
 534 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 535 * that index range, sorting them before iterating.  This function
 536 * does not sort dir itself; it should be sorted beforehand.
 537 */
 538static int do_for_each_ref_in_dir(struct ref_dir *dir, int offset,
 539                                  const char *base,
 540                                  each_ref_fn fn, int trim, int flags, void *cb_data)
 541{
 542        int i;
 543        assert(dir->sorted == dir->nr);
 544        for (i = offset; i < dir->nr; i++) {
 545                struct ref_entry *entry = dir->entries[i];
 546                int retval;
 547                if (entry->flag & REF_DIR) {
 548                        struct ref_dir *subdir = get_ref_dir(entry);
 549                        sort_ref_dir(subdir);
 550                        retval = do_for_each_ref_in_dir(subdir, 0,
 551                                                        base, fn, trim, flags, cb_data);
 552                } else {
 553                        retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
 554                }
 555                if (retval)
 556                        return retval;
 557        }
 558        return 0;
 559}
 560
 561/*
 562 * Call fn for each reference in the union of dir1 and dir2, in order
 563 * by refname.  Recurse into subdirectories.  If a value entry appears
 564 * in both dir1 and dir2, then only process the version that is in
 565 * dir2.  The input dirs must already be sorted, but subdirs will be
 566 * sorted as needed.
 567 */
 568static int do_for_each_ref_in_dirs(struct ref_dir *dir1,
 569                                   struct ref_dir *dir2,
 570                                   const char *base, each_ref_fn fn, int trim,
 571                                   int flags, void *cb_data)
 572{
 573        int retval;
 574        int i1 = 0, i2 = 0;
 575
 576        assert(dir1->sorted == dir1->nr);
 577        assert(dir2->sorted == dir2->nr);
 578        while (1) {
 579                struct ref_entry *e1, *e2;
 580                int cmp;
 581                if (i1 == dir1->nr) {
 582                        return do_for_each_ref_in_dir(dir2, i2,
 583                                                      base, fn, trim, flags, cb_data);
 584                }
 585                if (i2 == dir2->nr) {
 586                        return do_for_each_ref_in_dir(dir1, i1,
 587                                                      base, fn, trim, flags, cb_data);
 588                }
 589                e1 = dir1->entries[i1];
 590                e2 = dir2->entries[i2];
 591                cmp = strcmp(e1->name, e2->name);
 592                if (cmp == 0) {
 593                        if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
 594                                /* Both are directories; descend them in parallel. */
 595                                struct ref_dir *subdir1 = get_ref_dir(e1);
 596                                struct ref_dir *subdir2 = get_ref_dir(e2);
 597                                sort_ref_dir(subdir1);
 598                                sort_ref_dir(subdir2);
 599                                retval = do_for_each_ref_in_dirs(
 600                                                subdir1, subdir2,
 601                                                base, fn, trim, flags, cb_data);
 602                                i1++;
 603                                i2++;
 604                        } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
 605                                /* Both are references; ignore the one from dir1. */
 606                                retval = do_one_ref(base, fn, trim, flags, cb_data, e2);
 607                                i1++;
 608                                i2++;
 609                        } else {
 610                                die("conflict between reference and directory: %s",
 611                                    e1->name);
 612                        }
 613                } else {
 614                        struct ref_entry *e;
 615                        if (cmp < 0) {
 616                                e = e1;
 617                                i1++;
 618                        } else {
 619                                e = e2;
 620                                i2++;
 621                        }
 622                        if (e->flag & REF_DIR) {
 623                                struct ref_dir *subdir = get_ref_dir(e);
 624                                sort_ref_dir(subdir);
 625                                retval = do_for_each_ref_in_dir(
 626                                                subdir, 0,
 627                                                base, fn, trim, flags, cb_data);
 628                        } else {
 629                                retval = do_one_ref(base, fn, trim, flags, cb_data, e);
 630                        }
 631                }
 632                if (retval)
 633                        return retval;
 634        }
 635        if (i1 < dir1->nr)
 636                return do_for_each_ref_in_dir(dir1, i1,
 637                                              base, fn, trim, flags, cb_data);
 638        if (i2 < dir2->nr)
 639                return do_for_each_ref_in_dir(dir2, i2,
 640                                              base, fn, trim, flags, cb_data);
 641        return 0;
 642}
 643
 644/*
 645 * Return true iff refname1 and refname2 conflict with each other.
 646 * Two reference names conflict if one of them exactly matches the
 647 * leading components of the other; e.g., "foo/bar" conflicts with
 648 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
 649 * "foo/barbados".
 650 */
 651static int names_conflict(const char *refname1, const char *refname2)
 652{
 653        for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
 654                ;
 655        return (*refname1 == '\0' && *refname2 == '/')
 656                || (*refname1 == '/' && *refname2 == '\0');
 657}
 658
 659struct name_conflict_cb {
 660        const char *refname;
 661        const char *oldrefname;
 662        const char *conflicting_refname;
 663};
 664
 665static int name_conflict_fn(const char *existingrefname, const unsigned char *sha1,
 666                            int flags, void *cb_data)
 667{
 668        struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
 669        if (data->oldrefname && !strcmp(data->oldrefname, existingrefname))
 670                return 0;
 671        if (names_conflict(data->refname, existingrefname)) {
 672                data->conflicting_refname = existingrefname;
 673                return 1;
 674        }
 675        return 0;
 676}
 677
 678/*
 679 * Return true iff a reference named refname could be created without
 680 * conflicting with the name of an existing reference in array.  If
 681 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
 682 * (e.g., because oldrefname is scheduled for deletion in the same
 683 * operation).
 684 */
 685static int is_refname_available(const char *refname, const char *oldrefname,
 686                                struct ref_dir *dir)
 687{
 688        struct name_conflict_cb data;
 689        data.refname = refname;
 690        data.oldrefname = oldrefname;
 691        data.conflicting_refname = NULL;
 692
 693        sort_ref_dir(dir);
 694        if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
 695                                   0, DO_FOR_EACH_INCLUDE_BROKEN,
 696                                   &data)) {
 697                error("'%s' exists; cannot create '%s'",
 698                      data.conflicting_refname, refname);
 699                return 0;
 700        }
 701        return 1;
 702}
 703
 704/*
 705 * Future: need to be in "struct repository"
 706 * when doing a full libification.
 707 */
 708static struct ref_cache {
 709        struct ref_cache *next;
 710        struct ref_entry *loose;
 711        struct ref_entry *packed;
 712        /* The submodule name, or "" for the main repo. */
 713        char name[FLEX_ARRAY];
 714} *ref_cache;
 715
 716static void clear_packed_ref_cache(struct ref_cache *refs)
 717{
 718        if (refs->packed) {
 719                free_ref_entry(refs->packed);
 720                refs->packed = NULL;
 721        }
 722}
 723
 724static void clear_loose_ref_cache(struct ref_cache *refs)
 725{
 726        if (refs->loose) {
 727                free_ref_entry(refs->loose);
 728                refs->loose = NULL;
 729        }
 730}
 731
 732static struct ref_cache *create_ref_cache(const char *submodule)
 733{
 734        int len;
 735        struct ref_cache *refs;
 736        if (!submodule)
 737                submodule = "";
 738        len = strlen(submodule) + 1;
 739        refs = xcalloc(1, sizeof(struct ref_cache) + len);
 740        memcpy(refs->name, submodule, len);
 741        return refs;
 742}
 743
 744/*
 745 * Return a pointer to a ref_cache for the specified submodule. For
 746 * the main repository, use submodule==NULL. The returned structure
 747 * will be allocated and initialized but not necessarily populated; it
 748 * should not be freed.
 749 */
 750static struct ref_cache *get_ref_cache(const char *submodule)
 751{
 752        struct ref_cache *refs = ref_cache;
 753        if (!submodule)
 754                submodule = "";
 755        while (refs) {
 756                if (!strcmp(submodule, refs->name))
 757                        return refs;
 758                refs = refs->next;
 759        }
 760
 761        refs = create_ref_cache(submodule);
 762        refs->next = ref_cache;
 763        ref_cache = refs;
 764        return refs;
 765}
 766
 767void invalidate_ref_cache(const char *submodule)
 768{
 769        struct ref_cache *refs = get_ref_cache(submodule);
 770        clear_packed_ref_cache(refs);
 771        clear_loose_ref_cache(refs);
 772}
 773
 774/*
 775 * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
 776 * Return a pointer to the refname within the line (null-terminated),
 777 * or NULL if there was a problem.
 778 */
 779static const char *parse_ref_line(char *line, unsigned char *sha1)
 780{
 781        /*
 782         * 42: the answer to everything.
 783         *
 784         * In this case, it happens to be the answer to
 785         *  40 (length of sha1 hex representation)
 786         *  +1 (space in between hex and name)
 787         *  +1 (newline at the end of the line)
 788         */
 789        int len = strlen(line) - 42;
 790
 791        if (len <= 0)
 792                return NULL;
 793        if (get_sha1_hex(line, sha1) < 0)
 794                return NULL;
 795        if (!isspace(line[40]))
 796                return NULL;
 797        line += 41;
 798        if (isspace(*line))
 799                return NULL;
 800        if (line[len] != '\n')
 801                return NULL;
 802        line[len] = 0;
 803
 804        return line;
 805}
 806
 807/*
 808 * Read f, which is a packed-refs file, into dir.
 809 *
 810 * A comment line of the form "# pack-refs with: " may contain zero or
 811 * more traits. We interpret the traits as follows:
 812 *
 813 *   No traits:
 814 *
 815 *      Probably no references are peeled. But if the file contains a
 816 *      peeled value for a reference, we will use it.
 817 *
 818 *   peeled:
 819 *
 820 *      References under "refs/tags/", if they *can* be peeled, *are*
 821 *      peeled in this file. References outside of "refs/tags/" are
 822 *      probably not peeled even if they could have been, but if we find
 823 *      a peeled value for such a reference we will use it.
 824 *
 825 *   fully-peeled:
 826 *
 827 *      All references in the file that can be peeled are peeled.
 828 *      Inversely (and this is more important), any references in the
 829 *      file for which no peeled value is recorded is not peelable. This
 830 *      trait should typically be written alongside "peeled" for
 831 *      compatibility with older clients, but we do not require it
 832 *      (i.e., "peeled" is a no-op if "fully-peeled" is set).
 833 */
 834static void read_packed_refs(FILE *f, struct ref_dir *dir)
 835{
 836        struct ref_entry *last = NULL;
 837        char refline[PATH_MAX];
 838        enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
 839
 840        while (fgets(refline, sizeof(refline), f)) {
 841                unsigned char sha1[20];
 842                const char *refname;
 843                static const char header[] = "# pack-refs with:";
 844
 845                if (!strncmp(refline, header, sizeof(header)-1)) {
 846                        const char *traits = refline + sizeof(header) - 1;
 847                        if (strstr(traits, " fully-peeled "))
 848                                peeled = PEELED_FULLY;
 849                        else if (strstr(traits, " peeled "))
 850                                peeled = PEELED_TAGS;
 851                        /* perhaps other traits later as well */
 852                        continue;
 853                }
 854
 855                refname = parse_ref_line(refline, sha1);
 856                if (refname) {
 857                        last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
 858                        if (peeled == PEELED_FULLY ||
 859                            (peeled == PEELED_TAGS && !prefixcmp(refname, "refs/tags/")))
 860                                last->flag |= REF_KNOWS_PEELED;
 861                        add_ref(dir, last);
 862                        continue;
 863                }
 864                if (last &&
 865                    refline[0] == '^' &&
 866                    strlen(refline) == 42 &&
 867                    refline[41] == '\n' &&
 868                    !get_sha1_hex(refline + 1, sha1)) {
 869                        hashcpy(last->u.value.peeled, sha1);
 870                        /*
 871                         * Regardless of what the file header said,
 872                         * we definitely know the value of *this*
 873                         * reference:
 874                         */
 875                        last->flag |= REF_KNOWS_PEELED;
 876                }
 877        }
 878}
 879
 880static struct ref_dir *get_packed_refs(struct ref_cache *refs)
 881{
 882        if (!refs->packed) {
 883                const char *packed_refs_file;
 884                FILE *f;
 885
 886                refs->packed = create_dir_entry(refs, "", 0, 0);
 887                if (*refs->name)
 888                        packed_refs_file = git_path_submodule(refs->name, "packed-refs");
 889                else
 890                        packed_refs_file = git_path("packed-refs");
 891                f = fopen(packed_refs_file, "r");
 892                if (f) {
 893                        read_packed_refs(f, get_ref_dir(refs->packed));
 894                        fclose(f);
 895                }
 896        }
 897        return get_ref_dir(refs->packed);
 898}
 899
 900void add_packed_ref(const char *refname, const unsigned char *sha1)
 901{
 902        add_ref(get_packed_refs(get_ref_cache(NULL)),
 903                        create_ref_entry(refname, sha1, REF_ISPACKED, 1));
 904}
 905
 906/*
 907 * Read the loose references from the namespace dirname into dir
 908 * (without recursing).  dirname must end with '/'.  dir must be the
 909 * directory entry corresponding to dirname.
 910 */
 911static void read_loose_refs(const char *dirname, struct ref_dir *dir)
 912{
 913        struct ref_cache *refs = dir->ref_cache;
 914        DIR *d;
 915        const char *path;
 916        struct dirent *de;
 917        int dirnamelen = strlen(dirname);
 918        struct strbuf refname;
 919
 920        if (*refs->name)
 921                path = git_path_submodule(refs->name, "%s", dirname);
 922        else
 923                path = git_path("%s", dirname);
 924
 925        d = opendir(path);
 926        if (!d)
 927                return;
 928
 929        strbuf_init(&refname, dirnamelen + 257);
 930        strbuf_add(&refname, dirname, dirnamelen);
 931
 932        while ((de = readdir(d)) != NULL) {
 933                unsigned char sha1[20];
 934                struct stat st;
 935                int flag;
 936                const char *refdir;
 937
 938                if (de->d_name[0] == '.')
 939                        continue;
 940                if (has_extension(de->d_name, ".lock"))
 941                        continue;
 942                strbuf_addstr(&refname, de->d_name);
 943                refdir = *refs->name
 944                        ? git_path_submodule(refs->name, "%s", refname.buf)
 945                        : git_path("%s", refname.buf);
 946                if (stat(refdir, &st) < 0) {
 947                        ; /* silently ignore */
 948                } else if (S_ISDIR(st.st_mode)) {
 949                        strbuf_addch(&refname, '/');
 950                        add_entry_to_dir(dir,
 951                                         create_dir_entry(refs, refname.buf,
 952                                                          refname.len, 1));
 953                } else {
 954                        if (*refs->name) {
 955                                hashclr(sha1);
 956                                flag = 0;
 957                                if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
 958                                        hashclr(sha1);
 959                                        flag |= REF_ISBROKEN;
 960                                }
 961                        } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
 962                                hashclr(sha1);
 963                                flag |= REF_ISBROKEN;
 964                        }
 965                        add_entry_to_dir(dir,
 966                                         create_ref_entry(refname.buf, sha1, flag, 1));
 967                }
 968                strbuf_setlen(&refname, dirnamelen);
 969        }
 970        strbuf_release(&refname);
 971        closedir(d);
 972}
 973
 974static struct ref_dir *get_loose_refs(struct ref_cache *refs)
 975{
 976        if (!refs->loose) {
 977                /*
 978                 * Mark the top-level directory complete because we
 979                 * are about to read the only subdirectory that can
 980                 * hold references:
 981                 */
 982                refs->loose = create_dir_entry(refs, "", 0, 0);
 983                /*
 984                 * Create an incomplete entry for "refs/":
 985                 */
 986                add_entry_to_dir(get_ref_dir(refs->loose),
 987                                 create_dir_entry(refs, "refs/", 5, 1));
 988        }
 989        return get_ref_dir(refs->loose);
 990}
 991
 992/* We allow "recursive" symbolic refs. Only within reason, though */
 993#define MAXDEPTH 5
 994#define MAXREFLEN (1024)
 995
 996/*
 997 * Called by resolve_gitlink_ref_recursive() after it failed to read
 998 * from the loose refs in ref_cache refs. Find <refname> in the
 999 * packed-refs file for the submodule.
1000 */
1001static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1002                                      const char *refname, unsigned char *sha1)
1003{
1004        struct ref_entry *ref;
1005        struct ref_dir *dir = get_packed_refs(refs);
1006
1007        ref = find_ref(dir, refname);
1008        if (ref == NULL)
1009                return -1;
1010
1011        memcpy(sha1, ref->u.value.sha1, 20);
1012        return 0;
1013}
1014
1015static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1016                                         const char *refname, unsigned char *sha1,
1017                                         int recursion)
1018{
1019        int fd, len;
1020        char buffer[128], *p;
1021        char *path;
1022
1023        if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1024                return -1;
1025        path = *refs->name
1026                ? git_path_submodule(refs->name, "%s", refname)
1027                : git_path("%s", refname);
1028        fd = open(path, O_RDONLY);
1029        if (fd < 0)
1030                return resolve_gitlink_packed_ref(refs, refname, sha1);
1031
1032        len = read(fd, buffer, sizeof(buffer)-1);
1033        close(fd);
1034        if (len < 0)
1035                return -1;
1036        while (len && isspace(buffer[len-1]))
1037                len--;
1038        buffer[len] = 0;
1039
1040        /* Was it a detached head or an old-fashioned symlink? */
1041        if (!get_sha1_hex(buffer, sha1))
1042                return 0;
1043
1044        /* Symref? */
1045        if (strncmp(buffer, "ref:", 4))
1046                return -1;
1047        p = buffer + 4;
1048        while (isspace(*p))
1049                p++;
1050
1051        return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1052}
1053
1054int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1055{
1056        int len = strlen(path), retval;
1057        char *submodule;
1058        struct ref_cache *refs;
1059
1060        while (len && path[len-1] == '/')
1061                len--;
1062        if (!len)
1063                return -1;
1064        submodule = xstrndup(path, len);
1065        refs = get_ref_cache(submodule);
1066        free(submodule);
1067
1068        retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1069        return retval;
1070}
1071
1072/*
1073 * Try to read ref from the packed references.  On success, set sha1
1074 * and return 0; otherwise, return -1.
1075 */
1076static int get_packed_ref(const char *refname, unsigned char *sha1)
1077{
1078        struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1079        struct ref_entry *entry = find_ref(packed, refname);
1080        if (entry) {
1081                hashcpy(sha1, entry->u.value.sha1);
1082                return 0;
1083        }
1084        return -1;
1085}
1086
1087const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1088{
1089        int depth = MAXDEPTH;
1090        ssize_t len;
1091        char buffer[256];
1092        static char refname_buffer[256];
1093
1094        if (flag)
1095                *flag = 0;
1096
1097        if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1098                return NULL;
1099
1100        for (;;) {
1101                char path[PATH_MAX];
1102                struct stat st;
1103                char *buf;
1104                int fd;
1105
1106                if (--depth < 0)
1107                        return NULL;
1108
1109                git_snpath(path, sizeof(path), "%s", refname);
1110
1111                if (lstat(path, &st) < 0) {
1112                        if (errno != ENOENT)
1113                                return NULL;
1114                        /*
1115                         * The loose reference file does not exist;
1116                         * check for a packed reference.
1117                         */
1118                        if (!get_packed_ref(refname, sha1)) {
1119                                if (flag)
1120                                        *flag |= REF_ISPACKED;
1121                                return refname;
1122                        }
1123                        /* The reference is not a packed reference, either. */
1124                        if (reading) {
1125                                return NULL;
1126                        } else {
1127                                hashclr(sha1);
1128                                return refname;
1129                        }
1130                }
1131
1132                /* Follow "normalized" - ie "refs/.." symlinks by hand */
1133                if (S_ISLNK(st.st_mode)) {
1134                        len = readlink(path, buffer, sizeof(buffer)-1);
1135                        if (len < 0)
1136                                return NULL;
1137                        buffer[len] = 0;
1138                        if (!prefixcmp(buffer, "refs/") &&
1139                                        !check_refname_format(buffer, 0)) {
1140                                strcpy(refname_buffer, buffer);
1141                                refname = refname_buffer;
1142                                if (flag)
1143                                        *flag |= REF_ISSYMREF;
1144                                continue;
1145                        }
1146                }
1147
1148                /* Is it a directory? */
1149                if (S_ISDIR(st.st_mode)) {
1150                        errno = EISDIR;
1151                        return NULL;
1152                }
1153
1154                /*
1155                 * Anything else, just open it and try to use it as
1156                 * a ref
1157                 */
1158                fd = open(path, O_RDONLY);
1159                if (fd < 0)
1160                        return NULL;
1161                len = read_in_full(fd, buffer, sizeof(buffer)-1);
1162                close(fd);
1163                if (len < 0)
1164                        return NULL;
1165                while (len && isspace(buffer[len-1]))
1166                        len--;
1167                buffer[len] = '\0';
1168
1169                /*
1170                 * Is it a symbolic ref?
1171                 */
1172                if (prefixcmp(buffer, "ref:"))
1173                        break;
1174                if (flag)
1175                        *flag |= REF_ISSYMREF;
1176                buf = buffer + 4;
1177                while (isspace(*buf))
1178                        buf++;
1179                if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1180                        if (flag)
1181                                *flag |= REF_ISBROKEN;
1182                        return NULL;
1183                }
1184                refname = strcpy(refname_buffer, buf);
1185        }
1186        /* Please note that FETCH_HEAD has a second line containing other data. */
1187        if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1188                if (flag)
1189                        *flag |= REF_ISBROKEN;
1190                return NULL;
1191        }
1192        return refname;
1193}
1194
1195char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1196{
1197        const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1198        return ret ? xstrdup(ret) : NULL;
1199}
1200
1201/* The argument to filter_refs */
1202struct ref_filter {
1203        const char *pattern;
1204        each_ref_fn *fn;
1205        void *cb_data;
1206};
1207
1208int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1209{
1210        if (resolve_ref_unsafe(refname, sha1, reading, flags))
1211                return 0;
1212        return -1;
1213}
1214
1215int read_ref(const char *refname, unsigned char *sha1)
1216{
1217        return read_ref_full(refname, sha1, 1, NULL);
1218}
1219
1220int ref_exists(const char *refname)
1221{
1222        unsigned char sha1[20];
1223        return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1224}
1225
1226static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1227                       void *data)
1228{
1229        struct ref_filter *filter = (struct ref_filter *)data;
1230        if (fnmatch(filter->pattern, refname, 0))
1231                return 0;
1232        return filter->fn(refname, sha1, flags, filter->cb_data);
1233}
1234
1235int peel_ref(const char *refname, unsigned char *sha1)
1236{
1237        int flag;
1238        unsigned char base[20];
1239        struct object *o;
1240
1241        if (current_ref && (current_ref->name == refname
1242                || !strcmp(current_ref->name, refname))) {
1243                if (current_ref->flag & REF_KNOWS_PEELED) {
1244                        if (is_null_sha1(current_ref->u.value.peeled))
1245                            return -1;
1246                        hashcpy(sha1, current_ref->u.value.peeled);
1247                        return 0;
1248                }
1249                hashcpy(base, current_ref->u.value.sha1);
1250                goto fallback;
1251        }
1252
1253        if (read_ref_full(refname, base, 1, &flag))
1254                return -1;
1255
1256        if ((flag & REF_ISPACKED)) {
1257                struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1258                struct ref_entry *r = find_ref(dir, refname);
1259
1260                if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1261                        hashcpy(sha1, r->u.value.peeled);
1262                        return 0;
1263                }
1264        }
1265
1266fallback:
1267        o = lookup_unknown_object(base);
1268        if (o->type == OBJ_NONE) {
1269                int type = sha1_object_info(base, NULL);
1270                if (type < 0)
1271                        return -1;
1272                o->type = type;
1273        }
1274
1275        if (o->type == OBJ_TAG) {
1276                o = deref_tag_noverify(o);
1277                if (o) {
1278                        hashcpy(sha1, o->sha1);
1279                        return 0;
1280                }
1281        }
1282        return -1;
1283}
1284
1285struct warn_if_dangling_data {
1286        FILE *fp;
1287        const char *refname;
1288        const char *msg_fmt;
1289};
1290
1291static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1292                                   int flags, void *cb_data)
1293{
1294        struct warn_if_dangling_data *d = cb_data;
1295        const char *resolves_to;
1296        unsigned char junk[20];
1297
1298        if (!(flags & REF_ISSYMREF))
1299                return 0;
1300
1301        resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1302        if (!resolves_to || strcmp(resolves_to, d->refname))
1303                return 0;
1304
1305        fprintf(d->fp, d->msg_fmt, refname);
1306        fputc('\n', d->fp);
1307        return 0;
1308}
1309
1310void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1311{
1312        struct warn_if_dangling_data data;
1313
1314        data.fp = fp;
1315        data.refname = refname;
1316        data.msg_fmt = msg_fmt;
1317        for_each_rawref(warn_if_dangling_symref, &data);
1318}
1319
1320static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
1321                           int trim, int flags, void *cb_data)
1322{
1323        struct ref_cache *refs = get_ref_cache(submodule);
1324        struct ref_dir *packed_dir = get_packed_refs(refs);
1325        struct ref_dir *loose_dir = get_loose_refs(refs);
1326        int retval = 0;
1327
1328        if (base && *base) {
1329                packed_dir = find_containing_dir(packed_dir, base, 0);
1330                loose_dir = find_containing_dir(loose_dir, base, 0);
1331        }
1332
1333        if (packed_dir && loose_dir) {
1334                sort_ref_dir(packed_dir);
1335                sort_ref_dir(loose_dir);
1336                retval = do_for_each_ref_in_dirs(
1337                                packed_dir, loose_dir,
1338                                base, fn, trim, flags, cb_data);
1339        } else if (packed_dir) {
1340                sort_ref_dir(packed_dir);
1341                retval = do_for_each_ref_in_dir(
1342                                packed_dir, 0,
1343                                base, fn, trim, flags, cb_data);
1344        } else if (loose_dir) {
1345                sort_ref_dir(loose_dir);
1346                retval = do_for_each_ref_in_dir(
1347                                loose_dir, 0,
1348                                base, fn, trim, flags, cb_data);
1349        }
1350
1351        return retval;
1352}
1353
1354static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1355{
1356        unsigned char sha1[20];
1357        int flag;
1358
1359        if (submodule) {
1360                if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1361                        return fn("HEAD", sha1, 0, cb_data);
1362
1363                return 0;
1364        }
1365
1366        if (!read_ref_full("HEAD", sha1, 1, &flag))
1367                return fn("HEAD", sha1, flag, cb_data);
1368
1369        return 0;
1370}
1371
1372int head_ref(each_ref_fn fn, void *cb_data)
1373{
1374        return do_head_ref(NULL, fn, cb_data);
1375}
1376
1377int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1378{
1379        return do_head_ref(submodule, fn, cb_data);
1380}
1381
1382int for_each_ref(each_ref_fn fn, void *cb_data)
1383{
1384        return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1385}
1386
1387int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1388{
1389        return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1390}
1391
1392int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1393{
1394        return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1395}
1396
1397int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1398                each_ref_fn fn, void *cb_data)
1399{
1400        return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1401}
1402
1403int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1404{
1405        return for_each_ref_in("refs/tags/", fn, cb_data);
1406}
1407
1408int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1409{
1410        return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1411}
1412
1413int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1414{
1415        return for_each_ref_in("refs/heads/", fn, cb_data);
1416}
1417
1418int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1419{
1420        return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1421}
1422
1423int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1424{
1425        return for_each_ref_in("refs/remotes/", fn, cb_data);
1426}
1427
1428int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1429{
1430        return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1431}
1432
1433int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1434{
1435        return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1436}
1437
1438int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1439{
1440        struct strbuf buf = STRBUF_INIT;
1441        int ret = 0;
1442        unsigned char sha1[20];
1443        int flag;
1444
1445        strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1446        if (!read_ref_full(buf.buf, sha1, 1, &flag))
1447                ret = fn(buf.buf, sha1, flag, cb_data);
1448        strbuf_release(&buf);
1449
1450        return ret;
1451}
1452
1453int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1454{
1455        struct strbuf buf = STRBUF_INIT;
1456        int ret;
1457        strbuf_addf(&buf, "%srefs/", get_git_namespace());
1458        ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
1459        strbuf_release(&buf);
1460        return ret;
1461}
1462
1463int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1464        const char *prefix, void *cb_data)
1465{
1466        struct strbuf real_pattern = STRBUF_INIT;
1467        struct ref_filter filter;
1468        int ret;
1469
1470        if (!prefix && prefixcmp(pattern, "refs/"))
1471                strbuf_addstr(&real_pattern, "refs/");
1472        else if (prefix)
1473                strbuf_addstr(&real_pattern, prefix);
1474        strbuf_addstr(&real_pattern, pattern);
1475
1476        if (!has_glob_specials(pattern)) {
1477                /* Append implied '/' '*' if not present. */
1478                if (real_pattern.buf[real_pattern.len - 1] != '/')
1479                        strbuf_addch(&real_pattern, '/');
1480                /* No need to check for '*', there is none. */
1481                strbuf_addch(&real_pattern, '*');
1482        }
1483
1484        filter.pattern = real_pattern.buf;
1485        filter.fn = fn;
1486        filter.cb_data = cb_data;
1487        ret = for_each_ref(filter_refs, &filter);
1488
1489        strbuf_release(&real_pattern);
1490        return ret;
1491}
1492
1493int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1494{
1495        return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1496}
1497
1498int for_each_rawref(each_ref_fn fn, void *cb_data)
1499{
1500        return do_for_each_ref(NULL, "", fn, 0,
1501                               DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1502}
1503
1504const char *prettify_refname(const char *name)
1505{
1506        return name + (
1507                !prefixcmp(name, "refs/heads/") ? 11 :
1508                !prefixcmp(name, "refs/tags/") ? 10 :
1509                !prefixcmp(name, "refs/remotes/") ? 13 :
1510                0);
1511}
1512
1513const char *ref_rev_parse_rules[] = {
1514        "%.*s",
1515        "refs/%.*s",
1516        "refs/tags/%.*s",
1517        "refs/heads/%.*s",
1518        "refs/remotes/%.*s",
1519        "refs/remotes/%.*s/HEAD",
1520        NULL
1521};
1522
1523int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1524{
1525        const char **p;
1526        const int abbrev_name_len = strlen(abbrev_name);
1527
1528        for (p = rules; *p; p++) {
1529                if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1530                        return 1;
1531                }
1532        }
1533
1534        return 0;
1535}
1536
1537static struct ref_lock *verify_lock(struct ref_lock *lock,
1538        const unsigned char *old_sha1, int mustexist)
1539{
1540        if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1541                error("Can't verify ref %s", lock->ref_name);
1542                unlock_ref(lock);
1543                return NULL;
1544        }
1545        if (hashcmp(lock->old_sha1, old_sha1)) {
1546                error("Ref %s is at %s but expected %s", lock->ref_name,
1547                        sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1548                unlock_ref(lock);
1549                return NULL;
1550        }
1551        return lock;
1552}
1553
1554static int remove_empty_directories(const char *file)
1555{
1556        /* we want to create a file but there is a directory there;
1557         * if that is an empty directory (or a directory that contains
1558         * only empty directories), remove them.
1559         */
1560        struct strbuf path;
1561        int result;
1562
1563        strbuf_init(&path, 20);
1564        strbuf_addstr(&path, file);
1565
1566        result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1567
1568        strbuf_release(&path);
1569
1570        return result;
1571}
1572
1573/*
1574 * *string and *len will only be substituted, and *string returned (for
1575 * later free()ing) if the string passed in is a magic short-hand form
1576 * to name a branch.
1577 */
1578static char *substitute_branch_name(const char **string, int *len)
1579{
1580        struct strbuf buf = STRBUF_INIT;
1581        int ret = interpret_branch_name(*string, &buf);
1582
1583        if (ret == *len) {
1584                size_t size;
1585                *string = strbuf_detach(&buf, &size);
1586                *len = size;
1587                return (char *)*string;
1588        }
1589
1590        return NULL;
1591}
1592
1593int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1594{
1595        char *last_branch = substitute_branch_name(&str, &len);
1596        const char **p, *r;
1597        int refs_found = 0;
1598
1599        *ref = NULL;
1600        for (p = ref_rev_parse_rules; *p; p++) {
1601                char fullref[PATH_MAX];
1602                unsigned char sha1_from_ref[20];
1603                unsigned char *this_result;
1604                int flag;
1605
1606                this_result = refs_found ? sha1_from_ref : sha1;
1607                mksnpath(fullref, sizeof(fullref), *p, len, str);
1608                r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1609                if (r) {
1610                        if (!refs_found++)
1611                                *ref = xstrdup(r);
1612                        if (!warn_ambiguous_refs)
1613                                break;
1614                } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1615                        warning("ignoring dangling symref %s.", fullref);
1616                } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1617                        warning("ignoring broken ref %s.", fullref);
1618                }
1619        }
1620        free(last_branch);
1621        return refs_found;
1622}
1623
1624int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1625{
1626        char *last_branch = substitute_branch_name(&str, &len);
1627        const char **p;
1628        int logs_found = 0;
1629
1630        *log = NULL;
1631        for (p = ref_rev_parse_rules; *p; p++) {
1632                struct stat st;
1633                unsigned char hash[20];
1634                char path[PATH_MAX];
1635                const char *ref, *it;
1636
1637                mksnpath(path, sizeof(path), *p, len, str);
1638                ref = resolve_ref_unsafe(path, hash, 1, NULL);
1639                if (!ref)
1640                        continue;
1641                if (!stat(git_path("logs/%s", path), &st) &&
1642                    S_ISREG(st.st_mode))
1643                        it = path;
1644                else if (strcmp(ref, path) &&
1645                         !stat(git_path("logs/%s", ref), &st) &&
1646                         S_ISREG(st.st_mode))
1647                        it = ref;
1648                else
1649                        continue;
1650                if (!logs_found++) {
1651                        *log = xstrdup(it);
1652                        hashcpy(sha1, hash);
1653                }
1654                if (!warn_ambiguous_refs)
1655                        break;
1656        }
1657        free(last_branch);
1658        return logs_found;
1659}
1660
1661static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1662                                            const unsigned char *old_sha1,
1663                                            int flags, int *type_p)
1664{
1665        char *ref_file;
1666        const char *orig_refname = refname;
1667        struct ref_lock *lock;
1668        int last_errno = 0;
1669        int type, lflags;
1670        int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1671        int missing = 0;
1672
1673        lock = xcalloc(1, sizeof(struct ref_lock));
1674        lock->lock_fd = -1;
1675
1676        refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1677        if (!refname && errno == EISDIR) {
1678                /* we are trying to lock foo but we used to
1679                 * have foo/bar which now does not exist;
1680                 * it is normal for the empty directory 'foo'
1681                 * to remain.
1682                 */
1683                ref_file = git_path("%s", orig_refname);
1684                if (remove_empty_directories(ref_file)) {
1685                        last_errno = errno;
1686                        error("there are still refs under '%s'", orig_refname);
1687                        goto error_return;
1688                }
1689                refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1690        }
1691        if (type_p)
1692            *type_p = type;
1693        if (!refname) {
1694                last_errno = errno;
1695                error("unable to resolve reference %s: %s",
1696                        orig_refname, strerror(errno));
1697                goto error_return;
1698        }
1699        missing = is_null_sha1(lock->old_sha1);
1700        /* When the ref did not exist and we are creating it,
1701         * make sure there is no existing ref that is packed
1702         * whose name begins with our refname, nor a ref whose
1703         * name is a proper prefix of our refname.
1704         */
1705        if (missing &&
1706             !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1707                last_errno = ENOTDIR;
1708                goto error_return;
1709        }
1710
1711        lock->lk = xcalloc(1, sizeof(struct lock_file));
1712
1713        lflags = LOCK_DIE_ON_ERROR;
1714        if (flags & REF_NODEREF) {
1715                refname = orig_refname;
1716                lflags |= LOCK_NODEREF;
1717        }
1718        lock->ref_name = xstrdup(refname);
1719        lock->orig_ref_name = xstrdup(orig_refname);
1720        ref_file = git_path("%s", refname);
1721        if (missing)
1722                lock->force_write = 1;
1723        if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1724                lock->force_write = 1;
1725
1726        if (safe_create_leading_directories(ref_file)) {
1727                last_errno = errno;
1728                error("unable to create directory for %s", ref_file);
1729                goto error_return;
1730        }
1731
1732        lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1733        return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1734
1735 error_return:
1736        unlock_ref(lock);
1737        errno = last_errno;
1738        return NULL;
1739}
1740
1741struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1742{
1743        char refpath[PATH_MAX];
1744        if (check_refname_format(refname, 0))
1745                return NULL;
1746        strcpy(refpath, mkpath("refs/%s", refname));
1747        return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1748}
1749
1750struct ref_lock *lock_any_ref_for_update(const char *refname,
1751                                         const unsigned char *old_sha1, int flags)
1752{
1753        if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1754                return NULL;
1755        return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1756}
1757
1758struct repack_without_ref_sb {
1759        const char *refname;
1760        int fd;
1761};
1762
1763static int repack_without_ref_fn(const char *refname, const unsigned char *sha1,
1764                                 int flags, void *cb_data)
1765{
1766        struct repack_without_ref_sb *data = cb_data;
1767        char line[PATH_MAX + 100];
1768        int len;
1769
1770        if (!strcmp(data->refname, refname))
1771                return 0;
1772        len = snprintf(line, sizeof(line), "%s %s\n",
1773                       sha1_to_hex(sha1), refname);
1774        /* this should not happen but just being defensive */
1775        if (len > sizeof(line))
1776                die("too long a refname '%s'", refname);
1777        write_or_die(data->fd, line, len);
1778        return 0;
1779}
1780
1781static struct lock_file packlock;
1782
1783static int repack_without_ref(const char *refname)
1784{
1785        struct repack_without_ref_sb data;
1786        struct ref_cache *refs = get_ref_cache(NULL);
1787        struct ref_dir *packed = get_packed_refs(refs);
1788        if (find_ref(packed, refname) == NULL)
1789                return 0;
1790        data.refname = refname;
1791        data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1792        if (data.fd < 0) {
1793                unable_to_lock_error(git_path("packed-refs"), errno);
1794                return error("cannot delete '%s' from packed refs", refname);
1795        }
1796        clear_packed_ref_cache(refs);
1797        packed = get_packed_refs(refs);
1798        do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
1799        return commit_lock_file(&packlock);
1800}
1801
1802int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1803{
1804        struct ref_lock *lock;
1805        int err, i = 0, ret = 0, flag = 0;
1806
1807        lock = lock_ref_sha1_basic(refname, sha1, delopt, &flag);
1808        if (!lock)
1809                return 1;
1810        if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1811                /* loose */
1812                i = strlen(lock->lk->filename) - 5; /* .lock */
1813                lock->lk->filename[i] = 0;
1814                err = unlink_or_warn(lock->lk->filename);
1815                if (err && errno != ENOENT)
1816                        ret = 1;
1817
1818                lock->lk->filename[i] = '.';
1819        }
1820        /* removing the loose one could have resurrected an earlier
1821         * packed one.  Also, if it was not loose we need to repack
1822         * without it.
1823         */
1824        ret |= repack_without_ref(lock->ref_name);
1825
1826        unlink_or_warn(git_path("logs/%s", lock->ref_name));
1827        invalidate_ref_cache(NULL);
1828        unlock_ref(lock);
1829        return ret;
1830}
1831
1832/*
1833 * People using contrib's git-new-workdir have .git/logs/refs ->
1834 * /some/other/path/.git/logs/refs, and that may live on another device.
1835 *
1836 * IOW, to avoid cross device rename errors, the temporary renamed log must
1837 * live into logs/refs.
1838 */
1839#define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1840
1841int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1842{
1843        unsigned char sha1[20], orig_sha1[20];
1844        int flag = 0, logmoved = 0;
1845        struct ref_lock *lock;
1846        struct stat loginfo;
1847        int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
1848        const char *symref = NULL;
1849        struct ref_cache *refs = get_ref_cache(NULL);
1850
1851        if (log && S_ISLNK(loginfo.st_mode))
1852                return error("reflog for %s is a symlink", oldrefname);
1853
1854        symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
1855        if (flag & REF_ISSYMREF)
1856                return error("refname %s is a symbolic ref, renaming it is not supported",
1857                        oldrefname);
1858        if (!symref)
1859                return error("refname %s not found", oldrefname);
1860
1861        if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1862                return 1;
1863
1864        if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1865                return 1;
1866
1867        if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1868                return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1869                        oldrefname, strerror(errno));
1870
1871        if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1872                error("unable to delete old %s", oldrefname);
1873                goto rollback;
1874        }
1875
1876        if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1877            delete_ref(newrefname, sha1, REF_NODEREF)) {
1878                if (errno==EISDIR) {
1879                        if (remove_empty_directories(git_path("%s", newrefname))) {
1880                                error("Directory not empty: %s", newrefname);
1881                                goto rollback;
1882                        }
1883                } else {
1884                        error("unable to delete existing %s", newrefname);
1885                        goto rollback;
1886                }
1887        }
1888
1889        if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1890                error("unable to create directory for %s", newrefname);
1891                goto rollback;
1892        }
1893
1894 retry:
1895        if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1896                if (errno==EISDIR || errno==ENOTDIR) {
1897                        /*
1898                         * rename(a, b) when b is an existing
1899                         * directory ought to result in ISDIR, but
1900                         * Solaris 5.8 gives ENOTDIR.  Sheesh.
1901                         */
1902                        if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1903                                error("Directory not empty: logs/%s", newrefname);
1904                                goto rollback;
1905                        }
1906                        goto retry;
1907                } else {
1908                        error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1909                                newrefname, strerror(errno));
1910                        goto rollback;
1911                }
1912        }
1913        logmoved = log;
1914
1915        lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1916        if (!lock) {
1917                error("unable to lock %s for update", newrefname);
1918                goto rollback;
1919        }
1920        lock->force_write = 1;
1921        hashcpy(lock->old_sha1, orig_sha1);
1922        if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1923                error("unable to write current sha1 into %s", newrefname);
1924                goto rollback;
1925        }
1926
1927        return 0;
1928
1929 rollback:
1930        lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1931        if (!lock) {
1932                error("unable to lock %s for rollback", oldrefname);
1933                goto rollbacklog;
1934        }
1935
1936        lock->force_write = 1;
1937        flag = log_all_ref_updates;
1938        log_all_ref_updates = 0;
1939        if (write_ref_sha1(lock, orig_sha1, NULL))
1940                error("unable to write current sha1 into %s", oldrefname);
1941        log_all_ref_updates = flag;
1942
1943 rollbacklog:
1944        if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1945                error("unable to restore logfile %s from %s: %s",
1946                        oldrefname, newrefname, strerror(errno));
1947        if (!logmoved && log &&
1948            rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1949                error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1950                        oldrefname, strerror(errno));
1951
1952        return 1;
1953}
1954
1955int close_ref(struct ref_lock *lock)
1956{
1957        if (close_lock_file(lock->lk))
1958                return -1;
1959        lock->lock_fd = -1;
1960        return 0;
1961}
1962
1963int commit_ref(struct ref_lock *lock)
1964{
1965        if (commit_lock_file(lock->lk))
1966                return -1;
1967        lock->lock_fd = -1;
1968        return 0;
1969}
1970
1971void unlock_ref(struct ref_lock *lock)
1972{
1973        /* Do not free lock->lk -- atexit() still looks at them */
1974        if (lock->lk)
1975                rollback_lock_file(lock->lk);
1976        free(lock->ref_name);
1977        free(lock->orig_ref_name);
1978        free(lock);
1979}
1980
1981/*
1982 * copy the reflog message msg to buf, which has been allocated sufficiently
1983 * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1984 * because reflog file is one line per entry.
1985 */
1986static int copy_msg(char *buf, const char *msg)
1987{
1988        char *cp = buf;
1989        char c;
1990        int wasspace = 1;
1991
1992        *cp++ = '\t';
1993        while ((c = *msg++)) {
1994                if (wasspace && isspace(c))
1995                        continue;
1996                wasspace = isspace(c);
1997                if (wasspace)
1998                        c = ' ';
1999                *cp++ = c;
2000        }
2001        while (buf < cp && isspace(cp[-1]))
2002                cp--;
2003        *cp++ = '\n';
2004        return cp - buf;
2005}
2006
2007int log_ref_setup(const char *refname, char *logfile, int bufsize)
2008{
2009        int logfd, oflags = O_APPEND | O_WRONLY;
2010
2011        git_snpath(logfile, bufsize, "logs/%s", refname);
2012        if (log_all_ref_updates &&
2013            (!prefixcmp(refname, "refs/heads/") ||
2014             !prefixcmp(refname, "refs/remotes/") ||
2015             !prefixcmp(refname, "refs/notes/") ||
2016             !strcmp(refname, "HEAD"))) {
2017                if (safe_create_leading_directories(logfile) < 0)
2018                        return error("unable to create directory for %s",
2019                                     logfile);
2020                oflags |= O_CREAT;
2021        }
2022
2023        logfd = open(logfile, oflags, 0666);
2024        if (logfd < 0) {
2025                if (!(oflags & O_CREAT) && errno == ENOENT)
2026                        return 0;
2027
2028                if ((oflags & O_CREAT) && errno == EISDIR) {
2029                        if (remove_empty_directories(logfile)) {
2030                                return error("There are still logs under '%s'",
2031                                             logfile);
2032                        }
2033                        logfd = open(logfile, oflags, 0666);
2034                }
2035
2036                if (logfd < 0)
2037                        return error("Unable to append to %s: %s",
2038                                     logfile, strerror(errno));
2039        }
2040
2041        adjust_shared_perm(logfile);
2042        close(logfd);
2043        return 0;
2044}
2045
2046static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2047                         const unsigned char *new_sha1, const char *msg)
2048{
2049        int logfd, result, written, oflags = O_APPEND | O_WRONLY;
2050        unsigned maxlen, len;
2051        int msglen;
2052        char log_file[PATH_MAX];
2053        char *logrec;
2054        const char *committer;
2055
2056        if (log_all_ref_updates < 0)
2057                log_all_ref_updates = !is_bare_repository();
2058
2059        result = log_ref_setup(refname, log_file, sizeof(log_file));
2060        if (result)
2061                return result;
2062
2063        logfd = open(log_file, oflags);
2064        if (logfd < 0)
2065                return 0;
2066        msglen = msg ? strlen(msg) : 0;
2067        committer = git_committer_info(0);
2068        maxlen = strlen(committer) + msglen + 100;
2069        logrec = xmalloc(maxlen);
2070        len = sprintf(logrec, "%s %s %s\n",
2071                      sha1_to_hex(old_sha1),
2072                      sha1_to_hex(new_sha1),
2073                      committer);
2074        if (msglen)
2075                len += copy_msg(logrec + len - 1, msg) - 1;
2076        written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2077        free(logrec);
2078        if (close(logfd) != 0 || written != len)
2079                return error("Unable to append to %s", log_file);
2080        return 0;
2081}
2082
2083static int is_branch(const char *refname)
2084{
2085        return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
2086}
2087
2088int write_ref_sha1(struct ref_lock *lock,
2089        const unsigned char *sha1, const char *logmsg)
2090{
2091        static char term = '\n';
2092        struct object *o;
2093
2094        if (!lock)
2095                return -1;
2096        if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2097                unlock_ref(lock);
2098                return 0;
2099        }
2100        o = parse_object(sha1);
2101        if (!o) {
2102                error("Trying to write ref %s with nonexistent object %s",
2103                        lock->ref_name, sha1_to_hex(sha1));
2104                unlock_ref(lock);
2105                return -1;
2106        }
2107        if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2108                error("Trying to write non-commit object %s to branch %s",
2109                        sha1_to_hex(sha1), lock->ref_name);
2110                unlock_ref(lock);
2111                return -1;
2112        }
2113        if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2114            write_in_full(lock->lock_fd, &term, 1) != 1
2115                || close_ref(lock) < 0) {
2116                error("Couldn't write %s", lock->lk->filename);
2117                unlock_ref(lock);
2118                return -1;
2119        }
2120        clear_loose_ref_cache(get_ref_cache(NULL));
2121        if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2122            (strcmp(lock->ref_name, lock->orig_ref_name) &&
2123             log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2124                unlock_ref(lock);
2125                return -1;
2126        }
2127        if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2128                /*
2129                 * Special hack: If a branch is updated directly and HEAD
2130                 * points to it (may happen on the remote side of a push
2131                 * for example) then logically the HEAD reflog should be
2132                 * updated too.
2133                 * A generic solution implies reverse symref information,
2134                 * but finding all symrefs pointing to the given branch
2135                 * would be rather costly for this rare event (the direct
2136                 * update of a branch) to be worth it.  So let's cheat and
2137                 * check with HEAD only which should cover 99% of all usage
2138                 * scenarios (even 100% of the default ones).
2139                 */
2140                unsigned char head_sha1[20];
2141                int head_flag;
2142                const char *head_ref;
2143                head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2144                if (head_ref && (head_flag & REF_ISSYMREF) &&
2145                    !strcmp(head_ref, lock->ref_name))
2146                        log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2147        }
2148        if (commit_ref(lock)) {
2149                error("Couldn't set %s", lock->ref_name);
2150                unlock_ref(lock);
2151                return -1;
2152        }
2153        unlock_ref(lock);
2154        return 0;
2155}
2156
2157int create_symref(const char *ref_target, const char *refs_heads_master,
2158                  const char *logmsg)
2159{
2160        const char *lockpath;
2161        char ref[1000];
2162        int fd, len, written;
2163        char *git_HEAD = git_pathdup("%s", ref_target);
2164        unsigned char old_sha1[20], new_sha1[20];
2165
2166        if (logmsg && read_ref(ref_target, old_sha1))
2167                hashclr(old_sha1);
2168
2169        if (safe_create_leading_directories(git_HEAD) < 0)
2170                return error("unable to create directory for %s", git_HEAD);
2171
2172#ifndef NO_SYMLINK_HEAD
2173        if (prefer_symlink_refs) {
2174                unlink(git_HEAD);
2175                if (!symlink(refs_heads_master, git_HEAD))
2176                        goto done;
2177                fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2178        }
2179#endif
2180
2181        len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2182        if (sizeof(ref) <= len) {
2183                error("refname too long: %s", refs_heads_master);
2184                goto error_free_return;
2185        }
2186        lockpath = mkpath("%s.lock", git_HEAD);
2187        fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2188        if (fd < 0) {
2189                error("Unable to open %s for writing", lockpath);
2190                goto error_free_return;
2191        }
2192        written = write_in_full(fd, ref, len);
2193        if (close(fd) != 0 || written != len) {
2194                error("Unable to write to %s", lockpath);
2195                goto error_unlink_return;
2196        }
2197        if (rename(lockpath, git_HEAD) < 0) {
2198                error("Unable to create %s", git_HEAD);
2199                goto error_unlink_return;
2200        }
2201        if (adjust_shared_perm(git_HEAD)) {
2202                error("Unable to fix permissions on %s", lockpath);
2203        error_unlink_return:
2204                unlink_or_warn(lockpath);
2205        error_free_return:
2206                free(git_HEAD);
2207                return -1;
2208        }
2209
2210#ifndef NO_SYMLINK_HEAD
2211        done:
2212#endif
2213        if (logmsg && !read_ref(refs_heads_master, new_sha1))
2214                log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2215
2216        free(git_HEAD);
2217        return 0;
2218}
2219
2220static char *ref_msg(const char *line, const char *endp)
2221{
2222        const char *ep;
2223        line += 82;
2224        ep = memchr(line, '\n', endp - line);
2225        if (!ep)
2226                ep = endp;
2227        return xmemdupz(line, ep - line);
2228}
2229
2230int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2231                unsigned char *sha1, char **msg,
2232                unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2233{
2234        const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2235        char *tz_c;
2236        int logfd, tz, reccnt = 0;
2237        struct stat st;
2238        unsigned long date;
2239        unsigned char logged_sha1[20];
2240        void *log_mapped;
2241        size_t mapsz;
2242
2243        logfile = git_path("logs/%s", refname);
2244        logfd = open(logfile, O_RDONLY, 0);
2245        if (logfd < 0)
2246                die_errno("Unable to read log '%s'", logfile);
2247        fstat(logfd, &st);
2248        if (!st.st_size)
2249                die("Log %s is empty.", logfile);
2250        mapsz = xsize_t(st.st_size);
2251        log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2252        logdata = log_mapped;
2253        close(logfd);
2254
2255        lastrec = NULL;
2256        rec = logend = logdata + st.st_size;
2257        while (logdata < rec) {
2258                reccnt++;
2259                if (logdata < rec && *(rec-1) == '\n')
2260                        rec--;
2261                lastgt = NULL;
2262                while (logdata < rec && *(rec-1) != '\n') {
2263                        rec--;
2264                        if (*rec == '>')
2265                                lastgt = rec;
2266                }
2267                if (!lastgt)
2268                        die("Log %s is corrupt.", logfile);
2269                date = strtoul(lastgt + 1, &tz_c, 10);
2270                if (date <= at_time || cnt == 0) {
2271                        tz = strtoul(tz_c, NULL, 10);
2272                        if (msg)
2273                                *msg = ref_msg(rec, logend);
2274                        if (cutoff_time)
2275                                *cutoff_time = date;
2276                        if (cutoff_tz)
2277                                *cutoff_tz = tz;
2278                        if (cutoff_cnt)
2279                                *cutoff_cnt = reccnt - 1;
2280                        if (lastrec) {
2281                                if (get_sha1_hex(lastrec, logged_sha1))
2282                                        die("Log %s is corrupt.", logfile);
2283                                if (get_sha1_hex(rec + 41, sha1))
2284                                        die("Log %s is corrupt.", logfile);
2285                                if (hashcmp(logged_sha1, sha1)) {
2286                                        warning("Log %s has gap after %s.",
2287                                                logfile, show_date(date, tz, DATE_RFC2822));
2288                                }
2289                        }
2290                        else if (date == at_time) {
2291                                if (get_sha1_hex(rec + 41, sha1))
2292                                        die("Log %s is corrupt.", logfile);
2293                        }
2294                        else {
2295                                if (get_sha1_hex(rec + 41, logged_sha1))
2296                                        die("Log %s is corrupt.", logfile);
2297                                if (hashcmp(logged_sha1, sha1)) {
2298                                        warning("Log %s unexpectedly ended on %s.",
2299                                                logfile, show_date(date, tz, DATE_RFC2822));
2300                                }
2301                        }
2302                        munmap(log_mapped, mapsz);
2303                        return 0;
2304                }
2305                lastrec = rec;
2306                if (cnt > 0)
2307                        cnt--;
2308        }
2309
2310        rec = logdata;
2311        while (rec < logend && *rec != '>' && *rec != '\n')
2312                rec++;
2313        if (rec == logend || *rec == '\n')
2314                die("Log %s is corrupt.", logfile);
2315        date = strtoul(rec + 1, &tz_c, 10);
2316        tz = strtoul(tz_c, NULL, 10);
2317        if (get_sha1_hex(logdata, sha1))
2318                die("Log %s is corrupt.", logfile);
2319        if (is_null_sha1(sha1)) {
2320                if (get_sha1_hex(logdata + 41, sha1))
2321                        die("Log %s is corrupt.", logfile);
2322        }
2323        if (msg)
2324                *msg = ref_msg(logdata, logend);
2325        munmap(log_mapped, mapsz);
2326
2327        if (cutoff_time)
2328                *cutoff_time = date;
2329        if (cutoff_tz)
2330                *cutoff_tz = tz;
2331        if (cutoff_cnt)
2332                *cutoff_cnt = reccnt;
2333        return 1;
2334}
2335
2336int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2337{
2338        const char *logfile;
2339        FILE *logfp;
2340        struct strbuf sb = STRBUF_INIT;
2341        int ret = 0;
2342
2343        logfile = git_path("logs/%s", refname);
2344        logfp = fopen(logfile, "r");
2345        if (!logfp)
2346                return -1;
2347
2348        if (ofs) {
2349                struct stat statbuf;
2350                if (fstat(fileno(logfp), &statbuf) ||
2351                    statbuf.st_size < ofs ||
2352                    fseek(logfp, -ofs, SEEK_END) ||
2353                    strbuf_getwholeline(&sb, logfp, '\n')) {
2354                        fclose(logfp);
2355                        strbuf_release(&sb);
2356                        return -1;
2357                }
2358        }
2359
2360        while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2361                unsigned char osha1[20], nsha1[20];
2362                char *email_end, *message;
2363                unsigned long timestamp;
2364                int tz;
2365
2366                /* old SP new SP name <email> SP time TAB msg LF */
2367                if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
2368                    get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
2369                    get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
2370                    !(email_end = strchr(sb.buf + 82, '>')) ||
2371                    email_end[1] != ' ' ||
2372                    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
2373                    !message || message[0] != ' ' ||
2374                    (message[1] != '+' && message[1] != '-') ||
2375                    !isdigit(message[2]) || !isdigit(message[3]) ||
2376                    !isdigit(message[4]) || !isdigit(message[5]))
2377                        continue; /* corrupt? */
2378                email_end[1] = '\0';
2379                tz = strtol(message + 1, NULL, 10);
2380                if (message[6] != '\t')
2381                        message += 6;
2382                else
2383                        message += 7;
2384                ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
2385                         cb_data);
2386                if (ret)
2387                        break;
2388        }
2389        fclose(logfp);
2390        strbuf_release(&sb);
2391        return ret;
2392}
2393
2394int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2395{
2396        return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2397}
2398
2399/*
2400 * Call fn for each reflog in the namespace indicated by name.  name
2401 * must be empty or end with '/'.  Name will be used as a scratch
2402 * space, but its contents will be restored before return.
2403 */
2404static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
2405{
2406        DIR *d = opendir(git_path("logs/%s", name->buf));
2407        int retval = 0;
2408        struct dirent *de;
2409        int oldlen = name->len;
2410
2411        if (!d)
2412                return name->len ? errno : 0;
2413
2414        while ((de = readdir(d)) != NULL) {
2415                struct stat st;
2416
2417                if (de->d_name[0] == '.')
2418                        continue;
2419                if (has_extension(de->d_name, ".lock"))
2420                        continue;
2421                strbuf_addstr(name, de->d_name);
2422                if (stat(git_path("logs/%s", name->buf), &st) < 0) {
2423                        ; /* silently ignore */
2424                } else {
2425                        if (S_ISDIR(st.st_mode)) {
2426                                strbuf_addch(name, '/');
2427                                retval = do_for_each_reflog(name, fn, cb_data);
2428                        } else {
2429                                unsigned char sha1[20];
2430                                if (read_ref_full(name->buf, sha1, 0, NULL))
2431                                        retval = error("bad ref for %s", name->buf);
2432                                else
2433                                        retval = fn(name->buf, sha1, 0, cb_data);
2434                        }
2435                        if (retval)
2436                                break;
2437                }
2438                strbuf_setlen(name, oldlen);
2439        }
2440        closedir(d);
2441        return retval;
2442}
2443
2444int for_each_reflog(each_ref_fn fn, void *cb_data)
2445{
2446        int retval;
2447        struct strbuf name;
2448        strbuf_init(&name, PATH_MAX);
2449        retval = do_for_each_reflog(&name, fn, cb_data);
2450        strbuf_release(&name);
2451        return retval;
2452}
2453
2454int update_ref(const char *action, const char *refname,
2455                const unsigned char *sha1, const unsigned char *oldval,
2456                int flags, enum action_on_err onerr)
2457{
2458        static struct ref_lock *lock;
2459        lock = lock_any_ref_for_update(refname, oldval, flags);
2460        if (!lock) {
2461                const char *str = "Cannot lock the ref '%s'.";
2462                switch (onerr) {
2463                case MSG_ON_ERR: error(str, refname); break;
2464                case DIE_ON_ERR: die(str, refname); break;
2465                case QUIET_ON_ERR: break;
2466                }
2467                return 1;
2468        }
2469        if (write_ref_sha1(lock, sha1, action) < 0) {
2470                const char *str = "Cannot update the ref '%s'.";
2471                switch (onerr) {
2472                case MSG_ON_ERR: error(str, refname); break;
2473                case DIE_ON_ERR: die(str, refname); break;
2474                case QUIET_ON_ERR: break;
2475                }
2476                return 1;
2477        }
2478        return 0;
2479}
2480
2481struct ref *find_ref_by_name(const struct ref *list, const char *name)
2482{
2483        for ( ; list; list = list->next)
2484                if (!strcmp(list->name, name))
2485                        return (struct ref *)list;
2486        return NULL;
2487}
2488
2489/*
2490 * generate a format suitable for scanf from a ref_rev_parse_rules
2491 * rule, that is replace the "%.*s" spec with a "%s" spec
2492 */
2493static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2494{
2495        char *spec;
2496
2497        spec = strstr(rule, "%.*s");
2498        if (!spec || strstr(spec + 4, "%.*s"))
2499                die("invalid rule in ref_rev_parse_rules: %s", rule);
2500
2501        /* copy all until spec */
2502        strncpy(scanf_fmt, rule, spec - rule);
2503        scanf_fmt[spec - rule] = '\0';
2504        /* copy new spec */
2505        strcat(scanf_fmt, "%s");
2506        /* copy remaining rule */
2507        strcat(scanf_fmt, spec + 4);
2508
2509        return;
2510}
2511
2512char *shorten_unambiguous_ref(const char *refname, int strict)
2513{
2514        int i;
2515        static char **scanf_fmts;
2516        static int nr_rules;
2517        char *short_name;
2518
2519        /* pre generate scanf formats from ref_rev_parse_rules[] */
2520        if (!nr_rules) {
2521                size_t total_len = 0;
2522
2523                /* the rule list is NULL terminated, count them first */
2524                for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2525                        /* no +1 because strlen("%s") < strlen("%.*s") */
2526                        total_len += strlen(ref_rev_parse_rules[nr_rules]);
2527
2528                scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2529
2530                total_len = 0;
2531                for (i = 0; i < nr_rules; i++) {
2532                        scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2533                                        + total_len;
2534                        gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2535                        total_len += strlen(ref_rev_parse_rules[i]);
2536                }
2537        }
2538
2539        /* bail out if there are no rules */
2540        if (!nr_rules)
2541                return xstrdup(refname);
2542
2543        /* buffer for scanf result, at most refname must fit */
2544        short_name = xstrdup(refname);
2545
2546        /* skip first rule, it will always match */
2547        for (i = nr_rules - 1; i > 0 ; --i) {
2548                int j;
2549                int rules_to_fail = i;
2550                int short_name_len;
2551
2552                if (1 != sscanf(refname, scanf_fmts[i], short_name))
2553                        continue;
2554
2555                short_name_len = strlen(short_name);
2556
2557                /*
2558                 * in strict mode, all (except the matched one) rules
2559                 * must fail to resolve to a valid non-ambiguous ref
2560                 */
2561                if (strict)
2562                        rules_to_fail = nr_rules;
2563
2564                /*
2565                 * check if the short name resolves to a valid ref,
2566                 * but use only rules prior to the matched one
2567                 */
2568                for (j = 0; j < rules_to_fail; j++) {
2569                        const char *rule = ref_rev_parse_rules[j];
2570                        char refname[PATH_MAX];
2571
2572                        /* skip matched rule */
2573                        if (i == j)
2574                                continue;
2575
2576                        /*
2577                         * the short name is ambiguous, if it resolves
2578                         * (with this previous rule) to a valid ref
2579                         * read_ref() returns 0 on success
2580                         */
2581                        mksnpath(refname, sizeof(refname),
2582                                 rule, short_name_len, short_name);
2583                        if (ref_exists(refname))
2584                                break;
2585                }
2586
2587                /*
2588                 * short name is non-ambiguous if all previous rules
2589                 * haven't resolved to a valid ref
2590                 */
2591                if (j == rules_to_fail)
2592                        return short_name;
2593        }
2594
2595        free(short_name);
2596        return xstrdup(refname);
2597}