Merge branch 'dd/time-reentrancy'
[git] / read-cache.c
1 /*
2  * GIT - The information manager from hell
3  *
4  * Copyright (C) Linus Torvalds, 2005
5  */
6 #include "cache.h"
7 #include "config.h"
8 #include "diff.h"
9 #include "diffcore.h"
10 #include "tempfile.h"
11 #include "lockfile.h"
12 #include "cache-tree.h"
13 #include "refs.h"
14 #include "dir.h"
15 #include "object-store.h"
16 #include "tree.h"
17 #include "commit.h"
18 #include "blob.h"
19 #include "resolve-undo.h"
20 #include "run-command.h"
21 #include "strbuf.h"
22 #include "varint.h"
23 #include "split-index.h"
24 #include "utf8.h"
25 #include "fsmonitor.h"
26 #include "thread-utils.h"
27 #include "progress.h"
28
29 /* Mask for the name length in ce_flags in the on-disk index */
30
31 #define CE_NAMEMASK  (0x0fff)
32
33 /* Index extensions.
34  *
35  * The first letter should be 'A'..'Z' for extensions that are not
36  * necessary for a correct operation (i.e. optimization data).
37  * When new extensions are added that _needs_ to be understood in
38  * order to correctly interpret the index file, pick character that
39  * is outside the range, to cause the reader to abort.
40  */
41
42 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
43 #define CACHE_EXT_TREE 0x54524545       /* "TREE" */
44 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
45 #define CACHE_EXT_LINK 0x6c696e6b         /* "link" */
46 #define CACHE_EXT_UNTRACKED 0x554E5452    /* "UNTR" */
47 #define CACHE_EXT_FSMONITOR 0x46534D4E    /* "FSMN" */
48 #define CACHE_EXT_ENDOFINDEXENTRIES 0x454F4945  /* "EOIE" */
49 #define CACHE_EXT_INDEXENTRYOFFSETTABLE 0x49454F54 /* "IEOT" */
50
51 /* changes that can be kept in $GIT_DIR/index (basically all extensions) */
52 #define EXTMASK (RESOLVE_UNDO_CHANGED | CACHE_TREE_CHANGED | \
53                  CE_ENTRY_ADDED | CE_ENTRY_REMOVED | CE_ENTRY_CHANGED | \
54                  SPLIT_INDEX_ORDERED | UNTRACKED_CHANGED | FSMONITOR_CHANGED)
55
56
57 /*
58  * This is an estimate of the pathname length in the index.  We use
59  * this for V4 index files to guess the un-deltafied size of the index
60  * in memory because of pathname deltafication.  This is not required
61  * for V2/V3 index formats because their pathnames are not compressed.
62  * If the initial amount of memory set aside is not sufficient, the
63  * mem pool will allocate extra memory.
64  */
65 #define CACHE_ENTRY_PATH_LENGTH 80
66
67 static inline struct cache_entry *mem_pool__ce_alloc(struct mem_pool *mem_pool, size_t len)
68 {
69         struct cache_entry *ce;
70         ce = mem_pool_alloc(mem_pool, cache_entry_size(len));
71         ce->mem_pool_allocated = 1;
72         return ce;
73 }
74
75 static inline struct cache_entry *mem_pool__ce_calloc(struct mem_pool *mem_pool, size_t len)
76 {
77         struct cache_entry * ce;
78         ce = mem_pool_calloc(mem_pool, 1, cache_entry_size(len));
79         ce->mem_pool_allocated = 1;
80         return ce;
81 }
82
83 static struct mem_pool *find_mem_pool(struct index_state *istate)
84 {
85         struct mem_pool **pool_ptr;
86
87         if (istate->split_index && istate->split_index->base)
88                 pool_ptr = &istate->split_index->base->ce_mem_pool;
89         else
90                 pool_ptr = &istate->ce_mem_pool;
91
92         if (!*pool_ptr)
93                 mem_pool_init(pool_ptr, 0);
94
95         return *pool_ptr;
96 }
97
98 static const char *alternate_index_output;
99
100 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
101 {
102         istate->cache[nr] = ce;
103         add_name_hash(istate, ce);
104 }
105
106 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
107 {
108         struct cache_entry *old = istate->cache[nr];
109
110         replace_index_entry_in_base(istate, old, ce);
111         remove_name_hash(istate, old);
112         discard_cache_entry(old);
113         ce->ce_flags &= ~CE_HASHED;
114         set_index_entry(istate, nr, ce);
115         ce->ce_flags |= CE_UPDATE_IN_BASE;
116         mark_fsmonitor_invalid(istate, ce);
117         istate->cache_changed |= CE_ENTRY_CHANGED;
118 }
119
120 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
121 {
122         struct cache_entry *old_entry = istate->cache[nr], *new_entry;
123         int namelen = strlen(new_name);
124
125         new_entry = make_empty_cache_entry(istate, namelen);
126         copy_cache_entry(new_entry, old_entry);
127         new_entry->ce_flags &= ~CE_HASHED;
128         new_entry->ce_namelen = namelen;
129         new_entry->index = 0;
130         memcpy(new_entry->name, new_name, namelen + 1);
131
132         cache_tree_invalidate_path(istate, old_entry->name);
133         untracked_cache_remove_from_index(istate, old_entry->name);
134         remove_index_entry_at(istate, nr);
135         add_index_entry(istate, new_entry, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
136 }
137
138 void fill_stat_data(struct stat_data *sd, struct stat *st)
139 {
140         sd->sd_ctime.sec = (unsigned int)st->st_ctime;
141         sd->sd_mtime.sec = (unsigned int)st->st_mtime;
142         sd->sd_ctime.nsec = ST_CTIME_NSEC(*st);
143         sd->sd_mtime.nsec = ST_MTIME_NSEC(*st);
144         sd->sd_dev = st->st_dev;
145         sd->sd_ino = st->st_ino;
146         sd->sd_uid = st->st_uid;
147         sd->sd_gid = st->st_gid;
148         sd->sd_size = st->st_size;
149 }
150
151 int match_stat_data(const struct stat_data *sd, struct stat *st)
152 {
153         int changed = 0;
154
155         if (sd->sd_mtime.sec != (unsigned int)st->st_mtime)
156                 changed |= MTIME_CHANGED;
157         if (trust_ctime && check_stat &&
158             sd->sd_ctime.sec != (unsigned int)st->st_ctime)
159                 changed |= CTIME_CHANGED;
160
161 #ifdef USE_NSEC
162         if (check_stat && sd->sd_mtime.nsec != ST_MTIME_NSEC(*st))
163                 changed |= MTIME_CHANGED;
164         if (trust_ctime && check_stat &&
165             sd->sd_ctime.nsec != ST_CTIME_NSEC(*st))
166                 changed |= CTIME_CHANGED;
167 #endif
168
169         if (check_stat) {
170                 if (sd->sd_uid != (unsigned int) st->st_uid ||
171                         sd->sd_gid != (unsigned int) st->st_gid)
172                         changed |= OWNER_CHANGED;
173                 if (sd->sd_ino != (unsigned int) st->st_ino)
174                         changed |= INODE_CHANGED;
175         }
176
177 #ifdef USE_STDEV
178         /*
179          * st_dev breaks on network filesystems where different
180          * clients will have different views of what "device"
181          * the filesystem is on
182          */
183         if (check_stat && sd->sd_dev != (unsigned int) st->st_dev)
184                         changed |= INODE_CHANGED;
185 #endif
186
187         if (sd->sd_size != (unsigned int) st->st_size)
188                 changed |= DATA_CHANGED;
189
190         return changed;
191 }
192
193 /*
194  * This only updates the "non-critical" parts of the directory
195  * cache, ie the parts that aren't tracked by GIT, and only used
196  * to validate the cache.
197  */
198 void fill_stat_cache_info(struct index_state *istate, struct cache_entry *ce, struct stat *st)
199 {
200         fill_stat_data(&ce->ce_stat_data, st);
201
202         if (assume_unchanged)
203                 ce->ce_flags |= CE_VALID;
204
205         if (S_ISREG(st->st_mode)) {
206                 ce_mark_uptodate(ce);
207                 mark_fsmonitor_valid(istate, ce);
208         }
209 }
210
211 static int ce_compare_data(struct index_state *istate,
212                            const struct cache_entry *ce,
213                            struct stat *st)
214 {
215         int match = -1;
216         int fd = git_open_cloexec(ce->name, O_RDONLY);
217
218         if (fd >= 0) {
219                 struct object_id oid;
220                 if (!index_fd(istate, &oid, fd, st, OBJ_BLOB, ce->name, 0))
221                         match = !oideq(&oid, &ce->oid);
222                 /* index_fd() closed the file descriptor already */
223         }
224         return match;
225 }
226
227 static int ce_compare_link(const struct cache_entry *ce, size_t expected_size)
228 {
229         int match = -1;
230         void *buffer;
231         unsigned long size;
232         enum object_type type;
233         struct strbuf sb = STRBUF_INIT;
234
235         if (strbuf_readlink(&sb, ce->name, expected_size))
236                 return -1;
237
238         buffer = read_object_file(&ce->oid, &type, &size);
239         if (buffer) {
240                 if (size == sb.len)
241                         match = memcmp(buffer, sb.buf, size);
242                 free(buffer);
243         }
244         strbuf_release(&sb);
245         return match;
246 }
247
248 static int ce_compare_gitlink(const struct cache_entry *ce)
249 {
250         struct object_id oid;
251
252         /*
253          * We don't actually require that the .git directory
254          * under GITLINK directory be a valid git directory. It
255          * might even be missing (in case nobody populated that
256          * sub-project).
257          *
258          * If so, we consider it always to match.
259          */
260         if (resolve_gitlink_ref(ce->name, "HEAD", &oid) < 0)
261                 return 0;
262         return !oideq(&oid, &ce->oid);
263 }
264
265 static int ce_modified_check_fs(struct index_state *istate,
266                                 const struct cache_entry *ce,
267                                 struct stat *st)
268 {
269         switch (st->st_mode & S_IFMT) {
270         case S_IFREG:
271                 if (ce_compare_data(istate, ce, st))
272                         return DATA_CHANGED;
273                 break;
274         case S_IFLNK:
275                 if (ce_compare_link(ce, xsize_t(st->st_size)))
276                         return DATA_CHANGED;
277                 break;
278         case S_IFDIR:
279                 if (S_ISGITLINK(ce->ce_mode))
280                         return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
281                 /* else fallthrough */
282         default:
283                 return TYPE_CHANGED;
284         }
285         return 0;
286 }
287
288 static int ce_match_stat_basic(const struct cache_entry *ce, struct stat *st)
289 {
290         unsigned int changed = 0;
291
292         if (ce->ce_flags & CE_REMOVE)
293                 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
294
295         switch (ce->ce_mode & S_IFMT) {
296         case S_IFREG:
297                 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
298                 /* We consider only the owner x bit to be relevant for
299                  * "mode changes"
300                  */
301                 if (trust_executable_bit &&
302                     (0100 & (ce->ce_mode ^ st->st_mode)))
303                         changed |= MODE_CHANGED;
304                 break;
305         case S_IFLNK:
306                 if (!S_ISLNK(st->st_mode) &&
307                     (has_symlinks || !S_ISREG(st->st_mode)))
308                         changed |= TYPE_CHANGED;
309                 break;
310         case S_IFGITLINK:
311                 /* We ignore most of the st_xxx fields for gitlinks */
312                 if (!S_ISDIR(st->st_mode))
313                         changed |= TYPE_CHANGED;
314                 else if (ce_compare_gitlink(ce))
315                         changed |= DATA_CHANGED;
316                 return changed;
317         default:
318                 BUG("unsupported ce_mode: %o", ce->ce_mode);
319         }
320
321         changed |= match_stat_data(&ce->ce_stat_data, st);
322
323         /* Racily smudged entry? */
324         if (!ce->ce_stat_data.sd_size) {
325                 if (!is_empty_blob_sha1(ce->oid.hash))
326                         changed |= DATA_CHANGED;
327         }
328
329         return changed;
330 }
331
332 static int is_racy_stat(const struct index_state *istate,
333                         const struct stat_data *sd)
334 {
335         return (istate->timestamp.sec &&
336 #ifdef USE_NSEC
337                  /* nanosecond timestamped files can also be racy! */
338                 (istate->timestamp.sec < sd->sd_mtime.sec ||
339                  (istate->timestamp.sec == sd->sd_mtime.sec &&
340                   istate->timestamp.nsec <= sd->sd_mtime.nsec))
341 #else
342                 istate->timestamp.sec <= sd->sd_mtime.sec
343 #endif
344                 );
345 }
346
347 int is_racy_timestamp(const struct index_state *istate,
348                              const struct cache_entry *ce)
349 {
350         return (!S_ISGITLINK(ce->ce_mode) &&
351                 is_racy_stat(istate, &ce->ce_stat_data));
352 }
353
354 int match_stat_data_racy(const struct index_state *istate,
355                          const struct stat_data *sd, struct stat *st)
356 {
357         if (is_racy_stat(istate, sd))
358                 return MTIME_CHANGED;
359         return match_stat_data(sd, st);
360 }
361
362 int ie_match_stat(struct index_state *istate,
363                   const struct cache_entry *ce, struct stat *st,
364                   unsigned int options)
365 {
366         unsigned int changed;
367         int ignore_valid = options & CE_MATCH_IGNORE_VALID;
368         int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
369         int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
370         int ignore_fsmonitor = options & CE_MATCH_IGNORE_FSMONITOR;
371
372         if (!ignore_fsmonitor)
373                 refresh_fsmonitor(istate);
374         /*
375          * If it's marked as always valid in the index, it's
376          * valid whatever the checked-out copy says.
377          *
378          * skip-worktree has the same effect with higher precedence
379          */
380         if (!ignore_skip_worktree && ce_skip_worktree(ce))
381                 return 0;
382         if (!ignore_valid && (ce->ce_flags & CE_VALID))
383                 return 0;
384         if (!ignore_fsmonitor && (ce->ce_flags & CE_FSMONITOR_VALID))
385                 return 0;
386
387         /*
388          * Intent-to-add entries have not been added, so the index entry
389          * by definition never matches what is in the work tree until it
390          * actually gets added.
391          */
392         if (ce_intent_to_add(ce))
393                 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
394
395         changed = ce_match_stat_basic(ce, st);
396
397         /*
398          * Within 1 second of this sequence:
399          *      echo xyzzy >file && git-update-index --add file
400          * running this command:
401          *      echo frotz >file
402          * would give a falsely clean cache entry.  The mtime and
403          * length match the cache, and other stat fields do not change.
404          *
405          * We could detect this at update-index time (the cache entry
406          * being registered/updated records the same time as "now")
407          * and delay the return from git-update-index, but that would
408          * effectively mean we can make at most one commit per second,
409          * which is not acceptable.  Instead, we check cache entries
410          * whose mtime are the same as the index file timestamp more
411          * carefully than others.
412          */
413         if (!changed && is_racy_timestamp(istate, ce)) {
414                 if (assume_racy_is_modified)
415                         changed |= DATA_CHANGED;
416                 else
417                         changed |= ce_modified_check_fs(istate, ce, st);
418         }
419
420         return changed;
421 }
422
423 int ie_modified(struct index_state *istate,
424                 const struct cache_entry *ce,
425                 struct stat *st, unsigned int options)
426 {
427         int changed, changed_fs;
428
429         changed = ie_match_stat(istate, ce, st, options);
430         if (!changed)
431                 return 0;
432         /*
433          * If the mode or type has changed, there's no point in trying
434          * to refresh the entry - it's not going to match
435          */
436         if (changed & (MODE_CHANGED | TYPE_CHANGED))
437                 return changed;
438
439         /*
440          * Immediately after read-tree or update-index --cacheinfo,
441          * the length field is zero, as we have never even read the
442          * lstat(2) information once, and we cannot trust DATA_CHANGED
443          * returned by ie_match_stat() which in turn was returned by
444          * ce_match_stat_basic() to signal that the filesize of the
445          * blob changed.  We have to actually go to the filesystem to
446          * see if the contents match, and if so, should answer "unchanged".
447          *
448          * The logic does not apply to gitlinks, as ce_match_stat_basic()
449          * already has checked the actual HEAD from the filesystem in the
450          * subproject.  If ie_match_stat() already said it is different,
451          * then we know it is.
452          */
453         if ((changed & DATA_CHANGED) &&
454             (S_ISGITLINK(ce->ce_mode) || ce->ce_stat_data.sd_size != 0))
455                 return changed;
456
457         changed_fs = ce_modified_check_fs(istate, ce, st);
458         if (changed_fs)
459                 return changed | changed_fs;
460         return 0;
461 }
462
463 int base_name_compare(const char *name1, int len1, int mode1,
464                       const char *name2, int len2, int mode2)
465 {
466         unsigned char c1, c2;
467         int len = len1 < len2 ? len1 : len2;
468         int cmp;
469
470         cmp = memcmp(name1, name2, len);
471         if (cmp)
472                 return cmp;
473         c1 = name1[len];
474         c2 = name2[len];
475         if (!c1 && S_ISDIR(mode1))
476                 c1 = '/';
477         if (!c2 && S_ISDIR(mode2))
478                 c2 = '/';
479         return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
480 }
481
482 /*
483  * df_name_compare() is identical to base_name_compare(), except it
484  * compares conflicting directory/file entries as equal. Note that
485  * while a directory name compares as equal to a regular file, they
486  * then individually compare _differently_ to a filename that has
487  * a dot after the basename (because '\0' < '.' < '/').
488  *
489  * This is used by routines that want to traverse the git namespace
490  * but then handle conflicting entries together when possible.
491  */
492 int df_name_compare(const char *name1, int len1, int mode1,
493                     const char *name2, int len2, int mode2)
494 {
495         int len = len1 < len2 ? len1 : len2, cmp;
496         unsigned char c1, c2;
497
498         cmp = memcmp(name1, name2, len);
499         if (cmp)
500                 return cmp;
501         /* Directories and files compare equal (same length, same name) */
502         if (len1 == len2)
503                 return 0;
504         c1 = name1[len];
505         if (!c1 && S_ISDIR(mode1))
506                 c1 = '/';
507         c2 = name2[len];
508         if (!c2 && S_ISDIR(mode2))
509                 c2 = '/';
510         if (c1 == '/' && !c2)
511                 return 0;
512         if (c2 == '/' && !c1)
513                 return 0;
514         return c1 - c2;
515 }
516
517 int name_compare(const char *name1, size_t len1, const char *name2, size_t len2)
518 {
519         size_t min_len = (len1 < len2) ? len1 : len2;
520         int cmp = memcmp(name1, name2, min_len);
521         if (cmp)
522                 return cmp;
523         if (len1 < len2)
524                 return -1;
525         if (len1 > len2)
526                 return 1;
527         return 0;
528 }
529
530 int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2)
531 {
532         int cmp;
533
534         cmp = name_compare(name1, len1, name2, len2);
535         if (cmp)
536                 return cmp;
537
538         if (stage1 < stage2)
539                 return -1;
540         if (stage1 > stage2)
541                 return 1;
542         return 0;
543 }
544
545 static int index_name_stage_pos(const struct index_state *istate, const char *name, int namelen, int stage)
546 {
547         int first, last;
548
549         first = 0;
550         last = istate->cache_nr;
551         while (last > first) {
552                 int next = first + ((last - first) >> 1);
553                 struct cache_entry *ce = istate->cache[next];
554                 int cmp = cache_name_stage_compare(name, namelen, stage, ce->name, ce_namelen(ce), ce_stage(ce));
555                 if (!cmp)
556                         return next;
557                 if (cmp < 0) {
558                         last = next;
559                         continue;
560                 }
561                 first = next+1;
562         }
563         return -first-1;
564 }
565
566 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
567 {
568         return index_name_stage_pos(istate, name, namelen, 0);
569 }
570
571 int remove_index_entry_at(struct index_state *istate, int pos)
572 {
573         struct cache_entry *ce = istate->cache[pos];
574
575         record_resolve_undo(istate, ce);
576         remove_name_hash(istate, ce);
577         save_or_free_index_entry(istate, ce);
578         istate->cache_changed |= CE_ENTRY_REMOVED;
579         istate->cache_nr--;
580         if (pos >= istate->cache_nr)
581                 return 0;
582         MOVE_ARRAY(istate->cache + pos, istate->cache + pos + 1,
583                    istate->cache_nr - pos);
584         return 1;
585 }
586
587 /*
588  * Remove all cache entries marked for removal, that is where
589  * CE_REMOVE is set in ce_flags.  This is much more effective than
590  * calling remove_index_entry_at() for each entry to be removed.
591  */
592 void remove_marked_cache_entries(struct index_state *istate, int invalidate)
593 {
594         struct cache_entry **ce_array = istate->cache;
595         unsigned int i, j;
596
597         for (i = j = 0; i < istate->cache_nr; i++) {
598                 if (ce_array[i]->ce_flags & CE_REMOVE) {
599                         if (invalidate) {
600                                 cache_tree_invalidate_path(istate,
601                                                            ce_array[i]->name);
602                                 untracked_cache_remove_from_index(istate,
603                                                                   ce_array[i]->name);
604                         }
605                         remove_name_hash(istate, ce_array[i]);
606                         save_or_free_index_entry(istate, ce_array[i]);
607                 }
608                 else
609                         ce_array[j++] = ce_array[i];
610         }
611         if (j == istate->cache_nr)
612                 return;
613         istate->cache_changed |= CE_ENTRY_REMOVED;
614         istate->cache_nr = j;
615 }
616
617 int remove_file_from_index(struct index_state *istate, const char *path)
618 {
619         int pos = index_name_pos(istate, path, strlen(path));
620         if (pos < 0)
621                 pos = -pos-1;
622         cache_tree_invalidate_path(istate, path);
623         untracked_cache_remove_from_index(istate, path);
624         while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
625                 remove_index_entry_at(istate, pos);
626         return 0;
627 }
628
629 static int compare_name(struct cache_entry *ce, const char *path, int namelen)
630 {
631         return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
632 }
633
634 static int index_name_pos_also_unmerged(struct index_state *istate,
635         const char *path, int namelen)
636 {
637         int pos = index_name_pos(istate, path, namelen);
638         struct cache_entry *ce;
639
640         if (pos >= 0)
641                 return pos;
642
643         /* maybe unmerged? */
644         pos = -1 - pos;
645         if (pos >= istate->cache_nr ||
646                         compare_name((ce = istate->cache[pos]), path, namelen))
647                 return -1;
648
649         /* order of preference: stage 2, 1, 3 */
650         if (ce_stage(ce) == 1 && pos + 1 < istate->cache_nr &&
651                         ce_stage((ce = istate->cache[pos + 1])) == 2 &&
652                         !compare_name(ce, path, namelen))
653                 pos++;
654         return pos;
655 }
656
657 static int different_name(struct cache_entry *ce, struct cache_entry *alias)
658 {
659         int len = ce_namelen(ce);
660         return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
661 }
662
663 /*
664  * If we add a filename that aliases in the cache, we will use the
665  * name that we already have - but we don't want to update the same
666  * alias twice, because that implies that there were actually two
667  * different files with aliasing names!
668  *
669  * So we use the CE_ADDED flag to verify that the alias was an old
670  * one before we accept it as
671  */
672 static struct cache_entry *create_alias_ce(struct index_state *istate,
673                                            struct cache_entry *ce,
674                                            struct cache_entry *alias)
675 {
676         int len;
677         struct cache_entry *new_entry;
678
679         if (alias->ce_flags & CE_ADDED)
680                 die(_("will not add file alias '%s' ('%s' already exists in index)"),
681                     ce->name, alias->name);
682
683         /* Ok, create the new entry using the name of the existing alias */
684         len = ce_namelen(alias);
685         new_entry = make_empty_cache_entry(istate, len);
686         memcpy(new_entry->name, alias->name, len);
687         copy_cache_entry(new_entry, ce);
688         save_or_free_index_entry(istate, ce);
689         return new_entry;
690 }
691
692 void set_object_name_for_intent_to_add_entry(struct cache_entry *ce)
693 {
694         struct object_id oid;
695         if (write_object_file("", 0, blob_type, &oid))
696                 die(_("cannot create an empty blob in the object database"));
697         oidcpy(&ce->oid, &oid);
698 }
699
700 int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
701 {
702         int namelen, was_same;
703         mode_t st_mode = st->st_mode;
704         struct cache_entry *ce, *alias = NULL;
705         unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
706         int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
707         int pretend = flags & ADD_CACHE_PRETEND;
708         int intent_only = flags & ADD_CACHE_INTENT;
709         int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
710                           (intent_only ? ADD_CACHE_NEW_ONLY : 0));
711         int hash_flags = HASH_WRITE_OBJECT;
712         struct object_id oid;
713
714         if (flags & ADD_CACHE_RENORMALIZE)
715                 hash_flags |= HASH_RENORMALIZE;
716
717         if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
718                 return error(_("%s: can only add regular files, symbolic links or git-directories"), path);
719
720         namelen = strlen(path);
721         if (S_ISDIR(st_mode)) {
722                 if (resolve_gitlink_ref(path, "HEAD", &oid) < 0)
723                         return error(_("'%s' does not have a commit checked out"), path);
724                 while (namelen && path[namelen-1] == '/')
725                         namelen--;
726         }
727         ce = make_empty_cache_entry(istate, namelen);
728         memcpy(ce->name, path, namelen);
729         ce->ce_namelen = namelen;
730         if (!intent_only)
731                 fill_stat_cache_info(istate, ce, st);
732         else
733                 ce->ce_flags |= CE_INTENT_TO_ADD;
734
735
736         if (trust_executable_bit && has_symlinks) {
737                 ce->ce_mode = create_ce_mode(st_mode);
738         } else {
739                 /* If there is an existing entry, pick the mode bits and type
740                  * from it, otherwise assume unexecutable regular file.
741                  */
742                 struct cache_entry *ent;
743                 int pos = index_name_pos_also_unmerged(istate, path, namelen);
744
745                 ent = (0 <= pos) ? istate->cache[pos] : NULL;
746                 ce->ce_mode = ce_mode_from_stat(ent, st_mode);
747         }
748
749         /* When core.ignorecase=true, determine if a directory of the same name but differing
750          * case already exists within the Git repository.  If it does, ensure the directory
751          * case of the file being added to the repository matches (is folded into) the existing
752          * entry's directory case.
753          */
754         if (ignore_case) {
755                 adjust_dirname_case(istate, ce->name);
756         }
757         if (!(flags & ADD_CACHE_RENORMALIZE)) {
758                 alias = index_file_exists(istate, ce->name,
759                                           ce_namelen(ce), ignore_case);
760                 if (alias &&
761                     !ce_stage(alias) &&
762                     !ie_match_stat(istate, alias, st, ce_option)) {
763                         /* Nothing changed, really */
764                         if (!S_ISGITLINK(alias->ce_mode))
765                                 ce_mark_uptodate(alias);
766                         alias->ce_flags |= CE_ADDED;
767
768                         discard_cache_entry(ce);
769                         return 0;
770                 }
771         }
772         if (!intent_only) {
773                 if (index_path(istate, &ce->oid, path, st, hash_flags)) {
774                         discard_cache_entry(ce);
775                         return error(_("unable to index file '%s'"), path);
776                 }
777         } else
778                 set_object_name_for_intent_to_add_entry(ce);
779
780         if (ignore_case && alias && different_name(ce, alias))
781                 ce = create_alias_ce(istate, ce, alias);
782         ce->ce_flags |= CE_ADDED;
783
784         /* It was suspected to be racily clean, but it turns out to be Ok */
785         was_same = (alias &&
786                     !ce_stage(alias) &&
787                     oideq(&alias->oid, &ce->oid) &&
788                     ce->ce_mode == alias->ce_mode);
789
790         if (pretend)
791                 discard_cache_entry(ce);
792         else if (add_index_entry(istate, ce, add_option)) {
793                 discard_cache_entry(ce);
794                 return error(_("unable to add '%s' to index"), path);
795         }
796         if (verbose && !was_same)
797                 printf("add '%s'\n", path);
798         return 0;
799 }
800
801 int add_file_to_index(struct index_state *istate, const char *path, int flags)
802 {
803         struct stat st;
804         if (lstat(path, &st))
805                 die_errno(_("unable to stat '%s'"), path);
806         return add_to_index(istate, path, &st, flags);
807 }
808
809 struct cache_entry *make_empty_cache_entry(struct index_state *istate, size_t len)
810 {
811         return mem_pool__ce_calloc(find_mem_pool(istate), len);
812 }
813
814 struct cache_entry *make_empty_transient_cache_entry(size_t len)
815 {
816         return xcalloc(1, cache_entry_size(len));
817 }
818
819 struct cache_entry *make_cache_entry(struct index_state *istate,
820                                      unsigned int mode,
821                                      const struct object_id *oid,
822                                      const char *path,
823                                      int stage,
824                                      unsigned int refresh_options)
825 {
826         struct cache_entry *ce, *ret;
827         int len;
828
829         if (!verify_path(path, mode)) {
830                 error(_("invalid path '%s'"), path);
831                 return NULL;
832         }
833
834         len = strlen(path);
835         ce = make_empty_cache_entry(istate, len);
836
837         oidcpy(&ce->oid, oid);
838         memcpy(ce->name, path, len);
839         ce->ce_flags = create_ce_flags(stage);
840         ce->ce_namelen = len;
841         ce->ce_mode = create_ce_mode(mode);
842
843         ret = refresh_cache_entry(istate, ce, refresh_options);
844         if (ret != ce)
845                 discard_cache_entry(ce);
846         return ret;
847 }
848
849 struct cache_entry *make_transient_cache_entry(unsigned int mode, const struct object_id *oid,
850                                                const char *path, int stage)
851 {
852         struct cache_entry *ce;
853         int len;
854
855         if (!verify_path(path, mode)) {
856                 error(_("invalid path '%s'"), path);
857                 return NULL;
858         }
859
860         len = strlen(path);
861         ce = make_empty_transient_cache_entry(len);
862
863         oidcpy(&ce->oid, oid);
864         memcpy(ce->name, path, len);
865         ce->ce_flags = create_ce_flags(stage);
866         ce->ce_namelen = len;
867         ce->ce_mode = create_ce_mode(mode);
868
869         return ce;
870 }
871
872 /*
873  * Chmod an index entry with either +x or -x.
874  *
875  * Returns -1 if the chmod for the particular cache entry failed (if it's
876  * not a regular file), -2 if an invalid flip argument is passed in, 0
877  * otherwise.
878  */
879 int chmod_index_entry(struct index_state *istate, struct cache_entry *ce,
880                       char flip)
881 {
882         if (!S_ISREG(ce->ce_mode))
883                 return -1;
884         switch (flip) {
885         case '+':
886                 ce->ce_mode |= 0111;
887                 break;
888         case '-':
889                 ce->ce_mode &= ~0111;
890                 break;
891         default:
892                 return -2;
893         }
894         cache_tree_invalidate_path(istate, ce->name);
895         ce->ce_flags |= CE_UPDATE_IN_BASE;
896         mark_fsmonitor_invalid(istate, ce);
897         istate->cache_changed |= CE_ENTRY_CHANGED;
898
899         return 0;
900 }
901
902 int ce_same_name(const struct cache_entry *a, const struct cache_entry *b)
903 {
904         int len = ce_namelen(a);
905         return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
906 }
907
908 /*
909  * We fundamentally don't like some paths: we don't want
910  * dot or dot-dot anywhere, and for obvious reasons don't
911  * want to recurse into ".git" either.
912  *
913  * Also, we don't want double slashes or slashes at the
914  * end that can make pathnames ambiguous.
915  */
916 static int verify_dotfile(const char *rest, unsigned mode)
917 {
918         /*
919          * The first character was '.', but that
920          * has already been discarded, we now test
921          * the rest.
922          */
923
924         /* "." is not allowed */
925         if (*rest == '\0' || is_dir_sep(*rest))
926                 return 0;
927
928         switch (*rest) {
929         /*
930          * ".git" followed by NUL or slash is bad. Note that we match
931          * case-insensitively here, even if ignore_case is not set.
932          * This outlaws ".GIT" everywhere out of an abundance of caution,
933          * since there's really no good reason to allow it.
934          *
935          * Once we've seen ".git", we can also find ".gitmodules", etc (also
936          * case-insensitively).
937          */
938         case 'g':
939         case 'G':
940                 if (rest[1] != 'i' && rest[1] != 'I')
941                         break;
942                 if (rest[2] != 't' && rest[2] != 'T')
943                         break;
944                 if (rest[3] == '\0' || is_dir_sep(rest[3]))
945                         return 0;
946                 if (S_ISLNK(mode)) {
947                         rest += 3;
948                         if (skip_iprefix(rest, "modules", &rest) &&
949                             (*rest == '\0' || is_dir_sep(*rest)))
950                                 return 0;
951                 }
952                 break;
953         case '.':
954                 if (rest[1] == '\0' || is_dir_sep(rest[1]))
955                         return 0;
956         }
957         return 1;
958 }
959
960 int verify_path(const char *path, unsigned mode)
961 {
962         char c;
963
964         if (has_dos_drive_prefix(path))
965                 return 0;
966
967         if (!is_valid_path(path))
968                 return 0;
969
970         goto inside;
971         for (;;) {
972                 if (!c)
973                         return 1;
974                 if (is_dir_sep(c)) {
975 inside:
976                         if (protect_hfs) {
977                                 if (is_hfs_dotgit(path))
978                                         return 0;
979                                 if (S_ISLNK(mode)) {
980                                         if (is_hfs_dotgitmodules(path))
981                                                 return 0;
982                                 }
983                         }
984                         if (protect_ntfs) {
985                                 if (is_ntfs_dotgit(path))
986                                         return 0;
987                                 if (S_ISLNK(mode)) {
988                                         if (is_ntfs_dotgitmodules(path))
989                                                 return 0;
990                                 }
991                         }
992
993                         c = *path++;
994                         if ((c == '.' && !verify_dotfile(path, mode)) ||
995                             is_dir_sep(c) || c == '\0')
996                                 return 0;
997                 } else if (c == '\\' && protect_ntfs) {
998                         if (is_ntfs_dotgit(path))
999                                 return 0;
1000                         if (S_ISLNK(mode)) {
1001                                 if (is_ntfs_dotgitmodules(path))
1002                                         return 0;
1003                         }
1004                 }
1005
1006                 c = *path++;
1007         }
1008 }
1009
1010 /*
1011  * Do we have another file that has the beginning components being a
1012  * proper superset of the name we're trying to add?
1013  */
1014 static int has_file_name(struct index_state *istate,
1015                          const struct cache_entry *ce, int pos, int ok_to_replace)
1016 {
1017         int retval = 0;
1018         int len = ce_namelen(ce);
1019         int stage = ce_stage(ce);
1020         const char *name = ce->name;
1021
1022         while (pos < istate->cache_nr) {
1023                 struct cache_entry *p = istate->cache[pos++];
1024
1025                 if (len >= ce_namelen(p))
1026                         break;
1027                 if (memcmp(name, p->name, len))
1028                         break;
1029                 if (ce_stage(p) != stage)
1030                         continue;
1031                 if (p->name[len] != '/')
1032                         continue;
1033                 if (p->ce_flags & CE_REMOVE)
1034                         continue;
1035                 retval = -1;
1036                 if (!ok_to_replace)
1037                         break;
1038                 remove_index_entry_at(istate, --pos);
1039         }
1040         return retval;
1041 }
1042
1043
1044 /*
1045  * Like strcmp(), but also return the offset of the first change.
1046  * If strings are equal, return the length.
1047  */
1048 int strcmp_offset(const char *s1, const char *s2, size_t *first_change)
1049 {
1050         size_t k;
1051
1052         if (!first_change)
1053                 return strcmp(s1, s2);
1054
1055         for (k = 0; s1[k] == s2[k]; k++)
1056                 if (s1[k] == '\0')
1057                         break;
1058
1059         *first_change = k;
1060         return (unsigned char)s1[k] - (unsigned char)s2[k];
1061 }
1062
1063 /*
1064  * Do we have another file with a pathname that is a proper
1065  * subset of the name we're trying to add?
1066  *
1067  * That is, is there another file in the index with a path
1068  * that matches a sub-directory in the given entry?
1069  */
1070 static int has_dir_name(struct index_state *istate,
1071                         const struct cache_entry *ce, int pos, int ok_to_replace)
1072 {
1073         int retval = 0;
1074         int stage = ce_stage(ce);
1075         const char *name = ce->name;
1076         const char *slash = name + ce_namelen(ce);
1077         size_t len_eq_last;
1078         int cmp_last = 0;
1079
1080         /*
1081          * We are frequently called during an iteration on a sorted
1082          * list of pathnames and while building a new index.  Therefore,
1083          * there is a high probability that this entry will eventually
1084          * be appended to the index, rather than inserted in the middle.
1085          * If we can confirm that, we can avoid binary searches on the
1086          * components of the pathname.
1087          *
1088          * Compare the entry's full path with the last path in the index.
1089          */
1090         if (istate->cache_nr > 0) {
1091                 cmp_last = strcmp_offset(name,
1092                         istate->cache[istate->cache_nr - 1]->name,
1093                         &len_eq_last);
1094                 if (cmp_last > 0) {
1095                         if (len_eq_last == 0) {
1096                                 /*
1097                                  * The entry sorts AFTER the last one in the
1098                                  * index and their paths have no common prefix,
1099                                  * so there cannot be a F/D conflict.
1100                                  */
1101                                 return retval;
1102                         } else {
1103                                 /*
1104                                  * The entry sorts AFTER the last one in the
1105                                  * index, but has a common prefix.  Fall through
1106                                  * to the loop below to disect the entry's path
1107                                  * and see where the difference is.
1108                                  */
1109                         }
1110                 } else if (cmp_last == 0) {
1111                         /*
1112                          * The entry exactly matches the last one in the
1113                          * index, but because of multiple stage and CE_REMOVE
1114                          * items, we fall through and let the regular search
1115                          * code handle it.
1116                          */
1117                 }
1118         }
1119
1120         for (;;) {
1121                 size_t len;
1122
1123                 for (;;) {
1124                         if (*--slash == '/')
1125                                 break;
1126                         if (slash <= ce->name)
1127                                 return retval;
1128                 }
1129                 len = slash - name;
1130
1131                 if (cmp_last > 0) {
1132                         /*
1133                          * (len + 1) is a directory boundary (including
1134                          * the trailing slash).  And since the loop is
1135                          * decrementing "slash", the first iteration is
1136                          * the longest directory prefix; subsequent
1137                          * iterations consider parent directories.
1138                          */
1139
1140                         if (len + 1 <= len_eq_last) {
1141                                 /*
1142                                  * The directory prefix (including the trailing
1143                                  * slash) also appears as a prefix in the last
1144                                  * entry, so the remainder cannot collide (because
1145                                  * strcmp said the whole path was greater).
1146                                  *
1147                                  * EQ: last: xxx/A
1148                                  *     this: xxx/B
1149                                  *
1150                                  * LT: last: xxx/file_A
1151                                  *     this: xxx/file_B
1152                                  */
1153                                 return retval;
1154                         }
1155
1156                         if (len > len_eq_last) {
1157                                 /*
1158                                  * This part of the directory prefix (excluding
1159                                  * the trailing slash) is longer than the known
1160                                  * equal portions, so this sub-directory cannot
1161                                  * collide with a file.
1162                                  *
1163                                  * GT: last: xxxA
1164                                  *     this: xxxB/file
1165                                  */
1166                                 return retval;
1167                         }
1168
1169                         if (istate->cache_nr > 0 &&
1170                                 ce_namelen(istate->cache[istate->cache_nr - 1]) > len) {
1171                                 /*
1172                                  * The directory prefix lines up with part of
1173                                  * a longer file or directory name, but sorts
1174                                  * after it, so this sub-directory cannot
1175                                  * collide with a file.
1176                                  *
1177                                  * last: xxx/yy-file (because '-' sorts before '/')
1178                                  * this: xxx/yy/abc
1179                                  */
1180                                 return retval;
1181                         }
1182
1183                         /*
1184                          * This is a possible collision. Fall through and
1185                          * let the regular search code handle it.
1186                          *
1187                          * last: xxx
1188                          * this: xxx/file
1189                          */
1190                 }
1191
1192                 pos = index_name_stage_pos(istate, name, len, stage);
1193                 if (pos >= 0) {
1194                         /*
1195                          * Found one, but not so fast.  This could
1196                          * be a marker that says "I was here, but
1197                          * I am being removed".  Such an entry is
1198                          * not a part of the resulting tree, and
1199                          * it is Ok to have a directory at the same
1200                          * path.
1201                          */
1202                         if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
1203                                 retval = -1;
1204                                 if (!ok_to_replace)
1205                                         break;
1206                                 remove_index_entry_at(istate, pos);
1207                                 continue;
1208                         }
1209                 }
1210                 else
1211                         pos = -pos-1;
1212
1213                 /*
1214                  * Trivial optimization: if we find an entry that
1215                  * already matches the sub-directory, then we know
1216                  * we're ok, and we can exit.
1217                  */
1218                 while (pos < istate->cache_nr) {
1219                         struct cache_entry *p = istate->cache[pos];
1220                         if ((ce_namelen(p) <= len) ||
1221                             (p->name[len] != '/') ||
1222                             memcmp(p->name, name, len))
1223                                 break; /* not our subdirectory */
1224                         if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
1225                                 /*
1226                                  * p is at the same stage as our entry, and
1227                                  * is a subdirectory of what we are looking
1228                                  * at, so we cannot have conflicts at our
1229                                  * level or anything shorter.
1230                                  */
1231                                 return retval;
1232                         pos++;
1233                 }
1234         }
1235         return retval;
1236 }
1237
1238 /* We may be in a situation where we already have path/file and path
1239  * is being added, or we already have path and path/file is being
1240  * added.  Either one would result in a nonsense tree that has path
1241  * twice when git-write-tree tries to write it out.  Prevent it.
1242  *
1243  * If ok-to-replace is specified, we remove the conflicting entries
1244  * from the cache so the caller should recompute the insert position.
1245  * When this happens, we return non-zero.
1246  */
1247 static int check_file_directory_conflict(struct index_state *istate,
1248                                          const struct cache_entry *ce,
1249                                          int pos, int ok_to_replace)
1250 {
1251         int retval;
1252
1253         /*
1254          * When ce is an "I am going away" entry, we allow it to be added
1255          */
1256         if (ce->ce_flags & CE_REMOVE)
1257                 return 0;
1258
1259         /*
1260          * We check if the path is a sub-path of a subsequent pathname
1261          * first, since removing those will not change the position
1262          * in the array.
1263          */
1264         retval = has_file_name(istate, ce, pos, ok_to_replace);
1265
1266         /*
1267          * Then check if the path might have a clashing sub-directory
1268          * before it.
1269          */
1270         return retval + has_dir_name(istate, ce, pos, ok_to_replace);
1271 }
1272
1273 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
1274 {
1275         int pos;
1276         int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
1277         int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
1278         int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
1279         int new_only = option & ADD_CACHE_NEW_ONLY;
1280
1281         if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1282                 cache_tree_invalidate_path(istate, ce->name);
1283
1284         /*
1285          * If this entry's path sorts after the last entry in the index,
1286          * we can avoid searching for it.
1287          */
1288         if (istate->cache_nr > 0 &&
1289                 strcmp(ce->name, istate->cache[istate->cache_nr - 1]->name) > 0)
1290                 pos = index_pos_to_insert_pos(istate->cache_nr);
1291         else
1292                 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1293
1294         /* existing match? Just replace it. */
1295         if (pos >= 0) {
1296                 if (!new_only)
1297                         replace_index_entry(istate, pos, ce);
1298                 return 0;
1299         }
1300         pos = -pos-1;
1301
1302         if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1303                 untracked_cache_add_to_index(istate, ce->name);
1304
1305         /*
1306          * Inserting a merged entry ("stage 0") into the index
1307          * will always replace all non-merged entries..
1308          */
1309         if (pos < istate->cache_nr && ce_stage(ce) == 0) {
1310                 while (ce_same_name(istate->cache[pos], ce)) {
1311                         ok_to_add = 1;
1312                         if (!remove_index_entry_at(istate, pos))
1313                                 break;
1314                 }
1315         }
1316
1317         if (!ok_to_add)
1318                 return -1;
1319         if (!verify_path(ce->name, ce->ce_mode))
1320                 return error(_("invalid path '%s'"), ce->name);
1321
1322         if (!skip_df_check &&
1323             check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
1324                 if (!ok_to_replace)
1325                         return error(_("'%s' appears as both a file and as a directory"),
1326                                      ce->name);
1327                 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1328                 pos = -pos-1;
1329         }
1330         return pos + 1;
1331 }
1332
1333 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
1334 {
1335         int pos;
1336
1337         if (option & ADD_CACHE_JUST_APPEND)
1338                 pos = istate->cache_nr;
1339         else {
1340                 int ret;
1341                 ret = add_index_entry_with_check(istate, ce, option);
1342                 if (ret <= 0)
1343                         return ret;
1344                 pos = ret - 1;
1345         }
1346
1347         /* Make sure the array is big enough .. */
1348         ALLOC_GROW(istate->cache, istate->cache_nr + 1, istate->cache_alloc);
1349
1350         /* Add it in.. */
1351         istate->cache_nr++;
1352         if (istate->cache_nr > pos + 1)
1353                 MOVE_ARRAY(istate->cache + pos + 1, istate->cache + pos,
1354                            istate->cache_nr - pos - 1);
1355         set_index_entry(istate, pos, ce);
1356         istate->cache_changed |= CE_ENTRY_ADDED;
1357         return 0;
1358 }
1359
1360 /*
1361  * "refresh" does not calculate a new sha1 file or bring the
1362  * cache up-to-date for mode/content changes. But what it
1363  * _does_ do is to "re-match" the stat information of a file
1364  * with the cache, so that you can refresh the cache for a
1365  * file that hasn't been changed but where the stat entry is
1366  * out of date.
1367  *
1368  * For example, you'd want to do this after doing a "git-read-tree",
1369  * to link up the stat cache details with the proper files.
1370  */
1371 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1372                                              struct cache_entry *ce,
1373                                              unsigned int options, int *err,
1374                                              int *changed_ret)
1375 {
1376         struct stat st;
1377         struct cache_entry *updated;
1378         int changed;
1379         int refresh = options & CE_MATCH_REFRESH;
1380         int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1381         int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1382         int ignore_missing = options & CE_MATCH_IGNORE_MISSING;
1383         int ignore_fsmonitor = options & CE_MATCH_IGNORE_FSMONITOR;
1384
1385         if (!refresh || ce_uptodate(ce))
1386                 return ce;
1387
1388         if (!ignore_fsmonitor)
1389                 refresh_fsmonitor(istate);
1390         /*
1391          * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1392          * that the change to the work tree does not matter and told
1393          * us not to worry.
1394          */
1395         if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1396                 ce_mark_uptodate(ce);
1397                 return ce;
1398         }
1399         if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1400                 ce_mark_uptodate(ce);
1401                 return ce;
1402         }
1403         if (!ignore_fsmonitor && (ce->ce_flags & CE_FSMONITOR_VALID)) {
1404                 ce_mark_uptodate(ce);
1405                 return ce;
1406         }
1407
1408         if (has_symlink_leading_path(ce->name, ce_namelen(ce))) {
1409                 if (ignore_missing)
1410                         return ce;
1411                 if (err)
1412                         *err = ENOENT;
1413                 return NULL;
1414         }
1415
1416         if (lstat(ce->name, &st) < 0) {
1417                 if (ignore_missing && errno == ENOENT)
1418                         return ce;
1419                 if (err)
1420                         *err = errno;
1421                 return NULL;
1422         }
1423
1424         changed = ie_match_stat(istate, ce, &st, options);
1425         if (changed_ret)
1426                 *changed_ret = changed;
1427         if (!changed) {
1428                 /*
1429                  * The path is unchanged.  If we were told to ignore
1430                  * valid bit, then we did the actual stat check and
1431                  * found that the entry is unmodified.  If the entry
1432                  * is not marked VALID, this is the place to mark it
1433                  * valid again, under "assume unchanged" mode.
1434                  */
1435                 if (ignore_valid && assume_unchanged &&
1436                     !(ce->ce_flags & CE_VALID))
1437                         ; /* mark this one VALID again */
1438                 else {
1439                         /*
1440                          * We do not mark the index itself "modified"
1441                          * because CE_UPTODATE flag is in-core only;
1442                          * we are not going to write this change out.
1443                          */
1444                         if (!S_ISGITLINK(ce->ce_mode)) {
1445                                 ce_mark_uptodate(ce);
1446                                 mark_fsmonitor_valid(istate, ce);
1447                         }
1448                         return ce;
1449                 }
1450         }
1451
1452         if (ie_modified(istate, ce, &st, options)) {
1453                 if (err)
1454                         *err = EINVAL;
1455                 return NULL;
1456         }
1457
1458         updated = make_empty_cache_entry(istate, ce_namelen(ce));
1459         copy_cache_entry(updated, ce);
1460         memcpy(updated->name, ce->name, ce->ce_namelen + 1);
1461         fill_stat_cache_info(istate, updated, &st);
1462         /*
1463          * If ignore_valid is not set, we should leave CE_VALID bit
1464          * alone.  Otherwise, paths marked with --no-assume-unchanged
1465          * (i.e. things to be edited) will reacquire CE_VALID bit
1466          * automatically, which is not really what we want.
1467          */
1468         if (!ignore_valid && assume_unchanged &&
1469             !(ce->ce_flags & CE_VALID))
1470                 updated->ce_flags &= ~CE_VALID;
1471
1472         /* istate->cache_changed is updated in the caller */
1473         return updated;
1474 }
1475
1476 static void show_file(const char * fmt, const char * name, int in_porcelain,
1477                       int * first, const char *header_msg)
1478 {
1479         if (in_porcelain && *first && header_msg) {
1480                 printf("%s\n", header_msg);
1481                 *first = 0;
1482         }
1483         printf(fmt, name);
1484 }
1485
1486 int repo_refresh_and_write_index(struct repository *repo,
1487                                  unsigned int refresh_flags,
1488                                  unsigned int write_flags,
1489                                  int gentle,
1490                                  const struct pathspec *pathspec,
1491                                  char *seen, const char *header_msg)
1492 {
1493         struct lock_file lock_file = LOCK_INIT;
1494         int fd, ret = 0;
1495
1496         fd = repo_hold_locked_index(repo, &lock_file, 0);
1497         if (!gentle && fd < 0)
1498                 return -1;
1499         if (refresh_index(repo->index, refresh_flags, pathspec, seen, header_msg))
1500                 ret = 1;
1501         if (0 <= fd && write_locked_index(repo->index, &lock_file, COMMIT_LOCK | write_flags))
1502                 ret = -1;
1503         return ret;
1504 }
1505
1506
1507 int refresh_index(struct index_state *istate, unsigned int flags,
1508                   const struct pathspec *pathspec,
1509                   char *seen, const char *header_msg)
1510 {
1511         int i;
1512         int has_errors = 0;
1513         int really = (flags & REFRESH_REALLY) != 0;
1514         int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1515         int quiet = (flags & REFRESH_QUIET) != 0;
1516         int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1517         int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1518         int first = 1;
1519         int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1520         unsigned int options = (CE_MATCH_REFRESH |
1521                                 (really ? CE_MATCH_IGNORE_VALID : 0) |
1522                                 (not_new ? CE_MATCH_IGNORE_MISSING : 0));
1523         const char *modified_fmt;
1524         const char *deleted_fmt;
1525         const char *typechange_fmt;
1526         const char *added_fmt;
1527         const char *unmerged_fmt;
1528         struct progress *progress = NULL;
1529
1530         if (flags & REFRESH_PROGRESS && isatty(2))
1531                 progress = start_delayed_progress(_("Refresh index"),
1532                                                   istate->cache_nr);
1533
1534         trace_performance_enter();
1535         modified_fmt   = in_porcelain ? "M\t%s\n" : "%s: needs update\n";
1536         deleted_fmt    = in_porcelain ? "D\t%s\n" : "%s: needs update\n";
1537         typechange_fmt = in_porcelain ? "T\t%s\n" : "%s: needs update\n";
1538         added_fmt      = in_porcelain ? "A\t%s\n" : "%s: needs update\n";
1539         unmerged_fmt   = in_porcelain ? "U\t%s\n" : "%s: needs merge\n";
1540         /*
1541          * Use the multi-threaded preload_index() to refresh most of the
1542          * cache entries quickly then in the single threaded loop below,
1543          * we only have to do the special cases that are left.
1544          */
1545         preload_index(istate, pathspec, 0);
1546         for (i = 0; i < istate->cache_nr; i++) {
1547                 struct cache_entry *ce, *new_entry;
1548                 int cache_errno = 0;
1549                 int changed = 0;
1550                 int filtered = 0;
1551
1552                 ce = istate->cache[i];
1553                 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1554                         continue;
1555
1556                 if (pathspec && !ce_path_match(istate, ce, pathspec, seen))
1557                         filtered = 1;
1558
1559                 if (ce_stage(ce)) {
1560                         while ((i < istate->cache_nr) &&
1561                                ! strcmp(istate->cache[i]->name, ce->name))
1562                                 i++;
1563                         i--;
1564                         if (allow_unmerged)
1565                                 continue;
1566                         if (!filtered)
1567                                 show_file(unmerged_fmt, ce->name, in_porcelain,
1568                                           &first, header_msg);
1569                         has_errors = 1;
1570                         continue;
1571                 }
1572
1573                 if (filtered)
1574                         continue;
1575
1576                 new_entry = refresh_cache_ent(istate, ce, options, &cache_errno, &changed);
1577                 if (new_entry == ce)
1578                         continue;
1579                 if (progress)
1580                         display_progress(progress, i);
1581                 if (!new_entry) {
1582                         const char *fmt;
1583
1584                         if (really && cache_errno == EINVAL) {
1585                                 /* If we are doing --really-refresh that
1586                                  * means the index is not valid anymore.
1587                                  */
1588                                 ce->ce_flags &= ~CE_VALID;
1589                                 ce->ce_flags |= CE_UPDATE_IN_BASE;
1590                                 mark_fsmonitor_invalid(istate, ce);
1591                                 istate->cache_changed |= CE_ENTRY_CHANGED;
1592                         }
1593                         if (quiet)
1594                                 continue;
1595
1596                         if (cache_errno == ENOENT)
1597                                 fmt = deleted_fmt;
1598                         else if (ce_intent_to_add(ce))
1599                                 fmt = added_fmt; /* must be before other checks */
1600                         else if (changed & TYPE_CHANGED)
1601                                 fmt = typechange_fmt;
1602                         else
1603                                 fmt = modified_fmt;
1604                         show_file(fmt,
1605                                   ce->name, in_porcelain, &first, header_msg);
1606                         has_errors = 1;
1607                         continue;
1608                 }
1609
1610                 replace_index_entry(istate, i, new_entry);
1611         }
1612         if (progress) {
1613                 display_progress(progress, istate->cache_nr);
1614                 stop_progress(&progress);
1615         }
1616         trace_performance_leave("refresh index");
1617         return has_errors;
1618 }
1619
1620 struct cache_entry *refresh_cache_entry(struct index_state *istate,
1621                                         struct cache_entry *ce,
1622                                         unsigned int options)
1623 {
1624         return refresh_cache_ent(istate, ce, options, NULL, NULL);
1625 }
1626
1627
1628 /*****************************************************************
1629  * Index File I/O
1630  *****************************************************************/
1631
1632 #define INDEX_FORMAT_DEFAULT 3
1633
1634 static unsigned int get_index_format_default(struct repository *r)
1635 {
1636         char *envversion = getenv("GIT_INDEX_VERSION");
1637         char *endp;
1638         unsigned int version = INDEX_FORMAT_DEFAULT;
1639
1640         if (!envversion) {
1641                 prepare_repo_settings(r);
1642
1643                 if (r->settings.index_version >= 0)
1644                         version = r->settings.index_version;
1645                 if (version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1646                         warning(_("index.version set, but the value is invalid.\n"
1647                                   "Using version %i"), INDEX_FORMAT_DEFAULT);
1648                         return INDEX_FORMAT_DEFAULT;
1649                 }
1650                 return version;
1651         }
1652
1653         version = strtoul(envversion, &endp, 10);
1654         if (*endp ||
1655             version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1656                 warning(_("GIT_INDEX_VERSION set, but the value is invalid.\n"
1657                           "Using version %i"), INDEX_FORMAT_DEFAULT);
1658                 version = INDEX_FORMAT_DEFAULT;
1659         }
1660         return version;
1661 }
1662
1663 /*
1664  * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1665  * Again - this is just a (very strong in practice) heuristic that
1666  * the inode hasn't changed.
1667  *
1668  * We save the fields in big-endian order to allow using the
1669  * index file over NFS transparently.
1670  */
1671 struct ondisk_cache_entry {
1672         struct cache_time ctime;
1673         struct cache_time mtime;
1674         uint32_t dev;
1675         uint32_t ino;
1676         uint32_t mode;
1677         uint32_t uid;
1678         uint32_t gid;
1679         uint32_t size;
1680         /*
1681          * unsigned char hash[hashsz];
1682          * uint16_t flags;
1683          * if (flags & CE_EXTENDED)
1684          *      uint16_t flags2;
1685          */
1686         unsigned char data[GIT_MAX_RAWSZ + 2 * sizeof(uint16_t)];
1687         char name[FLEX_ARRAY];
1688 };
1689
1690 /* These are only used for v3 or lower */
1691 #define align_padding_size(size, len) ((size + (len) + 8) & ~7) - (size + len)
1692 #define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,data) + (len) + 8) & ~7)
1693 #define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1694 #define ondisk_data_size(flags, len) (the_hash_algo->rawsz + \
1695                                      ((flags & CE_EXTENDED) ? 2 : 1) * sizeof(uint16_t) + len)
1696 #define ondisk_data_size_max(len) (ondisk_data_size(CE_EXTENDED, len))
1697 #define ondisk_ce_size(ce) (ondisk_cache_entry_size(ondisk_data_size((ce)->ce_flags, ce_namelen(ce))))
1698
1699 /* Allow fsck to force verification of the index checksum. */
1700 int verify_index_checksum;
1701
1702 /* Allow fsck to force verification of the cache entry order. */
1703 int verify_ce_order;
1704
1705 static int verify_hdr(const struct cache_header *hdr, unsigned long size)
1706 {
1707         git_hash_ctx c;
1708         unsigned char hash[GIT_MAX_RAWSZ];
1709         int hdr_version;
1710
1711         if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1712                 return error(_("bad signature 0x%08x"), hdr->hdr_signature);
1713         hdr_version = ntohl(hdr->hdr_version);
1714         if (hdr_version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < hdr_version)
1715                 return error(_("bad index version %d"), hdr_version);
1716
1717         if (!verify_index_checksum)
1718                 return 0;
1719
1720         the_hash_algo->init_fn(&c);
1721         the_hash_algo->update_fn(&c, hdr, size - the_hash_algo->rawsz);
1722         the_hash_algo->final_fn(hash, &c);
1723         if (!hasheq(hash, (unsigned char *)hdr + size - the_hash_algo->rawsz))
1724                 return error(_("bad index file sha1 signature"));
1725         return 0;
1726 }
1727
1728 static int read_index_extension(struct index_state *istate,
1729                                 const char *ext, const char *data, unsigned long sz)
1730 {
1731         switch (CACHE_EXT(ext)) {
1732         case CACHE_EXT_TREE:
1733                 istate->cache_tree = cache_tree_read(data, sz);
1734                 break;
1735         case CACHE_EXT_RESOLVE_UNDO:
1736                 istate->resolve_undo = resolve_undo_read(data, sz);
1737                 break;
1738         case CACHE_EXT_LINK:
1739                 if (read_link_extension(istate, data, sz))
1740                         return -1;
1741                 break;
1742         case CACHE_EXT_UNTRACKED:
1743                 istate->untracked = read_untracked_extension(data, sz);
1744                 break;
1745         case CACHE_EXT_FSMONITOR:
1746                 read_fsmonitor_extension(istate, data, sz);
1747                 break;
1748         case CACHE_EXT_ENDOFINDEXENTRIES:
1749         case CACHE_EXT_INDEXENTRYOFFSETTABLE:
1750                 /* already handled in do_read_index() */
1751                 break;
1752         default:
1753                 if (*ext < 'A' || 'Z' < *ext)
1754                         return error(_("index uses %.4s extension, which we do not understand"),
1755                                      ext);
1756                 fprintf_ln(stderr, _("ignoring %.4s extension"), ext);
1757                 break;
1758         }
1759         return 0;
1760 }
1761
1762 static struct cache_entry *create_from_disk(struct mem_pool *ce_mem_pool,
1763                                             unsigned int version,
1764                                             struct ondisk_cache_entry *ondisk,
1765                                             unsigned long *ent_size,
1766                                             const struct cache_entry *previous_ce)
1767 {
1768         struct cache_entry *ce;
1769         size_t len;
1770         const char *name;
1771         const unsigned hashsz = the_hash_algo->rawsz;
1772         const uint16_t *flagsp = (const uint16_t *)(ondisk->data + hashsz);
1773         unsigned int flags;
1774         size_t copy_len = 0;
1775         /*
1776          * Adjacent cache entries tend to share the leading paths, so it makes
1777          * sense to only store the differences in later entries.  In the v4
1778          * on-disk format of the index, each on-disk cache entry stores the
1779          * number of bytes to be stripped from the end of the previous name,
1780          * and the bytes to append to the result, to come up with its name.
1781          */
1782         int expand_name_field = version == 4;
1783
1784         /* On-disk flags are just 16 bits */
1785         flags = get_be16(flagsp);
1786         len = flags & CE_NAMEMASK;
1787
1788         if (flags & CE_EXTENDED) {
1789                 int extended_flags;
1790                 extended_flags = get_be16(flagsp + 1) << 16;
1791                 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1792                 if (extended_flags & ~CE_EXTENDED_FLAGS)
1793                         die(_("unknown index entry format 0x%08x"), extended_flags);
1794                 flags |= extended_flags;
1795                 name = (const char *)(flagsp + 2);
1796         }
1797         else
1798                 name = (const char *)(flagsp + 1);
1799
1800         if (expand_name_field) {
1801                 const unsigned char *cp = (const unsigned char *)name;
1802                 size_t strip_len, previous_len;
1803
1804                 /* If we're at the beginning of a block, ignore the previous name */
1805                 strip_len = decode_varint(&cp);
1806                 if (previous_ce) {
1807                         previous_len = previous_ce->ce_namelen;
1808                         if (previous_len < strip_len)
1809                                 die(_("malformed name field in the index, near path '%s'"),
1810                                         previous_ce->name);
1811                         copy_len = previous_len - strip_len;
1812                 }
1813                 name = (const char *)cp;
1814         }
1815
1816         if (len == CE_NAMEMASK) {
1817                 len = strlen(name);
1818                 if (expand_name_field)
1819                         len += copy_len;
1820         }
1821
1822         ce = mem_pool__ce_alloc(ce_mem_pool, len);
1823
1824         ce->ce_stat_data.sd_ctime.sec = get_be32(&ondisk->ctime.sec);
1825         ce->ce_stat_data.sd_mtime.sec = get_be32(&ondisk->mtime.sec);
1826         ce->ce_stat_data.sd_ctime.nsec = get_be32(&ondisk->ctime.nsec);
1827         ce->ce_stat_data.sd_mtime.nsec = get_be32(&ondisk->mtime.nsec);
1828         ce->ce_stat_data.sd_dev   = get_be32(&ondisk->dev);
1829         ce->ce_stat_data.sd_ino   = get_be32(&ondisk->ino);
1830         ce->ce_mode  = get_be32(&ondisk->mode);
1831         ce->ce_stat_data.sd_uid   = get_be32(&ondisk->uid);
1832         ce->ce_stat_data.sd_gid   = get_be32(&ondisk->gid);
1833         ce->ce_stat_data.sd_size  = get_be32(&ondisk->size);
1834         ce->ce_flags = flags & ~CE_NAMEMASK;
1835         ce->ce_namelen = len;
1836         ce->index = 0;
1837         hashcpy(ce->oid.hash, ondisk->data);
1838         memcpy(ce->name, name, len);
1839         ce->name[len] = '\0';
1840
1841         if (expand_name_field) {
1842                 if (copy_len)
1843                         memcpy(ce->name, previous_ce->name, copy_len);
1844                 memcpy(ce->name + copy_len, name, len + 1 - copy_len);
1845                 *ent_size = (name - ((char *)ondisk)) + len + 1 - copy_len;
1846         } else {
1847                 memcpy(ce->name, name, len + 1);
1848                 *ent_size = ondisk_ce_size(ce);
1849         }
1850         return ce;
1851 }
1852
1853 static void check_ce_order(struct index_state *istate)
1854 {
1855         unsigned int i;
1856
1857         if (!verify_ce_order)
1858                 return;
1859
1860         for (i = 1; i < istate->cache_nr; i++) {
1861                 struct cache_entry *ce = istate->cache[i - 1];
1862                 struct cache_entry *next_ce = istate->cache[i];
1863                 int name_compare = strcmp(ce->name, next_ce->name);
1864
1865                 if (0 < name_compare)
1866                         die(_("unordered stage entries in index"));
1867                 if (!name_compare) {
1868                         if (!ce_stage(ce))
1869                                 die(_("multiple stage entries for merged file '%s'"),
1870                                     ce->name);
1871                         if (ce_stage(ce) > ce_stage(next_ce))
1872                                 die(_("unordered stage entries for '%s'"),
1873                                     ce->name);
1874                 }
1875         }
1876 }
1877
1878 static void tweak_untracked_cache(struct index_state *istate)
1879 {
1880         struct repository *r = the_repository;
1881
1882         prepare_repo_settings(r);
1883
1884         if (r->settings.core_untracked_cache  == UNTRACKED_CACHE_REMOVE) {
1885                 remove_untracked_cache(istate);
1886                 return;
1887         }
1888
1889         if (r->settings.core_untracked_cache == UNTRACKED_CACHE_WRITE)
1890                 add_untracked_cache(istate);
1891 }
1892
1893 static void tweak_split_index(struct index_state *istate)
1894 {
1895         switch (git_config_get_split_index()) {
1896         case -1: /* unset: do nothing */
1897                 break;
1898         case 0: /* false */
1899                 remove_split_index(istate);
1900                 break;
1901         case 1: /* true */
1902                 add_split_index(istate);
1903                 break;
1904         default: /* unknown value: do nothing */
1905                 break;
1906         }
1907 }
1908
1909 static void post_read_index_from(struct index_state *istate)
1910 {
1911         check_ce_order(istate);
1912         tweak_untracked_cache(istate);
1913         tweak_split_index(istate);
1914         tweak_fsmonitor(istate);
1915 }
1916
1917 static size_t estimate_cache_size_from_compressed(unsigned int entries)
1918 {
1919         return entries * (sizeof(struct cache_entry) + CACHE_ENTRY_PATH_LENGTH);
1920 }
1921
1922 static size_t estimate_cache_size(size_t ondisk_size, unsigned int entries)
1923 {
1924         long per_entry = sizeof(struct cache_entry) - sizeof(struct ondisk_cache_entry);
1925
1926         /*
1927          * Account for potential alignment differences.
1928          */
1929         per_entry += align_padding_size(per_entry, 0);
1930         return ondisk_size + entries * per_entry;
1931 }
1932
1933 struct index_entry_offset
1934 {
1935         /* starting byte offset into index file, count of index entries in this block */
1936         int offset, nr;
1937 };
1938
1939 struct index_entry_offset_table
1940 {
1941         int nr;
1942         struct index_entry_offset entries[FLEX_ARRAY];
1943 };
1944
1945 static struct index_entry_offset_table *read_ieot_extension(const char *mmap, size_t mmap_size, size_t offset);
1946 static void write_ieot_extension(struct strbuf *sb, struct index_entry_offset_table *ieot);
1947
1948 static size_t read_eoie_extension(const char *mmap, size_t mmap_size);
1949 static void write_eoie_extension(struct strbuf *sb, git_hash_ctx *eoie_context, size_t offset);
1950
1951 struct load_index_extensions
1952 {
1953         pthread_t pthread;
1954         struct index_state *istate;
1955         const char *mmap;
1956         size_t mmap_size;
1957         unsigned long src_offset;
1958 };
1959
1960 static void *load_index_extensions(void *_data)
1961 {
1962         struct load_index_extensions *p = _data;
1963         unsigned long src_offset = p->src_offset;
1964
1965         while (src_offset <= p->mmap_size - the_hash_algo->rawsz - 8) {
1966                 /* After an array of active_nr index entries,
1967                  * there can be arbitrary number of extended
1968                  * sections, each of which is prefixed with
1969                  * extension name (4-byte) and section length
1970                  * in 4-byte network byte order.
1971                  */
1972                 uint32_t extsize = get_be32(p->mmap + src_offset + 4);
1973                 if (read_index_extension(p->istate,
1974                                          p->mmap + src_offset,
1975                                          p->mmap + src_offset + 8,
1976                                          extsize) < 0) {
1977                         munmap((void *)p->mmap, p->mmap_size);
1978                         die(_("index file corrupt"));
1979                 }
1980                 src_offset += 8;
1981                 src_offset += extsize;
1982         }
1983
1984         return NULL;
1985 }
1986
1987 /*
1988  * A helper function that will load the specified range of cache entries
1989  * from the memory mapped file and add them to the given index.
1990  */
1991 static unsigned long load_cache_entry_block(struct index_state *istate,
1992                         struct mem_pool *ce_mem_pool, int offset, int nr, const char *mmap,
1993                         unsigned long start_offset, const struct cache_entry *previous_ce)
1994 {
1995         int i;
1996         unsigned long src_offset = start_offset;
1997
1998         for (i = offset; i < offset + nr; i++) {
1999                 struct ondisk_cache_entry *disk_ce;
2000                 struct cache_entry *ce;
2001                 unsigned long consumed;
2002
2003                 disk_ce = (struct ondisk_cache_entry *)(mmap + src_offset);
2004                 ce = create_from_disk(ce_mem_pool, istate->version, disk_ce, &consumed, previous_ce);
2005                 set_index_entry(istate, i, ce);
2006
2007                 src_offset += consumed;
2008                 previous_ce = ce;
2009         }
2010         return src_offset - start_offset;
2011 }
2012
2013 static unsigned long load_all_cache_entries(struct index_state *istate,
2014                         const char *mmap, size_t mmap_size, unsigned long src_offset)
2015 {
2016         unsigned long consumed;
2017
2018         if (istate->version == 4) {
2019                 mem_pool_init(&istate->ce_mem_pool,
2020                                 estimate_cache_size_from_compressed(istate->cache_nr));
2021         } else {
2022                 mem_pool_init(&istate->ce_mem_pool,
2023                                 estimate_cache_size(mmap_size, istate->cache_nr));
2024         }
2025
2026         consumed = load_cache_entry_block(istate, istate->ce_mem_pool,
2027                                         0, istate->cache_nr, mmap, src_offset, NULL);
2028         return consumed;
2029 }
2030
2031 /*
2032  * Mostly randomly chosen maximum thread counts: we
2033  * cap the parallelism to online_cpus() threads, and we want
2034  * to have at least 10000 cache entries per thread for it to
2035  * be worth starting a thread.
2036  */
2037
2038 #define THREAD_COST             (10000)
2039
2040 struct load_cache_entries_thread_data
2041 {
2042         pthread_t pthread;
2043         struct index_state *istate;
2044         struct mem_pool *ce_mem_pool;
2045         int offset;
2046         const char *mmap;
2047         struct index_entry_offset_table *ieot;
2048         int ieot_start;         /* starting index into the ieot array */
2049         int ieot_blocks;        /* count of ieot entries to process */
2050         unsigned long consumed; /* return # of bytes in index file processed */
2051 };
2052
2053 /*
2054  * A thread proc to run the load_cache_entries() computation
2055  * across multiple background threads.
2056  */
2057 static void *load_cache_entries_thread(void *_data)
2058 {
2059         struct load_cache_entries_thread_data *p = _data;
2060         int i;
2061
2062         /* iterate across all ieot blocks assigned to this thread */
2063         for (i = p->ieot_start; i < p->ieot_start + p->ieot_blocks; i++) {
2064                 p->consumed += load_cache_entry_block(p->istate, p->ce_mem_pool,
2065                         p->offset, p->ieot->entries[i].nr, p->mmap, p->ieot->entries[i].offset, NULL);
2066                 p->offset += p->ieot->entries[i].nr;
2067         }
2068         return NULL;
2069 }
2070
2071 static unsigned long load_cache_entries_threaded(struct index_state *istate, const char *mmap, size_t mmap_size,
2072                                                  int nr_threads, struct index_entry_offset_table *ieot)
2073 {
2074         int i, offset, ieot_blocks, ieot_start, err;
2075         struct load_cache_entries_thread_data *data;
2076         unsigned long consumed = 0;
2077
2078         /* a little sanity checking */
2079         if (istate->name_hash_initialized)
2080                 BUG("the name hash isn't thread safe");
2081
2082         mem_pool_init(&istate->ce_mem_pool, 0);
2083
2084         /* ensure we have no more threads than we have blocks to process */
2085         if (nr_threads > ieot->nr)
2086                 nr_threads = ieot->nr;
2087         data = xcalloc(nr_threads, sizeof(*data));
2088
2089         offset = ieot_start = 0;
2090         ieot_blocks = DIV_ROUND_UP(ieot->nr, nr_threads);
2091         for (i = 0; i < nr_threads; i++) {
2092                 struct load_cache_entries_thread_data *p = &data[i];
2093                 int nr, j;
2094
2095                 if (ieot_start + ieot_blocks > ieot->nr)
2096                         ieot_blocks = ieot->nr - ieot_start;
2097
2098                 p->istate = istate;
2099                 p->offset = offset;
2100                 p->mmap = mmap;
2101                 p->ieot = ieot;
2102                 p->ieot_start = ieot_start;
2103                 p->ieot_blocks = ieot_blocks;
2104
2105                 /* create a mem_pool for each thread */
2106                 nr = 0;
2107                 for (j = p->ieot_start; j < p->ieot_start + p->ieot_blocks; j++)
2108                         nr += p->ieot->entries[j].nr;
2109                 if (istate->version == 4) {
2110                         mem_pool_init(&p->ce_mem_pool,
2111                                 estimate_cache_size_from_compressed(nr));
2112                 } else {
2113                         mem_pool_init(&p->ce_mem_pool,
2114                                 estimate_cache_size(mmap_size, nr));
2115                 }
2116
2117                 err = pthread_create(&p->pthread, NULL, load_cache_entries_thread, p);
2118                 if (err)
2119                         die(_("unable to create load_cache_entries thread: %s"), strerror(err));
2120
2121                 /* increment by the number of cache entries in the ieot block being processed */
2122                 for (j = 0; j < ieot_blocks; j++)
2123                         offset += ieot->entries[ieot_start + j].nr;
2124                 ieot_start += ieot_blocks;
2125         }
2126
2127         for (i = 0; i < nr_threads; i++) {
2128                 struct load_cache_entries_thread_data *p = &data[i];
2129
2130                 err = pthread_join(p->pthread, NULL);
2131                 if (err)
2132                         die(_("unable to join load_cache_entries thread: %s"), strerror(err));
2133                 mem_pool_combine(istate->ce_mem_pool, p->ce_mem_pool);
2134                 consumed += p->consumed;
2135         }
2136
2137         free(data);
2138
2139         return consumed;
2140 }
2141
2142 /* remember to discard_cache() before reading a different cache! */
2143 int do_read_index(struct index_state *istate, const char *path, int must_exist)
2144 {
2145         int fd;
2146         struct stat st;
2147         unsigned long src_offset;
2148         const struct cache_header *hdr;
2149         const char *mmap;
2150         size_t mmap_size;
2151         struct load_index_extensions p;
2152         size_t extension_offset = 0;
2153         int nr_threads, cpus;
2154         struct index_entry_offset_table *ieot = NULL;
2155
2156         if (istate->initialized)
2157                 return istate->cache_nr;
2158
2159         istate->timestamp.sec = 0;
2160         istate->timestamp.nsec = 0;
2161         fd = open(path, O_RDONLY);
2162         if (fd < 0) {
2163                 if (!must_exist && errno == ENOENT)
2164                         return 0;
2165                 die_errno(_("%s: index file open failed"), path);
2166         }
2167
2168         if (fstat(fd, &st))
2169                 die_errno(_("%s: cannot stat the open index"), path);
2170
2171         mmap_size = xsize_t(st.st_size);
2172         if (mmap_size < sizeof(struct cache_header) + the_hash_algo->rawsz)
2173                 die(_("%s: index file smaller than expected"), path);
2174
2175         mmap = xmmap_gently(NULL, mmap_size, PROT_READ, MAP_PRIVATE, fd, 0);
2176         if (mmap == MAP_FAILED)
2177                 die_errno(_("%s: unable to map index file"), path);
2178         close(fd);
2179
2180         hdr = (const struct cache_header *)mmap;
2181         if (verify_hdr(hdr, mmap_size) < 0)
2182                 goto unmap;
2183
2184         hashcpy(istate->oid.hash, (const unsigned char *)hdr + mmap_size - the_hash_algo->rawsz);
2185         istate->version = ntohl(hdr->hdr_version);
2186         istate->cache_nr = ntohl(hdr->hdr_entries);
2187         istate->cache_alloc = alloc_nr(istate->cache_nr);
2188         istate->cache = xcalloc(istate->cache_alloc, sizeof(*istate->cache));
2189         istate->initialized = 1;
2190
2191         p.istate = istate;
2192         p.mmap = mmap;
2193         p.mmap_size = mmap_size;
2194
2195         src_offset = sizeof(*hdr);
2196
2197         if (git_config_get_index_threads(&nr_threads))
2198                 nr_threads = 1;
2199
2200         /* TODO: does creating more threads than cores help? */
2201         if (!nr_threads) {
2202                 nr_threads = istate->cache_nr / THREAD_COST;
2203                 cpus = online_cpus();
2204                 if (nr_threads > cpus)
2205                         nr_threads = cpus;
2206         }
2207
2208         if (!HAVE_THREADS)
2209                 nr_threads = 1;
2210
2211         if (nr_threads > 1) {
2212                 extension_offset = read_eoie_extension(mmap, mmap_size);
2213                 if (extension_offset) {
2214                         int err;
2215
2216                         p.src_offset = extension_offset;
2217                         err = pthread_create(&p.pthread, NULL, load_index_extensions, &p);
2218                         if (err)
2219                                 die(_("unable to create load_index_extensions thread: %s"), strerror(err));
2220
2221                         nr_threads--;
2222                 }
2223         }
2224
2225         /*
2226          * Locate and read the index entry offset table so that we can use it
2227          * to multi-thread the reading of the cache entries.
2228          */
2229         if (extension_offset && nr_threads > 1)
2230                 ieot = read_ieot_extension(mmap, mmap_size, extension_offset);
2231
2232         if (ieot) {
2233                 src_offset += load_cache_entries_threaded(istate, mmap, mmap_size, nr_threads, ieot);
2234                 free(ieot);
2235         } else {
2236                 src_offset += load_all_cache_entries(istate, mmap, mmap_size, src_offset);
2237         }
2238
2239         istate->timestamp.sec = st.st_mtime;
2240         istate->timestamp.nsec = ST_MTIME_NSEC(st);
2241
2242         /* if we created a thread, join it otherwise load the extensions on the primary thread */
2243         if (extension_offset) {
2244                 int ret = pthread_join(p.pthread, NULL);
2245                 if (ret)
2246                         die(_("unable to join load_index_extensions thread: %s"), strerror(ret));
2247         } else {
2248                 p.src_offset = src_offset;
2249                 load_index_extensions(&p);
2250         }
2251         munmap((void *)mmap, mmap_size);
2252
2253         /*
2254          * TODO trace2: replace "the_repository" with the actual repo instance
2255          * that is associated with the given "istate".
2256          */
2257         trace2_data_intmax("index", the_repository, "read/version",
2258                            istate->version);
2259         trace2_data_intmax("index", the_repository, "read/cache_nr",
2260                            istate->cache_nr);
2261
2262         return istate->cache_nr;
2263
2264 unmap:
2265         munmap((void *)mmap, mmap_size);
2266         die(_("index file corrupt"));
2267 }
2268
2269 /*
2270  * Signal that the shared index is used by updating its mtime.
2271  *
2272  * This way, shared index can be removed if they have not been used
2273  * for some time.
2274  */
2275 static void freshen_shared_index(const char *shared_index, int warn)
2276 {
2277         if (!check_and_freshen_file(shared_index, 1) && warn)
2278                 warning(_("could not freshen shared index '%s'"), shared_index);
2279 }
2280
2281 int read_index_from(struct index_state *istate, const char *path,
2282                     const char *gitdir)
2283 {
2284         struct split_index *split_index;
2285         int ret;
2286         char *base_oid_hex;
2287         char *base_path;
2288
2289         /* istate->initialized covers both .git/index and .git/sharedindex.xxx */
2290         if (istate->initialized)
2291                 return istate->cache_nr;
2292
2293         /*
2294          * TODO trace2: replace "the_repository" with the actual repo instance
2295          * that is associated with the given "istate".
2296          */
2297         trace2_region_enter_printf("index", "do_read_index", the_repository,
2298                                    "%s", path);
2299         trace_performance_enter();
2300         ret = do_read_index(istate, path, 0);
2301         trace_performance_leave("read cache %s", path);
2302         trace2_region_leave_printf("index", "do_read_index", the_repository,
2303                                    "%s", path);
2304
2305         split_index = istate->split_index;
2306         if (!split_index || is_null_oid(&split_index->base_oid)) {
2307                 post_read_index_from(istate);
2308                 return ret;
2309         }
2310
2311         trace_performance_enter();
2312         if (split_index->base)
2313                 discard_index(split_index->base);
2314         else
2315                 split_index->base = xcalloc(1, sizeof(*split_index->base));
2316
2317         base_oid_hex = oid_to_hex(&split_index->base_oid);
2318         base_path = xstrfmt("%s/sharedindex.%s", gitdir, base_oid_hex);
2319         trace2_region_enter_printf("index", "shared/do_read_index",
2320                                    the_repository, "%s", base_path);
2321         ret = do_read_index(split_index->base, base_path, 1);
2322         trace2_region_leave_printf("index", "shared/do_read_index",
2323                                    the_repository, "%s", base_path);
2324         if (!oideq(&split_index->base_oid, &split_index->base->oid))
2325                 die(_("broken index, expect %s in %s, got %s"),
2326                     base_oid_hex, base_path,
2327                     oid_to_hex(&split_index->base->oid));
2328
2329         freshen_shared_index(base_path, 0);
2330         merge_base_index(istate);
2331         post_read_index_from(istate);
2332         trace_performance_leave("read cache %s", base_path);
2333         free(base_path);
2334         return ret;
2335 }
2336
2337 int is_index_unborn(struct index_state *istate)
2338 {
2339         return (!istate->cache_nr && !istate->timestamp.sec);
2340 }
2341
2342 int discard_index(struct index_state *istate)
2343 {
2344         /*
2345          * Cache entries in istate->cache[] should have been allocated
2346          * from the memory pool associated with this index, or from an
2347          * associated split_index. There is no need to free individual
2348          * cache entries. validate_cache_entries can detect when this
2349          * assertion does not hold.
2350          */
2351         validate_cache_entries(istate);
2352
2353         resolve_undo_clear_index(istate);
2354         istate->cache_nr = 0;
2355         istate->cache_changed = 0;
2356         istate->timestamp.sec = 0;
2357         istate->timestamp.nsec = 0;
2358         free_name_hash(istate);
2359         cache_tree_free(&(istate->cache_tree));
2360         istate->initialized = 0;
2361         istate->fsmonitor_has_run_once = 0;
2362         FREE_AND_NULL(istate->cache);
2363         istate->cache_alloc = 0;
2364         discard_split_index(istate);
2365         free_untracked_cache(istate->untracked);
2366         istate->untracked = NULL;
2367
2368         if (istate->ce_mem_pool) {
2369                 mem_pool_discard(istate->ce_mem_pool, should_validate_cache_entries());
2370                 istate->ce_mem_pool = NULL;
2371         }
2372
2373         return 0;
2374 }
2375
2376 /*
2377  * Validate the cache entries of this index.
2378  * All cache entries associated with this index
2379  * should have been allocated by the memory pool
2380  * associated with this index, or by a referenced
2381  * split index.
2382  */
2383 void validate_cache_entries(const struct index_state *istate)
2384 {
2385         int i;
2386
2387         if (!should_validate_cache_entries() ||!istate || !istate->initialized)
2388                 return;
2389
2390         for (i = 0; i < istate->cache_nr; i++) {
2391                 if (!istate) {
2392                         BUG("cache entry is not allocated from expected memory pool");
2393                 } else if (!istate->ce_mem_pool ||
2394                         !mem_pool_contains(istate->ce_mem_pool, istate->cache[i])) {
2395                         if (!istate->split_index ||
2396                                 !istate->split_index->base ||
2397                                 !istate->split_index->base->ce_mem_pool ||
2398                                 !mem_pool_contains(istate->split_index->base->ce_mem_pool, istate->cache[i])) {
2399                                 BUG("cache entry is not allocated from expected memory pool");
2400                         }
2401                 }
2402         }
2403
2404         if (istate->split_index)
2405                 validate_cache_entries(istate->split_index->base);
2406 }
2407
2408 int unmerged_index(const struct index_state *istate)
2409 {
2410         int i;
2411         for (i = 0; i < istate->cache_nr; i++) {
2412                 if (ce_stage(istate->cache[i]))
2413                         return 1;
2414         }
2415         return 0;
2416 }
2417
2418 int repo_index_has_changes(struct repository *repo,
2419                            struct tree *tree,
2420                            struct strbuf *sb)
2421 {
2422         struct index_state *istate = repo->index;
2423         struct object_id cmp;
2424         int i;
2425
2426         if (tree)
2427                 cmp = tree->object.oid;
2428         if (tree || !get_oid_tree("HEAD", &cmp)) {
2429                 struct diff_options opt;
2430
2431                 repo_diff_setup(repo, &opt);
2432                 opt.flags.exit_with_status = 1;
2433                 if (!sb)
2434                         opt.flags.quick = 1;
2435                 do_diff_cache(&cmp, &opt);
2436                 diffcore_std(&opt);
2437                 for (i = 0; sb && i < diff_queued_diff.nr; i++) {
2438                         if (i)
2439                                 strbuf_addch(sb, ' ');
2440                         strbuf_addstr(sb, diff_queued_diff.queue[i]->two->path);
2441                 }
2442                 diff_flush(&opt);
2443                 return opt.flags.has_changes != 0;
2444         } else {
2445                 for (i = 0; sb && i < istate->cache_nr; i++) {
2446                         if (i)
2447                                 strbuf_addch(sb, ' ');
2448                         strbuf_addstr(sb, istate->cache[i]->name);
2449                 }
2450                 return !!istate->cache_nr;
2451         }
2452 }
2453
2454 #define WRITE_BUFFER_SIZE 8192
2455 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
2456 static unsigned long write_buffer_len;
2457
2458 static int ce_write_flush(git_hash_ctx *context, int fd)
2459 {
2460         unsigned int buffered = write_buffer_len;
2461         if (buffered) {
2462                 the_hash_algo->update_fn(context, write_buffer, buffered);
2463                 if (write_in_full(fd, write_buffer, buffered) < 0)
2464                         return -1;
2465                 write_buffer_len = 0;
2466         }
2467         return 0;
2468 }
2469
2470 static int ce_write(git_hash_ctx *context, int fd, void *data, unsigned int len)
2471 {
2472         while (len) {
2473                 unsigned int buffered = write_buffer_len;
2474                 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
2475                 if (partial > len)
2476                         partial = len;
2477                 memcpy(write_buffer + buffered, data, partial);
2478                 buffered += partial;
2479                 if (buffered == WRITE_BUFFER_SIZE) {
2480                         write_buffer_len = buffered;
2481                         if (ce_write_flush(context, fd))
2482                                 return -1;
2483                         buffered = 0;
2484                 }
2485                 write_buffer_len = buffered;
2486                 len -= partial;
2487                 data = (char *) data + partial;
2488         }
2489         return 0;
2490 }
2491
2492 static int write_index_ext_header(git_hash_ctx *context, git_hash_ctx *eoie_context,
2493                                   int fd, unsigned int ext, unsigned int sz)
2494 {
2495         ext = htonl(ext);
2496         sz = htonl(sz);
2497         if (eoie_context) {
2498                 the_hash_algo->update_fn(eoie_context, &ext, 4);
2499                 the_hash_algo->update_fn(eoie_context, &sz, 4);
2500         }
2501         return ((ce_write(context, fd, &ext, 4) < 0) ||
2502                 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
2503 }
2504
2505 static int ce_flush(git_hash_ctx *context, int fd, unsigned char *hash)
2506 {
2507         unsigned int left = write_buffer_len;
2508
2509         if (left) {
2510                 write_buffer_len = 0;
2511                 the_hash_algo->update_fn(context, write_buffer, left);
2512         }
2513
2514         /* Flush first if not enough space for hash signature */
2515         if (left + the_hash_algo->rawsz > WRITE_BUFFER_SIZE) {
2516                 if (write_in_full(fd, write_buffer, left) < 0)
2517                         return -1;
2518                 left = 0;
2519         }
2520
2521         /* Append the hash signature at the end */
2522         the_hash_algo->final_fn(write_buffer + left, context);
2523         hashcpy(hash, write_buffer + left);
2524         left += the_hash_algo->rawsz;
2525         return (write_in_full(fd, write_buffer, left) < 0) ? -1 : 0;
2526 }
2527
2528 static void ce_smudge_racily_clean_entry(struct index_state *istate,
2529                                          struct cache_entry *ce)
2530 {
2531         /*
2532          * The only thing we care about in this function is to smudge the
2533          * falsely clean entry due to touch-update-touch race, so we leave
2534          * everything else as they are.  We are called for entries whose
2535          * ce_stat_data.sd_mtime match the index file mtime.
2536          *
2537          * Note that this actually does not do much for gitlinks, for
2538          * which ce_match_stat_basic() always goes to the actual
2539          * contents.  The caller checks with is_racy_timestamp() which
2540          * always says "no" for gitlinks, so we are not called for them ;-)
2541          */
2542         struct stat st;
2543
2544         if (lstat(ce->name, &st) < 0)
2545                 return;
2546         if (ce_match_stat_basic(ce, &st))
2547                 return;
2548         if (ce_modified_check_fs(istate, ce, &st)) {
2549                 /* This is "racily clean"; smudge it.  Note that this
2550                  * is a tricky code.  At first glance, it may appear
2551                  * that it can break with this sequence:
2552                  *
2553                  * $ echo xyzzy >frotz
2554                  * $ git-update-index --add frotz
2555                  * $ : >frotz
2556                  * $ sleep 3
2557                  * $ echo filfre >nitfol
2558                  * $ git-update-index --add nitfol
2559                  *
2560                  * but it does not.  When the second update-index runs,
2561                  * it notices that the entry "frotz" has the same timestamp
2562                  * as index, and if we were to smudge it by resetting its
2563                  * size to zero here, then the object name recorded
2564                  * in index is the 6-byte file but the cached stat information
2565                  * becomes zero --- which would then match what we would
2566                  * obtain from the filesystem next time we stat("frotz").
2567                  *
2568                  * However, the second update-index, before calling
2569                  * this function, notices that the cached size is 6
2570                  * bytes and what is on the filesystem is an empty
2571                  * file, and never calls us, so the cached size information
2572                  * for "frotz" stays 6 which does not match the filesystem.
2573                  */
2574                 ce->ce_stat_data.sd_size = 0;
2575         }
2576 }
2577
2578 /* Copy miscellaneous fields but not the name */
2579 static void copy_cache_entry_to_ondisk(struct ondisk_cache_entry *ondisk,
2580                                        struct cache_entry *ce)
2581 {
2582         short flags;
2583         const unsigned hashsz = the_hash_algo->rawsz;
2584         uint16_t *flagsp = (uint16_t *)(ondisk->data + hashsz);
2585
2586         ondisk->ctime.sec = htonl(ce->ce_stat_data.sd_ctime.sec);
2587         ondisk->mtime.sec = htonl(ce->ce_stat_data.sd_mtime.sec);
2588         ondisk->ctime.nsec = htonl(ce->ce_stat_data.sd_ctime.nsec);
2589         ondisk->mtime.nsec = htonl(ce->ce_stat_data.sd_mtime.nsec);
2590         ondisk->dev  = htonl(ce->ce_stat_data.sd_dev);
2591         ondisk->ino  = htonl(ce->ce_stat_data.sd_ino);
2592         ondisk->mode = htonl(ce->ce_mode);
2593         ondisk->uid  = htonl(ce->ce_stat_data.sd_uid);
2594         ondisk->gid  = htonl(ce->ce_stat_data.sd_gid);
2595         ondisk->size = htonl(ce->ce_stat_data.sd_size);
2596         hashcpy(ondisk->data, ce->oid.hash);
2597
2598         flags = ce->ce_flags & ~CE_NAMEMASK;
2599         flags |= (ce_namelen(ce) >= CE_NAMEMASK ? CE_NAMEMASK : ce_namelen(ce));
2600         flagsp[0] = htons(flags);
2601         if (ce->ce_flags & CE_EXTENDED) {
2602                 flagsp[1] = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
2603         }
2604 }
2605
2606 static int ce_write_entry(git_hash_ctx *c, int fd, struct cache_entry *ce,
2607                           struct strbuf *previous_name, struct ondisk_cache_entry *ondisk)
2608 {
2609         int size;
2610         int result;
2611         unsigned int saved_namelen;
2612         int stripped_name = 0;
2613         static unsigned char padding[8] = { 0x00 };
2614
2615         if (ce->ce_flags & CE_STRIP_NAME) {
2616                 saved_namelen = ce_namelen(ce);
2617                 ce->ce_namelen = 0;
2618                 stripped_name = 1;
2619         }
2620
2621         size = offsetof(struct ondisk_cache_entry,data) + ondisk_data_size(ce->ce_flags, 0);
2622
2623         if (!previous_name) {
2624                 int len = ce_namelen(ce);
2625                 copy_cache_entry_to_ondisk(ondisk, ce);
2626                 result = ce_write(c, fd, ondisk, size);
2627                 if (!result)
2628                         result = ce_write(c, fd, ce->name, len);
2629                 if (!result)
2630                         result = ce_write(c, fd, padding, align_padding_size(size, len));
2631         } else {
2632                 int common, to_remove, prefix_size;
2633                 unsigned char to_remove_vi[16];
2634                 for (common = 0;
2635                      (ce->name[common] &&
2636                       common < previous_name->len &&
2637                       ce->name[common] == previous_name->buf[common]);
2638                      common++)
2639                         ; /* still matching */
2640                 to_remove = previous_name->len - common;
2641                 prefix_size = encode_varint(to_remove, to_remove_vi);
2642
2643                 copy_cache_entry_to_ondisk(ondisk, ce);
2644                 result = ce_write(c, fd, ondisk, size);
2645                 if (!result)
2646                         result = ce_write(c, fd, to_remove_vi, prefix_size);
2647                 if (!result)
2648                         result = ce_write(c, fd, ce->name + common, ce_namelen(ce) - common);
2649                 if (!result)
2650                         result = ce_write(c, fd, padding, 1);
2651
2652                 strbuf_splice(previous_name, common, to_remove,
2653                               ce->name + common, ce_namelen(ce) - common);
2654         }
2655         if (stripped_name) {
2656                 ce->ce_namelen = saved_namelen;
2657                 ce->ce_flags &= ~CE_STRIP_NAME;
2658         }
2659
2660         return result;
2661 }
2662
2663 /*
2664  * This function verifies if index_state has the correct sha1 of the
2665  * index file.  Don't die if we have any other failure, just return 0.
2666  */
2667 static int verify_index_from(const struct index_state *istate, const char *path)
2668 {
2669         int fd;
2670         ssize_t n;
2671         struct stat st;
2672         unsigned char hash[GIT_MAX_RAWSZ];
2673
2674         if (!istate->initialized)
2675                 return 0;
2676
2677         fd = open(path, O_RDONLY);
2678         if (fd < 0)
2679                 return 0;
2680
2681         if (fstat(fd, &st))
2682                 goto out;
2683
2684         if (st.st_size < sizeof(struct cache_header) + the_hash_algo->rawsz)
2685                 goto out;
2686
2687         n = pread_in_full(fd, hash, the_hash_algo->rawsz, st.st_size - the_hash_algo->rawsz);
2688         if (n != the_hash_algo->rawsz)
2689                 goto out;
2690
2691         if (!hasheq(istate->oid.hash, hash))
2692                 goto out;
2693
2694         close(fd);
2695         return 1;
2696
2697 out:
2698         close(fd);
2699         return 0;
2700 }
2701
2702 static int repo_verify_index(struct repository *repo)
2703 {
2704         return verify_index_from(repo->index, repo->index_file);
2705 }
2706
2707 static int has_racy_timestamp(struct index_state *istate)
2708 {
2709         int entries = istate->cache_nr;
2710         int i;
2711
2712         for (i = 0; i < entries; i++) {
2713                 struct cache_entry *ce = istate->cache[i];
2714                 if (is_racy_timestamp(istate, ce))
2715                         return 1;
2716         }
2717         return 0;
2718 }
2719
2720 void repo_update_index_if_able(struct repository *repo,
2721                                struct lock_file *lockfile)
2722 {
2723         if ((repo->index->cache_changed ||
2724              has_racy_timestamp(repo->index)) &&
2725             repo_verify_index(repo))
2726                 write_locked_index(repo->index, lockfile, COMMIT_LOCK);
2727         else
2728                 rollback_lock_file(lockfile);
2729 }
2730
2731 static int record_eoie(void)
2732 {
2733         int val;
2734
2735         if (!git_config_get_bool("index.recordendofindexentries", &val))
2736                 return val;
2737
2738         /*
2739          * As a convenience, the end of index entries extension
2740          * used for threading is written by default if the user
2741          * explicitly requested threaded index reads.
2742          */
2743         return !git_config_get_index_threads(&val) && val != 1;
2744 }
2745
2746 static int record_ieot(void)
2747 {
2748         int val;
2749
2750         if (!git_config_get_bool("index.recordoffsettable", &val))
2751                 return val;
2752
2753         /*
2754          * As a convenience, the offset table used for threading is
2755          * written by default if the user explicitly requested
2756          * threaded index reads.
2757          */
2758         return !git_config_get_index_threads(&val) && val != 1;
2759 }
2760
2761 /*
2762  * On success, `tempfile` is closed. If it is the temporary file
2763  * of a `struct lock_file`, we will therefore effectively perform
2764  * a 'close_lock_file_gently()`. Since that is an implementation
2765  * detail of lockfiles, callers of `do_write_index()` should not
2766  * rely on it.
2767  */
2768 static int do_write_index(struct index_state *istate, struct tempfile *tempfile,
2769                           int strip_extensions)
2770 {
2771         uint64_t start = getnanotime();
2772         int newfd = tempfile->fd;
2773         git_hash_ctx c, eoie_c;
2774         struct cache_header hdr;
2775         int i, err = 0, removed, extended, hdr_version;
2776         struct cache_entry **cache = istate->cache;
2777         int entries = istate->cache_nr;
2778         struct stat st;
2779         struct ondisk_cache_entry ondisk;
2780         struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
2781         int drop_cache_tree = istate->drop_cache_tree;
2782         off_t offset;
2783         int ieot_entries = 1;
2784         struct index_entry_offset_table *ieot = NULL;
2785         int nr, nr_threads;
2786
2787         for (i = removed = extended = 0; i < entries; i++) {
2788                 if (cache[i]->ce_flags & CE_REMOVE)
2789                         removed++;
2790
2791                 /* reduce extended entries if possible */
2792                 cache[i]->ce_flags &= ~CE_EXTENDED;
2793                 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
2794                         extended++;
2795                         cache[i]->ce_flags |= CE_EXTENDED;
2796                 }
2797         }
2798
2799         if (!istate->version) {
2800                 istate->version = get_index_format_default(the_repository);
2801                 if (git_env_bool("GIT_TEST_SPLIT_INDEX", 0))
2802                         init_split_index(istate);
2803         }
2804
2805         /* demote version 3 to version 2 when the latter suffices */
2806         if (istate->version == 3 || istate->version == 2)
2807                 istate->version = extended ? 3 : 2;
2808
2809         hdr_version = istate->version;
2810
2811         hdr.hdr_signature = htonl(CACHE_SIGNATURE);
2812         hdr.hdr_version = htonl(hdr_version);
2813         hdr.hdr_entries = htonl(entries - removed);
2814
2815         the_hash_algo->init_fn(&c);
2816         if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
2817                 return -1;
2818
2819         if (!HAVE_THREADS || git_config_get_index_threads(&nr_threads))
2820                 nr_threads = 1;
2821
2822         if (nr_threads != 1 && record_ieot()) {
2823                 int ieot_blocks, cpus;
2824
2825                 /*
2826                  * ensure default number of ieot blocks maps evenly to the
2827                  * default number of threads that will process them leaving
2828                  * room for the thread to load the index extensions.
2829                  */
2830                 if (!nr_threads) {
2831                         ieot_blocks = istate->cache_nr / THREAD_COST;
2832                         cpus = online_cpus();
2833                         if (ieot_blocks > cpus - 1)
2834                                 ieot_blocks = cpus - 1;
2835                 } else {
2836                         ieot_blocks = nr_threads;
2837                         if (ieot_blocks > istate->cache_nr)
2838                                 ieot_blocks = istate->cache_nr;
2839                 }
2840
2841                 /*
2842                  * no reason to write out the IEOT extension if we don't
2843                  * have enough blocks to utilize multi-threading
2844                  */
2845                 if (ieot_blocks > 1) {
2846                         ieot = xcalloc(1, sizeof(struct index_entry_offset_table)
2847                                 + (ieot_blocks * sizeof(struct index_entry_offset)));
2848                         ieot_entries = DIV_ROUND_UP(entries, ieot_blocks);
2849                 }
2850         }
2851
2852         offset = lseek(newfd, 0, SEEK_CUR);
2853         if (offset < 0) {
2854                 free(ieot);
2855                 return -1;
2856         }
2857         offset += write_buffer_len;
2858         nr = 0;
2859         previous_name = (hdr_version == 4) ? &previous_name_buf : NULL;
2860
2861         for (i = 0; i < entries; i++) {
2862                 struct cache_entry *ce = cache[i];
2863                 if (ce->ce_flags & CE_REMOVE)
2864                         continue;
2865                 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
2866                         ce_smudge_racily_clean_entry(istate, ce);
2867                 if (is_null_oid(&ce->oid)) {
2868                         static const char msg[] = "cache entry has null sha1: %s";
2869                         static int allow = -1;
2870
2871                         if (allow < 0)
2872                                 allow = git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
2873                         if (allow)
2874                                 warning(msg, ce->name);
2875                         else
2876                                 err = error(msg, ce->name);
2877
2878                         drop_cache_tree = 1;
2879                 }
2880                 if (ieot && i && (i % ieot_entries == 0)) {
2881                         ieot->entries[ieot->nr].nr = nr;
2882                         ieot->entries[ieot->nr].offset = offset;
2883                         ieot->nr++;
2884                         /*
2885                          * If we have a V4 index, set the first byte to an invalid
2886                          * character to ensure there is nothing common with the previous
2887                          * entry
2888                          */
2889                         if (previous_name)
2890                                 previous_name->buf[0] = 0;
2891                         nr = 0;
2892                         offset = lseek(newfd, 0, SEEK_CUR);
2893                         if (offset < 0) {
2894                                 free(ieot);
2895                                 return -1;
2896                         }
2897                         offset += write_buffer_len;
2898                 }
2899                 if (ce_write_entry(&c, newfd, ce, previous_name, (struct ondisk_cache_entry *)&ondisk) < 0)
2900                         err = -1;
2901
2902                 if (err)
2903                         break;
2904                 nr++;
2905         }
2906         if (ieot && nr) {
2907                 ieot->entries[ieot->nr].nr = nr;
2908                 ieot->entries[ieot->nr].offset = offset;
2909                 ieot->nr++;
2910         }
2911         strbuf_release(&previous_name_buf);
2912
2913         if (err) {
2914                 free(ieot);
2915                 return err;
2916         }
2917
2918         /* Write extension data here */
2919         offset = lseek(newfd, 0, SEEK_CUR);
2920         if (offset < 0) {
2921                 free(ieot);
2922                 return -1;
2923         }
2924         offset += write_buffer_len;
2925         the_hash_algo->init_fn(&eoie_c);
2926
2927         /*
2928          * Lets write out CACHE_EXT_INDEXENTRYOFFSETTABLE first so that we
2929          * can minimize the number of extensions we have to scan through to
2930          * find it during load.  Write it out regardless of the
2931          * strip_extensions parameter as we need it when loading the shared
2932          * index.
2933          */
2934         if (ieot) {
2935                 struct strbuf sb = STRBUF_INIT;
2936
2937                 write_ieot_extension(&sb, ieot);
2938                 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_INDEXENTRYOFFSETTABLE, sb.len) < 0
2939                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2940                 strbuf_release(&sb);
2941                 free(ieot);
2942                 if (err)
2943                         return -1;
2944         }
2945
2946         if (!strip_extensions && istate->split_index &&
2947             !is_null_oid(&istate->split_index->base_oid)) {
2948                 struct strbuf sb = STRBUF_INIT;
2949
2950                 err = write_link_extension(&sb, istate) < 0 ||
2951                         write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_LINK,
2952                                                sb.len) < 0 ||
2953                         ce_write(&c, newfd, sb.buf, sb.len) < 0;
2954                 strbuf_release(&sb);
2955                 if (err)
2956                         return -1;
2957         }
2958         if (!strip_extensions && !drop_cache_tree && istate->cache_tree) {
2959                 struct strbuf sb = STRBUF_INIT;
2960
2961                 cache_tree_write(&sb, istate->cache_tree);
2962                 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_TREE, sb.len) < 0
2963                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2964                 strbuf_release(&sb);
2965                 if (err)
2966                         return -1;
2967         }
2968         if (!strip_extensions && istate->resolve_undo) {
2969                 struct strbuf sb = STRBUF_INIT;
2970
2971                 resolve_undo_write(&sb, istate->resolve_undo);
2972                 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_RESOLVE_UNDO,
2973                                              sb.len) < 0
2974                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2975                 strbuf_release(&sb);
2976                 if (err)
2977                         return -1;
2978         }
2979         if (!strip_extensions && istate->untracked) {
2980                 struct strbuf sb = STRBUF_INIT;
2981
2982                 write_untracked_extension(&sb, istate->untracked);
2983                 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_UNTRACKED,
2984                                              sb.len) < 0 ||
2985                         ce_write(&c, newfd, sb.buf, sb.len) < 0;
2986                 strbuf_release(&sb);
2987                 if (err)
2988                         return -1;
2989         }
2990         if (!strip_extensions && istate->fsmonitor_last_update) {
2991                 struct strbuf sb = STRBUF_INIT;
2992
2993                 write_fsmonitor_extension(&sb, istate);
2994                 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_FSMONITOR, sb.len) < 0
2995                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2996                 strbuf_release(&sb);
2997                 if (err)
2998                         return -1;
2999         }
3000
3001         /*
3002          * CACHE_EXT_ENDOFINDEXENTRIES must be written as the last entry before the SHA1
3003          * so that it can be found and processed before all the index entries are
3004          * read.  Write it out regardless of the strip_extensions parameter as we need it
3005          * when loading the shared index.
3006          */
3007         if (offset && record_eoie()) {
3008                 struct strbuf sb = STRBUF_INIT;
3009
3010                 write_eoie_extension(&sb, &eoie_c, offset);
3011                 err = write_index_ext_header(&c, NULL, newfd, CACHE_EXT_ENDOFINDEXENTRIES, sb.len) < 0
3012                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
3013                 strbuf_release(&sb);
3014                 if (err)
3015                         return -1;
3016         }
3017
3018         if (ce_flush(&c, newfd, istate->oid.hash))
3019                 return -1;
3020         if (close_tempfile_gently(tempfile)) {
3021                 error(_("could not close '%s'"), tempfile->filename.buf);
3022                 return -1;
3023         }
3024         if (stat(tempfile->filename.buf, &st))
3025                 return -1;
3026         istate->timestamp.sec = (unsigned int)st.st_mtime;
3027         istate->timestamp.nsec = ST_MTIME_NSEC(st);
3028         trace_performance_since(start, "write index, changed mask = %x", istate->cache_changed);
3029
3030         /*
3031          * TODO trace2: replace "the_repository" with the actual repo instance
3032          * that is associated with the given "istate".
3033          */
3034         trace2_data_intmax("index", the_repository, "write/version",
3035                            istate->version);
3036         trace2_data_intmax("index", the_repository, "write/cache_nr",
3037                            istate->cache_nr);
3038
3039         return 0;
3040 }
3041
3042 void set_alternate_index_output(const char *name)
3043 {
3044         alternate_index_output = name;
3045 }
3046
3047 static int commit_locked_index(struct lock_file *lk)
3048 {
3049         if (alternate_index_output)
3050                 return commit_lock_file_to(lk, alternate_index_output);
3051         else
3052                 return commit_lock_file(lk);
3053 }
3054
3055 static int do_write_locked_index(struct index_state *istate, struct lock_file *lock,
3056                                  unsigned flags)
3057 {
3058         int ret;
3059
3060         /*
3061          * TODO trace2: replace "the_repository" with the actual repo instance
3062          * that is associated with the given "istate".
3063          */
3064         trace2_region_enter_printf("index", "do_write_index", the_repository,
3065                                    "%s", lock->tempfile->filename.buf);
3066         ret = do_write_index(istate, lock->tempfile, 0);
3067         trace2_region_leave_printf("index", "do_write_index", the_repository,
3068                                    "%s", lock->tempfile->filename.buf);
3069
3070         if (ret)
3071                 return ret;
3072         if (flags & COMMIT_LOCK)
3073                 ret = commit_locked_index(lock);
3074         else
3075                 ret = close_lock_file_gently(lock);
3076
3077         run_hook_le(NULL, "post-index-change",
3078                         istate->updated_workdir ? "1" : "0",
3079                         istate->updated_skipworktree ? "1" : "0", NULL);
3080         istate->updated_workdir = 0;
3081         istate->updated_skipworktree = 0;
3082
3083         return ret;
3084 }
3085
3086 static int write_split_index(struct index_state *istate,
3087                              struct lock_file *lock,
3088                              unsigned flags)
3089 {
3090         int ret;
3091         prepare_to_write_split_index(istate);
3092         ret = do_write_locked_index(istate, lock, flags);
3093         finish_writing_split_index(istate);
3094         return ret;
3095 }
3096
3097 static const char *shared_index_expire = "2.weeks.ago";
3098
3099 static unsigned long get_shared_index_expire_date(void)
3100 {
3101         static unsigned long shared_index_expire_date;
3102         static int shared_index_expire_date_prepared;
3103
3104         if (!shared_index_expire_date_prepared) {
3105                 git_config_get_expiry("splitindex.sharedindexexpire",
3106                                       &shared_index_expire);
3107                 shared_index_expire_date = approxidate(shared_index_expire);
3108                 shared_index_expire_date_prepared = 1;
3109         }
3110
3111         return shared_index_expire_date;
3112 }
3113
3114 static int should_delete_shared_index(const char *shared_index_path)
3115 {
3116         struct stat st;
3117         unsigned long expiration;
3118
3119         /* Check timestamp */
3120         expiration = get_shared_index_expire_date();
3121         if (!expiration)
3122                 return 0;
3123         if (stat(shared_index_path, &st))
3124                 return error_errno(_("could not stat '%s'"), shared_index_path);
3125         if (st.st_mtime > expiration)
3126                 return 0;
3127
3128         return 1;
3129 }
3130
3131 static int clean_shared_index_files(const char *current_hex)
3132 {
3133         struct dirent *de;
3134         DIR *dir = opendir(get_git_dir());
3135
3136         if (!dir)
3137                 return error_errno(_("unable to open git dir: %s"), get_git_dir());
3138
3139         while ((de = readdir(dir)) != NULL) {
3140                 const char *sha1_hex;
3141                 const char *shared_index_path;
3142                 if (!skip_prefix(de->d_name, "sharedindex.", &sha1_hex))
3143                         continue;
3144                 if (!strcmp(sha1_hex, current_hex))
3145                         continue;
3146                 shared_index_path = git_path("%s", de->d_name);
3147                 if (should_delete_shared_index(shared_index_path) > 0 &&
3148                     unlink(shared_index_path))
3149                         warning_errno(_("unable to unlink: %s"), shared_index_path);
3150         }
3151         closedir(dir);
3152
3153         return 0;
3154 }
3155
3156 static int write_shared_index(struct index_state *istate,
3157                               struct tempfile **temp)
3158 {
3159         struct split_index *si = istate->split_index;
3160         int ret;
3161
3162         move_cache_to_base_index(istate);
3163
3164         trace2_region_enter_printf("index", "shared/do_write_index",
3165                                    the_repository, "%s", (*temp)->filename.buf);
3166         ret = do_write_index(si->base, *temp, 1);
3167         trace2_region_leave_printf("index", "shared/do_write_index",
3168                                    the_repository, "%s", (*temp)->filename.buf);
3169
3170         if (ret)
3171                 return ret;
3172         ret = adjust_shared_perm(get_tempfile_path(*temp));
3173         if (ret) {
3174                 error(_("cannot fix permission bits on '%s'"), get_tempfile_path(*temp));
3175                 return ret;
3176         }
3177         ret = rename_tempfile(temp,
3178                               git_path("sharedindex.%s", oid_to_hex(&si->base->oid)));
3179         if (!ret) {
3180                 oidcpy(&si->base_oid, &si->base->oid);
3181                 clean_shared_index_files(oid_to_hex(&si->base->oid));
3182         }
3183
3184         return ret;
3185 }
3186
3187 static const int default_max_percent_split_change = 20;
3188
3189 static int too_many_not_shared_entries(struct index_state *istate)
3190 {
3191         int i, not_shared = 0;
3192         int max_split = git_config_get_max_percent_split_change();
3193
3194         switch (max_split) {
3195         case -1:
3196                 /* not or badly configured: use the default value */
3197                 max_split = default_max_percent_split_change;
3198                 break;
3199         case 0:
3200                 return 1; /* 0% means always write a new shared index */
3201         case 100:
3202                 return 0; /* 100% means never write a new shared index */
3203         default:
3204                 break; /* just use the configured value */
3205         }
3206
3207         /* Count not shared entries */
3208         for (i = 0; i < istate->cache_nr; i++) {
3209                 struct cache_entry *ce = istate->cache[i];
3210                 if (!ce->index)
3211                         not_shared++;
3212         }
3213
3214         return (int64_t)istate->cache_nr * max_split < (int64_t)not_shared * 100;
3215 }
3216
3217 int write_locked_index(struct index_state *istate, struct lock_file *lock,
3218                        unsigned flags)
3219 {
3220         int new_shared_index, ret;
3221         struct split_index *si = istate->split_index;
3222
3223         if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
3224                 cache_tree_verify(the_repository, istate);
3225
3226         if ((flags & SKIP_IF_UNCHANGED) && !istate->cache_changed) {
3227                 if (flags & COMMIT_LOCK)
3228                         rollback_lock_file(lock);
3229                 return 0;
3230         }
3231
3232         if (istate->fsmonitor_last_update)
3233                 fill_fsmonitor_bitmap(istate);
3234
3235         if (!si || alternate_index_output ||
3236             (istate->cache_changed & ~EXTMASK)) {
3237                 if (si)
3238                         oidclr(&si->base_oid);
3239                 ret = do_write_locked_index(istate, lock, flags);
3240                 goto out;
3241         }
3242
3243         if (git_env_bool("GIT_TEST_SPLIT_INDEX", 0)) {
3244                 int v = si->base_oid.hash[0];
3245                 if ((v & 15) < 6)
3246                         istate->cache_changed |= SPLIT_INDEX_ORDERED;
3247         }
3248         if (too_many_not_shared_entries(istate))
3249                 istate->cache_changed |= SPLIT_INDEX_ORDERED;
3250
3251         new_shared_index = istate->cache_changed & SPLIT_INDEX_ORDERED;
3252
3253         if (new_shared_index) {
3254                 struct tempfile *temp;
3255                 int saved_errno;
3256
3257                 /* Same initial permissions as the main .git/index file */
3258                 temp = mks_tempfile_sm(git_path("sharedindex_XXXXXX"), 0, 0666);
3259                 if (!temp) {
3260                         oidclr(&si->base_oid);
3261                         ret = do_write_locked_index(istate, lock, flags);
3262                         goto out;
3263                 }
3264                 ret = write_shared_index(istate, &temp);
3265
3266                 saved_errno = errno;
3267                 if (is_tempfile_active(temp))
3268                         delete_tempfile(&temp);
3269                 errno = saved_errno;
3270
3271                 if (ret)
3272                         goto out;
3273         }
3274
3275         ret = write_split_index(istate, lock, flags);
3276
3277         /* Freshen the shared index only if the split-index was written */
3278         if (!ret && !new_shared_index && !is_null_oid(&si->base_oid)) {
3279                 const char *shared_index = git_path("sharedindex.%s",
3280                                                     oid_to_hex(&si->base_oid));
3281                 freshen_shared_index(shared_index, 1);
3282         }
3283
3284 out:
3285         if (flags & COMMIT_LOCK)
3286                 rollback_lock_file(lock);
3287         return ret;
3288 }
3289
3290 /*
3291  * Read the index file that is potentially unmerged into given
3292  * index_state, dropping any unmerged entries to stage #0 (potentially
3293  * resulting in a path appearing as both a file and a directory in the
3294  * index; the caller is responsible to clear out the extra entries
3295  * before writing the index to a tree).  Returns true if the index is
3296  * unmerged.  Callers who want to refuse to work from an unmerged
3297  * state can call this and check its return value, instead of calling
3298  * read_cache().
3299  */
3300 int repo_read_index_unmerged(struct repository *repo)
3301 {
3302         struct index_state *istate;
3303         int i;
3304         int unmerged = 0;
3305
3306         repo_read_index(repo);
3307         istate = repo->index;
3308         for (i = 0; i < istate->cache_nr; i++) {
3309                 struct cache_entry *ce = istate->cache[i];
3310                 struct cache_entry *new_ce;
3311                 int len;
3312
3313                 if (!ce_stage(ce))
3314                         continue;
3315                 unmerged = 1;
3316                 len = ce_namelen(ce);
3317                 new_ce = make_empty_cache_entry(istate, len);
3318                 memcpy(new_ce->name, ce->name, len);
3319                 new_ce->ce_flags = create_ce_flags(0) | CE_CONFLICTED;
3320                 new_ce->ce_namelen = len;
3321                 new_ce->ce_mode = ce->ce_mode;
3322                 if (add_index_entry(istate, new_ce, ADD_CACHE_SKIP_DFCHECK))
3323                         return error(_("%s: cannot drop to stage #0"),
3324                                      new_ce->name);
3325         }
3326         return unmerged;
3327 }
3328
3329 /*
3330  * Returns 1 if the path is an "other" path with respect to
3331  * the index; that is, the path is not mentioned in the index at all,
3332  * either as a file, a directory with some files in the index,
3333  * or as an unmerged entry.
3334  *
3335  * We helpfully remove a trailing "/" from directories so that
3336  * the output of read_directory can be used as-is.
3337  */
3338 int index_name_is_other(const struct index_state *istate, const char *name,
3339                 int namelen)
3340 {
3341         int pos;
3342         if (namelen && name[namelen - 1] == '/')
3343                 namelen--;
3344         pos = index_name_pos(istate, name, namelen);
3345         if (0 <= pos)
3346                 return 0;       /* exact match */
3347         pos = -pos - 1;
3348         if (pos < istate->cache_nr) {
3349                 struct cache_entry *ce = istate->cache[pos];
3350                 if (ce_namelen(ce) == namelen &&
3351                     !memcmp(ce->name, name, namelen))
3352                         return 0; /* Yup, this one exists unmerged */
3353         }
3354         return 1;
3355 }
3356
3357 void *read_blob_data_from_index(const struct index_state *istate,
3358                                 const char *path, unsigned long *size)
3359 {
3360         int pos, len;
3361         unsigned long sz;
3362         enum object_type type;
3363         void *data;
3364
3365         len = strlen(path);
3366         pos = index_name_pos(istate, path, len);
3367         if (pos < 0) {
3368                 /*
3369                  * We might be in the middle of a merge, in which
3370                  * case we would read stage #2 (ours).
3371                  */
3372                 int i;
3373                 for (i = -pos - 1;
3374                      (pos < 0 && i < istate->cache_nr &&
3375                       !strcmp(istate->cache[i]->name, path));
3376                      i++)
3377                         if (ce_stage(istate->cache[i]) == 2)
3378                                 pos = i;
3379         }
3380         if (pos < 0)
3381                 return NULL;
3382         data = read_object_file(&istate->cache[pos]->oid, &type, &sz);
3383         if (!data || type != OBJ_BLOB) {
3384                 free(data);
3385                 return NULL;
3386         }
3387         if (size)
3388                 *size = sz;
3389         return data;
3390 }
3391
3392 void stat_validity_clear(struct stat_validity *sv)
3393 {
3394         FREE_AND_NULL(sv->sd);
3395 }
3396
3397 int stat_validity_check(struct stat_validity *sv, const char *path)
3398 {
3399         struct stat st;
3400
3401         if (stat(path, &st) < 0)
3402                 return sv->sd == NULL;
3403         if (!sv->sd)
3404                 return 0;
3405         return S_ISREG(st.st_mode) && !match_stat_data(sv->sd, &st);
3406 }
3407
3408 void stat_validity_update(struct stat_validity *sv, int fd)
3409 {
3410         struct stat st;
3411
3412         if (fstat(fd, &st) < 0 || !S_ISREG(st.st_mode))
3413                 stat_validity_clear(sv);
3414         else {
3415                 if (!sv->sd)
3416                         sv->sd = xcalloc(1, sizeof(struct stat_data));
3417                 fill_stat_data(sv->sd, &st);
3418         }
3419 }
3420
3421 void move_index_extensions(struct index_state *dst, struct index_state *src)
3422 {
3423         dst->untracked = src->untracked;
3424         src->untracked = NULL;
3425         dst->cache_tree = src->cache_tree;
3426         src->cache_tree = NULL;
3427 }
3428
3429 struct cache_entry *dup_cache_entry(const struct cache_entry *ce,
3430                                     struct index_state *istate)
3431 {
3432         unsigned int size = ce_size(ce);
3433         int mem_pool_allocated;
3434         struct cache_entry *new_entry = make_empty_cache_entry(istate, ce_namelen(ce));
3435         mem_pool_allocated = new_entry->mem_pool_allocated;
3436
3437         memcpy(new_entry, ce, size);
3438         new_entry->mem_pool_allocated = mem_pool_allocated;
3439         return new_entry;
3440 }
3441
3442 void discard_cache_entry(struct cache_entry *ce)
3443 {
3444         if (ce && should_validate_cache_entries())
3445                 memset(ce, 0xCD, cache_entry_size(ce->ce_namelen));
3446
3447         if (ce && ce->mem_pool_allocated)
3448                 return;
3449
3450         free(ce);
3451 }
3452
3453 int should_validate_cache_entries(void)
3454 {
3455         static int validate_index_cache_entries = -1;
3456
3457         if (validate_index_cache_entries < 0) {
3458                 if (getenv("GIT_TEST_VALIDATE_INDEX_CACHE_ENTRIES"))
3459                         validate_index_cache_entries = 1;
3460                 else
3461                         validate_index_cache_entries = 0;
3462         }
3463
3464         return validate_index_cache_entries;
3465 }
3466
3467 #define EOIE_SIZE (4 + GIT_SHA1_RAWSZ) /* <4-byte offset> + <20-byte hash> */
3468 #define EOIE_SIZE_WITH_HEADER (4 + 4 + EOIE_SIZE) /* <4-byte signature> + <4-byte length> + EOIE_SIZE */
3469
3470 static size_t read_eoie_extension(const char *mmap, size_t mmap_size)
3471 {
3472         /*
3473          * The end of index entries (EOIE) extension is guaranteed to be last
3474          * so that it can be found by scanning backwards from the EOF.
3475          *
3476          * "EOIE"
3477          * <4-byte length>
3478          * <4-byte offset>
3479          * <20-byte hash>
3480          */
3481         const char *index, *eoie;
3482         uint32_t extsize;
3483         size_t offset, src_offset;
3484         unsigned char hash[GIT_MAX_RAWSZ];
3485         git_hash_ctx c;
3486
3487         /* ensure we have an index big enough to contain an EOIE extension */
3488         if (mmap_size < sizeof(struct cache_header) + EOIE_SIZE_WITH_HEADER + the_hash_algo->rawsz)
3489                 return 0;
3490
3491         /* validate the extension signature */
3492         index = eoie = mmap + mmap_size - EOIE_SIZE_WITH_HEADER - the_hash_algo->rawsz;
3493         if (CACHE_EXT(index) != CACHE_EXT_ENDOFINDEXENTRIES)
3494                 return 0;
3495         index += sizeof(uint32_t);
3496
3497         /* validate the extension size */
3498         extsize = get_be32(index);
3499         if (extsize != EOIE_SIZE)
3500                 return 0;
3501         index += sizeof(uint32_t);
3502
3503         /*
3504          * Validate the offset we're going to look for the first extension
3505          * signature is after the index header and before the eoie extension.
3506          */
3507         offset = get_be32(index);
3508         if (mmap + offset < mmap + sizeof(struct cache_header))
3509                 return 0;
3510         if (mmap + offset >= eoie)
3511                 return 0;
3512         index += sizeof(uint32_t);
3513
3514         /*
3515          * The hash is computed over extension types and their sizes (but not
3516          * their contents).  E.g. if we have "TREE" extension that is N-bytes
3517          * long, "REUC" extension that is M-bytes long, followed by "EOIE",
3518          * then the hash would be:
3519          *
3520          * SHA-1("TREE" + <binary representation of N> +
3521          *       "REUC" + <binary representation of M>)
3522          */
3523         src_offset = offset;
3524         the_hash_algo->init_fn(&c);
3525         while (src_offset < mmap_size - the_hash_algo->rawsz - EOIE_SIZE_WITH_HEADER) {
3526                 /* After an array of active_nr index entries,
3527                  * there can be arbitrary number of extended
3528                  * sections, each of which is prefixed with
3529                  * extension name (4-byte) and section length
3530                  * in 4-byte network byte order.
3531                  */
3532                 uint32_t extsize;
3533                 memcpy(&extsize, mmap + src_offset + 4, 4);
3534                 extsize = ntohl(extsize);
3535
3536                 /* verify the extension size isn't so large it will wrap around */
3537                 if (src_offset + 8 + extsize < src_offset)
3538                         return 0;
3539
3540                 the_hash_algo->update_fn(&c, mmap + src_offset, 8);
3541
3542                 src_offset += 8;
3543                 src_offset += extsize;
3544         }
3545         the_hash_algo->final_fn(hash, &c);
3546         if (!hasheq(hash, (const unsigned char *)index))
3547                 return 0;
3548
3549         /* Validate that the extension offsets returned us back to the eoie extension. */
3550         if (src_offset != mmap_size - the_hash_algo->rawsz - EOIE_SIZE_WITH_HEADER)
3551                 return 0;
3552
3553         return offset;
3554 }
3555
3556 static void write_eoie_extension(struct strbuf *sb, git_hash_ctx *eoie_context, size_t offset)
3557 {
3558         uint32_t buffer;
3559         unsigned char hash[GIT_MAX_RAWSZ];
3560
3561         /* offset */
3562         put_be32(&buffer, offset);
3563         strbuf_add(sb, &buffer, sizeof(uint32_t));
3564
3565         /* hash */
3566         the_hash_algo->final_fn(hash, eoie_context);
3567         strbuf_add(sb, hash, the_hash_algo->rawsz);
3568 }
3569
3570 #define IEOT_VERSION    (1)
3571
3572 static struct index_entry_offset_table *read_ieot_extension(const char *mmap, size_t mmap_size, size_t offset)
3573 {
3574         const char *index = NULL;
3575         uint32_t extsize, ext_version;
3576         struct index_entry_offset_table *ieot;
3577         int i, nr;
3578
3579         /* find the IEOT extension */
3580         if (!offset)
3581                 return NULL;
3582         while (offset <= mmap_size - the_hash_algo->rawsz - 8) {
3583                 extsize = get_be32(mmap + offset + 4);
3584                 if (CACHE_EXT((mmap + offset)) == CACHE_EXT_INDEXENTRYOFFSETTABLE) {
3585                         index = mmap + offset + 4 + 4;
3586                         break;
3587                 }
3588                 offset += 8;
3589                 offset += extsize;
3590         }
3591         if (!index)
3592                 return NULL;
3593
3594         /* validate the version is IEOT_VERSION */
3595         ext_version = get_be32(index);
3596         if (ext_version != IEOT_VERSION) {
3597                 error("invalid IEOT version %d", ext_version);
3598                 return NULL;
3599         }
3600         index += sizeof(uint32_t);
3601
3602         /* extension size - version bytes / bytes per entry */
3603         nr = (extsize - sizeof(uint32_t)) / (sizeof(uint32_t) + sizeof(uint32_t));
3604         if (!nr) {
3605                 error("invalid number of IEOT entries %d", nr);
3606                 return NULL;
3607         }
3608         ieot = xmalloc(sizeof(struct index_entry_offset_table)
3609                        + (nr * sizeof(struct index_entry_offset)));
3610         ieot->nr = nr;
3611         for (i = 0; i < nr; i++) {
3612                 ieot->entries[i].offset = get_be32(index);
3613                 index += sizeof(uint32_t);
3614                 ieot->entries[i].nr = get_be32(index);
3615                 index += sizeof(uint32_t);
3616         }
3617
3618         return ieot;
3619 }
3620
3621 static void write_ieot_extension(struct strbuf *sb, struct index_entry_offset_table *ieot)
3622 {
3623         uint32_t buffer;
3624         int i;
3625
3626         /* version */
3627         put_be32(&buffer, IEOT_VERSION);
3628         strbuf_add(sb, &buffer, sizeof(uint32_t));
3629
3630         /* ieot */
3631         for (i = 0; i < ieot->nr; i++) {
3632
3633                 /* offset */
3634                 put_be32(&buffer, ieot->entries[i].offset);
3635                 strbuf_add(sb, &buffer, sizeof(uint32_t));
3636
3637                 /* count */
3638                 put_be32(&buffer, ieot->entries[i].nr);
3639                 strbuf_add(sb, &buffer, sizeof(uint32_t));
3640         }
3641 }