cache-tree.con commit cache-tree: create/update cache-tree on checkout (aecf567)
   1#include "cache.h"
   2#include "tree.h"
   3#include "tree-walk.h"
   4#include "cache-tree.h"
   5
   6#ifndef DEBUG
   7#define DEBUG 0
   8#endif
   9
  10struct cache_tree *cache_tree(void)
  11{
  12        struct cache_tree *it = xcalloc(1, sizeof(struct cache_tree));
  13        it->entry_count = -1;
  14        return it;
  15}
  16
  17void cache_tree_free(struct cache_tree **it_p)
  18{
  19        int i;
  20        struct cache_tree *it = *it_p;
  21
  22        if (!it)
  23                return;
  24        for (i = 0; i < it->subtree_nr; i++)
  25                if (it->down[i]) {
  26                        cache_tree_free(&it->down[i]->cache_tree);
  27                        free(it->down[i]);
  28                }
  29        free(it->down);
  30        free(it);
  31        *it_p = NULL;
  32}
  33
  34static int subtree_name_cmp(const char *one, int onelen,
  35                            const char *two, int twolen)
  36{
  37        if (onelen < twolen)
  38                return -1;
  39        if (twolen < onelen)
  40                return 1;
  41        return memcmp(one, two, onelen);
  42}
  43
  44static int subtree_pos(struct cache_tree *it, const char *path, int pathlen)
  45{
  46        struct cache_tree_sub **down = it->down;
  47        int lo, hi;
  48        lo = 0;
  49        hi = it->subtree_nr;
  50        while (lo < hi) {
  51                int mi = (lo + hi) / 2;
  52                struct cache_tree_sub *mdl = down[mi];
  53                int cmp = subtree_name_cmp(path, pathlen,
  54                                           mdl->name, mdl->namelen);
  55                if (!cmp)
  56                        return mi;
  57                if (cmp < 0)
  58                        hi = mi;
  59                else
  60                        lo = mi + 1;
  61        }
  62        return -lo-1;
  63}
  64
  65static struct cache_tree_sub *find_subtree(struct cache_tree *it,
  66                                           const char *path,
  67                                           int pathlen,
  68                                           int create)
  69{
  70        struct cache_tree_sub *down;
  71        int pos = subtree_pos(it, path, pathlen);
  72        if (0 <= pos)
  73                return it->down[pos];
  74        if (!create)
  75                return NULL;
  76
  77        pos = -pos-1;
  78        ALLOC_GROW(it->down, it->subtree_nr + 1, it->subtree_alloc);
  79        it->subtree_nr++;
  80
  81        down = xmalloc(sizeof(*down) + pathlen + 1);
  82        down->cache_tree = NULL;
  83        down->namelen = pathlen;
  84        memcpy(down->name, path, pathlen);
  85        down->name[pathlen] = 0;
  86
  87        if (pos < it->subtree_nr)
  88                memmove(it->down + pos + 1,
  89                        it->down + pos,
  90                        sizeof(down) * (it->subtree_nr - pos - 1));
  91        it->down[pos] = down;
  92        return down;
  93}
  94
  95struct cache_tree_sub *cache_tree_sub(struct cache_tree *it, const char *path)
  96{
  97        int pathlen = strlen(path);
  98        return find_subtree(it, path, pathlen, 1);
  99}
 100
 101void cache_tree_invalidate_path(struct cache_tree *it, const char *path)
 102{
 103        /* a/b/c
 104         * ==> invalidate self
 105         * ==> find "a", have it invalidate "b/c"
 106         * a
 107         * ==> invalidate self
 108         * ==> if "a" exists as a subtree, remove it.
 109         */
 110        const char *slash;
 111        int namelen;
 112        struct cache_tree_sub *down;
 113
 114#if DEBUG
 115        fprintf(stderr, "cache-tree invalidate <%s>\n", path);
 116#endif
 117
 118        if (!it)
 119                return;
 120        slash = strchrnul(path, '/');
 121        namelen = slash - path;
 122        it->entry_count = -1;
 123        if (!*slash) {
 124                int pos;
 125                pos = subtree_pos(it, path, namelen);
 126                if (0 <= pos) {
 127                        cache_tree_free(&it->down[pos]->cache_tree);
 128                        free(it->down[pos]);
 129                        /* 0 1 2 3 4 5
 130                         *       ^     ^subtree_nr = 6
 131                         *       pos
 132                         * move 4 and 5 up one place (2 entries)
 133                         * 2 = 6 - 3 - 1 = subtree_nr - pos - 1
 134                         */
 135                        memmove(it->down+pos, it->down+pos+1,
 136                                sizeof(struct cache_tree_sub *) *
 137                                (it->subtree_nr - pos - 1));
 138                        it->subtree_nr--;
 139                }
 140                return;
 141        }
 142        down = find_subtree(it, path, namelen, 0);
 143        if (down)
 144                cache_tree_invalidate_path(down->cache_tree, slash + 1);
 145}
 146
 147static int verify_cache(const struct cache_entry * const *cache,
 148                        int entries, int flags)
 149{
 150        int i, funny;
 151        int silent = flags & WRITE_TREE_SILENT;
 152
 153        /* Verify that the tree is merged */
 154        funny = 0;
 155        for (i = 0; i < entries; i++) {
 156                const struct cache_entry *ce = cache[i];
 157                if (ce_stage(ce)) {
 158                        if (silent)
 159                                return -1;
 160                        if (10 < ++funny) {
 161                                fprintf(stderr, "...\n");
 162                                break;
 163                        }
 164                        fprintf(stderr, "%s: unmerged (%s)\n",
 165                                ce->name, sha1_to_hex(ce->sha1));
 166                }
 167        }
 168        if (funny)
 169                return -1;
 170
 171        /* Also verify that the cache does not have path and path/file
 172         * at the same time.  At this point we know the cache has only
 173         * stage 0 entries.
 174         */
 175        funny = 0;
 176        for (i = 0; i < entries - 1; i++) {
 177                /* path/file always comes after path because of the way
 178                 * the cache is sorted.  Also path can appear only once,
 179                 * which means conflicting one would immediately follow.
 180                 */
 181                const char *this_name = cache[i]->name;
 182                const char *next_name = cache[i+1]->name;
 183                int this_len = strlen(this_name);
 184                if (this_len < strlen(next_name) &&
 185                    strncmp(this_name, next_name, this_len) == 0 &&
 186                    next_name[this_len] == '/') {
 187                        if (10 < ++funny) {
 188                                fprintf(stderr, "...\n");
 189                                break;
 190                        }
 191                        fprintf(stderr, "You have both %s and %s\n",
 192                                this_name, next_name);
 193                }
 194        }
 195        if (funny)
 196                return -1;
 197        return 0;
 198}
 199
 200static void discard_unused_subtrees(struct cache_tree *it)
 201{
 202        struct cache_tree_sub **down = it->down;
 203        int nr = it->subtree_nr;
 204        int dst, src;
 205        for (dst = src = 0; src < nr; src++) {
 206                struct cache_tree_sub *s = down[src];
 207                if (s->used)
 208                        down[dst++] = s;
 209                else {
 210                        cache_tree_free(&s->cache_tree);
 211                        free(s);
 212                        it->subtree_nr--;
 213                }
 214        }
 215}
 216
 217int cache_tree_fully_valid(struct cache_tree *it)
 218{
 219        int i;
 220        if (!it)
 221                return 0;
 222        if (it->entry_count < 0 || !has_sha1_file(it->sha1))
 223                return 0;
 224        for (i = 0; i < it->subtree_nr; i++) {
 225                if (!cache_tree_fully_valid(it->down[i]->cache_tree))
 226                        return 0;
 227        }
 228        return 1;
 229}
 230
 231static int update_one(struct cache_tree *it,
 232                      const struct cache_entry * const *cache,
 233                      int entries,
 234                      const char *base,
 235                      int baselen,
 236                      int *skip_count,
 237                      int flags)
 238{
 239        struct strbuf buffer;
 240        int missing_ok = flags & WRITE_TREE_MISSING_OK;
 241        int dryrun = flags & WRITE_TREE_DRY_RUN;
 242        int repair = flags & WRITE_TREE_REPAIR;
 243        int to_invalidate = 0;
 244        int i;
 245
 246        assert(!(dryrun && repair));
 247
 248        *skip_count = 0;
 249
 250        if (0 <= it->entry_count && has_sha1_file(it->sha1))
 251                return it->entry_count;
 252
 253        /*
 254         * We first scan for subtrees and update them; we start by
 255         * marking existing subtrees -- the ones that are unmarked
 256         * should not be in the result.
 257         */
 258        for (i = 0; i < it->subtree_nr; i++)
 259                it->down[i]->used = 0;
 260
 261        /*
 262         * Find the subtrees and update them.
 263         */
 264        i = 0;
 265        while (i < entries) {
 266                const struct cache_entry *ce = cache[i];
 267                struct cache_tree_sub *sub;
 268                const char *path, *slash;
 269                int pathlen, sublen, subcnt, subskip;
 270
 271                path = ce->name;
 272                pathlen = ce_namelen(ce);
 273                if (pathlen <= baselen || memcmp(base, path, baselen))
 274                        break; /* at the end of this level */
 275
 276                slash = strchr(path + baselen, '/');
 277                if (!slash) {
 278                        i++;
 279                        continue;
 280                }
 281                /*
 282                 * a/bbb/c (base = a/, slash = /c)
 283                 * ==>
 284                 * path+baselen = bbb/c, sublen = 3
 285                 */
 286                sublen = slash - (path + baselen);
 287                sub = find_subtree(it, path + baselen, sublen, 1);
 288                if (!sub->cache_tree)
 289                        sub->cache_tree = cache_tree();
 290                subcnt = update_one(sub->cache_tree,
 291                                    cache + i, entries - i,
 292                                    path,
 293                                    baselen + sublen + 1,
 294                                    &subskip,
 295                                    flags);
 296                if (subcnt < 0)
 297                        return subcnt;
 298                i += subcnt;
 299                sub->count = subcnt; /* to be used in the next loop */
 300                *skip_count += subskip;
 301                sub->used = 1;
 302        }
 303
 304        discard_unused_subtrees(it);
 305
 306        /*
 307         * Then write out the tree object for this level.
 308         */
 309        strbuf_init(&buffer, 8192);
 310
 311        i = 0;
 312        while (i < entries) {
 313                const struct cache_entry *ce = cache[i];
 314                struct cache_tree_sub *sub;
 315                const char *path, *slash;
 316                int pathlen, entlen;
 317                const unsigned char *sha1;
 318                unsigned mode;
 319
 320                path = ce->name;
 321                pathlen = ce_namelen(ce);
 322                if (pathlen <= baselen || memcmp(base, path, baselen))
 323                        break; /* at the end of this level */
 324
 325                slash = strchr(path + baselen, '/');
 326                if (slash) {
 327                        entlen = slash - (path + baselen);
 328                        sub = find_subtree(it, path + baselen, entlen, 0);
 329                        if (!sub)
 330                                die("cache-tree.c: '%.*s' in '%s' not found",
 331                                    entlen, path + baselen, path);
 332                        i += sub->count;
 333                        sha1 = sub->cache_tree->sha1;
 334                        mode = S_IFDIR;
 335                        if (sub->cache_tree->entry_count < 0)
 336                                to_invalidate = 1;
 337                }
 338                else {
 339                        sha1 = ce->sha1;
 340                        mode = ce->ce_mode;
 341                        entlen = pathlen - baselen;
 342                        i++;
 343                }
 344                if (mode != S_IFGITLINK && !missing_ok && !has_sha1_file(sha1)) {
 345                        strbuf_release(&buffer);
 346                        return error("invalid object %06o %s for '%.*s'",
 347                                mode, sha1_to_hex(sha1), entlen+baselen, path);
 348                }
 349
 350                /*
 351                 * CE_REMOVE entries are removed before the index is
 352                 * written to disk. Skip them to remain consistent
 353                 * with the future on-disk index.
 354                 */
 355                if (ce->ce_flags & CE_REMOVE) {
 356                        *skip_count = *skip_count + 1;
 357                        continue;
 358                }
 359
 360                /*
 361                 * CE_INTENT_TO_ADD entries exist on on-disk index but
 362                 * they are not part of generated trees. Invalidate up
 363                 * to root to force cache-tree users to read elsewhere.
 364                 */
 365                if (ce->ce_flags & CE_INTENT_TO_ADD) {
 366                        to_invalidate = 1;
 367                        continue;
 368                }
 369
 370                strbuf_grow(&buffer, entlen + 100);
 371                strbuf_addf(&buffer, "%o %.*s%c", mode, entlen, path + baselen, '\0');
 372                strbuf_add(&buffer, sha1, 20);
 373
 374#if DEBUG
 375                fprintf(stderr, "cache-tree update-one %o %.*s\n",
 376                        mode, entlen, path + baselen);
 377#endif
 378        }
 379
 380        if (repair) {
 381                unsigned char sha1[20];
 382                hash_sha1_file(buffer.buf, buffer.len, tree_type, sha1);
 383                if (has_sha1_file(sha1))
 384                        hashcpy(it->sha1, sha1);
 385                else
 386                        to_invalidate = 1;
 387        } else if (dryrun)
 388                hash_sha1_file(buffer.buf, buffer.len, tree_type, it->sha1);
 389        else if (write_sha1_file(buffer.buf, buffer.len, tree_type, it->sha1)) {
 390                strbuf_release(&buffer);
 391                return -1;
 392        }
 393
 394        strbuf_release(&buffer);
 395        it->entry_count = to_invalidate ? -1 : i - *skip_count;
 396#if DEBUG
 397        fprintf(stderr, "cache-tree update-one (%d ent, %d subtree) %s\n",
 398                it->entry_count, it->subtree_nr,
 399                sha1_to_hex(it->sha1));
 400#endif
 401        return i;
 402}
 403
 404int cache_tree_update(struct cache_tree *it,
 405                      const struct cache_entry * const *cache,
 406                      int entries,
 407                      int flags)
 408{
 409        int i, skip;
 410        i = verify_cache(cache, entries, flags);
 411        if (i)
 412                return i;
 413        i = update_one(it, cache, entries, "", 0, &skip, flags);
 414        if (i < 0)
 415                return i;
 416        return 0;
 417}
 418
 419static void write_one(struct strbuf *buffer, struct cache_tree *it,
 420                      const char *path, int pathlen)
 421{
 422        int i;
 423
 424        /* One "cache-tree" entry consists of the following:
 425         * path (NUL terminated)
 426         * entry_count, subtree_nr ("%d %d\n")
 427         * tree-sha1 (missing if invalid)
 428         * subtree_nr "cache-tree" entries for subtrees.
 429         */
 430        strbuf_grow(buffer, pathlen + 100);
 431        strbuf_add(buffer, path, pathlen);
 432        strbuf_addf(buffer, "%c%d %d\n", 0, it->entry_count, it->subtree_nr);
 433
 434#if DEBUG
 435        if (0 <= it->entry_count)
 436                fprintf(stderr, "cache-tree <%.*s> (%d ent, %d subtree) %s\n",
 437                        pathlen, path, it->entry_count, it->subtree_nr,
 438                        sha1_to_hex(it->sha1));
 439        else
 440                fprintf(stderr, "cache-tree <%.*s> (%d subtree) invalid\n",
 441                        pathlen, path, it->subtree_nr);
 442#endif
 443
 444        if (0 <= it->entry_count) {
 445                strbuf_add(buffer, it->sha1, 20);
 446        }
 447        for (i = 0; i < it->subtree_nr; i++) {
 448                struct cache_tree_sub *down = it->down[i];
 449                if (i) {
 450                        struct cache_tree_sub *prev = it->down[i-1];
 451                        if (subtree_name_cmp(down->name, down->namelen,
 452                                             prev->name, prev->namelen) <= 0)
 453                                die("fatal - unsorted cache subtree");
 454                }
 455                write_one(buffer, down->cache_tree, down->name, down->namelen);
 456        }
 457}
 458
 459void cache_tree_write(struct strbuf *sb, struct cache_tree *root)
 460{
 461        write_one(sb, root, "", 0);
 462}
 463
 464static struct cache_tree *read_one(const char **buffer, unsigned long *size_p)
 465{
 466        const char *buf = *buffer;
 467        unsigned long size = *size_p;
 468        const char *cp;
 469        char *ep;
 470        struct cache_tree *it;
 471        int i, subtree_nr;
 472
 473        it = NULL;
 474        /* skip name, but make sure name exists */
 475        while (size && *buf) {
 476                size--;
 477                buf++;
 478        }
 479        if (!size)
 480                goto free_return;
 481        buf++; size--;
 482        it = cache_tree();
 483
 484        cp = buf;
 485        it->entry_count = strtol(cp, &ep, 10);
 486        if (cp == ep)
 487                goto free_return;
 488        cp = ep;
 489        subtree_nr = strtol(cp, &ep, 10);
 490        if (cp == ep)
 491                goto free_return;
 492        while (size && *buf && *buf != '\n') {
 493                size--;
 494                buf++;
 495        }
 496        if (!size)
 497                goto free_return;
 498        buf++; size--;
 499        if (0 <= it->entry_count) {
 500                if (size < 20)
 501                        goto free_return;
 502                hashcpy(it->sha1, (const unsigned char*)buf);
 503                buf += 20;
 504                size -= 20;
 505        }
 506
 507#if DEBUG
 508        if (0 <= it->entry_count)
 509                fprintf(stderr, "cache-tree <%s> (%d ent, %d subtree) %s\n",
 510                        *buffer, it->entry_count, subtree_nr,
 511                        sha1_to_hex(it->sha1));
 512        else
 513                fprintf(stderr, "cache-tree <%s> (%d subtrees) invalid\n",
 514                        *buffer, subtree_nr);
 515#endif
 516
 517        /*
 518         * Just a heuristic -- we do not add directories that often but
 519         * we do not want to have to extend it immediately when we do,
 520         * hence +2.
 521         */
 522        it->subtree_alloc = subtree_nr + 2;
 523        it->down = xcalloc(it->subtree_alloc, sizeof(struct cache_tree_sub *));
 524        for (i = 0; i < subtree_nr; i++) {
 525                /* read each subtree */
 526                struct cache_tree *sub;
 527                struct cache_tree_sub *subtree;
 528                const char *name = buf;
 529
 530                sub = read_one(&buf, &size);
 531                if (!sub)
 532                        goto free_return;
 533                subtree = cache_tree_sub(it, name);
 534                subtree->cache_tree = sub;
 535        }
 536        if (subtree_nr != it->subtree_nr)
 537                die("cache-tree: internal error");
 538        *buffer = buf;
 539        *size_p = size;
 540        return it;
 541
 542 free_return:
 543        cache_tree_free(&it);
 544        return NULL;
 545}
 546
 547struct cache_tree *cache_tree_read(const char *buffer, unsigned long size)
 548{
 549        if (buffer[0])
 550                return NULL; /* not the whole tree */
 551        return read_one(&buffer, &size);
 552}
 553
 554static struct cache_tree *cache_tree_find(struct cache_tree *it, const char *path)
 555{
 556        if (!it)
 557                return NULL;
 558        while (*path) {
 559                const char *slash;
 560                struct cache_tree_sub *sub;
 561
 562                slash = strchrnul(path, '/');
 563                /*
 564                 * Between path and slash is the name of the subtree
 565                 * to look for.
 566                 */
 567                sub = find_subtree(it, path, slash - path, 0);
 568                if (!sub)
 569                        return NULL;
 570                it = sub->cache_tree;
 571
 572                path = slash;
 573                while (*path == '/')
 574                        path++;
 575        }
 576        return it;
 577}
 578
 579int write_cache_as_tree(unsigned char *sha1, int flags, const char *prefix)
 580{
 581        int entries, was_valid, newfd;
 582        struct lock_file *lock_file;
 583
 584        /*
 585         * We can't free this memory, it becomes part of a linked list
 586         * parsed atexit()
 587         */
 588        lock_file = xcalloc(1, sizeof(struct lock_file));
 589
 590        newfd = hold_locked_index(lock_file, 1);
 591
 592        entries = read_cache();
 593        if (entries < 0)
 594                return WRITE_TREE_UNREADABLE_INDEX;
 595        if (flags & WRITE_TREE_IGNORE_CACHE_TREE)
 596                cache_tree_free(&(active_cache_tree));
 597
 598        if (!active_cache_tree)
 599                active_cache_tree = cache_tree();
 600
 601        was_valid = cache_tree_fully_valid(active_cache_tree);
 602        if (!was_valid) {
 603                if (cache_tree_update(active_cache_tree,
 604                                      (const struct cache_entry * const *)active_cache,
 605                                      active_nr, flags) < 0)
 606                        return WRITE_TREE_UNMERGED_INDEX;
 607                if (0 <= newfd) {
 608                        if (!write_cache(newfd, active_cache, active_nr) &&
 609                            !commit_lock_file(lock_file))
 610                                newfd = -1;
 611                }
 612                /* Not being able to write is fine -- we are only interested
 613                 * in updating the cache-tree part, and if the next caller
 614                 * ends up using the old index with unupdated cache-tree part
 615                 * it misses the work we did here, but that is just a
 616                 * performance penalty and not a big deal.
 617                 */
 618        }
 619
 620        if (prefix) {
 621                struct cache_tree *subtree =
 622                        cache_tree_find(active_cache_tree, prefix);
 623                if (!subtree)
 624                        return WRITE_TREE_PREFIX_ERROR;
 625                hashcpy(sha1, subtree->sha1);
 626        }
 627        else
 628                hashcpy(sha1, active_cache_tree->sha1);
 629
 630        if (0 <= newfd)
 631                rollback_lock_file(lock_file);
 632
 633        return 0;
 634}
 635
 636static void prime_cache_tree_rec(struct cache_tree *it, struct tree *tree)
 637{
 638        struct tree_desc desc;
 639        struct name_entry entry;
 640        int cnt;
 641
 642        hashcpy(it->sha1, tree->object.sha1);
 643        init_tree_desc(&desc, tree->buffer, tree->size);
 644        cnt = 0;
 645        while (tree_entry(&desc, &entry)) {
 646                if (!S_ISDIR(entry.mode))
 647                        cnt++;
 648                else {
 649                        struct cache_tree_sub *sub;
 650                        struct tree *subtree = lookup_tree(entry.sha1);
 651                        if (!subtree->object.parsed)
 652                                parse_tree(subtree);
 653                        sub = cache_tree_sub(it, entry.path);
 654                        sub->cache_tree = cache_tree();
 655                        prime_cache_tree_rec(sub->cache_tree, subtree);
 656                        cnt += sub->cache_tree->entry_count;
 657                }
 658        }
 659        it->entry_count = cnt;
 660}
 661
 662void prime_cache_tree(struct cache_tree **it, struct tree *tree)
 663{
 664        cache_tree_free(it);
 665        *it = cache_tree();
 666        prime_cache_tree_rec(*it, tree);
 667}
 668
 669/*
 670 * find the cache_tree that corresponds to the current level without
 671 * exploding the full path into textual form.  The root of the
 672 * cache tree is given as "root", and our current level is "info".
 673 * (1) When at root level, info->prev is NULL, so it is "root" itself.
 674 * (2) Otherwise, find the cache_tree that corresponds to one level
 675 *     above us, and find ourselves in there.
 676 */
 677static struct cache_tree *find_cache_tree_from_traversal(struct cache_tree *root,
 678                                                         struct traverse_info *info)
 679{
 680        struct cache_tree *our_parent;
 681
 682        if (!info->prev)
 683                return root;
 684        our_parent = find_cache_tree_from_traversal(root, info->prev);
 685        return cache_tree_find(our_parent, info->name.path);
 686}
 687
 688int cache_tree_matches_traversal(struct cache_tree *root,
 689                                 struct name_entry *ent,
 690                                 struct traverse_info *info)
 691{
 692        struct cache_tree *it;
 693
 694        it = find_cache_tree_from_traversal(root, info);
 695        it = cache_tree_find(it, ent->path);
 696        if (it && it->entry_count > 0 && !hashcmp(ent->sha1, it->sha1))
 697                return it->entry_count;
 698        return 0;
 699}
 700
 701int update_main_cache_tree(int flags)
 702{
 703        if (!the_index.cache_tree)
 704                the_index.cache_tree = cache_tree();
 705        return cache_tree_update(the_index.cache_tree,
 706                                 (const struct cache_entry * const *)the_index.cache,
 707                                 the_index.cache_nr, flags);
 708}