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