refs.con commit Update draft release notes to 1.7.9 (876a6f4)
   1#include "cache.h"
   2#include "refs.h"
   3#include "object.h"
   4#include "tag.h"
   5#include "dir.h"
   6
   7/* ISSYMREF=0x01, ISPACKED=0x02 and ISBROKEN=0x04 are public interfaces */
   8#define REF_KNOWS_PEELED 0x10
   9
  10struct ref_entry {
  11        unsigned char flag; /* ISSYMREF? ISPACKED? */
  12        unsigned char sha1[20];
  13        unsigned char peeled[20];
  14        char name[FLEX_ARRAY];
  15};
  16
  17struct ref_array {
  18        int nr, alloc;
  19        struct ref_entry **refs;
  20};
  21
  22static const char *parse_ref_line(char *line, unsigned char *sha1)
  23{
  24        /*
  25         * 42: the answer to everything.
  26         *
  27         * In this case, it happens to be the answer to
  28         *  40 (length of sha1 hex representation)
  29         *  +1 (space in between hex and name)
  30         *  +1 (newline at the end of the line)
  31         */
  32        int len = strlen(line) - 42;
  33
  34        if (len <= 0)
  35                return NULL;
  36        if (get_sha1_hex(line, sha1) < 0)
  37                return NULL;
  38        if (!isspace(line[40]))
  39                return NULL;
  40        line += 41;
  41        if (isspace(*line))
  42                return NULL;
  43        if (line[len] != '\n')
  44                return NULL;
  45        line[len] = 0;
  46
  47        return line;
  48}
  49
  50static void add_ref(const char *name, const unsigned char *sha1,
  51                    int flag, int check_name, struct ref_array *refs,
  52                    struct ref_entry **new_entry)
  53{
  54        int len;
  55        struct ref_entry *entry;
  56
  57        /* Allocate it and add it in.. */
  58        len = strlen(name) + 1;
  59        entry = xmalloc(sizeof(struct ref_entry) + len);
  60        hashcpy(entry->sha1, sha1);
  61        hashclr(entry->peeled);
  62        if (check_name &&
  63            check_refname_format(name, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
  64                die("Reference has invalid format: '%s'", name);
  65        memcpy(entry->name, name, len);
  66        entry->flag = flag;
  67        if (new_entry)
  68                *new_entry = entry;
  69        ALLOC_GROW(refs->refs, refs->nr + 1, refs->alloc);
  70        refs->refs[refs->nr++] = entry;
  71}
  72
  73static int ref_entry_cmp(const void *a, const void *b)
  74{
  75        struct ref_entry *one = *(struct ref_entry **)a;
  76        struct ref_entry *two = *(struct ref_entry **)b;
  77        return strcmp(one->name, two->name);
  78}
  79
  80static void sort_ref_array(struct ref_array *array)
  81{
  82        int i = 0, j = 1;
  83
  84        /* Nothing to sort unless there are at least two entries */
  85        if (array->nr < 2)
  86                return;
  87
  88        qsort(array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
  89
  90        /* Remove any duplicates from the ref_array */
  91        for (; j < array->nr; j++) {
  92                struct ref_entry *a = array->refs[i];
  93                struct ref_entry *b = array->refs[j];
  94                if (!strcmp(a->name, b->name)) {
  95                        if (hashcmp(a->sha1, b->sha1))
  96                                die("Duplicated ref, and SHA1s don't match: %s",
  97                                    a->name);
  98                        warning("Duplicated ref: %s", a->name);
  99                        free(b);
 100                        continue;
 101                }
 102                i++;
 103                array->refs[i] = array->refs[j];
 104        }
 105        array->nr = i + 1;
 106}
 107
 108static struct ref_entry *search_ref_array(struct ref_array *array, const char *name)
 109{
 110        struct ref_entry *e, **r;
 111        int len;
 112
 113        if (name == NULL)
 114                return NULL;
 115
 116        if (!array->nr)
 117                return NULL;
 118
 119        len = strlen(name) + 1;
 120        e = xmalloc(sizeof(struct ref_entry) + len);
 121        memcpy(e->name, name, len);
 122
 123        r = bsearch(&e, array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
 124
 125        free(e);
 126
 127        if (r == NULL)
 128                return NULL;
 129
 130        return *r;
 131}
 132
 133/*
 134 * Future: need to be in "struct repository"
 135 * when doing a full libification.
 136 */
 137static struct ref_cache {
 138        struct ref_cache *next;
 139        char did_loose;
 140        char did_packed;
 141        struct ref_array loose;
 142        struct ref_array packed;
 143        /* The submodule name, or "" for the main repo. */
 144        char name[FLEX_ARRAY];
 145} *ref_cache;
 146
 147static struct ref_entry *current_ref;
 148
 149static struct ref_array extra_refs;
 150
 151static void free_ref_array(struct ref_array *array)
 152{
 153        int i;
 154        for (i = 0; i < array->nr; i++)
 155                free(array->refs[i]);
 156        free(array->refs);
 157        array->nr = array->alloc = 0;
 158        array->refs = NULL;
 159}
 160
 161static void clear_packed_ref_cache(struct ref_cache *refs)
 162{
 163        if (refs->did_packed)
 164                free_ref_array(&refs->packed);
 165        refs->did_packed = 0;
 166}
 167
 168static void clear_loose_ref_cache(struct ref_cache *refs)
 169{
 170        if (refs->did_loose)
 171                free_ref_array(&refs->loose);
 172        refs->did_loose = 0;
 173}
 174
 175static struct ref_cache *create_ref_cache(const char *submodule)
 176{
 177        int len;
 178        struct ref_cache *refs;
 179        if (!submodule)
 180                submodule = "";
 181        len = strlen(submodule) + 1;
 182        refs = xcalloc(1, sizeof(struct ref_cache) + len);
 183        memcpy(refs->name, submodule, len);
 184        return refs;
 185}
 186
 187/*
 188 * Return a pointer to a ref_cache for the specified submodule. For
 189 * the main repository, use submodule==NULL. The returned structure
 190 * will be allocated and initialized but not necessarily populated; it
 191 * should not be freed.
 192 */
 193static struct ref_cache *get_ref_cache(const char *submodule)
 194{
 195        struct ref_cache *refs = ref_cache;
 196        if (!submodule)
 197                submodule = "";
 198        while (refs) {
 199                if (!strcmp(submodule, refs->name))
 200                        return refs;
 201                refs = refs->next;
 202        }
 203
 204        refs = create_ref_cache(submodule);
 205        refs->next = ref_cache;
 206        ref_cache = refs;
 207        return refs;
 208}
 209
 210void invalidate_ref_cache(const char *submodule)
 211{
 212        struct ref_cache *refs = get_ref_cache(submodule);
 213        clear_packed_ref_cache(refs);
 214        clear_loose_ref_cache(refs);
 215}
 216
 217static void read_packed_refs(FILE *f, struct ref_array *array)
 218{
 219        struct ref_entry *last = NULL;
 220        char refline[PATH_MAX];
 221        int flag = REF_ISPACKED;
 222
 223        while (fgets(refline, sizeof(refline), f)) {
 224                unsigned char sha1[20];
 225                const char *name;
 226                static const char header[] = "# pack-refs with:";
 227
 228                if (!strncmp(refline, header, sizeof(header)-1)) {
 229                        const char *traits = refline + sizeof(header) - 1;
 230                        if (strstr(traits, " peeled "))
 231                                flag |= REF_KNOWS_PEELED;
 232                        /* perhaps other traits later as well */
 233                        continue;
 234                }
 235
 236                name = parse_ref_line(refline, sha1);
 237                if (name) {
 238                        add_ref(name, sha1, flag, 1, array, &last);
 239                        continue;
 240                }
 241                if (last &&
 242                    refline[0] == '^' &&
 243                    strlen(refline) == 42 &&
 244                    refline[41] == '\n' &&
 245                    !get_sha1_hex(refline + 1, sha1))
 246                        hashcpy(last->peeled, sha1);
 247        }
 248        sort_ref_array(array);
 249}
 250
 251void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
 252{
 253        add_ref(name, sha1, flag, 0, &extra_refs, NULL);
 254}
 255
 256void clear_extra_refs(void)
 257{
 258        free_ref_array(&extra_refs);
 259}
 260
 261static struct ref_array *get_packed_refs(const char *submodule)
 262{
 263        struct ref_cache *refs = get_ref_cache(submodule);
 264
 265        if (!refs->did_packed) {
 266                const char *packed_refs_file;
 267                FILE *f;
 268
 269                if (submodule)
 270                        packed_refs_file = git_path_submodule(submodule, "packed-refs");
 271                else
 272                        packed_refs_file = git_path("packed-refs");
 273                f = fopen(packed_refs_file, "r");
 274                if (f) {
 275                        read_packed_refs(f, &refs->packed);
 276                        fclose(f);
 277                }
 278                refs->did_packed = 1;
 279        }
 280        return &refs->packed;
 281}
 282
 283static void get_ref_dir(const char *submodule, const char *base,
 284                        struct ref_array *array)
 285{
 286        DIR *dir;
 287        const char *path;
 288
 289        if (submodule)
 290                path = git_path_submodule(submodule, "%s", base);
 291        else
 292                path = git_path("%s", base);
 293
 294
 295        dir = opendir(path);
 296
 297        if (dir) {
 298                struct dirent *de;
 299                int baselen = strlen(base);
 300                char *ref = xmalloc(baselen + 257);
 301
 302                memcpy(ref, base, baselen);
 303                if (baselen && base[baselen-1] != '/')
 304                        ref[baselen++] = '/';
 305
 306                while ((de = readdir(dir)) != NULL) {
 307                        unsigned char sha1[20];
 308                        struct stat st;
 309                        int flag;
 310                        int namelen;
 311                        const char *refdir;
 312
 313                        if (de->d_name[0] == '.')
 314                                continue;
 315                        namelen = strlen(de->d_name);
 316                        if (namelen > 255)
 317                                continue;
 318                        if (has_extension(de->d_name, ".lock"))
 319                                continue;
 320                        memcpy(ref + baselen, de->d_name, namelen+1);
 321                        refdir = submodule
 322                                ? git_path_submodule(submodule, "%s", ref)
 323                                : git_path("%s", ref);
 324                        if (stat(refdir, &st) < 0)
 325                                continue;
 326                        if (S_ISDIR(st.st_mode)) {
 327                                get_ref_dir(submodule, ref, array);
 328                                continue;
 329                        }
 330                        if (submodule) {
 331                                hashclr(sha1);
 332                                flag = 0;
 333                                if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
 334                                        hashclr(sha1);
 335                                        flag |= REF_ISBROKEN;
 336                                }
 337                        } else if (read_ref_full(ref, sha1, 1, &flag)) {
 338                                hashclr(sha1);
 339                                flag |= REF_ISBROKEN;
 340                        }
 341                        add_ref(ref, sha1, flag, 1, array, NULL);
 342                }
 343                free(ref);
 344                closedir(dir);
 345        }
 346}
 347
 348struct warn_if_dangling_data {
 349        FILE *fp;
 350        const char *refname;
 351        const char *msg_fmt;
 352};
 353
 354static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
 355                                   int flags, void *cb_data)
 356{
 357        struct warn_if_dangling_data *d = cb_data;
 358        const char *resolves_to;
 359        unsigned char junk[20];
 360
 361        if (!(flags & REF_ISSYMREF))
 362                return 0;
 363
 364        resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
 365        if (!resolves_to || strcmp(resolves_to, d->refname))
 366                return 0;
 367
 368        fprintf(d->fp, d->msg_fmt, refname);
 369        return 0;
 370}
 371
 372void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
 373{
 374        struct warn_if_dangling_data data;
 375
 376        data.fp = fp;
 377        data.refname = refname;
 378        data.msg_fmt = msg_fmt;
 379        for_each_rawref(warn_if_dangling_symref, &data);
 380}
 381
 382static struct ref_array *get_loose_refs(const char *submodule)
 383{
 384        struct ref_cache *refs = get_ref_cache(submodule);
 385
 386        if (!refs->did_loose) {
 387                get_ref_dir(submodule, "refs", &refs->loose);
 388                sort_ref_array(&refs->loose);
 389                refs->did_loose = 1;
 390        }
 391        return &refs->loose;
 392}
 393
 394/* We allow "recursive" symbolic refs. Only within reason, though */
 395#define MAXDEPTH 5
 396#define MAXREFLEN (1024)
 397
 398/*
 399 * Called by resolve_gitlink_ref_recursive() after it failed to read
 400 * from "name", which is "module/.git/<refname>". Find <refname> in
 401 * the packed-refs file for the submodule.
 402 */
 403static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
 404{
 405        int retval = -1;
 406        struct ref_entry *ref;
 407        struct ref_array *array;
 408
 409        /* being defensive: resolve_gitlink_ref() did this for us */
 410        if (pathlen < 6 || memcmp(name + pathlen - 6, "/.git/", 6))
 411                die("Oops");
 412        name[pathlen - 6] = '\0'; /* make it path to the submodule */
 413        array = get_packed_refs(name);
 414        ref = search_ref_array(array, refname);
 415        if (ref != NULL) {
 416                memcpy(result, ref->sha1, 20);
 417                retval = 0;
 418        }
 419        return retval;
 420}
 421
 422static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
 423{
 424        int fd, len = strlen(refname);
 425        char buffer[128], *p;
 426
 427        if (recursion > MAXDEPTH || len > MAXREFLEN)
 428                return -1;
 429        memcpy(name + pathlen, refname, len+1);
 430        fd = open(name, O_RDONLY);
 431        if (fd < 0)
 432                return resolve_gitlink_packed_ref(name, pathlen, refname, result);
 433
 434        len = read(fd, buffer, sizeof(buffer)-1);
 435        close(fd);
 436        if (len < 0)
 437                return -1;
 438        while (len && isspace(buffer[len-1]))
 439                len--;
 440        buffer[len] = 0;
 441
 442        /* Was it a detached head or an old-fashioned symlink? */
 443        if (!get_sha1_hex(buffer, result))
 444                return 0;
 445
 446        /* Symref? */
 447        if (strncmp(buffer, "ref:", 4))
 448                return -1;
 449        p = buffer + 4;
 450        while (isspace(*p))
 451                p++;
 452
 453        return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
 454}
 455
 456int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
 457{
 458        int len = strlen(path), retval;
 459        char *gitdir;
 460        const char *tmp;
 461
 462        while (len && path[len-1] == '/')
 463                len--;
 464        if (!len)
 465                return -1;
 466        gitdir = xmalloc(len + MAXREFLEN + 8);
 467        memcpy(gitdir, path, len);
 468        memcpy(gitdir + len, "/.git", 6);
 469        len += 5;
 470
 471        tmp = read_gitfile(gitdir);
 472        if (tmp) {
 473                free(gitdir);
 474                len = strlen(tmp);
 475                gitdir = xmalloc(len + MAXREFLEN + 3);
 476                memcpy(gitdir, tmp, len);
 477        }
 478        gitdir[len] = '/';
 479        gitdir[++len] = '\0';
 480        retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
 481        free(gitdir);
 482        return retval;
 483}
 484
 485/*
 486 * Try to read ref from the packed references.  On success, set sha1
 487 * and return 0; otherwise, return -1.
 488 */
 489static int get_packed_ref(const char *ref, unsigned char *sha1)
 490{
 491        struct ref_array *packed = get_packed_refs(NULL);
 492        struct ref_entry *entry = search_ref_array(packed, ref);
 493        if (entry) {
 494                hashcpy(sha1, entry->sha1);
 495                return 0;
 496        }
 497        return -1;
 498}
 499
 500const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag)
 501{
 502        int depth = MAXDEPTH;
 503        ssize_t len;
 504        char buffer[256];
 505        static char ref_buffer[256];
 506
 507        if (flag)
 508                *flag = 0;
 509
 510        if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
 511                return NULL;
 512
 513        for (;;) {
 514                char path[PATH_MAX];
 515                struct stat st;
 516                char *buf;
 517                int fd;
 518
 519                if (--depth < 0)
 520                        return NULL;
 521
 522                git_snpath(path, sizeof(path), "%s", ref);
 523
 524                if (lstat(path, &st) < 0) {
 525                        if (errno != ENOENT)
 526                                return NULL;
 527                        /*
 528                         * The loose reference file does not exist;
 529                         * check for a packed reference.
 530                         */
 531                        if (!get_packed_ref(ref, sha1)) {
 532                                if (flag)
 533                                        *flag |= REF_ISPACKED;
 534                                return ref;
 535                        }
 536                        /* The reference is not a packed reference, either. */
 537                        if (reading) {
 538                                return NULL;
 539                        } else {
 540                                hashclr(sha1);
 541                                return ref;
 542                        }
 543                }
 544
 545                /* Follow "normalized" - ie "refs/.." symlinks by hand */
 546                if (S_ISLNK(st.st_mode)) {
 547                        len = readlink(path, buffer, sizeof(buffer)-1);
 548                        if (len < 0)
 549                                return NULL;
 550                        buffer[len] = 0;
 551                        if (!prefixcmp(buffer, "refs/") &&
 552                                        !check_refname_format(buffer, 0)) {
 553                                strcpy(ref_buffer, buffer);
 554                                ref = ref_buffer;
 555                                if (flag)
 556                                        *flag |= REF_ISSYMREF;
 557                                continue;
 558                        }
 559                }
 560
 561                /* Is it a directory? */
 562                if (S_ISDIR(st.st_mode)) {
 563                        errno = EISDIR;
 564                        return NULL;
 565                }
 566
 567                /*
 568                 * Anything else, just open it and try to use it as
 569                 * a ref
 570                 */
 571                fd = open(path, O_RDONLY);
 572                if (fd < 0)
 573                        return NULL;
 574                len = read_in_full(fd, buffer, sizeof(buffer)-1);
 575                close(fd);
 576                if (len < 0)
 577                        return NULL;
 578                while (len && isspace(buffer[len-1]))
 579                        len--;
 580                buffer[len] = '\0';
 581
 582                /*
 583                 * Is it a symbolic ref?
 584                 */
 585                if (prefixcmp(buffer, "ref:"))
 586                        break;
 587                if (flag)
 588                        *flag |= REF_ISSYMREF;
 589                buf = buffer + 4;
 590                while (isspace(*buf))
 591                        buf++;
 592                if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
 593                        if (flag)
 594                                *flag |= REF_ISBROKEN;
 595                        return NULL;
 596                }
 597                ref = strcpy(ref_buffer, buf);
 598        }
 599        /* Please note that FETCH_HEAD has a second line containing other data. */
 600        if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
 601                if (flag)
 602                        *flag |= REF_ISBROKEN;
 603                return NULL;
 604        }
 605        return ref;
 606}
 607
 608char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
 609{
 610        const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
 611        return ret ? xstrdup(ret) : NULL;
 612}
 613
 614/* The argument to filter_refs */
 615struct ref_filter {
 616        const char *pattern;
 617        each_ref_fn *fn;
 618        void *cb_data;
 619};
 620
 621int read_ref_full(const char *ref, unsigned char *sha1, int reading, int *flags)
 622{
 623        if (resolve_ref_unsafe(ref, sha1, reading, flags))
 624                return 0;
 625        return -1;
 626}
 627
 628int read_ref(const char *ref, unsigned char *sha1)
 629{
 630        return read_ref_full(ref, sha1, 1, NULL);
 631}
 632
 633#define DO_FOR_EACH_INCLUDE_BROKEN 01
 634static int do_one_ref(const char *base, each_ref_fn fn, int trim,
 635                      int flags, void *cb_data, struct ref_entry *entry)
 636{
 637        if (prefixcmp(entry->name, base))
 638                return 0;
 639
 640        if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
 641                if (entry->flag & REF_ISBROKEN)
 642                        return 0; /* ignore broken refs e.g. dangling symref */
 643                if (!has_sha1_file(entry->sha1)) {
 644                        error("%s does not point to a valid object!", entry->name);
 645                        return 0;
 646                }
 647        }
 648        current_ref = entry;
 649        return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
 650}
 651
 652static int filter_refs(const char *ref, const unsigned char *sha, int flags,
 653        void *data)
 654{
 655        struct ref_filter *filter = (struct ref_filter *)data;
 656        if (fnmatch(filter->pattern, ref, 0))
 657                return 0;
 658        return filter->fn(ref, sha, flags, filter->cb_data);
 659}
 660
 661int peel_ref(const char *ref, unsigned char *sha1)
 662{
 663        int flag;
 664        unsigned char base[20];
 665        struct object *o;
 666
 667        if (current_ref && (current_ref->name == ref
 668                || !strcmp(current_ref->name, ref))) {
 669                if (current_ref->flag & REF_KNOWS_PEELED) {
 670                        hashcpy(sha1, current_ref->peeled);
 671                        return 0;
 672                }
 673                hashcpy(base, current_ref->sha1);
 674                goto fallback;
 675        }
 676
 677        if (read_ref_full(ref, base, 1, &flag))
 678                return -1;
 679
 680        if ((flag & REF_ISPACKED)) {
 681                struct ref_array *array = get_packed_refs(NULL);
 682                struct ref_entry *r = search_ref_array(array, ref);
 683
 684                if (r != NULL && r->flag & REF_KNOWS_PEELED) {
 685                        hashcpy(sha1, r->peeled);
 686                        return 0;
 687                }
 688        }
 689
 690fallback:
 691        o = parse_object(base);
 692        if (o && o->type == OBJ_TAG) {
 693                o = deref_tag(o, ref, 0);
 694                if (o) {
 695                        hashcpy(sha1, o->sha1);
 696                        return 0;
 697                }
 698        }
 699        return -1;
 700}
 701
 702static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
 703                           int trim, int flags, void *cb_data)
 704{
 705        int retval = 0, i, p = 0, l = 0;
 706        struct ref_array *packed = get_packed_refs(submodule);
 707        struct ref_array *loose = get_loose_refs(submodule);
 708
 709        struct ref_array *extra = &extra_refs;
 710
 711        for (i = 0; i < extra->nr; i++)
 712                retval = do_one_ref(base, fn, trim, flags, cb_data, extra->refs[i]);
 713
 714        while (p < packed->nr && l < loose->nr) {
 715                struct ref_entry *entry;
 716                int cmp = strcmp(packed->refs[p]->name, loose->refs[l]->name);
 717                if (!cmp) {
 718                        p++;
 719                        continue;
 720                }
 721                if (cmp > 0) {
 722                        entry = loose->refs[l++];
 723                } else {
 724                        entry = packed->refs[p++];
 725                }
 726                retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
 727                if (retval)
 728                        goto end_each;
 729        }
 730
 731        if (l < loose->nr) {
 732                p = l;
 733                packed = loose;
 734        }
 735
 736        for (; p < packed->nr; p++) {
 737                retval = do_one_ref(base, fn, trim, flags, cb_data, packed->refs[p]);
 738                if (retval)
 739                        goto end_each;
 740        }
 741
 742end_each:
 743        current_ref = NULL;
 744        return retval;
 745}
 746
 747
 748static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
 749{
 750        unsigned char sha1[20];
 751        int flag;
 752
 753        if (submodule) {
 754                if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
 755                        return fn("HEAD", sha1, 0, cb_data);
 756
 757                return 0;
 758        }
 759
 760        if (!read_ref_full("HEAD", sha1, 1, &flag))
 761                return fn("HEAD", sha1, flag, cb_data);
 762
 763        return 0;
 764}
 765
 766int head_ref(each_ref_fn fn, void *cb_data)
 767{
 768        return do_head_ref(NULL, fn, cb_data);
 769}
 770
 771int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 772{
 773        return do_head_ref(submodule, fn, cb_data);
 774}
 775
 776int for_each_ref(each_ref_fn fn, void *cb_data)
 777{
 778        return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
 779}
 780
 781int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 782{
 783        return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
 784}
 785
 786int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
 787{
 788        return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
 789}
 790
 791int for_each_ref_in_submodule(const char *submodule, const char *prefix,
 792                each_ref_fn fn, void *cb_data)
 793{
 794        return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
 795}
 796
 797int for_each_tag_ref(each_ref_fn fn, void *cb_data)
 798{
 799        return for_each_ref_in("refs/tags/", fn, cb_data);
 800}
 801
 802int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 803{
 804        return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
 805}
 806
 807int for_each_branch_ref(each_ref_fn fn, void *cb_data)
 808{
 809        return for_each_ref_in("refs/heads/", fn, cb_data);
 810}
 811
 812int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 813{
 814        return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
 815}
 816
 817int for_each_remote_ref(each_ref_fn fn, void *cb_data)
 818{
 819        return for_each_ref_in("refs/remotes/", fn, cb_data);
 820}
 821
 822int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 823{
 824        return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
 825}
 826
 827int for_each_replace_ref(each_ref_fn fn, void *cb_data)
 828{
 829        return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
 830}
 831
 832int head_ref_namespaced(each_ref_fn fn, void *cb_data)
 833{
 834        struct strbuf buf = STRBUF_INIT;
 835        int ret = 0;
 836        unsigned char sha1[20];
 837        int flag;
 838
 839        strbuf_addf(&buf, "%sHEAD", get_git_namespace());
 840        if (!read_ref_full(buf.buf, sha1, 1, &flag))
 841                ret = fn(buf.buf, sha1, flag, cb_data);
 842        strbuf_release(&buf);
 843
 844        return ret;
 845}
 846
 847int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
 848{
 849        struct strbuf buf = STRBUF_INIT;
 850        int ret;
 851        strbuf_addf(&buf, "%srefs/", get_git_namespace());
 852        ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
 853        strbuf_release(&buf);
 854        return ret;
 855}
 856
 857int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
 858        const char *prefix, void *cb_data)
 859{
 860        struct strbuf real_pattern = STRBUF_INIT;
 861        struct ref_filter filter;
 862        int ret;
 863
 864        if (!prefix && prefixcmp(pattern, "refs/"))
 865                strbuf_addstr(&real_pattern, "refs/");
 866        else if (prefix)
 867                strbuf_addstr(&real_pattern, prefix);
 868        strbuf_addstr(&real_pattern, pattern);
 869
 870        if (!has_glob_specials(pattern)) {
 871                /* Append implied '/' '*' if not present. */
 872                if (real_pattern.buf[real_pattern.len - 1] != '/')
 873                        strbuf_addch(&real_pattern, '/');
 874                /* No need to check for '*', there is none. */
 875                strbuf_addch(&real_pattern, '*');
 876        }
 877
 878        filter.pattern = real_pattern.buf;
 879        filter.fn = fn;
 880        filter.cb_data = cb_data;
 881        ret = for_each_ref(filter_refs, &filter);
 882
 883        strbuf_release(&real_pattern);
 884        return ret;
 885}
 886
 887int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
 888{
 889        return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
 890}
 891
 892int for_each_rawref(each_ref_fn fn, void *cb_data)
 893{
 894        return do_for_each_ref(NULL, "", fn, 0,
 895                               DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
 896}
 897
 898/*
 899 * Make sure "ref" is something reasonable to have under ".git/refs/";
 900 * We do not like it if:
 901 *
 902 * - any path component of it begins with ".", or
 903 * - it has double dots "..", or
 904 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
 905 * - it ends with a "/".
 906 * - it ends with ".lock"
 907 * - it contains a "\" (backslash)
 908 */
 909
 910/* Return true iff ch is not allowed in reference names. */
 911static inline int bad_ref_char(int ch)
 912{
 913        if (((unsigned) ch) <= ' ' || ch == 0x7f ||
 914            ch == '~' || ch == '^' || ch == ':' || ch == '\\')
 915                return 1;
 916        /* 2.13 Pattern Matching Notation */
 917        if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
 918                return 1;
 919        return 0;
 920}
 921
 922/*
 923 * Try to read one refname component from the front of ref.  Return
 924 * the length of the component found, or -1 if the component is not
 925 * legal.
 926 */
 927static int check_refname_component(const char *ref, int flags)
 928{
 929        const char *cp;
 930        char last = '\0';
 931
 932        for (cp = ref; ; cp++) {
 933                char ch = *cp;
 934                if (ch == '\0' || ch == '/')
 935                        break;
 936                if (bad_ref_char(ch))
 937                        return -1; /* Illegal character in refname. */
 938                if (last == '.' && ch == '.')
 939                        return -1; /* Refname contains "..". */
 940                if (last == '@' && ch == '{')
 941                        return -1; /* Refname contains "@{". */
 942                last = ch;
 943        }
 944        if (cp == ref)
 945                return -1; /* Component has zero length. */
 946        if (ref[0] == '.') {
 947                if (!(flags & REFNAME_DOT_COMPONENT))
 948                        return -1; /* Component starts with '.'. */
 949                /*
 950                 * Even if leading dots are allowed, don't allow "."
 951                 * as a component (".." is prevented by a rule above).
 952                 */
 953                if (ref[1] == '\0')
 954                        return -1; /* Component equals ".". */
 955        }
 956        if (cp - ref >= 5 && !memcmp(cp - 5, ".lock", 5))
 957                return -1; /* Refname ends with ".lock". */
 958        return cp - ref;
 959}
 960
 961int check_refname_format(const char *ref, int flags)
 962{
 963        int component_len, component_count = 0;
 964
 965        while (1) {
 966                /* We are at the start of a path component. */
 967                component_len = check_refname_component(ref, flags);
 968                if (component_len < 0) {
 969                        if ((flags & REFNAME_REFSPEC_PATTERN) &&
 970                                        ref[0] == '*' &&
 971                                        (ref[1] == '\0' || ref[1] == '/')) {
 972                                /* Accept one wildcard as a full refname component. */
 973                                flags &= ~REFNAME_REFSPEC_PATTERN;
 974                                component_len = 1;
 975                        } else {
 976                                return -1;
 977                        }
 978                }
 979                component_count++;
 980                if (ref[component_len] == '\0')
 981                        break;
 982                /* Skip to next component. */
 983                ref += component_len + 1;
 984        }
 985
 986        if (ref[component_len - 1] == '.')
 987                return -1; /* Refname ends with '.'. */
 988        if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
 989                return -1; /* Refname has only one component. */
 990        return 0;
 991}
 992
 993const char *prettify_refname(const char *name)
 994{
 995        return name + (
 996                !prefixcmp(name, "refs/heads/") ? 11 :
 997                !prefixcmp(name, "refs/tags/") ? 10 :
 998                !prefixcmp(name, "refs/remotes/") ? 13 :
 999                0);
1000}
1001
1002const char *ref_rev_parse_rules[] = {
1003        "%.*s",
1004        "refs/%.*s",
1005        "refs/tags/%.*s",
1006        "refs/heads/%.*s",
1007        "refs/remotes/%.*s",
1008        "refs/remotes/%.*s/HEAD",
1009        NULL
1010};
1011
1012int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1013{
1014        const char **p;
1015        const int abbrev_name_len = strlen(abbrev_name);
1016
1017        for (p = rules; *p; p++) {
1018                if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1019                        return 1;
1020                }
1021        }
1022
1023        return 0;
1024}
1025
1026static struct ref_lock *verify_lock(struct ref_lock *lock,
1027        const unsigned char *old_sha1, int mustexist)
1028{
1029        if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1030                error("Can't verify ref %s", lock->ref_name);
1031                unlock_ref(lock);
1032                return NULL;
1033        }
1034        if (hashcmp(lock->old_sha1, old_sha1)) {
1035                error("Ref %s is at %s but expected %s", lock->ref_name,
1036                        sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1037                unlock_ref(lock);
1038                return NULL;
1039        }
1040        return lock;
1041}
1042
1043static int remove_empty_directories(const char *file)
1044{
1045        /* we want to create a file but there is a directory there;
1046         * if that is an empty directory (or a directory that contains
1047         * only empty directories), remove them.
1048         */
1049        struct strbuf path;
1050        int result;
1051
1052        strbuf_init(&path, 20);
1053        strbuf_addstr(&path, file);
1054
1055        result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1056
1057        strbuf_release(&path);
1058
1059        return result;
1060}
1061
1062static int is_refname_available(const char *ref, const char *oldref,
1063                                struct ref_array *array, int quiet)
1064{
1065        int i, namlen = strlen(ref); /* e.g. 'foo/bar' */
1066        for (i = 0; i < array->nr; i++ ) {
1067                struct ref_entry *entry = array->refs[i];
1068                /* entry->name could be 'foo' or 'foo/bar/baz' */
1069                if (!oldref || strcmp(oldref, entry->name)) {
1070                        int len = strlen(entry->name);
1071                        int cmplen = (namlen < len) ? namlen : len;
1072                        const char *lead = (namlen < len) ? entry->name : ref;
1073                        if (!strncmp(ref, entry->name, cmplen) &&
1074                            lead[cmplen] == '/') {
1075                                if (!quiet)
1076                                        error("'%s' exists; cannot create '%s'",
1077                                              entry->name, ref);
1078                                return 0;
1079                        }
1080                }
1081        }
1082        return 1;
1083}
1084
1085/*
1086 * *string and *len will only be substituted, and *string returned (for
1087 * later free()ing) if the string passed in is a magic short-hand form
1088 * to name a branch.
1089 */
1090static char *substitute_branch_name(const char **string, int *len)
1091{
1092        struct strbuf buf = STRBUF_INIT;
1093        int ret = interpret_branch_name(*string, &buf);
1094
1095        if (ret == *len) {
1096                size_t size;
1097                *string = strbuf_detach(&buf, &size);
1098                *len = size;
1099                return (char *)*string;
1100        }
1101
1102        return NULL;
1103}
1104
1105int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1106{
1107        char *last_branch = substitute_branch_name(&str, &len);
1108        const char **p, *r;
1109        int refs_found = 0;
1110
1111        *ref = NULL;
1112        for (p = ref_rev_parse_rules; *p; p++) {
1113                char fullref[PATH_MAX];
1114                unsigned char sha1_from_ref[20];
1115                unsigned char *this_result;
1116                int flag;
1117
1118                this_result = refs_found ? sha1_from_ref : sha1;
1119                mksnpath(fullref, sizeof(fullref), *p, len, str);
1120                r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1121                if (r) {
1122                        if (!refs_found++)
1123                                *ref = xstrdup(r);
1124                        if (!warn_ambiguous_refs)
1125                                break;
1126                } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1127                        warning("ignoring dangling symref %s.", fullref);
1128                } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1129                        warning("ignoring broken ref %s.", fullref);
1130                }
1131        }
1132        free(last_branch);
1133        return refs_found;
1134}
1135
1136int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1137{
1138        char *last_branch = substitute_branch_name(&str, &len);
1139        const char **p;
1140        int logs_found = 0;
1141
1142        *log = NULL;
1143        for (p = ref_rev_parse_rules; *p; p++) {
1144                struct stat st;
1145                unsigned char hash[20];
1146                char path[PATH_MAX];
1147                const char *ref, *it;
1148
1149                mksnpath(path, sizeof(path), *p, len, str);
1150                ref = resolve_ref_unsafe(path, hash, 1, NULL);
1151                if (!ref)
1152                        continue;
1153                if (!stat(git_path("logs/%s", path), &st) &&
1154                    S_ISREG(st.st_mode))
1155                        it = path;
1156                else if (strcmp(ref, path) &&
1157                         !stat(git_path("logs/%s", ref), &st) &&
1158                         S_ISREG(st.st_mode))
1159                        it = ref;
1160                else
1161                        continue;
1162                if (!logs_found++) {
1163                        *log = xstrdup(it);
1164                        hashcpy(sha1, hash);
1165                }
1166                if (!warn_ambiguous_refs)
1167                        break;
1168        }
1169        free(last_branch);
1170        return logs_found;
1171}
1172
1173static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1174{
1175        char *ref_file;
1176        const char *orig_ref = ref;
1177        struct ref_lock *lock;
1178        int last_errno = 0;
1179        int type, lflags;
1180        int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1181        int missing = 0;
1182
1183        lock = xcalloc(1, sizeof(struct ref_lock));
1184        lock->lock_fd = -1;
1185
1186        ref = resolve_ref_unsafe(ref, lock->old_sha1, mustexist, &type);
1187        if (!ref && errno == EISDIR) {
1188                /* we are trying to lock foo but we used to
1189                 * have foo/bar which now does not exist;
1190                 * it is normal for the empty directory 'foo'
1191                 * to remain.
1192                 */
1193                ref_file = git_path("%s", orig_ref);
1194                if (remove_empty_directories(ref_file)) {
1195                        last_errno = errno;
1196                        error("there are still refs under '%s'", orig_ref);
1197                        goto error_return;
1198                }
1199                ref = resolve_ref_unsafe(orig_ref, lock->old_sha1, mustexist, &type);
1200        }
1201        if (type_p)
1202            *type_p = type;
1203        if (!ref) {
1204                last_errno = errno;
1205                error("unable to resolve reference %s: %s",
1206                        orig_ref, strerror(errno));
1207                goto error_return;
1208        }
1209        missing = is_null_sha1(lock->old_sha1);
1210        /* When the ref did not exist and we are creating it,
1211         * make sure there is no existing ref that is packed
1212         * whose name begins with our refname, nor a ref whose
1213         * name is a proper prefix of our refname.
1214         */
1215        if (missing &&
1216             !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1217                last_errno = ENOTDIR;
1218                goto error_return;
1219        }
1220
1221        lock->lk = xcalloc(1, sizeof(struct lock_file));
1222
1223        lflags = LOCK_DIE_ON_ERROR;
1224        if (flags & REF_NODEREF) {
1225                ref = orig_ref;
1226                lflags |= LOCK_NODEREF;
1227        }
1228        lock->ref_name = xstrdup(ref);
1229        lock->orig_ref_name = xstrdup(orig_ref);
1230        ref_file = git_path("%s", ref);
1231        if (missing)
1232                lock->force_write = 1;
1233        if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1234                lock->force_write = 1;
1235
1236        if (safe_create_leading_directories(ref_file)) {
1237                last_errno = errno;
1238                error("unable to create directory for %s", ref_file);
1239                goto error_return;
1240        }
1241
1242        lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1243        return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1244
1245 error_return:
1246        unlock_ref(lock);
1247        errno = last_errno;
1248        return NULL;
1249}
1250
1251struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1252{
1253        char refpath[PATH_MAX];
1254        if (check_refname_format(ref, 0))
1255                return NULL;
1256        strcpy(refpath, mkpath("refs/%s", ref));
1257        return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1258}
1259
1260struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1261{
1262        if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
1263                return NULL;
1264        return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1265}
1266
1267static struct lock_file packlock;
1268
1269static int repack_without_ref(const char *refname)
1270{
1271        struct ref_array *packed;
1272        struct ref_entry *ref;
1273        int fd, i;
1274
1275        packed = get_packed_refs(NULL);
1276        ref = search_ref_array(packed, refname);
1277        if (ref == NULL)
1278                return 0;
1279        fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1280        if (fd < 0) {
1281                unable_to_lock_error(git_path("packed-refs"), errno);
1282                return error("cannot delete '%s' from packed refs", refname);
1283        }
1284
1285        for (i = 0; i < packed->nr; i++) {
1286                char line[PATH_MAX + 100];
1287                int len;
1288
1289                ref = packed->refs[i];
1290
1291                if (!strcmp(refname, ref->name))
1292                        continue;
1293                len = snprintf(line, sizeof(line), "%s %s\n",
1294                               sha1_to_hex(ref->sha1), ref->name);
1295                /* this should not happen but just being defensive */
1296                if (len > sizeof(line))
1297                        die("too long a refname '%s'", ref->name);
1298                write_or_die(fd, line, len);
1299        }
1300        return commit_lock_file(&packlock);
1301}
1302
1303int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1304{
1305        struct ref_lock *lock;
1306        int err, i = 0, ret = 0, flag = 0;
1307
1308        lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1309        if (!lock)
1310                return 1;
1311        if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1312                /* loose */
1313                const char *path;
1314
1315                if (!(delopt & REF_NODEREF)) {
1316                        i = strlen(lock->lk->filename) - 5; /* .lock */
1317                        lock->lk->filename[i] = 0;
1318                        path = lock->lk->filename;
1319                } else {
1320                        path = git_path("%s", refname);
1321                }
1322                err = unlink_or_warn(path);
1323                if (err && errno != ENOENT)
1324                        ret = 1;
1325
1326                if (!(delopt & REF_NODEREF))
1327                        lock->lk->filename[i] = '.';
1328        }
1329        /* removing the loose one could have resurrected an earlier
1330         * packed one.  Also, if it was not loose we need to repack
1331         * without it.
1332         */
1333        ret |= repack_without_ref(refname);
1334
1335        unlink_or_warn(git_path("logs/%s", lock->ref_name));
1336        invalidate_ref_cache(NULL);
1337        unlock_ref(lock);
1338        return ret;
1339}
1340
1341/*
1342 * People using contrib's git-new-workdir have .git/logs/refs ->
1343 * /some/other/path/.git/logs/refs, and that may live on another device.
1344 *
1345 * IOW, to avoid cross device rename errors, the temporary renamed log must
1346 * live into logs/refs.
1347 */
1348#define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1349
1350int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1351{
1352        unsigned char sha1[20], orig_sha1[20];
1353        int flag = 0, logmoved = 0;
1354        struct ref_lock *lock;
1355        struct stat loginfo;
1356        int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1357        const char *symref = NULL;
1358
1359        if (log && S_ISLNK(loginfo.st_mode))
1360                return error("reflog for %s is a symlink", oldref);
1361
1362        symref = resolve_ref_unsafe(oldref, orig_sha1, 1, &flag);
1363        if (flag & REF_ISSYMREF)
1364                return error("refname %s is a symbolic ref, renaming it is not supported",
1365                        oldref);
1366        if (!symref)
1367                return error("refname %s not found", oldref);
1368
1369        if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1370                return 1;
1371
1372        if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1373                return 1;
1374
1375        if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1376                return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1377                        oldref, strerror(errno));
1378
1379        if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1380                error("unable to delete old %s", oldref);
1381                goto rollback;
1382        }
1383
1384        if (!read_ref_full(newref, sha1, 1, &flag) &&
1385            delete_ref(newref, sha1, REF_NODEREF)) {
1386                if (errno==EISDIR) {
1387                        if (remove_empty_directories(git_path("%s", newref))) {
1388                                error("Directory not empty: %s", newref);
1389                                goto rollback;
1390                        }
1391                } else {
1392                        error("unable to delete existing %s", newref);
1393                        goto rollback;
1394                }
1395        }
1396
1397        if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1398                error("unable to create directory for %s", newref);
1399                goto rollback;
1400        }
1401
1402 retry:
1403        if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1404                if (errno==EISDIR || errno==ENOTDIR) {
1405                        /*
1406                         * rename(a, b) when b is an existing
1407                         * directory ought to result in ISDIR, but
1408                         * Solaris 5.8 gives ENOTDIR.  Sheesh.
1409                         */
1410                        if (remove_empty_directories(git_path("logs/%s", newref))) {
1411                                error("Directory not empty: logs/%s", newref);
1412                                goto rollback;
1413                        }
1414                        goto retry;
1415                } else {
1416                        error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1417                                newref, strerror(errno));
1418                        goto rollback;
1419                }
1420        }
1421        logmoved = log;
1422
1423        lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1424        if (!lock) {
1425                error("unable to lock %s for update", newref);
1426                goto rollback;
1427        }
1428        lock->force_write = 1;
1429        hashcpy(lock->old_sha1, orig_sha1);
1430        if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1431                error("unable to write current sha1 into %s", newref);
1432                goto rollback;
1433        }
1434
1435        return 0;
1436
1437 rollback:
1438        lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1439        if (!lock) {
1440                error("unable to lock %s for rollback", oldref);
1441                goto rollbacklog;
1442        }
1443
1444        lock->force_write = 1;
1445        flag = log_all_ref_updates;
1446        log_all_ref_updates = 0;
1447        if (write_ref_sha1(lock, orig_sha1, NULL))
1448                error("unable to write current sha1 into %s", oldref);
1449        log_all_ref_updates = flag;
1450
1451 rollbacklog:
1452        if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1453                error("unable to restore logfile %s from %s: %s",
1454                        oldref, newref, strerror(errno));
1455        if (!logmoved && log &&
1456            rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1457                error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1458                        oldref, strerror(errno));
1459
1460        return 1;
1461}
1462
1463int close_ref(struct ref_lock *lock)
1464{
1465        if (close_lock_file(lock->lk))
1466                return -1;
1467        lock->lock_fd = -1;
1468        return 0;
1469}
1470
1471int commit_ref(struct ref_lock *lock)
1472{
1473        if (commit_lock_file(lock->lk))
1474                return -1;
1475        lock->lock_fd = -1;
1476        return 0;
1477}
1478
1479void unlock_ref(struct ref_lock *lock)
1480{
1481        /* Do not free lock->lk -- atexit() still looks at them */
1482        if (lock->lk)
1483                rollback_lock_file(lock->lk);
1484        free(lock->ref_name);
1485        free(lock->orig_ref_name);
1486        free(lock);
1487}
1488
1489/*
1490 * copy the reflog message msg to buf, which has been allocated sufficiently
1491 * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1492 * because reflog file is one line per entry.
1493 */
1494static int copy_msg(char *buf, const char *msg)
1495{
1496        char *cp = buf;
1497        char c;
1498        int wasspace = 1;
1499
1500        *cp++ = '\t';
1501        while ((c = *msg++)) {
1502                if (wasspace && isspace(c))
1503                        continue;
1504                wasspace = isspace(c);
1505                if (wasspace)
1506                        c = ' ';
1507                *cp++ = c;
1508        }
1509        while (buf < cp && isspace(cp[-1]))
1510                cp--;
1511        *cp++ = '\n';
1512        return cp - buf;
1513}
1514
1515int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1516{
1517        int logfd, oflags = O_APPEND | O_WRONLY;
1518
1519        git_snpath(logfile, bufsize, "logs/%s", ref_name);
1520        if (log_all_ref_updates &&
1521            (!prefixcmp(ref_name, "refs/heads/") ||
1522             !prefixcmp(ref_name, "refs/remotes/") ||
1523             !prefixcmp(ref_name, "refs/notes/") ||
1524             !strcmp(ref_name, "HEAD"))) {
1525                if (safe_create_leading_directories(logfile) < 0)
1526                        return error("unable to create directory for %s",
1527                                     logfile);
1528                oflags |= O_CREAT;
1529        }
1530
1531        logfd = open(logfile, oflags, 0666);
1532        if (logfd < 0) {
1533                if (!(oflags & O_CREAT) && errno == ENOENT)
1534                        return 0;
1535
1536                if ((oflags & O_CREAT) && errno == EISDIR) {
1537                        if (remove_empty_directories(logfile)) {
1538                                return error("There are still logs under '%s'",
1539                                             logfile);
1540                        }
1541                        logfd = open(logfile, oflags, 0666);
1542                }
1543
1544                if (logfd < 0)
1545                        return error("Unable to append to %s: %s",
1546                                     logfile, strerror(errno));
1547        }
1548
1549        adjust_shared_perm(logfile);
1550        close(logfd);
1551        return 0;
1552}
1553
1554static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1555                         const unsigned char *new_sha1, const char *msg)
1556{
1557        int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1558        unsigned maxlen, len;
1559        int msglen;
1560        char log_file[PATH_MAX];
1561        char *logrec;
1562        const char *committer;
1563
1564        if (log_all_ref_updates < 0)
1565                log_all_ref_updates = !is_bare_repository();
1566
1567        result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1568        if (result)
1569                return result;
1570
1571        logfd = open(log_file, oflags);
1572        if (logfd < 0)
1573                return 0;
1574        msglen = msg ? strlen(msg) : 0;
1575        committer = git_committer_info(0);
1576        maxlen = strlen(committer) + msglen + 100;
1577        logrec = xmalloc(maxlen);
1578        len = sprintf(logrec, "%s %s %s\n",
1579                      sha1_to_hex(old_sha1),
1580                      sha1_to_hex(new_sha1),
1581                      committer);
1582        if (msglen)
1583                len += copy_msg(logrec + len - 1, msg) - 1;
1584        written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1585        free(logrec);
1586        if (close(logfd) != 0 || written != len)
1587                return error("Unable to append to %s", log_file);
1588        return 0;
1589}
1590
1591static int is_branch(const char *refname)
1592{
1593        return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1594}
1595
1596int write_ref_sha1(struct ref_lock *lock,
1597        const unsigned char *sha1, const char *logmsg)
1598{
1599        static char term = '\n';
1600        struct object *o;
1601
1602        if (!lock)
1603                return -1;
1604        if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1605                unlock_ref(lock);
1606                return 0;
1607        }
1608        o = parse_object(sha1);
1609        if (!o) {
1610                error("Trying to write ref %s with nonexistent object %s",
1611                        lock->ref_name, sha1_to_hex(sha1));
1612                unlock_ref(lock);
1613                return -1;
1614        }
1615        if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1616                error("Trying to write non-commit object %s to branch %s",
1617                        sha1_to_hex(sha1), lock->ref_name);
1618                unlock_ref(lock);
1619                return -1;
1620        }
1621        if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1622            write_in_full(lock->lock_fd, &term, 1) != 1
1623                || close_ref(lock) < 0) {
1624                error("Couldn't write %s", lock->lk->filename);
1625                unlock_ref(lock);
1626                return -1;
1627        }
1628        clear_loose_ref_cache(get_ref_cache(NULL));
1629        if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1630            (strcmp(lock->ref_name, lock->orig_ref_name) &&
1631             log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1632                unlock_ref(lock);
1633                return -1;
1634        }
1635        if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1636                /*
1637                 * Special hack: If a branch is updated directly and HEAD
1638                 * points to it (may happen on the remote side of a push
1639                 * for example) then logically the HEAD reflog should be
1640                 * updated too.
1641                 * A generic solution implies reverse symref information,
1642                 * but finding all symrefs pointing to the given branch
1643                 * would be rather costly for this rare event (the direct
1644                 * update of a branch) to be worth it.  So let's cheat and
1645                 * check with HEAD only which should cover 99% of all usage
1646                 * scenarios (even 100% of the default ones).
1647                 */
1648                unsigned char head_sha1[20];
1649                int head_flag;
1650                const char *head_ref;
1651                head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
1652                if (head_ref && (head_flag & REF_ISSYMREF) &&
1653                    !strcmp(head_ref, lock->ref_name))
1654                        log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1655        }
1656        if (commit_ref(lock)) {
1657                error("Couldn't set %s", lock->ref_name);
1658                unlock_ref(lock);
1659                return -1;
1660        }
1661        unlock_ref(lock);
1662        return 0;
1663}
1664
1665int create_symref(const char *ref_target, const char *refs_heads_master,
1666                  const char *logmsg)
1667{
1668        const char *lockpath;
1669        char ref[1000];
1670        int fd, len, written;
1671        char *git_HEAD = git_pathdup("%s", ref_target);
1672        unsigned char old_sha1[20], new_sha1[20];
1673
1674        if (logmsg && read_ref(ref_target, old_sha1))
1675                hashclr(old_sha1);
1676
1677        if (safe_create_leading_directories(git_HEAD) < 0)
1678                return error("unable to create directory for %s", git_HEAD);
1679
1680#ifndef NO_SYMLINK_HEAD
1681        if (prefer_symlink_refs) {
1682                unlink(git_HEAD);
1683                if (!symlink(refs_heads_master, git_HEAD))
1684                        goto done;
1685                fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1686        }
1687#endif
1688
1689        len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1690        if (sizeof(ref) <= len) {
1691                error("refname too long: %s", refs_heads_master);
1692                goto error_free_return;
1693        }
1694        lockpath = mkpath("%s.lock", git_HEAD);
1695        fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1696        if (fd < 0) {
1697                error("Unable to open %s for writing", lockpath);
1698                goto error_free_return;
1699        }
1700        written = write_in_full(fd, ref, len);
1701        if (close(fd) != 0 || written != len) {
1702                error("Unable to write to %s", lockpath);
1703                goto error_unlink_return;
1704        }
1705        if (rename(lockpath, git_HEAD) < 0) {
1706                error("Unable to create %s", git_HEAD);
1707                goto error_unlink_return;
1708        }
1709        if (adjust_shared_perm(git_HEAD)) {
1710                error("Unable to fix permissions on %s", lockpath);
1711        error_unlink_return:
1712                unlink_or_warn(lockpath);
1713        error_free_return:
1714                free(git_HEAD);
1715                return -1;
1716        }
1717
1718#ifndef NO_SYMLINK_HEAD
1719        done:
1720#endif
1721        if (logmsg && !read_ref(refs_heads_master, new_sha1))
1722                log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1723
1724        free(git_HEAD);
1725        return 0;
1726}
1727
1728static char *ref_msg(const char *line, const char *endp)
1729{
1730        const char *ep;
1731        line += 82;
1732        ep = memchr(line, '\n', endp - line);
1733        if (!ep)
1734                ep = endp;
1735        return xmemdupz(line, ep - line);
1736}
1737
1738int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1739{
1740        const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1741        char *tz_c;
1742        int logfd, tz, reccnt = 0;
1743        struct stat st;
1744        unsigned long date;
1745        unsigned char logged_sha1[20];
1746        void *log_mapped;
1747        size_t mapsz;
1748
1749        logfile = git_path("logs/%s", ref);
1750        logfd = open(logfile, O_RDONLY, 0);
1751        if (logfd < 0)
1752                die_errno("Unable to read log '%s'", logfile);
1753        fstat(logfd, &st);
1754        if (!st.st_size)
1755                die("Log %s is empty.", logfile);
1756        mapsz = xsize_t(st.st_size);
1757        log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1758        logdata = log_mapped;
1759        close(logfd);
1760
1761        lastrec = NULL;
1762        rec = logend = logdata + st.st_size;
1763        while (logdata < rec) {
1764                reccnt++;
1765                if (logdata < rec && *(rec-1) == '\n')
1766                        rec--;
1767                lastgt = NULL;
1768                while (logdata < rec && *(rec-1) != '\n') {
1769                        rec--;
1770                        if (*rec == '>')
1771                                lastgt = rec;
1772                }
1773                if (!lastgt)
1774                        die("Log %s is corrupt.", logfile);
1775                date = strtoul(lastgt + 1, &tz_c, 10);
1776                if (date <= at_time || cnt == 0) {
1777                        tz = strtoul(tz_c, NULL, 10);
1778                        if (msg)
1779                                *msg = ref_msg(rec, logend);
1780                        if (cutoff_time)
1781                                *cutoff_time = date;
1782                        if (cutoff_tz)
1783                                *cutoff_tz = tz;
1784                        if (cutoff_cnt)
1785                                *cutoff_cnt = reccnt - 1;
1786                        if (lastrec) {
1787                                if (get_sha1_hex(lastrec, logged_sha1))
1788                                        die("Log %s is corrupt.", logfile);
1789                                if (get_sha1_hex(rec + 41, sha1))
1790                                        die("Log %s is corrupt.", logfile);
1791                                if (hashcmp(logged_sha1, sha1)) {
1792                                        warning("Log %s has gap after %s.",
1793                                                logfile, show_date(date, tz, DATE_RFC2822));
1794                                }
1795                        }
1796                        else if (date == at_time) {
1797                                if (get_sha1_hex(rec + 41, sha1))
1798                                        die("Log %s is corrupt.", logfile);
1799                        }
1800                        else {
1801                                if (get_sha1_hex(rec + 41, logged_sha1))
1802                                        die("Log %s is corrupt.", logfile);
1803                                if (hashcmp(logged_sha1, sha1)) {
1804                                        warning("Log %s unexpectedly ended on %s.",
1805                                                logfile, show_date(date, tz, DATE_RFC2822));
1806                                }
1807                        }
1808                        munmap(log_mapped, mapsz);
1809                        return 0;
1810                }
1811                lastrec = rec;
1812                if (cnt > 0)
1813                        cnt--;
1814        }
1815
1816        rec = logdata;
1817        while (rec < logend && *rec != '>' && *rec != '\n')
1818                rec++;
1819        if (rec == logend || *rec == '\n')
1820                die("Log %s is corrupt.", logfile);
1821        date = strtoul(rec + 1, &tz_c, 10);
1822        tz = strtoul(tz_c, NULL, 10);
1823        if (get_sha1_hex(logdata, sha1))
1824                die("Log %s is corrupt.", logfile);
1825        if (is_null_sha1(sha1)) {
1826                if (get_sha1_hex(logdata + 41, sha1))
1827                        die("Log %s is corrupt.", logfile);
1828        }
1829        if (msg)
1830                *msg = ref_msg(logdata, logend);
1831        munmap(log_mapped, mapsz);
1832
1833        if (cutoff_time)
1834                *cutoff_time = date;
1835        if (cutoff_tz)
1836                *cutoff_tz = tz;
1837        if (cutoff_cnt)
1838                *cutoff_cnt = reccnt;
1839        return 1;
1840}
1841
1842int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1843{
1844        const char *logfile;
1845        FILE *logfp;
1846        struct strbuf sb = STRBUF_INIT;
1847        int ret = 0;
1848
1849        logfile = git_path("logs/%s", ref);
1850        logfp = fopen(logfile, "r");
1851        if (!logfp)
1852                return -1;
1853
1854        if (ofs) {
1855                struct stat statbuf;
1856                if (fstat(fileno(logfp), &statbuf) ||
1857                    statbuf.st_size < ofs ||
1858                    fseek(logfp, -ofs, SEEK_END) ||
1859                    strbuf_getwholeline(&sb, logfp, '\n')) {
1860                        fclose(logfp);
1861                        strbuf_release(&sb);
1862                        return -1;
1863                }
1864        }
1865
1866        while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1867                unsigned char osha1[20], nsha1[20];
1868                char *email_end, *message;
1869                unsigned long timestamp;
1870                int tz;
1871
1872                /* old SP new SP name <email> SP time TAB msg LF */
1873                if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1874                    get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1875                    get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1876                    !(email_end = strchr(sb.buf + 82, '>')) ||
1877                    email_end[1] != ' ' ||
1878                    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1879                    !message || message[0] != ' ' ||
1880                    (message[1] != '+' && message[1] != '-') ||
1881                    !isdigit(message[2]) || !isdigit(message[3]) ||
1882                    !isdigit(message[4]) || !isdigit(message[5]))
1883                        continue; /* corrupt? */
1884                email_end[1] = '\0';
1885                tz = strtol(message + 1, NULL, 10);
1886                if (message[6] != '\t')
1887                        message += 6;
1888                else
1889                        message += 7;
1890                ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1891                         cb_data);
1892                if (ret)
1893                        break;
1894        }
1895        fclose(logfp);
1896        strbuf_release(&sb);
1897        return ret;
1898}
1899
1900int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1901{
1902        return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1903}
1904
1905static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1906{
1907        DIR *dir = opendir(git_path("logs/%s", base));
1908        int retval = 0;
1909
1910        if (dir) {
1911                struct dirent *de;
1912                int baselen = strlen(base);
1913                char *log = xmalloc(baselen + 257);
1914
1915                memcpy(log, base, baselen);
1916                if (baselen && base[baselen-1] != '/')
1917                        log[baselen++] = '/';
1918
1919                while ((de = readdir(dir)) != NULL) {
1920                        struct stat st;
1921                        int namelen;
1922
1923                        if (de->d_name[0] == '.')
1924                                continue;
1925                        namelen = strlen(de->d_name);
1926                        if (namelen > 255)
1927                                continue;
1928                        if (has_extension(de->d_name, ".lock"))
1929                                continue;
1930                        memcpy(log + baselen, de->d_name, namelen+1);
1931                        if (stat(git_path("logs/%s", log), &st) < 0)
1932                                continue;
1933                        if (S_ISDIR(st.st_mode)) {
1934                                retval = do_for_each_reflog(log, fn, cb_data);
1935                        } else {
1936                                unsigned char sha1[20];
1937                                if (read_ref_full(log, sha1, 0, NULL))
1938                                        retval = error("bad ref for %s", log);
1939                                else
1940                                        retval = fn(log, sha1, 0, cb_data);
1941                        }
1942                        if (retval)
1943                                break;
1944                }
1945                free(log);
1946                closedir(dir);
1947        }
1948        else if (*base)
1949                return errno;
1950        return retval;
1951}
1952
1953int for_each_reflog(each_ref_fn fn, void *cb_data)
1954{
1955        return do_for_each_reflog("", fn, cb_data);
1956}
1957
1958int update_ref(const char *action, const char *refname,
1959                const unsigned char *sha1, const unsigned char *oldval,
1960                int flags, enum action_on_err onerr)
1961{
1962        static struct ref_lock *lock;
1963        lock = lock_any_ref_for_update(refname, oldval, flags);
1964        if (!lock) {
1965                const char *str = "Cannot lock the ref '%s'.";
1966                switch (onerr) {
1967                case MSG_ON_ERR: error(str, refname); break;
1968                case DIE_ON_ERR: die(str, refname); break;
1969                case QUIET_ON_ERR: break;
1970                }
1971                return 1;
1972        }
1973        if (write_ref_sha1(lock, sha1, action) < 0) {
1974                const char *str = "Cannot update the ref '%s'.";
1975                switch (onerr) {
1976                case MSG_ON_ERR: error(str, refname); break;
1977                case DIE_ON_ERR: die(str, refname); break;
1978                case QUIET_ON_ERR: break;
1979                }
1980                return 1;
1981        }
1982        return 0;
1983}
1984
1985int ref_exists(const char *refname)
1986{
1987        unsigned char sha1[20];
1988        return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1989}
1990
1991struct ref *find_ref_by_name(const struct ref *list, const char *name)
1992{
1993        for ( ; list; list = list->next)
1994                if (!strcmp(list->name, name))
1995                        return (struct ref *)list;
1996        return NULL;
1997}
1998
1999/*
2000 * generate a format suitable for scanf from a ref_rev_parse_rules
2001 * rule, that is replace the "%.*s" spec with a "%s" spec
2002 */
2003static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2004{
2005        char *spec;
2006
2007        spec = strstr(rule, "%.*s");
2008        if (!spec || strstr(spec + 4, "%.*s"))
2009                die("invalid rule in ref_rev_parse_rules: %s", rule);
2010
2011        /* copy all until spec */
2012        strncpy(scanf_fmt, rule, spec - rule);
2013        scanf_fmt[spec - rule] = '\0';
2014        /* copy new spec */
2015        strcat(scanf_fmt, "%s");
2016        /* copy remaining rule */
2017        strcat(scanf_fmt, spec + 4);
2018
2019        return;
2020}
2021
2022char *shorten_unambiguous_ref(const char *ref, int strict)
2023{
2024        int i;
2025        static char **scanf_fmts;
2026        static int nr_rules;
2027        char *short_name;
2028
2029        /* pre generate scanf formats from ref_rev_parse_rules[] */
2030        if (!nr_rules) {
2031                size_t total_len = 0;
2032
2033                /* the rule list is NULL terminated, count them first */
2034                for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2035                        /* no +1 because strlen("%s") < strlen("%.*s") */
2036                        total_len += strlen(ref_rev_parse_rules[nr_rules]);
2037
2038                scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2039
2040                total_len = 0;
2041                for (i = 0; i < nr_rules; i++) {
2042                        scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2043                                        + total_len;
2044                        gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2045                        total_len += strlen(ref_rev_parse_rules[i]);
2046                }
2047        }
2048
2049        /* bail out if there are no rules */
2050        if (!nr_rules)
2051                return xstrdup(ref);
2052
2053        /* buffer for scanf result, at most ref must fit */
2054        short_name = xstrdup(ref);
2055
2056        /* skip first rule, it will always match */
2057        for (i = nr_rules - 1; i > 0 ; --i) {
2058                int j;
2059                int rules_to_fail = i;
2060                int short_name_len;
2061
2062                if (1 != sscanf(ref, scanf_fmts[i], short_name))
2063                        continue;
2064
2065                short_name_len = strlen(short_name);
2066
2067                /*
2068                 * in strict mode, all (except the matched one) rules
2069                 * must fail to resolve to a valid non-ambiguous ref
2070                 */
2071                if (strict)
2072                        rules_to_fail = nr_rules;
2073
2074                /*
2075                 * check if the short name resolves to a valid ref,
2076                 * but use only rules prior to the matched one
2077                 */
2078                for (j = 0; j < rules_to_fail; j++) {
2079                        const char *rule = ref_rev_parse_rules[j];
2080                        char refname[PATH_MAX];
2081
2082                        /* skip matched rule */
2083                        if (i == j)
2084                                continue;
2085
2086                        /*
2087                         * the short name is ambiguous, if it resolves
2088                         * (with this previous rule) to a valid ref
2089                         * read_ref() returns 0 on success
2090                         */
2091                        mksnpath(refname, sizeof(refname),
2092                                 rule, short_name_len, short_name);
2093                        if (ref_exists(refname))
2094                                break;
2095                }
2096
2097                /*
2098                 * short name is non-ambiguous if all previous rules
2099                 * haven't resolved to a valid ref
2100                 */
2101                if (j == rules_to_fail)
2102                        return short_name;
2103        }
2104
2105        free(short_name);
2106        return xstrdup(ref);
2107}