read-cache.c

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