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