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