sha1_file.con commit Merge branch 'jk/interop-test' (0bb80ab)
   1/*
   2 * GIT - The information manager from hell
   3 *
   4 * Copyright (C) Linus Torvalds, 2005
   5 *
   6 * This handles basic git sha1 object files - packing, unpacking,
   7 * creation etc.
   8 */
   9#include "cache.h"
  10#include "string-list.h"
  11#include "lockfile.h"
  12#include "delta.h"
  13#include "pack.h"
  14#include "blob.h"
  15#include "commit.h"
  16#include "run-command.h"
  17#include "tag.h"
  18#include "tree.h"
  19#include "tree-walk.h"
  20#include "refs.h"
  21#include "pack-revindex.h"
  22#include "sha1-lookup.h"
  23#include "bulk-checkin.h"
  24#include "streaming.h"
  25#include "dir.h"
  26#include "mru.h"
  27#include "list.h"
  28#include "mergesort.h"
  29#include "quote.h"
  30
  31#define SZ_FMT PRIuMAX
  32static inline uintmax_t sz_fmt(size_t s) { return s; }
  33
  34const unsigned char null_sha1[20];
  35const struct object_id null_oid;
  36const struct object_id empty_tree_oid = {
  37        EMPTY_TREE_SHA1_BIN_LITERAL
  38};
  39const struct object_id empty_blob_oid = {
  40        EMPTY_BLOB_SHA1_BIN_LITERAL
  41};
  42
  43/*
  44 * This is meant to hold a *small* number of objects that you would
  45 * want read_sha1_file() to be able to return, but yet you do not want
  46 * to write them into the object store (e.g. a browse-only
  47 * application).
  48 */
  49static struct cached_object {
  50        unsigned char sha1[20];
  51        enum object_type type;
  52        void *buf;
  53        unsigned long size;
  54} *cached_objects;
  55static int cached_object_nr, cached_object_alloc;
  56
  57static struct cached_object empty_tree = {
  58        EMPTY_TREE_SHA1_BIN_LITERAL,
  59        OBJ_TREE,
  60        "",
  61        0
  62};
  63
  64static struct cached_object *find_cached_object(const unsigned char *sha1)
  65{
  66        int i;
  67        struct cached_object *co = cached_objects;
  68
  69        for (i = 0; i < cached_object_nr; i++, co++) {
  70                if (!hashcmp(co->sha1, sha1))
  71                        return co;
  72        }
  73        if (!hashcmp(sha1, empty_tree.sha1))
  74                return &empty_tree;
  75        return NULL;
  76}
  77
  78int mkdir_in_gitdir(const char *path)
  79{
  80        if (mkdir(path, 0777)) {
  81                int saved_errno = errno;
  82                struct stat st;
  83                struct strbuf sb = STRBUF_INIT;
  84
  85                if (errno != EEXIST)
  86                        return -1;
  87                /*
  88                 * Are we looking at a path in a symlinked worktree
  89                 * whose original repository does not yet have it?
  90                 * e.g. .git/rr-cache pointing at its original
  91                 * repository in which the user hasn't performed any
  92                 * conflict resolution yet?
  93                 */
  94                if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
  95                    strbuf_readlink(&sb, path, st.st_size) ||
  96                    !is_absolute_path(sb.buf) ||
  97                    mkdir(sb.buf, 0777)) {
  98                        strbuf_release(&sb);
  99                        errno = saved_errno;
 100                        return -1;
 101                }
 102                strbuf_release(&sb);
 103        }
 104        return adjust_shared_perm(path);
 105}
 106
 107enum scld_error safe_create_leading_directories(char *path)
 108{
 109        char *next_component = path + offset_1st_component(path);
 110        enum scld_error ret = SCLD_OK;
 111
 112        while (ret == SCLD_OK && next_component) {
 113                struct stat st;
 114                char *slash = next_component, slash_character;
 115
 116                while (*slash && !is_dir_sep(*slash))
 117                        slash++;
 118
 119                if (!*slash)
 120                        break;
 121
 122                next_component = slash + 1;
 123                while (is_dir_sep(*next_component))
 124                        next_component++;
 125                if (!*next_component)
 126                        break;
 127
 128                slash_character = *slash;
 129                *slash = '\0';
 130                if (!stat(path, &st)) {
 131                        /* path exists */
 132                        if (!S_ISDIR(st.st_mode)) {
 133                                errno = ENOTDIR;
 134                                ret = SCLD_EXISTS;
 135                        }
 136                } else if (mkdir(path, 0777)) {
 137                        if (errno == EEXIST &&
 138                            !stat(path, &st) && S_ISDIR(st.st_mode))
 139                                ; /* somebody created it since we checked */
 140                        else if (errno == ENOENT)
 141                                /*
 142                                 * Either mkdir() failed because
 143                                 * somebody just pruned the containing
 144                                 * directory, or stat() failed because
 145                                 * the file that was in our way was
 146                                 * just removed.  Either way, inform
 147                                 * the caller that it might be worth
 148                                 * trying again:
 149                                 */
 150                                ret = SCLD_VANISHED;
 151                        else
 152                                ret = SCLD_FAILED;
 153                } else if (adjust_shared_perm(path)) {
 154                        ret = SCLD_PERMS;
 155                }
 156                *slash = slash_character;
 157        }
 158        return ret;
 159}
 160
 161enum scld_error safe_create_leading_directories_const(const char *path)
 162{
 163        int save_errno;
 164        /* path points to cache entries, so xstrdup before messing with it */
 165        char *buf = xstrdup(path);
 166        enum scld_error result = safe_create_leading_directories(buf);
 167
 168        save_errno = errno;
 169        free(buf);
 170        errno = save_errno;
 171        return result;
 172}
 173
 174int raceproof_create_file(const char *path, create_file_fn fn, void *cb)
 175{
 176        /*
 177         * The number of times we will try to remove empty directories
 178         * in the way of path. This is only 1 because if another
 179         * process is racily creating directories that conflict with
 180         * us, we don't want to fight against them.
 181         */
 182        int remove_directories_remaining = 1;
 183
 184        /*
 185         * The number of times that we will try to create the
 186         * directories containing path. We are willing to attempt this
 187         * more than once, because another process could be trying to
 188         * clean up empty directories at the same time as we are
 189         * trying to create them.
 190         */
 191        int create_directories_remaining = 3;
 192
 193        /* A scratch copy of path, filled lazily if we need it: */
 194        struct strbuf path_copy = STRBUF_INIT;
 195
 196        int ret, save_errno;
 197
 198        /* Sanity check: */
 199        assert(*path);
 200
 201retry_fn:
 202        ret = fn(path, cb);
 203        save_errno = errno;
 204        if (!ret)
 205                goto out;
 206
 207        if (errno == EISDIR && remove_directories_remaining-- > 0) {
 208                /*
 209                 * A directory is in the way. Maybe it is empty; try
 210                 * to remove it:
 211                 */
 212                if (!path_copy.len)
 213                        strbuf_addstr(&path_copy, path);
 214
 215                if (!remove_dir_recursively(&path_copy, REMOVE_DIR_EMPTY_ONLY))
 216                        goto retry_fn;
 217        } else if (errno == ENOENT && create_directories_remaining-- > 0) {
 218                /*
 219                 * Maybe the containing directory didn't exist, or
 220                 * maybe it was just deleted by a process that is
 221                 * racing with us to clean up empty directories. Try
 222                 * to create it:
 223                 */
 224                enum scld_error scld_result;
 225
 226                if (!path_copy.len)
 227                        strbuf_addstr(&path_copy, path);
 228
 229                do {
 230                        scld_result = safe_create_leading_directories(path_copy.buf);
 231                        if (scld_result == SCLD_OK)
 232                                goto retry_fn;
 233                } while (scld_result == SCLD_VANISHED && create_directories_remaining-- > 0);
 234        }
 235
 236out:
 237        strbuf_release(&path_copy);
 238        errno = save_errno;
 239        return ret;
 240}
 241
 242static void fill_sha1_path(struct strbuf *buf, const unsigned char *sha1)
 243{
 244        int i;
 245        for (i = 0; i < 20; i++) {
 246                static char hex[] = "0123456789abcdef";
 247                unsigned int val = sha1[i];
 248                strbuf_addch(buf, hex[val >> 4]);
 249                strbuf_addch(buf, hex[val & 0xf]);
 250                if (!i)
 251                        strbuf_addch(buf, '/');
 252        }
 253}
 254
 255const char *sha1_file_name(const unsigned char *sha1)
 256{
 257        static struct strbuf buf = STRBUF_INIT;
 258
 259        strbuf_reset(&buf);
 260        strbuf_addf(&buf, "%s/", get_object_directory());
 261
 262        fill_sha1_path(&buf, sha1);
 263        return buf.buf;
 264}
 265
 266struct strbuf *alt_scratch_buf(struct alternate_object_database *alt)
 267{
 268        strbuf_setlen(&alt->scratch, alt->base_len);
 269        return &alt->scratch;
 270}
 271
 272static const char *alt_sha1_path(struct alternate_object_database *alt,
 273                                 const unsigned char *sha1)
 274{
 275        struct strbuf *buf = alt_scratch_buf(alt);
 276        fill_sha1_path(buf, sha1);
 277        return buf->buf;
 278}
 279
 280/*
 281 * Return the name of the pack or index file with the specified sha1
 282 * in its filename.  *base and *name are scratch space that must be
 283 * provided by the caller.  which should be "pack" or "idx".
 284 */
 285static char *sha1_get_pack_name(const unsigned char *sha1,
 286                                struct strbuf *buf,
 287                                const char *which)
 288{
 289        strbuf_reset(buf);
 290        strbuf_addf(buf, "%s/pack/pack-%s.%s", get_object_directory(),
 291                    sha1_to_hex(sha1), which);
 292        return buf->buf;
 293}
 294
 295char *sha1_pack_name(const unsigned char *sha1)
 296{
 297        static struct strbuf buf = STRBUF_INIT;
 298        return sha1_get_pack_name(sha1, &buf, "pack");
 299}
 300
 301char *sha1_pack_index_name(const unsigned char *sha1)
 302{
 303        static struct strbuf buf = STRBUF_INIT;
 304        return sha1_get_pack_name(sha1, &buf, "idx");
 305}
 306
 307struct alternate_object_database *alt_odb_list;
 308static struct alternate_object_database **alt_odb_tail;
 309
 310/*
 311 * Return non-zero iff the path is usable as an alternate object database.
 312 */
 313static int alt_odb_usable(struct strbuf *path, const char *normalized_objdir)
 314{
 315        struct alternate_object_database *alt;
 316
 317        /* Detect cases where alternate disappeared */
 318        if (!is_directory(path->buf)) {
 319                error("object directory %s does not exist; "
 320                      "check .git/objects/info/alternates.",
 321                      path->buf);
 322                return 0;
 323        }
 324
 325        /*
 326         * Prevent the common mistake of listing the same
 327         * thing twice, or object directory itself.
 328         */
 329        for (alt = alt_odb_list; alt; alt = alt->next) {
 330                if (!fspathcmp(path->buf, alt->path))
 331                        return 0;
 332        }
 333        if (!fspathcmp(path->buf, normalized_objdir))
 334                return 0;
 335
 336        return 1;
 337}
 338
 339/*
 340 * Prepare alternate object database registry.
 341 *
 342 * The variable alt_odb_list points at the list of struct
 343 * alternate_object_database.  The elements on this list come from
 344 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
 345 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
 346 * whose contents is similar to that environment variable but can be
 347 * LF separated.  Its base points at a statically allocated buffer that
 348 * contains "/the/directory/corresponding/to/.git/objects/...", while
 349 * its name points just after the slash at the end of ".git/objects/"
 350 * in the example above, and has enough space to hold 40-byte hex
 351 * SHA1, an extra slash for the first level indirection, and the
 352 * terminating NUL.
 353 */
 354static int link_alt_odb_entry(const char *entry, const char *relative_base,
 355        int depth, const char *normalized_objdir)
 356{
 357        struct alternate_object_database *ent;
 358        struct strbuf pathbuf = STRBUF_INIT;
 359
 360        if (!is_absolute_path(entry) && relative_base) {
 361                strbuf_realpath(&pathbuf, relative_base, 1);
 362                strbuf_addch(&pathbuf, '/');
 363        }
 364        strbuf_addstr(&pathbuf, entry);
 365
 366        if (strbuf_normalize_path(&pathbuf) < 0 && relative_base) {
 367                error("unable to normalize alternate object path: %s",
 368                      pathbuf.buf);
 369                strbuf_release(&pathbuf);
 370                return -1;
 371        }
 372
 373        /*
 374         * The trailing slash after the directory name is given by
 375         * this function at the end. Remove duplicates.
 376         */
 377        while (pathbuf.len && pathbuf.buf[pathbuf.len - 1] == '/')
 378                strbuf_setlen(&pathbuf, pathbuf.len - 1);
 379
 380        if (!alt_odb_usable(&pathbuf, normalized_objdir)) {
 381                strbuf_release(&pathbuf);
 382                return -1;
 383        }
 384
 385        ent = alloc_alt_odb(pathbuf.buf);
 386
 387        /* add the alternate entry */
 388        *alt_odb_tail = ent;
 389        alt_odb_tail = &(ent->next);
 390        ent->next = NULL;
 391
 392        /* recursively add alternates */
 393        read_info_alternates(pathbuf.buf, depth + 1);
 394
 395        strbuf_release(&pathbuf);
 396        return 0;
 397}
 398
 399static const char *parse_alt_odb_entry(const char *string,
 400                                       int sep,
 401                                       struct strbuf *out)
 402{
 403        const char *end;
 404
 405        strbuf_reset(out);
 406
 407        if (*string == '#') {
 408                /* comment; consume up to next separator */
 409                end = strchrnul(string, sep);
 410        } else if (*string == '"' && !unquote_c_style(out, string, &end)) {
 411                /*
 412                 * quoted path; unquote_c_style has copied the
 413                 * data for us and set "end". Broken quoting (e.g.,
 414                 * an entry that doesn't end with a quote) falls
 415                 * back to the unquoted case below.
 416                 */
 417        } else {
 418                /* normal, unquoted path */
 419                end = strchrnul(string, sep);
 420                strbuf_add(out, string, end - string);
 421        }
 422
 423        if (*end)
 424                end++;
 425        return end;
 426}
 427
 428static void link_alt_odb_entries(const char *alt, int len, int sep,
 429                                 const char *relative_base, int depth)
 430{
 431        struct strbuf objdirbuf = STRBUF_INIT;
 432        struct strbuf entry = STRBUF_INIT;
 433
 434        if (depth > 5) {
 435                error("%s: ignoring alternate object stores, nesting too deep.",
 436                                relative_base);
 437                return;
 438        }
 439
 440        strbuf_add_absolute_path(&objdirbuf, get_object_directory());
 441        if (strbuf_normalize_path(&objdirbuf) < 0)
 442                die("unable to normalize object directory: %s",
 443                    objdirbuf.buf);
 444
 445        while (*alt) {
 446                alt = parse_alt_odb_entry(alt, sep, &entry);
 447                if (!entry.len)
 448                        continue;
 449                link_alt_odb_entry(entry.buf, relative_base, depth, objdirbuf.buf);
 450        }
 451        strbuf_release(&entry);
 452        strbuf_release(&objdirbuf);
 453}
 454
 455void read_info_alternates(const char * relative_base, int depth)
 456{
 457        char *map;
 458        size_t mapsz;
 459        struct stat st;
 460        char *path;
 461        int fd;
 462
 463        path = xstrfmt("%s/info/alternates", relative_base);
 464        fd = git_open(path);
 465        free(path);
 466        if (fd < 0)
 467                return;
 468        if (fstat(fd, &st) || (st.st_size == 0)) {
 469                close(fd);
 470                return;
 471        }
 472        mapsz = xsize_t(st.st_size);
 473        map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
 474        close(fd);
 475
 476        link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
 477
 478        munmap(map, mapsz);
 479}
 480
 481struct alternate_object_database *alloc_alt_odb(const char *dir)
 482{
 483        struct alternate_object_database *ent;
 484
 485        FLEX_ALLOC_STR(ent, path, dir);
 486        strbuf_init(&ent->scratch, 0);
 487        strbuf_addf(&ent->scratch, "%s/", dir);
 488        ent->base_len = ent->scratch.len;
 489
 490        return ent;
 491}
 492
 493void add_to_alternates_file(const char *reference)
 494{
 495        struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
 496        char *alts = git_pathdup("objects/info/alternates");
 497        FILE *in, *out;
 498
 499        hold_lock_file_for_update(lock, alts, LOCK_DIE_ON_ERROR);
 500        out = fdopen_lock_file(lock, "w");
 501        if (!out)
 502                die_errno("unable to fdopen alternates lockfile");
 503
 504        in = fopen(alts, "r");
 505        if (in) {
 506                struct strbuf line = STRBUF_INIT;
 507                int found = 0;
 508
 509                while (strbuf_getline(&line, in) != EOF) {
 510                        if (!strcmp(reference, line.buf)) {
 511                                found = 1;
 512                                break;
 513                        }
 514                        fprintf_or_die(out, "%s\n", line.buf);
 515                }
 516
 517                strbuf_release(&line);
 518                fclose(in);
 519
 520                if (found) {
 521                        rollback_lock_file(lock);
 522                        lock = NULL;
 523                }
 524        }
 525        else if (errno != ENOENT)
 526                die_errno("unable to read alternates file");
 527
 528        if (lock) {
 529                fprintf_or_die(out, "%s\n", reference);
 530                if (commit_lock_file(lock))
 531                        die_errno("unable to move new alternates file into place");
 532                if (alt_odb_tail)
 533                        link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
 534        }
 535        free(alts);
 536}
 537
 538void add_to_alternates_memory(const char *reference)
 539{
 540        /*
 541         * Make sure alternates are initialized, or else our entry may be
 542         * overwritten when they are.
 543         */
 544        prepare_alt_odb();
 545
 546        link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
 547}
 548
 549/*
 550 * Compute the exact path an alternate is at and returns it. In case of
 551 * error NULL is returned and the human readable error is added to `err`
 552 * `path` may be relative and should point to $GITDIR.
 553 * `err` must not be null.
 554 */
 555char *compute_alternate_path(const char *path, struct strbuf *err)
 556{
 557        char *ref_git = NULL;
 558        const char *repo, *ref_git_s;
 559        int seen_error = 0;
 560
 561        ref_git_s = real_path_if_valid(path);
 562        if (!ref_git_s) {
 563                seen_error = 1;
 564                strbuf_addf(err, _("path '%s' does not exist"), path);
 565                goto out;
 566        } else
 567                /*
 568                 * Beware: read_gitfile(), real_path() and mkpath()
 569                 * return static buffer
 570                 */
 571                ref_git = xstrdup(ref_git_s);
 572
 573        repo = read_gitfile(ref_git);
 574        if (!repo)
 575                repo = read_gitfile(mkpath("%s/.git", ref_git));
 576        if (repo) {
 577                free(ref_git);
 578                ref_git = xstrdup(repo);
 579        }
 580
 581        if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
 582                char *ref_git_git = mkpathdup("%s/.git", ref_git);
 583                free(ref_git);
 584                ref_git = ref_git_git;
 585        } else if (!is_directory(mkpath("%s/objects", ref_git))) {
 586                struct strbuf sb = STRBUF_INIT;
 587                seen_error = 1;
 588                if (get_common_dir(&sb, ref_git)) {
 589                        strbuf_addf(err,
 590                                    _("reference repository '%s' as a linked "
 591                                      "checkout is not supported yet."),
 592                                    path);
 593                        goto out;
 594                }
 595
 596                strbuf_addf(err, _("reference repository '%s' is not a "
 597                                        "local repository."), path);
 598                goto out;
 599        }
 600
 601        if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
 602                strbuf_addf(err, _("reference repository '%s' is shallow"),
 603                            path);
 604                seen_error = 1;
 605                goto out;
 606        }
 607
 608        if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
 609                strbuf_addf(err,
 610                            _("reference repository '%s' is grafted"),
 611                            path);
 612                seen_error = 1;
 613                goto out;
 614        }
 615
 616out:
 617        if (seen_error) {
 618                free(ref_git);
 619                ref_git = NULL;
 620        }
 621
 622        return ref_git;
 623}
 624
 625int foreach_alt_odb(alt_odb_fn fn, void *cb)
 626{
 627        struct alternate_object_database *ent;
 628        int r = 0;
 629
 630        prepare_alt_odb();
 631        for (ent = alt_odb_list; ent; ent = ent->next) {
 632                r = fn(ent, cb);
 633                if (r)
 634                        break;
 635        }
 636        return r;
 637}
 638
 639void prepare_alt_odb(void)
 640{
 641        const char *alt;
 642
 643        if (alt_odb_tail)
 644                return;
 645
 646        alt = getenv(ALTERNATE_DB_ENVIRONMENT);
 647        if (!alt) alt = "";
 648
 649        alt_odb_tail = &alt_odb_list;
 650        link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
 651
 652        read_info_alternates(get_object_directory(), 0);
 653}
 654
 655/* Returns 1 if we have successfully freshened the file, 0 otherwise. */
 656static int freshen_file(const char *fn)
 657{
 658        struct utimbuf t;
 659        t.actime = t.modtime = time(NULL);
 660        return !utime(fn, &t);
 661}
 662
 663/*
 664 * All of the check_and_freshen functions return 1 if the file exists and was
 665 * freshened (if freshening was requested), 0 otherwise. If they return
 666 * 0, you should not assume that it is safe to skip a write of the object (it
 667 * either does not exist on disk, or has a stale mtime and may be subject to
 668 * pruning).
 669 */
 670int check_and_freshen_file(const char *fn, int freshen)
 671{
 672        if (access(fn, F_OK))
 673                return 0;
 674        if (freshen && !freshen_file(fn))
 675                return 0;
 676        return 1;
 677}
 678
 679static int check_and_freshen_local(const unsigned char *sha1, int freshen)
 680{
 681        return check_and_freshen_file(sha1_file_name(sha1), freshen);
 682}
 683
 684static int check_and_freshen_nonlocal(const unsigned char *sha1, int freshen)
 685{
 686        struct alternate_object_database *alt;
 687        prepare_alt_odb();
 688        for (alt = alt_odb_list; alt; alt = alt->next) {
 689                const char *path = alt_sha1_path(alt, sha1);
 690                if (check_and_freshen_file(path, freshen))
 691                        return 1;
 692        }
 693        return 0;
 694}
 695
 696static int check_and_freshen(const unsigned char *sha1, int freshen)
 697{
 698        return check_and_freshen_local(sha1, freshen) ||
 699               check_and_freshen_nonlocal(sha1, freshen);
 700}
 701
 702int has_loose_object_nonlocal(const unsigned char *sha1)
 703{
 704        return check_and_freshen_nonlocal(sha1, 0);
 705}
 706
 707static int has_loose_object(const unsigned char *sha1)
 708{
 709        return check_and_freshen(sha1, 0);
 710}
 711
 712static unsigned int pack_used_ctr;
 713static unsigned int pack_mmap_calls;
 714static unsigned int peak_pack_open_windows;
 715static unsigned int pack_open_windows;
 716static unsigned int pack_open_fds;
 717static unsigned int pack_max_fds;
 718static size_t peak_pack_mapped;
 719static size_t pack_mapped;
 720struct packed_git *packed_git;
 721
 722static struct mru packed_git_mru_storage;
 723struct mru *packed_git_mru = &packed_git_mru_storage;
 724
 725void pack_report(void)
 726{
 727        fprintf(stderr,
 728                "pack_report: getpagesize()            = %10" SZ_FMT "\n"
 729                "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
 730                "pack_report: core.packedGitLimit      = %10" SZ_FMT "\n",
 731                sz_fmt(getpagesize()),
 732                sz_fmt(packed_git_window_size),
 733                sz_fmt(packed_git_limit));
 734        fprintf(stderr,
 735                "pack_report: pack_used_ctr            = %10u\n"
 736                "pack_report: pack_mmap_calls          = %10u\n"
 737                "pack_report: pack_open_windows        = %10u / %10u\n"
 738                "pack_report: pack_mapped              = "
 739                        "%10" SZ_FMT " / %10" SZ_FMT "\n",
 740                pack_used_ctr,
 741                pack_mmap_calls,
 742                pack_open_windows, peak_pack_open_windows,
 743                sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
 744}
 745
 746/*
 747 * Open and mmap the index file at path, perform a couple of
 748 * consistency checks, then record its information to p.  Return 0 on
 749 * success.
 750 */
 751static int check_packed_git_idx(const char *path, struct packed_git *p)
 752{
 753        void *idx_map;
 754        struct pack_idx_header *hdr;
 755        size_t idx_size;
 756        uint32_t version, nr, i, *index;
 757        int fd = git_open(path);
 758        struct stat st;
 759
 760        if (fd < 0)
 761                return -1;
 762        if (fstat(fd, &st)) {
 763                close(fd);
 764                return -1;
 765        }
 766        idx_size = xsize_t(st.st_size);
 767        if (idx_size < 4 * 256 + 20 + 20) {
 768                close(fd);
 769                return error("index file %s is too small", path);
 770        }
 771        idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
 772        close(fd);
 773
 774        hdr = idx_map;
 775        if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
 776                version = ntohl(hdr->idx_version);
 777                if (version < 2 || version > 2) {
 778                        munmap(idx_map, idx_size);
 779                        return error("index file %s is version %"PRIu32
 780                                     " and is not supported by this binary"
 781                                     " (try upgrading GIT to a newer version)",
 782                                     path, version);
 783                }
 784        } else
 785                version = 1;
 786
 787        nr = 0;
 788        index = idx_map;
 789        if (version > 1)
 790                index += 2;  /* skip index header */
 791        for (i = 0; i < 256; i++) {
 792                uint32_t n = ntohl(index[i]);
 793                if (n < nr) {
 794                        munmap(idx_map, idx_size);
 795                        return error("non-monotonic index %s", path);
 796                }
 797                nr = n;
 798        }
 799
 800        if (version == 1) {
 801                /*
 802                 * Total size:
 803                 *  - 256 index entries 4 bytes each
 804                 *  - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
 805                 *  - 20-byte SHA1 of the packfile
 806                 *  - 20-byte SHA1 file checksum
 807                 */
 808                if (idx_size != 4*256 + nr * 24 + 20 + 20) {
 809                        munmap(idx_map, idx_size);
 810                        return error("wrong index v1 file size in %s", path);
 811                }
 812        } else if (version == 2) {
 813                /*
 814                 * Minimum size:
 815                 *  - 8 bytes of header
 816                 *  - 256 index entries 4 bytes each
 817                 *  - 20-byte sha1 entry * nr
 818                 *  - 4-byte crc entry * nr
 819                 *  - 4-byte offset entry * nr
 820                 *  - 20-byte SHA1 of the packfile
 821                 *  - 20-byte SHA1 file checksum
 822                 * And after the 4-byte offset table might be a
 823                 * variable sized table containing 8-byte entries
 824                 * for offsets larger than 2^31.
 825                 */
 826                unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
 827                unsigned long max_size = min_size;
 828                if (nr)
 829                        max_size += (nr - 1)*8;
 830                if (idx_size < min_size || idx_size > max_size) {
 831                        munmap(idx_map, idx_size);
 832                        return error("wrong index v2 file size in %s", path);
 833                }
 834                if (idx_size != min_size &&
 835                    /*
 836                     * make sure we can deal with large pack offsets.
 837                     * 31-bit signed offset won't be enough, neither
 838                     * 32-bit unsigned one will be.
 839                     */
 840                    (sizeof(off_t) <= 4)) {
 841                        munmap(idx_map, idx_size);
 842                        return error("pack too large for current definition of off_t in %s", path);
 843                }
 844        }
 845
 846        p->index_version = version;
 847        p->index_data = idx_map;
 848        p->index_size = idx_size;
 849        p->num_objects = nr;
 850        return 0;
 851}
 852
 853int open_pack_index(struct packed_git *p)
 854{
 855        char *idx_name;
 856        size_t len;
 857        int ret;
 858
 859        if (p->index_data)
 860                return 0;
 861
 862        if (!strip_suffix(p->pack_name, ".pack", &len))
 863                die("BUG: pack_name does not end in .pack");
 864        idx_name = xstrfmt("%.*s.idx", (int)len, p->pack_name);
 865        ret = check_packed_git_idx(idx_name, p);
 866        free(idx_name);
 867        return ret;
 868}
 869
 870static void scan_windows(struct packed_git *p,
 871        struct packed_git **lru_p,
 872        struct pack_window **lru_w,
 873        struct pack_window **lru_l)
 874{
 875        struct pack_window *w, *w_l;
 876
 877        for (w_l = NULL, w = p->windows; w; w = w->next) {
 878                if (!w->inuse_cnt) {
 879                        if (!*lru_w || w->last_used < (*lru_w)->last_used) {
 880                                *lru_p = p;
 881                                *lru_w = w;
 882                                *lru_l = w_l;
 883                        }
 884                }
 885                w_l = w;
 886        }
 887}
 888
 889static int unuse_one_window(struct packed_git *current)
 890{
 891        struct packed_git *p, *lru_p = NULL;
 892        struct pack_window *lru_w = NULL, *lru_l = NULL;
 893
 894        if (current)
 895                scan_windows(current, &lru_p, &lru_w, &lru_l);
 896        for (p = packed_git; p; p = p->next)
 897                scan_windows(p, &lru_p, &lru_w, &lru_l);
 898        if (lru_p) {
 899                munmap(lru_w->base, lru_w->len);
 900                pack_mapped -= lru_w->len;
 901                if (lru_l)
 902                        lru_l->next = lru_w->next;
 903                else
 904                        lru_p->windows = lru_w->next;
 905                free(lru_w);
 906                pack_open_windows--;
 907                return 1;
 908        }
 909        return 0;
 910}
 911
 912void release_pack_memory(size_t need)
 913{
 914        size_t cur = pack_mapped;
 915        while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
 916                ; /* nothing */
 917}
 918
 919static void mmap_limit_check(size_t length)
 920{
 921        static size_t limit = 0;
 922        if (!limit) {
 923                limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
 924                if (!limit)
 925                        limit = SIZE_MAX;
 926        }
 927        if (length > limit)
 928                die("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX,
 929                    (uintmax_t)length, (uintmax_t)limit);
 930}
 931
 932void *xmmap_gently(void *start, size_t length,
 933                  int prot, int flags, int fd, off_t offset)
 934{
 935        void *ret;
 936
 937        mmap_limit_check(length);
 938        ret = mmap(start, length, prot, flags, fd, offset);
 939        if (ret == MAP_FAILED) {
 940                if (!length)
 941                        return NULL;
 942                release_pack_memory(length);
 943                ret = mmap(start, length, prot, flags, fd, offset);
 944        }
 945        return ret;
 946}
 947
 948void *xmmap(void *start, size_t length,
 949        int prot, int flags, int fd, off_t offset)
 950{
 951        void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
 952        if (ret == MAP_FAILED)
 953                die_errno("mmap failed");
 954        return ret;
 955}
 956
 957void close_pack_windows(struct packed_git *p)
 958{
 959        while (p->windows) {
 960                struct pack_window *w = p->windows;
 961
 962                if (w->inuse_cnt)
 963                        die("pack '%s' still has open windows to it",
 964                            p->pack_name);
 965                munmap(w->base, w->len);
 966                pack_mapped -= w->len;
 967                pack_open_windows--;
 968                p->windows = w->next;
 969                free(w);
 970        }
 971}
 972
 973static int close_pack_fd(struct packed_git *p)
 974{
 975        if (p->pack_fd < 0)
 976                return 0;
 977
 978        close(p->pack_fd);
 979        pack_open_fds--;
 980        p->pack_fd = -1;
 981
 982        return 1;
 983}
 984
 985static void close_pack(struct packed_git *p)
 986{
 987        close_pack_windows(p);
 988        close_pack_fd(p);
 989        close_pack_index(p);
 990}
 991
 992void close_all_packs(void)
 993{
 994        struct packed_git *p;
 995
 996        for (p = packed_git; p; p = p->next)
 997                if (p->do_not_close)
 998                        die("BUG: want to close pack marked 'do-not-close'");
 999                else
1000                        close_pack(p);
1001}
1002
1003
1004/*
1005 * The LRU pack is the one with the oldest MRU window, preferring packs
1006 * with no used windows, or the oldest mtime if it has no windows allocated.
1007 */
1008static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
1009{
1010        struct pack_window *w, *this_mru_w;
1011        int has_windows_inuse = 0;
1012
1013        /*
1014         * Reject this pack if it has windows and the previously selected
1015         * one does not.  If this pack does not have windows, reject
1016         * it if the pack file is newer than the previously selected one.
1017         */
1018        if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
1019                return;
1020
1021        for (w = this_mru_w = p->windows; w; w = w->next) {
1022                /*
1023                 * Reject this pack if any of its windows are in use,
1024                 * but the previously selected pack did not have any
1025                 * inuse windows.  Otherwise, record that this pack
1026                 * has windows in use.
1027                 */
1028                if (w->inuse_cnt) {
1029                        if (*accept_windows_inuse)
1030                                has_windows_inuse = 1;
1031                        else
1032                                return;
1033                }
1034
1035                if (w->last_used > this_mru_w->last_used)
1036                        this_mru_w = w;
1037
1038                /*
1039                 * Reject this pack if it has windows that have been
1040                 * used more recently than the previously selected pack.
1041                 * If the previously selected pack had windows inuse and
1042                 * we have not encountered a window in this pack that is
1043                 * inuse, skip this check since we prefer a pack with no
1044                 * inuse windows to one that has inuse windows.
1045                 */
1046                if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
1047                    this_mru_w->last_used > (*mru_w)->last_used)
1048                        return;
1049        }
1050
1051        /*
1052         * Select this pack.
1053         */
1054        *mru_w = this_mru_w;
1055        *lru_p = p;
1056        *accept_windows_inuse = has_windows_inuse;
1057}
1058
1059static int close_one_pack(void)
1060{
1061        struct packed_git *p, *lru_p = NULL;
1062        struct pack_window *mru_w = NULL;
1063        int accept_windows_inuse = 1;
1064
1065        for (p = packed_git; p; p = p->next) {
1066                if (p->pack_fd == -1)
1067                        continue;
1068                find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
1069        }
1070
1071        if (lru_p)
1072                return close_pack_fd(lru_p);
1073
1074        return 0;
1075}
1076
1077void unuse_pack(struct pack_window **w_cursor)
1078{
1079        struct pack_window *w = *w_cursor;
1080        if (w) {
1081                w->inuse_cnt--;
1082                *w_cursor = NULL;
1083        }
1084}
1085
1086void close_pack_index(struct packed_git *p)
1087{
1088        if (p->index_data) {
1089                munmap((void *)p->index_data, p->index_size);
1090                p->index_data = NULL;
1091        }
1092}
1093
1094static unsigned int get_max_fd_limit(void)
1095{
1096#ifdef RLIMIT_NOFILE
1097        {
1098                struct rlimit lim;
1099
1100                if (!getrlimit(RLIMIT_NOFILE, &lim))
1101                        return lim.rlim_cur;
1102        }
1103#endif
1104
1105#ifdef _SC_OPEN_MAX
1106        {
1107                long open_max = sysconf(_SC_OPEN_MAX);
1108                if (0 < open_max)
1109                        return open_max;
1110                /*
1111                 * Otherwise, we got -1 for one of the two
1112                 * reasons:
1113                 *
1114                 * (1) sysconf() did not understand _SC_OPEN_MAX
1115                 *     and signaled an error with -1; or
1116                 * (2) sysconf() said there is no limit.
1117                 *
1118                 * We _could_ clear errno before calling sysconf() to
1119                 * tell these two cases apart and return a huge number
1120                 * in the latter case to let the caller cap it to a
1121                 * value that is not so selfish, but letting the
1122                 * fallback OPEN_MAX codepath take care of these cases
1123                 * is a lot simpler.
1124                 */
1125        }
1126#endif
1127
1128#ifdef OPEN_MAX
1129        return OPEN_MAX;
1130#else
1131        return 1; /* see the caller ;-) */
1132#endif
1133}
1134
1135/*
1136 * Do not call this directly as this leaks p->pack_fd on error return;
1137 * call open_packed_git() instead.
1138 */
1139static int open_packed_git_1(struct packed_git *p)
1140{
1141        struct stat st;
1142        struct pack_header hdr;
1143        unsigned char sha1[20];
1144        unsigned char *idx_sha1;
1145        long fd_flag;
1146
1147        if (!p->index_data && open_pack_index(p))
1148                return error("packfile %s index unavailable", p->pack_name);
1149
1150        if (!pack_max_fds) {
1151                unsigned int max_fds = get_max_fd_limit();
1152
1153                /* Save 3 for stdin/stdout/stderr, 22 for work */
1154                if (25 < max_fds)
1155                        pack_max_fds = max_fds - 25;
1156                else
1157                        pack_max_fds = 1;
1158        }
1159
1160        while (pack_max_fds <= pack_open_fds && close_one_pack())
1161                ; /* nothing */
1162
1163        p->pack_fd = git_open(p->pack_name);
1164        if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
1165                return -1;
1166        pack_open_fds++;
1167
1168        /* If we created the struct before we had the pack we lack size. */
1169        if (!p->pack_size) {
1170                if (!S_ISREG(st.st_mode))
1171                        return error("packfile %s not a regular file", p->pack_name);
1172                p->pack_size = st.st_size;
1173        } else if (p->pack_size != st.st_size)
1174                return error("packfile %s size changed", p->pack_name);
1175
1176        /* We leave these file descriptors open with sliding mmap;
1177         * there is no point keeping them open across exec(), though.
1178         */
1179        fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
1180        if (fd_flag < 0)
1181                return error("cannot determine file descriptor flags");
1182        fd_flag |= FD_CLOEXEC;
1183        if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
1184                return error("cannot set FD_CLOEXEC");
1185
1186        /* Verify we recognize this pack file format. */
1187        if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
1188                return error("file %s is far too short to be a packfile", p->pack_name);
1189        if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
1190                return error("file %s is not a GIT packfile", p->pack_name);
1191        if (!pack_version_ok(hdr.hdr_version))
1192                return error("packfile %s is version %"PRIu32" and not"
1193                        " supported (try upgrading GIT to a newer version)",
1194                        p->pack_name, ntohl(hdr.hdr_version));
1195
1196        /* Verify the pack matches its index. */
1197        if (p->num_objects != ntohl(hdr.hdr_entries))
1198                return error("packfile %s claims to have %"PRIu32" objects"
1199                             " while index indicates %"PRIu32" objects",
1200                             p->pack_name, ntohl(hdr.hdr_entries),
1201                             p->num_objects);
1202        if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
1203                return error("end of packfile %s is unavailable", p->pack_name);
1204        if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
1205                return error("packfile %s signature is unavailable", p->pack_name);
1206        idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
1207        if (hashcmp(sha1, idx_sha1))
1208                return error("packfile %s does not match index", p->pack_name);
1209        return 0;
1210}
1211
1212static int open_packed_git(struct packed_git *p)
1213{
1214        if (!open_packed_git_1(p))
1215                return 0;
1216        close_pack_fd(p);
1217        return -1;
1218}
1219
1220static int in_window(struct pack_window *win, off_t offset)
1221{
1222        /* We must promise at least 20 bytes (one hash) after the
1223         * offset is available from this window, otherwise the offset
1224         * is not actually in this window and a different window (which
1225         * has that one hash excess) must be used.  This is to support
1226         * the object header and delta base parsing routines below.
1227         */
1228        off_t win_off = win->offset;
1229        return win_off <= offset
1230                && (offset + 20) <= (win_off + win->len);
1231}
1232
1233unsigned char *use_pack(struct packed_git *p,
1234                struct pack_window **w_cursor,
1235                off_t offset,
1236                unsigned long *left)
1237{
1238        struct pack_window *win = *w_cursor;
1239
1240        /* Since packfiles end in a hash of their content and it's
1241         * pointless to ask for an offset into the middle of that
1242         * hash, and the in_window function above wouldn't match
1243         * don't allow an offset too close to the end of the file.
1244         */
1245        if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
1246                die("packfile %s cannot be accessed", p->pack_name);
1247        if (offset > (p->pack_size - 20))
1248                die("offset beyond end of packfile (truncated pack?)");
1249        if (offset < 0)
1250                die(_("offset before end of packfile (broken .idx?)"));
1251
1252        if (!win || !in_window(win, offset)) {
1253                if (win)
1254                        win->inuse_cnt--;
1255                for (win = p->windows; win; win = win->next) {
1256                        if (in_window(win, offset))
1257                                break;
1258                }
1259                if (!win) {
1260                        size_t window_align = packed_git_window_size / 2;
1261                        off_t len;
1262
1263                        if (p->pack_fd == -1 && open_packed_git(p))
1264                                die("packfile %s cannot be accessed", p->pack_name);
1265
1266                        win = xcalloc(1, sizeof(*win));
1267                        win->offset = (offset / window_align) * window_align;
1268                        len = p->pack_size - win->offset;
1269                        if (len > packed_git_window_size)
1270                                len = packed_git_window_size;
1271                        win->len = (size_t)len;
1272                        pack_mapped += win->len;
1273                        while (packed_git_limit < pack_mapped
1274                                && unuse_one_window(p))
1275                                ; /* nothing */
1276                        win->base = xmmap(NULL, win->len,
1277                                PROT_READ, MAP_PRIVATE,
1278                                p->pack_fd, win->offset);
1279                        if (win->base == MAP_FAILED)
1280                                die_errno("packfile %s cannot be mapped",
1281                                          p->pack_name);
1282                        if (!win->offset && win->len == p->pack_size
1283                                && !p->do_not_close)
1284                                close_pack_fd(p);
1285                        pack_mmap_calls++;
1286                        pack_open_windows++;
1287                        if (pack_mapped > peak_pack_mapped)
1288                                peak_pack_mapped = pack_mapped;
1289                        if (pack_open_windows > peak_pack_open_windows)
1290                                peak_pack_open_windows = pack_open_windows;
1291                        win->next = p->windows;
1292                        p->windows = win;
1293                }
1294        }
1295        if (win != *w_cursor) {
1296                win->last_used = pack_used_ctr++;
1297                win->inuse_cnt++;
1298                *w_cursor = win;
1299        }
1300        offset -= win->offset;
1301        if (left)
1302                *left = win->len - xsize_t(offset);
1303        return win->base + offset;
1304}
1305
1306static struct packed_git *alloc_packed_git(int extra)
1307{
1308        struct packed_git *p = xmalloc(st_add(sizeof(*p), extra));
1309        memset(p, 0, sizeof(*p));
1310        p->pack_fd = -1;
1311        return p;
1312}
1313
1314static void try_to_free_pack_memory(size_t size)
1315{
1316        release_pack_memory(size);
1317}
1318
1319struct packed_git *add_packed_git(const char *path, size_t path_len, int local)
1320{
1321        static int have_set_try_to_free_routine;
1322        struct stat st;
1323        size_t alloc;
1324        struct packed_git *p;
1325
1326        if (!have_set_try_to_free_routine) {
1327                have_set_try_to_free_routine = 1;
1328                set_try_to_free_routine(try_to_free_pack_memory);
1329        }
1330
1331        /*
1332         * Make sure a corresponding .pack file exists and that
1333         * the index looks sane.
1334         */
1335        if (!strip_suffix_mem(path, &path_len, ".idx"))
1336                return NULL;
1337
1338        /*
1339         * ".pack" is long enough to hold any suffix we're adding (and
1340         * the use xsnprintf double-checks that)
1341         */
1342        alloc = st_add3(path_len, strlen(".pack"), 1);
1343        p = alloc_packed_git(alloc);
1344        memcpy(p->pack_name, path, path_len);
1345
1346        xsnprintf(p->pack_name + path_len, alloc - path_len, ".keep");
1347        if (!access(p->pack_name, F_OK))
1348                p->pack_keep = 1;
1349
1350        xsnprintf(p->pack_name + path_len, alloc - path_len, ".pack");
1351        if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1352                free(p);
1353                return NULL;
1354        }
1355
1356        /* ok, it looks sane as far as we can check without
1357         * actually mapping the pack file.
1358         */
1359        p->pack_size = st.st_size;
1360        p->pack_local = local;
1361        p->mtime = st.st_mtime;
1362        if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1363                hashclr(p->sha1);
1364        return p;
1365}
1366
1367struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1368{
1369        const char *path = sha1_pack_name(sha1);
1370        size_t alloc = st_add(strlen(path), 1);
1371        struct packed_git *p = alloc_packed_git(alloc);
1372
1373        memcpy(p->pack_name, path, alloc); /* includes NUL */
1374        hashcpy(p->sha1, sha1);
1375        if (check_packed_git_idx(idx_path, p)) {
1376                free(p);
1377                return NULL;
1378        }
1379
1380        return p;
1381}
1382
1383void install_packed_git(struct packed_git *pack)
1384{
1385        if (pack->pack_fd != -1)
1386                pack_open_fds++;
1387
1388        pack->next = packed_git;
1389        packed_git = pack;
1390}
1391
1392void (*report_garbage)(unsigned seen_bits, const char *path);
1393
1394static void report_helper(const struct string_list *list,
1395                          int seen_bits, int first, int last)
1396{
1397        if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
1398                return;
1399
1400        for (; first < last; first++)
1401                report_garbage(seen_bits, list->items[first].string);
1402}
1403
1404static void report_pack_garbage(struct string_list *list)
1405{
1406        int i, baselen = -1, first = 0, seen_bits = 0;
1407
1408        if (!report_garbage)
1409                return;
1410
1411        string_list_sort(list);
1412
1413        for (i = 0; i < list->nr; i++) {
1414                const char *path = list->items[i].string;
1415                if (baselen != -1 &&
1416                    strncmp(path, list->items[first].string, baselen)) {
1417                        report_helper(list, seen_bits, first, i);
1418                        baselen = -1;
1419                        seen_bits = 0;
1420                }
1421                if (baselen == -1) {
1422                        const char *dot = strrchr(path, '.');
1423                        if (!dot) {
1424                                report_garbage(PACKDIR_FILE_GARBAGE, path);
1425                                continue;
1426                        }
1427                        baselen = dot - path + 1;
1428                        first = i;
1429                }
1430                if (!strcmp(path + baselen, "pack"))
1431                        seen_bits |= 1;
1432                else if (!strcmp(path + baselen, "idx"))
1433                        seen_bits |= 2;
1434        }
1435        report_helper(list, seen_bits, first, list->nr);
1436}
1437
1438static void prepare_packed_git_one(char *objdir, int local)
1439{
1440        struct strbuf path = STRBUF_INIT;
1441        size_t dirnamelen;
1442        DIR *dir;
1443        struct dirent *de;
1444        struct string_list garbage = STRING_LIST_INIT_DUP;
1445
1446        strbuf_addstr(&path, objdir);
1447        strbuf_addstr(&path, "/pack");
1448        dir = opendir(path.buf);
1449        if (!dir) {
1450                if (errno != ENOENT)
1451                        error_errno("unable to open object pack directory: %s",
1452                                    path.buf);
1453                strbuf_release(&path);
1454                return;
1455        }
1456        strbuf_addch(&path, '/');
1457        dirnamelen = path.len;
1458        while ((de = readdir(dir)) != NULL) {
1459                struct packed_git *p;
1460                size_t base_len;
1461
1462                if (is_dot_or_dotdot(de->d_name))
1463                        continue;
1464
1465                strbuf_setlen(&path, dirnamelen);
1466                strbuf_addstr(&path, de->d_name);
1467
1468                base_len = path.len;
1469                if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
1470                        /* Don't reopen a pack we already have. */
1471                        for (p = packed_git; p; p = p->next) {
1472                                size_t len;
1473                                if (strip_suffix(p->pack_name, ".pack", &len) &&
1474                                    len == base_len &&
1475                                    !memcmp(p->pack_name, path.buf, len))
1476                                        break;
1477                        }
1478                        if (p == NULL &&
1479                            /*
1480                             * See if it really is a valid .idx file with
1481                             * corresponding .pack file that we can map.
1482                             */
1483                            (p = add_packed_git(path.buf, path.len, local)) != NULL)
1484                                install_packed_git(p);
1485                }
1486
1487                if (!report_garbage)
1488                        continue;
1489
1490                if (ends_with(de->d_name, ".idx") ||
1491                    ends_with(de->d_name, ".pack") ||
1492                    ends_with(de->d_name, ".bitmap") ||
1493                    ends_with(de->d_name, ".keep"))
1494                        string_list_append(&garbage, path.buf);
1495                else
1496                        report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
1497        }
1498        closedir(dir);
1499        report_pack_garbage(&garbage);
1500        string_list_clear(&garbage, 0);
1501        strbuf_release(&path);
1502}
1503
1504static int approximate_object_count_valid;
1505
1506/*
1507 * Give a fast, rough count of the number of objects in the repository. This
1508 * ignores loose objects completely. If you have a lot of them, then either
1509 * you should repack because your performance will be awful, or they are
1510 * all unreachable objects about to be pruned, in which case they're not really
1511 * interesting as a measure of repo size in the first place.
1512 */
1513unsigned long approximate_object_count(void)
1514{
1515        static unsigned long count;
1516        if (!approximate_object_count_valid) {
1517                struct packed_git *p;
1518
1519                prepare_packed_git();
1520                count = 0;
1521                for (p = packed_git; p; p = p->next) {
1522                        if (open_pack_index(p))
1523                                continue;
1524                        count += p->num_objects;
1525                }
1526        }
1527        return count;
1528}
1529
1530static void *get_next_packed_git(const void *p)
1531{
1532        return ((const struct packed_git *)p)->next;
1533}
1534
1535static void set_next_packed_git(void *p, void *next)
1536{
1537        ((struct packed_git *)p)->next = next;
1538}
1539
1540static int sort_pack(const void *a_, const void *b_)
1541{
1542        const struct packed_git *a = a_;
1543        const struct packed_git *b = b_;
1544        int st;
1545
1546        /*
1547         * Local packs tend to contain objects specific to our
1548         * variant of the project than remote ones.  In addition,
1549         * remote ones could be on a network mounted filesystem.
1550         * Favor local ones for these reasons.
1551         */
1552        st = a->pack_local - b->pack_local;
1553        if (st)
1554                return -st;
1555
1556        /*
1557         * Younger packs tend to contain more recent objects,
1558         * and more recent objects tend to get accessed more
1559         * often.
1560         */
1561        if (a->mtime < b->mtime)
1562                return 1;
1563        else if (a->mtime == b->mtime)
1564                return 0;
1565        return -1;
1566}
1567
1568static void rearrange_packed_git(void)
1569{
1570        packed_git = llist_mergesort(packed_git, get_next_packed_git,
1571                                     set_next_packed_git, sort_pack);
1572}
1573
1574static void prepare_packed_git_mru(void)
1575{
1576        struct packed_git *p;
1577
1578        mru_clear(packed_git_mru);
1579        for (p = packed_git; p; p = p->next)
1580                mru_append(packed_git_mru, p);
1581}
1582
1583static int prepare_packed_git_run_once = 0;
1584void prepare_packed_git(void)
1585{
1586        struct alternate_object_database *alt;
1587
1588        if (prepare_packed_git_run_once)
1589                return;
1590        prepare_packed_git_one(get_object_directory(), 1);
1591        prepare_alt_odb();
1592        for (alt = alt_odb_list; alt; alt = alt->next)
1593                prepare_packed_git_one(alt->path, 0);
1594        rearrange_packed_git();
1595        prepare_packed_git_mru();
1596        prepare_packed_git_run_once = 1;
1597}
1598
1599void reprepare_packed_git(void)
1600{
1601        approximate_object_count_valid = 0;
1602        prepare_packed_git_run_once = 0;
1603        prepare_packed_git();
1604}
1605
1606static void mark_bad_packed_object(struct packed_git *p,
1607                                   const unsigned char *sha1)
1608{
1609        unsigned i;
1610        for (i = 0; i < p->num_bad_objects; i++)
1611                if (!hashcmp(sha1, p->bad_object_sha1 + GIT_SHA1_RAWSZ * i))
1612                        return;
1613        p->bad_object_sha1 = xrealloc(p->bad_object_sha1,
1614                                      st_mult(GIT_SHA1_RAWSZ,
1615                                              st_add(p->num_bad_objects, 1)));
1616        hashcpy(p->bad_object_sha1 + GIT_SHA1_RAWSZ * p->num_bad_objects, sha1);
1617        p->num_bad_objects++;
1618}
1619
1620static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1621{
1622        struct packed_git *p;
1623        unsigned i;
1624
1625        for (p = packed_git; p; p = p->next)
1626                for (i = 0; i < p->num_bad_objects; i++)
1627                        if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1628                                return p;
1629        return NULL;
1630}
1631
1632/*
1633 * With an in-core object data in "map", rehash it to make sure the
1634 * object name actually matches "sha1" to detect object corruption.
1635 * With "map" == NULL, try reading the object named with "sha1" using
1636 * the streaming interface and rehash it to do the same.
1637 */
1638int check_sha1_signature(const unsigned char *sha1, void *map,
1639                         unsigned long size, const char *type)
1640{
1641        unsigned char real_sha1[20];
1642        enum object_type obj_type;
1643        struct git_istream *st;
1644        git_SHA_CTX c;
1645        char hdr[32];
1646        int hdrlen;
1647
1648        if (map) {
1649                hash_sha1_file(map, size, type, real_sha1);
1650                return hashcmp(sha1, real_sha1) ? -1 : 0;
1651        }
1652
1653        st = open_istream(sha1, &obj_type, &size, NULL);
1654        if (!st)
1655                return -1;
1656
1657        /* Generate the header */
1658        hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(obj_type), size) + 1;
1659
1660        /* Sha1.. */
1661        git_SHA1_Init(&c);
1662        git_SHA1_Update(&c, hdr, hdrlen);
1663        for (;;) {
1664                char buf[1024 * 16];
1665                ssize_t readlen = read_istream(st, buf, sizeof(buf));
1666
1667                if (readlen < 0) {
1668                        close_istream(st);
1669                        return -1;
1670                }
1671                if (!readlen)
1672                        break;
1673                git_SHA1_Update(&c, buf, readlen);
1674        }
1675        git_SHA1_Final(real_sha1, &c);
1676        close_istream(st);
1677        return hashcmp(sha1, real_sha1) ? -1 : 0;
1678}
1679
1680int git_open_cloexec(const char *name, int flags)
1681{
1682        int fd;
1683        static int o_cloexec = O_CLOEXEC;
1684
1685        fd = open(name, flags | o_cloexec);
1686        if ((o_cloexec & O_CLOEXEC) && fd < 0 && errno == EINVAL) {
1687                /* Try again w/o O_CLOEXEC: the kernel might not support it */
1688                o_cloexec &= ~O_CLOEXEC;
1689                fd = open(name, flags | o_cloexec);
1690        }
1691
1692#if defined(F_GETFL) && defined(F_SETFL) && defined(FD_CLOEXEC)
1693        {
1694                static int fd_cloexec = FD_CLOEXEC;
1695
1696                if (!o_cloexec && 0 <= fd && fd_cloexec) {
1697                        /* Opened w/o O_CLOEXEC?  try with fcntl(2) to add it */
1698                        int flags = fcntl(fd, F_GETFL);
1699                        if (fcntl(fd, F_SETFL, flags | fd_cloexec))
1700                                fd_cloexec = 0;
1701                }
1702        }
1703#endif
1704        return fd;
1705}
1706
1707/*
1708 * Find "sha1" as a loose object in the local repository or in an alternate.
1709 * Returns 0 on success, negative on failure.
1710 *
1711 * The "path" out-parameter will give the path of the object we found (if any).
1712 * Note that it may point to static storage and is only valid until another
1713 * call to sha1_file_name(), etc.
1714 */
1715static int stat_sha1_file(const unsigned char *sha1, struct stat *st,
1716                          const char **path)
1717{
1718        struct alternate_object_database *alt;
1719
1720        *path = sha1_file_name(sha1);
1721        if (!lstat(*path, st))
1722                return 0;
1723
1724        prepare_alt_odb();
1725        errno = ENOENT;
1726        for (alt = alt_odb_list; alt; alt = alt->next) {
1727                *path = alt_sha1_path(alt, sha1);
1728                if (!lstat(*path, st))
1729                        return 0;
1730        }
1731
1732        return -1;
1733}
1734
1735/*
1736 * Like stat_sha1_file(), but actually open the object and return the
1737 * descriptor. See the caveats on the "path" parameter above.
1738 */
1739static int open_sha1_file(const unsigned char *sha1, const char **path)
1740{
1741        int fd;
1742        struct alternate_object_database *alt;
1743        int most_interesting_errno;
1744
1745        *path = sha1_file_name(sha1);
1746        fd = git_open(*path);
1747        if (fd >= 0)
1748                return fd;
1749        most_interesting_errno = errno;
1750
1751        prepare_alt_odb();
1752        for (alt = alt_odb_list; alt; alt = alt->next) {
1753                *path = alt_sha1_path(alt, sha1);
1754                fd = git_open(*path);
1755                if (fd >= 0)
1756                        return fd;
1757                if (most_interesting_errno == ENOENT)
1758                        most_interesting_errno = errno;
1759        }
1760        errno = most_interesting_errno;
1761        return -1;
1762}
1763
1764/*
1765 * Map the loose object at "path" if it is not NULL, or the path found by
1766 * searching for a loose object named "sha1".
1767 */
1768static void *map_sha1_file_1(const char *path,
1769                             const unsigned char *sha1,
1770                             unsigned long *size)
1771{
1772        void *map;
1773        int fd;
1774
1775        if (path)
1776                fd = git_open(path);
1777        else
1778                fd = open_sha1_file(sha1, &path);
1779        map = NULL;
1780        if (fd >= 0) {
1781                struct stat st;
1782
1783                if (!fstat(fd, &st)) {
1784                        *size = xsize_t(st.st_size);
1785                        if (!*size) {
1786                                /* mmap() is forbidden on empty files */
1787                                error("object file %s is empty", path);
1788                                return NULL;
1789                        }
1790                        map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1791                }
1792                close(fd);
1793        }
1794        return map;
1795}
1796
1797void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1798{
1799        return map_sha1_file_1(NULL, sha1, size);
1800}
1801
1802unsigned long unpack_object_header_buffer(const unsigned char *buf,
1803                unsigned long len, enum object_type *type, unsigned long *sizep)
1804{
1805        unsigned shift;
1806        unsigned long size, c;
1807        unsigned long used = 0;
1808
1809        c = buf[used++];
1810        *type = (c >> 4) & 7;
1811        size = c & 15;
1812        shift = 4;
1813        while (c & 0x80) {
1814                if (len <= used || bitsizeof(long) <= shift) {
1815                        error("bad object header");
1816                        size = used = 0;
1817                        break;
1818                }
1819                c = buf[used++];
1820                size += (c & 0x7f) << shift;
1821                shift += 7;
1822        }
1823        *sizep = size;
1824        return used;
1825}
1826
1827static int unpack_sha1_short_header(git_zstream *stream,
1828                                    unsigned char *map, unsigned long mapsize,
1829                                    void *buffer, unsigned long bufsiz)
1830{
1831        /* Get the data stream */
1832        memset(stream, 0, sizeof(*stream));
1833        stream->next_in = map;
1834        stream->avail_in = mapsize;
1835        stream->next_out = buffer;
1836        stream->avail_out = bufsiz;
1837
1838        git_inflate_init(stream);
1839        return git_inflate(stream, 0);
1840}
1841
1842int unpack_sha1_header(git_zstream *stream,
1843                       unsigned char *map, unsigned long mapsize,
1844                       void *buffer, unsigned long bufsiz)
1845{
1846        int status = unpack_sha1_short_header(stream, map, mapsize,
1847                                              buffer, bufsiz);
1848
1849        if (status < Z_OK)
1850                return status;
1851
1852        /* Make sure we have the terminating NUL */
1853        if (!memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1854                return -1;
1855        return 0;
1856}
1857
1858static int unpack_sha1_header_to_strbuf(git_zstream *stream, unsigned char *map,
1859                                        unsigned long mapsize, void *buffer,
1860                                        unsigned long bufsiz, struct strbuf *header)
1861{
1862        int status;
1863
1864        status = unpack_sha1_short_header(stream, map, mapsize, buffer, bufsiz);
1865        if (status < Z_OK)
1866                return -1;
1867
1868        /*
1869         * Check if entire header is unpacked in the first iteration.
1870         */
1871        if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1872                return 0;
1873
1874        /*
1875         * buffer[0..bufsiz] was not large enough.  Copy the partial
1876         * result out to header, and then append the result of further
1877         * reading the stream.
1878         */
1879        strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1880        stream->next_out = buffer;
1881        stream->avail_out = bufsiz;
1882
1883        do {
1884                status = git_inflate(stream, 0);
1885                strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1886                if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1887                        return 0;
1888                stream->next_out = buffer;
1889                stream->avail_out = bufsiz;
1890        } while (status != Z_STREAM_END);
1891        return -1;
1892}
1893
1894static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1895{
1896        int bytes = strlen(buffer) + 1;
1897        unsigned char *buf = xmallocz(size);
1898        unsigned long n;
1899        int status = Z_OK;
1900
1901        n = stream->total_out - bytes;
1902        if (n > size)
1903                n = size;
1904        memcpy(buf, (char *) buffer + bytes, n);
1905        bytes = n;
1906        if (bytes <= size) {
1907                /*
1908                 * The above condition must be (bytes <= size), not
1909                 * (bytes < size).  In other words, even though we
1910                 * expect no more output and set avail_out to zero,
1911                 * the input zlib stream may have bytes that express
1912                 * "this concludes the stream", and we *do* want to
1913                 * eat that input.
1914                 *
1915                 * Otherwise we would not be able to test that we
1916                 * consumed all the input to reach the expected size;
1917                 * we also want to check that zlib tells us that all
1918                 * went well with status == Z_STREAM_END at the end.
1919                 */
1920                stream->next_out = buf + bytes;
1921                stream->avail_out = size - bytes;
1922                while (status == Z_OK)
1923                        status = git_inflate(stream, Z_FINISH);
1924        }
1925        if (status == Z_STREAM_END && !stream->avail_in) {
1926                git_inflate_end(stream);
1927                return buf;
1928        }
1929
1930        if (status < 0)
1931                error("corrupt loose object '%s'", sha1_to_hex(sha1));
1932        else if (stream->avail_in)
1933                error("garbage at end of loose object '%s'",
1934                      sha1_to_hex(sha1));
1935        free(buf);
1936        return NULL;
1937}
1938
1939/*
1940 * We used to just use "sscanf()", but that's actually way
1941 * too permissive for what we want to check. So do an anal
1942 * object header parse by hand.
1943 */
1944static int parse_sha1_header_extended(const char *hdr, struct object_info *oi,
1945                               unsigned int flags)
1946{
1947        const char *type_buf = hdr;
1948        unsigned long size;
1949        int type, type_len = 0;
1950
1951        /*
1952         * The type can be of any size but is followed by
1953         * a space.
1954         */
1955        for (;;) {
1956                char c = *hdr++;
1957                if (!c)
1958                        return -1;
1959                if (c == ' ')
1960                        break;
1961                type_len++;
1962        }
1963
1964        type = type_from_string_gently(type_buf, type_len, 1);
1965        if (oi->typename)
1966                strbuf_add(oi->typename, type_buf, type_len);
1967        /*
1968         * Set type to 0 if its an unknown object and
1969         * we're obtaining the type using '--allow-unknown-type'
1970         * option.
1971         */
1972        if ((flags & LOOKUP_UNKNOWN_OBJECT) && (type < 0))
1973                type = 0;
1974        else if (type < 0)
1975                die("invalid object type");
1976        if (oi->typep)
1977                *oi->typep = type;
1978
1979        /*
1980         * The length must follow immediately, and be in canonical
1981         * decimal format (ie "010" is not valid).
1982         */
1983        size = *hdr++ - '0';
1984        if (size > 9)
1985                return -1;
1986        if (size) {
1987                for (;;) {
1988                        unsigned long c = *hdr - '0';
1989                        if (c > 9)
1990                                break;
1991                        hdr++;
1992                        size = size * 10 + c;
1993                }
1994        }
1995
1996        if (oi->sizep)
1997                *oi->sizep = size;
1998
1999        /*
2000         * The length must be followed by a zero byte
2001         */
2002        return *hdr ? -1 : type;
2003}
2004
2005int parse_sha1_header(const char *hdr, unsigned long *sizep)
2006{
2007        struct object_info oi = OBJECT_INFO_INIT;
2008
2009        oi.sizep = sizep;
2010        return parse_sha1_header_extended(hdr, &oi, LOOKUP_REPLACE_OBJECT);
2011}
2012
2013static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
2014{
2015        int ret;
2016        git_zstream stream;
2017        char hdr[8192];
2018
2019        ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
2020        if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
2021                return NULL;
2022
2023        return unpack_sha1_rest(&stream, hdr, *size, sha1);
2024}
2025
2026unsigned long get_size_from_delta(struct packed_git *p,
2027                                  struct pack_window **w_curs,
2028                                  off_t curpos)
2029{
2030        const unsigned char *data;
2031        unsigned char delta_head[20], *in;
2032        git_zstream stream;
2033        int st;
2034
2035        memset(&stream, 0, sizeof(stream));
2036        stream.next_out = delta_head;
2037        stream.avail_out = sizeof(delta_head);
2038
2039        git_inflate_init(&stream);
2040        do {
2041                in = use_pack(p, w_curs, curpos, &stream.avail_in);
2042                stream.next_in = in;
2043                st = git_inflate(&stream, Z_FINISH);
2044                curpos += stream.next_in - in;
2045        } while ((st == Z_OK || st == Z_BUF_ERROR) &&
2046                 stream.total_out < sizeof(delta_head));
2047        git_inflate_end(&stream);
2048        if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
2049                error("delta data unpack-initial failed");
2050                return 0;
2051        }
2052
2053        /* Examine the initial part of the delta to figure out
2054         * the result size.
2055         */
2056        data = delta_head;
2057
2058        /* ignore base size */
2059        get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
2060
2061        /* Read the result size */
2062        return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
2063}
2064
2065static off_t get_delta_base(struct packed_git *p,
2066                                    struct pack_window **w_curs,
2067                                    off_t *curpos,
2068                                    enum object_type type,
2069                                    off_t delta_obj_offset)
2070{
2071        unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
2072        off_t base_offset;
2073
2074        /* use_pack() assured us we have [base_info, base_info + 20)
2075         * as a range that we can look at without walking off the
2076         * end of the mapped window.  Its actually the hash size
2077         * that is assured.  An OFS_DELTA longer than the hash size
2078         * is stupid, as then a REF_DELTA would be smaller to store.
2079         */
2080        if (type == OBJ_OFS_DELTA) {
2081                unsigned used = 0;
2082                unsigned char c = base_info[used++];
2083                base_offset = c & 127;
2084                while (c & 128) {
2085                        base_offset += 1;
2086                        if (!base_offset || MSB(base_offset, 7))
2087                                return 0;  /* overflow */
2088                        c = base_info[used++];
2089                        base_offset = (base_offset << 7) + (c & 127);
2090                }
2091                base_offset = delta_obj_offset - base_offset;
2092                if (base_offset <= 0 || base_offset >= delta_obj_offset)
2093                        return 0;  /* out of bound */
2094                *curpos += used;
2095        } else if (type == OBJ_REF_DELTA) {
2096                /* The base entry _must_ be in the same pack */
2097                base_offset = find_pack_entry_one(base_info, p);
2098                *curpos += 20;
2099        } else
2100                die("I am totally screwed");
2101        return base_offset;
2102}
2103
2104/*
2105 * Like get_delta_base above, but we return the sha1 instead of the pack
2106 * offset. This means it is cheaper for REF deltas (we do not have to do
2107 * the final object lookup), but more expensive for OFS deltas (we
2108 * have to load the revidx to convert the offset back into a sha1).
2109 */
2110static const unsigned char *get_delta_base_sha1(struct packed_git *p,
2111                                                struct pack_window **w_curs,
2112                                                off_t curpos,
2113                                                enum object_type type,
2114                                                off_t delta_obj_offset)
2115{
2116        if (type == OBJ_REF_DELTA) {
2117                unsigned char *base = use_pack(p, w_curs, curpos, NULL);
2118                return base;
2119        } else if (type == OBJ_OFS_DELTA) {
2120                struct revindex_entry *revidx;
2121                off_t base_offset = get_delta_base(p, w_curs, &curpos,
2122                                                   type, delta_obj_offset);
2123
2124                if (!base_offset)
2125                        return NULL;
2126
2127                revidx = find_pack_revindex(p, base_offset);
2128                if (!revidx)
2129                        return NULL;
2130
2131                return nth_packed_object_sha1(p, revidx->nr);
2132        } else
2133                return NULL;
2134}
2135
2136int unpack_object_header(struct packed_git *p,
2137                         struct pack_window **w_curs,
2138                         off_t *curpos,
2139                         unsigned long *sizep)
2140{
2141        unsigned char *base;
2142        unsigned long left;
2143        unsigned long used;
2144        enum object_type type;
2145
2146        /* use_pack() assures us we have [base, base + 20) available
2147         * as a range that we can look at.  (Its actually the hash
2148         * size that is assured.)  With our object header encoding
2149         * the maximum deflated object size is 2^137, which is just
2150         * insane, so we know won't exceed what we have been given.
2151         */
2152        base = use_pack(p, w_curs, *curpos, &left);
2153        used = unpack_object_header_buffer(base, left, &type, sizep);
2154        if (!used) {
2155                type = OBJ_BAD;
2156        } else
2157                *curpos += used;
2158
2159        return type;
2160}
2161
2162static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
2163{
2164        int type;
2165        struct revindex_entry *revidx;
2166        const unsigned char *sha1;
2167        revidx = find_pack_revindex(p, obj_offset);
2168        if (!revidx)
2169                return OBJ_BAD;
2170        sha1 = nth_packed_object_sha1(p, revidx->nr);
2171        mark_bad_packed_object(p, sha1);
2172        type = sha1_object_info(sha1, NULL);
2173        if (type <= OBJ_NONE)
2174                return OBJ_BAD;
2175        return type;
2176}
2177
2178#define POI_STACK_PREALLOC 64
2179
2180static enum object_type packed_to_object_type(struct packed_git *p,
2181                                              off_t obj_offset,
2182                                              enum object_type type,
2183                                              struct pack_window **w_curs,
2184                                              off_t curpos)
2185{
2186        off_t small_poi_stack[POI_STACK_PREALLOC];
2187        off_t *poi_stack = small_poi_stack;
2188        int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
2189
2190        while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2191                off_t base_offset;
2192                unsigned long size;
2193                /* Push the object we're going to leave behind */
2194                if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
2195                        poi_stack_alloc = alloc_nr(poi_stack_nr);
2196                        ALLOC_ARRAY(poi_stack, poi_stack_alloc);
2197                        memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
2198                } else {
2199                        ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
2200                }
2201                poi_stack[poi_stack_nr++] = obj_offset;
2202                /* If parsing the base offset fails, just unwind */
2203                base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
2204                if (!base_offset)
2205                        goto unwind;
2206                curpos = obj_offset = base_offset;
2207                type = unpack_object_header(p, w_curs, &curpos, &size);
2208                if (type <= OBJ_NONE) {
2209                        /* If getting the base itself fails, we first
2210                         * retry the base, otherwise unwind */
2211                        type = retry_bad_packed_offset(p, base_offset);
2212                        if (type > OBJ_NONE)
2213                                goto out;
2214                        goto unwind;
2215                }
2216        }
2217
2218        switch (type) {
2219        case OBJ_BAD:
2220        case OBJ_COMMIT:
2221        case OBJ_TREE:
2222        case OBJ_BLOB:
2223        case OBJ_TAG:
2224                break;
2225        default:
2226                error("unknown object type %i at offset %"PRIuMAX" in %s",
2227                      type, (uintmax_t)obj_offset, p->pack_name);
2228                type = OBJ_BAD;
2229        }
2230
2231out:
2232        if (poi_stack != small_poi_stack)
2233                free(poi_stack);
2234        return type;
2235
2236unwind:
2237        while (poi_stack_nr) {
2238                obj_offset = poi_stack[--poi_stack_nr];
2239                type = retry_bad_packed_offset(p, obj_offset);
2240                if (type > OBJ_NONE)
2241                        goto out;
2242        }
2243        type = OBJ_BAD;
2244        goto out;
2245}
2246
2247int packed_object_info(struct packed_git *p, off_t obj_offset,
2248                       struct object_info *oi)
2249{
2250        struct pack_window *w_curs = NULL;
2251        unsigned long size;
2252        off_t curpos = obj_offset;
2253        enum object_type type;
2254
2255        /*
2256         * We always get the representation type, but only convert it to
2257         * a "real" type later if the caller is interested.
2258         */
2259        type = unpack_object_header(p, &w_curs, &curpos, &size);
2260
2261        if (oi->sizep) {
2262                if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2263                        off_t tmp_pos = curpos;
2264                        off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
2265                                                           type, obj_offset);
2266                        if (!base_offset) {
2267                                type = OBJ_BAD;
2268                                goto out;
2269                        }
2270                        *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
2271                        if (*oi->sizep == 0) {
2272                                type = OBJ_BAD;
2273                                goto out;
2274                        }
2275                } else {
2276                        *oi->sizep = size;
2277                }
2278        }
2279
2280        if (oi->disk_sizep) {
2281                struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2282                *oi->disk_sizep = revidx[1].offset - obj_offset;
2283        }
2284
2285        if (oi->typep) {
2286                *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
2287                if (*oi->typep < 0) {
2288                        type = OBJ_BAD;
2289                        goto out;
2290                }
2291        }
2292
2293        if (oi->delta_base_sha1) {
2294                if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2295                        const unsigned char *base;
2296
2297                        base = get_delta_base_sha1(p, &w_curs, curpos,
2298                                                   type, obj_offset);
2299                        if (!base) {
2300                                type = OBJ_BAD;
2301                                goto out;
2302                        }
2303
2304                        hashcpy(oi->delta_base_sha1, base);
2305                } else
2306                        hashclr(oi->delta_base_sha1);
2307        }
2308
2309out:
2310        unuse_pack(&w_curs);
2311        return type;
2312}
2313
2314static void *unpack_compressed_entry(struct packed_git *p,
2315                                    struct pack_window **w_curs,
2316                                    off_t curpos,
2317                                    unsigned long size)
2318{
2319        int st;
2320        git_zstream stream;
2321        unsigned char *buffer, *in;
2322
2323        buffer = xmallocz_gently(size);
2324        if (!buffer)
2325                return NULL;
2326        memset(&stream, 0, sizeof(stream));
2327        stream.next_out = buffer;
2328        stream.avail_out = size + 1;
2329
2330        git_inflate_init(&stream);
2331        do {
2332                in = use_pack(p, w_curs, curpos, &stream.avail_in);
2333                stream.next_in = in;
2334                st = git_inflate(&stream, Z_FINISH);
2335                if (!stream.avail_out)
2336                        break; /* the payload is larger than it should be */
2337                curpos += stream.next_in - in;
2338        } while (st == Z_OK || st == Z_BUF_ERROR);
2339        git_inflate_end(&stream);
2340        if ((st != Z_STREAM_END) || stream.total_out != size) {
2341                free(buffer);
2342                return NULL;
2343        }
2344
2345        return buffer;
2346}
2347
2348static struct hashmap delta_base_cache;
2349static size_t delta_base_cached;
2350
2351static LIST_HEAD(delta_base_cache_lru);
2352
2353struct delta_base_cache_key {
2354        struct packed_git *p;
2355        off_t base_offset;
2356};
2357
2358struct delta_base_cache_entry {
2359        struct hashmap hash;
2360        struct delta_base_cache_key key;
2361        struct list_head lru;
2362        void *data;
2363        unsigned long size;
2364        enum object_type type;
2365};
2366
2367static unsigned int pack_entry_hash(struct packed_git *p, off_t base_offset)
2368{
2369        unsigned int hash;
2370
2371        hash = (unsigned int)(intptr_t)p + (unsigned int)base_offset;
2372        hash += (hash >> 8) + (hash >> 16);
2373        return hash;
2374}
2375
2376static struct delta_base_cache_entry *
2377get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
2378{
2379        struct hashmap_entry entry;
2380        struct delta_base_cache_key key;
2381
2382        if (!delta_base_cache.cmpfn)
2383                return NULL;
2384
2385        hashmap_entry_init(&entry, pack_entry_hash(p, base_offset));
2386        key.p = p;
2387        key.base_offset = base_offset;
2388        return hashmap_get(&delta_base_cache, &entry, &key);
2389}
2390
2391static int delta_base_cache_key_eq(const struct delta_base_cache_key *a,
2392                                   const struct delta_base_cache_key *b)
2393{
2394        return a->p == b->p && a->base_offset == b->base_offset;
2395}
2396
2397static int delta_base_cache_hash_cmp(const void *va, const void *vb,
2398                                     const void *vkey)
2399{
2400        const struct delta_base_cache_entry *a = va, *b = vb;
2401        const struct delta_base_cache_key *key = vkey;
2402        if (key)
2403                return !delta_base_cache_key_eq(&a->key, key);
2404        else
2405                return !delta_base_cache_key_eq(&a->key, &b->key);
2406}
2407
2408static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
2409{
2410        return !!get_delta_base_cache_entry(p, base_offset);
2411}
2412
2413/*
2414 * Remove the entry from the cache, but do _not_ free the associated
2415 * entry data. The caller takes ownership of the "data" buffer, and
2416 * should copy out any fields it wants before detaching.
2417 */
2418static void detach_delta_base_cache_entry(struct delta_base_cache_entry *ent)
2419{
2420        hashmap_remove(&delta_base_cache, ent, &ent->key);
2421        list_del(&ent->lru);
2422        delta_base_cached -= ent->size;
2423        free(ent);
2424}
2425
2426static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
2427        unsigned long *base_size, enum object_type *type)
2428{
2429        struct delta_base_cache_entry *ent;
2430
2431        ent = get_delta_base_cache_entry(p, base_offset);
2432        if (!ent)
2433                return unpack_entry(p, base_offset, type, base_size);
2434
2435        *type = ent->type;
2436        *base_size = ent->size;
2437        return xmemdupz(ent->data, ent->size);
2438}
2439
2440static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
2441{
2442        free(ent->data);
2443        detach_delta_base_cache_entry(ent);
2444}
2445
2446void clear_delta_base_cache(void)
2447{
2448        struct list_head *lru, *tmp;
2449        list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
2450                struct delta_base_cache_entry *entry =
2451                        list_entry(lru, struct delta_base_cache_entry, lru);
2452                release_delta_base_cache(entry);
2453        }
2454}
2455
2456static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
2457        void *base, unsigned long base_size, enum object_type type)
2458{
2459        struct delta_base_cache_entry *ent = xmalloc(sizeof(*ent));
2460        struct list_head *lru, *tmp;
2461
2462        delta_base_cached += base_size;
2463
2464        list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
2465                struct delta_base_cache_entry *f =
2466                        list_entry(lru, struct delta_base_cache_entry, lru);
2467                if (delta_base_cached <= delta_base_cache_limit)
2468                        break;
2469                release_delta_base_cache(f);
2470        }
2471
2472        ent->key.p = p;
2473        ent->key.base_offset = base_offset;
2474        ent->type = type;
2475        ent->data = base;
2476        ent->size = base_size;
2477        list_add_tail(&ent->lru, &delta_base_cache_lru);
2478
2479        if (!delta_base_cache.cmpfn)
2480                hashmap_init(&delta_base_cache, delta_base_cache_hash_cmp, 0);
2481        hashmap_entry_init(ent, pack_entry_hash(p, base_offset));
2482        hashmap_add(&delta_base_cache, ent);
2483}
2484
2485static void *read_object(const unsigned char *sha1, enum object_type *type,
2486                         unsigned long *size);
2487
2488static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2489{
2490        static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
2491        trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
2492                         p->pack_name, (uintmax_t)obj_offset);
2493}
2494
2495int do_check_packed_object_crc;
2496
2497#define UNPACK_ENTRY_STACK_PREALLOC 64
2498struct unpack_entry_stack_ent {
2499        off_t obj_offset;
2500        off_t curpos;
2501        unsigned long size;
2502};
2503
2504void *unpack_entry(struct packed_git *p, off_t obj_offset,
2505                   enum object_type *final_type, unsigned long *final_size)
2506{
2507        struct pack_window *w_curs = NULL;
2508        off_t curpos = obj_offset;
2509        void *data = NULL;
2510        unsigned long size;
2511        enum object_type type;
2512        struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2513        struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2514        int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2515        int base_from_cache = 0;
2516
2517        write_pack_access_log(p, obj_offset);
2518
2519        /* PHASE 1: drill down to the innermost base object */
2520        for (;;) {
2521                off_t base_offset;
2522                int i;
2523                struct delta_base_cache_entry *ent;
2524
2525                ent = get_delta_base_cache_entry(p, curpos);
2526                if (ent) {
2527                        type = ent->type;
2528                        data = ent->data;
2529                        size = ent->size;
2530                        detach_delta_base_cache_entry(ent);
2531                        base_from_cache = 1;
2532                        break;
2533                }
2534
2535                if (do_check_packed_object_crc && p->index_version > 1) {
2536                        struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2537                        off_t len = revidx[1].offset - obj_offset;
2538                        if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2539                                const unsigned char *sha1 =
2540                                        nth_packed_object_sha1(p, revidx->nr);
2541                                error("bad packed object CRC for %s",
2542                                      sha1_to_hex(sha1));
2543                                mark_bad_packed_object(p, sha1);
2544                                unuse_pack(&w_curs);
2545                                return NULL;
2546                        }
2547                }
2548
2549                type = unpack_object_header(p, &w_curs, &curpos, &size);
2550                if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2551                        break;
2552
2553                base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2554                if (!base_offset) {
2555                        error("failed to validate delta base reference "
2556                              "at offset %"PRIuMAX" from %s",
2557                              (uintmax_t)curpos, p->pack_name);
2558                        /* bail to phase 2, in hopes of recovery */
2559                        data = NULL;
2560                        break;
2561                }
2562
2563                /* push object, proceed to base */
2564                if (delta_stack_nr >= delta_stack_alloc
2565                    && delta_stack == small_delta_stack) {
2566                        delta_stack_alloc = alloc_nr(delta_stack_nr);
2567                        ALLOC_ARRAY(delta_stack, delta_stack_alloc);
2568                        memcpy(delta_stack, small_delta_stack,
2569                               sizeof(*delta_stack)*delta_stack_nr);
2570                } else {
2571                        ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2572                }
2573                i = delta_stack_nr++;
2574                delta_stack[i].obj_offset = obj_offset;
2575                delta_stack[i].curpos = curpos;
2576                delta_stack[i].size = size;
2577
2578                curpos = obj_offset = base_offset;
2579        }
2580
2581        /* PHASE 2: handle the base */
2582        switch (type) {
2583        case OBJ_OFS_DELTA:
2584        case OBJ_REF_DELTA:
2585                if (data)
2586                        die("BUG: unpack_entry: left loop at a valid delta");
2587                break;
2588        case OBJ_COMMIT:
2589        case OBJ_TREE:
2590        case OBJ_BLOB:
2591        case OBJ_TAG:
2592                if (!base_from_cache)
2593                        data = unpack_compressed_entry(p, &w_curs, curpos, size);
2594                break;
2595        default:
2596                data = NULL;
2597                error("unknown object type %i at offset %"PRIuMAX" in %s",
2598                      type, (uintmax_t)obj_offset, p->pack_name);
2599        }
2600
2601        /* PHASE 3: apply deltas in order */
2602
2603        /* invariants:
2604         *   'data' holds the base data, or NULL if there was corruption
2605         */
2606        while (delta_stack_nr) {
2607                void *delta_data;
2608                void *base = data;
2609                void *external_base = NULL;
2610                unsigned long delta_size, base_size = size;
2611                int i;
2612
2613                data = NULL;
2614
2615                if (base)
2616                        add_delta_base_cache(p, obj_offset, base, base_size, type);
2617
2618                if (!base) {
2619                        /*
2620                         * We're probably in deep shit, but let's try to fetch
2621                         * the required base anyway from another pack or loose.
2622                         * This is costly but should happen only in the presence
2623                         * of a corrupted pack, and is better than failing outright.
2624                         */
2625                        struct revindex_entry *revidx;
2626                        const unsigned char *base_sha1;
2627                        revidx = find_pack_revindex(p, obj_offset);
2628                        if (revidx) {
2629                                base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2630                                error("failed to read delta base object %s"
2631                                      " at offset %"PRIuMAX" from %s",
2632                                      sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2633                                      p->pack_name);
2634                                mark_bad_packed_object(p, base_sha1);
2635                                base = read_object(base_sha1, &type, &base_size);
2636                                external_base = base;
2637                        }
2638                }
2639
2640                i = --delta_stack_nr;
2641                obj_offset = delta_stack[i].obj_offset;
2642                curpos = delta_stack[i].curpos;
2643                delta_size = delta_stack[i].size;
2644
2645                if (!base)
2646                        continue;
2647
2648                delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2649
2650                if (!delta_data) {
2651                        error("failed to unpack compressed delta "
2652                              "at offset %"PRIuMAX" from %s",
2653                              (uintmax_t)curpos, p->pack_name);
2654                        data = NULL;
2655                        free(external_base);
2656                        continue;
2657                }
2658
2659                data = patch_delta(base, base_size,
2660                                   delta_data, delta_size,
2661                                   &size);
2662
2663                /*
2664                 * We could not apply the delta; warn the user, but keep going.
2665                 * Our failure will be noticed either in the next iteration of
2666                 * the loop, or if this is the final delta, in the caller when
2667                 * we return NULL. Those code paths will take care of making
2668                 * a more explicit warning and retrying with another copy of
2669                 * the object.
2670                 */
2671                if (!data)
2672                        error("failed to apply delta");
2673
2674                free(delta_data);
2675                free(external_base);
2676        }
2677
2678        *final_type = type;
2679        *final_size = size;
2680
2681        unuse_pack(&w_curs);
2682
2683        if (delta_stack != small_delta_stack)
2684                free(delta_stack);
2685
2686        return data;
2687}
2688
2689const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2690                                            uint32_t n)
2691{
2692        const unsigned char *index = p->index_data;
2693        if (!index) {
2694                if (open_pack_index(p))
2695                        return NULL;
2696                index = p->index_data;
2697        }
2698        if (n >= p->num_objects)
2699                return NULL;
2700        index += 4 * 256;
2701        if (p->index_version == 1) {
2702                return index + 24 * n + 4;
2703        } else {
2704                index += 8;
2705                return index + 20 * n;
2706        }
2707}
2708
2709void check_pack_index_ptr(const struct packed_git *p, const void *vptr)
2710{
2711        const unsigned char *ptr = vptr;
2712        const unsigned char *start = p->index_data;
2713        const unsigned char *end = start + p->index_size;
2714        if (ptr < start)
2715                die(_("offset before start of pack index for %s (corrupt index?)"),
2716                    p->pack_name);
2717        /* No need to check for underflow; .idx files must be at least 8 bytes */
2718        if (ptr >= end - 8)
2719                die(_("offset beyond end of pack index for %s (truncated index?)"),
2720                    p->pack_name);
2721}
2722
2723off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2724{
2725        const unsigned char *index = p->index_data;
2726        index += 4 * 256;
2727        if (p->index_version == 1) {
2728                return ntohl(*((uint32_t *)(index + 24 * n)));
2729        } else {
2730                uint32_t off;
2731                index += 8 + p->num_objects * (20 + 4);
2732                off = ntohl(*((uint32_t *)(index + 4 * n)));
2733                if (!(off & 0x80000000))
2734                        return off;
2735                index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2736                check_pack_index_ptr(p, index);
2737                return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2738                                   ntohl(*((uint32_t *)(index + 4)));
2739        }
2740}
2741
2742off_t find_pack_entry_one(const unsigned char *sha1,
2743                                  struct packed_git *p)
2744{
2745        const uint32_t *level1_ofs = p->index_data;
2746        const unsigned char *index = p->index_data;
2747        unsigned hi, lo, stride;
2748        static int use_lookup = -1;
2749        static int debug_lookup = -1;
2750
2751        if (debug_lookup < 0)
2752                debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2753
2754        if (!index) {
2755                if (open_pack_index(p))
2756                        return 0;
2757                level1_ofs = p->index_data;
2758                index = p->index_data;
2759        }
2760        if (p->index_version > 1) {
2761                level1_ofs += 2;
2762                index += 8;
2763        }
2764        index += 4 * 256;
2765        hi = ntohl(level1_ofs[*sha1]);
2766        lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2767        if (p->index_version > 1) {
2768                stride = 20;
2769        } else {
2770                stride = 24;
2771                index += 4;
2772        }
2773
2774        if (debug_lookup)
2775                printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2776                       sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2777
2778        if (use_lookup < 0)
2779                use_lookup = !!getenv("GIT_USE_LOOKUP");
2780        if (use_lookup) {
2781                int pos = sha1_entry_pos(index, stride, 0,
2782                                         lo, hi, p->num_objects, sha1);
2783                if (pos < 0)
2784                        return 0;
2785                return nth_packed_object_offset(p, pos);
2786        }
2787
2788        do {
2789                unsigned mi = (lo + hi) / 2;
2790                int cmp = hashcmp(index + mi * stride, sha1);
2791
2792                if (debug_lookup)
2793                        printf("lo %u hi %u rg %u mi %u\n",
2794                               lo, hi, hi - lo, mi);
2795                if (!cmp)
2796                        return nth_packed_object_offset(p, mi);
2797                if (cmp > 0)
2798                        hi = mi;
2799                else
2800                        lo = mi+1;
2801        } while (lo < hi);
2802        return 0;
2803}
2804
2805int is_pack_valid(struct packed_git *p)
2806{
2807        /* An already open pack is known to be valid. */
2808        if (p->pack_fd != -1)
2809                return 1;
2810
2811        /* If the pack has one window completely covering the
2812         * file size, the pack is known to be valid even if
2813         * the descriptor is not currently open.
2814         */
2815        if (p->windows) {
2816                struct pack_window *w = p->windows;
2817
2818                if (!w->offset && w->len == p->pack_size)
2819                        return 1;
2820        }
2821
2822        /* Force the pack to open to prove its valid. */
2823        return !open_packed_git(p);
2824}
2825
2826static int fill_pack_entry(const unsigned char *sha1,
2827                           struct pack_entry *e,
2828                           struct packed_git *p)
2829{
2830        off_t offset;
2831
2832        if (p->num_bad_objects) {
2833                unsigned i;
2834                for (i = 0; i < p->num_bad_objects; i++)
2835                        if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2836                                return 0;
2837        }
2838
2839        offset = find_pack_entry_one(sha1, p);
2840        if (!offset)
2841                return 0;
2842
2843        /*
2844         * We are about to tell the caller where they can locate the
2845         * requested object.  We better make sure the packfile is
2846         * still here and can be accessed before supplying that
2847         * answer, as it may have been deleted since the index was
2848         * loaded!
2849         */
2850        if (!is_pack_valid(p))
2851                return 0;
2852        e->offset = offset;
2853        e->p = p;
2854        hashcpy(e->sha1, sha1);
2855        return 1;
2856}
2857
2858/*
2859 * Iff a pack file contains the object named by sha1, return true and
2860 * store its location to e.
2861 */
2862static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2863{
2864        struct mru_entry *p;
2865
2866        prepare_packed_git();
2867        if (!packed_git)
2868                return 0;
2869
2870        for (p = packed_git_mru->head; p; p = p->next) {
2871                if (fill_pack_entry(sha1, e, p->item)) {
2872                        mru_mark(packed_git_mru, p);
2873                        return 1;
2874                }
2875        }
2876        return 0;
2877}
2878
2879struct packed_git *find_sha1_pack(const unsigned char *sha1,
2880                                  struct packed_git *packs)
2881{
2882        struct packed_git *p;
2883
2884        for (p = packs; p; p = p->next) {
2885                if (find_pack_entry_one(sha1, p))
2886                        return p;
2887        }
2888        return NULL;
2889
2890}
2891
2892static int sha1_loose_object_info(const unsigned char *sha1,
2893                                  struct object_info *oi,
2894                                  int flags)
2895{
2896        int status = 0;
2897        unsigned long mapsize;
2898        void *map;
2899        git_zstream stream;
2900        char hdr[32];
2901        struct strbuf hdrbuf = STRBUF_INIT;
2902
2903        if (oi->delta_base_sha1)
2904                hashclr(oi->delta_base_sha1);
2905
2906        /*
2907         * If we don't care about type or size, then we don't
2908         * need to look inside the object at all. Note that we
2909         * do not optimize out the stat call, even if the
2910         * caller doesn't care about the disk-size, since our
2911         * return value implicitly indicates whether the
2912         * object even exists.
2913         */
2914        if (!oi->typep && !oi->typename && !oi->sizep) {
2915                const char *path;
2916                struct stat st;
2917                if (stat_sha1_file(sha1, &st, &path) < 0)
2918                        return -1;
2919                if (oi->disk_sizep)
2920                        *oi->disk_sizep = st.st_size;
2921                return 0;
2922        }
2923
2924        map = map_sha1_file(sha1, &mapsize);
2925        if (!map)
2926                return -1;
2927        if (oi->disk_sizep)
2928                *oi->disk_sizep = mapsize;
2929        if ((flags & LOOKUP_UNKNOWN_OBJECT)) {
2930                if (unpack_sha1_header_to_strbuf(&stream, map, mapsize, hdr, sizeof(hdr), &hdrbuf) < 0)
2931                        status = error("unable to unpack %s header with --allow-unknown-type",
2932                                       sha1_to_hex(sha1));
2933        } else if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2934                status = error("unable to unpack %s header",
2935                               sha1_to_hex(sha1));
2936        if (status < 0)
2937                ; /* Do nothing */
2938        else if (hdrbuf.len) {
2939                if ((status = parse_sha1_header_extended(hdrbuf.buf, oi, flags)) < 0)
2940                        status = error("unable to parse %s header with --allow-unknown-type",
2941                                       sha1_to_hex(sha1));
2942        } else if ((status = parse_sha1_header_extended(hdr, oi, flags)) < 0)
2943                status = error("unable to parse %s header", sha1_to_hex(sha1));
2944        git_inflate_end(&stream);
2945        munmap(map, mapsize);
2946        if (status && oi->typep)
2947                *oi->typep = status;
2948        strbuf_release(&hdrbuf);
2949        return 0;
2950}
2951
2952int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi, unsigned flags)
2953{
2954        struct cached_object *co;
2955        struct pack_entry e;
2956        int rtype;
2957        enum object_type real_type;
2958        const unsigned char *real = lookup_replace_object_extended(sha1, flags);
2959
2960        co = find_cached_object(real);
2961        if (co) {
2962                if (oi->typep)
2963                        *(oi->typep) = co->type;
2964                if (oi->sizep)
2965                        *(oi->sizep) = co->size;
2966                if (oi->disk_sizep)
2967                        *(oi->disk_sizep) = 0;
2968                if (oi->delta_base_sha1)
2969                        hashclr(oi->delta_base_sha1);
2970                if (oi->typename)
2971                        strbuf_addstr(oi->typename, typename(co->type));
2972                oi->whence = OI_CACHED;
2973                return 0;
2974        }
2975
2976        if (!find_pack_entry(real, &e)) {
2977                /* Most likely it's a loose object. */
2978                if (!sha1_loose_object_info(real, oi, flags)) {
2979                        oi->whence = OI_LOOSE;
2980                        return 0;
2981                }
2982
2983                /* Not a loose object; someone else may have just packed it. */
2984                reprepare_packed_git();
2985                if (!find_pack_entry(real, &e))
2986                        return -1;
2987        }
2988
2989        /*
2990         * packed_object_info() does not follow the delta chain to
2991         * find out the real type, unless it is given oi->typep.
2992         */
2993        if (oi->typename && !oi->typep)
2994                oi->typep = &real_type;
2995
2996        rtype = packed_object_info(e.p, e.offset, oi);
2997        if (rtype < 0) {
2998                mark_bad_packed_object(e.p, real);
2999                if (oi->typep == &real_type)
3000                        oi->typep = NULL;
3001                return sha1_object_info_extended(real, oi, 0);
3002        } else if (in_delta_base_cache(e.p, e.offset)) {
3003                oi->whence = OI_DBCACHED;
3004        } else {
3005                oi->whence = OI_PACKED;
3006                oi->u.packed.offset = e.offset;
3007                oi->u.packed.pack = e.p;
3008                oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
3009                                         rtype == OBJ_OFS_DELTA);
3010        }
3011        if (oi->typename)
3012                strbuf_addstr(oi->typename, typename(*oi->typep));
3013        if (oi->typep == &real_type)
3014                oi->typep = NULL;
3015
3016        return 0;
3017}
3018
3019/* returns enum object_type or negative */
3020int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
3021{
3022        enum object_type type;
3023        struct object_info oi = OBJECT_INFO_INIT;
3024
3025        oi.typep = &type;
3026        oi.sizep = sizep;
3027        if (sha1_object_info_extended(sha1, &oi, LOOKUP_REPLACE_OBJECT) < 0)
3028                return -1;
3029        return type;
3030}
3031
3032static void *read_packed_sha1(const unsigned char *sha1,
3033                              enum object_type *type, unsigned long *size)
3034{
3035        struct pack_entry e;
3036        void *data;
3037
3038        if (!find_pack_entry(sha1, &e))
3039                return NULL;
3040        data = cache_or_unpack_entry(e.p, e.offset, size, type);
3041        if (!data) {
3042                /*
3043                 * We're probably in deep shit, but let's try to fetch
3044                 * the required object anyway from another pack or loose.
3045                 * This should happen only in the presence of a corrupted
3046                 * pack, and is better than failing outright.
3047                 */
3048                error("failed to read object %s at offset %"PRIuMAX" from %s",
3049                      sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
3050                mark_bad_packed_object(e.p, sha1);
3051                data = read_object(sha1, type, size);
3052        }
3053        return data;
3054}
3055
3056int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
3057                      unsigned char *sha1)
3058{
3059        struct cached_object *co;
3060
3061        hash_sha1_file(buf, len, typename(type), sha1);
3062        if (has_sha1_file(sha1) || find_cached_object(sha1))
3063                return 0;
3064        ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
3065        co = &cached_objects[cached_object_nr++];
3066        co->size = len;
3067        co->type = type;
3068        co->buf = xmalloc(len);
3069        memcpy(co->buf, buf, len);
3070        hashcpy(co->sha1, sha1);
3071        return 0;
3072}
3073
3074static void *read_object(const unsigned char *sha1, enum object_type *type,
3075                         unsigned long *size)
3076{
3077        unsigned long mapsize;
3078        void *map, *buf;
3079        struct cached_object *co;
3080
3081        co = find_cached_object(sha1);
3082        if (co) {
3083                *type = co->type;
3084                *size = co->size;
3085                return xmemdupz(co->buf, co->size);
3086        }
3087
3088        buf = read_packed_sha1(sha1, type, size);
3089        if (buf)
3090                return buf;
3091        map = map_sha1_file(sha1, &mapsize);
3092        if (map) {
3093                buf = unpack_sha1_file(map, mapsize, type, size, sha1);
3094                munmap(map, mapsize);
3095                return buf;
3096        }
3097        reprepare_packed_git();
3098        return read_packed_sha1(sha1, type, size);
3099}
3100
3101/*
3102 * This function dies on corrupt objects; the callers who want to
3103 * deal with them should arrange to call read_object() and give error
3104 * messages themselves.
3105 */
3106void *read_sha1_file_extended(const unsigned char *sha1,
3107                              enum object_type *type,
3108                              unsigned long *size,
3109                              unsigned flag)
3110{
3111        void *data;
3112        const struct packed_git *p;
3113        const char *path;
3114        struct stat st;
3115        const unsigned char *repl = lookup_replace_object_extended(sha1, flag);
3116
3117        errno = 0;
3118        data = read_object(repl, type, size);
3119        if (data)
3120                return data;
3121
3122        if (errno && errno != ENOENT)
3123                die_errno("failed to read object %s", sha1_to_hex(sha1));
3124
3125        /* die if we replaced an object with one that does not exist */
3126        if (repl != sha1)
3127                die("replacement %s not found for %s",
3128                    sha1_to_hex(repl), sha1_to_hex(sha1));
3129
3130        if (!stat_sha1_file(repl, &st, &path))
3131                die("loose object %s (stored in %s) is corrupt",
3132                    sha1_to_hex(repl), path);
3133
3134        if ((p = has_packed_and_bad(repl)) != NULL)
3135                die("packed object %s (stored in %s) is corrupt",
3136                    sha1_to_hex(repl), p->pack_name);
3137
3138        return NULL;
3139}
3140
3141void *read_object_with_reference(const unsigned char *sha1,
3142                                 const char *required_type_name,
3143                                 unsigned long *size,
3144                                 unsigned char *actual_sha1_return)
3145{
3146        enum object_type type, required_type;
3147        void *buffer;
3148        unsigned long isize;
3149        unsigned char actual_sha1[20];
3150
3151        required_type = type_from_string(required_type_name);
3152        hashcpy(actual_sha1, sha1);
3153        while (1) {
3154                int ref_length = -1;
3155                const char *ref_type = NULL;
3156
3157                buffer = read_sha1_file(actual_sha1, &type, &isize);
3158                if (!buffer)
3159                        return NULL;
3160                if (type == required_type) {
3161                        *size = isize;
3162                        if (actual_sha1_return)
3163                                hashcpy(actual_sha1_return, actual_sha1);
3164                        return buffer;
3165                }
3166                /* Handle references */
3167                else if (type == OBJ_COMMIT)
3168                        ref_type = "tree ";
3169                else if (type == OBJ_TAG)
3170                        ref_type = "object ";
3171                else {
3172                        free(buffer);
3173                        return NULL;
3174                }
3175                ref_length = strlen(ref_type);
3176
3177                if (ref_length + 40 > isize ||
3178                    memcmp(buffer, ref_type, ref_length) ||
3179                    get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
3180                        free(buffer);
3181                        return NULL;
3182                }
3183                free(buffer);
3184                /* Now we have the ID of the referred-to object in
3185                 * actual_sha1.  Check again. */
3186        }
3187}
3188
3189static void write_sha1_file_prepare(const void *buf, unsigned long len,
3190                                    const char *type, unsigned char *sha1,
3191                                    char *hdr, int *hdrlen)
3192{
3193        git_SHA_CTX c;
3194
3195        /* Generate the header */
3196        *hdrlen = xsnprintf(hdr, *hdrlen, "%s %lu", type, len)+1;
3197
3198        /* Sha1.. */
3199        git_SHA1_Init(&c);
3200        git_SHA1_Update(&c, hdr, *hdrlen);
3201        git_SHA1_Update(&c, buf, len);
3202        git_SHA1_Final(sha1, &c);
3203}
3204
3205/*
3206 * Move the just written object into its final resting place.
3207 */
3208int finalize_object_file(const char *tmpfile, const char *filename)
3209{
3210        int ret = 0;
3211
3212        if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
3213                goto try_rename;
3214        else if (link(tmpfile, filename))
3215                ret = errno;
3216
3217        /*
3218         * Coda hack - coda doesn't like cross-directory links,
3219         * so we fall back to a rename, which will mean that it
3220         * won't be able to check collisions, but that's not a
3221         * big deal.
3222         *
3223         * The same holds for FAT formatted media.
3224         *
3225         * When this succeeds, we just return.  We have nothing
3226         * left to unlink.
3227         */
3228        if (ret && ret != EEXIST) {
3229        try_rename:
3230                if (!rename(tmpfile, filename))
3231                        goto out;
3232                ret = errno;
3233        }
3234        unlink_or_warn(tmpfile);
3235        if (ret) {
3236                if (ret != EEXIST) {
3237                        return error_errno("unable to write sha1 filename %s", filename);
3238                }
3239                /* FIXME!!! Collision check here ? */
3240        }
3241
3242out:
3243        if (adjust_shared_perm(filename))
3244                return error("unable to set permission to '%s'", filename);
3245        return 0;
3246}
3247
3248static int write_buffer(int fd, const void *buf, size_t len)
3249{
3250        if (write_in_full(fd, buf, len) < 0)
3251                return error_errno("file write error");
3252        return 0;
3253}
3254
3255int hash_sha1_file(const void *buf, unsigned long len, const char *type,
3256                   unsigned char *sha1)
3257{
3258        char hdr[32];
3259        int hdrlen = sizeof(hdr);
3260        write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3261        return 0;
3262}
3263
3264/* Finalize a file on disk, and close it. */
3265static void close_sha1_file(int fd)
3266{
3267        if (fsync_object_files)
3268                fsync_or_die(fd, "sha1 file");
3269        if (close(fd) != 0)
3270                die_errno("error when closing sha1 file");
3271}
3272
3273/* Size of directory component, including the ending '/' */
3274static inline int directory_size(const char *filename)
3275{
3276        const char *s = strrchr(filename, '/');
3277        if (!s)
3278                return 0;
3279        return s - filename + 1;
3280}
3281
3282/*
3283 * This creates a temporary file in the same directory as the final
3284 * 'filename'
3285 *
3286 * We want to avoid cross-directory filename renames, because those
3287 * can have problems on various filesystems (FAT, NFS, Coda).
3288 */
3289static int create_tmpfile(struct strbuf *tmp, const char *filename)
3290{
3291        int fd, dirlen = directory_size(filename);
3292
3293        strbuf_reset(tmp);
3294        strbuf_add(tmp, filename, dirlen);
3295        strbuf_addstr(tmp, "tmp_obj_XXXXXX");
3296        fd = git_mkstemp_mode(tmp->buf, 0444);
3297        if (fd < 0 && dirlen && errno == ENOENT) {
3298                /*
3299                 * Make sure the directory exists; note that the contents
3300                 * of the buffer are undefined after mkstemp returns an
3301                 * error, so we have to rewrite the whole buffer from
3302                 * scratch.
3303                 */
3304                strbuf_reset(tmp);
3305                strbuf_add(tmp, filename, dirlen - 1);
3306                if (mkdir(tmp->buf, 0777) && errno != EEXIST)
3307                        return -1;
3308                if (adjust_shared_perm(tmp->buf))
3309                        return -1;
3310
3311                /* Try again */
3312                strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
3313                fd = git_mkstemp_mode(tmp->buf, 0444);
3314        }
3315        return fd;
3316}
3317
3318static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
3319                              const void *buf, unsigned long len, time_t mtime)
3320{
3321        int fd, ret;
3322        unsigned char compressed[4096];
3323        git_zstream stream;
3324        git_SHA_CTX c;
3325        unsigned char parano_sha1[20];
3326        static struct strbuf tmp_file = STRBUF_INIT;
3327        const char *filename = sha1_file_name(sha1);
3328
3329        fd = create_tmpfile(&tmp_file, filename);
3330        if (fd < 0) {
3331                if (errno == EACCES)
3332                        return error("insufficient permission for adding an object to repository database %s", get_object_directory());
3333                else
3334                        return error_errno("unable to create temporary file");
3335        }
3336
3337        /* Set it up */
3338        git_deflate_init(&stream, zlib_compression_level);
3339        stream.next_out = compressed;
3340        stream.avail_out = sizeof(compressed);
3341        git_SHA1_Init(&c);
3342
3343        /* First header.. */
3344        stream.next_in = (unsigned char *)hdr;
3345        stream.avail_in = hdrlen;
3346        while (git_deflate(&stream, 0) == Z_OK)
3347                ; /* nothing */
3348        git_SHA1_Update(&c, hdr, hdrlen);
3349
3350        /* Then the data itself.. */
3351        stream.next_in = (void *)buf;
3352        stream.avail_in = len;
3353        do {
3354                unsigned char *in0 = stream.next_in;
3355                ret = git_deflate(&stream, Z_FINISH);
3356                git_SHA1_Update(&c, in0, stream.next_in - in0);
3357                if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
3358                        die("unable to write sha1 file");
3359                stream.next_out = compressed;
3360                stream.avail_out = sizeof(compressed);
3361        } while (ret == Z_OK);
3362
3363        if (ret != Z_STREAM_END)
3364                die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
3365        ret = git_deflate_end_gently(&stream);
3366        if (ret != Z_OK)
3367                die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
3368        git_SHA1_Final(parano_sha1, &c);
3369        if (hashcmp(sha1, parano_sha1) != 0)
3370                die("confused by unstable object source data for %s", sha1_to_hex(sha1));
3371
3372        close_sha1_file(fd);
3373
3374        if (mtime) {
3375                struct utimbuf utb;
3376                utb.actime = mtime;
3377                utb.modtime = mtime;
3378                if (utime(tmp_file.buf, &utb) < 0)
3379                        warning_errno("failed utime() on %s", tmp_file.buf);
3380        }
3381
3382        return finalize_object_file(tmp_file.buf, filename);
3383}
3384
3385static int freshen_loose_object(const unsigned char *sha1)
3386{
3387        return check_and_freshen(sha1, 1);
3388}
3389
3390static int freshen_packed_object(const unsigned char *sha1)
3391{
3392        struct pack_entry e;
3393        if (!find_pack_entry(sha1, &e))
3394                return 0;
3395        if (e.p->freshened)
3396                return 1;
3397        if (!freshen_file(e.p->pack_name))
3398                return 0;
3399        e.p->freshened = 1;
3400        return 1;
3401}
3402
3403int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1)
3404{
3405        char hdr[32];
3406        int hdrlen = sizeof(hdr);
3407
3408        /* Normally if we have it in the pack then we do not bother writing
3409         * it out into .git/objects/??/?{38} file.
3410         */
3411        write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3412        if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3413                return 0;
3414        return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
3415}
3416
3417int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type,
3418                             unsigned char *sha1, unsigned flags)
3419{
3420        char *header;
3421        int hdrlen, status = 0;
3422
3423        /* type string, SP, %lu of the length plus NUL must fit this */
3424        hdrlen = strlen(type) + 32;
3425        header = xmalloc(hdrlen);
3426        write_sha1_file_prepare(buf, len, type, sha1, header, &hdrlen);
3427
3428        if (!(flags & HASH_WRITE_OBJECT))
3429                goto cleanup;
3430        if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3431                goto cleanup;
3432        status = write_loose_object(sha1, header, hdrlen, buf, len, 0);
3433
3434cleanup:
3435        free(header);
3436        return status;
3437}
3438
3439int force_object_loose(const unsigned char *sha1, time_t mtime)
3440{
3441        void *buf;
3442        unsigned long len;
3443        enum object_type type;
3444        char hdr[32];
3445        int hdrlen;
3446        int ret;
3447
3448        if (has_loose_object(sha1))
3449                return 0;
3450        buf = read_packed_sha1(sha1, &type, &len);
3451        if (!buf)
3452                return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
3453        hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(type), len) + 1;
3454        ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
3455        free(buf);
3456
3457        return ret;
3458}
3459
3460int has_pack_index(const unsigned char *sha1)
3461{
3462        struct stat st;
3463        if (stat(sha1_pack_index_name(sha1), &st))
3464                return 0;
3465        return 1;
3466}
3467
3468int has_sha1_pack(const unsigned char *sha1)
3469{
3470        struct pack_entry e;
3471        return find_pack_entry(sha1, &e);
3472}
3473
3474int has_sha1_file_with_flags(const unsigned char *sha1, int flags)
3475{
3476        struct pack_entry e;
3477
3478        if (find_pack_entry(sha1, &e))
3479                return 1;
3480        if (has_loose_object(sha1))
3481                return 1;
3482        if (flags & HAS_SHA1_QUICK)
3483                return 0;
3484        reprepare_packed_git();
3485        return find_pack_entry(sha1, &e);
3486}
3487
3488int has_object_file(const struct object_id *oid)
3489{
3490        return has_sha1_file(oid->hash);
3491}
3492
3493int has_object_file_with_flags(const struct object_id *oid, int flags)
3494{
3495        return has_sha1_file_with_flags(oid->hash, flags);
3496}
3497
3498static void check_tree(const void *buf, size_t size)
3499{
3500        struct tree_desc desc;
3501        struct name_entry entry;
3502
3503        init_tree_desc(&desc, buf, size);
3504        while (tree_entry(&desc, &entry))
3505                /* do nothing
3506                 * tree_entry() will die() on malformed entries */
3507                ;
3508}
3509
3510static void check_commit(const void *buf, size_t size)
3511{
3512        struct commit c;
3513        memset(&c, 0, sizeof(c));
3514        if (parse_commit_buffer(&c, buf, size))
3515                die("corrupt commit");
3516}
3517
3518static void check_tag(const void *buf, size_t size)
3519{
3520        struct tag t;
3521        memset(&t, 0, sizeof(t));
3522        if (parse_tag_buffer(&t, buf, size))
3523                die("corrupt tag");
3524}
3525
3526static int index_mem(unsigned char *sha1, void *buf, size_t size,
3527                     enum object_type type,
3528                     const char *path, unsigned flags)
3529{
3530        int ret, re_allocated = 0;
3531        int write_object = flags & HASH_WRITE_OBJECT;
3532
3533        if (!type)
3534                type = OBJ_BLOB;
3535
3536        /*
3537         * Convert blobs to git internal format
3538         */
3539        if ((type == OBJ_BLOB) && path) {
3540                struct strbuf nbuf = STRBUF_INIT;
3541                if (convert_to_git(path, buf, size, &nbuf,
3542                                   write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
3543                        buf = strbuf_detach(&nbuf, &size);
3544                        re_allocated = 1;
3545                }
3546        }
3547        if (flags & HASH_FORMAT_CHECK) {
3548                if (type == OBJ_TREE)
3549                        check_tree(buf, size);
3550                if (type == OBJ_COMMIT)
3551                        check_commit(buf, size);
3552                if (type == OBJ_TAG)
3553                        check_tag(buf, size);
3554        }
3555
3556        if (write_object)
3557                ret = write_sha1_file(buf, size, typename(type), sha1);
3558        else
3559                ret = hash_sha1_file(buf, size, typename(type), sha1);
3560        if (re_allocated)
3561                free(buf);
3562        return ret;
3563}
3564
3565static int index_stream_convert_blob(unsigned char *sha1, int fd,
3566                                     const char *path, unsigned flags)
3567{
3568        int ret;
3569        const int write_object = flags & HASH_WRITE_OBJECT;
3570        struct strbuf sbuf = STRBUF_INIT;
3571
3572        assert(path);
3573        assert(would_convert_to_git_filter_fd(path));
3574
3575        convert_to_git_filter_fd(path, fd, &sbuf,
3576                                 write_object ? safe_crlf : SAFE_CRLF_FALSE);
3577
3578        if (write_object)
3579                ret = write_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3580                                      sha1);
3581        else
3582                ret = hash_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3583                                     sha1);
3584        strbuf_release(&sbuf);
3585        return ret;
3586}
3587
3588static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3589                      const char *path, unsigned flags)
3590{
3591        struct strbuf sbuf = STRBUF_INIT;
3592        int ret;
3593
3594        if (strbuf_read(&sbuf, fd, 4096) >= 0)
3595                ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3596        else
3597                ret = -1;
3598        strbuf_release(&sbuf);
3599        return ret;
3600}
3601
3602#define SMALL_FILE_SIZE (32*1024)
3603
3604static int index_core(unsigned char *sha1, int fd, size_t size,
3605                      enum object_type type, const char *path,
3606                      unsigned flags)
3607{
3608        int ret;
3609
3610        if (!size) {
3611                ret = index_mem(sha1, "", size, type, path, flags);
3612        } else if (size <= SMALL_FILE_SIZE) {
3613                char *buf = xmalloc(size);
3614                if (size == read_in_full(fd, buf, size))
3615                        ret = index_mem(sha1, buf, size, type, path, flags);
3616                else
3617                        ret = error_errno("short read");
3618                free(buf);
3619        } else {
3620                void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3621                ret = index_mem(sha1, buf, size, type, path, flags);
3622                munmap(buf, size);
3623        }
3624        return ret;
3625}
3626
3627/*
3628 * This creates one packfile per large blob unless bulk-checkin
3629 * machinery is "plugged".
3630 *
3631 * This also bypasses the usual "convert-to-git" dance, and that is on
3632 * purpose. We could write a streaming version of the converting
3633 * functions and insert that before feeding the data to fast-import
3634 * (or equivalent in-core API described above). However, that is
3635 * somewhat complicated, as we do not know the size of the filter
3636 * result, which we need to know beforehand when writing a git object.
3637 * Since the primary motivation for trying to stream from the working
3638 * tree file and to avoid mmaping it in core is to deal with large
3639 * binary blobs, they generally do not want to get any conversion, and
3640 * callers should avoid this code path when filters are requested.
3641 */
3642static int index_stream(unsigned char *sha1, int fd, size_t size,
3643                        enum object_type type, const char *path,
3644                        unsigned flags)
3645{
3646        return index_bulk_checkin(sha1, fd, size, type, path, flags);
3647}
3648
3649int index_fd(unsigned char *sha1, int fd, struct stat *st,
3650             enum object_type type, const char *path, unsigned flags)
3651{
3652        int ret;
3653
3654        /*
3655         * Call xsize_t() only when needed to avoid potentially unnecessary
3656         * die() for large files.
3657         */
3658        if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(path))
3659                ret = index_stream_convert_blob(sha1, fd, path, flags);
3660        else if (!S_ISREG(st->st_mode))
3661                ret = index_pipe(sha1, fd, type, path, flags);
3662        else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
3663                 (path && would_convert_to_git(path)))
3664                ret = index_core(sha1, fd, xsize_t(st->st_size), type, path,
3665                                 flags);
3666        else
3667                ret = index_stream(sha1, fd, xsize_t(st->st_size), type, path,
3668                                   flags);
3669        close(fd);
3670        return ret;
3671}
3672
3673int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3674{
3675        int fd;
3676        struct strbuf sb = STRBUF_INIT;
3677
3678        switch (st->st_mode & S_IFMT) {
3679        case S_IFREG:
3680                fd = open(path, O_RDONLY);
3681                if (fd < 0)
3682                        return error_errno("open(\"%s\")", path);
3683                if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3684                        return error("%s: failed to insert into database",
3685                                     path);
3686                break;
3687        case S_IFLNK:
3688                if (strbuf_readlink(&sb, path, st->st_size))
3689                        return error_errno("readlink(\"%s\")", path);
3690                if (!(flags & HASH_WRITE_OBJECT))
3691                        hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3692                else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3693                        return error("%s: failed to insert into database",
3694                                     path);
3695                strbuf_release(&sb);
3696                break;
3697        case S_IFDIR:
3698                return resolve_gitlink_ref(path, "HEAD", sha1);
3699        default:
3700                return error("%s: unsupported file type", path);
3701        }
3702        return 0;
3703}
3704
3705int read_pack_header(int fd, struct pack_header *header)
3706{
3707        if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3708                /* "eof before pack header was fully read" */
3709                return PH_ERROR_EOF;
3710
3711        if (header->hdr_signature != htonl(PACK_SIGNATURE))
3712                /* "protocol error (pack signature mismatch detected)" */
3713                return PH_ERROR_PACK_SIGNATURE;
3714        if (!pack_version_ok(header->hdr_version))
3715                /* "protocol error (pack version unsupported)" */
3716                return PH_ERROR_PROTOCOL;
3717        return 0;
3718}
3719
3720void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3721{
3722        enum object_type type = sha1_object_info(sha1, NULL);
3723        if (type < 0)
3724                die("%s is not a valid object", sha1_to_hex(sha1));
3725        if (type != expect)
3726                die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3727                    typename(expect));
3728}
3729
3730static int for_each_file_in_obj_subdir(int subdir_nr,
3731                                       struct strbuf *path,
3732                                       each_loose_object_fn obj_cb,
3733                                       each_loose_cruft_fn cruft_cb,
3734                                       each_loose_subdir_fn subdir_cb,
3735                                       void *data)
3736{
3737        size_t baselen = path->len;
3738        DIR *dir = opendir(path->buf);
3739        struct dirent *de;
3740        int r = 0;
3741
3742        if (!dir) {
3743                if (errno == ENOENT)
3744                        return 0;
3745                return error_errno("unable to open %s", path->buf);
3746        }
3747
3748        while ((de = readdir(dir))) {
3749                if (is_dot_or_dotdot(de->d_name))
3750                        continue;
3751
3752                strbuf_setlen(path, baselen);
3753                strbuf_addf(path, "/%s", de->d_name);
3754
3755                if (strlen(de->d_name) == 38)  {
3756                        char hex[41];
3757                        unsigned char sha1[20];
3758
3759                        snprintf(hex, sizeof(hex), "%02x%s",
3760                                 subdir_nr, de->d_name);
3761                        if (!get_sha1_hex(hex, sha1)) {
3762                                if (obj_cb) {
3763                                        r = obj_cb(sha1, path->buf, data);
3764                                        if (r)
3765                                                break;
3766                                }
3767                                continue;
3768                        }
3769                }
3770
3771                if (cruft_cb) {
3772                        r = cruft_cb(de->d_name, path->buf, data);
3773                        if (r)
3774                                break;
3775                }
3776        }
3777        closedir(dir);
3778
3779        strbuf_setlen(path, baselen);
3780        if (!r && subdir_cb)
3781                r = subdir_cb(subdir_nr, path->buf, data);
3782
3783        return r;
3784}
3785
3786int for_each_loose_file_in_objdir_buf(struct strbuf *path,
3787                            each_loose_object_fn obj_cb,
3788                            each_loose_cruft_fn cruft_cb,
3789                            each_loose_subdir_fn subdir_cb,
3790                            void *data)
3791{
3792        size_t baselen = path->len;
3793        int r = 0;
3794        int i;
3795
3796        for (i = 0; i < 256; i++) {
3797                strbuf_addf(path, "/%02x", i);
3798                r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
3799                                                subdir_cb, data);
3800                strbuf_setlen(path, baselen);
3801                if (r)
3802                        break;
3803        }
3804
3805        return r;
3806}
3807
3808int for_each_loose_file_in_objdir(const char *path,
3809                                  each_loose_object_fn obj_cb,
3810                                  each_loose_cruft_fn cruft_cb,
3811                                  each_loose_subdir_fn subdir_cb,
3812                                  void *data)
3813{
3814        struct strbuf buf = STRBUF_INIT;
3815        int r;
3816
3817        strbuf_addstr(&buf, path);
3818        r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
3819                                              subdir_cb, data);
3820        strbuf_release(&buf);
3821
3822        return r;
3823}
3824
3825struct loose_alt_odb_data {
3826        each_loose_object_fn *cb;
3827        void *data;
3828};
3829
3830static int loose_from_alt_odb(struct alternate_object_database *alt,
3831                              void *vdata)
3832{
3833        struct loose_alt_odb_data *data = vdata;
3834        struct strbuf buf = STRBUF_INIT;
3835        int r;
3836
3837        strbuf_addstr(&buf, alt->path);
3838        r = for_each_loose_file_in_objdir_buf(&buf,
3839                                              data->cb, NULL, NULL,
3840                                              data->data);
3841        strbuf_release(&buf);
3842        return r;
3843}
3844
3845int for_each_loose_object(each_loose_object_fn cb, void *data, unsigned flags)
3846{
3847        struct loose_alt_odb_data alt;
3848        int r;
3849
3850        r = for_each_loose_file_in_objdir(get_object_directory(),
3851                                          cb, NULL, NULL, data);
3852        if (r)
3853                return r;
3854
3855        if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
3856                return 0;
3857
3858        alt.cb = cb;
3859        alt.data = data;
3860        return foreach_alt_odb(loose_from_alt_odb, &alt);
3861}
3862
3863static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
3864{
3865        uint32_t i;
3866        int r = 0;
3867
3868        for (i = 0; i < p->num_objects; i++) {
3869                const unsigned char *sha1 = nth_packed_object_sha1(p, i);
3870
3871                if (!sha1)
3872                        return error("unable to get sha1 of object %u in %s",
3873                                     i, p->pack_name);
3874
3875                r = cb(sha1, p, i, data);
3876                if (r)
3877                        break;
3878        }
3879        return r;
3880}
3881
3882int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
3883{
3884        struct packed_git *p;
3885        int r = 0;
3886        int pack_errors = 0;
3887
3888        prepare_packed_git();
3889        for (p = packed_git; p; p = p->next) {
3890                if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
3891                        continue;
3892                if (open_pack_index(p)) {
3893                        pack_errors = 1;
3894                        continue;
3895                }
3896                r = for_each_object_in_pack(p, cb, data);
3897                if (r)
3898                        break;
3899        }
3900        return r ? r : pack_errors;
3901}
3902
3903static int check_stream_sha1(git_zstream *stream,
3904                             const char *hdr,
3905                             unsigned long size,
3906                             const char *path,
3907                             const unsigned char *expected_sha1)
3908{
3909        git_SHA_CTX c;
3910        unsigned char real_sha1[GIT_SHA1_RAWSZ];
3911        unsigned char buf[4096];
3912        unsigned long total_read;
3913        int status = Z_OK;
3914
3915        git_SHA1_Init(&c);
3916        git_SHA1_Update(&c, hdr, stream->total_out);
3917
3918        /*
3919         * We already read some bytes into hdr, but the ones up to the NUL
3920         * do not count against the object's content size.
3921         */
3922        total_read = stream->total_out - strlen(hdr) - 1;
3923
3924        /*
3925         * This size comparison must be "<=" to read the final zlib packets;
3926         * see the comment in unpack_sha1_rest for details.
3927         */
3928        while (total_read <= size &&
3929               (status == Z_OK || status == Z_BUF_ERROR)) {
3930                stream->next_out = buf;
3931                stream->avail_out = sizeof(buf);
3932                if (size - total_read < stream->avail_out)
3933                        stream->avail_out = size - total_read;
3934                status = git_inflate(stream, Z_FINISH);
3935                git_SHA1_Update(&c, buf, stream->next_out - buf);
3936                total_read += stream->next_out - buf;
3937        }
3938        git_inflate_end(stream);
3939
3940        if (status != Z_STREAM_END) {
3941                error("corrupt loose object '%s'", sha1_to_hex(expected_sha1));
3942                return -1;
3943        }
3944        if (stream->avail_in) {
3945                error("garbage at end of loose object '%s'",
3946                      sha1_to_hex(expected_sha1));
3947                return -1;
3948        }
3949
3950        git_SHA1_Final(real_sha1, &c);
3951        if (hashcmp(expected_sha1, real_sha1)) {
3952                error("sha1 mismatch for %s (expected %s)", path,
3953                      sha1_to_hex(expected_sha1));
3954                return -1;
3955        }
3956
3957        return 0;
3958}
3959
3960int read_loose_object(const char *path,
3961                      const unsigned char *expected_sha1,
3962                      enum object_type *type,
3963                      unsigned long *size,
3964                      void **contents)
3965{
3966        int ret = -1;
3967        int fd = -1;
3968        void *map = NULL;
3969        unsigned long mapsize;
3970        git_zstream stream;
3971        char hdr[32];
3972
3973        *contents = NULL;
3974
3975        map = map_sha1_file_1(path, NULL, &mapsize);
3976        if (!map) {
3977                error_errno("unable to mmap %s", path);
3978                goto out;
3979        }
3980
3981        if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0) {
3982                error("unable to unpack header of %s", path);
3983                goto out;
3984        }
3985
3986        *type = parse_sha1_header(hdr, size);
3987        if (*type < 0) {
3988                error("unable to parse header of %s", path);
3989                git_inflate_end(&stream);
3990                goto out;
3991        }
3992
3993        if (*type == OBJ_BLOB) {
3994                if (check_stream_sha1(&stream, hdr, *size, path, expected_sha1) < 0)
3995                        goto out;
3996        } else {
3997                *contents = unpack_sha1_rest(&stream, hdr, *size, expected_sha1);
3998                if (!*contents) {
3999                        error("unable to unpack contents of %s", path);
4000                        git_inflate_end(&stream);
4001                        goto out;
4002                }
4003                if (check_sha1_signature(expected_sha1, *contents,
4004                                         *size, typename(*type))) {
4005                        error("sha1 mismatch for %s (expected %s)", path,
4006                              sha1_to_hex(expected_sha1));
4007                        free(*contents);
4008                        goto out;
4009                }
4010        }
4011
4012        ret = 0; /* everything checks out */
4013
4014out:
4015        if (map)
4016                munmap(map, mapsize);
4017        if (fd >= 0)
4018                close(fd);
4019        return ret;
4020}