Merge branch 'sg/test-bash-version-fix'
[git.git] / read-cache.c
blobbd45dc3e24d7dc28820d26cc6e6d377f92fda46d
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #define NO_THE_INDEX_COMPATIBILITY_MACROS
7 #include "cache.h"
8 #include "config.h"
9 #include "diff.h"
10 #include "diffcore.h"
11 #include "tempfile.h"
12 #include "lockfile.h"
13 #include "cache-tree.h"
14 #include "refs.h"
15 #include "dir.h"
16 #include "object-store.h"
17 #include "tree.h"
18 #include "commit.h"
19 #include "blob.h"
20 #include "resolve-undo.h"
21 #include "strbuf.h"
22 #include "varint.h"
23 #include "split-index.h"
24 #include "utf8.h"
25 #include "fsmonitor.h"
26 #include "thread-utils.h"
27 #include "progress.h"
29 /* Mask for the name length in ce_flags in the on-disk index */
31 #define CE_NAMEMASK (0x0fff)
33 /* Index extensions.
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.
42 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
43 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
44 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
45 #define CACHE_EXT_LINK 0x6c696e6b /* "link" */
46 #define CACHE_EXT_UNTRACKED 0x554E5452 /* "UNTR" */
47 #define CACHE_EXT_FSMONITOR 0x46534D4E /* "FSMN" */
48 #define CACHE_EXT_ENDOFINDEXENTRIES 0x454F4945 /* "EOIE" */
49 #define CACHE_EXT_INDEXENTRYOFFSETTABLE 0x49454F54 /* "IEOT" */
51 /* changes that can be kept in $GIT_DIR/index (basically all extensions) */
52 #define EXTMASK (RESOLVE_UNDO_CHANGED | CACHE_TREE_CHANGED | \
53 CE_ENTRY_ADDED | CE_ENTRY_REMOVED | CE_ENTRY_CHANGED | \
54 SPLIT_INDEX_ORDERED | UNTRACKED_CHANGED | FSMONITOR_CHANGED)
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.
65 #define CACHE_ENTRY_PATH_LENGTH 80
67 static inline struct cache_entry *mem_pool__ce_alloc(struct mem_pool *mem_pool, size_t len)
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;
75 static inline struct cache_entry *mem_pool__ce_calloc(struct mem_pool *mem_pool, size_t len)
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;
83 static struct mem_pool *find_mem_pool(struct index_state *istate)
85 struct mem_pool **pool_ptr;
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;
92 if (!*pool_ptr)
93 mem_pool_init(pool_ptr, 0);
95 return *pool_ptr;
98 struct index_state the_index;
99 static const char *alternate_index_output;
101 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
103 istate->cache[nr] = ce;
104 add_name_hash(istate, ce);
107 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
109 struct cache_entry *old = istate->cache[nr];
111 replace_index_entry_in_base(istate, old, ce);
112 remove_name_hash(istate, old);
113 discard_cache_entry(old);
114 ce->ce_flags &= ~CE_HASHED;
115 set_index_entry(istate, nr, ce);
116 ce->ce_flags |= CE_UPDATE_IN_BASE;
117 mark_fsmonitor_invalid(istate, ce);
118 istate->cache_changed |= CE_ENTRY_CHANGED;
121 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
123 struct cache_entry *old_entry = istate->cache[nr], *new_entry;
124 int namelen = strlen(new_name);
126 new_entry = make_empty_cache_entry(istate, namelen);
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);
133 cache_tree_invalidate_path(istate, old_entry->name);
134 untracked_cache_remove_from_index(istate, old_entry->name);
135 remove_index_entry_at(istate, nr);
136 add_index_entry(istate, new_entry, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
139 void fill_stat_data(struct stat_data *sd, struct stat *st)
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;
152 int match_stat_data(const struct stat_data *sd, struct stat *st)
154 int changed = 0;
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;
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
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;
178 #ifdef USE_STDEV
180 * st_dev breaks on network filesystems where different
181 * clients will have different views of what "device"
182 * the filesystem is on
184 if (check_stat && sd->sd_dev != (unsigned int) st->st_dev)
185 changed |= INODE_CHANGED;
186 #endif
188 if (sd->sd_size != (unsigned int) st->st_size)
189 changed |= DATA_CHANGED;
191 return changed;
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.
199 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
201 fill_stat_data(&ce->ce_stat_data, st);
203 if (assume_unchanged)
204 ce->ce_flags |= CE_VALID;
206 if (S_ISREG(st->st_mode)) {
207 ce_mark_uptodate(ce);
208 mark_fsmonitor_valid(ce);
212 static int ce_compare_data(struct index_state *istate,
213 const struct cache_entry *ce,
214 struct stat *st)
216 int match = -1;
217 int fd = git_open_cloexec(ce->name, O_RDONLY);
219 if (fd >= 0) {
220 struct object_id oid;
221 if (!index_fd(istate, &oid, fd, st, OBJ_BLOB, ce->name, 0))
222 match = !oideq(&oid, &ce->oid);
223 /* index_fd() closed the file descriptor already */
225 return match;
228 static int ce_compare_link(const struct cache_entry *ce, size_t expected_size)
230 int match = -1;
231 void *buffer;
232 unsigned long size;
233 enum object_type type;
234 struct strbuf sb = STRBUF_INIT;
236 if (strbuf_readlink(&sb, ce->name, expected_size))
237 return -1;
239 buffer = read_object_file(&ce->oid, &type, &size);
240 if (buffer) {
241 if (size == sb.len)
242 match = memcmp(buffer, sb.buf, size);
243 free(buffer);
245 strbuf_release(&sb);
246 return match;
249 static int ce_compare_gitlink(const struct cache_entry *ce)
251 struct object_id oid;
254 * We don't actually require that the .git directory
255 * under GITLINK directory be a valid git directory. It
256 * might even be missing (in case nobody populated that
257 * sub-project).
259 * If so, we consider it always to match.
261 if (resolve_gitlink_ref(ce->name, "HEAD", &oid) < 0)
262 return 0;
263 return !oideq(&oid, &ce->oid);
266 static int ce_modified_check_fs(struct index_state *istate,
267 const struct cache_entry *ce,
268 struct stat *st)
270 switch (st->st_mode & S_IFMT) {
271 case S_IFREG:
272 if (ce_compare_data(istate, ce, st))
273 return DATA_CHANGED;
274 break;
275 case S_IFLNK:
276 if (ce_compare_link(ce, xsize_t(st->st_size)))
277 return DATA_CHANGED;
278 break;
279 case S_IFDIR:
280 if (S_ISGITLINK(ce->ce_mode))
281 return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
282 /* else fallthrough */
283 default:
284 return TYPE_CHANGED;
286 return 0;
289 static int ce_match_stat_basic(const struct cache_entry *ce, struct stat *st)
291 unsigned int changed = 0;
293 if (ce->ce_flags & CE_REMOVE)
294 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
296 switch (ce->ce_mode & S_IFMT) {
297 case S_IFREG:
298 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
299 /* We consider only the owner x bit to be relevant for
300 * "mode changes"
302 if (trust_executable_bit &&
303 (0100 & (ce->ce_mode ^ st->st_mode)))
304 changed |= MODE_CHANGED;
305 break;
306 case S_IFLNK:
307 if (!S_ISLNK(st->st_mode) &&
308 (has_symlinks || !S_ISREG(st->st_mode)))
309 changed |= TYPE_CHANGED;
310 break;
311 case S_IFGITLINK:
312 /* We ignore most of the st_xxx fields for gitlinks */
313 if (!S_ISDIR(st->st_mode))
314 changed |= TYPE_CHANGED;
315 else if (ce_compare_gitlink(ce))
316 changed |= DATA_CHANGED;
317 return changed;
318 default:
319 die("internal error: ce_mode is %o", ce->ce_mode);
322 changed |= match_stat_data(&ce->ce_stat_data, st);
324 /* Racily smudged entry? */
325 if (!ce->ce_stat_data.sd_size) {
326 if (!is_empty_blob_sha1(ce->oid.hash))
327 changed |= DATA_CHANGED;
330 return changed;
333 static int is_racy_stat(const struct index_state *istate,
334 const struct stat_data *sd)
336 return (istate->timestamp.sec &&
337 #ifdef USE_NSEC
338 /* nanosecond timestamped files can also be racy! */
339 (istate->timestamp.sec < sd->sd_mtime.sec ||
340 (istate->timestamp.sec == sd->sd_mtime.sec &&
341 istate->timestamp.nsec <= sd->sd_mtime.nsec))
342 #else
343 istate->timestamp.sec <= sd->sd_mtime.sec
344 #endif
348 int is_racy_timestamp(const struct index_state *istate,
349 const struct cache_entry *ce)
351 return (!S_ISGITLINK(ce->ce_mode) &&
352 is_racy_stat(istate, &ce->ce_stat_data));
355 int match_stat_data_racy(const struct index_state *istate,
356 const struct stat_data *sd, struct stat *st)
358 if (is_racy_stat(istate, sd))
359 return MTIME_CHANGED;
360 return match_stat_data(sd, st);
363 int ie_match_stat(struct index_state *istate,
364 const struct cache_entry *ce, struct stat *st,
365 unsigned int options)
367 unsigned int changed;
368 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
369 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
370 int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
371 int ignore_fsmonitor = options & CE_MATCH_IGNORE_FSMONITOR;
373 if (!ignore_fsmonitor)
374 refresh_fsmonitor(istate);
376 * If it's marked as always valid in the index, it's
377 * valid whatever the checked-out copy says.
379 * skip-worktree has the same effect with higher precedence
381 if (!ignore_skip_worktree && ce_skip_worktree(ce))
382 return 0;
383 if (!ignore_valid && (ce->ce_flags & CE_VALID))
384 return 0;
385 if (!ignore_fsmonitor && (ce->ce_flags & CE_FSMONITOR_VALID))
386 return 0;
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.
393 if (ce_intent_to_add(ce))
394 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
396 changed = ce_match_stat_basic(ce, st);
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.
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
412 * carefully than others.
414 if (!changed && is_racy_timestamp(istate, ce)) {
415 if (assume_racy_is_modified)
416 changed |= DATA_CHANGED;
417 else
418 changed |= ce_modified_check_fs(istate, ce, st);
421 return changed;
424 int ie_modified(struct index_state *istate,
425 const struct cache_entry *ce,
426 struct stat *st, unsigned int options)
428 int changed, changed_fs;
430 changed = ie_match_stat(istate, ce, st, options);
431 if (!changed)
432 return 0;
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
437 if (changed & (MODE_CHANGED | TYPE_CHANGED))
438 return changed;
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".
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.
454 if ((changed & DATA_CHANGED) &&
455 (S_ISGITLINK(ce->ce_mode) || ce->ce_stat_data.sd_size != 0))
456 return changed;
458 changed_fs = ce_modified_check_fs(istate, ce, st);
459 if (changed_fs)
460 return changed | changed_fs;
461 return 0;
464 int base_name_compare(const char *name1, int len1, int mode1,
465 const char *name2, int len2, int mode2)
467 unsigned char c1, c2;
468 int len = len1 < len2 ? len1 : len2;
469 int cmp;
471 cmp = memcmp(name1, name2, len);
472 if (cmp)
473 return cmp;
474 c1 = name1[len];
475 c2 = name2[len];
476 if (!c1 && S_ISDIR(mode1))
477 c1 = '/';
478 if (!c2 && S_ISDIR(mode2))
479 c2 = '/';
480 return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
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' < '.' < '/').
490 * This is used by routines that want to traverse the git namespace
491 * but then handle conflicting entries together when possible.
493 int df_name_compare(const char *name1, int len1, int mode1,
494 const char *name2, int len2, int mode2)
496 int len = len1 < len2 ? len1 : len2, cmp;
497 unsigned char c1, c2;
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;
518 int name_compare(const char *name1, size_t len1, const char *name2, size_t len2)
520 size_t min_len = (len1 < len2) ? len1 : len2;
521 int cmp = memcmp(name1, name2, min_len);
522 if (cmp)
523 return cmp;
524 if (len1 < len2)
525 return -1;
526 if (len1 > len2)
527 return 1;
528 return 0;
531 int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2)
533 int cmp;
535 cmp = name_compare(name1, len1, name2, len2);
536 if (cmp)
537 return cmp;
539 if (stage1 < stage2)
540 return -1;
541 if (stage1 > stage2)
542 return 1;
543 return 0;
546 static int index_name_stage_pos(const struct index_state *istate, const char *name, int namelen, int stage)
548 int first, last;
550 first = 0;
551 last = istate->cache_nr;
552 while (last > first) {
553 int next = (last + first) >> 1;
554 struct cache_entry *ce = istate->cache[next];
555 int cmp = cache_name_stage_compare(name, namelen, stage, ce->name, ce_namelen(ce), ce_stage(ce));
556 if (!cmp)
557 return next;
558 if (cmp < 0) {
559 last = next;
560 continue;
562 first = next+1;
564 return -first-1;
567 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
569 return index_name_stage_pos(istate, name, namelen, 0);
572 int remove_index_entry_at(struct index_state *istate, int pos)
574 struct cache_entry *ce = istate->cache[pos];
576 record_resolve_undo(istate, ce);
577 remove_name_hash(istate, ce);
578 save_or_free_index_entry(istate, ce);
579 istate->cache_changed |= CE_ENTRY_REMOVED;
580 istate->cache_nr--;
581 if (pos >= istate->cache_nr)
582 return 0;
583 MOVE_ARRAY(istate->cache + pos, istate->cache + pos + 1,
584 istate->cache_nr - pos);
585 return 1;
589 * Remove all cache entries marked for removal, that is where
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.
593 void remove_marked_cache_entries(struct index_state *istate)
595 struct cache_entry **ce_array = istate->cache;
596 unsigned int i, j;
598 for (i = j = 0; i < istate->cache_nr; i++) {
599 if (ce_array[i]->ce_flags & CE_REMOVE) {
600 remove_name_hash(istate, ce_array[i]);
601 save_or_free_index_entry(istate, ce_array[i]);
603 else
604 ce_array[j++] = ce_array[i];
606 if (j == istate->cache_nr)
607 return;
608 istate->cache_changed |= CE_ENTRY_REMOVED;
609 istate->cache_nr = j;
612 int remove_file_from_index(struct index_state *istate, const char *path)
614 int pos = index_name_pos(istate, path, strlen(path));
615 if (pos < 0)
616 pos = -pos-1;
617 cache_tree_invalidate_path(istate, path);
618 untracked_cache_remove_from_index(istate, path);
619 while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
620 remove_index_entry_at(istate, pos);
621 return 0;
624 static int compare_name(struct cache_entry *ce, const char *path, int namelen)
626 return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
629 static int index_name_pos_also_unmerged(struct index_state *istate,
630 const char *path, int namelen)
632 int pos = index_name_pos(istate, path, namelen);
633 struct cache_entry *ce;
635 if (pos >= 0)
636 return pos;
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;
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;
652 static int different_name(struct cache_entry *ce, struct cache_entry *alias)
654 int len = ce_namelen(ce);
655 return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
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!
664 * So we use the CE_ADDED flag to verify that the alias was an old
665 * one before we accept it as
667 static struct cache_entry *create_alias_ce(struct index_state *istate,
668 struct cache_entry *ce,
669 struct cache_entry *alias)
671 int len;
672 struct cache_entry *new_entry;
674 if (alias->ce_flags & CE_ADDED)
675 die("Will not add file alias '%s' ('%s' already exists in index)", ce->name, alias->name);
677 /* Ok, create the new entry using the name of the existing alias */
678 len = ce_namelen(alias);
679 new_entry = make_empty_cache_entry(istate, len);
680 memcpy(new_entry->name, alias->name, len);
681 copy_cache_entry(new_entry, ce);
682 save_or_free_index_entry(istate, ce);
683 return new_entry;
686 void set_object_name_for_intent_to_add_entry(struct cache_entry *ce)
688 struct object_id oid;
689 if (write_object_file("", 0, blob_type, &oid))
690 die("cannot create an empty blob in the object database");
691 oidcpy(&ce->oid, &oid);
694 int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
696 int namelen, was_same;
697 mode_t st_mode = st->st_mode;
698 struct cache_entry *ce, *alias = NULL;
699 unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
700 int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
701 int pretend = flags & ADD_CACHE_PRETEND;
702 int intent_only = flags & ADD_CACHE_INTENT;
703 int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
704 (intent_only ? ADD_CACHE_NEW_ONLY : 0));
705 int newflags = HASH_WRITE_OBJECT;
707 if (flags & HASH_RENORMALIZE)
708 newflags |= HASH_RENORMALIZE;
710 if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
711 return error("%s: can only add regular files, symbolic links or git-directories", path);
713 namelen = strlen(path);
714 if (S_ISDIR(st_mode)) {
715 while (namelen && path[namelen-1] == '/')
716 namelen--;
718 ce = make_empty_cache_entry(istate, namelen);
719 memcpy(ce->name, path, namelen);
720 ce->ce_namelen = namelen;
721 if (!intent_only)
722 fill_stat_cache_info(ce, st);
723 else
724 ce->ce_flags |= CE_INTENT_TO_ADD;
727 if (trust_executable_bit && has_symlinks) {
728 ce->ce_mode = create_ce_mode(st_mode);
729 } else {
730 /* If there is an existing entry, pick the mode bits and type
731 * from it, otherwise assume unexecutable regular file.
733 struct cache_entry *ent;
734 int pos = index_name_pos_also_unmerged(istate, path, namelen);
736 ent = (0 <= pos) ? istate->cache[pos] : NULL;
737 ce->ce_mode = ce_mode_from_stat(ent, st_mode);
740 /* When core.ignorecase=true, determine if a directory of the same name but differing
741 * case already exists within the Git repository. If it does, ensure the directory
742 * case of the file being added to the repository matches (is folded into) the existing
743 * entry's directory case.
745 if (ignore_case) {
746 adjust_dirname_case(istate, ce->name);
748 if (!(flags & HASH_RENORMALIZE)) {
749 alias = index_file_exists(istate, ce->name,
750 ce_namelen(ce), ignore_case);
751 if (alias &&
752 !ce_stage(alias) &&
753 !ie_match_stat(istate, alias, st, ce_option)) {
754 /* Nothing changed, really */
755 if (!S_ISGITLINK(alias->ce_mode))
756 ce_mark_uptodate(alias);
757 alias->ce_flags |= CE_ADDED;
759 discard_cache_entry(ce);
760 return 0;
763 if (!intent_only) {
764 if (index_path(istate, &ce->oid, path, st, newflags)) {
765 discard_cache_entry(ce);
766 return error("unable to index file %s", path);
768 } else
769 set_object_name_for_intent_to_add_entry(ce);
771 if (ignore_case && alias && different_name(ce, alias))
772 ce = create_alias_ce(istate, ce, alias);
773 ce->ce_flags |= CE_ADDED;
775 /* It was suspected to be racily clean, but it turns out to be Ok */
776 was_same = (alias &&
777 !ce_stage(alias) &&
778 oideq(&alias->oid, &ce->oid) &&
779 ce->ce_mode == alias->ce_mode);
781 if (pretend)
782 discard_cache_entry(ce);
783 else if (add_index_entry(istate, ce, add_option)) {
784 discard_cache_entry(ce);
785 return error("unable to add %s to index", path);
787 if (verbose && !was_same)
788 printf("add '%s'\n", path);
789 return 0;
792 int add_file_to_index(struct index_state *istate, const char *path, int flags)
794 struct stat st;
795 if (lstat(path, &st))
796 die_errno("unable to stat '%s'", path);
797 return add_to_index(istate, path, &st, flags);
800 struct cache_entry *make_empty_cache_entry(struct index_state *istate, size_t len)
802 return mem_pool__ce_calloc(find_mem_pool(istate), len);
805 struct cache_entry *make_empty_transient_cache_entry(size_t len)
807 return xcalloc(1, cache_entry_size(len));
810 struct cache_entry *make_cache_entry(struct index_state *istate,
811 unsigned int mode,
812 const struct object_id *oid,
813 const char *path,
814 int stage,
815 unsigned int refresh_options)
817 struct cache_entry *ce, *ret;
818 int len;
820 if (!verify_path(path, mode)) {
821 error("Invalid path '%s'", path);
822 return NULL;
825 len = strlen(path);
826 ce = make_empty_cache_entry(istate, len);
828 oidcpy(&ce->oid, oid);
829 memcpy(ce->name, path, len);
830 ce->ce_flags = create_ce_flags(stage);
831 ce->ce_namelen = len;
832 ce->ce_mode = create_ce_mode(mode);
834 ret = refresh_cache_entry(istate, ce, refresh_options);
835 if (ret != ce)
836 discard_cache_entry(ce);
837 return ret;
840 struct cache_entry *make_transient_cache_entry(unsigned int mode, const struct object_id *oid,
841 const char *path, int stage)
843 struct cache_entry *ce;
844 int len;
846 if (!verify_path(path, mode)) {
847 error("Invalid path '%s'", path);
848 return NULL;
851 len = strlen(path);
852 ce = make_empty_transient_cache_entry(len);
854 oidcpy(&ce->oid, oid);
855 memcpy(ce->name, path, len);
856 ce->ce_flags = create_ce_flags(stage);
857 ce->ce_namelen = len;
858 ce->ce_mode = create_ce_mode(mode);
860 return ce;
864 * Chmod an index entry with either +x or -x.
866 * Returns -1 if the chmod for the particular cache entry failed (if it's
867 * not a regular file), -2 if an invalid flip argument is passed in, 0
868 * otherwise.
870 int chmod_index_entry(struct index_state *istate, struct cache_entry *ce,
871 char flip)
873 if (!S_ISREG(ce->ce_mode))
874 return -1;
875 switch (flip) {
876 case '+':
877 ce->ce_mode |= 0111;
878 break;
879 case '-':
880 ce->ce_mode &= ~0111;
881 break;
882 default:
883 return -2;
885 cache_tree_invalidate_path(istate, ce->name);
886 ce->ce_flags |= CE_UPDATE_IN_BASE;
887 mark_fsmonitor_invalid(istate, ce);
888 istate->cache_changed |= CE_ENTRY_CHANGED;
890 return 0;
893 int ce_same_name(const struct cache_entry *a, const struct cache_entry *b)
895 int len = ce_namelen(a);
896 return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
900 * We fundamentally don't like some paths: we don't want
901 * dot or dot-dot anywhere, and for obvious reasons don't
902 * want to recurse into ".git" either.
904 * Also, we don't want double slashes or slashes at the
905 * end that can make pathnames ambiguous.
907 static int verify_dotfile(const char *rest, unsigned mode)
910 * The first character was '.', but that
911 * has already been discarded, we now test
912 * the rest.
915 /* "." is not allowed */
916 if (*rest == '\0' || is_dir_sep(*rest))
917 return 0;
919 switch (*rest) {
921 * ".git" followed by NUL or slash is bad. Note that we match
922 * case-insensitively here, even if ignore_case is not set.
923 * This outlaws ".GIT" everywhere out of an abundance of caution,
924 * since there's really no good reason to allow it.
926 * Once we've seen ".git", we can also find ".gitmodules", etc (also
927 * case-insensitively).
929 case 'g':
930 case 'G':
931 if (rest[1] != 'i' && rest[1] != 'I')
932 break;
933 if (rest[2] != 't' && rest[2] != 'T')
934 break;
935 if (rest[3] == '\0' || is_dir_sep(rest[3]))
936 return 0;
937 if (S_ISLNK(mode)) {
938 rest += 3;
939 if (skip_iprefix(rest, "modules", &rest) &&
940 (*rest == '\0' || is_dir_sep(*rest)))
941 return 0;
943 break;
944 case '.':
945 if (rest[1] == '\0' || is_dir_sep(rest[1]))
946 return 0;
948 return 1;
951 int verify_path(const char *path, unsigned mode)
953 char c;
955 if (has_dos_drive_prefix(path))
956 return 0;
958 goto inside;
959 for (;;) {
960 if (!c)
961 return 1;
962 if (is_dir_sep(c)) {
963 inside:
964 if (protect_hfs) {
965 if (is_hfs_dotgit(path))
966 return 0;
967 if (S_ISLNK(mode)) {
968 if (is_hfs_dotgitmodules(path))
969 return 0;
972 if (protect_ntfs) {
973 if (is_ntfs_dotgit(path))
974 return 0;
975 if (S_ISLNK(mode)) {
976 if (is_ntfs_dotgitmodules(path))
977 return 0;
981 c = *path++;
982 if ((c == '.' && !verify_dotfile(path, mode)) ||
983 is_dir_sep(c) || c == '\0')
984 return 0;
986 c = *path++;
991 * Do we have another file that has the beginning components being a
992 * proper superset of the name we're trying to add?
994 static int has_file_name(struct index_state *istate,
995 const struct cache_entry *ce, int pos, int ok_to_replace)
997 int retval = 0;
998 int len = ce_namelen(ce);
999 int stage = ce_stage(ce);
1000 const char *name = ce->name;
1002 while (pos < istate->cache_nr) {
1003 struct cache_entry *p = istate->cache[pos++];
1005 if (len >= ce_namelen(p))
1006 break;
1007 if (memcmp(name, p->name, len))
1008 break;
1009 if (ce_stage(p) != stage)
1010 continue;
1011 if (p->name[len] != '/')
1012 continue;
1013 if (p->ce_flags & CE_REMOVE)
1014 continue;
1015 retval = -1;
1016 if (!ok_to_replace)
1017 break;
1018 remove_index_entry_at(istate, --pos);
1020 return retval;
1025 * Like strcmp(), but also return the offset of the first change.
1026 * If strings are equal, return the length.
1028 int strcmp_offset(const char *s1, const char *s2, size_t *first_change)
1030 size_t k;
1032 if (!first_change)
1033 return strcmp(s1, s2);
1035 for (k = 0; s1[k] == s2[k]; k++)
1036 if (s1[k] == '\0')
1037 break;
1039 *first_change = k;
1040 return (unsigned char)s1[k] - (unsigned char)s2[k];
1044 * Do we have another file with a pathname that is a proper
1045 * subset of the name we're trying to add?
1047 * That is, is there another file in the index with a path
1048 * that matches a sub-directory in the given entry?
1050 static int has_dir_name(struct index_state *istate,
1051 const struct cache_entry *ce, int pos, int ok_to_replace)
1053 int retval = 0;
1054 int stage = ce_stage(ce);
1055 const char *name = ce->name;
1056 const char *slash = name + ce_namelen(ce);
1057 size_t len_eq_last;
1058 int cmp_last = 0;
1061 * We are frequently called during an iteration on a sorted
1062 * list of pathnames and while building a new index. Therefore,
1063 * there is a high probability that this entry will eventually
1064 * be appended to the index, rather than inserted in the middle.
1065 * If we can confirm that, we can avoid binary searches on the
1066 * components of the pathname.
1068 * Compare the entry's full path with the last path in the index.
1070 if (istate->cache_nr > 0) {
1071 cmp_last = strcmp_offset(name,
1072 istate->cache[istate->cache_nr - 1]->name,
1073 &len_eq_last);
1074 if (cmp_last > 0) {
1075 if (len_eq_last == 0) {
1077 * The entry sorts AFTER the last one in the
1078 * index and their paths have no common prefix,
1079 * so there cannot be a F/D conflict.
1081 return retval;
1082 } else {
1084 * The entry sorts AFTER the last one in the
1085 * index, but has a common prefix. Fall through
1086 * to the loop below to disect the entry's path
1087 * and see where the difference is.
1090 } else if (cmp_last == 0) {
1092 * The entry exactly matches the last one in the
1093 * index, but because of multiple stage and CE_REMOVE
1094 * items, we fall through and let the regular search
1095 * code handle it.
1100 for (;;) {
1101 size_t len;
1103 for (;;) {
1104 if (*--slash == '/')
1105 break;
1106 if (slash <= ce->name)
1107 return retval;
1109 len = slash - name;
1111 if (cmp_last > 0) {
1113 * (len + 1) is a directory boundary (including
1114 * the trailing slash). And since the loop is
1115 * decrementing "slash", the first iteration is
1116 * the longest directory prefix; subsequent
1117 * iterations consider parent directories.
1120 if (len + 1 <= len_eq_last) {
1122 * The directory prefix (including the trailing
1123 * slash) also appears as a prefix in the last
1124 * entry, so the remainder cannot collide (because
1125 * strcmp said the whole path was greater).
1127 * EQ: last: xxx/A
1128 * this: xxx/B
1130 * LT: last: xxx/file_A
1131 * this: xxx/file_B
1133 return retval;
1136 if (len > len_eq_last) {
1138 * This part of the directory prefix (excluding
1139 * the trailing slash) is longer than the known
1140 * equal portions, so this sub-directory cannot
1141 * collide with a file.
1143 * GT: last: xxxA
1144 * this: xxxB/file
1146 return retval;
1149 if (istate->cache_nr > 0 &&
1150 ce_namelen(istate->cache[istate->cache_nr - 1]) > len) {
1152 * The directory prefix lines up with part of
1153 * a longer file or directory name, but sorts
1154 * after it, so this sub-directory cannot
1155 * collide with a file.
1157 * last: xxx/yy-file (because '-' sorts before '/')
1158 * this: xxx/yy/abc
1160 return retval;
1164 * This is a possible collision. Fall through and
1165 * let the regular search code handle it.
1167 * last: xxx
1168 * this: xxx/file
1172 pos = index_name_stage_pos(istate, name, len, stage);
1173 if (pos >= 0) {
1175 * Found one, but not so fast. This could
1176 * be a marker that says "I was here, but
1177 * I am being removed". Such an entry is
1178 * not a part of the resulting tree, and
1179 * it is Ok to have a directory at the same
1180 * path.
1182 if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
1183 retval = -1;
1184 if (!ok_to_replace)
1185 break;
1186 remove_index_entry_at(istate, pos);
1187 continue;
1190 else
1191 pos = -pos-1;
1194 * Trivial optimization: if we find an entry that
1195 * already matches the sub-directory, then we know
1196 * we're ok, and we can exit.
1198 while (pos < istate->cache_nr) {
1199 struct cache_entry *p = istate->cache[pos];
1200 if ((ce_namelen(p) <= len) ||
1201 (p->name[len] != '/') ||
1202 memcmp(p->name, name, len))
1203 break; /* not our subdirectory */
1204 if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
1206 * p is at the same stage as our entry, and
1207 * is a subdirectory of what we are looking
1208 * at, so we cannot have conflicts at our
1209 * level or anything shorter.
1211 return retval;
1212 pos++;
1215 return retval;
1218 /* We may be in a situation where we already have path/file and path
1219 * is being added, or we already have path and path/file is being
1220 * added. Either one would result in a nonsense tree that has path
1221 * twice when git-write-tree tries to write it out. Prevent it.
1223 * If ok-to-replace is specified, we remove the conflicting entries
1224 * from the cache so the caller should recompute the insert position.
1225 * When this happens, we return non-zero.
1227 static int check_file_directory_conflict(struct index_state *istate,
1228 const struct cache_entry *ce,
1229 int pos, int ok_to_replace)
1231 int retval;
1234 * When ce is an "I am going away" entry, we allow it to be added
1236 if (ce->ce_flags & CE_REMOVE)
1237 return 0;
1240 * We check if the path is a sub-path of a subsequent pathname
1241 * first, since removing those will not change the position
1242 * in the array.
1244 retval = has_file_name(istate, ce, pos, ok_to_replace);
1247 * Then check if the path might have a clashing sub-directory
1248 * before it.
1250 return retval + has_dir_name(istate, ce, pos, ok_to_replace);
1253 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
1255 int pos;
1256 int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
1257 int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
1258 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
1259 int new_only = option & ADD_CACHE_NEW_ONLY;
1261 if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1262 cache_tree_invalidate_path(istate, ce->name);
1265 * If this entry's path sorts after the last entry in the index,
1266 * we can avoid searching for it.
1268 if (istate->cache_nr > 0 &&
1269 strcmp(ce->name, istate->cache[istate->cache_nr - 1]->name) > 0)
1270 pos = -istate->cache_nr - 1;
1271 else
1272 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1274 /* existing match? Just replace it. */
1275 if (pos >= 0) {
1276 if (!new_only)
1277 replace_index_entry(istate, pos, ce);
1278 return 0;
1280 pos = -pos-1;
1282 if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1283 untracked_cache_add_to_index(istate, ce->name);
1286 * Inserting a merged entry ("stage 0") into the index
1287 * will always replace all non-merged entries..
1289 if (pos < istate->cache_nr && ce_stage(ce) == 0) {
1290 while (ce_same_name(istate->cache[pos], ce)) {
1291 ok_to_add = 1;
1292 if (!remove_index_entry_at(istate, pos))
1293 break;
1297 if (!ok_to_add)
1298 return -1;
1299 if (!verify_path(ce->name, ce->ce_mode))
1300 return error("Invalid path '%s'", ce->name);
1302 if (!skip_df_check &&
1303 check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
1304 if (!ok_to_replace)
1305 return error("'%s' appears as both a file and as a directory",
1306 ce->name);
1307 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1308 pos = -pos-1;
1310 return pos + 1;
1313 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
1315 int pos;
1317 if (option & ADD_CACHE_JUST_APPEND)
1318 pos = istate->cache_nr;
1319 else {
1320 int ret;
1321 ret = add_index_entry_with_check(istate, ce, option);
1322 if (ret <= 0)
1323 return ret;
1324 pos = ret - 1;
1327 /* Make sure the array is big enough .. */
1328 ALLOC_GROW(istate->cache, istate->cache_nr + 1, istate->cache_alloc);
1330 /* Add it in.. */
1331 istate->cache_nr++;
1332 if (istate->cache_nr > pos + 1)
1333 MOVE_ARRAY(istate->cache + pos + 1, istate->cache + pos,
1334 istate->cache_nr - pos - 1);
1335 set_index_entry(istate, pos, ce);
1336 istate->cache_changed |= CE_ENTRY_ADDED;
1337 return 0;
1341 * "refresh" does not calculate a new sha1 file or bring the
1342 * cache up-to-date for mode/content changes. But what it
1343 * _does_ do is to "re-match" the stat information of a file
1344 * with the cache, so that you can refresh the cache for a
1345 * file that hasn't been changed but where the stat entry is
1346 * out of date.
1348 * For example, you'd want to do this after doing a "git-read-tree",
1349 * to link up the stat cache details with the proper files.
1351 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1352 struct cache_entry *ce,
1353 unsigned int options, int *err,
1354 int *changed_ret)
1356 struct stat st;
1357 struct cache_entry *updated;
1358 int changed;
1359 int refresh = options & CE_MATCH_REFRESH;
1360 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1361 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1362 int ignore_missing = options & CE_MATCH_IGNORE_MISSING;
1363 int ignore_fsmonitor = options & CE_MATCH_IGNORE_FSMONITOR;
1365 if (!refresh || ce_uptodate(ce))
1366 return ce;
1368 if (!ignore_fsmonitor)
1369 refresh_fsmonitor(istate);
1371 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1372 * that the change to the work tree does not matter and told
1373 * us not to worry.
1375 if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1376 ce_mark_uptodate(ce);
1377 return ce;
1379 if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1380 ce_mark_uptodate(ce);
1381 return ce;
1383 if (!ignore_fsmonitor && (ce->ce_flags & CE_FSMONITOR_VALID)) {
1384 ce_mark_uptodate(ce);
1385 return ce;
1388 if (has_symlink_leading_path(ce->name, ce_namelen(ce))) {
1389 if (ignore_missing)
1390 return ce;
1391 if (err)
1392 *err = ENOENT;
1393 return NULL;
1396 if (lstat(ce->name, &st) < 0) {
1397 if (ignore_missing && errno == ENOENT)
1398 return ce;
1399 if (err)
1400 *err = errno;
1401 return NULL;
1404 changed = ie_match_stat(istate, ce, &st, options);
1405 if (changed_ret)
1406 *changed_ret = changed;
1407 if (!changed) {
1409 * The path is unchanged. If we were told to ignore
1410 * valid bit, then we did the actual stat check and
1411 * found that the entry is unmodified. If the entry
1412 * is not marked VALID, this is the place to mark it
1413 * valid again, under "assume unchanged" mode.
1415 if (ignore_valid && assume_unchanged &&
1416 !(ce->ce_flags & CE_VALID))
1417 ; /* mark this one VALID again */
1418 else {
1420 * We do not mark the index itself "modified"
1421 * because CE_UPTODATE flag is in-core only;
1422 * we are not going to write this change out.
1424 if (!S_ISGITLINK(ce->ce_mode)) {
1425 ce_mark_uptodate(ce);
1426 mark_fsmonitor_valid(ce);
1428 return ce;
1432 if (ie_modified(istate, ce, &st, options)) {
1433 if (err)
1434 *err = EINVAL;
1435 return NULL;
1438 updated = make_empty_cache_entry(istate, ce_namelen(ce));
1439 copy_cache_entry(updated, ce);
1440 memcpy(updated->name, ce->name, ce->ce_namelen + 1);
1441 fill_stat_cache_info(updated, &st);
1443 * If ignore_valid is not set, we should leave CE_VALID bit
1444 * alone. Otherwise, paths marked with --no-assume-unchanged
1445 * (i.e. things to be edited) will reacquire CE_VALID bit
1446 * automatically, which is not really what we want.
1448 if (!ignore_valid && assume_unchanged &&
1449 !(ce->ce_flags & CE_VALID))
1450 updated->ce_flags &= ~CE_VALID;
1452 /* istate->cache_changed is updated in the caller */
1453 return updated;
1456 static void show_file(const char * fmt, const char * name, int in_porcelain,
1457 int * first, const char *header_msg)
1459 if (in_porcelain && *first && header_msg) {
1460 printf("%s\n", header_msg);
1461 *first = 0;
1463 printf(fmt, name);
1466 int refresh_index(struct index_state *istate, unsigned int flags,
1467 const struct pathspec *pathspec,
1468 char *seen, const char *header_msg)
1470 int i;
1471 int has_errors = 0;
1472 int really = (flags & REFRESH_REALLY) != 0;
1473 int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1474 int quiet = (flags & REFRESH_QUIET) != 0;
1475 int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1476 int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1477 int first = 1;
1478 int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1479 unsigned int options = (CE_MATCH_REFRESH |
1480 (really ? CE_MATCH_IGNORE_VALID : 0) |
1481 (not_new ? CE_MATCH_IGNORE_MISSING : 0));
1482 const char *modified_fmt;
1483 const char *deleted_fmt;
1484 const char *typechange_fmt;
1485 const char *added_fmt;
1486 const char *unmerged_fmt;
1487 struct progress *progress = NULL;
1489 if (flags & REFRESH_PROGRESS && isatty(2))
1490 progress = start_delayed_progress(_("Refresh index"),
1491 istate->cache_nr);
1493 trace_performance_enter();
1494 modified_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1495 deleted_fmt = (in_porcelain ? "D\t%s\n" : "%s: needs update\n");
1496 typechange_fmt = (in_porcelain ? "T\t%s\n" : "%s needs update\n");
1497 added_fmt = (in_porcelain ? "A\t%s\n" : "%s needs update\n");
1498 unmerged_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1500 * Use the multi-threaded preload_index() to refresh most of the
1501 * cache entries quickly then in the single threaded loop below,
1502 * we only have to do the special cases that are left.
1504 preload_index(istate, pathspec, 0);
1505 for (i = 0; i < istate->cache_nr; i++) {
1506 struct cache_entry *ce, *new_entry;
1507 int cache_errno = 0;
1508 int changed = 0;
1509 int filtered = 0;
1511 ce = istate->cache[i];
1512 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1513 continue;
1515 if (pathspec && !ce_path_match(istate, ce, pathspec, seen))
1516 filtered = 1;
1518 if (ce_stage(ce)) {
1519 while ((i < istate->cache_nr) &&
1520 ! strcmp(istate->cache[i]->name, ce->name))
1521 i++;
1522 i--;
1523 if (allow_unmerged)
1524 continue;
1525 if (!filtered)
1526 show_file(unmerged_fmt, ce->name, in_porcelain,
1527 &first, header_msg);
1528 has_errors = 1;
1529 continue;
1532 if (filtered)
1533 continue;
1535 new_entry = refresh_cache_ent(istate, ce, options, &cache_errno, &changed);
1536 if (new_entry == ce)
1537 continue;
1538 if (progress)
1539 display_progress(progress, i);
1540 if (!new_entry) {
1541 const char *fmt;
1543 if (really && cache_errno == EINVAL) {
1544 /* If we are doing --really-refresh that
1545 * means the index is not valid anymore.
1547 ce->ce_flags &= ~CE_VALID;
1548 ce->ce_flags |= CE_UPDATE_IN_BASE;
1549 mark_fsmonitor_invalid(istate, ce);
1550 istate->cache_changed |= CE_ENTRY_CHANGED;
1552 if (quiet)
1553 continue;
1555 if (cache_errno == ENOENT)
1556 fmt = deleted_fmt;
1557 else if (ce_intent_to_add(ce))
1558 fmt = added_fmt; /* must be before other checks */
1559 else if (changed & TYPE_CHANGED)
1560 fmt = typechange_fmt;
1561 else
1562 fmt = modified_fmt;
1563 show_file(fmt,
1564 ce->name, in_porcelain, &first, header_msg);
1565 has_errors = 1;
1566 continue;
1569 replace_index_entry(istate, i, new_entry);
1571 if (progress) {
1572 display_progress(progress, istate->cache_nr);
1573 stop_progress(&progress);
1575 trace_performance_leave("refresh index");
1576 return has_errors;
1579 struct cache_entry *refresh_cache_entry(struct index_state *istate,
1580 struct cache_entry *ce,
1581 unsigned int options)
1583 return refresh_cache_ent(istate, ce, options, NULL, NULL);
1587 /*****************************************************************
1588 * Index File I/O
1589 *****************************************************************/
1591 #define INDEX_FORMAT_DEFAULT 3
1593 static unsigned int get_index_format_default(void)
1595 char *envversion = getenv("GIT_INDEX_VERSION");
1596 char *endp;
1597 int value;
1598 unsigned int version = INDEX_FORMAT_DEFAULT;
1600 if (!envversion) {
1601 if (!git_config_get_int("index.version", &value))
1602 version = value;
1603 if (version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1604 warning(_("index.version set, but the value is invalid.\n"
1605 "Using version %i"), INDEX_FORMAT_DEFAULT);
1606 return INDEX_FORMAT_DEFAULT;
1608 return version;
1611 version = strtoul(envversion, &endp, 10);
1612 if (*endp ||
1613 version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1614 warning(_("GIT_INDEX_VERSION set, but the value is invalid.\n"
1615 "Using version %i"), INDEX_FORMAT_DEFAULT);
1616 version = INDEX_FORMAT_DEFAULT;
1618 return version;
1622 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1623 * Again - this is just a (very strong in practice) heuristic that
1624 * the inode hasn't changed.
1626 * We save the fields in big-endian order to allow using the
1627 * index file over NFS transparently.
1629 struct ondisk_cache_entry {
1630 struct cache_time ctime;
1631 struct cache_time mtime;
1632 uint32_t dev;
1633 uint32_t ino;
1634 uint32_t mode;
1635 uint32_t uid;
1636 uint32_t gid;
1637 uint32_t size;
1638 unsigned char sha1[20];
1639 uint16_t flags;
1640 char name[FLEX_ARRAY]; /* more */
1644 * This struct is used when CE_EXTENDED bit is 1
1645 * The struct must match ondisk_cache_entry exactly from
1646 * ctime till flags
1648 struct ondisk_cache_entry_extended {
1649 struct cache_time ctime;
1650 struct cache_time mtime;
1651 uint32_t dev;
1652 uint32_t ino;
1653 uint32_t mode;
1654 uint32_t uid;
1655 uint32_t gid;
1656 uint32_t size;
1657 unsigned char sha1[20];
1658 uint16_t flags;
1659 uint16_t flags2;
1660 char name[FLEX_ARRAY]; /* more */
1663 /* These are only used for v3 or lower */
1664 #define align_padding_size(size, len) ((size + (len) + 8) & ~7) - (size + len)
1665 #define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
1666 #define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1667 #define ondisk_cache_entry_extended_size(len) align_flex_name(ondisk_cache_entry_extended,len)
1668 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
1669 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
1670 ondisk_cache_entry_size(ce_namelen(ce)))
1672 /* Allow fsck to force verification of the index checksum. */
1673 int verify_index_checksum;
1675 /* Allow fsck to force verification of the cache entry order. */
1676 int verify_ce_order;
1678 static int verify_hdr(const struct cache_header *hdr, unsigned long size)
1680 git_hash_ctx c;
1681 unsigned char hash[GIT_MAX_RAWSZ];
1682 int hdr_version;
1684 if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1685 return error("bad signature");
1686 hdr_version = ntohl(hdr->hdr_version);
1687 if (hdr_version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < hdr_version)
1688 return error("bad index version %d", hdr_version);
1690 if (!verify_index_checksum)
1691 return 0;
1693 the_hash_algo->init_fn(&c);
1694 the_hash_algo->update_fn(&c, hdr, size - the_hash_algo->rawsz);
1695 the_hash_algo->final_fn(hash, &c);
1696 if (!hasheq(hash, (unsigned char *)hdr + size - the_hash_algo->rawsz))
1697 return error("bad index file sha1 signature");
1698 return 0;
1701 static int read_index_extension(struct index_state *istate,
1702 const char *ext, const char *data, unsigned long sz)
1704 switch (CACHE_EXT(ext)) {
1705 case CACHE_EXT_TREE:
1706 istate->cache_tree = cache_tree_read(data, sz);
1707 break;
1708 case CACHE_EXT_RESOLVE_UNDO:
1709 istate->resolve_undo = resolve_undo_read(data, sz);
1710 break;
1711 case CACHE_EXT_LINK:
1712 if (read_link_extension(istate, data, sz))
1713 return -1;
1714 break;
1715 case CACHE_EXT_UNTRACKED:
1716 istate->untracked = read_untracked_extension(data, sz);
1717 break;
1718 case CACHE_EXT_FSMONITOR:
1719 read_fsmonitor_extension(istate, data, sz);
1720 break;
1721 case CACHE_EXT_ENDOFINDEXENTRIES:
1722 case CACHE_EXT_INDEXENTRYOFFSETTABLE:
1723 /* already handled in do_read_index() */
1724 break;
1725 default:
1726 if (*ext < 'A' || 'Z' < *ext)
1727 return error("index uses %.4s extension, which we do not understand",
1728 ext);
1729 fprintf(stderr, "ignoring %.4s extension\n", ext);
1730 break;
1732 return 0;
1735 int hold_locked_index(struct lock_file *lk, int lock_flags)
1737 return hold_lock_file_for_update(lk, get_index_file(), lock_flags);
1740 int read_index(struct index_state *istate)
1742 return read_index_from(istate, get_index_file(), get_git_dir());
1745 static struct cache_entry *create_from_disk(struct mem_pool *ce_mem_pool,
1746 unsigned int version,
1747 struct ondisk_cache_entry *ondisk,
1748 unsigned long *ent_size,
1749 const struct cache_entry *previous_ce)
1751 struct cache_entry *ce;
1752 size_t len;
1753 const char *name;
1754 unsigned int flags;
1755 size_t copy_len = 0;
1757 * Adjacent cache entries tend to share the leading paths, so it makes
1758 * sense to only store the differences in later entries. In the v4
1759 * on-disk format of the index, each on-disk cache entry stores the
1760 * number of bytes to be stripped from the end of the previous name,
1761 * and the bytes to append to the result, to come up with its name.
1763 int expand_name_field = version == 4;
1765 /* On-disk flags are just 16 bits */
1766 flags = get_be16(&ondisk->flags);
1767 len = flags & CE_NAMEMASK;
1769 if (flags & CE_EXTENDED) {
1770 struct ondisk_cache_entry_extended *ondisk2;
1771 int extended_flags;
1772 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1773 extended_flags = get_be16(&ondisk2->flags2) << 16;
1774 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1775 if (extended_flags & ~CE_EXTENDED_FLAGS)
1776 die("Unknown index entry format %08x", extended_flags);
1777 flags |= extended_flags;
1778 name = ondisk2->name;
1780 else
1781 name = ondisk->name;
1783 if (expand_name_field) {
1784 const unsigned char *cp = (const unsigned char *)name;
1785 size_t strip_len, previous_len;
1787 /* If we're at the begining of a block, ignore the previous name */
1788 strip_len = decode_varint(&cp);
1789 if (previous_ce) {
1790 previous_len = previous_ce->ce_namelen;
1791 if (previous_len < strip_len)
1792 die(_("malformed name field in the index, near path '%s'"),
1793 previous_ce->name);
1794 copy_len = previous_len - strip_len;
1796 name = (const char *)cp;
1799 if (len == CE_NAMEMASK) {
1800 len = strlen(name);
1801 if (expand_name_field)
1802 len += copy_len;
1805 ce = mem_pool__ce_alloc(ce_mem_pool, len);
1807 ce->ce_stat_data.sd_ctime.sec = get_be32(&ondisk->ctime.sec);
1808 ce->ce_stat_data.sd_mtime.sec = get_be32(&ondisk->mtime.sec);
1809 ce->ce_stat_data.sd_ctime.nsec = get_be32(&ondisk->ctime.nsec);
1810 ce->ce_stat_data.sd_mtime.nsec = get_be32(&ondisk->mtime.nsec);
1811 ce->ce_stat_data.sd_dev = get_be32(&ondisk->dev);
1812 ce->ce_stat_data.sd_ino = get_be32(&ondisk->ino);
1813 ce->ce_mode = get_be32(&ondisk->mode);
1814 ce->ce_stat_data.sd_uid = get_be32(&ondisk->uid);
1815 ce->ce_stat_data.sd_gid = get_be32(&ondisk->gid);
1816 ce->ce_stat_data.sd_size = get_be32(&ondisk->size);
1817 ce->ce_flags = flags & ~CE_NAMEMASK;
1818 ce->ce_namelen = len;
1819 ce->index = 0;
1820 hashcpy(ce->oid.hash, ondisk->sha1);
1822 if (expand_name_field) {
1823 if (copy_len)
1824 memcpy(ce->name, previous_ce->name, copy_len);
1825 memcpy(ce->name + copy_len, name, len + 1 - copy_len);
1826 *ent_size = (name - ((char *)ondisk)) + len + 1 - copy_len;
1827 } else {
1828 memcpy(ce->name, name, len + 1);
1829 *ent_size = ondisk_ce_size(ce);
1831 return ce;
1834 static void check_ce_order(struct index_state *istate)
1836 unsigned int i;
1838 if (!verify_ce_order)
1839 return;
1841 for (i = 1; i < istate->cache_nr; i++) {
1842 struct cache_entry *ce = istate->cache[i - 1];
1843 struct cache_entry *next_ce = istate->cache[i];
1844 int name_compare = strcmp(ce->name, next_ce->name);
1846 if (0 < name_compare)
1847 die("unordered stage entries in index");
1848 if (!name_compare) {
1849 if (!ce_stage(ce))
1850 die("multiple stage entries for merged file '%s'",
1851 ce->name);
1852 if (ce_stage(ce) > ce_stage(next_ce))
1853 die("unordered stage entries for '%s'",
1854 ce->name);
1859 static void tweak_untracked_cache(struct index_state *istate)
1861 switch (git_config_get_untracked_cache()) {
1862 case -1: /* keep: do nothing */
1863 break;
1864 case 0: /* false */
1865 remove_untracked_cache(istate);
1866 break;
1867 case 1: /* true */
1868 add_untracked_cache(istate);
1869 break;
1870 default: /* unknown value: do nothing */
1871 break;
1875 static void tweak_split_index(struct index_state *istate)
1877 switch (git_config_get_split_index()) {
1878 case -1: /* unset: do nothing */
1879 break;
1880 case 0: /* false */
1881 remove_split_index(istate);
1882 break;
1883 case 1: /* true */
1884 add_split_index(istate);
1885 break;
1886 default: /* unknown value: do nothing */
1887 break;
1891 static void post_read_index_from(struct index_state *istate)
1893 check_ce_order(istate);
1894 tweak_untracked_cache(istate);
1895 tweak_split_index(istate);
1896 tweak_fsmonitor(istate);
1899 static size_t estimate_cache_size_from_compressed(unsigned int entries)
1901 return entries * (sizeof(struct cache_entry) + CACHE_ENTRY_PATH_LENGTH);
1904 static size_t estimate_cache_size(size_t ondisk_size, unsigned int entries)
1906 long per_entry = sizeof(struct cache_entry) - sizeof(struct ondisk_cache_entry);
1909 * Account for potential alignment differences.
1911 per_entry += align_padding_size(sizeof(struct cache_entry), -sizeof(struct ondisk_cache_entry));
1912 return ondisk_size + entries * per_entry;
1915 struct index_entry_offset
1917 /* starting byte offset into index file, count of index entries in this block */
1918 int offset, nr;
1921 struct index_entry_offset_table
1923 int nr;
1924 struct index_entry_offset entries[FLEX_ARRAY];
1927 static struct index_entry_offset_table *read_ieot_extension(const char *mmap, size_t mmap_size, size_t offset);
1928 static void write_ieot_extension(struct strbuf *sb, struct index_entry_offset_table *ieot);
1930 static size_t read_eoie_extension(const char *mmap, size_t mmap_size);
1931 static void write_eoie_extension(struct strbuf *sb, git_hash_ctx *eoie_context, size_t offset);
1933 struct load_index_extensions
1935 pthread_t pthread;
1936 struct index_state *istate;
1937 const char *mmap;
1938 size_t mmap_size;
1939 unsigned long src_offset;
1942 static void *load_index_extensions(void *_data)
1944 struct load_index_extensions *p = _data;
1945 unsigned long src_offset = p->src_offset;
1947 while (src_offset <= p->mmap_size - the_hash_algo->rawsz - 8) {
1948 /* After an array of active_nr index entries,
1949 * there can be arbitrary number of extended
1950 * sections, each of which is prefixed with
1951 * extension name (4-byte) and section length
1952 * in 4-byte network byte order.
1954 uint32_t extsize = get_be32(p->mmap + src_offset + 4);
1955 if (read_index_extension(p->istate,
1956 p->mmap + src_offset,
1957 p->mmap + src_offset + 8,
1958 extsize) < 0) {
1959 munmap((void *)p->mmap, p->mmap_size);
1960 die(_("index file corrupt"));
1962 src_offset += 8;
1963 src_offset += extsize;
1966 return NULL;
1970 * A helper function that will load the specified range of cache entries
1971 * from the memory mapped file and add them to the given index.
1973 static unsigned long load_cache_entry_block(struct index_state *istate,
1974 struct mem_pool *ce_mem_pool, int offset, int nr, const char *mmap,
1975 unsigned long start_offset, const struct cache_entry *previous_ce)
1977 int i;
1978 unsigned long src_offset = start_offset;
1980 for (i = offset; i < offset + nr; i++) {
1981 struct ondisk_cache_entry *disk_ce;
1982 struct cache_entry *ce;
1983 unsigned long consumed;
1985 disk_ce = (struct ondisk_cache_entry *)(mmap + src_offset);
1986 ce = create_from_disk(ce_mem_pool, istate->version, disk_ce, &consumed, previous_ce);
1987 set_index_entry(istate, i, ce);
1989 src_offset += consumed;
1990 previous_ce = ce;
1992 return src_offset - start_offset;
1995 static unsigned long load_all_cache_entries(struct index_state *istate,
1996 const char *mmap, size_t mmap_size, unsigned long src_offset)
1998 unsigned long consumed;
2000 if (istate->version == 4) {
2001 mem_pool_init(&istate->ce_mem_pool,
2002 estimate_cache_size_from_compressed(istate->cache_nr));
2003 } else {
2004 mem_pool_init(&istate->ce_mem_pool,
2005 estimate_cache_size(mmap_size, istate->cache_nr));
2008 consumed = load_cache_entry_block(istate, istate->ce_mem_pool,
2009 0, istate->cache_nr, mmap, src_offset, NULL);
2010 return consumed;
2014 * Mostly randomly chosen maximum thread counts: we
2015 * cap the parallelism to online_cpus() threads, and we want
2016 * to have at least 10000 cache entries per thread for it to
2017 * be worth starting a thread.
2020 #define THREAD_COST (10000)
2022 struct load_cache_entries_thread_data
2024 pthread_t pthread;
2025 struct index_state *istate;
2026 struct mem_pool *ce_mem_pool;
2027 int offset;
2028 const char *mmap;
2029 struct index_entry_offset_table *ieot;
2030 int ieot_start; /* starting index into the ieot array */
2031 int ieot_blocks; /* count of ieot entries to process */
2032 unsigned long consumed; /* return # of bytes in index file processed */
2036 * A thread proc to run the load_cache_entries() computation
2037 * across multiple background threads.
2039 static void *load_cache_entries_thread(void *_data)
2041 struct load_cache_entries_thread_data *p = _data;
2042 int i;
2044 /* iterate across all ieot blocks assigned to this thread */
2045 for (i = p->ieot_start; i < p->ieot_start + p->ieot_blocks; i++) {
2046 p->consumed += load_cache_entry_block(p->istate, p->ce_mem_pool,
2047 p->offset, p->ieot->entries[i].nr, p->mmap, p->ieot->entries[i].offset, NULL);
2048 p->offset += p->ieot->entries[i].nr;
2050 return NULL;
2053 static unsigned long load_cache_entries_threaded(struct index_state *istate, const char *mmap, size_t mmap_size,
2054 unsigned long src_offset, int nr_threads, struct index_entry_offset_table *ieot)
2056 int i, offset, ieot_blocks, ieot_start, err;
2057 struct load_cache_entries_thread_data *data;
2058 unsigned long consumed = 0;
2060 /* a little sanity checking */
2061 if (istate->name_hash_initialized)
2062 BUG("the name hash isn't thread safe");
2064 mem_pool_init(&istate->ce_mem_pool, 0);
2066 /* ensure we have no more threads than we have blocks to process */
2067 if (nr_threads > ieot->nr)
2068 nr_threads = ieot->nr;
2069 data = xcalloc(nr_threads, sizeof(*data));
2071 offset = ieot_start = 0;
2072 ieot_blocks = DIV_ROUND_UP(ieot->nr, nr_threads);
2073 for (i = 0; i < nr_threads; i++) {
2074 struct load_cache_entries_thread_data *p = &data[i];
2075 int nr, j;
2077 if (ieot_start + ieot_blocks > ieot->nr)
2078 ieot_blocks = ieot->nr - ieot_start;
2080 p->istate = istate;
2081 p->offset = offset;
2082 p->mmap = mmap;
2083 p->ieot = ieot;
2084 p->ieot_start = ieot_start;
2085 p->ieot_blocks = ieot_blocks;
2087 /* create a mem_pool for each thread */
2088 nr = 0;
2089 for (j = p->ieot_start; j < p->ieot_start + p->ieot_blocks; j++)
2090 nr += p->ieot->entries[j].nr;
2091 if (istate->version == 4) {
2092 mem_pool_init(&p->ce_mem_pool,
2093 estimate_cache_size_from_compressed(nr));
2094 } else {
2095 mem_pool_init(&p->ce_mem_pool,
2096 estimate_cache_size(mmap_size, nr));
2099 err = pthread_create(&p->pthread, NULL, load_cache_entries_thread, p);
2100 if (err)
2101 die(_("unable to create load_cache_entries thread: %s"), strerror(err));
2103 /* increment by the number of cache entries in the ieot block being processed */
2104 for (j = 0; j < ieot_blocks; j++)
2105 offset += ieot->entries[ieot_start + j].nr;
2106 ieot_start += ieot_blocks;
2109 for (i = 0; i < nr_threads; i++) {
2110 struct load_cache_entries_thread_data *p = &data[i];
2112 err = pthread_join(p->pthread, NULL);
2113 if (err)
2114 die(_("unable to join load_cache_entries thread: %s"), strerror(err));
2115 mem_pool_combine(istate->ce_mem_pool, p->ce_mem_pool);
2116 consumed += p->consumed;
2119 free(data);
2121 return consumed;
2124 /* remember to discard_cache() before reading a different cache! */
2125 int do_read_index(struct index_state *istate, const char *path, int must_exist)
2127 int fd;
2128 struct stat st;
2129 unsigned long src_offset;
2130 const struct cache_header *hdr;
2131 const char *mmap;
2132 size_t mmap_size;
2133 struct load_index_extensions p;
2134 size_t extension_offset = 0;
2135 int nr_threads, cpus;
2136 struct index_entry_offset_table *ieot = NULL;
2138 if (istate->initialized)
2139 return istate->cache_nr;
2141 istate->timestamp.sec = 0;
2142 istate->timestamp.nsec = 0;
2143 fd = open(path, O_RDONLY);
2144 if (fd < 0) {
2145 if (!must_exist && errno == ENOENT)
2146 return 0;
2147 die_errno("%s: index file open failed", path);
2150 if (fstat(fd, &st))
2151 die_errno("cannot stat the open index");
2153 mmap_size = xsize_t(st.st_size);
2154 if (mmap_size < sizeof(struct cache_header) + the_hash_algo->rawsz)
2155 die("index file smaller than expected");
2157 mmap = xmmap(NULL, mmap_size, PROT_READ, MAP_PRIVATE, fd, 0);
2158 if (mmap == MAP_FAILED)
2159 die_errno("unable to map index file");
2160 close(fd);
2162 hdr = (const struct cache_header *)mmap;
2163 if (verify_hdr(hdr, mmap_size) < 0)
2164 goto unmap;
2166 hashcpy(istate->oid.hash, (const unsigned char *)hdr + mmap_size - the_hash_algo->rawsz);
2167 istate->version = ntohl(hdr->hdr_version);
2168 istate->cache_nr = ntohl(hdr->hdr_entries);
2169 istate->cache_alloc = alloc_nr(istate->cache_nr);
2170 istate->cache = xcalloc(istate->cache_alloc, sizeof(*istate->cache));
2171 istate->initialized = 1;
2173 p.istate = istate;
2174 p.mmap = mmap;
2175 p.mmap_size = mmap_size;
2177 src_offset = sizeof(*hdr);
2179 if (git_config_get_index_threads(&nr_threads))
2180 nr_threads = 1;
2182 /* TODO: does creating more threads than cores help? */
2183 if (!nr_threads) {
2184 nr_threads = istate->cache_nr / THREAD_COST;
2185 cpus = online_cpus();
2186 if (nr_threads > cpus)
2187 nr_threads = cpus;
2190 if (!HAVE_THREADS)
2191 nr_threads = 1;
2193 if (nr_threads > 1) {
2194 extension_offset = read_eoie_extension(mmap, mmap_size);
2195 if (extension_offset) {
2196 int err;
2198 p.src_offset = extension_offset;
2199 err = pthread_create(&p.pthread, NULL, load_index_extensions, &p);
2200 if (err)
2201 die(_("unable to create load_index_extensions thread: %s"), strerror(err));
2203 nr_threads--;
2208 * Locate and read the index entry offset table so that we can use it
2209 * to multi-thread the reading of the cache entries.
2211 if (extension_offset && nr_threads > 1)
2212 ieot = read_ieot_extension(mmap, mmap_size, extension_offset);
2214 if (ieot) {
2215 src_offset += load_cache_entries_threaded(istate, mmap, mmap_size, src_offset, nr_threads, ieot);
2216 free(ieot);
2217 } else {
2218 src_offset += load_all_cache_entries(istate, mmap, mmap_size, src_offset);
2221 istate->timestamp.sec = st.st_mtime;
2222 istate->timestamp.nsec = ST_MTIME_NSEC(st);
2224 /* if we created a thread, join it otherwise load the extensions on the primary thread */
2225 if (extension_offset) {
2226 int ret = pthread_join(p.pthread, NULL);
2227 if (ret)
2228 die(_("unable to join load_index_extensions thread: %s"), strerror(ret));
2229 } else {
2230 p.src_offset = src_offset;
2231 load_index_extensions(&p);
2233 munmap((void *)mmap, mmap_size);
2234 return istate->cache_nr;
2236 unmap:
2237 munmap((void *)mmap, mmap_size);
2238 die("index file corrupt");
2242 * Signal that the shared index is used by updating its mtime.
2244 * This way, shared index can be removed if they have not been used
2245 * for some time.
2247 static void freshen_shared_index(const char *shared_index, int warn)
2249 if (!check_and_freshen_file(shared_index, 1) && warn)
2250 warning("could not freshen shared index '%s'", shared_index);
2253 int read_index_from(struct index_state *istate, const char *path,
2254 const char *gitdir)
2256 struct split_index *split_index;
2257 int ret;
2258 char *base_oid_hex;
2259 char *base_path;
2261 /* istate->initialized covers both .git/index and .git/sharedindex.xxx */
2262 if (istate->initialized)
2263 return istate->cache_nr;
2265 trace_performance_enter();
2266 ret = do_read_index(istate, path, 0);
2267 trace_performance_leave("read cache %s", path);
2269 split_index = istate->split_index;
2270 if (!split_index || is_null_oid(&split_index->base_oid)) {
2271 post_read_index_from(istate);
2272 return ret;
2275 trace_performance_enter();
2276 if (split_index->base)
2277 discard_index(split_index->base);
2278 else
2279 split_index->base = xcalloc(1, sizeof(*split_index->base));
2281 base_oid_hex = oid_to_hex(&split_index->base_oid);
2282 base_path = xstrfmt("%s/sharedindex.%s", gitdir, base_oid_hex);
2283 ret = do_read_index(split_index->base, base_path, 1);
2284 if (!oideq(&split_index->base_oid, &split_index->base->oid))
2285 die("broken index, expect %s in %s, got %s",
2286 base_oid_hex, base_path,
2287 oid_to_hex(&split_index->base->oid));
2289 freshen_shared_index(base_path, 0);
2290 merge_base_index(istate);
2291 post_read_index_from(istate);
2292 trace_performance_leave("read cache %s", base_path);
2293 free(base_path);
2294 return ret;
2297 int is_index_unborn(struct index_state *istate)
2299 return (!istate->cache_nr && !istate->timestamp.sec);
2302 int discard_index(struct index_state *istate)
2305 * Cache entries in istate->cache[] should have been allocated
2306 * from the memory pool associated with this index, or from an
2307 * associated split_index. There is no need to free individual
2308 * cache entries. validate_cache_entries can detect when this
2309 * assertion does not hold.
2311 validate_cache_entries(istate);
2313 resolve_undo_clear_index(istate);
2314 istate->cache_nr = 0;
2315 istate->cache_changed = 0;
2316 istate->timestamp.sec = 0;
2317 istate->timestamp.nsec = 0;
2318 free_name_hash(istate);
2319 cache_tree_free(&(istate->cache_tree));
2320 istate->initialized = 0;
2321 FREE_AND_NULL(istate->cache);
2322 istate->cache_alloc = 0;
2323 discard_split_index(istate);
2324 free_untracked_cache(istate->untracked);
2325 istate->untracked = NULL;
2327 if (istate->ce_mem_pool) {
2328 mem_pool_discard(istate->ce_mem_pool, should_validate_cache_entries());
2329 istate->ce_mem_pool = NULL;
2332 return 0;
2336 * Validate the cache entries of this index.
2337 * All cache entries associated with this index
2338 * should have been allocated by the memory pool
2339 * associated with this index, or by a referenced
2340 * split index.
2342 void validate_cache_entries(const struct index_state *istate)
2344 int i;
2346 if (!should_validate_cache_entries() ||!istate || !istate->initialized)
2347 return;
2349 for (i = 0; i < istate->cache_nr; i++) {
2350 if (!istate) {
2351 die("internal error: cache entry is not allocated from expected memory pool");
2352 } else if (!istate->ce_mem_pool ||
2353 !mem_pool_contains(istate->ce_mem_pool, istate->cache[i])) {
2354 if (!istate->split_index ||
2355 !istate->split_index->base ||
2356 !istate->split_index->base->ce_mem_pool ||
2357 !mem_pool_contains(istate->split_index->base->ce_mem_pool, istate->cache[i])) {
2358 die("internal error: cache entry is not allocated from expected memory pool");
2363 if (istate->split_index)
2364 validate_cache_entries(istate->split_index->base);
2367 int unmerged_index(const struct index_state *istate)
2369 int i;
2370 for (i = 0; i < istate->cache_nr; i++) {
2371 if (ce_stage(istate->cache[i]))
2372 return 1;
2374 return 0;
2377 int index_has_changes(struct index_state *istate,
2378 struct tree *tree,
2379 struct strbuf *sb)
2381 struct object_id cmp;
2382 int i;
2384 if (istate != &the_index) {
2385 BUG("index_has_changes cannot yet accept istate != &the_index; do_diff_cache needs updating first.");
2387 if (tree)
2388 cmp = tree->object.oid;
2389 if (tree || !get_oid_tree("HEAD", &cmp)) {
2390 struct diff_options opt;
2392 repo_diff_setup(the_repository, &opt);
2393 opt.flags.exit_with_status = 1;
2394 if (!sb)
2395 opt.flags.quick = 1;
2396 do_diff_cache(&cmp, &opt);
2397 diffcore_std(&opt);
2398 for (i = 0; sb && i < diff_queued_diff.nr; i++) {
2399 if (i)
2400 strbuf_addch(sb, ' ');
2401 strbuf_addstr(sb, diff_queued_diff.queue[i]->two->path);
2403 diff_flush(&opt);
2404 return opt.flags.has_changes != 0;
2405 } else {
2406 for (i = 0; sb && i < istate->cache_nr; i++) {
2407 if (i)
2408 strbuf_addch(sb, ' ');
2409 strbuf_addstr(sb, istate->cache[i]->name);
2411 return !!istate->cache_nr;
2415 #define WRITE_BUFFER_SIZE 8192
2416 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
2417 static unsigned long write_buffer_len;
2419 static int ce_write_flush(git_hash_ctx *context, int fd)
2421 unsigned int buffered = write_buffer_len;
2422 if (buffered) {
2423 the_hash_algo->update_fn(context, write_buffer, buffered);
2424 if (write_in_full(fd, write_buffer, buffered) < 0)
2425 return -1;
2426 write_buffer_len = 0;
2428 return 0;
2431 static int ce_write(git_hash_ctx *context, int fd, void *data, unsigned int len)
2433 while (len) {
2434 unsigned int buffered = write_buffer_len;
2435 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
2436 if (partial > len)
2437 partial = len;
2438 memcpy(write_buffer + buffered, data, partial);
2439 buffered += partial;
2440 if (buffered == WRITE_BUFFER_SIZE) {
2441 write_buffer_len = buffered;
2442 if (ce_write_flush(context, fd))
2443 return -1;
2444 buffered = 0;
2446 write_buffer_len = buffered;
2447 len -= partial;
2448 data = (char *) data + partial;
2450 return 0;
2453 static int write_index_ext_header(git_hash_ctx *context, git_hash_ctx *eoie_context,
2454 int fd, unsigned int ext, unsigned int sz)
2456 ext = htonl(ext);
2457 sz = htonl(sz);
2458 if (eoie_context) {
2459 the_hash_algo->update_fn(eoie_context, &ext, 4);
2460 the_hash_algo->update_fn(eoie_context, &sz, 4);
2462 return ((ce_write(context, fd, &ext, 4) < 0) ||
2463 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
2466 static int ce_flush(git_hash_ctx *context, int fd, unsigned char *hash)
2468 unsigned int left = write_buffer_len;
2470 if (left) {
2471 write_buffer_len = 0;
2472 the_hash_algo->update_fn(context, write_buffer, left);
2475 /* Flush first if not enough space for hash signature */
2476 if (left + the_hash_algo->rawsz > WRITE_BUFFER_SIZE) {
2477 if (write_in_full(fd, write_buffer, left) < 0)
2478 return -1;
2479 left = 0;
2482 /* Append the hash signature at the end */
2483 the_hash_algo->final_fn(write_buffer + left, context);
2484 hashcpy(hash, write_buffer + left);
2485 left += the_hash_algo->rawsz;
2486 return (write_in_full(fd, write_buffer, left) < 0) ? -1 : 0;
2489 static void ce_smudge_racily_clean_entry(struct index_state *istate,
2490 struct cache_entry *ce)
2493 * The only thing we care about in this function is to smudge the
2494 * falsely clean entry due to touch-update-touch race, so we leave
2495 * everything else as they are. We are called for entries whose
2496 * ce_stat_data.sd_mtime match the index file mtime.
2498 * Note that this actually does not do much for gitlinks, for
2499 * which ce_match_stat_basic() always goes to the actual
2500 * contents. The caller checks with is_racy_timestamp() which
2501 * always says "no" for gitlinks, so we are not called for them ;-)
2503 struct stat st;
2505 if (lstat(ce->name, &st) < 0)
2506 return;
2507 if (ce_match_stat_basic(ce, &st))
2508 return;
2509 if (ce_modified_check_fs(istate, ce, &st)) {
2510 /* This is "racily clean"; smudge it. Note that this
2511 * is a tricky code. At first glance, it may appear
2512 * that it can break with this sequence:
2514 * $ echo xyzzy >frotz
2515 * $ git-update-index --add frotz
2516 * $ : >frotz
2517 * $ sleep 3
2518 * $ echo filfre >nitfol
2519 * $ git-update-index --add nitfol
2521 * but it does not. When the second update-index runs,
2522 * it notices that the entry "frotz" has the same timestamp
2523 * as index, and if we were to smudge it by resetting its
2524 * size to zero here, then the object name recorded
2525 * in index is the 6-byte file but the cached stat information
2526 * becomes zero --- which would then match what we would
2527 * obtain from the filesystem next time we stat("frotz").
2529 * However, the second update-index, before calling
2530 * this function, notices that the cached size is 6
2531 * bytes and what is on the filesystem is an empty
2532 * file, and never calls us, so the cached size information
2533 * for "frotz" stays 6 which does not match the filesystem.
2535 ce->ce_stat_data.sd_size = 0;
2539 /* Copy miscellaneous fields but not the name */
2540 static void copy_cache_entry_to_ondisk(struct ondisk_cache_entry *ondisk,
2541 struct cache_entry *ce)
2543 short flags;
2545 ondisk->ctime.sec = htonl(ce->ce_stat_data.sd_ctime.sec);
2546 ondisk->mtime.sec = htonl(ce->ce_stat_data.sd_mtime.sec);
2547 ondisk->ctime.nsec = htonl(ce->ce_stat_data.sd_ctime.nsec);
2548 ondisk->mtime.nsec = htonl(ce->ce_stat_data.sd_mtime.nsec);
2549 ondisk->dev = htonl(ce->ce_stat_data.sd_dev);
2550 ondisk->ino = htonl(ce->ce_stat_data.sd_ino);
2551 ondisk->mode = htonl(ce->ce_mode);
2552 ondisk->uid = htonl(ce->ce_stat_data.sd_uid);
2553 ondisk->gid = htonl(ce->ce_stat_data.sd_gid);
2554 ondisk->size = htonl(ce->ce_stat_data.sd_size);
2555 hashcpy(ondisk->sha1, ce->oid.hash);
2557 flags = ce->ce_flags & ~CE_NAMEMASK;
2558 flags |= (ce_namelen(ce) >= CE_NAMEMASK ? CE_NAMEMASK : ce_namelen(ce));
2559 ondisk->flags = htons(flags);
2560 if (ce->ce_flags & CE_EXTENDED) {
2561 struct ondisk_cache_entry_extended *ondisk2;
2562 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
2563 ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
2567 static int ce_write_entry(git_hash_ctx *c, int fd, struct cache_entry *ce,
2568 struct strbuf *previous_name, struct ondisk_cache_entry *ondisk)
2570 int size;
2571 int result;
2572 unsigned int saved_namelen;
2573 int stripped_name = 0;
2574 static unsigned char padding[8] = { 0x00 };
2576 if (ce->ce_flags & CE_STRIP_NAME) {
2577 saved_namelen = ce_namelen(ce);
2578 ce->ce_namelen = 0;
2579 stripped_name = 1;
2582 if (ce->ce_flags & CE_EXTENDED)
2583 size = offsetof(struct ondisk_cache_entry_extended, name);
2584 else
2585 size = offsetof(struct ondisk_cache_entry, name);
2587 if (!previous_name) {
2588 int len = ce_namelen(ce);
2589 copy_cache_entry_to_ondisk(ondisk, ce);
2590 result = ce_write(c, fd, ondisk, size);
2591 if (!result)
2592 result = ce_write(c, fd, ce->name, len);
2593 if (!result)
2594 result = ce_write(c, fd, padding, align_padding_size(size, len));
2595 } else {
2596 int common, to_remove, prefix_size;
2597 unsigned char to_remove_vi[16];
2598 for (common = 0;
2599 (ce->name[common] &&
2600 common < previous_name->len &&
2601 ce->name[common] == previous_name->buf[common]);
2602 common++)
2603 ; /* still matching */
2604 to_remove = previous_name->len - common;
2605 prefix_size = encode_varint(to_remove, to_remove_vi);
2607 copy_cache_entry_to_ondisk(ondisk, ce);
2608 result = ce_write(c, fd, ondisk, size);
2609 if (!result)
2610 result = ce_write(c, fd, to_remove_vi, prefix_size);
2611 if (!result)
2612 result = ce_write(c, fd, ce->name + common, ce_namelen(ce) - common);
2613 if (!result)
2614 result = ce_write(c, fd, padding, 1);
2616 strbuf_splice(previous_name, common, to_remove,
2617 ce->name + common, ce_namelen(ce) - common);
2619 if (stripped_name) {
2620 ce->ce_namelen = saved_namelen;
2621 ce->ce_flags &= ~CE_STRIP_NAME;
2624 return result;
2628 * This function verifies if index_state has the correct sha1 of the
2629 * index file. Don't die if we have any other failure, just return 0.
2631 static int verify_index_from(const struct index_state *istate, const char *path)
2633 int fd;
2634 ssize_t n;
2635 struct stat st;
2636 unsigned char hash[GIT_MAX_RAWSZ];
2638 if (!istate->initialized)
2639 return 0;
2641 fd = open(path, O_RDONLY);
2642 if (fd < 0)
2643 return 0;
2645 if (fstat(fd, &st))
2646 goto out;
2648 if (st.st_size < sizeof(struct cache_header) + the_hash_algo->rawsz)
2649 goto out;
2651 n = pread_in_full(fd, hash, the_hash_algo->rawsz, st.st_size - the_hash_algo->rawsz);
2652 if (n != the_hash_algo->rawsz)
2653 goto out;
2655 if (!hasheq(istate->oid.hash, hash))
2656 goto out;
2658 close(fd);
2659 return 1;
2661 out:
2662 close(fd);
2663 return 0;
2666 static int verify_index(const struct index_state *istate)
2668 return verify_index_from(istate, get_index_file());
2671 static int has_racy_timestamp(struct index_state *istate)
2673 int entries = istate->cache_nr;
2674 int i;
2676 for (i = 0; i < entries; i++) {
2677 struct cache_entry *ce = istate->cache[i];
2678 if (is_racy_timestamp(istate, ce))
2679 return 1;
2681 return 0;
2684 void update_index_if_able(struct index_state *istate, struct lock_file *lockfile)
2686 if ((istate->cache_changed || has_racy_timestamp(istate)) &&
2687 verify_index(istate))
2688 write_locked_index(istate, lockfile, COMMIT_LOCK);
2689 else
2690 rollback_lock_file(lockfile);
2693 static int record_eoie(void)
2695 int val;
2697 if (!git_config_get_bool("index.recordendofindexentries", &val))
2698 return val;
2701 * As a convenience, the end of index entries extension
2702 * used for threading is written by default if the user
2703 * explicitly requested threaded index reads.
2705 return !git_config_get_index_threads(&val) && val != 1;
2708 static int record_ieot(void)
2710 int val;
2712 if (!git_config_get_bool("index.recordoffsettable", &val))
2713 return val;
2716 * As a convenience, the offset table used for threading is
2717 * written by default if the user explicitly requested
2718 * threaded index reads.
2720 return !git_config_get_index_threads(&val) && val != 1;
2724 * On success, `tempfile` is closed. If it is the temporary file
2725 * of a `struct lock_file`, we will therefore effectively perform
2726 * a 'close_lock_file_gently()`. Since that is an implementation
2727 * detail of lockfiles, callers of `do_write_index()` should not
2728 * rely on it.
2730 static int do_write_index(struct index_state *istate, struct tempfile *tempfile,
2731 int strip_extensions)
2733 uint64_t start = getnanotime();
2734 int newfd = tempfile->fd;
2735 git_hash_ctx c, eoie_c;
2736 struct cache_header hdr;
2737 int i, err = 0, removed, extended, hdr_version;
2738 struct cache_entry **cache = istate->cache;
2739 int entries = istate->cache_nr;
2740 struct stat st;
2741 struct ondisk_cache_entry_extended ondisk;
2742 struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
2743 int drop_cache_tree = istate->drop_cache_tree;
2744 off_t offset;
2745 int ieot_entries = 1;
2746 struct index_entry_offset_table *ieot = NULL;
2747 int nr, nr_threads;
2749 for (i = removed = extended = 0; i < entries; i++) {
2750 if (cache[i]->ce_flags & CE_REMOVE)
2751 removed++;
2753 /* reduce extended entries if possible */
2754 cache[i]->ce_flags &= ~CE_EXTENDED;
2755 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
2756 extended++;
2757 cache[i]->ce_flags |= CE_EXTENDED;
2761 if (!istate->version) {
2762 istate->version = get_index_format_default();
2763 if (git_env_bool("GIT_TEST_SPLIT_INDEX", 0))
2764 init_split_index(istate);
2767 /* demote version 3 to version 2 when the latter suffices */
2768 if (istate->version == 3 || istate->version == 2)
2769 istate->version = extended ? 3 : 2;
2771 hdr_version = istate->version;
2773 hdr.hdr_signature = htonl(CACHE_SIGNATURE);
2774 hdr.hdr_version = htonl(hdr_version);
2775 hdr.hdr_entries = htonl(entries - removed);
2777 the_hash_algo->init_fn(&c);
2778 if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
2779 return -1;
2781 if (!HAVE_THREADS || git_config_get_index_threads(&nr_threads))
2782 nr_threads = 1;
2784 if (nr_threads != 1 && record_ieot()) {
2785 int ieot_blocks, cpus;
2788 * ensure default number of ieot blocks maps evenly to the
2789 * default number of threads that will process them leaving
2790 * room for the thread to load the index extensions.
2792 if (!nr_threads) {
2793 ieot_blocks = istate->cache_nr / THREAD_COST;
2794 cpus = online_cpus();
2795 if (ieot_blocks > cpus - 1)
2796 ieot_blocks = cpus - 1;
2797 } else {
2798 ieot_blocks = nr_threads;
2799 if (ieot_blocks > istate->cache_nr)
2800 ieot_blocks = istate->cache_nr;
2804 * no reason to write out the IEOT extension if we don't
2805 * have enough blocks to utilize multi-threading
2807 if (ieot_blocks > 1) {
2808 ieot = xcalloc(1, sizeof(struct index_entry_offset_table)
2809 + (ieot_blocks * sizeof(struct index_entry_offset)));
2810 ieot_entries = DIV_ROUND_UP(entries, ieot_blocks);
2814 offset = lseek(newfd, 0, SEEK_CUR);
2815 if (offset < 0) {
2816 free(ieot);
2817 return -1;
2819 offset += write_buffer_len;
2820 nr = 0;
2821 previous_name = (hdr_version == 4) ? &previous_name_buf : NULL;
2823 for (i = 0; i < entries; i++) {
2824 struct cache_entry *ce = cache[i];
2825 if (ce->ce_flags & CE_REMOVE)
2826 continue;
2827 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
2828 ce_smudge_racily_clean_entry(istate, ce);
2829 if (is_null_oid(&ce->oid)) {
2830 static const char msg[] = "cache entry has null sha1: %s";
2831 static int allow = -1;
2833 if (allow < 0)
2834 allow = git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
2835 if (allow)
2836 warning(msg, ce->name);
2837 else
2838 err = error(msg, ce->name);
2840 drop_cache_tree = 1;
2842 if (ieot && i && (i % ieot_entries == 0)) {
2843 ieot->entries[ieot->nr].nr = nr;
2844 ieot->entries[ieot->nr].offset = offset;
2845 ieot->nr++;
2847 * If we have a V4 index, set the first byte to an invalid
2848 * character to ensure there is nothing common with the previous
2849 * entry
2851 if (previous_name)
2852 previous_name->buf[0] = 0;
2853 nr = 0;
2854 offset = lseek(newfd, 0, SEEK_CUR);
2855 if (offset < 0) {
2856 free(ieot);
2857 return -1;
2859 offset += write_buffer_len;
2861 if (ce_write_entry(&c, newfd, ce, previous_name, (struct ondisk_cache_entry *)&ondisk) < 0)
2862 err = -1;
2864 if (err)
2865 break;
2866 nr++;
2868 if (ieot && nr) {
2869 ieot->entries[ieot->nr].nr = nr;
2870 ieot->entries[ieot->nr].offset = offset;
2871 ieot->nr++;
2873 strbuf_release(&previous_name_buf);
2875 if (err) {
2876 free(ieot);
2877 return err;
2880 /* Write extension data here */
2881 offset = lseek(newfd, 0, SEEK_CUR);
2882 if (offset < 0) {
2883 free(ieot);
2884 return -1;
2886 offset += write_buffer_len;
2887 the_hash_algo->init_fn(&eoie_c);
2890 * Lets write out CACHE_EXT_INDEXENTRYOFFSETTABLE first so that we
2891 * can minimize the number of extensions we have to scan through to
2892 * find it during load. Write it out regardless of the
2893 * strip_extensions parameter as we need it when loading the shared
2894 * index.
2896 if (ieot) {
2897 struct strbuf sb = STRBUF_INIT;
2899 write_ieot_extension(&sb, ieot);
2900 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_INDEXENTRYOFFSETTABLE, sb.len) < 0
2901 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2902 strbuf_release(&sb);
2903 free(ieot);
2904 if (err)
2905 return -1;
2908 if (!strip_extensions && istate->split_index) {
2909 struct strbuf sb = STRBUF_INIT;
2911 err = write_link_extension(&sb, istate) < 0 ||
2912 write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_LINK,
2913 sb.len) < 0 ||
2914 ce_write(&c, newfd, sb.buf, sb.len) < 0;
2915 strbuf_release(&sb);
2916 if (err)
2917 return -1;
2919 if (!strip_extensions && !drop_cache_tree && istate->cache_tree) {
2920 struct strbuf sb = STRBUF_INIT;
2922 cache_tree_write(&sb, istate->cache_tree);
2923 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_TREE, sb.len) < 0
2924 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2925 strbuf_release(&sb);
2926 if (err)
2927 return -1;
2929 if (!strip_extensions && istate->resolve_undo) {
2930 struct strbuf sb = STRBUF_INIT;
2932 resolve_undo_write(&sb, istate->resolve_undo);
2933 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_RESOLVE_UNDO,
2934 sb.len) < 0
2935 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2936 strbuf_release(&sb);
2937 if (err)
2938 return -1;
2940 if (!strip_extensions && istate->untracked) {
2941 struct strbuf sb = STRBUF_INIT;
2943 write_untracked_extension(&sb, istate->untracked);
2944 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_UNTRACKED,
2945 sb.len) < 0 ||
2946 ce_write(&c, newfd, sb.buf, sb.len) < 0;
2947 strbuf_release(&sb);
2948 if (err)
2949 return -1;
2951 if (!strip_extensions && istate->fsmonitor_last_update) {
2952 struct strbuf sb = STRBUF_INIT;
2954 write_fsmonitor_extension(&sb, istate);
2955 err = write_index_ext_header(&c, &eoie_c, newfd, CACHE_EXT_FSMONITOR, sb.len) < 0
2956 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2957 strbuf_release(&sb);
2958 if (err)
2959 return -1;
2963 * CACHE_EXT_ENDOFINDEXENTRIES must be written as the last entry before the SHA1
2964 * so that it can be found and processed before all the index entries are
2965 * read. Write it out regardless of the strip_extensions parameter as we need it
2966 * when loading the shared index.
2968 if (offset && record_eoie()) {
2969 struct strbuf sb = STRBUF_INIT;
2971 write_eoie_extension(&sb, &eoie_c, offset);
2972 err = write_index_ext_header(&c, NULL, newfd, CACHE_EXT_ENDOFINDEXENTRIES, sb.len) < 0
2973 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2974 strbuf_release(&sb);
2975 if (err)
2976 return -1;
2979 if (ce_flush(&c, newfd, istate->oid.hash))
2980 return -1;
2981 if (close_tempfile_gently(tempfile)) {
2982 error(_("could not close '%s'"), tempfile->filename.buf);
2983 return -1;
2985 if (stat(tempfile->filename.buf, &st))
2986 return -1;
2987 istate->timestamp.sec = (unsigned int)st.st_mtime;
2988 istate->timestamp.nsec = ST_MTIME_NSEC(st);
2989 trace_performance_since(start, "write index, changed mask = %x", istate->cache_changed);
2990 return 0;
2993 void set_alternate_index_output(const char *name)
2995 alternate_index_output = name;
2998 static int commit_locked_index(struct lock_file *lk)
3000 if (alternate_index_output)
3001 return commit_lock_file_to(lk, alternate_index_output);
3002 else
3003 return commit_lock_file(lk);
3006 static int do_write_locked_index(struct index_state *istate, struct lock_file *lock,
3007 unsigned flags)
3009 int ret = do_write_index(istate, lock->tempfile, 0);
3010 if (ret)
3011 return ret;
3012 if (flags & COMMIT_LOCK)
3013 return commit_locked_index(lock);
3014 return close_lock_file_gently(lock);
3017 static int write_split_index(struct index_state *istate,
3018 struct lock_file *lock,
3019 unsigned flags)
3021 int ret;
3022 prepare_to_write_split_index(istate);
3023 ret = do_write_locked_index(istate, lock, flags);
3024 finish_writing_split_index(istate);
3025 return ret;
3028 static const char *shared_index_expire = "2.weeks.ago";
3030 static unsigned long get_shared_index_expire_date(void)
3032 static unsigned long shared_index_expire_date;
3033 static int shared_index_expire_date_prepared;
3035 if (!shared_index_expire_date_prepared) {
3036 git_config_get_expiry("splitindex.sharedindexexpire",
3037 &shared_index_expire);
3038 shared_index_expire_date = approxidate(shared_index_expire);
3039 shared_index_expire_date_prepared = 1;
3042 return shared_index_expire_date;
3045 static int should_delete_shared_index(const char *shared_index_path)
3047 struct stat st;
3048 unsigned long expiration;
3050 /* Check timestamp */
3051 expiration = get_shared_index_expire_date();
3052 if (!expiration)
3053 return 0;
3054 if (stat(shared_index_path, &st))
3055 return error_errno(_("could not stat '%s'"), shared_index_path);
3056 if (st.st_mtime > expiration)
3057 return 0;
3059 return 1;
3062 static int clean_shared_index_files(const char *current_hex)
3064 struct dirent *de;
3065 DIR *dir = opendir(get_git_dir());
3067 if (!dir)
3068 return error_errno(_("unable to open git dir: %s"), get_git_dir());
3070 while ((de = readdir(dir)) != NULL) {
3071 const char *sha1_hex;
3072 const char *shared_index_path;
3073 if (!skip_prefix(de->d_name, "sharedindex.", &sha1_hex))
3074 continue;
3075 if (!strcmp(sha1_hex, current_hex))
3076 continue;
3077 shared_index_path = git_path("%s", de->d_name);
3078 if (should_delete_shared_index(shared_index_path) > 0 &&
3079 unlink(shared_index_path))
3080 warning_errno(_("unable to unlink: %s"), shared_index_path);
3082 closedir(dir);
3084 return 0;
3087 static int write_shared_index(struct index_state *istate,
3088 struct tempfile **temp)
3090 struct split_index *si = istate->split_index;
3091 int ret;
3093 move_cache_to_base_index(istate);
3094 ret = do_write_index(si->base, *temp, 1);
3095 if (ret)
3096 return ret;
3097 ret = adjust_shared_perm(get_tempfile_path(*temp));
3098 if (ret) {
3099 error("cannot fix permission bits on %s", get_tempfile_path(*temp));
3100 return ret;
3102 ret = rename_tempfile(temp,
3103 git_path("sharedindex.%s", oid_to_hex(&si->base->oid)));
3104 if (!ret) {
3105 oidcpy(&si->base_oid, &si->base->oid);
3106 clean_shared_index_files(oid_to_hex(&si->base->oid));
3109 return ret;
3112 static const int default_max_percent_split_change = 20;
3114 static int too_many_not_shared_entries(struct index_state *istate)
3116 int i, not_shared = 0;
3117 int max_split = git_config_get_max_percent_split_change();
3119 switch (max_split) {
3120 case -1:
3121 /* not or badly configured: use the default value */
3122 max_split = default_max_percent_split_change;
3123 break;
3124 case 0:
3125 return 1; /* 0% means always write a new shared index */
3126 case 100:
3127 return 0; /* 100% means never write a new shared index */
3128 default:
3129 break; /* just use the configured value */
3132 /* Count not shared entries */
3133 for (i = 0; i < istate->cache_nr; i++) {
3134 struct cache_entry *ce = istate->cache[i];
3135 if (!ce->index)
3136 not_shared++;
3139 return (int64_t)istate->cache_nr * max_split < (int64_t)not_shared * 100;
3142 int write_locked_index(struct index_state *istate, struct lock_file *lock,
3143 unsigned flags)
3145 int new_shared_index, ret;
3146 struct split_index *si = istate->split_index;
3148 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
3149 cache_tree_verify(istate);
3151 if ((flags & SKIP_IF_UNCHANGED) && !istate->cache_changed) {
3152 if (flags & COMMIT_LOCK)
3153 rollback_lock_file(lock);
3154 return 0;
3157 if (istate->fsmonitor_last_update)
3158 fill_fsmonitor_bitmap(istate);
3160 if (!si || alternate_index_output ||
3161 (istate->cache_changed & ~EXTMASK)) {
3162 if (si)
3163 oidclr(&si->base_oid);
3164 ret = do_write_locked_index(istate, lock, flags);
3165 goto out;
3168 if (git_env_bool("GIT_TEST_SPLIT_INDEX", 0)) {
3169 int v = si->base_oid.hash[0];
3170 if ((v & 15) < 6)
3171 istate->cache_changed |= SPLIT_INDEX_ORDERED;
3173 if (too_many_not_shared_entries(istate))
3174 istate->cache_changed |= SPLIT_INDEX_ORDERED;
3176 new_shared_index = istate->cache_changed & SPLIT_INDEX_ORDERED;
3178 if (new_shared_index) {
3179 struct tempfile *temp;
3180 int saved_errno;
3182 /* Same initial permissions as the main .git/index file */
3183 temp = mks_tempfile_sm(git_path("sharedindex_XXXXXX"), 0, 0666);
3184 if (!temp) {
3185 oidclr(&si->base_oid);
3186 ret = do_write_locked_index(istate, lock, flags);
3187 goto out;
3189 ret = write_shared_index(istate, &temp);
3191 saved_errno = errno;
3192 if (is_tempfile_active(temp))
3193 delete_tempfile(&temp);
3194 errno = saved_errno;
3196 if (ret)
3197 goto out;
3200 ret = write_split_index(istate, lock, flags);
3202 /* Freshen the shared index only if the split-index was written */
3203 if (!ret && !new_shared_index) {
3204 const char *shared_index = git_path("sharedindex.%s",
3205 oid_to_hex(&si->base_oid));
3206 freshen_shared_index(shared_index, 1);
3209 out:
3210 if (flags & COMMIT_LOCK)
3211 rollback_lock_file(lock);
3212 return ret;
3216 * Read the index file that is potentially unmerged into given
3217 * index_state, dropping any unmerged entries to stage #0 (potentially
3218 * resulting in a path appearing as both a file and a directory in the
3219 * index; the caller is responsible to clear out the extra entries
3220 * before writing the index to a tree). Returns true if the index is
3221 * unmerged. Callers who want to refuse to work from an unmerged
3222 * state can call this and check its return value, instead of calling
3223 * read_cache().
3225 int read_index_unmerged(struct index_state *istate)
3227 int i;
3228 int unmerged = 0;
3230 read_index(istate);
3231 for (i = 0; i < istate->cache_nr; i++) {
3232 struct cache_entry *ce = istate->cache[i];
3233 struct cache_entry *new_ce;
3234 int len;
3236 if (!ce_stage(ce))
3237 continue;
3238 unmerged = 1;
3239 len = ce_namelen(ce);
3240 new_ce = make_empty_cache_entry(istate, len);
3241 memcpy(new_ce->name, ce->name, len);
3242 new_ce->ce_flags = create_ce_flags(0) | CE_CONFLICTED;
3243 new_ce->ce_namelen = len;
3244 new_ce->ce_mode = ce->ce_mode;
3245 if (add_index_entry(istate, new_ce, ADD_CACHE_SKIP_DFCHECK))
3246 return error("%s: cannot drop to stage #0",
3247 new_ce->name);
3249 return unmerged;
3253 * Returns 1 if the path is an "other" path with respect to
3254 * the index; that is, the path is not mentioned in the index at all,
3255 * either as a file, a directory with some files in the index,
3256 * or as an unmerged entry.
3258 * We helpfully remove a trailing "/" from directories so that
3259 * the output of read_directory can be used as-is.
3261 int index_name_is_other(const struct index_state *istate, const char *name,
3262 int namelen)
3264 int pos;
3265 if (namelen && name[namelen - 1] == '/')
3266 namelen--;
3267 pos = index_name_pos(istate, name, namelen);
3268 if (0 <= pos)
3269 return 0; /* exact match */
3270 pos = -pos - 1;
3271 if (pos < istate->cache_nr) {
3272 struct cache_entry *ce = istate->cache[pos];
3273 if (ce_namelen(ce) == namelen &&
3274 !memcmp(ce->name, name, namelen))
3275 return 0; /* Yup, this one exists unmerged */
3277 return 1;
3280 void *read_blob_data_from_index(const struct index_state *istate,
3281 const char *path, unsigned long *size)
3283 int pos, len;
3284 unsigned long sz;
3285 enum object_type type;
3286 void *data;
3288 len = strlen(path);
3289 pos = index_name_pos(istate, path, len);
3290 if (pos < 0) {
3292 * We might be in the middle of a merge, in which
3293 * case we would read stage #2 (ours).
3295 int i;
3296 for (i = -pos - 1;
3297 (pos < 0 && i < istate->cache_nr &&
3298 !strcmp(istate->cache[i]->name, path));
3299 i++)
3300 if (ce_stage(istate->cache[i]) == 2)
3301 pos = i;
3303 if (pos < 0)
3304 return NULL;
3305 data = read_object_file(&istate->cache[pos]->oid, &type, &sz);
3306 if (!data || type != OBJ_BLOB) {
3307 free(data);
3308 return NULL;
3310 if (size)
3311 *size = sz;
3312 return data;
3315 void stat_validity_clear(struct stat_validity *sv)
3317 FREE_AND_NULL(sv->sd);
3320 int stat_validity_check(struct stat_validity *sv, const char *path)
3322 struct stat st;
3324 if (stat(path, &st) < 0)
3325 return sv->sd == NULL;
3326 if (!sv->sd)
3327 return 0;
3328 return S_ISREG(st.st_mode) && !match_stat_data(sv->sd, &st);
3331 void stat_validity_update(struct stat_validity *sv, int fd)
3333 struct stat st;
3335 if (fstat(fd, &st) < 0 || !S_ISREG(st.st_mode))
3336 stat_validity_clear(sv);
3337 else {
3338 if (!sv->sd)
3339 sv->sd = xcalloc(1, sizeof(struct stat_data));
3340 fill_stat_data(sv->sd, &st);
3344 void move_index_extensions(struct index_state *dst, struct index_state *src)
3346 dst->untracked = src->untracked;
3347 src->untracked = NULL;
3348 dst->cache_tree = src->cache_tree;
3349 src->cache_tree = NULL;
3352 struct cache_entry *dup_cache_entry(const struct cache_entry *ce,
3353 struct index_state *istate)
3355 unsigned int size = ce_size(ce);
3356 int mem_pool_allocated;
3357 struct cache_entry *new_entry = make_empty_cache_entry(istate, ce_namelen(ce));
3358 mem_pool_allocated = new_entry->mem_pool_allocated;
3360 memcpy(new_entry, ce, size);
3361 new_entry->mem_pool_allocated = mem_pool_allocated;
3362 return new_entry;
3365 void discard_cache_entry(struct cache_entry *ce)
3367 if (ce && should_validate_cache_entries())
3368 memset(ce, 0xCD, cache_entry_size(ce->ce_namelen));
3370 if (ce && ce->mem_pool_allocated)
3371 return;
3373 free(ce);
3376 int should_validate_cache_entries(void)
3378 static int validate_index_cache_entries = -1;
3380 if (validate_index_cache_entries < 0) {
3381 if (getenv("GIT_TEST_VALIDATE_INDEX_CACHE_ENTRIES"))
3382 validate_index_cache_entries = 1;
3383 else
3384 validate_index_cache_entries = 0;
3387 return validate_index_cache_entries;
3390 #define EOIE_SIZE (4 + GIT_SHA1_RAWSZ) /* <4-byte offset> + <20-byte hash> */
3391 #define EOIE_SIZE_WITH_HEADER (4 + 4 + EOIE_SIZE) /* <4-byte signature> + <4-byte length> + EOIE_SIZE */
3393 static size_t read_eoie_extension(const char *mmap, size_t mmap_size)
3396 * The end of index entries (EOIE) extension is guaranteed to be last
3397 * so that it can be found by scanning backwards from the EOF.
3399 * "EOIE"
3400 * <4-byte length>
3401 * <4-byte offset>
3402 * <20-byte hash>
3404 const char *index, *eoie;
3405 uint32_t extsize;
3406 size_t offset, src_offset;
3407 unsigned char hash[GIT_MAX_RAWSZ];
3408 git_hash_ctx c;
3410 /* ensure we have an index big enough to contain an EOIE extension */
3411 if (mmap_size < sizeof(struct cache_header) + EOIE_SIZE_WITH_HEADER + the_hash_algo->rawsz)
3412 return 0;
3414 /* validate the extension signature */
3415 index = eoie = mmap + mmap_size - EOIE_SIZE_WITH_HEADER - the_hash_algo->rawsz;
3416 if (CACHE_EXT(index) != CACHE_EXT_ENDOFINDEXENTRIES)
3417 return 0;
3418 index += sizeof(uint32_t);
3420 /* validate the extension size */
3421 extsize = get_be32(index);
3422 if (extsize != EOIE_SIZE)
3423 return 0;
3424 index += sizeof(uint32_t);
3427 * Validate the offset we're going to look for the first extension
3428 * signature is after the index header and before the eoie extension.
3430 offset = get_be32(index);
3431 if (mmap + offset < mmap + sizeof(struct cache_header))
3432 return 0;
3433 if (mmap + offset >= eoie)
3434 return 0;
3435 index += sizeof(uint32_t);
3438 * The hash is computed over extension types and their sizes (but not
3439 * their contents). E.g. if we have "TREE" extension that is N-bytes
3440 * long, "REUC" extension that is M-bytes long, followed by "EOIE",
3441 * then the hash would be:
3443 * SHA-1("TREE" + <binary representation of N> +
3444 * "REUC" + <binary representation of M>)
3446 src_offset = offset;
3447 the_hash_algo->init_fn(&c);
3448 while (src_offset < mmap_size - the_hash_algo->rawsz - EOIE_SIZE_WITH_HEADER) {
3449 /* After an array of active_nr index entries,
3450 * there can be arbitrary number of extended
3451 * sections, each of which is prefixed with
3452 * extension name (4-byte) and section length
3453 * in 4-byte network byte order.
3455 uint32_t extsize;
3456 memcpy(&extsize, mmap + src_offset + 4, 4);
3457 extsize = ntohl(extsize);
3459 /* verify the extension size isn't so large it will wrap around */
3460 if (src_offset + 8 + extsize < src_offset)
3461 return 0;
3463 the_hash_algo->update_fn(&c, mmap + src_offset, 8);
3465 src_offset += 8;
3466 src_offset += extsize;
3468 the_hash_algo->final_fn(hash, &c);
3469 if (!hasheq(hash, (const unsigned char *)index))
3470 return 0;
3472 /* Validate that the extension offsets returned us back to the eoie extension. */
3473 if (src_offset != mmap_size - the_hash_algo->rawsz - EOIE_SIZE_WITH_HEADER)
3474 return 0;
3476 return offset;
3479 static void write_eoie_extension(struct strbuf *sb, git_hash_ctx *eoie_context, size_t offset)
3481 uint32_t buffer;
3482 unsigned char hash[GIT_MAX_RAWSZ];
3484 /* offset */
3485 put_be32(&buffer, offset);
3486 strbuf_add(sb, &buffer, sizeof(uint32_t));
3488 /* hash */
3489 the_hash_algo->final_fn(hash, eoie_context);
3490 strbuf_add(sb, hash, the_hash_algo->rawsz);
3493 #define IEOT_VERSION (1)
3495 static struct index_entry_offset_table *read_ieot_extension(const char *mmap, size_t mmap_size, size_t offset)
3497 const char *index = NULL;
3498 uint32_t extsize, ext_version;
3499 struct index_entry_offset_table *ieot;
3500 int i, nr;
3502 /* find the IEOT extension */
3503 if (!offset)
3504 return NULL;
3505 while (offset <= mmap_size - the_hash_algo->rawsz - 8) {
3506 extsize = get_be32(mmap + offset + 4);
3507 if (CACHE_EXT((mmap + offset)) == CACHE_EXT_INDEXENTRYOFFSETTABLE) {
3508 index = mmap + offset + 4 + 4;
3509 break;
3511 offset += 8;
3512 offset += extsize;
3514 if (!index)
3515 return NULL;
3517 /* validate the version is IEOT_VERSION */
3518 ext_version = get_be32(index);
3519 if (ext_version != IEOT_VERSION) {
3520 error("invalid IEOT version %d", ext_version);
3521 return NULL;
3523 index += sizeof(uint32_t);
3525 /* extension size - version bytes / bytes per entry */
3526 nr = (extsize - sizeof(uint32_t)) / (sizeof(uint32_t) + sizeof(uint32_t));
3527 if (!nr) {
3528 error("invalid number of IEOT entries %d", nr);
3529 return NULL;
3531 ieot = xmalloc(sizeof(struct index_entry_offset_table)
3532 + (nr * sizeof(struct index_entry_offset)));
3533 ieot->nr = nr;
3534 for (i = 0; i < nr; i++) {
3535 ieot->entries[i].offset = get_be32(index);
3536 index += sizeof(uint32_t);
3537 ieot->entries[i].nr = get_be32(index);
3538 index += sizeof(uint32_t);
3541 return ieot;
3544 static void write_ieot_extension(struct strbuf *sb, struct index_entry_offset_table *ieot)
3546 uint32_t buffer;
3547 int i;
3549 /* version */
3550 put_be32(&buffer, IEOT_VERSION);
3551 strbuf_add(sb, &buffer, sizeof(uint32_t));
3553 /* ieot */
3554 for (i = 0; i < ieot->nr; i++) {
3556 /* offset */
3557 put_be32(&buffer, ieot->entries[i].offset);
3558 strbuf_add(sb, &buffer, sizeof(uint32_t));
3560 /* count */
3561 put_be32(&buffer, ieot->entries[i].nr);
3562 strbuf_add(sb, &buffer, sizeof(uint32_t));