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