b5e9c3f8acb58f26ad4f08874585e1684caf2077
   1/*
   2 * GIT - The information manager from hell
   3 *
   4 * Copyright (C) Linus Torvalds, 2005
   5 */
   6#define NO_THE_INDEX_COMPATIBILITY_MACROS
   7#include "cache.h"
   8#include "lockfile.h"
   9#include "cache-tree.h"
  10#include "refs.h"
  11#include "dir.h"
  12#include "tree.h"
  13#include "commit.h"
  14#include "blob.h"
  15#include "resolve-undo.h"
  16#include "strbuf.h"
  17#include "varint.h"
  18#include "split-index.h"
  19#include "sigchain.h"
  20#include "utf8.h"
  21
  22static struct cache_entry *refresh_cache_entry(struct cache_entry *ce,
  23                                               unsigned int options);
  24
  25/* Mask for the name length in ce_flags in the on-disk index */
  26
  27#define CE_NAMEMASK  (0x0fff)
  28
  29/* Index extensions.
  30 *
  31 * The first letter should be 'A'..'Z' for extensions that are not
  32 * necessary for a correct operation (i.e. optimization data).
  33 * When new extensions are added that _needs_ to be understood in
  34 * order to correctly interpret the index file, pick character that
  35 * is outside the range, to cause the reader to abort.
  36 */
  37
  38#define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
  39#define CACHE_EXT_TREE 0x54524545       /* "TREE" */
  40#define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
  41#define CACHE_EXT_LINK 0x6c696e6b         /* "link" */
  42#define CACHE_EXT_UNTRACKED 0x554E5452    /* "UNTR" */
  43
  44/* changes that can be kept in $GIT_DIR/index (basically all extensions) */
  45#define EXTMASK (RESOLVE_UNDO_CHANGED | CACHE_TREE_CHANGED | \
  46                 CE_ENTRY_ADDED | CE_ENTRY_REMOVED | CE_ENTRY_CHANGED | \
  47                 SPLIT_INDEX_ORDERED)
  48
  49struct index_state the_index;
  50static const char *alternate_index_output;
  51
  52static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
  53{
  54        istate->cache[nr] = ce;
  55        add_name_hash(istate, ce);
  56}
  57
  58static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
  59{
  60        struct cache_entry *old = istate->cache[nr];
  61
  62        replace_index_entry_in_base(istate, old, ce);
  63        remove_name_hash(istate, old);
  64        free(old);
  65        set_index_entry(istate, nr, ce);
  66        ce->ce_flags |= CE_UPDATE_IN_BASE;
  67        istate->cache_changed |= CE_ENTRY_CHANGED;
  68}
  69
  70void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
  71{
  72        struct cache_entry *old = istate->cache[nr], *new;
  73        int namelen = strlen(new_name);
  74
  75        new = xmalloc(cache_entry_size(namelen));
  76        copy_cache_entry(new, old);
  77        new->ce_flags &= ~CE_HASHED;
  78        new->ce_namelen = namelen;
  79        new->index = 0;
  80        memcpy(new->name, new_name, namelen + 1);
  81
  82        cache_tree_invalidate_path(istate, old->name);
  83        untracked_cache_remove_from_index(istate, old->name);
  84        remove_index_entry_at(istate, nr);
  85        add_index_entry(istate, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
  86}
  87
  88void fill_stat_data(struct stat_data *sd, struct stat *st)
  89{
  90        sd->sd_ctime.sec = (unsigned int)st->st_ctime;
  91        sd->sd_mtime.sec = (unsigned int)st->st_mtime;
  92        sd->sd_ctime.nsec = ST_CTIME_NSEC(*st);
  93        sd->sd_mtime.nsec = ST_MTIME_NSEC(*st);
  94        sd->sd_dev = st->st_dev;
  95        sd->sd_ino = st->st_ino;
  96        sd->sd_uid = st->st_uid;
  97        sd->sd_gid = st->st_gid;
  98        sd->sd_size = st->st_size;
  99}
 100
 101int match_stat_data(const struct stat_data *sd, struct stat *st)
 102{
 103        int changed = 0;
 104
 105        if (sd->sd_mtime.sec != (unsigned int)st->st_mtime)
 106                changed |= MTIME_CHANGED;
 107        if (trust_ctime && check_stat &&
 108            sd->sd_ctime.sec != (unsigned int)st->st_ctime)
 109                changed |= CTIME_CHANGED;
 110
 111#ifdef USE_NSEC
 112        if (check_stat && sd->sd_mtime.nsec != ST_MTIME_NSEC(*st))
 113                changed |= MTIME_CHANGED;
 114        if (trust_ctime && check_stat &&
 115            sd->sd_ctime.nsec != ST_CTIME_NSEC(*st))
 116                changed |= CTIME_CHANGED;
 117#endif
 118
 119        if (check_stat) {
 120                if (sd->sd_uid != (unsigned int) st->st_uid ||
 121                        sd->sd_gid != (unsigned int) st->st_gid)
 122                        changed |= OWNER_CHANGED;
 123                if (sd->sd_ino != (unsigned int) st->st_ino)
 124                        changed |= INODE_CHANGED;
 125        }
 126
 127#ifdef USE_STDEV
 128        /*
 129         * st_dev breaks on network filesystems where different
 130         * clients will have different views of what "device"
 131         * the filesystem is on
 132         */
 133        if (check_stat && sd->sd_dev != (unsigned int) st->st_dev)
 134                        changed |= INODE_CHANGED;
 135#endif
 136
 137        if (sd->sd_size != (unsigned int) st->st_size)
 138                changed |= DATA_CHANGED;
 139
 140        return changed;
 141}
 142
 143/*
 144 * This only updates the "non-critical" parts of the directory
 145 * cache, ie the parts that aren't tracked by GIT, and only used
 146 * to validate the cache.
 147 */
 148void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
 149{
 150        fill_stat_data(&ce->ce_stat_data, st);
 151
 152        if (assume_unchanged)
 153                ce->ce_flags |= CE_VALID;
 154
 155        if (S_ISREG(st->st_mode))
 156                ce_mark_uptodate(ce);
 157}
 158
 159static int ce_compare_data(const struct cache_entry *ce, struct stat *st)
 160{
 161        int match = -1;
 162        int fd = open(ce->name, O_RDONLY);
 163
 164        if (fd >= 0) {
 165                unsigned char sha1[20];
 166                if (!index_fd(sha1, fd, st, OBJ_BLOB, ce->name, 0))
 167                        match = hashcmp(sha1, ce->sha1);
 168                /* index_fd() closed the file descriptor already */
 169        }
 170        return match;
 171}
 172
 173static int ce_compare_link(const struct cache_entry *ce, size_t expected_size)
 174{
 175        int match = -1;
 176        void *buffer;
 177        unsigned long size;
 178        enum object_type type;
 179        struct strbuf sb = STRBUF_INIT;
 180
 181        if (strbuf_readlink(&sb, ce->name, expected_size))
 182                return -1;
 183
 184        buffer = read_sha1_file(ce->sha1, &type, &size);
 185        if (buffer) {
 186                if (size == sb.len)
 187                        match = memcmp(buffer, sb.buf, size);
 188                free(buffer);
 189        }
 190        strbuf_release(&sb);
 191        return match;
 192}
 193
 194static int ce_compare_gitlink(const struct cache_entry *ce)
 195{
 196        unsigned char sha1[20];
 197
 198        /*
 199         * We don't actually require that the .git directory
 200         * under GITLINK directory be a valid git directory. It
 201         * might even be missing (in case nobody populated that
 202         * sub-project).
 203         *
 204         * If so, we consider it always to match.
 205         */
 206        if (resolve_gitlink_ref(ce->name, "HEAD", sha1) < 0)
 207                return 0;
 208        return hashcmp(sha1, ce->sha1);
 209}
 210
 211static int ce_modified_check_fs(const struct cache_entry *ce, struct stat *st)
 212{
 213        switch (st->st_mode & S_IFMT) {
 214        case S_IFREG:
 215                if (ce_compare_data(ce, st))
 216                        return DATA_CHANGED;
 217                break;
 218        case S_IFLNK:
 219                if (ce_compare_link(ce, xsize_t(st->st_size)))
 220                        return DATA_CHANGED;
 221                break;
 222        case S_IFDIR:
 223                if (S_ISGITLINK(ce->ce_mode))
 224                        return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
 225        default:
 226                return TYPE_CHANGED;
 227        }
 228        return 0;
 229}
 230
 231static int ce_match_stat_basic(const struct cache_entry *ce, struct stat *st)
 232{
 233        unsigned int changed = 0;
 234
 235        if (ce->ce_flags & CE_REMOVE)
 236                return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
 237
 238        switch (ce->ce_mode & S_IFMT) {
 239        case S_IFREG:
 240                changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
 241                /* We consider only the owner x bit to be relevant for
 242                 * "mode changes"
 243                 */
 244                if (trust_executable_bit &&
 245                    (0100 & (ce->ce_mode ^ st->st_mode)))
 246                        changed |= MODE_CHANGED;
 247                break;
 248        case S_IFLNK:
 249                if (!S_ISLNK(st->st_mode) &&
 250                    (has_symlinks || !S_ISREG(st->st_mode)))
 251                        changed |= TYPE_CHANGED;
 252                break;
 253        case S_IFGITLINK:
 254                /* We ignore most of the st_xxx fields for gitlinks */
 255                if (!S_ISDIR(st->st_mode))
 256                        changed |= TYPE_CHANGED;
 257                else if (ce_compare_gitlink(ce))
 258                        changed |= DATA_CHANGED;
 259                return changed;
 260        default:
 261                die("internal error: ce_mode is %o", ce->ce_mode);
 262        }
 263
 264        changed |= match_stat_data(&ce->ce_stat_data, st);
 265
 266        /* Racily smudged entry? */
 267        if (!ce->ce_stat_data.sd_size) {
 268                if (!is_empty_blob_sha1(ce->sha1))
 269                        changed |= DATA_CHANGED;
 270        }
 271
 272        return changed;
 273}
 274
 275static int is_racy_stat(const struct index_state *istate,
 276                        const struct stat_data *sd)
 277{
 278        return (istate->timestamp.sec &&
 279#ifdef USE_NSEC
 280                 /* nanosecond timestamped files can also be racy! */
 281                (istate->timestamp.sec < sd->sd_mtime.sec ||
 282                 (istate->timestamp.sec == sd->sd_mtime.sec &&
 283                  istate->timestamp.nsec <= sd->sd_mtime.nsec))
 284#else
 285                istate->timestamp.sec <= sd->sd_mtime.sec
 286#endif
 287                );
 288}
 289
 290static int is_racy_timestamp(const struct index_state *istate,
 291                             const struct cache_entry *ce)
 292{
 293        return (!S_ISGITLINK(ce->ce_mode) &&
 294                is_racy_stat(istate, &ce->ce_stat_data));
 295}
 296
 297int ie_match_stat(const struct index_state *istate,
 298                  const struct cache_entry *ce, struct stat *st,
 299                  unsigned int options)
 300{
 301        unsigned int changed;
 302        int ignore_valid = options & CE_MATCH_IGNORE_VALID;
 303        int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
 304        int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
 305
 306        /*
 307         * If it's marked as always valid in the index, it's
 308         * valid whatever the checked-out copy says.
 309         *
 310         * skip-worktree has the same effect with higher precedence
 311         */
 312        if (!ignore_skip_worktree && ce_skip_worktree(ce))
 313                return 0;
 314        if (!ignore_valid && (ce->ce_flags & CE_VALID))
 315                return 0;
 316
 317        /*
 318         * Intent-to-add entries have not been added, so the index entry
 319         * by definition never matches what is in the work tree until it
 320         * actually gets added.
 321         */
 322        if (ce->ce_flags & CE_INTENT_TO_ADD)
 323                return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
 324
 325        changed = ce_match_stat_basic(ce, st);
 326
 327        /*
 328         * Within 1 second of this sequence:
 329         *      echo xyzzy >file && git-update-index --add file
 330         * running this command:
 331         *      echo frotz >file
 332         * would give a falsely clean cache entry.  The mtime and
 333         * length match the cache, and other stat fields do not change.
 334         *
 335         * We could detect this at update-index time (the cache entry
 336         * being registered/updated records the same time as "now")
 337         * and delay the return from git-update-index, but that would
 338         * effectively mean we can make at most one commit per second,
 339         * which is not acceptable.  Instead, we check cache entries
 340         * whose mtime are the same as the index file timestamp more
 341         * carefully than others.
 342         */
 343        if (!changed && is_racy_timestamp(istate, ce)) {
 344                if (assume_racy_is_modified)
 345                        changed |= DATA_CHANGED;
 346                else
 347                        changed |= ce_modified_check_fs(ce, st);
 348        }
 349
 350        return changed;
 351}
 352
 353int ie_modified(const struct index_state *istate,
 354                const struct cache_entry *ce,
 355                struct stat *st, unsigned int options)
 356{
 357        int changed, changed_fs;
 358
 359        changed = ie_match_stat(istate, ce, st, options);
 360        if (!changed)
 361                return 0;
 362        /*
 363         * If the mode or type has changed, there's no point in trying
 364         * to refresh the entry - it's not going to match
 365         */
 366        if (changed & (MODE_CHANGED | TYPE_CHANGED))
 367                return changed;
 368
 369        /*
 370         * Immediately after read-tree or update-index --cacheinfo,
 371         * the length field is zero, as we have never even read the
 372         * lstat(2) information once, and we cannot trust DATA_CHANGED
 373         * returned by ie_match_stat() which in turn was returned by
 374         * ce_match_stat_basic() to signal that the filesize of the
 375         * blob changed.  We have to actually go to the filesystem to
 376         * see if the contents match, and if so, should answer "unchanged".
 377         *
 378         * The logic does not apply to gitlinks, as ce_match_stat_basic()
 379         * already has checked the actual HEAD from the filesystem in the
 380         * subproject.  If ie_match_stat() already said it is different,
 381         * then we know it is.
 382         */
 383        if ((changed & DATA_CHANGED) &&
 384            (S_ISGITLINK(ce->ce_mode) || ce->ce_stat_data.sd_size != 0))
 385                return changed;
 386
 387        changed_fs = ce_modified_check_fs(ce, st);
 388        if (changed_fs)
 389                return changed | changed_fs;
 390        return 0;
 391}
 392
 393int base_name_compare(const char *name1, int len1, int mode1,
 394                      const char *name2, int len2, int mode2)
 395{
 396        unsigned char c1, c2;
 397        int len = len1 < len2 ? len1 : len2;
 398        int cmp;
 399
 400        cmp = memcmp(name1, name2, len);
 401        if (cmp)
 402                return cmp;
 403        c1 = name1[len];
 404        c2 = name2[len];
 405        if (!c1 && S_ISDIR(mode1))
 406                c1 = '/';
 407        if (!c2 && S_ISDIR(mode2))
 408                c2 = '/';
 409        return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
 410}
 411
 412/*
 413 * df_name_compare() is identical to base_name_compare(), except it
 414 * compares conflicting directory/file entries as equal. Note that
 415 * while a directory name compares as equal to a regular file, they
 416 * then individually compare _differently_ to a filename that has
 417 * a dot after the basename (because '\0' < '.' < '/').
 418 *
 419 * This is used by routines that want to traverse the git namespace
 420 * but then handle conflicting entries together when possible.
 421 */
 422int df_name_compare(const char *name1, int len1, int mode1,
 423                    const char *name2, int len2, int mode2)
 424{
 425        int len = len1 < len2 ? len1 : len2, cmp;
 426        unsigned char c1, c2;
 427
 428        cmp = memcmp(name1, name2, len);
 429        if (cmp)
 430                return cmp;
 431        /* Directories and files compare equal (same length, same name) */
 432        if (len1 == len2)
 433                return 0;
 434        c1 = name1[len];
 435        if (!c1 && S_ISDIR(mode1))
 436                c1 = '/';
 437        c2 = name2[len];
 438        if (!c2 && S_ISDIR(mode2))
 439                c2 = '/';
 440        if (c1 == '/' && !c2)
 441                return 0;
 442        if (c2 == '/' && !c1)
 443                return 0;
 444        return c1 - c2;
 445}
 446
 447int name_compare(const char *name1, size_t len1, const char *name2, size_t len2)
 448{
 449        size_t min_len = (len1 < len2) ? len1 : len2;
 450        int cmp = memcmp(name1, name2, min_len);
 451        if (cmp)
 452                return cmp;
 453        if (len1 < len2)
 454                return -1;
 455        if (len1 > len2)
 456                return 1;
 457        return 0;
 458}
 459
 460int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2)
 461{
 462        int cmp;
 463
 464        cmp = name_compare(name1, len1, name2, len2);
 465        if (cmp)
 466                return cmp;
 467
 468        if (stage1 < stage2)
 469                return -1;
 470        if (stage1 > stage2)
 471                return 1;
 472        return 0;
 473}
 474
 475static int index_name_stage_pos(const struct index_state *istate, const char *name, int namelen, int stage)
 476{
 477        int first, last;
 478
 479        first = 0;
 480        last = istate->cache_nr;
 481        while (last > first) {
 482                int next = (last + first) >> 1;
 483                struct cache_entry *ce = istate->cache[next];
 484                int cmp = cache_name_stage_compare(name, namelen, stage, ce->name, ce_namelen(ce), ce_stage(ce));
 485                if (!cmp)
 486                        return next;
 487                if (cmp < 0) {
 488                        last = next;
 489                        continue;
 490                }
 491                first = next+1;
 492        }
 493        return -first-1;
 494}
 495
 496int index_name_pos(const struct index_state *istate, const char *name, int namelen)
 497{
 498        return index_name_stage_pos(istate, name, namelen, 0);
 499}
 500
 501/* Remove entry, return true if there are more entries to go.. */
 502int remove_index_entry_at(struct index_state *istate, int pos)
 503{
 504        struct cache_entry *ce = istate->cache[pos];
 505
 506        record_resolve_undo(istate, ce);
 507        remove_name_hash(istate, ce);
 508        save_or_free_index_entry(istate, ce);
 509        istate->cache_changed |= CE_ENTRY_REMOVED;
 510        istate->cache_nr--;
 511        if (pos >= istate->cache_nr)
 512                return 0;
 513        memmove(istate->cache + pos,
 514                istate->cache + pos + 1,
 515                (istate->cache_nr - pos) * sizeof(struct cache_entry *));
 516        return 1;
 517}
 518
 519/*
 520 * Remove all cache entries marked for removal, that is where
 521 * CE_REMOVE is set in ce_flags.  This is much more effective than
 522 * calling remove_index_entry_at() for each entry to be removed.
 523 */
 524void remove_marked_cache_entries(struct index_state *istate)
 525{
 526        struct cache_entry **ce_array = istate->cache;
 527        unsigned int i, j;
 528
 529        for (i = j = 0; i < istate->cache_nr; i++) {
 530                if (ce_array[i]->ce_flags & CE_REMOVE) {
 531                        remove_name_hash(istate, ce_array[i]);
 532                        save_or_free_index_entry(istate, ce_array[i]);
 533                }
 534                else
 535                        ce_array[j++] = ce_array[i];
 536        }
 537        if (j == istate->cache_nr)
 538                return;
 539        istate->cache_changed |= CE_ENTRY_REMOVED;
 540        istate->cache_nr = j;
 541}
 542
 543int remove_file_from_index(struct index_state *istate, const char *path)
 544{
 545        int pos = index_name_pos(istate, path, strlen(path));
 546        if (pos < 0)
 547                pos = -pos-1;
 548        cache_tree_invalidate_path(istate, path);
 549        untracked_cache_remove_from_index(istate, path);
 550        while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
 551                remove_index_entry_at(istate, pos);
 552        return 0;
 553}
 554
 555static int compare_name(struct cache_entry *ce, const char *path, int namelen)
 556{
 557        return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
 558}
 559
 560static int index_name_pos_also_unmerged(struct index_state *istate,
 561        const char *path, int namelen)
 562{
 563        int pos = index_name_pos(istate, path, namelen);
 564        struct cache_entry *ce;
 565
 566        if (pos >= 0)
 567                return pos;
 568
 569        /* maybe unmerged? */
 570        pos = -1 - pos;
 571        if (pos >= istate->cache_nr ||
 572                        compare_name((ce = istate->cache[pos]), path, namelen))
 573                return -1;
 574
 575        /* order of preference: stage 2, 1, 3 */
 576        if (ce_stage(ce) == 1 && pos + 1 < istate->cache_nr &&
 577                        ce_stage((ce = istate->cache[pos + 1])) == 2 &&
 578                        !compare_name(ce, path, namelen))
 579                pos++;
 580        return pos;
 581}
 582
 583static int different_name(struct cache_entry *ce, struct cache_entry *alias)
 584{
 585        int len = ce_namelen(ce);
 586        return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
 587}
 588
 589/*
 590 * If we add a filename that aliases in the cache, we will use the
 591 * name that we already have - but we don't want to update the same
 592 * alias twice, because that implies that there were actually two
 593 * different files with aliasing names!
 594 *
 595 * So we use the CE_ADDED flag to verify that the alias was an old
 596 * one before we accept it as
 597 */
 598static struct cache_entry *create_alias_ce(struct index_state *istate,
 599                                           struct cache_entry *ce,
 600                                           struct cache_entry *alias)
 601{
 602        int len;
 603        struct cache_entry *new;
 604
 605        if (alias->ce_flags & CE_ADDED)
 606                die("Will not add file alias '%s' ('%s' already exists in index)", ce->name, alias->name);
 607
 608        /* Ok, create the new entry using the name of the existing alias */
 609        len = ce_namelen(alias);
 610        new = xcalloc(1, cache_entry_size(len));
 611        memcpy(new->name, alias->name, len);
 612        copy_cache_entry(new, ce);
 613        save_or_free_index_entry(istate, ce);
 614        return new;
 615}
 616
 617void set_object_name_for_intent_to_add_entry(struct cache_entry *ce)
 618{
 619        unsigned char sha1[20];
 620        if (write_sha1_file("", 0, blob_type, sha1))
 621                die("cannot create an empty blob in the object database");
 622        hashcpy(ce->sha1, sha1);
 623}
 624
 625int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
 626{
 627        int size, namelen, was_same;
 628        mode_t st_mode = st->st_mode;
 629        struct cache_entry *ce, *alias;
 630        unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
 631        int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
 632        int pretend = flags & ADD_CACHE_PRETEND;
 633        int intent_only = flags & ADD_CACHE_INTENT;
 634        int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
 635                          (intent_only ? ADD_CACHE_NEW_ONLY : 0));
 636
 637        if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
 638                return error("%s: can only add regular files, symbolic links or git-directories", path);
 639
 640        namelen = strlen(path);
 641        if (S_ISDIR(st_mode)) {
 642                while (namelen && path[namelen-1] == '/')
 643                        namelen--;
 644        }
 645        size = cache_entry_size(namelen);
 646        ce = xcalloc(1, size);
 647        memcpy(ce->name, path, namelen);
 648        ce->ce_namelen = namelen;
 649        if (!intent_only)
 650                fill_stat_cache_info(ce, st);
 651        else
 652                ce->ce_flags |= CE_INTENT_TO_ADD;
 653
 654        if (trust_executable_bit && has_symlinks)
 655                ce->ce_mode = create_ce_mode(st_mode);
 656        else {
 657                /* If there is an existing entry, pick the mode bits and type
 658                 * from it, otherwise assume unexecutable regular file.
 659                 */
 660                struct cache_entry *ent;
 661                int pos = index_name_pos_also_unmerged(istate, path, namelen);
 662
 663                ent = (0 <= pos) ? istate->cache[pos] : NULL;
 664                ce->ce_mode = ce_mode_from_stat(ent, st_mode);
 665        }
 666
 667        /* When core.ignorecase=true, determine if a directory of the same name but differing
 668         * case already exists within the Git repository.  If it does, ensure the directory
 669         * case of the file being added to the repository matches (is folded into) the existing
 670         * entry's directory case.
 671         */
 672        if (ignore_case) {
 673                const char *startPtr = ce->name;
 674                const char *ptr = startPtr;
 675                while (*ptr) {
 676                        while (*ptr && *ptr != '/')
 677                                ++ptr;
 678                        if (*ptr == '/') {
 679                                struct cache_entry *foundce;
 680                                ++ptr;
 681                                foundce = index_dir_exists(istate, ce->name, ptr - ce->name - 1);
 682                                if (foundce) {
 683                                        memcpy((void *)startPtr, foundce->name + (startPtr - ce->name), ptr - startPtr);
 684                                        startPtr = ptr;
 685                                }
 686                        }
 687                }
 688        }
 689
 690        alias = index_file_exists(istate, ce->name, ce_namelen(ce), ignore_case);
 691        if (alias && !ce_stage(alias) && !ie_match_stat(istate, alias, st, ce_option)) {
 692                /* Nothing changed, really */
 693                free(ce);
 694                if (!S_ISGITLINK(alias->ce_mode))
 695                        ce_mark_uptodate(alias);
 696                alias->ce_flags |= CE_ADDED;
 697                return 0;
 698        }
 699        if (!intent_only) {
 700                if (index_path(ce->sha1, path, st, HASH_WRITE_OBJECT))
 701                        return error("unable to index file %s", path);
 702        } else
 703                set_object_name_for_intent_to_add_entry(ce);
 704
 705        if (ignore_case && alias && different_name(ce, alias))
 706                ce = create_alias_ce(istate, ce, alias);
 707        ce->ce_flags |= CE_ADDED;
 708
 709        /* It was suspected to be racily clean, but it turns out to be Ok */
 710        was_same = (alias &&
 711                    !ce_stage(alias) &&
 712                    !hashcmp(alias->sha1, ce->sha1) &&
 713                    ce->ce_mode == alias->ce_mode);
 714
 715        if (pretend)
 716                ;
 717        else if (add_index_entry(istate, ce, add_option))
 718                return error("unable to add %s to index",path);
 719        if (verbose && !was_same)
 720                printf("add '%s'\n", path);
 721        return 0;
 722}
 723
 724int add_file_to_index(struct index_state *istate, const char *path, int flags)
 725{
 726        struct stat st;
 727        if (lstat(path, &st))
 728                die_errno("unable to stat '%s'", path);
 729        return add_to_index(istate, path, &st, flags);
 730}
 731
 732struct cache_entry *make_cache_entry(unsigned int mode,
 733                const unsigned char *sha1, const char *path, int stage,
 734                unsigned int refresh_options)
 735{
 736        int size, len;
 737        struct cache_entry *ce, *ret;
 738
 739        if (!verify_path(path)) {
 740                error("Invalid path '%s'", path);
 741                return NULL;
 742        }
 743
 744        len = strlen(path);
 745        size = cache_entry_size(len);
 746        ce = xcalloc(1, size);
 747
 748        hashcpy(ce->sha1, sha1);
 749        memcpy(ce->name, path, len);
 750        ce->ce_flags = create_ce_flags(stage);
 751        ce->ce_namelen = len;
 752        ce->ce_mode = create_ce_mode(mode);
 753
 754        ret = refresh_cache_entry(ce, refresh_options);
 755        if (!ret) {
 756                free(ce);
 757                return NULL;
 758        } else {
 759                return ret;
 760        }
 761}
 762
 763int ce_same_name(const struct cache_entry *a, const struct cache_entry *b)
 764{
 765        int len = ce_namelen(a);
 766        return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
 767}
 768
 769/*
 770 * We fundamentally don't like some paths: we don't want
 771 * dot or dot-dot anywhere, and for obvious reasons don't
 772 * want to recurse into ".git" either.
 773 *
 774 * Also, we don't want double slashes or slashes at the
 775 * end that can make pathnames ambiguous.
 776 */
 777static int verify_dotfile(const char *rest)
 778{
 779        /*
 780         * The first character was '.', but that
 781         * has already been discarded, we now test
 782         * the rest.
 783         */
 784
 785        /* "." is not allowed */
 786        if (*rest == '\0' || is_dir_sep(*rest))
 787                return 0;
 788
 789        switch (*rest) {
 790        /*
 791         * ".git" followed by  NUL or slash is bad. This
 792         * shares the path end test with the ".." case.
 793         */
 794        case 'g':
 795        case 'G':
 796                if (rest[1] != 'i' && rest[1] != 'I')
 797                        break;
 798                if (rest[2] != 't' && rest[2] != 'T')
 799                        break;
 800                rest += 2;
 801        /* fallthrough */
 802        case '.':
 803                if (rest[1] == '\0' || is_dir_sep(rest[1]))
 804                        return 0;
 805        }
 806        return 1;
 807}
 808
 809int verify_path(const char *path)
 810{
 811        char c;
 812
 813        if (has_dos_drive_prefix(path))
 814                return 0;
 815
 816        goto inside;
 817        for (;;) {
 818                if (!c)
 819                        return 1;
 820                if (is_dir_sep(c)) {
 821inside:
 822                        if (protect_hfs && is_hfs_dotgit(path))
 823                                return 0;
 824                        if (protect_ntfs && is_ntfs_dotgit(path))
 825                                return 0;
 826                        c = *path++;
 827                        if ((c == '.' && !verify_dotfile(path)) ||
 828                            is_dir_sep(c) || c == '\0')
 829                                return 0;
 830                }
 831                c = *path++;
 832        }
 833}
 834
 835/*
 836 * Do we have another file that has the beginning components being a
 837 * proper superset of the name we're trying to add?
 838 */
 839static int has_file_name(struct index_state *istate,
 840                         const struct cache_entry *ce, int pos, int ok_to_replace)
 841{
 842        int retval = 0;
 843        int len = ce_namelen(ce);
 844        int stage = ce_stage(ce);
 845        const char *name = ce->name;
 846
 847        while (pos < istate->cache_nr) {
 848                struct cache_entry *p = istate->cache[pos++];
 849
 850                if (len >= ce_namelen(p))
 851                        break;
 852                if (memcmp(name, p->name, len))
 853                        break;
 854                if (ce_stage(p) != stage)
 855                        continue;
 856                if (p->name[len] != '/')
 857                        continue;
 858                if (p->ce_flags & CE_REMOVE)
 859                        continue;
 860                retval = -1;
 861                if (!ok_to_replace)
 862                        break;
 863                remove_index_entry_at(istate, --pos);
 864        }
 865        return retval;
 866}
 867
 868/*
 869 * Do we have another file with a pathname that is a proper
 870 * subset of the name we're trying to add?
 871 */
 872static int has_dir_name(struct index_state *istate,
 873                        const struct cache_entry *ce, int pos, int ok_to_replace)
 874{
 875        int retval = 0;
 876        int stage = ce_stage(ce);
 877        const char *name = ce->name;
 878        const char *slash = name + ce_namelen(ce);
 879
 880        for (;;) {
 881                int len;
 882
 883                for (;;) {
 884                        if (*--slash == '/')
 885                                break;
 886                        if (slash <= ce->name)
 887                                return retval;
 888                }
 889                len = slash - name;
 890
 891                pos = index_name_stage_pos(istate, name, len, stage);
 892                if (pos >= 0) {
 893                        /*
 894                         * Found one, but not so fast.  This could
 895                         * be a marker that says "I was here, but
 896                         * I am being removed".  Such an entry is
 897                         * not a part of the resulting tree, and
 898                         * it is Ok to have a directory at the same
 899                         * path.
 900                         */
 901                        if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
 902                                retval = -1;
 903                                if (!ok_to_replace)
 904                                        break;
 905                                remove_index_entry_at(istate, pos);
 906                                continue;
 907                        }
 908                }
 909                else
 910                        pos = -pos-1;
 911
 912                /*
 913                 * Trivial optimization: if we find an entry that
 914                 * already matches the sub-directory, then we know
 915                 * we're ok, and we can exit.
 916                 */
 917                while (pos < istate->cache_nr) {
 918                        struct cache_entry *p = istate->cache[pos];
 919                        if ((ce_namelen(p) <= len) ||
 920                            (p->name[len] != '/') ||
 921                            memcmp(p->name, name, len))
 922                                break; /* not our subdirectory */
 923                        if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
 924                                /*
 925                                 * p is at the same stage as our entry, and
 926                                 * is a subdirectory of what we are looking
 927                                 * at, so we cannot have conflicts at our
 928                                 * level or anything shorter.
 929                                 */
 930                                return retval;
 931                        pos++;
 932                }
 933        }
 934        return retval;
 935}
 936
 937/* We may be in a situation where we already have path/file and path
 938 * is being added, or we already have path and path/file is being
 939 * added.  Either one would result in a nonsense tree that has path
 940 * twice when git-write-tree tries to write it out.  Prevent it.
 941 *
 942 * If ok-to-replace is specified, we remove the conflicting entries
 943 * from the cache so the caller should recompute the insert position.
 944 * When this happens, we return non-zero.
 945 */
 946static int check_file_directory_conflict(struct index_state *istate,
 947                                         const struct cache_entry *ce,
 948                                         int pos, int ok_to_replace)
 949{
 950        int retval;
 951
 952        /*
 953         * When ce is an "I am going away" entry, we allow it to be added
 954         */
 955        if (ce->ce_flags & CE_REMOVE)
 956                return 0;
 957
 958        /*
 959         * We check if the path is a sub-path of a subsequent pathname
 960         * first, since removing those will not change the position
 961         * in the array.
 962         */
 963        retval = has_file_name(istate, ce, pos, ok_to_replace);
 964
 965        /*
 966         * Then check if the path might have a clashing sub-directory
 967         * before it.
 968         */
 969        return retval + has_dir_name(istate, ce, pos, ok_to_replace);
 970}
 971
 972static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
 973{
 974        int pos;
 975        int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
 976        int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
 977        int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
 978        int new_only = option & ADD_CACHE_NEW_ONLY;
 979
 980        if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
 981                cache_tree_invalidate_path(istate, ce->name);
 982        pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
 983
 984        /* existing match? Just replace it. */
 985        if (pos >= 0) {
 986                if (!new_only)
 987                        replace_index_entry(istate, pos, ce);
 988                return 0;
 989        }
 990        pos = -pos-1;
 991
 992        untracked_cache_add_to_index(istate, ce->name);
 993
 994        /*
 995         * Inserting a merged entry ("stage 0") into the index
 996         * will always replace all non-merged entries..
 997         */
 998        if (pos < istate->cache_nr && ce_stage(ce) == 0) {
 999                while (ce_same_name(istate->cache[pos], ce)) {
1000                        ok_to_add = 1;
1001                        if (!remove_index_entry_at(istate, pos))
1002                                break;
1003                }
1004        }
1005
1006        if (!ok_to_add)
1007                return -1;
1008        if (!verify_path(ce->name))
1009                return error("Invalid path '%s'", ce->name);
1010
1011        if (!skip_df_check &&
1012            check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
1013                if (!ok_to_replace)
1014                        return error("'%s' appears as both a file and as a directory",
1015                                     ce->name);
1016                pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1017                pos = -pos-1;
1018        }
1019        return pos + 1;
1020}
1021
1022int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
1023{
1024        int pos;
1025
1026        if (option & ADD_CACHE_JUST_APPEND)
1027                pos = istate->cache_nr;
1028        else {
1029                int ret;
1030                ret = add_index_entry_with_check(istate, ce, option);
1031                if (ret <= 0)
1032                        return ret;
1033                pos = ret - 1;
1034        }
1035
1036        /* Make sure the array is big enough .. */
1037        ALLOC_GROW(istate->cache, istate->cache_nr + 1, istate->cache_alloc);
1038
1039        /* Add it in.. */
1040        istate->cache_nr++;
1041        if (istate->cache_nr > pos + 1)
1042                memmove(istate->cache + pos + 1,
1043                        istate->cache + pos,
1044                        (istate->cache_nr - pos - 1) * sizeof(ce));
1045        set_index_entry(istate, pos, ce);
1046        istate->cache_changed |= CE_ENTRY_ADDED;
1047        return 0;
1048}
1049
1050/*
1051 * "refresh" does not calculate a new sha1 file or bring the
1052 * cache up-to-date for mode/content changes. But what it
1053 * _does_ do is to "re-match" the stat information of a file
1054 * with the cache, so that you can refresh the cache for a
1055 * file that hasn't been changed but where the stat entry is
1056 * out of date.
1057 *
1058 * For example, you'd want to do this after doing a "git-read-tree",
1059 * to link up the stat cache details with the proper files.
1060 */
1061static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1062                                             struct cache_entry *ce,
1063                                             unsigned int options, int *err,
1064                                             int *changed_ret)
1065{
1066        struct stat st;
1067        struct cache_entry *updated;
1068        int changed, size;
1069        int refresh = options & CE_MATCH_REFRESH;
1070        int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1071        int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1072        int ignore_missing = options & CE_MATCH_IGNORE_MISSING;
1073
1074        if (!refresh || ce_uptodate(ce))
1075                return ce;
1076
1077        /*
1078         * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1079         * that the change to the work tree does not matter and told
1080         * us not to worry.
1081         */
1082        if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1083                ce_mark_uptodate(ce);
1084                return ce;
1085        }
1086        if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1087                ce_mark_uptodate(ce);
1088                return ce;
1089        }
1090
1091        if (has_symlink_leading_path(ce->name, ce_namelen(ce))) {
1092                if (ignore_missing)
1093                        return ce;
1094                if (err)
1095                        *err = ENOENT;
1096                return NULL;
1097        }
1098
1099        if (lstat(ce->name, &st) < 0) {
1100                if (ignore_missing && errno == ENOENT)
1101                        return ce;
1102                if (err)
1103                        *err = errno;
1104                return NULL;
1105        }
1106
1107        changed = ie_match_stat(istate, ce, &st, options);
1108        if (changed_ret)
1109                *changed_ret = changed;
1110        if (!changed) {
1111                /*
1112                 * The path is unchanged.  If we were told to ignore
1113                 * valid bit, then we did the actual stat check and
1114                 * found that the entry is unmodified.  If the entry
1115                 * is not marked VALID, this is the place to mark it
1116                 * valid again, under "assume unchanged" mode.
1117                 */
1118                if (ignore_valid && assume_unchanged &&
1119                    !(ce->ce_flags & CE_VALID))
1120                        ; /* mark this one VALID again */
1121                else {
1122                        /*
1123                         * We do not mark the index itself "modified"
1124                         * because CE_UPTODATE flag is in-core only;
1125                         * we are not going to write this change out.
1126                         */
1127                        if (!S_ISGITLINK(ce->ce_mode))
1128                                ce_mark_uptodate(ce);
1129                        return ce;
1130                }
1131        }
1132
1133        if (ie_modified(istate, ce, &st, options)) {
1134                if (err)
1135                        *err = EINVAL;
1136                return NULL;
1137        }
1138
1139        size = ce_size(ce);
1140        updated = xmalloc(size);
1141        memcpy(updated, ce, size);
1142        fill_stat_cache_info(updated, &st);
1143        /*
1144         * If ignore_valid is not set, we should leave CE_VALID bit
1145         * alone.  Otherwise, paths marked with --no-assume-unchanged
1146         * (i.e. things to be edited) will reacquire CE_VALID bit
1147         * automatically, which is not really what we want.
1148         */
1149        if (!ignore_valid && assume_unchanged &&
1150            !(ce->ce_flags & CE_VALID))
1151                updated->ce_flags &= ~CE_VALID;
1152
1153        /* istate->cache_changed is updated in the caller */
1154        return updated;
1155}
1156
1157static void show_file(const char * fmt, const char * name, int in_porcelain,
1158                      int * first, const char *header_msg)
1159{
1160        if (in_porcelain && *first && header_msg) {
1161                printf("%s\n", header_msg);
1162                *first = 0;
1163        }
1164        printf(fmt, name);
1165}
1166
1167int refresh_index(struct index_state *istate, unsigned int flags,
1168                  const struct pathspec *pathspec,
1169                  char *seen, const char *header_msg)
1170{
1171        int i;
1172        int has_errors = 0;
1173        int really = (flags & REFRESH_REALLY) != 0;
1174        int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1175        int quiet = (flags & REFRESH_QUIET) != 0;
1176        int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1177        int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1178        int first = 1;
1179        int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1180        unsigned int options = (CE_MATCH_REFRESH |
1181                                (really ? CE_MATCH_IGNORE_VALID : 0) |
1182                                (not_new ? CE_MATCH_IGNORE_MISSING : 0));
1183        const char *modified_fmt;
1184        const char *deleted_fmt;
1185        const char *typechange_fmt;
1186        const char *added_fmt;
1187        const char *unmerged_fmt;
1188
1189        modified_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1190        deleted_fmt = (in_porcelain ? "D\t%s\n" : "%s: needs update\n");
1191        typechange_fmt = (in_porcelain ? "T\t%s\n" : "%s needs update\n");
1192        added_fmt = (in_porcelain ? "A\t%s\n" : "%s needs update\n");
1193        unmerged_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1194        for (i = 0; i < istate->cache_nr; i++) {
1195                struct cache_entry *ce, *new;
1196                int cache_errno = 0;
1197                int changed = 0;
1198                int filtered = 0;
1199
1200                ce = istate->cache[i];
1201                if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1202                        continue;
1203
1204                if (pathspec && !ce_path_match(ce, pathspec, seen))
1205                        filtered = 1;
1206
1207                if (ce_stage(ce)) {
1208                        while ((i < istate->cache_nr) &&
1209                               ! strcmp(istate->cache[i]->name, ce->name))
1210                                i++;
1211                        i--;
1212                        if (allow_unmerged)
1213                                continue;
1214                        if (!filtered)
1215                                show_file(unmerged_fmt, ce->name, in_porcelain,
1216                                          &first, header_msg);
1217                        has_errors = 1;
1218                        continue;
1219                }
1220
1221                if (filtered)
1222                        continue;
1223
1224                new = refresh_cache_ent(istate, ce, options, &cache_errno, &changed);
1225                if (new == ce)
1226                        continue;
1227                if (!new) {
1228                        const char *fmt;
1229
1230                        if (really && cache_errno == EINVAL) {
1231                                /* If we are doing --really-refresh that
1232                                 * means the index is not valid anymore.
1233                                 */
1234                                ce->ce_flags &= ~CE_VALID;
1235                                ce->ce_flags |= CE_UPDATE_IN_BASE;
1236                                istate->cache_changed |= CE_ENTRY_CHANGED;
1237                        }
1238                        if (quiet)
1239                                continue;
1240
1241                        if (cache_errno == ENOENT)
1242                                fmt = deleted_fmt;
1243                        else if (ce->ce_flags & CE_INTENT_TO_ADD)
1244                                fmt = added_fmt; /* must be before other checks */
1245                        else if (changed & TYPE_CHANGED)
1246                                fmt = typechange_fmt;
1247                        else
1248                                fmt = modified_fmt;
1249                        show_file(fmt,
1250                                  ce->name, in_porcelain, &first, header_msg);
1251                        has_errors = 1;
1252                        continue;
1253                }
1254
1255                replace_index_entry(istate, i, new);
1256        }
1257        return has_errors;
1258}
1259
1260static struct cache_entry *refresh_cache_entry(struct cache_entry *ce,
1261                                               unsigned int options)
1262{
1263        return refresh_cache_ent(&the_index, ce, options, NULL, NULL);
1264}
1265
1266
1267/*****************************************************************
1268 * Index File I/O
1269 *****************************************************************/
1270
1271#define INDEX_FORMAT_DEFAULT 3
1272
1273static unsigned int get_index_format_default(void)
1274{
1275        char *envversion = getenv("GIT_INDEX_VERSION");
1276        char *endp;
1277        int value;
1278        unsigned int version = INDEX_FORMAT_DEFAULT;
1279
1280        if (!envversion) {
1281                if (!git_config_get_int("index.version", &value))
1282                        version = value;
1283                if (version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1284                        warning(_("index.version set, but the value is invalid.\n"
1285                                  "Using version %i"), INDEX_FORMAT_DEFAULT);
1286                        return INDEX_FORMAT_DEFAULT;
1287                }
1288                return version;
1289        }
1290
1291        version = strtoul(envversion, &endp, 10);
1292        if (*endp ||
1293            version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1294                warning(_("GIT_INDEX_VERSION set, but the value is invalid.\n"
1295                          "Using version %i"), INDEX_FORMAT_DEFAULT);
1296                version = INDEX_FORMAT_DEFAULT;
1297        }
1298        return version;
1299}
1300
1301/*
1302 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1303 * Again - this is just a (very strong in practice) heuristic that
1304 * the inode hasn't changed.
1305 *
1306 * We save the fields in big-endian order to allow using the
1307 * index file over NFS transparently.
1308 */
1309struct ondisk_cache_entry {
1310        struct cache_time ctime;
1311        struct cache_time mtime;
1312        uint32_t dev;
1313        uint32_t ino;
1314        uint32_t mode;
1315        uint32_t uid;
1316        uint32_t gid;
1317        uint32_t size;
1318        unsigned char sha1[20];
1319        uint16_t flags;
1320        char name[FLEX_ARRAY]; /* more */
1321};
1322
1323/*
1324 * This struct is used when CE_EXTENDED bit is 1
1325 * The struct must match ondisk_cache_entry exactly from
1326 * ctime till flags
1327 */
1328struct ondisk_cache_entry_extended {
1329        struct cache_time ctime;
1330        struct cache_time mtime;
1331        uint32_t dev;
1332        uint32_t ino;
1333        uint32_t mode;
1334        uint32_t uid;
1335        uint32_t gid;
1336        uint32_t size;
1337        unsigned char sha1[20];
1338        uint16_t flags;
1339        uint16_t flags2;
1340        char name[FLEX_ARRAY]; /* more */
1341};
1342
1343/* These are only used for v3 or lower */
1344#define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
1345#define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1346#define ondisk_cache_entry_extended_size(len) align_flex_name(ondisk_cache_entry_extended,len)
1347#define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
1348                            ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
1349                            ondisk_cache_entry_size(ce_namelen(ce)))
1350
1351static int verify_hdr(struct cache_header *hdr, unsigned long size)
1352{
1353        git_SHA_CTX c;
1354        unsigned char sha1[20];
1355        int hdr_version;
1356
1357        if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1358                return error("bad signature");
1359        hdr_version = ntohl(hdr->hdr_version);
1360        if (hdr_version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < hdr_version)
1361                return error("bad index version %d", hdr_version);
1362        git_SHA1_Init(&c);
1363        git_SHA1_Update(&c, hdr, size - 20);
1364        git_SHA1_Final(sha1, &c);
1365        if (hashcmp(sha1, (unsigned char *)hdr + size - 20))
1366                return error("bad index file sha1 signature");
1367        return 0;
1368}
1369
1370static int read_index_extension(struct index_state *istate,
1371                                const char *ext, void *data, unsigned long sz)
1372{
1373        switch (CACHE_EXT(ext)) {
1374        case CACHE_EXT_TREE:
1375                istate->cache_tree = cache_tree_read(data, sz);
1376                break;
1377        case CACHE_EXT_RESOLVE_UNDO:
1378                istate->resolve_undo = resolve_undo_read(data, sz);
1379                break;
1380        case CACHE_EXT_LINK:
1381                if (read_link_extension(istate, data, sz))
1382                        return -1;
1383                break;
1384        case CACHE_EXT_UNTRACKED:
1385                istate->untracked = read_untracked_extension(data, sz);
1386                break;
1387        default:
1388                if (*ext < 'A' || 'Z' < *ext)
1389                        return error("index uses %.4s extension, which we do not understand",
1390                                     ext);
1391                fprintf(stderr, "ignoring %.4s extension\n", ext);
1392                break;
1393        }
1394        return 0;
1395}
1396
1397int hold_locked_index(struct lock_file *lk, int die_on_error)
1398{
1399        return hold_lock_file_for_update(lk, get_index_file(),
1400                                         die_on_error
1401                                         ? LOCK_DIE_ON_ERROR
1402                                         : 0);
1403}
1404
1405int read_index(struct index_state *istate)
1406{
1407        return read_index_from(istate, get_index_file());
1408}
1409
1410static struct cache_entry *cache_entry_from_ondisk(struct ondisk_cache_entry *ondisk,
1411                                                   unsigned int flags,
1412                                                   const char *name,
1413                                                   size_t len)
1414{
1415        struct cache_entry *ce = xmalloc(cache_entry_size(len));
1416
1417        ce->ce_stat_data.sd_ctime.sec = get_be32(&ondisk->ctime.sec);
1418        ce->ce_stat_data.sd_mtime.sec = get_be32(&ondisk->mtime.sec);
1419        ce->ce_stat_data.sd_ctime.nsec = get_be32(&ondisk->ctime.nsec);
1420        ce->ce_stat_data.sd_mtime.nsec = get_be32(&ondisk->mtime.nsec);
1421        ce->ce_stat_data.sd_dev   = get_be32(&ondisk->dev);
1422        ce->ce_stat_data.sd_ino   = get_be32(&ondisk->ino);
1423        ce->ce_mode  = get_be32(&ondisk->mode);
1424        ce->ce_stat_data.sd_uid   = get_be32(&ondisk->uid);
1425        ce->ce_stat_data.sd_gid   = get_be32(&ondisk->gid);
1426        ce->ce_stat_data.sd_size  = get_be32(&ondisk->size);
1427        ce->ce_flags = flags & ~CE_NAMEMASK;
1428        ce->ce_namelen = len;
1429        ce->index = 0;
1430        hashcpy(ce->sha1, ondisk->sha1);
1431        memcpy(ce->name, name, len);
1432        ce->name[len] = '\0';
1433        return ce;
1434}
1435
1436/*
1437 * Adjacent cache entries tend to share the leading paths, so it makes
1438 * sense to only store the differences in later entries.  In the v4
1439 * on-disk format of the index, each on-disk cache entry stores the
1440 * number of bytes to be stripped from the end of the previous name,
1441 * and the bytes to append to the result, to come up with its name.
1442 */
1443static unsigned long expand_name_field(struct strbuf *name, const char *cp_)
1444{
1445        const unsigned char *ep, *cp = (const unsigned char *)cp_;
1446        size_t len = decode_varint(&cp);
1447
1448        if (name->len < len)
1449                die("malformed name field in the index");
1450        strbuf_remove(name, name->len - len, len);
1451        for (ep = cp; *ep; ep++)
1452                ; /* find the end */
1453        strbuf_add(name, cp, ep - cp);
1454        return (const char *)ep + 1 - cp_;
1455}
1456
1457static struct cache_entry *create_from_disk(struct ondisk_cache_entry *ondisk,
1458                                            unsigned long *ent_size,
1459                                            struct strbuf *previous_name)
1460{
1461        struct cache_entry *ce;
1462        size_t len;
1463        const char *name;
1464        unsigned int flags;
1465
1466        /* On-disk flags are just 16 bits */
1467        flags = get_be16(&ondisk->flags);
1468        len = flags & CE_NAMEMASK;
1469
1470        if (flags & CE_EXTENDED) {
1471                struct ondisk_cache_entry_extended *ondisk2;
1472                int extended_flags;
1473                ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1474                extended_flags = get_be16(&ondisk2->flags2) << 16;
1475                /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1476                if (extended_flags & ~CE_EXTENDED_FLAGS)
1477                        die("Unknown index entry format %08x", extended_flags);
1478                flags |= extended_flags;
1479                name = ondisk2->name;
1480        }
1481        else
1482                name = ondisk->name;
1483
1484        if (!previous_name) {
1485                /* v3 and earlier */
1486                if (len == CE_NAMEMASK)
1487                        len = strlen(name);
1488                ce = cache_entry_from_ondisk(ondisk, flags, name, len);
1489
1490                *ent_size = ondisk_ce_size(ce);
1491        } else {
1492                unsigned long consumed;
1493                consumed = expand_name_field(previous_name, name);
1494                ce = cache_entry_from_ondisk(ondisk, flags,
1495                                             previous_name->buf,
1496                                             previous_name->len);
1497
1498                *ent_size = (name - ((char *)ondisk)) + consumed;
1499        }
1500        return ce;
1501}
1502
1503static void check_ce_order(struct cache_entry *ce, struct cache_entry *next_ce)
1504{
1505        int name_compare = strcmp(ce->name, next_ce->name);
1506        if (0 < name_compare)
1507                die("unordered stage entries in index");
1508        if (!name_compare) {
1509                if (!ce_stage(ce))
1510                        die("multiple stage entries for merged file '%s'",
1511                                ce->name);
1512                if (ce_stage(ce) > ce_stage(next_ce))
1513                        die("unordered stage entries for '%s'",
1514                                ce->name);
1515        }
1516}
1517
1518/* remember to discard_cache() before reading a different cache! */
1519int do_read_index(struct index_state *istate, const char *path, int must_exist)
1520{
1521        int fd, i;
1522        struct stat st;
1523        unsigned long src_offset;
1524        struct cache_header *hdr;
1525        void *mmap;
1526        size_t mmap_size;
1527        struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
1528
1529        if (istate->initialized)
1530                return istate->cache_nr;
1531
1532        istate->timestamp.sec = 0;
1533        istate->timestamp.nsec = 0;
1534        fd = open(path, O_RDONLY);
1535        if (fd < 0) {
1536                if (!must_exist && errno == ENOENT)
1537                        return 0;
1538                die_errno("%s: index file open failed", path);
1539        }
1540
1541        if (fstat(fd, &st))
1542                die_errno("cannot stat the open index");
1543
1544        mmap_size = xsize_t(st.st_size);
1545        if (mmap_size < sizeof(struct cache_header) + 20)
1546                die("index file smaller than expected");
1547
1548        mmap = xmmap(NULL, mmap_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0);
1549        if (mmap == MAP_FAILED)
1550                die_errno("unable to map index file");
1551        close(fd);
1552
1553        hdr = mmap;
1554        if (verify_hdr(hdr, mmap_size) < 0)
1555                goto unmap;
1556
1557        hashcpy(istate->sha1, (const unsigned char *)hdr + mmap_size - 20);
1558        istate->version = ntohl(hdr->hdr_version);
1559        istate->cache_nr = ntohl(hdr->hdr_entries);
1560        istate->cache_alloc = alloc_nr(istate->cache_nr);
1561        istate->cache = xcalloc(istate->cache_alloc, sizeof(*istate->cache));
1562        istate->initialized = 1;
1563
1564        if (istate->version == 4)
1565                previous_name = &previous_name_buf;
1566        else
1567                previous_name = NULL;
1568
1569        src_offset = sizeof(*hdr);
1570        for (i = 0; i < istate->cache_nr; i++) {
1571                struct ondisk_cache_entry *disk_ce;
1572                struct cache_entry *ce;
1573                unsigned long consumed;
1574
1575                disk_ce = (struct ondisk_cache_entry *)((char *)mmap + src_offset);
1576                ce = create_from_disk(disk_ce, &consumed, previous_name);
1577                set_index_entry(istate, i, ce);
1578
1579                if (i > 0)
1580                        check_ce_order(istate->cache[i - 1], ce);
1581
1582                src_offset += consumed;
1583        }
1584        strbuf_release(&previous_name_buf);
1585        istate->timestamp.sec = st.st_mtime;
1586        istate->timestamp.nsec = ST_MTIME_NSEC(st);
1587
1588        while (src_offset <= mmap_size - 20 - 8) {
1589                /* After an array of active_nr index entries,
1590                 * there can be arbitrary number of extended
1591                 * sections, each of which is prefixed with
1592                 * extension name (4-byte) and section length
1593                 * in 4-byte network byte order.
1594                 */
1595                uint32_t extsize;
1596                memcpy(&extsize, (char *)mmap + src_offset + 4, 4);
1597                extsize = ntohl(extsize);
1598                if (read_index_extension(istate,
1599                                         (const char *) mmap + src_offset,
1600                                         (char *) mmap + src_offset + 8,
1601                                         extsize) < 0)
1602                        goto unmap;
1603                src_offset += 8;
1604                src_offset += extsize;
1605        }
1606        munmap(mmap, mmap_size);
1607        return istate->cache_nr;
1608
1609unmap:
1610        munmap(mmap, mmap_size);
1611        die("index file corrupt");
1612}
1613
1614int read_index_from(struct index_state *istate, const char *path)
1615{
1616        struct split_index *split_index;
1617        int ret;
1618
1619        /* istate->initialized covers both .git/index and .git/sharedindex.xxx */
1620        if (istate->initialized)
1621                return istate->cache_nr;
1622
1623        ret = do_read_index(istate, path, 0);
1624        split_index = istate->split_index;
1625        if (!split_index)
1626                return ret;
1627
1628        if (is_null_sha1(split_index->base_sha1))
1629                return ret;
1630
1631        if (split_index->base)
1632                discard_index(split_index->base);
1633        else
1634                split_index->base = xcalloc(1, sizeof(*split_index->base));
1635        ret = do_read_index(split_index->base,
1636                            git_path("sharedindex.%s",
1637                                     sha1_to_hex(split_index->base_sha1)), 1);
1638        if (hashcmp(split_index->base_sha1, split_index->base->sha1))
1639                die("broken index, expect %s in %s, got %s",
1640                    sha1_to_hex(split_index->base_sha1),
1641                    git_path("sharedindex.%s",
1642                                     sha1_to_hex(split_index->base_sha1)),
1643                    sha1_to_hex(split_index->base->sha1));
1644        merge_base_index(istate);
1645        return ret;
1646}
1647
1648int is_index_unborn(struct index_state *istate)
1649{
1650        return (!istate->cache_nr && !istate->timestamp.sec);
1651}
1652
1653int discard_index(struct index_state *istate)
1654{
1655        int i;
1656
1657        for (i = 0; i < istate->cache_nr; i++) {
1658                if (istate->cache[i]->index &&
1659                    istate->split_index &&
1660                    istate->split_index->base &&
1661                    istate->cache[i]->index <= istate->split_index->base->cache_nr &&
1662                    istate->cache[i] == istate->split_index->base->cache[istate->cache[i]->index - 1])
1663                        continue;
1664                free(istate->cache[i]);
1665        }
1666        resolve_undo_clear_index(istate);
1667        istate->cache_nr = 0;
1668        istate->cache_changed = 0;
1669        istate->timestamp.sec = 0;
1670        istate->timestamp.nsec = 0;
1671        free_name_hash(istate);
1672        cache_tree_free(&(istate->cache_tree));
1673        istate->initialized = 0;
1674        free(istate->cache);
1675        istate->cache = NULL;
1676        istate->cache_alloc = 0;
1677        discard_split_index(istate);
1678        free_untracked_cache(istate->untracked);
1679        istate->untracked = NULL;
1680        return 0;
1681}
1682
1683int unmerged_index(const struct index_state *istate)
1684{
1685        int i;
1686        for (i = 0; i < istate->cache_nr; i++) {
1687                if (ce_stage(istate->cache[i]))
1688                        return 1;
1689        }
1690        return 0;
1691}
1692
1693#define WRITE_BUFFER_SIZE 8192
1694static unsigned char write_buffer[WRITE_BUFFER_SIZE];
1695static unsigned long write_buffer_len;
1696
1697static int ce_write_flush(git_SHA_CTX *context, int fd)
1698{
1699        unsigned int buffered = write_buffer_len;
1700        if (buffered) {
1701                git_SHA1_Update(context, write_buffer, buffered);
1702                if (write_in_full(fd, write_buffer, buffered) != buffered)
1703                        return -1;
1704                write_buffer_len = 0;
1705        }
1706        return 0;
1707}
1708
1709static int ce_write(git_SHA_CTX *context, int fd, void *data, unsigned int len)
1710{
1711        while (len) {
1712                unsigned int buffered = write_buffer_len;
1713                unsigned int partial = WRITE_BUFFER_SIZE - buffered;
1714                if (partial > len)
1715                        partial = len;
1716                memcpy(write_buffer + buffered, data, partial);
1717                buffered += partial;
1718                if (buffered == WRITE_BUFFER_SIZE) {
1719                        write_buffer_len = buffered;
1720                        if (ce_write_flush(context, fd))
1721                                return -1;
1722                        buffered = 0;
1723                }
1724                write_buffer_len = buffered;
1725                len -= partial;
1726                data = (char *) data + partial;
1727        }
1728        return 0;
1729}
1730
1731static int write_index_ext_header(git_SHA_CTX *context, int fd,
1732                                  unsigned int ext, unsigned int sz)
1733{
1734        ext = htonl(ext);
1735        sz = htonl(sz);
1736        return ((ce_write(context, fd, &ext, 4) < 0) ||
1737                (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
1738}
1739
1740static int ce_flush(git_SHA_CTX *context, int fd, unsigned char *sha1)
1741{
1742        unsigned int left = write_buffer_len;
1743
1744        if (left) {
1745                write_buffer_len = 0;
1746                git_SHA1_Update(context, write_buffer, left);
1747        }
1748
1749        /* Flush first if not enough space for SHA1 signature */
1750        if (left + 20 > WRITE_BUFFER_SIZE) {
1751                if (write_in_full(fd, write_buffer, left) != left)
1752                        return -1;
1753                left = 0;
1754        }
1755
1756        /* Append the SHA1 signature at the end */
1757        git_SHA1_Final(write_buffer + left, context);
1758        hashcpy(sha1, write_buffer + left);
1759        left += 20;
1760        return (write_in_full(fd, write_buffer, left) != left) ? -1 : 0;
1761}
1762
1763static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
1764{
1765        /*
1766         * The only thing we care about in this function is to smudge the
1767         * falsely clean entry due to touch-update-touch race, so we leave
1768         * everything else as they are.  We are called for entries whose
1769         * ce_stat_data.sd_mtime match the index file mtime.
1770         *
1771         * Note that this actually does not do much for gitlinks, for
1772         * which ce_match_stat_basic() always goes to the actual
1773         * contents.  The caller checks with is_racy_timestamp() which
1774         * always says "no" for gitlinks, so we are not called for them ;-)
1775         */
1776        struct stat st;
1777
1778        if (lstat(ce->name, &st) < 0)
1779                return;
1780        if (ce_match_stat_basic(ce, &st))
1781                return;
1782        if (ce_modified_check_fs(ce, &st)) {
1783                /* This is "racily clean"; smudge it.  Note that this
1784                 * is a tricky code.  At first glance, it may appear
1785                 * that it can break with this sequence:
1786                 *
1787                 * $ echo xyzzy >frotz
1788                 * $ git-update-index --add frotz
1789                 * $ : >frotz
1790                 * $ sleep 3
1791                 * $ echo filfre >nitfol
1792                 * $ git-update-index --add nitfol
1793                 *
1794                 * but it does not.  When the second update-index runs,
1795                 * it notices that the entry "frotz" has the same timestamp
1796                 * as index, and if we were to smudge it by resetting its
1797                 * size to zero here, then the object name recorded
1798                 * in index is the 6-byte file but the cached stat information
1799                 * becomes zero --- which would then match what we would
1800                 * obtain from the filesystem next time we stat("frotz").
1801                 *
1802                 * However, the second update-index, before calling
1803                 * this function, notices that the cached size is 6
1804                 * bytes and what is on the filesystem is an empty
1805                 * file, and never calls us, so the cached size information
1806                 * for "frotz" stays 6 which does not match the filesystem.
1807                 */
1808                ce->ce_stat_data.sd_size = 0;
1809        }
1810}
1811
1812/* Copy miscellaneous fields but not the name */
1813static char *copy_cache_entry_to_ondisk(struct ondisk_cache_entry *ondisk,
1814                                       struct cache_entry *ce)
1815{
1816        short flags;
1817
1818        ondisk->ctime.sec = htonl(ce->ce_stat_data.sd_ctime.sec);
1819        ondisk->mtime.sec = htonl(ce->ce_stat_data.sd_mtime.sec);
1820        ondisk->ctime.nsec = htonl(ce->ce_stat_data.sd_ctime.nsec);
1821        ondisk->mtime.nsec = htonl(ce->ce_stat_data.sd_mtime.nsec);
1822        ondisk->dev  = htonl(ce->ce_stat_data.sd_dev);
1823        ondisk->ino  = htonl(ce->ce_stat_data.sd_ino);
1824        ondisk->mode = htonl(ce->ce_mode);
1825        ondisk->uid  = htonl(ce->ce_stat_data.sd_uid);
1826        ondisk->gid  = htonl(ce->ce_stat_data.sd_gid);
1827        ondisk->size = htonl(ce->ce_stat_data.sd_size);
1828        hashcpy(ondisk->sha1, ce->sha1);
1829
1830        flags = ce->ce_flags & ~CE_NAMEMASK;
1831        flags |= (ce_namelen(ce) >= CE_NAMEMASK ? CE_NAMEMASK : ce_namelen(ce));
1832        ondisk->flags = htons(flags);
1833        if (ce->ce_flags & CE_EXTENDED) {
1834                struct ondisk_cache_entry_extended *ondisk2;
1835                ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1836                ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
1837                return ondisk2->name;
1838        }
1839        else {
1840                return ondisk->name;
1841        }
1842}
1843
1844static int ce_write_entry(git_SHA_CTX *c, int fd, struct cache_entry *ce,
1845                          struct strbuf *previous_name)
1846{
1847        int size;
1848        struct ondisk_cache_entry *ondisk;
1849        int saved_namelen = saved_namelen; /* compiler workaround */
1850        char *name;
1851        int result;
1852
1853        if (ce->ce_flags & CE_STRIP_NAME) {
1854                saved_namelen = ce_namelen(ce);
1855                ce->ce_namelen = 0;
1856        }
1857
1858        if (!previous_name) {
1859                size = ondisk_ce_size(ce);
1860                ondisk = xcalloc(1, size);
1861                name = copy_cache_entry_to_ondisk(ondisk, ce);
1862                memcpy(name, ce->name, ce_namelen(ce));
1863        } else {
1864                int common, to_remove, prefix_size;
1865                unsigned char to_remove_vi[16];
1866                for (common = 0;
1867                     (ce->name[common] &&
1868                      common < previous_name->len &&
1869                      ce->name[common] == previous_name->buf[common]);
1870                     common++)
1871                        ; /* still matching */
1872                to_remove = previous_name->len - common;
1873                prefix_size = encode_varint(to_remove, to_remove_vi);
1874
1875                if (ce->ce_flags & CE_EXTENDED)
1876                        size = offsetof(struct ondisk_cache_entry_extended, name);
1877                else
1878                        size = offsetof(struct ondisk_cache_entry, name);
1879                size += prefix_size + (ce_namelen(ce) - common + 1);
1880
1881                ondisk = xcalloc(1, size);
1882                name = copy_cache_entry_to_ondisk(ondisk, ce);
1883                memcpy(name, to_remove_vi, prefix_size);
1884                memcpy(name + prefix_size, ce->name + common, ce_namelen(ce) - common);
1885
1886                strbuf_splice(previous_name, common, to_remove,
1887                              ce->name + common, ce_namelen(ce) - common);
1888        }
1889        if (ce->ce_flags & CE_STRIP_NAME) {
1890                ce->ce_namelen = saved_namelen;
1891                ce->ce_flags &= ~CE_STRIP_NAME;
1892        }
1893
1894        result = ce_write(c, fd, ondisk, size);
1895        free(ondisk);
1896        return result;
1897}
1898
1899/*
1900 * This function verifies if index_state has the correct sha1 of the
1901 * index file.  Don't die if we have any other failure, just return 0.
1902 */
1903static int verify_index_from(const struct index_state *istate, const char *path)
1904{
1905        int fd;
1906        ssize_t n;
1907        struct stat st;
1908        unsigned char sha1[20];
1909
1910        if (!istate->initialized)
1911                return 0;
1912
1913        fd = open(path, O_RDONLY);
1914        if (fd < 0)
1915                return 0;
1916
1917        if (fstat(fd, &st))
1918                goto out;
1919
1920        if (st.st_size < sizeof(struct cache_header) + 20)
1921                goto out;
1922
1923        n = pread_in_full(fd, sha1, 20, st.st_size - 20);
1924        if (n != 20)
1925                goto out;
1926
1927        if (hashcmp(istate->sha1, sha1))
1928                goto out;
1929
1930        close(fd);
1931        return 1;
1932
1933out:
1934        close(fd);
1935        return 0;
1936}
1937
1938static int verify_index(const struct index_state *istate)
1939{
1940        return verify_index_from(istate, get_index_file());
1941}
1942
1943static int has_racy_timestamp(struct index_state *istate)
1944{
1945        int entries = istate->cache_nr;
1946        int i;
1947
1948        for (i = 0; i < entries; i++) {
1949                struct cache_entry *ce = istate->cache[i];
1950                if (is_racy_timestamp(istate, ce))
1951                        return 1;
1952        }
1953        return 0;
1954}
1955
1956/*
1957 * Opportunistically update the index but do not complain if we can't
1958 */
1959void update_index_if_able(struct index_state *istate, struct lock_file *lockfile)
1960{
1961        if ((istate->cache_changed || has_racy_timestamp(istate)) &&
1962            verify_index(istate) &&
1963            write_locked_index(istate, lockfile, COMMIT_LOCK))
1964                rollback_lock_file(lockfile);
1965}
1966
1967static int do_write_index(struct index_state *istate, int newfd,
1968                          int strip_extensions)
1969{
1970        git_SHA_CTX c;
1971        struct cache_header hdr;
1972        int i, err, removed, extended, hdr_version;
1973        struct cache_entry **cache = istate->cache;
1974        int entries = istate->cache_nr;
1975        struct stat st;
1976        struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
1977
1978        for (i = removed = extended = 0; i < entries; i++) {
1979                if (cache[i]->ce_flags & CE_REMOVE)
1980                        removed++;
1981
1982                /* reduce extended entries if possible */
1983                cache[i]->ce_flags &= ~CE_EXTENDED;
1984                if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
1985                        extended++;
1986                        cache[i]->ce_flags |= CE_EXTENDED;
1987                }
1988        }
1989
1990        if (!istate->version) {
1991                istate->version = get_index_format_default();
1992                if (getenv("GIT_TEST_SPLIT_INDEX"))
1993                        init_split_index(istate);
1994        }
1995
1996        /* demote version 3 to version 2 when the latter suffices */
1997        if (istate->version == 3 || istate->version == 2)
1998                istate->version = extended ? 3 : 2;
1999
2000        hdr_version = istate->version;
2001
2002        hdr.hdr_signature = htonl(CACHE_SIGNATURE);
2003        hdr.hdr_version = htonl(hdr_version);
2004        hdr.hdr_entries = htonl(entries - removed);
2005
2006        git_SHA1_Init(&c);
2007        if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
2008                return -1;
2009
2010        previous_name = (hdr_version == 4) ? &previous_name_buf : NULL;
2011        for (i = 0; i < entries; i++) {
2012                struct cache_entry *ce = cache[i];
2013                if (ce->ce_flags & CE_REMOVE)
2014                        continue;
2015                if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
2016                        ce_smudge_racily_clean_entry(ce);
2017                if (is_null_sha1(ce->sha1)) {
2018                        static const char msg[] = "cache entry has null sha1: %s";
2019                        static int allow = -1;
2020
2021                        if (allow < 0)
2022                                allow = git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
2023                        if (allow)
2024                                warning(msg, ce->name);
2025                        else
2026                                return error(msg, ce->name);
2027                }
2028                if (ce_write_entry(&c, newfd, ce, previous_name) < 0)
2029                        return -1;
2030        }
2031        strbuf_release(&previous_name_buf);
2032
2033        /* Write extension data here */
2034        if (!strip_extensions && istate->split_index) {
2035                struct strbuf sb = STRBUF_INIT;
2036
2037                err = write_link_extension(&sb, istate) < 0 ||
2038                        write_index_ext_header(&c, newfd, CACHE_EXT_LINK,
2039                                               sb.len) < 0 ||
2040                        ce_write(&c, newfd, sb.buf, sb.len) < 0;
2041                strbuf_release(&sb);
2042                if (err)
2043                        return -1;
2044        }
2045        if (!strip_extensions && istate->cache_tree) {
2046                struct strbuf sb = STRBUF_INIT;
2047
2048                cache_tree_write(&sb, istate->cache_tree);
2049                err = write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sb.len) < 0
2050                        || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2051                strbuf_release(&sb);
2052                if (err)
2053                        return -1;
2054        }
2055        if (!strip_extensions && istate->resolve_undo) {
2056                struct strbuf sb = STRBUF_INIT;
2057
2058                resolve_undo_write(&sb, istate->resolve_undo);
2059                err = write_index_ext_header(&c, newfd, CACHE_EXT_RESOLVE_UNDO,
2060                                             sb.len) < 0
2061                        || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2062                strbuf_release(&sb);
2063                if (err)
2064                        return -1;
2065        }
2066        if (!strip_extensions && istate->untracked) {
2067                struct strbuf sb = STRBUF_INIT;
2068
2069                write_untracked_extension(&sb, istate->untracked);
2070                err = write_index_ext_header(&c, newfd, CACHE_EXT_UNTRACKED,
2071                                             sb.len) < 0 ||
2072                        ce_write(&c, newfd, sb.buf, sb.len) < 0;
2073                strbuf_release(&sb);
2074                if (err)
2075                        return -1;
2076        }
2077
2078        if (ce_flush(&c, newfd, istate->sha1) || fstat(newfd, &st))
2079                return -1;
2080        istate->timestamp.sec = (unsigned int)st.st_mtime;
2081        istate->timestamp.nsec = ST_MTIME_NSEC(st);
2082        return 0;
2083}
2084
2085void set_alternate_index_output(const char *name)
2086{
2087        alternate_index_output = name;
2088}
2089
2090static int commit_locked_index(struct lock_file *lk)
2091{
2092        if (alternate_index_output)
2093                return commit_lock_file_to(lk, alternate_index_output);
2094        else
2095                return commit_lock_file(lk);
2096}
2097
2098static int do_write_locked_index(struct index_state *istate, struct lock_file *lock,
2099                                 unsigned flags)
2100{
2101        int ret = do_write_index(istate, lock->fd, 0);
2102        if (ret)
2103                return ret;
2104        assert((flags & (COMMIT_LOCK | CLOSE_LOCK)) !=
2105               (COMMIT_LOCK | CLOSE_LOCK));
2106        if (flags & COMMIT_LOCK)
2107                return commit_locked_index(lock);
2108        else if (flags & CLOSE_LOCK)
2109                return close_lock_file(lock);
2110        else
2111                return ret;
2112}
2113
2114static int write_split_index(struct index_state *istate,
2115                             struct lock_file *lock,
2116                             unsigned flags)
2117{
2118        int ret;
2119        prepare_to_write_split_index(istate);
2120        ret = do_write_locked_index(istate, lock, flags);
2121        finish_writing_split_index(istate);
2122        return ret;
2123}
2124
2125static char *temporary_sharedindex;
2126
2127static void remove_temporary_sharedindex(void)
2128{
2129        if (temporary_sharedindex) {
2130                unlink_or_warn(temporary_sharedindex);
2131                free(temporary_sharedindex);
2132                temporary_sharedindex = NULL;
2133        }
2134}
2135
2136static void remove_temporary_sharedindex_on_signal(int signo)
2137{
2138        remove_temporary_sharedindex();
2139        sigchain_pop(signo);
2140        raise(signo);
2141}
2142
2143static int write_shared_index(struct index_state *istate,
2144                              struct lock_file *lock, unsigned flags)
2145{
2146        struct split_index *si = istate->split_index;
2147        static int installed_handler;
2148        int fd, ret;
2149
2150        temporary_sharedindex = git_pathdup("sharedindex_XXXXXX");
2151        fd = mkstemp(temporary_sharedindex);
2152        if (fd < 0) {
2153                free(temporary_sharedindex);
2154                temporary_sharedindex = NULL;
2155                hashclr(si->base_sha1);
2156                return do_write_locked_index(istate, lock, flags);
2157        }
2158        if (!installed_handler) {
2159                atexit(remove_temporary_sharedindex);
2160                sigchain_push_common(remove_temporary_sharedindex_on_signal);
2161        }
2162        move_cache_to_base_index(istate);
2163        ret = do_write_index(si->base, fd, 1);
2164        close(fd);
2165        if (ret) {
2166                remove_temporary_sharedindex();
2167                return ret;
2168        }
2169        ret = rename(temporary_sharedindex,
2170                     git_path("sharedindex.%s", sha1_to_hex(si->base->sha1)));
2171        free(temporary_sharedindex);
2172        temporary_sharedindex = NULL;
2173        if (!ret)
2174                hashcpy(si->base_sha1, si->base->sha1);
2175        return ret;
2176}
2177
2178int write_locked_index(struct index_state *istate, struct lock_file *lock,
2179                       unsigned flags)
2180{
2181        struct split_index *si = istate->split_index;
2182
2183        if (!si || alternate_index_output ||
2184            (istate->cache_changed & ~EXTMASK)) {
2185                if (si)
2186                        hashclr(si->base_sha1);
2187                return do_write_locked_index(istate, lock, flags);
2188        }
2189
2190        if (getenv("GIT_TEST_SPLIT_INDEX")) {
2191                int v = si->base_sha1[0];
2192                if ((v & 15) < 6)
2193                        istate->cache_changed |= SPLIT_INDEX_ORDERED;
2194        }
2195        if (istate->cache_changed & SPLIT_INDEX_ORDERED) {
2196                int ret = write_shared_index(istate, lock, flags);
2197                if (ret)
2198                        return ret;
2199        }
2200
2201        return write_split_index(istate, lock, flags);
2202}
2203
2204/*
2205 * Read the index file that is potentially unmerged into given
2206 * index_state, dropping any unmerged entries.  Returns true if
2207 * the index is unmerged.  Callers who want to refuse to work
2208 * from an unmerged state can call this and check its return value,
2209 * instead of calling read_cache().
2210 */
2211int read_index_unmerged(struct index_state *istate)
2212{
2213        int i;
2214        int unmerged = 0;
2215
2216        read_index(istate);
2217        for (i = 0; i < istate->cache_nr; i++) {
2218                struct cache_entry *ce = istate->cache[i];
2219                struct cache_entry *new_ce;
2220                int size, len;
2221
2222                if (!ce_stage(ce))
2223                        continue;
2224                unmerged = 1;
2225                len = ce_namelen(ce);
2226                size = cache_entry_size(len);
2227                new_ce = xcalloc(1, size);
2228                memcpy(new_ce->name, ce->name, len);
2229                new_ce->ce_flags = create_ce_flags(0) | CE_CONFLICTED;
2230                new_ce->ce_namelen = len;
2231                new_ce->ce_mode = ce->ce_mode;
2232                if (add_index_entry(istate, new_ce, 0))
2233                        return error("%s: cannot drop to stage #0",
2234                                     new_ce->name);
2235        }
2236        return unmerged;
2237}
2238
2239/*
2240 * Returns 1 if the path is an "other" path with respect to
2241 * the index; that is, the path is not mentioned in the index at all,
2242 * either as a file, a directory with some files in the index,
2243 * or as an unmerged entry.
2244 *
2245 * We helpfully remove a trailing "/" from directories so that
2246 * the output of read_directory can be used as-is.
2247 */
2248int index_name_is_other(const struct index_state *istate, const char *name,
2249                int namelen)
2250{
2251        int pos;
2252        if (namelen && name[namelen - 1] == '/')
2253                namelen--;
2254        pos = index_name_pos(istate, name, namelen);
2255        if (0 <= pos)
2256                return 0;       /* exact match */
2257        pos = -pos - 1;
2258        if (pos < istate->cache_nr) {
2259                struct cache_entry *ce = istate->cache[pos];
2260                if (ce_namelen(ce) == namelen &&
2261                    !memcmp(ce->name, name, namelen))
2262                        return 0; /* Yup, this one exists unmerged */
2263        }
2264        return 1;
2265}
2266
2267void *read_blob_data_from_index(struct index_state *istate, const char *path, unsigned long *size)
2268{
2269        int pos, len;
2270        unsigned long sz;
2271        enum object_type type;
2272        void *data;
2273
2274        len = strlen(path);
2275        pos = index_name_pos(istate, path, len);
2276        if (pos < 0) {
2277                /*
2278                 * We might be in the middle of a merge, in which
2279                 * case we would read stage #2 (ours).
2280                 */
2281                int i;
2282                for (i = -pos - 1;
2283                     (pos < 0 && i < istate->cache_nr &&
2284                      !strcmp(istate->cache[i]->name, path));
2285                     i++)
2286                        if (ce_stage(istate->cache[i]) == 2)
2287                                pos = i;
2288        }
2289        if (pos < 0)
2290                return NULL;
2291        data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
2292        if (!data || type != OBJ_BLOB) {
2293                free(data);
2294                return NULL;
2295        }
2296        if (size)
2297                *size = sz;
2298        return data;
2299}
2300
2301void stat_validity_clear(struct stat_validity *sv)
2302{
2303        free(sv->sd);
2304        sv->sd = NULL;
2305}
2306
2307int stat_validity_check(struct stat_validity *sv, const char *path)
2308{
2309        struct stat st;
2310
2311        if (stat(path, &st) < 0)
2312                return sv->sd == NULL;
2313        if (!sv->sd)
2314                return 0;
2315        return S_ISREG(st.st_mode) && !match_stat_data(sv->sd, &st);
2316}
2317
2318void stat_validity_update(struct stat_validity *sv, int fd)
2319{
2320        struct stat st;
2321
2322        if (fstat(fd, &st) < 0 || !S_ISREG(st.st_mode))
2323                stat_validity_clear(sv);
2324        else {
2325                if (!sv->sd)
2326                        sv->sd = xcalloc(1, sizeof(struct stat_data));
2327                fill_stat_data(sv->sd, &st);
2328        }
2329}