2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
12 #include "cache-tree.h"
15 #include "object-store.h"
19 #include "resolve-undo.h"
20 #include "run-command.h"
23 #include "split-index.h"
25 #include "fsmonitor.h"
26 #include "thread-utils.h"
28 #include "sparse-index.h"
29 #include "csum-file.h"
30 #include "promisor-remote.h"
33 /* Mask for the name length in ce_flags in the on-disk index */
35 #define CE_NAMEMASK (0x0fff)
39 * The first letter should be 'A'..'Z' for extensions that are not
40 * necessary for a correct operation (i.e. optimization data).
41 * When new extensions are added that _needs_ to be understood in
42 * order to correctly interpret the index file, pick character that
43 * is outside the range, to cause the reader to abort.
46 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
47 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
48 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
49 #define CACHE_EXT_LINK 0x6c696e6b /* "link" */
50 #define CACHE_EXT_UNTRACKED 0x554E5452 /* "UNTR" */
51 #define CACHE_EXT_FSMONITOR 0x46534D4E /* "FSMN" */
52 #define CACHE_EXT_ENDOFINDEXENTRIES 0x454F4945 /* "EOIE" */
53 #define CACHE_EXT_INDEXENTRYOFFSETTABLE 0x49454F54 /* "IEOT" */
54 #define CACHE_EXT_SPARSE_DIRECTORIES 0x73646972 /* "sdir" */
56 /* changes that can be kept in $GIT_DIR/index (basically all extensions) */
57 #define EXTMASK (RESOLVE_UNDO_CHANGED | CACHE_TREE_CHANGED | \
58 CE_ENTRY_ADDED | CE_ENTRY_REMOVED | CE_ENTRY_CHANGED | \
59 SPLIT_INDEX_ORDERED | UNTRACKED_CHANGED | FSMONITOR_CHANGED)
63 * This is an estimate of the pathname length in the index. We use
64 * this for V4 index files to guess the un-deltafied size of the index
65 * in memory because of pathname deltafication. This is not required
66 * for V2/V3 index formats because their pathnames are not compressed.
67 * If the initial amount of memory set aside is not sufficient, the
68 * mem pool will allocate extra memory.
70 #define CACHE_ENTRY_PATH_LENGTH 80
72 enum index_search_mode
{
77 static inline struct cache_entry
*mem_pool__ce_alloc(struct mem_pool
*mem_pool
, size_t len
)
79 struct cache_entry
*ce
;
80 ce
= mem_pool_alloc(mem_pool
, cache_entry_size(len
));
81 ce
->mem_pool_allocated
= 1;
85 static inline struct cache_entry
*mem_pool__ce_calloc(struct mem_pool
*mem_pool
, size_t len
)
87 struct cache_entry
* ce
;
88 ce
= mem_pool_calloc(mem_pool
, 1, cache_entry_size(len
));
89 ce
->mem_pool_allocated
= 1;
93 static struct mem_pool
*find_mem_pool(struct index_state
*istate
)
95 struct mem_pool
**pool_ptr
;
97 if (istate
->split_index
&& istate
->split_index
->base
)
98 pool_ptr
= &istate
->split_index
->base
->ce_mem_pool
;
100 pool_ptr
= &istate
->ce_mem_pool
;
103 *pool_ptr
= xmalloc(sizeof(**pool_ptr
));
104 mem_pool_init(*pool_ptr
, 0);
110 static const char *alternate_index_output
;
112 static void set_index_entry(struct index_state
*istate
, int nr
, struct cache_entry
*ce
)
114 if (S_ISSPARSEDIR(ce
->ce_mode
))
115 istate
->sparse_index
= 1;
117 istate
->cache
[nr
] = ce
;
118 add_name_hash(istate
, ce
);
121 static void replace_index_entry(struct index_state
*istate
, int nr
, struct cache_entry
*ce
)
123 struct cache_entry
*old
= istate
->cache
[nr
];
125 replace_index_entry_in_base(istate
, old
, ce
);
126 remove_name_hash(istate
, old
);
127 discard_cache_entry(old
);
128 ce
->ce_flags
&= ~CE_HASHED
;
129 set_index_entry(istate
, nr
, ce
);
130 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
131 mark_fsmonitor_invalid(istate
, ce
);
132 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
135 void rename_index_entry_at(struct index_state
*istate
, int nr
, const char *new_name
)
137 struct cache_entry
*old_entry
= istate
->cache
[nr
], *new_entry
;
138 int namelen
= strlen(new_name
);
140 new_entry
= make_empty_cache_entry(istate
, namelen
);
141 copy_cache_entry(new_entry
, old_entry
);
142 new_entry
->ce_flags
&= ~CE_HASHED
;
143 new_entry
->ce_namelen
= namelen
;
144 new_entry
->index
= 0;
145 memcpy(new_entry
->name
, new_name
, namelen
+ 1);
147 cache_tree_invalidate_path(istate
, old_entry
->name
);
148 untracked_cache_remove_from_index(istate
, old_entry
->name
);
149 remove_index_entry_at(istate
, nr
);
150 add_index_entry(istate
, new_entry
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
153 void fill_stat_data(struct stat_data
*sd
, struct stat
*st
)
155 sd
->sd_ctime
.sec
= (unsigned int)st
->st_ctime
;
156 sd
->sd_mtime
.sec
= (unsigned int)st
->st_mtime
;
157 sd
->sd_ctime
.nsec
= ST_CTIME_NSEC(*st
);
158 sd
->sd_mtime
.nsec
= ST_MTIME_NSEC(*st
);
159 sd
->sd_dev
= st
->st_dev
;
160 sd
->sd_ino
= st
->st_ino
;
161 sd
->sd_uid
= st
->st_uid
;
162 sd
->sd_gid
= st
->st_gid
;
163 sd
->sd_size
= st
->st_size
;
166 int match_stat_data(const struct stat_data
*sd
, struct stat
*st
)
170 if (sd
->sd_mtime
.sec
!= (unsigned int)st
->st_mtime
)
171 changed
|= MTIME_CHANGED
;
172 if (trust_ctime
&& check_stat
&&
173 sd
->sd_ctime
.sec
!= (unsigned int)st
->st_ctime
)
174 changed
|= CTIME_CHANGED
;
177 if (check_stat
&& sd
->sd_mtime
.nsec
!= ST_MTIME_NSEC(*st
))
178 changed
|= MTIME_CHANGED
;
179 if (trust_ctime
&& check_stat
&&
180 sd
->sd_ctime
.nsec
!= ST_CTIME_NSEC(*st
))
181 changed
|= CTIME_CHANGED
;
185 if (sd
->sd_uid
!= (unsigned int) st
->st_uid
||
186 sd
->sd_gid
!= (unsigned int) st
->st_gid
)
187 changed
|= OWNER_CHANGED
;
188 if (sd
->sd_ino
!= (unsigned int) st
->st_ino
)
189 changed
|= INODE_CHANGED
;
194 * st_dev breaks on network filesystems where different
195 * clients will have different views of what "device"
196 * the filesystem is on
198 if (check_stat
&& sd
->sd_dev
!= (unsigned int) st
->st_dev
)
199 changed
|= INODE_CHANGED
;
202 if (sd
->sd_size
!= (unsigned int) st
->st_size
)
203 changed
|= DATA_CHANGED
;
209 * This only updates the "non-critical" parts of the directory
210 * cache, ie the parts that aren't tracked by GIT, and only used
211 * to validate the cache.
213 void fill_stat_cache_info(struct index_state
*istate
, struct cache_entry
*ce
, struct stat
*st
)
215 fill_stat_data(&ce
->ce_stat_data
, st
);
217 if (assume_unchanged
)
218 ce
->ce_flags
|= CE_VALID
;
220 if (S_ISREG(st
->st_mode
)) {
221 ce_mark_uptodate(ce
);
222 mark_fsmonitor_valid(istate
, ce
);
226 static int ce_compare_data(struct index_state
*istate
,
227 const struct cache_entry
*ce
,
231 int fd
= git_open_cloexec(ce
->name
, O_RDONLY
);
234 struct object_id oid
;
235 if (!index_fd(istate
, &oid
, fd
, st
, OBJ_BLOB
, ce
->name
, 0))
236 match
= !oideq(&oid
, &ce
->oid
);
237 /* index_fd() closed the file descriptor already */
242 static int ce_compare_link(const struct cache_entry
*ce
, size_t expected_size
)
247 enum object_type type
;
248 struct strbuf sb
= STRBUF_INIT
;
250 if (strbuf_readlink(&sb
, ce
->name
, expected_size
))
253 buffer
= read_object_file(&ce
->oid
, &type
, &size
);
256 match
= memcmp(buffer
, sb
.buf
, size
);
263 static int ce_compare_gitlink(const struct cache_entry
*ce
)
265 struct object_id oid
;
268 * We don't actually require that the .git directory
269 * under GITLINK directory be a valid git directory. It
270 * might even be missing (in case nobody populated that
273 * If so, we consider it always to match.
275 if (resolve_gitlink_ref(ce
->name
, "HEAD", &oid
) < 0)
277 return !oideq(&oid
, &ce
->oid
);
280 static int ce_modified_check_fs(struct index_state
*istate
,
281 const struct cache_entry
*ce
,
284 switch (st
->st_mode
& S_IFMT
) {
286 if (ce_compare_data(istate
, ce
, st
))
290 if (ce_compare_link(ce
, xsize_t(st
->st_size
)))
294 if (S_ISGITLINK(ce
->ce_mode
))
295 return ce_compare_gitlink(ce
) ? DATA_CHANGED
: 0;
296 /* else fallthrough */
303 static int ce_match_stat_basic(const struct cache_entry
*ce
, struct stat
*st
)
305 unsigned int changed
= 0;
307 if (ce
->ce_flags
& CE_REMOVE
)
308 return MODE_CHANGED
| DATA_CHANGED
| TYPE_CHANGED
;
310 switch (ce
->ce_mode
& S_IFMT
) {
312 changed
|= !S_ISREG(st
->st_mode
) ? TYPE_CHANGED
: 0;
313 /* We consider only the owner x bit to be relevant for
316 if (trust_executable_bit
&&
317 (0100 & (ce
->ce_mode
^ st
->st_mode
)))
318 changed
|= MODE_CHANGED
;
321 if (!S_ISLNK(st
->st_mode
) &&
322 (has_symlinks
|| !S_ISREG(st
->st_mode
)))
323 changed
|= TYPE_CHANGED
;
326 /* We ignore most of the st_xxx fields for gitlinks */
327 if (!S_ISDIR(st
->st_mode
))
328 changed
|= TYPE_CHANGED
;
329 else if (ce_compare_gitlink(ce
))
330 changed
|= DATA_CHANGED
;
333 BUG("unsupported ce_mode: %o", ce
->ce_mode
);
336 changed
|= match_stat_data(&ce
->ce_stat_data
, st
);
338 /* Racily smudged entry? */
339 if (!ce
->ce_stat_data
.sd_size
) {
340 if (!is_empty_blob_sha1(ce
->oid
.hash
))
341 changed
|= DATA_CHANGED
;
347 static int is_racy_stat(const struct index_state
*istate
,
348 const struct stat_data
*sd
)
350 return (istate
->timestamp
.sec
&&
352 /* nanosecond timestamped files can also be racy! */
353 (istate
->timestamp
.sec
< sd
->sd_mtime
.sec
||
354 (istate
->timestamp
.sec
== sd
->sd_mtime
.sec
&&
355 istate
->timestamp
.nsec
<= sd
->sd_mtime
.nsec
))
357 istate
->timestamp
.sec
<= sd
->sd_mtime
.sec
362 int is_racy_timestamp(const struct index_state
*istate
,
363 const struct cache_entry
*ce
)
365 return (!S_ISGITLINK(ce
->ce_mode
) &&
366 is_racy_stat(istate
, &ce
->ce_stat_data
));
369 int match_stat_data_racy(const struct index_state
*istate
,
370 const struct stat_data
*sd
, struct stat
*st
)
372 if (is_racy_stat(istate
, sd
))
373 return MTIME_CHANGED
;
374 return match_stat_data(sd
, st
);
377 int ie_match_stat(struct index_state
*istate
,
378 const struct cache_entry
*ce
, struct stat
*st
,
379 unsigned int options
)
381 unsigned int changed
;
382 int ignore_valid
= options
& CE_MATCH_IGNORE_VALID
;
383 int ignore_skip_worktree
= options
& CE_MATCH_IGNORE_SKIP_WORKTREE
;
384 int assume_racy_is_modified
= options
& CE_MATCH_RACY_IS_DIRTY
;
385 int ignore_fsmonitor
= options
& CE_MATCH_IGNORE_FSMONITOR
;
387 if (!ignore_fsmonitor
)
388 refresh_fsmonitor(istate
);
390 * If it's marked as always valid in the index, it's
391 * valid whatever the checked-out copy says.
393 * skip-worktree has the same effect with higher precedence
395 if (!ignore_skip_worktree
&& ce_skip_worktree(ce
))
397 if (!ignore_valid
&& (ce
->ce_flags
& CE_VALID
))
399 if (!ignore_fsmonitor
&& (ce
->ce_flags
& CE_FSMONITOR_VALID
))
403 * Intent-to-add entries have not been added, so the index entry
404 * by definition never matches what is in the work tree until it
405 * actually gets added.
407 if (ce_intent_to_add(ce
))
408 return DATA_CHANGED
| TYPE_CHANGED
| MODE_CHANGED
;
410 changed
= ce_match_stat_basic(ce
, st
);
413 * Within 1 second of this sequence:
414 * echo xyzzy >file && git-update-index --add file
415 * running this command:
417 * would give a falsely clean cache entry. The mtime and
418 * length match the cache, and other stat fields do not change.
420 * We could detect this at update-index time (the cache entry
421 * being registered/updated records the same time as "now")
422 * and delay the return from git-update-index, but that would
423 * effectively mean we can make at most one commit per second,
424 * which is not acceptable. Instead, we check cache entries
425 * whose mtime are the same as the index file timestamp more
426 * carefully than others.
428 if (!changed
&& is_racy_timestamp(istate
, ce
)) {
429 if (assume_racy_is_modified
)
430 changed
|= DATA_CHANGED
;
432 changed
|= ce_modified_check_fs(istate
, ce
, st
);
438 int ie_modified(struct index_state
*istate
,
439 const struct cache_entry
*ce
,
440 struct stat
*st
, unsigned int options
)
442 int changed
, changed_fs
;
444 changed
= ie_match_stat(istate
, ce
, st
, options
);
448 * If the mode or type has changed, there's no point in trying
449 * to refresh the entry - it's not going to match
451 if (changed
& (MODE_CHANGED
| TYPE_CHANGED
))
455 * Immediately after read-tree or update-index --cacheinfo,
456 * the length field is zero, as we have never even read the
457 * lstat(2) information once, and we cannot trust DATA_CHANGED
458 * returned by ie_match_stat() which in turn was returned by
459 * ce_match_stat_basic() to signal that the filesize of the
460 * blob changed. We have to actually go to the filesystem to
461 * see if the contents match, and if so, should answer "unchanged".
463 * The logic does not apply to gitlinks, as ce_match_stat_basic()
464 * already has checked the actual HEAD from the filesystem in the
465 * subproject. If ie_match_stat() already said it is different,
466 * then we know it is.
468 if ((changed
& DATA_CHANGED
) &&
469 (S_ISGITLINK(ce
->ce_mode
) || ce
->ce_stat_data
.sd_size
!= 0))
472 changed_fs
= ce_modified_check_fs(istate
, ce
, st
);
474 return changed
| changed_fs
;
478 int base_name_compare(const char *name1
, int len1
, int mode1
,
479 const char *name2
, int len2
, int mode2
)
481 unsigned char c1
, c2
;
482 int len
= len1
< len2
? len1
: len2
;
485 cmp
= memcmp(name1
, name2
, len
);
490 if (!c1
&& S_ISDIR(mode1
))
492 if (!c2
&& S_ISDIR(mode2
))
494 return (c1
< c2
) ? -1 : (c1
> c2
) ? 1 : 0;
498 * df_name_compare() is identical to base_name_compare(), except it
499 * compares conflicting directory/file entries as equal. Note that
500 * while a directory name compares as equal to a regular file, they
501 * then individually compare _differently_ to a filename that has
502 * a dot after the basename (because '\0' < '.' < '/').
504 * This is used by routines that want to traverse the git namespace
505 * but then handle conflicting entries together when possible.
507 int df_name_compare(const char *name1
, int len1
, int mode1
,
508 const char *name2
, int len2
, int mode2
)
510 int len
= len1
< len2
? len1
: len2
, cmp
;
511 unsigned char c1
, c2
;
513 cmp
= memcmp(name1
, name2
, len
);
516 /* Directories and files compare equal (same length, same name) */
520 if (!c1
&& S_ISDIR(mode1
))
523 if (!c2
&& S_ISDIR(mode2
))
525 if (c1
== '/' && !c2
)
527 if (c2
== '/' && !c1
)
532 int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
)
534 size_t min_len
= (len1
< len2
) ? len1
: len2
;
535 int cmp
= memcmp(name1
, name2
, min_len
);
545 int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
)
549 cmp
= name_compare(name1
, len1
, name2
, len2
);
560 static int index_name_stage_pos(struct index_state
*istate
,
561 const char *name
, int namelen
,
563 enum index_search_mode search_mode
)
568 last
= istate
->cache_nr
;
569 while (last
> first
) {
570 int next
= first
+ ((last
- first
) >> 1);
571 struct cache_entry
*ce
= istate
->cache
[next
];
572 int cmp
= cache_name_stage_compare(name
, namelen
, stage
, ce
->name
, ce_namelen(ce
), ce_stage(ce
));
582 if (search_mode
== EXPAND_SPARSE
&& istate
->sparse_index
&&
584 /* Note: first <= istate->cache_nr */
585 struct cache_entry
*ce
= istate
->cache
[first
- 1];
588 * If we are in a sparse-index _and_ the entry before the
589 * insertion position is a sparse-directory entry that is
590 * an ancestor of 'name', then we need to expand the index
591 * and search again. This will only trigger once, because
592 * thereafter the index is fully expanded.
594 if (S_ISSPARSEDIR(ce
->ce_mode
) &&
595 ce_namelen(ce
) < namelen
&&
596 !strncmp(name
, ce
->name
, ce_namelen(ce
))) {
597 ensure_full_index(istate
);
598 return index_name_stage_pos(istate
, name
, namelen
, stage
, search_mode
);
605 int index_name_pos(struct index_state
*istate
, const char *name
, int namelen
)
607 return index_name_stage_pos(istate
, name
, namelen
, 0, EXPAND_SPARSE
);
610 int index_entry_exists(struct index_state
*istate
, const char *name
, int namelen
)
612 return index_name_stage_pos(istate
, name
, namelen
, 0, NO_EXPAND_SPARSE
) >= 0;
615 int remove_index_entry_at(struct index_state
*istate
, int pos
)
617 struct cache_entry
*ce
= istate
->cache
[pos
];
619 record_resolve_undo(istate
, ce
);
620 remove_name_hash(istate
, ce
);
621 save_or_free_index_entry(istate
, ce
);
622 istate
->cache_changed
|= CE_ENTRY_REMOVED
;
624 if (pos
>= istate
->cache_nr
)
626 MOVE_ARRAY(istate
->cache
+ pos
, istate
->cache
+ pos
+ 1,
627 istate
->cache_nr
- pos
);
632 * Remove all cache entries marked for removal, that is where
633 * CE_REMOVE is set in ce_flags. This is much more effective than
634 * calling remove_index_entry_at() for each entry to be removed.
636 void remove_marked_cache_entries(struct index_state
*istate
, int invalidate
)
638 struct cache_entry
**ce_array
= istate
->cache
;
641 for (i
= j
= 0; i
< istate
->cache_nr
; i
++) {
642 if (ce_array
[i
]->ce_flags
& CE_REMOVE
) {
644 cache_tree_invalidate_path(istate
,
646 untracked_cache_remove_from_index(istate
,
649 remove_name_hash(istate
, ce_array
[i
]);
650 save_or_free_index_entry(istate
, ce_array
[i
]);
653 ce_array
[j
++] = ce_array
[i
];
655 if (j
== istate
->cache_nr
)
657 istate
->cache_changed
|= CE_ENTRY_REMOVED
;
658 istate
->cache_nr
= j
;
661 int remove_file_from_index(struct index_state
*istate
, const char *path
)
663 int pos
= index_name_pos(istate
, path
, strlen(path
));
666 cache_tree_invalidate_path(istate
, path
);
667 untracked_cache_remove_from_index(istate
, path
);
668 while (pos
< istate
->cache_nr
&& !strcmp(istate
->cache
[pos
]->name
, path
))
669 remove_index_entry_at(istate
, pos
);
673 static int compare_name(struct cache_entry
*ce
, const char *path
, int namelen
)
675 return namelen
!= ce_namelen(ce
) || memcmp(path
, ce
->name
, namelen
);
678 static int index_name_pos_also_unmerged(struct index_state
*istate
,
679 const char *path
, int namelen
)
681 int pos
= index_name_pos(istate
, path
, namelen
);
682 struct cache_entry
*ce
;
687 /* maybe unmerged? */
689 if (pos
>= istate
->cache_nr
||
690 compare_name((ce
= istate
->cache
[pos
]), path
, namelen
))
693 /* order of preference: stage 2, 1, 3 */
694 if (ce_stage(ce
) == 1 && pos
+ 1 < istate
->cache_nr
&&
695 ce_stage((ce
= istate
->cache
[pos
+ 1])) == 2 &&
696 !compare_name(ce
, path
, namelen
))
701 static int different_name(struct cache_entry
*ce
, struct cache_entry
*alias
)
703 int len
= ce_namelen(ce
);
704 return ce_namelen(alias
) != len
|| memcmp(ce
->name
, alias
->name
, len
);
708 * If we add a filename that aliases in the cache, we will use the
709 * name that we already have - but we don't want to update the same
710 * alias twice, because that implies that there were actually two
711 * different files with aliasing names!
713 * So we use the CE_ADDED flag to verify that the alias was an old
714 * one before we accept it as
716 static struct cache_entry
*create_alias_ce(struct index_state
*istate
,
717 struct cache_entry
*ce
,
718 struct cache_entry
*alias
)
721 struct cache_entry
*new_entry
;
723 if (alias
->ce_flags
& CE_ADDED
)
724 die(_("will not add file alias '%s' ('%s' already exists in index)"),
725 ce
->name
, alias
->name
);
727 /* Ok, create the new entry using the name of the existing alias */
728 len
= ce_namelen(alias
);
729 new_entry
= make_empty_cache_entry(istate
, len
);
730 memcpy(new_entry
->name
, alias
->name
, len
);
731 copy_cache_entry(new_entry
, ce
);
732 save_or_free_index_entry(istate
, ce
);
736 void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
)
738 struct object_id oid
;
739 if (write_object_file("", 0, blob_type
, &oid
))
740 die(_("cannot create an empty blob in the object database"));
741 oidcpy(&ce
->oid
, &oid
);
744 int add_to_index(struct index_state
*istate
, const char *path
, struct stat
*st
, int flags
)
746 int namelen
, was_same
;
747 mode_t st_mode
= st
->st_mode
;
748 struct cache_entry
*ce
, *alias
= NULL
;
749 unsigned ce_option
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
|CE_MATCH_RACY_IS_DIRTY
;
750 int verbose
= flags
& (ADD_CACHE_VERBOSE
| ADD_CACHE_PRETEND
);
751 int pretend
= flags
& ADD_CACHE_PRETEND
;
752 int intent_only
= flags
& ADD_CACHE_INTENT
;
753 int add_option
= (ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
|
754 (intent_only
? ADD_CACHE_NEW_ONLY
: 0));
755 unsigned hash_flags
= pretend
? 0 : HASH_WRITE_OBJECT
;
756 struct object_id oid
;
758 if (flags
& ADD_CACHE_RENORMALIZE
)
759 hash_flags
|= HASH_RENORMALIZE
;
761 if (!S_ISREG(st_mode
) && !S_ISLNK(st_mode
) && !S_ISDIR(st_mode
))
762 return error(_("%s: can only add regular files, symbolic links or git-directories"), path
);
764 namelen
= strlen(path
);
765 if (S_ISDIR(st_mode
)) {
766 if (resolve_gitlink_ref(path
, "HEAD", &oid
) < 0)
767 return error(_("'%s' does not have a commit checked out"), path
);
768 while (namelen
&& path
[namelen
-1] == '/')
771 ce
= make_empty_cache_entry(istate
, namelen
);
772 memcpy(ce
->name
, path
, namelen
);
773 ce
->ce_namelen
= namelen
;
775 fill_stat_cache_info(istate
, ce
, st
);
777 ce
->ce_flags
|= CE_INTENT_TO_ADD
;
780 if (trust_executable_bit
&& has_symlinks
) {
781 ce
->ce_mode
= create_ce_mode(st_mode
);
783 /* If there is an existing entry, pick the mode bits and type
784 * from it, otherwise assume unexecutable regular file.
786 struct cache_entry
*ent
;
787 int pos
= index_name_pos_also_unmerged(istate
, path
, namelen
);
789 ent
= (0 <= pos
) ? istate
->cache
[pos
] : NULL
;
790 ce
->ce_mode
= ce_mode_from_stat(ent
, st_mode
);
793 /* When core.ignorecase=true, determine if a directory of the same name but differing
794 * case already exists within the Git repository. If it does, ensure the directory
795 * case of the file being added to the repository matches (is folded into) the existing
796 * entry's directory case.
799 adjust_dirname_case(istate
, ce
->name
);
801 if (!(flags
& ADD_CACHE_RENORMALIZE
)) {
802 alias
= index_file_exists(istate
, ce
->name
,
803 ce_namelen(ce
), ignore_case
);
806 !ie_match_stat(istate
, alias
, st
, ce_option
)) {
807 /* Nothing changed, really */
808 if (!S_ISGITLINK(alias
->ce_mode
))
809 ce_mark_uptodate(alias
);
810 alias
->ce_flags
|= CE_ADDED
;
812 discard_cache_entry(ce
);
817 if (index_path(istate
, &ce
->oid
, path
, st
, hash_flags
)) {
818 discard_cache_entry(ce
);
819 return error(_("unable to index file '%s'"), path
);
822 set_object_name_for_intent_to_add_entry(ce
);
824 if (ignore_case
&& alias
&& different_name(ce
, alias
))
825 ce
= create_alias_ce(istate
, ce
, alias
);
826 ce
->ce_flags
|= CE_ADDED
;
828 /* It was suspected to be racily clean, but it turns out to be Ok */
831 oideq(&alias
->oid
, &ce
->oid
) &&
832 ce
->ce_mode
== alias
->ce_mode
);
835 discard_cache_entry(ce
);
836 else if (add_index_entry(istate
, ce
, add_option
)) {
837 discard_cache_entry(ce
);
838 return error(_("unable to add '%s' to index"), path
);
840 if (verbose
&& !was_same
)
841 printf("add '%s'\n", path
);
845 int add_file_to_index(struct index_state
*istate
, const char *path
, int flags
)
848 if (lstat(path
, &st
))
849 die_errno(_("unable to stat '%s'"), path
);
850 return add_to_index(istate
, path
, &st
, flags
);
853 struct cache_entry
*make_empty_cache_entry(struct index_state
*istate
, size_t len
)
855 return mem_pool__ce_calloc(find_mem_pool(istate
), len
);
858 struct cache_entry
*make_empty_transient_cache_entry(size_t len
,
859 struct mem_pool
*ce_mem_pool
)
862 return mem_pool__ce_calloc(ce_mem_pool
, len
);
863 return xcalloc(1, cache_entry_size(len
));
866 enum verify_path_result
{
872 static enum verify_path_result
verify_path_internal(const char *, unsigned);
874 int verify_path(const char *path
, unsigned mode
)
876 return verify_path_internal(path
, mode
) == PATH_OK
;
879 struct cache_entry
*make_cache_entry(struct index_state
*istate
,
881 const struct object_id
*oid
,
884 unsigned int refresh_options
)
886 struct cache_entry
*ce
, *ret
;
889 if (verify_path_internal(path
, mode
) == PATH_INVALID
) {
890 error(_("invalid path '%s'"), path
);
895 ce
= make_empty_cache_entry(istate
, len
);
897 oidcpy(&ce
->oid
, oid
);
898 memcpy(ce
->name
, path
, len
);
899 ce
->ce_flags
= create_ce_flags(stage
);
900 ce
->ce_namelen
= len
;
901 ce
->ce_mode
= create_ce_mode(mode
);
903 ret
= refresh_cache_entry(istate
, ce
, refresh_options
);
905 discard_cache_entry(ce
);
909 struct cache_entry
*make_transient_cache_entry(unsigned int mode
,
910 const struct object_id
*oid
,
913 struct mem_pool
*ce_mem_pool
)
915 struct cache_entry
*ce
;
918 if (!verify_path(path
, mode
)) {
919 error(_("invalid path '%s'"), path
);
924 ce
= make_empty_transient_cache_entry(len
, ce_mem_pool
);
926 oidcpy(&ce
->oid
, oid
);
927 memcpy(ce
->name
, path
, len
);
928 ce
->ce_flags
= create_ce_flags(stage
);
929 ce
->ce_namelen
= len
;
930 ce
->ce_mode
= create_ce_mode(mode
);
936 * Chmod an index entry with either +x or -x.
938 * Returns -1 if the chmod for the particular cache entry failed (if it's
939 * not a regular file), -2 if an invalid flip argument is passed in, 0
942 int chmod_index_entry(struct index_state
*istate
, struct cache_entry
*ce
,
945 if (!S_ISREG(ce
->ce_mode
))
952 ce
->ce_mode
&= ~0111;
957 cache_tree_invalidate_path(istate
, ce
->name
);
958 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
959 mark_fsmonitor_invalid(istate
, ce
);
960 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
965 int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
)
967 int len
= ce_namelen(a
);
968 return ce_namelen(b
) == len
&& !memcmp(a
->name
, b
->name
, len
);
972 * We fundamentally don't like some paths: we don't want
973 * dot or dot-dot anywhere, and for obvious reasons don't
974 * want to recurse into ".git" either.
976 * Also, we don't want double slashes or slashes at the
977 * end that can make pathnames ambiguous.
979 static int verify_dotfile(const char *rest
, unsigned mode
)
982 * The first character was '.', but that
983 * has already been discarded, we now test
987 /* "." is not allowed */
988 if (*rest
== '\0' || is_dir_sep(*rest
))
993 * ".git" followed by NUL or slash is bad. Note that we match
994 * case-insensitively here, even if ignore_case is not set.
995 * This outlaws ".GIT" everywhere out of an abundance of caution,
996 * since there's really no good reason to allow it.
998 * Once we've seen ".git", we can also find ".gitmodules", etc (also
999 * case-insensitively).
1003 if (rest
[1] != 'i' && rest
[1] != 'I')
1005 if (rest
[2] != 't' && rest
[2] != 'T')
1007 if (rest
[3] == '\0' || is_dir_sep(rest
[3]))
1009 if (S_ISLNK(mode
)) {
1011 if (skip_iprefix(rest
, "modules", &rest
) &&
1012 (*rest
== '\0' || is_dir_sep(*rest
)))
1017 if (rest
[1] == '\0' || is_dir_sep(rest
[1]))
1023 static enum verify_path_result
verify_path_internal(const char *path
,
1028 if (has_dos_drive_prefix(path
))
1029 return PATH_INVALID
;
1031 if (!is_valid_path(path
))
1032 return PATH_INVALID
;
1038 if (is_dir_sep(c
)) {
1042 if (is_hfs_dotgit(path
))
1043 return PATH_INVALID
;
1044 if (S_ISLNK(mode
)) {
1045 if (is_hfs_dotgitmodules(path
))
1046 return PATH_INVALID
;
1050 #if defined GIT_WINDOWS_NATIVE || defined __CYGWIN__
1052 return PATH_INVALID
;
1054 if (is_ntfs_dotgit(path
))
1055 return PATH_INVALID
;
1056 if (S_ISLNK(mode
)) {
1057 if (is_ntfs_dotgitmodules(path
))
1058 return PATH_INVALID
;
1063 if ((c
== '.' && !verify_dotfile(path
, mode
)) ||
1065 return PATH_INVALID
;
1067 * allow terminating directory separators for
1068 * sparse directory entries.
1071 return S_ISDIR(mode
) ? PATH_DIR_WITH_SEP
:
1073 } else if (c
== '\\' && protect_ntfs
) {
1074 if (is_ntfs_dotgit(path
))
1075 return PATH_INVALID
;
1076 if (S_ISLNK(mode
)) {
1077 if (is_ntfs_dotgitmodules(path
))
1078 return PATH_INVALID
;
1087 * Do we have another file that has the beginning components being a
1088 * proper superset of the name we're trying to add?
1090 static int has_file_name(struct index_state
*istate
,
1091 const struct cache_entry
*ce
, int pos
, int ok_to_replace
)
1094 int len
= ce_namelen(ce
);
1095 int stage
= ce_stage(ce
);
1096 const char *name
= ce
->name
;
1098 while (pos
< istate
->cache_nr
) {
1099 struct cache_entry
*p
= istate
->cache
[pos
++];
1101 if (len
>= ce_namelen(p
))
1103 if (memcmp(name
, p
->name
, len
))
1105 if (ce_stage(p
) != stage
)
1107 if (p
->name
[len
] != '/')
1109 if (p
->ce_flags
& CE_REMOVE
)
1114 remove_index_entry_at(istate
, --pos
);
1121 * Like strcmp(), but also return the offset of the first change.
1122 * If strings are equal, return the length.
1124 int strcmp_offset(const char *s1
, const char *s2
, size_t *first_change
)
1129 return strcmp(s1
, s2
);
1131 for (k
= 0; s1
[k
] == s2
[k
]; k
++)
1136 return (unsigned char)s1
[k
] - (unsigned char)s2
[k
];
1140 * Do we have another file with a pathname that is a proper
1141 * subset of the name we're trying to add?
1143 * That is, is there another file in the index with a path
1144 * that matches a sub-directory in the given entry?
1146 static int has_dir_name(struct index_state
*istate
,
1147 const struct cache_entry
*ce
, int pos
, int ok_to_replace
)
1150 int stage
= ce_stage(ce
);
1151 const char *name
= ce
->name
;
1152 const char *slash
= name
+ ce_namelen(ce
);
1157 * We are frequently called during an iteration on a sorted
1158 * list of pathnames and while building a new index. Therefore,
1159 * there is a high probability that this entry will eventually
1160 * be appended to the index, rather than inserted in the middle.
1161 * If we can confirm that, we can avoid binary searches on the
1162 * components of the pathname.
1164 * Compare the entry's full path with the last path in the index.
1166 if (istate
->cache_nr
> 0) {
1167 cmp_last
= strcmp_offset(name
,
1168 istate
->cache
[istate
->cache_nr
- 1]->name
,
1171 if (len_eq_last
== 0) {
1173 * The entry sorts AFTER the last one in the
1174 * index and their paths have no common prefix,
1175 * so there cannot be a F/D conflict.
1180 * The entry sorts AFTER the last one in the
1181 * index, but has a common prefix. Fall through
1182 * to the loop below to disect the entry's path
1183 * and see where the difference is.
1186 } else if (cmp_last
== 0) {
1188 * The entry exactly matches the last one in the
1189 * index, but because of multiple stage and CE_REMOVE
1190 * items, we fall through and let the regular search
1200 if (*--slash
== '/')
1202 if (slash
<= ce
->name
)
1209 * (len + 1) is a directory boundary (including
1210 * the trailing slash). And since the loop is
1211 * decrementing "slash", the first iteration is
1212 * the longest directory prefix; subsequent
1213 * iterations consider parent directories.
1216 if (len
+ 1 <= len_eq_last
) {
1218 * The directory prefix (including the trailing
1219 * slash) also appears as a prefix in the last
1220 * entry, so the remainder cannot collide (because
1221 * strcmp said the whole path was greater).
1226 * LT: last: xxx/file_A
1232 if (len
> len_eq_last
) {
1234 * This part of the directory prefix (excluding
1235 * the trailing slash) is longer than the known
1236 * equal portions, so this sub-directory cannot
1237 * collide with a file.
1246 * This is a possible collision. Fall through and
1247 * let the regular search code handle it.
1254 pos
= index_name_stage_pos(istate
, name
, len
, stage
, EXPAND_SPARSE
);
1257 * Found one, but not so fast. This could
1258 * be a marker that says "I was here, but
1259 * I am being removed". Such an entry is
1260 * not a part of the resulting tree, and
1261 * it is Ok to have a directory at the same
1264 if (!(istate
->cache
[pos
]->ce_flags
& CE_REMOVE
)) {
1268 remove_index_entry_at(istate
, pos
);
1276 * Trivial optimization: if we find an entry that
1277 * already matches the sub-directory, then we know
1278 * we're ok, and we can exit.
1280 while (pos
< istate
->cache_nr
) {
1281 struct cache_entry
*p
= istate
->cache
[pos
];
1282 if ((ce_namelen(p
) <= len
) ||
1283 (p
->name
[len
] != '/') ||
1284 memcmp(p
->name
, name
, len
))
1285 break; /* not our subdirectory */
1286 if (ce_stage(p
) == stage
&& !(p
->ce_flags
& CE_REMOVE
))
1288 * p is at the same stage as our entry, and
1289 * is a subdirectory of what we are looking
1290 * at, so we cannot have conflicts at our
1291 * level or anything shorter.
1300 /* We may be in a situation where we already have path/file and path
1301 * is being added, or we already have path and path/file is being
1302 * added. Either one would result in a nonsense tree that has path
1303 * twice when git-write-tree tries to write it out. Prevent it.
1305 * If ok-to-replace is specified, we remove the conflicting entries
1306 * from the cache so the caller should recompute the insert position.
1307 * When this happens, we return non-zero.
1309 static int check_file_directory_conflict(struct index_state
*istate
,
1310 const struct cache_entry
*ce
,
1311 int pos
, int ok_to_replace
)
1316 * When ce is an "I am going away" entry, we allow it to be added
1318 if (ce
->ce_flags
& CE_REMOVE
)
1322 * We check if the path is a sub-path of a subsequent pathname
1323 * first, since removing those will not change the position
1326 retval
= has_file_name(istate
, ce
, pos
, ok_to_replace
);
1329 * Then check if the path might have a clashing sub-directory
1332 return retval
+ has_dir_name(istate
, ce
, pos
, ok_to_replace
);
1335 static int add_index_entry_with_check(struct index_state
*istate
, struct cache_entry
*ce
, int option
)
1338 int ok_to_add
= option
& ADD_CACHE_OK_TO_ADD
;
1339 int ok_to_replace
= option
& ADD_CACHE_OK_TO_REPLACE
;
1340 int skip_df_check
= option
& ADD_CACHE_SKIP_DFCHECK
;
1341 int new_only
= option
& ADD_CACHE_NEW_ONLY
;
1343 if (!(option
& ADD_CACHE_KEEP_CACHE_TREE
))
1344 cache_tree_invalidate_path(istate
, ce
->name
);
1347 * If this entry's path sorts after the last entry in the index,
1348 * we can avoid searching for it.
1350 if (istate
->cache_nr
> 0 &&
1351 strcmp(ce
->name
, istate
->cache
[istate
->cache_nr
- 1]->name
) > 0)
1352 pos
= index_pos_to_insert_pos(istate
->cache_nr
);
1354 pos
= index_name_stage_pos(istate
, ce
->name
, ce_namelen(ce
), ce_stage(ce
), EXPAND_SPARSE
);
1356 /* existing match? Just replace it. */
1359 replace_index_entry(istate
, pos
, ce
);
1364 if (!(option
& ADD_CACHE_KEEP_CACHE_TREE
))
1365 untracked_cache_add_to_index(istate
, ce
->name
);
1368 * Inserting a merged entry ("stage 0") into the index
1369 * will always replace all non-merged entries..
1371 if (pos
< istate
->cache_nr
&& ce_stage(ce
) == 0) {
1372 while (ce_same_name(istate
->cache
[pos
], ce
)) {
1374 if (!remove_index_entry_at(istate
, pos
))
1381 if (verify_path_internal(ce
->name
, ce
->ce_mode
) == PATH_INVALID
)
1382 return error(_("invalid path '%s'"), ce
->name
);
1384 if (!skip_df_check
&&
1385 check_file_directory_conflict(istate
, ce
, pos
, ok_to_replace
)) {
1387 return error(_("'%s' appears as both a file and as a directory"),
1389 pos
= index_name_stage_pos(istate
, ce
->name
, ce_namelen(ce
), ce_stage(ce
), EXPAND_SPARSE
);
1395 int add_index_entry(struct index_state
*istate
, struct cache_entry
*ce
, int option
)
1399 if (option
& ADD_CACHE_JUST_APPEND
)
1400 pos
= istate
->cache_nr
;
1403 ret
= add_index_entry_with_check(istate
, ce
, option
);
1409 /* Make sure the array is big enough .. */
1410 ALLOC_GROW(istate
->cache
, istate
->cache_nr
+ 1, istate
->cache_alloc
);
1414 if (istate
->cache_nr
> pos
+ 1)
1415 MOVE_ARRAY(istate
->cache
+ pos
+ 1, istate
->cache
+ pos
,
1416 istate
->cache_nr
- pos
- 1);
1417 set_index_entry(istate
, pos
, ce
);
1418 istate
->cache_changed
|= CE_ENTRY_ADDED
;
1423 * "refresh" does not calculate a new sha1 file or bring the
1424 * cache up-to-date for mode/content changes. But what it
1425 * _does_ do is to "re-match" the stat information of a file
1426 * with the cache, so that you can refresh the cache for a
1427 * file that hasn't been changed but where the stat entry is
1430 * For example, you'd want to do this after doing a "git-read-tree",
1431 * to link up the stat cache details with the proper files.
1433 static struct cache_entry
*refresh_cache_ent(struct index_state
*istate
,
1434 struct cache_entry
*ce
,
1435 unsigned int options
, int *err
,
1441 struct cache_entry
*updated
;
1443 int refresh
= options
& CE_MATCH_REFRESH
;
1444 int ignore_valid
= options
& CE_MATCH_IGNORE_VALID
;
1445 int ignore_skip_worktree
= options
& CE_MATCH_IGNORE_SKIP_WORKTREE
;
1446 int ignore_missing
= options
& CE_MATCH_IGNORE_MISSING
;
1447 int ignore_fsmonitor
= options
& CE_MATCH_IGNORE_FSMONITOR
;
1449 if (!refresh
|| ce_uptodate(ce
))
1452 if (!ignore_fsmonitor
)
1453 refresh_fsmonitor(istate
);
1455 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1456 * that the change to the work tree does not matter and told
1459 if (!ignore_skip_worktree
&& ce_skip_worktree(ce
)) {
1460 ce_mark_uptodate(ce
);
1463 if (!ignore_valid
&& (ce
->ce_flags
& CE_VALID
)) {
1464 ce_mark_uptodate(ce
);
1467 if (!ignore_fsmonitor
&& (ce
->ce_flags
& CE_FSMONITOR_VALID
)) {
1468 ce_mark_uptodate(ce
);
1472 if (has_symlink_leading_path(ce
->name
, ce_namelen(ce
))) {
1482 if (lstat(ce
->name
, &st
) < 0) {
1483 if (ignore_missing
&& errno
== ENOENT
)
1490 changed
= ie_match_stat(istate
, ce
, &st
, options
);
1492 *changed_ret
= changed
;
1495 * The path is unchanged. If we were told to ignore
1496 * valid bit, then we did the actual stat check and
1497 * found that the entry is unmodified. If the entry
1498 * is not marked VALID, this is the place to mark it
1499 * valid again, under "assume unchanged" mode.
1501 if (ignore_valid
&& assume_unchanged
&&
1502 !(ce
->ce_flags
& CE_VALID
))
1503 ; /* mark this one VALID again */
1506 * We do not mark the index itself "modified"
1507 * because CE_UPTODATE flag is in-core only;
1508 * we are not going to write this change out.
1510 if (!S_ISGITLINK(ce
->ce_mode
)) {
1511 ce_mark_uptodate(ce
);
1512 mark_fsmonitor_valid(istate
, ce
);
1520 if (ie_modified(istate
, ce
, &st
, options
)) {
1526 updated
= make_empty_cache_entry(istate
, ce_namelen(ce
));
1527 copy_cache_entry(updated
, ce
);
1528 memcpy(updated
->name
, ce
->name
, ce
->ce_namelen
+ 1);
1529 fill_stat_cache_info(istate
, updated
, &st
);
1531 * If ignore_valid is not set, we should leave CE_VALID bit
1532 * alone. Otherwise, paths marked with --no-assume-unchanged
1533 * (i.e. things to be edited) will reacquire CE_VALID bit
1534 * automatically, which is not really what we want.
1536 if (!ignore_valid
&& assume_unchanged
&&
1537 !(ce
->ce_flags
& CE_VALID
))
1538 updated
->ce_flags
&= ~CE_VALID
;
1540 /* istate->cache_changed is updated in the caller */
1544 static void show_file(const char * fmt
, const char * name
, int in_porcelain
,
1545 int * first
, const char *header_msg
)
1547 if (in_porcelain
&& *first
&& header_msg
) {
1548 printf("%s\n", header_msg
);
1554 int repo_refresh_and_write_index(struct repository
*repo
,
1555 unsigned int refresh_flags
,
1556 unsigned int write_flags
,
1558 const struct pathspec
*pathspec
,
1559 char *seen
, const char *header_msg
)
1561 struct lock_file lock_file
= LOCK_INIT
;
1564 fd
= repo_hold_locked_index(repo
, &lock_file
, 0);
1565 if (!gentle
&& fd
< 0)
1567 if (refresh_index(repo
->index
, refresh_flags
, pathspec
, seen
, header_msg
))
1569 if (0 <= fd
&& write_locked_index(repo
->index
, &lock_file
, COMMIT_LOCK
| write_flags
))
1575 int refresh_index(struct index_state
*istate
, unsigned int flags
,
1576 const struct pathspec
*pathspec
,
1577 char *seen
, const char *header_msg
)
1581 int really
= (flags
& REFRESH_REALLY
) != 0;
1582 int allow_unmerged
= (flags
& REFRESH_UNMERGED
) != 0;
1583 int quiet
= (flags
& REFRESH_QUIET
) != 0;
1584 int not_new
= (flags
& REFRESH_IGNORE_MISSING
) != 0;
1585 int ignore_submodules
= (flags
& REFRESH_IGNORE_SUBMODULES
) != 0;
1586 int ignore_skip_worktree
= (flags
& REFRESH_IGNORE_SKIP_WORKTREE
) != 0;
1588 int in_porcelain
= (flags
& REFRESH_IN_PORCELAIN
);
1589 unsigned int options
= (CE_MATCH_REFRESH
|
1590 (really
? CE_MATCH_IGNORE_VALID
: 0) |
1591 (not_new
? CE_MATCH_IGNORE_MISSING
: 0));
1592 const char *modified_fmt
;
1593 const char *deleted_fmt
;
1594 const char *typechange_fmt
;
1595 const char *added_fmt
;
1596 const char *unmerged_fmt
;
1597 struct progress
*progress
= NULL
;
1598 int t2_sum_lstat
= 0;
1599 int t2_sum_scan
= 0;
1601 if (flags
& REFRESH_PROGRESS
&& isatty(2))
1602 progress
= start_delayed_progress(_("Refresh index"),
1605 trace_performance_enter();
1606 modified_fmt
= in_porcelain
? "M\t%s\n" : "%s: needs update\n";
1607 deleted_fmt
= in_porcelain
? "D\t%s\n" : "%s: needs update\n";
1608 typechange_fmt
= in_porcelain
? "T\t%s\n" : "%s: needs update\n";
1609 added_fmt
= in_porcelain
? "A\t%s\n" : "%s: needs update\n";
1610 unmerged_fmt
= in_porcelain
? "U\t%s\n" : "%s: needs merge\n";
1612 * Use the multi-threaded preload_index() to refresh most of the
1613 * cache entries quickly then in the single threaded loop below,
1614 * we only have to do the special cases that are left.
1616 preload_index(istate
, pathspec
, 0);
1617 trace2_region_enter("index", "refresh", NULL
);
1619 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1620 struct cache_entry
*ce
, *new_entry
;
1621 int cache_errno
= 0;
1624 int t2_did_lstat
= 0;
1625 int t2_did_scan
= 0;
1627 ce
= istate
->cache
[i
];
1628 if (ignore_submodules
&& S_ISGITLINK(ce
->ce_mode
))
1630 if (ignore_skip_worktree
&& ce_skip_worktree(ce
))
1634 * If this entry is a sparse directory, then there isn't
1635 * any stat() information to update. Ignore the entry.
1637 if (S_ISSPARSEDIR(ce
->ce_mode
))
1640 if (pathspec
&& !ce_path_match(istate
, ce
, pathspec
, seen
))
1644 while ((i
< istate
->cache_nr
) &&
1645 ! strcmp(istate
->cache
[i
]->name
, ce
->name
))
1651 show_file(unmerged_fmt
, ce
->name
, in_porcelain
,
1652 &first
, header_msg
);
1660 new_entry
= refresh_cache_ent(istate
, ce
, options
,
1661 &cache_errno
, &changed
,
1662 &t2_did_lstat
, &t2_did_scan
);
1663 t2_sum_lstat
+= t2_did_lstat
;
1664 t2_sum_scan
+= t2_did_scan
;
1665 if (new_entry
== ce
)
1667 display_progress(progress
, i
);
1671 if (really
&& cache_errno
== EINVAL
) {
1672 /* If we are doing --really-refresh that
1673 * means the index is not valid anymore.
1675 ce
->ce_flags
&= ~CE_VALID
;
1676 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
1677 mark_fsmonitor_invalid(istate
, ce
);
1678 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
1683 if (cache_errno
== ENOENT
)
1685 else if (ce_intent_to_add(ce
))
1686 fmt
= added_fmt
; /* must be before other checks */
1687 else if (changed
& TYPE_CHANGED
)
1688 fmt
= typechange_fmt
;
1692 ce
->name
, in_porcelain
, &first
, header_msg
);
1697 replace_index_entry(istate
, i
, new_entry
);
1699 trace2_data_intmax("index", NULL
, "refresh/sum_lstat", t2_sum_lstat
);
1700 trace2_data_intmax("index", NULL
, "refresh/sum_scan", t2_sum_scan
);
1701 trace2_region_leave("index", "refresh", NULL
);
1702 display_progress(progress
, istate
->cache_nr
);
1703 stop_progress(&progress
);
1704 trace_performance_leave("refresh index");
1708 struct cache_entry
*refresh_cache_entry(struct index_state
*istate
,
1709 struct cache_entry
*ce
,
1710 unsigned int options
)
1712 return refresh_cache_ent(istate
, ce
, options
, NULL
, NULL
, NULL
, NULL
);
1716 /*****************************************************************
1718 *****************************************************************/
1720 #define INDEX_FORMAT_DEFAULT 3
1722 static unsigned int get_index_format_default(struct repository
*r
)
1724 char *envversion
= getenv("GIT_INDEX_VERSION");
1726 unsigned int version
= INDEX_FORMAT_DEFAULT
;
1729 prepare_repo_settings(r
);
1731 if (r
->settings
.index_version
>= 0)
1732 version
= r
->settings
.index_version
;
1733 if (version
< INDEX_FORMAT_LB
|| INDEX_FORMAT_UB
< version
) {
1734 warning(_("index.version set, but the value is invalid.\n"
1735 "Using version %i"), INDEX_FORMAT_DEFAULT
);
1736 return INDEX_FORMAT_DEFAULT
;
1741 version
= strtoul(envversion
, &endp
, 10);
1743 version
< INDEX_FORMAT_LB
|| INDEX_FORMAT_UB
< version
) {
1744 warning(_("GIT_INDEX_VERSION set, but the value is invalid.\n"
1745 "Using version %i"), INDEX_FORMAT_DEFAULT
);
1746 version
= INDEX_FORMAT_DEFAULT
;
1752 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1753 * Again - this is just a (very strong in practice) heuristic that
1754 * the inode hasn't changed.
1756 * We save the fields in big-endian order to allow using the
1757 * index file over NFS transparently.
1759 struct ondisk_cache_entry
{
1760 struct cache_time ctime
;
1761 struct cache_time mtime
;
1769 * unsigned char hash[hashsz];
1771 * if (flags & CE_EXTENDED)
1774 unsigned char data
[GIT_MAX_RAWSZ
+ 2 * sizeof(uint16_t)];
1775 char name
[FLEX_ARRAY
];
1778 /* These are only used for v3 or lower */
1779 #define align_padding_size(size, len) ((size + (len) + 8) & ~7) - (size + len)
1780 #define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,data) + (len) + 8) & ~7)
1781 #define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1782 #define ondisk_data_size(flags, len) (the_hash_algo->rawsz + \
1783 ((flags & CE_EXTENDED) ? 2 : 1) * sizeof(uint16_t) + len)
1784 #define ondisk_data_size_max(len) (ondisk_data_size(CE_EXTENDED, len))
1785 #define ondisk_ce_size(ce) (ondisk_cache_entry_size(ondisk_data_size((ce)->ce_flags, ce_namelen(ce))))
1787 /* Allow fsck to force verification of the index checksum. */
1788 int verify_index_checksum
;
1790 /* Allow fsck to force verification of the cache entry order. */
1791 int verify_ce_order
;
1793 static int verify_hdr(const struct cache_header
*hdr
, unsigned long size
)
1796 unsigned char hash
[GIT_MAX_RAWSZ
];
1799 if (hdr
->hdr_signature
!= htonl(CACHE_SIGNATURE
))
1800 return error(_("bad signature 0x%08x"), hdr
->hdr_signature
);
1801 hdr_version
= ntohl(hdr
->hdr_version
);
1802 if (hdr_version
< INDEX_FORMAT_LB
|| INDEX_FORMAT_UB
< hdr_version
)
1803 return error(_("bad index version %d"), hdr_version
);
1805 if (!verify_index_checksum
)
1808 the_hash_algo
->init_fn(&c
);
1809 the_hash_algo
->update_fn(&c
, hdr
, size
- the_hash_algo
->rawsz
);
1810 the_hash_algo
->final_fn(hash
, &c
);
1811 if (!hasheq(hash
, (unsigned char *)hdr
+ size
- the_hash_algo
->rawsz
))
1812 return error(_("bad index file sha1 signature"));
1816 static int read_index_extension(struct index_state
*istate
,
1817 const char *ext
, const char *data
, unsigned long sz
)
1819 switch (CACHE_EXT(ext
)) {
1820 case CACHE_EXT_TREE
:
1821 istate
->cache_tree
= cache_tree_read(data
, sz
);
1823 case CACHE_EXT_RESOLVE_UNDO
:
1824 istate
->resolve_undo
= resolve_undo_read(data
, sz
);
1826 case CACHE_EXT_LINK
:
1827 if (read_link_extension(istate
, data
, sz
))
1830 case CACHE_EXT_UNTRACKED
:
1831 istate
->untracked
= read_untracked_extension(data
, sz
);
1833 case CACHE_EXT_FSMONITOR
:
1834 read_fsmonitor_extension(istate
, data
, sz
);
1836 case CACHE_EXT_ENDOFINDEXENTRIES
:
1837 case CACHE_EXT_INDEXENTRYOFFSETTABLE
:
1838 /* already handled in do_read_index() */
1840 case CACHE_EXT_SPARSE_DIRECTORIES
:
1841 /* no content, only an indicator */
1842 istate
->sparse_index
= 1;
1845 if (*ext
< 'A' || 'Z' < *ext
)
1846 return error(_("index uses %.4s extension, which we do not understand"),
1848 fprintf_ln(stderr
, _("ignoring %.4s extension"), ext
);
1854 static struct cache_entry
*create_from_disk(struct mem_pool
*ce_mem_pool
,
1855 unsigned int version
,
1856 struct ondisk_cache_entry
*ondisk
,
1857 unsigned long *ent_size
,
1858 const struct cache_entry
*previous_ce
)
1860 struct cache_entry
*ce
;
1863 const unsigned hashsz
= the_hash_algo
->rawsz
;
1864 const uint16_t *flagsp
= (const uint16_t *)(ondisk
->data
+ hashsz
);
1866 size_t copy_len
= 0;
1868 * Adjacent cache entries tend to share the leading paths, so it makes
1869 * sense to only store the differences in later entries. In the v4
1870 * on-disk format of the index, each on-disk cache entry stores the
1871 * number of bytes to be stripped from the end of the previous name,
1872 * and the bytes to append to the result, to come up with its name.
1874 int expand_name_field
= version
== 4;
1876 /* On-disk flags are just 16 bits */
1877 flags
= get_be16(flagsp
);
1878 len
= flags
& CE_NAMEMASK
;
1880 if (flags
& CE_EXTENDED
) {
1882 extended_flags
= get_be16(flagsp
+ 1) << 16;
1883 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1884 if (extended_flags
& ~CE_EXTENDED_FLAGS
)
1885 die(_("unknown index entry format 0x%08x"), extended_flags
);
1886 flags
|= extended_flags
;
1887 name
= (const char *)(flagsp
+ 2);
1890 name
= (const char *)(flagsp
+ 1);
1892 if (expand_name_field
) {
1893 const unsigned char *cp
= (const unsigned char *)name
;
1894 size_t strip_len
, previous_len
;
1896 /* If we're at the beginning of a block, ignore the previous name */
1897 strip_len
= decode_varint(&cp
);
1899 previous_len
= previous_ce
->ce_namelen
;
1900 if (previous_len
< strip_len
)
1901 die(_("malformed name field in the index, near path '%s'"),
1903 copy_len
= previous_len
- strip_len
;
1905 name
= (const char *)cp
;
1908 if (len
== CE_NAMEMASK
) {
1910 if (expand_name_field
)
1914 ce
= mem_pool__ce_alloc(ce_mem_pool
, len
);
1916 ce
->ce_stat_data
.sd_ctime
.sec
= get_be32(&ondisk
->ctime
.sec
);
1917 ce
->ce_stat_data
.sd_mtime
.sec
= get_be32(&ondisk
->mtime
.sec
);
1918 ce
->ce_stat_data
.sd_ctime
.nsec
= get_be32(&ondisk
->ctime
.nsec
);
1919 ce
->ce_stat_data
.sd_mtime
.nsec
= get_be32(&ondisk
->mtime
.nsec
);
1920 ce
->ce_stat_data
.sd_dev
= get_be32(&ondisk
->dev
);
1921 ce
->ce_stat_data
.sd_ino
= get_be32(&ondisk
->ino
);
1922 ce
->ce_mode
= get_be32(&ondisk
->mode
);
1923 ce
->ce_stat_data
.sd_uid
= get_be32(&ondisk
->uid
);
1924 ce
->ce_stat_data
.sd_gid
= get_be32(&ondisk
->gid
);
1925 ce
->ce_stat_data
.sd_size
= get_be32(&ondisk
->size
);
1926 ce
->ce_flags
= flags
& ~CE_NAMEMASK
;
1927 ce
->ce_namelen
= len
;
1929 oidread(&ce
->oid
, ondisk
->data
);
1930 memcpy(ce
->name
, name
, len
);
1931 ce
->name
[len
] = '\0';
1933 if (expand_name_field
) {
1935 memcpy(ce
->name
, previous_ce
->name
, copy_len
);
1936 memcpy(ce
->name
+ copy_len
, name
, len
+ 1 - copy_len
);
1937 *ent_size
= (name
- ((char *)ondisk
)) + len
+ 1 - copy_len
;
1939 memcpy(ce
->name
, name
, len
+ 1);
1940 *ent_size
= ondisk_ce_size(ce
);
1945 static void check_ce_order(struct index_state
*istate
)
1949 if (!verify_ce_order
)
1952 for (i
= 1; i
< istate
->cache_nr
; i
++) {
1953 struct cache_entry
*ce
= istate
->cache
[i
- 1];
1954 struct cache_entry
*next_ce
= istate
->cache
[i
];
1955 int name_compare
= strcmp(ce
->name
, next_ce
->name
);
1957 if (0 < name_compare
)
1958 die(_("unordered stage entries in index"));
1959 if (!name_compare
) {
1961 die(_("multiple stage entries for merged file '%s'"),
1963 if (ce_stage(ce
) > ce_stage(next_ce
))
1964 die(_("unordered stage entries for '%s'"),
1970 static void tweak_untracked_cache(struct index_state
*istate
)
1972 struct repository
*r
= the_repository
;
1974 prepare_repo_settings(r
);
1976 switch (r
->settings
.core_untracked_cache
) {
1977 case UNTRACKED_CACHE_REMOVE
:
1978 remove_untracked_cache(istate
);
1980 case UNTRACKED_CACHE_WRITE
:
1981 add_untracked_cache(istate
);
1983 case UNTRACKED_CACHE_KEEP
:
1985 * Either an explicit "core.untrackedCache=keep", the
1986 * default if "core.untrackedCache" isn't configured,
1987 * or a fallback on an unknown "core.untrackedCache"
1994 static void tweak_split_index(struct index_state
*istate
)
1996 switch (git_config_get_split_index()) {
1997 case -1: /* unset: do nothing */
2000 remove_split_index(istate
);
2003 add_split_index(istate
);
2005 default: /* unknown value: do nothing */
2010 static void post_read_index_from(struct index_state
*istate
)
2012 check_ce_order(istate
);
2013 tweak_untracked_cache(istate
);
2014 tweak_split_index(istate
);
2015 tweak_fsmonitor(istate
);
2018 static size_t estimate_cache_size_from_compressed(unsigned int entries
)
2020 return entries
* (sizeof(struct cache_entry
) + CACHE_ENTRY_PATH_LENGTH
);
2023 static size_t estimate_cache_size(size_t ondisk_size
, unsigned int entries
)
2025 long per_entry
= sizeof(struct cache_entry
) - sizeof(struct ondisk_cache_entry
);
2028 * Account for potential alignment differences.
2030 per_entry
+= align_padding_size(per_entry
, 0);
2031 return ondisk_size
+ entries
* per_entry
;
2034 struct index_entry_offset
2036 /* starting byte offset into index file, count of index entries in this block */
2040 struct index_entry_offset_table
2043 struct index_entry_offset entries
[FLEX_ARRAY
];
2046 static struct index_entry_offset_table
*read_ieot_extension(const char *mmap
, size_t mmap_size
, size_t offset
);
2047 static void write_ieot_extension(struct strbuf
*sb
, struct index_entry_offset_table
*ieot
);
2049 static size_t read_eoie_extension(const char *mmap
, size_t mmap_size
);
2050 static void write_eoie_extension(struct strbuf
*sb
, git_hash_ctx
*eoie_context
, size_t offset
);
2052 struct load_index_extensions
2055 struct index_state
*istate
;
2058 unsigned long src_offset
;
2061 static void *load_index_extensions(void *_data
)
2063 struct load_index_extensions
*p
= _data
;
2064 unsigned long src_offset
= p
->src_offset
;
2066 while (src_offset
<= p
->mmap_size
- the_hash_algo
->rawsz
- 8) {
2067 /* After an array of active_nr index entries,
2068 * there can be arbitrary number of extended
2069 * sections, each of which is prefixed with
2070 * extension name (4-byte) and section length
2071 * in 4-byte network byte order.
2073 uint32_t extsize
= get_be32(p
->mmap
+ src_offset
+ 4);
2074 if (read_index_extension(p
->istate
,
2075 p
->mmap
+ src_offset
,
2076 p
->mmap
+ src_offset
+ 8,
2078 munmap((void *)p
->mmap
, p
->mmap_size
);
2079 die(_("index file corrupt"));
2082 src_offset
+= extsize
;
2089 * A helper function that will load the specified range of cache entries
2090 * from the memory mapped file and add them to the given index.
2092 static unsigned long load_cache_entry_block(struct index_state
*istate
,
2093 struct mem_pool
*ce_mem_pool
, int offset
, int nr
, const char *mmap
,
2094 unsigned long start_offset
, const struct cache_entry
*previous_ce
)
2097 unsigned long src_offset
= start_offset
;
2099 for (i
= offset
; i
< offset
+ nr
; i
++) {
2100 struct ondisk_cache_entry
*disk_ce
;
2101 struct cache_entry
*ce
;
2102 unsigned long consumed
;
2104 disk_ce
= (struct ondisk_cache_entry
*)(mmap
+ src_offset
);
2105 ce
= create_from_disk(ce_mem_pool
, istate
->version
, disk_ce
, &consumed
, previous_ce
);
2106 set_index_entry(istate
, i
, ce
);
2108 src_offset
+= consumed
;
2111 return src_offset
- start_offset
;
2114 static unsigned long load_all_cache_entries(struct index_state
*istate
,
2115 const char *mmap
, size_t mmap_size
, unsigned long src_offset
)
2117 unsigned long consumed
;
2119 istate
->ce_mem_pool
= xmalloc(sizeof(*istate
->ce_mem_pool
));
2120 if (istate
->version
== 4) {
2121 mem_pool_init(istate
->ce_mem_pool
,
2122 estimate_cache_size_from_compressed(istate
->cache_nr
));
2124 mem_pool_init(istate
->ce_mem_pool
,
2125 estimate_cache_size(mmap_size
, istate
->cache_nr
));
2128 consumed
= load_cache_entry_block(istate
, istate
->ce_mem_pool
,
2129 0, istate
->cache_nr
, mmap
, src_offset
, NULL
);
2134 * Mostly randomly chosen maximum thread counts: we
2135 * cap the parallelism to online_cpus() threads, and we want
2136 * to have at least 10000 cache entries per thread for it to
2137 * be worth starting a thread.
2140 #define THREAD_COST (10000)
2142 struct load_cache_entries_thread_data
2145 struct index_state
*istate
;
2146 struct mem_pool
*ce_mem_pool
;
2149 struct index_entry_offset_table
*ieot
;
2150 int ieot_start
; /* starting index into the ieot array */
2151 int ieot_blocks
; /* count of ieot entries to process */
2152 unsigned long consumed
; /* return # of bytes in index file processed */
2156 * A thread proc to run the load_cache_entries() computation
2157 * across multiple background threads.
2159 static void *load_cache_entries_thread(void *_data
)
2161 struct load_cache_entries_thread_data
*p
= _data
;
2164 /* iterate across all ieot blocks assigned to this thread */
2165 for (i
= p
->ieot_start
; i
< p
->ieot_start
+ p
->ieot_blocks
; i
++) {
2166 p
->consumed
+= load_cache_entry_block(p
->istate
, p
->ce_mem_pool
,
2167 p
->offset
, p
->ieot
->entries
[i
].nr
, p
->mmap
, p
->ieot
->entries
[i
].offset
, NULL
);
2168 p
->offset
+= p
->ieot
->entries
[i
].nr
;
2173 static unsigned long load_cache_entries_threaded(struct index_state
*istate
, const char *mmap
, size_t mmap_size
,
2174 int nr_threads
, struct index_entry_offset_table
*ieot
)
2176 int i
, offset
, ieot_blocks
, ieot_start
, err
;
2177 struct load_cache_entries_thread_data
*data
;
2178 unsigned long consumed
= 0;
2180 /* a little sanity checking */
2181 if (istate
->name_hash_initialized
)
2182 BUG("the name hash isn't thread safe");
2184 istate
->ce_mem_pool
= xmalloc(sizeof(*istate
->ce_mem_pool
));
2185 mem_pool_init(istate
->ce_mem_pool
, 0);
2187 /* ensure we have no more threads than we have blocks to process */
2188 if (nr_threads
> ieot
->nr
)
2189 nr_threads
= ieot
->nr
;
2190 CALLOC_ARRAY(data
, nr_threads
);
2192 offset
= ieot_start
= 0;
2193 ieot_blocks
= DIV_ROUND_UP(ieot
->nr
, nr_threads
);
2194 for (i
= 0; i
< nr_threads
; i
++) {
2195 struct load_cache_entries_thread_data
*p
= &data
[i
];
2198 if (ieot_start
+ ieot_blocks
> ieot
->nr
)
2199 ieot_blocks
= ieot
->nr
- ieot_start
;
2205 p
->ieot_start
= ieot_start
;
2206 p
->ieot_blocks
= ieot_blocks
;
2208 /* create a mem_pool for each thread */
2210 for (j
= p
->ieot_start
; j
< p
->ieot_start
+ p
->ieot_blocks
; j
++)
2211 nr
+= p
->ieot
->entries
[j
].nr
;
2212 p
->ce_mem_pool
= xmalloc(sizeof(*istate
->ce_mem_pool
));
2213 if (istate
->version
== 4) {
2214 mem_pool_init(p
->ce_mem_pool
,
2215 estimate_cache_size_from_compressed(nr
));
2217 mem_pool_init(p
->ce_mem_pool
,
2218 estimate_cache_size(mmap_size
, nr
));
2221 err
= pthread_create(&p
->pthread
, NULL
, load_cache_entries_thread
, p
);
2223 die(_("unable to create load_cache_entries thread: %s"), strerror(err
));
2225 /* increment by the number of cache entries in the ieot block being processed */
2226 for (j
= 0; j
< ieot_blocks
; j
++)
2227 offset
+= ieot
->entries
[ieot_start
+ j
].nr
;
2228 ieot_start
+= ieot_blocks
;
2231 for (i
= 0; i
< nr_threads
; i
++) {
2232 struct load_cache_entries_thread_data
*p
= &data
[i
];
2234 err
= pthread_join(p
->pthread
, NULL
);
2236 die(_("unable to join load_cache_entries thread: %s"), strerror(err
));
2237 mem_pool_combine(istate
->ce_mem_pool
, p
->ce_mem_pool
);
2238 consumed
+= p
->consumed
;
2246 /* remember to discard_cache() before reading a different cache! */
2247 int do_read_index(struct index_state
*istate
, const char *path
, int must_exist
)
2251 unsigned long src_offset
;
2252 const struct cache_header
*hdr
;
2255 struct load_index_extensions p
;
2256 size_t extension_offset
= 0;
2257 int nr_threads
, cpus
;
2258 struct index_entry_offset_table
*ieot
= NULL
;
2260 if (istate
->initialized
)
2261 return istate
->cache_nr
;
2263 istate
->timestamp
.sec
= 0;
2264 istate
->timestamp
.nsec
= 0;
2265 fd
= open(path
, O_RDONLY
);
2267 if (!must_exist
&& errno
== ENOENT
)
2269 die_errno(_("%s: index file open failed"), path
);
2273 die_errno(_("%s: cannot stat the open index"), path
);
2275 mmap_size
= xsize_t(st
.st_size
);
2276 if (mmap_size
< sizeof(struct cache_header
) + the_hash_algo
->rawsz
)
2277 die(_("%s: index file smaller than expected"), path
);
2279 mmap
= xmmap_gently(NULL
, mmap_size
, PROT_READ
, MAP_PRIVATE
, fd
, 0);
2280 if (mmap
== MAP_FAILED
)
2281 die_errno(_("%s: unable to map index file%s"), path
,
2285 hdr
= (const struct cache_header
*)mmap
;
2286 if (verify_hdr(hdr
, mmap_size
) < 0)
2289 oidread(&istate
->oid
, (const unsigned char *)hdr
+ mmap_size
- the_hash_algo
->rawsz
);
2290 istate
->version
= ntohl(hdr
->hdr_version
);
2291 istate
->cache_nr
= ntohl(hdr
->hdr_entries
);
2292 istate
->cache_alloc
= alloc_nr(istate
->cache_nr
);
2293 CALLOC_ARRAY(istate
->cache
, istate
->cache_alloc
);
2294 istate
->initialized
= 1;
2298 p
.mmap_size
= mmap_size
;
2300 src_offset
= sizeof(*hdr
);
2302 if (git_config_get_index_threads(&nr_threads
))
2305 /* TODO: does creating more threads than cores help? */
2307 nr_threads
= istate
->cache_nr
/ THREAD_COST
;
2308 cpus
= online_cpus();
2309 if (nr_threads
> cpus
)
2316 if (nr_threads
> 1) {
2317 extension_offset
= read_eoie_extension(mmap
, mmap_size
);
2318 if (extension_offset
) {
2321 p
.src_offset
= extension_offset
;
2322 err
= pthread_create(&p
.pthread
, NULL
, load_index_extensions
, &p
);
2324 die(_("unable to create load_index_extensions thread: %s"), strerror(err
));
2331 * Locate and read the index entry offset table so that we can use it
2332 * to multi-thread the reading of the cache entries.
2334 if (extension_offset
&& nr_threads
> 1)
2335 ieot
= read_ieot_extension(mmap
, mmap_size
, extension_offset
);
2338 src_offset
+= load_cache_entries_threaded(istate
, mmap
, mmap_size
, nr_threads
, ieot
);
2341 src_offset
+= load_all_cache_entries(istate
, mmap
, mmap_size
, src_offset
);
2344 istate
->timestamp
.sec
= st
.st_mtime
;
2345 istate
->timestamp
.nsec
= ST_MTIME_NSEC(st
);
2347 /* if we created a thread, join it otherwise load the extensions on the primary thread */
2348 if (extension_offset
) {
2349 int ret
= pthread_join(p
.pthread
, NULL
);
2351 die(_("unable to join load_index_extensions thread: %s"), strerror(ret
));
2353 p
.src_offset
= src_offset
;
2354 load_index_extensions(&p
);
2356 munmap((void *)mmap
, mmap_size
);
2359 * TODO trace2: replace "the_repository" with the actual repo instance
2360 * that is associated with the given "istate".
2362 trace2_data_intmax("index", the_repository
, "read/version",
2364 trace2_data_intmax("index", the_repository
, "read/cache_nr",
2368 istate
->repo
= the_repository
;
2371 * If the command explicitly requires a full index, force it
2372 * to be full. Otherwise, correct the sparsity based on repository
2373 * settings and other properties of the index (if necessary).
2375 prepare_repo_settings(istate
->repo
);
2376 if (istate
->repo
->settings
.command_requires_full_index
)
2377 ensure_full_index(istate
);
2379 ensure_correct_sparsity(istate
);
2381 return istate
->cache_nr
;
2384 munmap((void *)mmap
, mmap_size
);
2385 die(_("index file corrupt"));
2389 * Signal that the shared index is used by updating its mtime.
2391 * This way, shared index can be removed if they have not been used
2394 static void freshen_shared_index(const char *shared_index
, int warn
)
2396 if (!check_and_freshen_file(shared_index
, 1) && warn
)
2397 warning(_("could not freshen shared index '%s'"), shared_index
);
2400 int read_index_from(struct index_state
*istate
, const char *path
,
2403 struct split_index
*split_index
;
2408 /* istate->initialized covers both .git/index and .git/sharedindex.xxx */
2409 if (istate
->initialized
)
2410 return istate
->cache_nr
;
2413 * TODO trace2: replace "the_repository" with the actual repo instance
2414 * that is associated with the given "istate".
2416 trace2_region_enter_printf("index", "do_read_index", the_repository
,
2418 trace_performance_enter();
2419 ret
= do_read_index(istate
, path
, 0);
2420 trace_performance_leave("read cache %s", path
);
2421 trace2_region_leave_printf("index", "do_read_index", the_repository
,
2424 split_index
= istate
->split_index
;
2425 if (!split_index
|| is_null_oid(&split_index
->base_oid
)) {
2426 post_read_index_from(istate
);
2430 trace_performance_enter();
2431 if (split_index
->base
)
2432 discard_index(split_index
->base
);
2434 CALLOC_ARRAY(split_index
->base
, 1);
2436 base_oid_hex
= oid_to_hex(&split_index
->base_oid
);
2437 base_path
= xstrfmt("%s/sharedindex.%s", gitdir
, base_oid_hex
);
2438 trace2_region_enter_printf("index", "shared/do_read_index",
2439 the_repository
, "%s", base_path
);
2440 ret
= do_read_index(split_index
->base
, base_path
, 0);
2441 trace2_region_leave_printf("index", "shared/do_read_index",
2442 the_repository
, "%s", base_path
);
2444 char *path_copy
= xstrdup(path
);
2445 const char *base_path2
= xstrfmt("%s/sharedindex.%s",
2449 trace2_region_enter_printf("index", "shared/do_read_index",
2450 the_repository
, "%s", base_path2
);
2451 ret
= do_read_index(split_index
->base
, base_path2
, 1);
2452 trace2_region_leave_printf("index", "shared/do_read_index",
2453 the_repository
, "%s", base_path2
);
2455 if (!oideq(&split_index
->base_oid
, &split_index
->base
->oid
))
2456 die(_("broken index, expect %s in %s, got %s"),
2457 base_oid_hex
, base_path
,
2458 oid_to_hex(&split_index
->base
->oid
));
2460 freshen_shared_index(base_path
, 0);
2461 merge_base_index(istate
);
2462 post_read_index_from(istate
);
2463 trace_performance_leave("read cache %s", base_path
);
2468 int is_index_unborn(struct index_state
*istate
)
2470 return (!istate
->cache_nr
&& !istate
->timestamp
.sec
);
2473 int discard_index(struct index_state
*istate
)
2476 * Cache entries in istate->cache[] should have been allocated
2477 * from the memory pool associated with this index, or from an
2478 * associated split_index. There is no need to free individual
2479 * cache entries. validate_cache_entries can detect when this
2480 * assertion does not hold.
2482 validate_cache_entries(istate
);
2484 resolve_undo_clear_index(istate
);
2485 istate
->cache_nr
= 0;
2486 istate
->cache_changed
= 0;
2487 istate
->timestamp
.sec
= 0;
2488 istate
->timestamp
.nsec
= 0;
2489 free_name_hash(istate
);
2490 cache_tree_free(&(istate
->cache_tree
));
2491 istate
->initialized
= 0;
2492 istate
->fsmonitor_has_run_once
= 0;
2493 FREE_AND_NULL(istate
->fsmonitor_last_update
);
2494 FREE_AND_NULL(istate
->cache
);
2495 istate
->cache_alloc
= 0;
2496 discard_split_index(istate
);
2497 free_untracked_cache(istate
->untracked
);
2498 istate
->untracked
= NULL
;
2500 if (istate
->ce_mem_pool
) {
2501 mem_pool_discard(istate
->ce_mem_pool
, should_validate_cache_entries());
2502 FREE_AND_NULL(istate
->ce_mem_pool
);
2509 * Validate the cache entries of this index.
2510 * All cache entries associated with this index
2511 * should have been allocated by the memory pool
2512 * associated with this index, or by a referenced
2515 void validate_cache_entries(const struct index_state
*istate
)
2519 if (!should_validate_cache_entries() ||!istate
|| !istate
->initialized
)
2522 for (i
= 0; i
< istate
->cache_nr
; i
++) {
2524 BUG("cache entry is not allocated from expected memory pool");
2525 } else if (!istate
->ce_mem_pool
||
2526 !mem_pool_contains(istate
->ce_mem_pool
, istate
->cache
[i
])) {
2527 if (!istate
->split_index
||
2528 !istate
->split_index
->base
||
2529 !istate
->split_index
->base
->ce_mem_pool
||
2530 !mem_pool_contains(istate
->split_index
->base
->ce_mem_pool
, istate
->cache
[i
])) {
2531 BUG("cache entry is not allocated from expected memory pool");
2536 if (istate
->split_index
)
2537 validate_cache_entries(istate
->split_index
->base
);
2540 int unmerged_index(const struct index_state
*istate
)
2543 for (i
= 0; i
< istate
->cache_nr
; i
++) {
2544 if (ce_stage(istate
->cache
[i
]))
2550 int repo_index_has_changes(struct repository
*repo
,
2554 struct index_state
*istate
= repo
->index
;
2555 struct object_id cmp
;
2559 cmp
= tree
->object
.oid
;
2560 if (tree
|| !get_oid_tree("HEAD", &cmp
)) {
2561 struct diff_options opt
;
2563 repo_diff_setup(repo
, &opt
);
2564 opt
.flags
.exit_with_status
= 1;
2566 opt
.flags
.quick
= 1;
2567 diff_setup_done(&opt
);
2568 do_diff_cache(&cmp
, &opt
);
2570 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
2572 strbuf_addch(sb
, ' ');
2573 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
2576 return opt
.flags
.has_changes
!= 0;
2578 /* TODO: audit for interaction with sparse-index. */
2579 ensure_full_index(istate
);
2580 for (i
= 0; sb
&& i
< istate
->cache_nr
; i
++) {
2582 strbuf_addch(sb
, ' ');
2583 strbuf_addstr(sb
, istate
->cache
[i
]->name
);
2585 return !!istate
->cache_nr
;
2589 static int write_index_ext_header(struct hashfile
*f
,
2590 git_hash_ctx
*eoie_f
,
2594 hashwrite_be32(f
, ext
);
2595 hashwrite_be32(f
, sz
);
2600 the_hash_algo
->update_fn(eoie_f
, &ext
, sizeof(ext
));
2601 the_hash_algo
->update_fn(eoie_f
, &sz
, sizeof(sz
));
2606 static void ce_smudge_racily_clean_entry(struct index_state
*istate
,
2607 struct cache_entry
*ce
)
2610 * The only thing we care about in this function is to smudge the
2611 * falsely clean entry due to touch-update-touch race, so we leave
2612 * everything else as they are. We are called for entries whose
2613 * ce_stat_data.sd_mtime match the index file mtime.
2615 * Note that this actually does not do much for gitlinks, for
2616 * which ce_match_stat_basic() always goes to the actual
2617 * contents. The caller checks with is_racy_timestamp() which
2618 * always says "no" for gitlinks, so we are not called for them ;-)
2622 if (lstat(ce
->name
, &st
) < 0)
2624 if (ce_match_stat_basic(ce
, &st
))
2626 if (ce_modified_check_fs(istate
, ce
, &st
)) {
2627 /* This is "racily clean"; smudge it. Note that this
2628 * is a tricky code. At first glance, it may appear
2629 * that it can break with this sequence:
2631 * $ echo xyzzy >frotz
2632 * $ git-update-index --add frotz
2635 * $ echo filfre >nitfol
2636 * $ git-update-index --add nitfol
2638 * but it does not. When the second update-index runs,
2639 * it notices that the entry "frotz" has the same timestamp
2640 * as index, and if we were to smudge it by resetting its
2641 * size to zero here, then the object name recorded
2642 * in index is the 6-byte file but the cached stat information
2643 * becomes zero --- which would then match what we would
2644 * obtain from the filesystem next time we stat("frotz").
2646 * However, the second update-index, before calling
2647 * this function, notices that the cached size is 6
2648 * bytes and what is on the filesystem is an empty
2649 * file, and never calls us, so the cached size information
2650 * for "frotz" stays 6 which does not match the filesystem.
2652 ce
->ce_stat_data
.sd_size
= 0;
2656 /* Copy miscellaneous fields but not the name */
2657 static void copy_cache_entry_to_ondisk(struct ondisk_cache_entry
*ondisk
,
2658 struct cache_entry
*ce
)
2661 const unsigned hashsz
= the_hash_algo
->rawsz
;
2662 uint16_t *flagsp
= (uint16_t *)(ondisk
->data
+ hashsz
);
2664 ondisk
->ctime
.sec
= htonl(ce
->ce_stat_data
.sd_ctime
.sec
);
2665 ondisk
->mtime
.sec
= htonl(ce
->ce_stat_data
.sd_mtime
.sec
);
2666 ondisk
->ctime
.nsec
= htonl(ce
->ce_stat_data
.sd_ctime
.nsec
);
2667 ondisk
->mtime
.nsec
= htonl(ce
->ce_stat_data
.sd_mtime
.nsec
);
2668 ondisk
->dev
= htonl(ce
->ce_stat_data
.sd_dev
);
2669 ondisk
->ino
= htonl(ce
->ce_stat_data
.sd_ino
);
2670 ondisk
->mode
= htonl(ce
->ce_mode
);
2671 ondisk
->uid
= htonl(ce
->ce_stat_data
.sd_uid
);
2672 ondisk
->gid
= htonl(ce
->ce_stat_data
.sd_gid
);
2673 ondisk
->size
= htonl(ce
->ce_stat_data
.sd_size
);
2674 hashcpy(ondisk
->data
, ce
->oid
.hash
);
2676 flags
= ce
->ce_flags
& ~CE_NAMEMASK
;
2677 flags
|= (ce_namelen(ce
) >= CE_NAMEMASK
? CE_NAMEMASK
: ce_namelen(ce
));
2678 flagsp
[0] = htons(flags
);
2679 if (ce
->ce_flags
& CE_EXTENDED
) {
2680 flagsp
[1] = htons((ce
->ce_flags
& CE_EXTENDED_FLAGS
) >> 16);
2684 static int ce_write_entry(struct hashfile
*f
, struct cache_entry
*ce
,
2685 struct strbuf
*previous_name
, struct ondisk_cache_entry
*ondisk
)
2688 unsigned int saved_namelen
;
2689 int stripped_name
= 0;
2690 static unsigned char padding
[8] = { 0x00 };
2692 if (ce
->ce_flags
& CE_STRIP_NAME
) {
2693 saved_namelen
= ce_namelen(ce
);
2698 size
= offsetof(struct ondisk_cache_entry
,data
) + ondisk_data_size(ce
->ce_flags
, 0);
2700 if (!previous_name
) {
2701 int len
= ce_namelen(ce
);
2702 copy_cache_entry_to_ondisk(ondisk
, ce
);
2703 hashwrite(f
, ondisk
, size
);
2704 hashwrite(f
, ce
->name
, len
);
2705 hashwrite(f
, padding
, align_padding_size(size
, len
));
2707 int common
, to_remove
, prefix_size
;
2708 unsigned char to_remove_vi
[16];
2710 (ce
->name
[common
] &&
2711 common
< previous_name
->len
&&
2712 ce
->name
[common
] == previous_name
->buf
[common
]);
2714 ; /* still matching */
2715 to_remove
= previous_name
->len
- common
;
2716 prefix_size
= encode_varint(to_remove
, to_remove_vi
);
2718 copy_cache_entry_to_ondisk(ondisk
, ce
);
2719 hashwrite(f
, ondisk
, size
);
2720 hashwrite(f
, to_remove_vi
, prefix_size
);
2721 hashwrite(f
, ce
->name
+ common
, ce_namelen(ce
) - common
);
2722 hashwrite(f
, padding
, 1);
2724 strbuf_splice(previous_name
, common
, to_remove
,
2725 ce
->name
+ common
, ce_namelen(ce
) - common
);
2727 if (stripped_name
) {
2728 ce
->ce_namelen
= saved_namelen
;
2729 ce
->ce_flags
&= ~CE_STRIP_NAME
;
2736 * This function verifies if index_state has the correct sha1 of the
2737 * index file. Don't die if we have any other failure, just return 0.
2739 static int verify_index_from(const struct index_state
*istate
, const char *path
)
2744 unsigned char hash
[GIT_MAX_RAWSZ
];
2746 if (!istate
->initialized
)
2749 fd
= open(path
, O_RDONLY
);
2756 if (st
.st_size
< sizeof(struct cache_header
) + the_hash_algo
->rawsz
)
2759 n
= pread_in_full(fd
, hash
, the_hash_algo
->rawsz
, st
.st_size
- the_hash_algo
->rawsz
);
2760 if (n
!= the_hash_algo
->rawsz
)
2763 if (!hasheq(istate
->oid
.hash
, hash
))
2774 static int repo_verify_index(struct repository
*repo
)
2776 return verify_index_from(repo
->index
, repo
->index_file
);
2779 int has_racy_timestamp(struct index_state
*istate
)
2781 int entries
= istate
->cache_nr
;
2784 for (i
= 0; i
< entries
; i
++) {
2785 struct cache_entry
*ce
= istate
->cache
[i
];
2786 if (is_racy_timestamp(istate
, ce
))
2792 void repo_update_index_if_able(struct repository
*repo
,
2793 struct lock_file
*lockfile
)
2795 if ((repo
->index
->cache_changed
||
2796 has_racy_timestamp(repo
->index
)) &&
2797 repo_verify_index(repo
))
2798 write_locked_index(repo
->index
, lockfile
, COMMIT_LOCK
);
2800 rollback_lock_file(lockfile
);
2803 static int record_eoie(void)
2807 if (!git_config_get_bool("index.recordendofindexentries", &val
))
2811 * As a convenience, the end of index entries extension
2812 * used for threading is written by default if the user
2813 * explicitly requested threaded index reads.
2815 return !git_config_get_index_threads(&val
) && val
!= 1;
2818 static int record_ieot(void)
2822 if (!git_config_get_bool("index.recordoffsettable", &val
))
2826 * As a convenience, the offset table used for threading is
2827 * written by default if the user explicitly requested
2828 * threaded index reads.
2830 return !git_config_get_index_threads(&val
) && val
!= 1;
2834 * On success, `tempfile` is closed. If it is the temporary file
2835 * of a `struct lock_file`, we will therefore effectively perform
2836 * a 'close_lock_file_gently()`. Since that is an implementation
2837 * detail of lockfiles, callers of `do_write_index()` should not
2840 static int do_write_index(struct index_state
*istate
, struct tempfile
*tempfile
,
2841 int strip_extensions
)
2843 uint64_t start
= getnanotime();
2845 git_hash_ctx
*eoie_c
= NULL
;
2846 struct cache_header hdr
;
2847 int i
, err
= 0, removed
, extended
, hdr_version
;
2848 struct cache_entry
**cache
= istate
->cache
;
2849 int entries
= istate
->cache_nr
;
2851 struct ondisk_cache_entry ondisk
;
2852 struct strbuf previous_name_buf
= STRBUF_INIT
, *previous_name
;
2853 int drop_cache_tree
= istate
->drop_cache_tree
;
2855 int ieot_entries
= 1;
2856 struct index_entry_offset_table
*ieot
= NULL
;
2859 f
= hashfd(tempfile
->fd
, tempfile
->filename
.buf
);
2861 for (i
= removed
= extended
= 0; i
< entries
; i
++) {
2862 if (cache
[i
]->ce_flags
& CE_REMOVE
)
2865 /* reduce extended entries if possible */
2866 cache
[i
]->ce_flags
&= ~CE_EXTENDED
;
2867 if (cache
[i
]->ce_flags
& CE_EXTENDED_FLAGS
) {
2869 cache
[i
]->ce_flags
|= CE_EXTENDED
;
2873 if (!istate
->version
)
2874 istate
->version
= get_index_format_default(the_repository
);
2876 /* demote version 3 to version 2 when the latter suffices */
2877 if (istate
->version
== 3 || istate
->version
== 2)
2878 istate
->version
= extended
? 3 : 2;
2880 hdr_version
= istate
->version
;
2882 hdr
.hdr_signature
= htonl(CACHE_SIGNATURE
);
2883 hdr
.hdr_version
= htonl(hdr_version
);
2884 hdr
.hdr_entries
= htonl(entries
- removed
);
2886 hashwrite(f
, &hdr
, sizeof(hdr
));
2888 if (!HAVE_THREADS
|| git_config_get_index_threads(&nr_threads
))
2891 if (nr_threads
!= 1 && record_ieot()) {
2892 int ieot_blocks
, cpus
;
2895 * ensure default number of ieot blocks maps evenly to the
2896 * default number of threads that will process them leaving
2897 * room for the thread to load the index extensions.
2900 ieot_blocks
= istate
->cache_nr
/ THREAD_COST
;
2901 cpus
= online_cpus();
2902 if (ieot_blocks
> cpus
- 1)
2903 ieot_blocks
= cpus
- 1;
2905 ieot_blocks
= nr_threads
;
2906 if (ieot_blocks
> istate
->cache_nr
)
2907 ieot_blocks
= istate
->cache_nr
;
2911 * no reason to write out the IEOT extension if we don't
2912 * have enough blocks to utilize multi-threading
2914 if (ieot_blocks
> 1) {
2915 ieot
= xcalloc(1, sizeof(struct index_entry_offset_table
)
2916 + (ieot_blocks
* sizeof(struct index_entry_offset
)));
2917 ieot_entries
= DIV_ROUND_UP(entries
, ieot_blocks
);
2921 offset
= hashfile_total(f
);
2924 previous_name
= (hdr_version
== 4) ? &previous_name_buf
: NULL
;
2926 for (i
= 0; i
< entries
; i
++) {
2927 struct cache_entry
*ce
= cache
[i
];
2928 if (ce
->ce_flags
& CE_REMOVE
)
2930 if (!ce_uptodate(ce
) && is_racy_timestamp(istate
, ce
))
2931 ce_smudge_racily_clean_entry(istate
, ce
);
2932 if (is_null_oid(&ce
->oid
)) {
2933 static const char msg
[] = "cache entry has null sha1: %s";
2934 static int allow
= -1;
2937 allow
= git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
2939 warning(msg
, ce
->name
);
2941 err
= error(msg
, ce
->name
);
2943 drop_cache_tree
= 1;
2945 if (ieot
&& i
&& (i
% ieot_entries
== 0)) {
2946 ieot
->entries
[ieot
->nr
].nr
= nr
;
2947 ieot
->entries
[ieot
->nr
].offset
= offset
;
2950 * If we have a V4 index, set the first byte to an invalid
2951 * character to ensure there is nothing common with the previous
2955 previous_name
->buf
[0] = 0;
2958 offset
= hashfile_total(f
);
2960 if (ce_write_entry(f
, ce
, previous_name
, (struct ondisk_cache_entry
*)&ondisk
) < 0)
2968 ieot
->entries
[ieot
->nr
].nr
= nr
;
2969 ieot
->entries
[ieot
->nr
].offset
= offset
;
2972 strbuf_release(&previous_name_buf
);
2979 offset
= hashfile_total(f
);
2982 * The extension headers must be hashed on their own for the
2983 * EOIE extension. Create a hashfile here to compute that hash.
2985 if (offset
&& record_eoie()) {
2986 CALLOC_ARRAY(eoie_c
, 1);
2987 the_hash_algo
->init_fn(eoie_c
);
2991 * Lets write out CACHE_EXT_INDEXENTRYOFFSETTABLE first so that we
2992 * can minimize the number of extensions we have to scan through to
2993 * find it during load. Write it out regardless of the
2994 * strip_extensions parameter as we need it when loading the shared
2998 struct strbuf sb
= STRBUF_INIT
;
3000 write_ieot_extension(&sb
, ieot
);
3001 err
= write_index_ext_header(f
, eoie_c
, CACHE_EXT_INDEXENTRYOFFSETTABLE
, sb
.len
) < 0;
3002 hashwrite(f
, sb
.buf
, sb
.len
);
3003 strbuf_release(&sb
);
3009 if (!strip_extensions
&& istate
->split_index
&&
3010 !is_null_oid(&istate
->split_index
->base_oid
)) {
3011 struct strbuf sb
= STRBUF_INIT
;
3013 if (istate
->sparse_index
)
3014 die(_("cannot write split index for a sparse index"));
3016 err
= write_link_extension(&sb
, istate
) < 0 ||
3017 write_index_ext_header(f
, eoie_c
, CACHE_EXT_LINK
,
3019 hashwrite(f
, sb
.buf
, sb
.len
);
3020 strbuf_release(&sb
);
3024 if (!strip_extensions
&& !drop_cache_tree
&& istate
->cache_tree
) {
3025 struct strbuf sb
= STRBUF_INIT
;
3027 cache_tree_write(&sb
, istate
->cache_tree
);
3028 err
= write_index_ext_header(f
, eoie_c
, CACHE_EXT_TREE
, sb
.len
) < 0;
3029 hashwrite(f
, sb
.buf
, sb
.len
);
3030 strbuf_release(&sb
);
3034 if (!strip_extensions
&& istate
->resolve_undo
) {
3035 struct strbuf sb
= STRBUF_INIT
;
3037 resolve_undo_write(&sb
, istate
->resolve_undo
);
3038 err
= write_index_ext_header(f
, eoie_c
, CACHE_EXT_RESOLVE_UNDO
,
3040 hashwrite(f
, sb
.buf
, sb
.len
);
3041 strbuf_release(&sb
);
3045 if (!strip_extensions
&& istate
->untracked
) {
3046 struct strbuf sb
= STRBUF_INIT
;
3048 write_untracked_extension(&sb
, istate
->untracked
);
3049 err
= write_index_ext_header(f
, eoie_c
, CACHE_EXT_UNTRACKED
,
3051 hashwrite(f
, sb
.buf
, sb
.len
);
3052 strbuf_release(&sb
);
3056 if (!strip_extensions
&& istate
->fsmonitor_last_update
) {
3057 struct strbuf sb
= STRBUF_INIT
;
3059 write_fsmonitor_extension(&sb
, istate
);
3060 err
= write_index_ext_header(f
, eoie_c
, CACHE_EXT_FSMONITOR
, sb
.len
) < 0;
3061 hashwrite(f
, sb
.buf
, sb
.len
);
3062 strbuf_release(&sb
);
3066 if (istate
->sparse_index
) {
3067 if (write_index_ext_header(f
, eoie_c
, CACHE_EXT_SPARSE_DIRECTORIES
, 0) < 0)
3072 * CACHE_EXT_ENDOFINDEXENTRIES must be written as the last entry before the SHA1
3073 * so that it can be found and processed before all the index entries are
3074 * read. Write it out regardless of the strip_extensions parameter as we need it
3075 * when loading the shared index.
3078 struct strbuf sb
= STRBUF_INIT
;
3080 write_eoie_extension(&sb
, eoie_c
, offset
);
3081 err
= write_index_ext_header(f
, NULL
, CACHE_EXT_ENDOFINDEXENTRIES
, sb
.len
) < 0;
3082 hashwrite(f
, sb
.buf
, sb
.len
);
3083 strbuf_release(&sb
);
3088 finalize_hashfile(f
, istate
->oid
.hash
, CSUM_HASH_IN_STREAM
);
3089 if (close_tempfile_gently(tempfile
)) {
3090 error(_("could not close '%s'"), get_tempfile_path(tempfile
));
3093 if (stat(get_tempfile_path(tempfile
), &st
))
3095 istate
->timestamp
.sec
= (unsigned int)st
.st_mtime
;
3096 istate
->timestamp
.nsec
= ST_MTIME_NSEC(st
);
3097 trace_performance_since(start
, "write index, changed mask = %x", istate
->cache_changed
);
3100 * TODO trace2: replace "the_repository" with the actual repo instance
3101 * that is associated with the given "istate".
3103 trace2_data_intmax("index", the_repository
, "write/version",
3105 trace2_data_intmax("index", the_repository
, "write/cache_nr",
3111 void set_alternate_index_output(const char *name
)
3113 alternate_index_output
= name
;
3116 static int commit_locked_index(struct lock_file
*lk
)
3118 if (alternate_index_output
)
3119 return commit_lock_file_to(lk
, alternate_index_output
);
3121 return commit_lock_file(lk
);
3124 static int do_write_locked_index(struct index_state
*istate
, struct lock_file
*lock
,
3128 int was_full
= !istate
->sparse_index
;
3130 ret
= convert_to_sparse(istate
, 0);
3133 warning(_("failed to convert to a sparse-index"));
3138 * TODO trace2: replace "the_repository" with the actual repo instance
3139 * that is associated with the given "istate".
3141 trace2_region_enter_printf("index", "do_write_index", the_repository
,
3142 "%s", get_lock_file_path(lock
));
3143 ret
= do_write_index(istate
, lock
->tempfile
, 0);
3144 trace2_region_leave_printf("index", "do_write_index", the_repository
,
3145 "%s", get_lock_file_path(lock
));
3148 ensure_full_index(istate
);
3152 if (flags
& COMMIT_LOCK
)
3153 ret
= commit_locked_index(lock
);
3155 ret
= close_lock_file_gently(lock
);
3157 run_hooks_l("post-index-change",
3158 istate
->updated_workdir
? "1" : "0",
3159 istate
->updated_skipworktree
? "1" : "0", NULL
);
3160 istate
->updated_workdir
= 0;
3161 istate
->updated_skipworktree
= 0;
3166 static int write_split_index(struct index_state
*istate
,
3167 struct lock_file
*lock
,
3171 prepare_to_write_split_index(istate
);
3172 ret
= do_write_locked_index(istate
, lock
, flags
);
3173 finish_writing_split_index(istate
);
3177 static const char *shared_index_expire
= "2.weeks.ago";
3179 static unsigned long get_shared_index_expire_date(void)
3181 static unsigned long shared_index_expire_date
;
3182 static int shared_index_expire_date_prepared
;
3184 if (!shared_index_expire_date_prepared
) {
3185 git_config_get_expiry("splitindex.sharedindexexpire",
3186 &shared_index_expire
);
3187 shared_index_expire_date
= approxidate(shared_index_expire
);
3188 shared_index_expire_date_prepared
= 1;
3191 return shared_index_expire_date
;
3194 static int should_delete_shared_index(const char *shared_index_path
)
3197 unsigned long expiration
;
3199 /* Check timestamp */
3200 expiration
= get_shared_index_expire_date();
3203 if (stat(shared_index_path
, &st
))
3204 return error_errno(_("could not stat '%s'"), shared_index_path
);
3205 if (st
.st_mtime
> expiration
)
3211 static int clean_shared_index_files(const char *current_hex
)
3214 DIR *dir
= opendir(get_git_dir());
3217 return error_errno(_("unable to open git dir: %s"), get_git_dir());
3219 while ((de
= readdir(dir
)) != NULL
) {
3220 const char *sha1_hex
;
3221 const char *shared_index_path
;
3222 if (!skip_prefix(de
->d_name
, "sharedindex.", &sha1_hex
))
3224 if (!strcmp(sha1_hex
, current_hex
))
3226 shared_index_path
= git_path("%s", de
->d_name
);
3227 if (should_delete_shared_index(shared_index_path
) > 0 &&
3228 unlink(shared_index_path
))
3229 warning_errno(_("unable to unlink: %s"), shared_index_path
);
3236 static int write_shared_index(struct index_state
*istate
,
3237 struct tempfile
**temp
)
3239 struct split_index
*si
= istate
->split_index
;
3240 int ret
, was_full
= !istate
->sparse_index
;
3242 move_cache_to_base_index(istate
);
3243 convert_to_sparse(istate
, 0);
3245 trace2_region_enter_printf("index", "shared/do_write_index",
3246 the_repository
, "%s", get_tempfile_path(*temp
));
3247 ret
= do_write_index(si
->base
, *temp
, 1);
3248 trace2_region_leave_printf("index", "shared/do_write_index",
3249 the_repository
, "%s", get_tempfile_path(*temp
));
3252 ensure_full_index(istate
);
3256 ret
= adjust_shared_perm(get_tempfile_path(*temp
));
3258 error(_("cannot fix permission bits on '%s'"), get_tempfile_path(*temp
));
3261 ret
= rename_tempfile(temp
,
3262 git_path("sharedindex.%s", oid_to_hex(&si
->base
->oid
)));
3264 oidcpy(&si
->base_oid
, &si
->base
->oid
);
3265 clean_shared_index_files(oid_to_hex(&si
->base
->oid
));
3271 static const int default_max_percent_split_change
= 20;
3273 static int too_many_not_shared_entries(struct index_state
*istate
)
3275 int i
, not_shared
= 0;
3276 int max_split
= git_config_get_max_percent_split_change();
3278 switch (max_split
) {
3280 /* not or badly configured: use the default value */
3281 max_split
= default_max_percent_split_change
;
3284 return 1; /* 0% means always write a new shared index */
3286 return 0; /* 100% means never write a new shared index */
3288 break; /* just use the configured value */
3291 /* Count not shared entries */
3292 for (i
= 0; i
< istate
->cache_nr
; i
++) {
3293 struct cache_entry
*ce
= istate
->cache
[i
];
3298 return (int64_t)istate
->cache_nr
* max_split
< (int64_t)not_shared
* 100;
3301 int write_locked_index(struct index_state
*istate
, struct lock_file
*lock
,
3304 int new_shared_index
, ret
, test_split_index_env
;
3305 struct split_index
*si
= istate
->split_index
;
3307 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
3308 cache_tree_verify(the_repository
, istate
);
3310 if ((flags
& SKIP_IF_UNCHANGED
) && !istate
->cache_changed
) {
3311 if (flags
& COMMIT_LOCK
)
3312 rollback_lock_file(lock
);
3316 if (istate
->fsmonitor_last_update
)
3317 fill_fsmonitor_bitmap(istate
);
3319 test_split_index_env
= git_env_bool("GIT_TEST_SPLIT_INDEX", 0);
3321 if ((!si
&& !test_split_index_env
) ||
3322 alternate_index_output
||
3323 (istate
->cache_changed
& ~EXTMASK
)) {
3325 oidclr(&si
->base_oid
);
3326 ret
= do_write_locked_index(istate
, lock
, flags
);
3330 if (test_split_index_env
) {
3332 si
= init_split_index(istate
);
3333 istate
->cache_changed
|= SPLIT_INDEX_ORDERED
;
3335 int v
= si
->base_oid
.hash
[0];
3337 istate
->cache_changed
|= SPLIT_INDEX_ORDERED
;
3340 if (too_many_not_shared_entries(istate
))
3341 istate
->cache_changed
|= SPLIT_INDEX_ORDERED
;
3343 new_shared_index
= istate
->cache_changed
& SPLIT_INDEX_ORDERED
;
3345 if (new_shared_index
) {
3346 struct tempfile
*temp
;
3349 /* Same initial permissions as the main .git/index file */
3350 temp
= mks_tempfile_sm(git_path("sharedindex_XXXXXX"), 0, 0666);
3352 oidclr(&si
->base_oid
);
3353 ret
= do_write_locked_index(istate
, lock
, flags
);
3356 ret
= write_shared_index(istate
, &temp
);
3358 saved_errno
= errno
;
3359 if (is_tempfile_active(temp
))
3360 delete_tempfile(&temp
);
3361 errno
= saved_errno
;
3367 ret
= write_split_index(istate
, lock
, flags
);
3369 /* Freshen the shared index only if the split-index was written */
3370 if (!ret
&& !new_shared_index
&& !is_null_oid(&si
->base_oid
)) {
3371 const char *shared_index
= git_path("sharedindex.%s",
3372 oid_to_hex(&si
->base_oid
));
3373 freshen_shared_index(shared_index
, 1);
3377 if (flags
& COMMIT_LOCK
)
3378 rollback_lock_file(lock
);
3383 * Read the index file that is potentially unmerged into given
3384 * index_state, dropping any unmerged entries to stage #0 (potentially
3385 * resulting in a path appearing as both a file and a directory in the
3386 * index; the caller is responsible to clear out the extra entries
3387 * before writing the index to a tree). Returns true if the index is
3388 * unmerged. Callers who want to refuse to work from an unmerged
3389 * state can call this and check its return value, instead of calling
3392 int repo_read_index_unmerged(struct repository
*repo
)
3394 struct index_state
*istate
;
3398 repo_read_index(repo
);
3399 istate
= repo
->index
;
3400 for (i
= 0; i
< istate
->cache_nr
; i
++) {
3401 struct cache_entry
*ce
= istate
->cache
[i
];
3402 struct cache_entry
*new_ce
;
3408 len
= ce_namelen(ce
);
3409 new_ce
= make_empty_cache_entry(istate
, len
);
3410 memcpy(new_ce
->name
, ce
->name
, len
);
3411 new_ce
->ce_flags
= create_ce_flags(0) | CE_CONFLICTED
;
3412 new_ce
->ce_namelen
= len
;
3413 new_ce
->ce_mode
= ce
->ce_mode
;
3414 if (add_index_entry(istate
, new_ce
, ADD_CACHE_SKIP_DFCHECK
))
3415 return error(_("%s: cannot drop to stage #0"),
3422 * Returns 1 if the path is an "other" path with respect to
3423 * the index; that is, the path is not mentioned in the index at all,
3424 * either as a file, a directory with some files in the index,
3425 * or as an unmerged entry.
3427 * We helpfully remove a trailing "/" from directories so that
3428 * the output of read_directory can be used as-is.
3430 int index_name_is_other(struct index_state
*istate
, const char *name
,
3434 if (namelen
&& name
[namelen
- 1] == '/')
3436 pos
= index_name_pos(istate
, name
, namelen
);
3438 return 0; /* exact match */
3440 if (pos
< istate
->cache_nr
) {
3441 struct cache_entry
*ce
= istate
->cache
[pos
];
3442 if (ce_namelen(ce
) == namelen
&&
3443 !memcmp(ce
->name
, name
, namelen
))
3444 return 0; /* Yup, this one exists unmerged */
3449 void *read_blob_data_from_index(struct index_state
*istate
,
3450 const char *path
, unsigned long *size
)
3454 enum object_type type
;
3458 pos
= index_name_pos(istate
, path
, len
);
3461 * We might be in the middle of a merge, in which
3462 * case we would read stage #2 (ours).
3466 (pos
< 0 && i
< istate
->cache_nr
&&
3467 !strcmp(istate
->cache
[i
]->name
, path
));
3469 if (ce_stage(istate
->cache
[i
]) == 2)
3474 data
= read_object_file(&istate
->cache
[pos
]->oid
, &type
, &sz
);
3475 if (!data
|| type
!= OBJ_BLOB
) {
3484 void stat_validity_clear(struct stat_validity
*sv
)
3486 FREE_AND_NULL(sv
->sd
);
3489 int stat_validity_check(struct stat_validity
*sv
, const char *path
)
3493 if (stat(path
, &st
) < 0)
3494 return sv
->sd
== NULL
;
3497 return S_ISREG(st
.st_mode
) && !match_stat_data(sv
->sd
, &st
);
3500 void stat_validity_update(struct stat_validity
*sv
, int fd
)
3504 if (fstat(fd
, &st
) < 0 || !S_ISREG(st
.st_mode
))
3505 stat_validity_clear(sv
);
3508 CALLOC_ARRAY(sv
->sd
, 1);
3509 fill_stat_data(sv
->sd
, &st
);
3513 void move_index_extensions(struct index_state
*dst
, struct index_state
*src
)
3515 dst
->untracked
= src
->untracked
;
3516 src
->untracked
= NULL
;
3517 dst
->cache_tree
= src
->cache_tree
;
3518 src
->cache_tree
= NULL
;
3521 struct cache_entry
*dup_cache_entry(const struct cache_entry
*ce
,
3522 struct index_state
*istate
)
3524 unsigned int size
= ce_size(ce
);
3525 int mem_pool_allocated
;
3526 struct cache_entry
*new_entry
= make_empty_cache_entry(istate
, ce_namelen(ce
));
3527 mem_pool_allocated
= new_entry
->mem_pool_allocated
;
3529 memcpy(new_entry
, ce
, size
);
3530 new_entry
->mem_pool_allocated
= mem_pool_allocated
;
3534 void discard_cache_entry(struct cache_entry
*ce
)
3536 if (ce
&& should_validate_cache_entries())
3537 memset(ce
, 0xCD, cache_entry_size(ce
->ce_namelen
));
3539 if (ce
&& ce
->mem_pool_allocated
)
3545 int should_validate_cache_entries(void)
3547 static int validate_index_cache_entries
= -1;
3549 if (validate_index_cache_entries
< 0) {
3550 if (getenv("GIT_TEST_VALIDATE_INDEX_CACHE_ENTRIES"))
3551 validate_index_cache_entries
= 1;
3553 validate_index_cache_entries
= 0;
3556 return validate_index_cache_entries
;
3559 #define EOIE_SIZE (4 + GIT_SHA1_RAWSZ) /* <4-byte offset> + <20-byte hash> */
3560 #define EOIE_SIZE_WITH_HEADER (4 + 4 + EOIE_SIZE) /* <4-byte signature> + <4-byte length> + EOIE_SIZE */
3562 static size_t read_eoie_extension(const char *mmap
, size_t mmap_size
)
3565 * The end of index entries (EOIE) extension is guaranteed to be last
3566 * so that it can be found by scanning backwards from the EOF.
3573 const char *index
, *eoie
;
3575 size_t offset
, src_offset
;
3576 unsigned char hash
[GIT_MAX_RAWSZ
];
3579 /* ensure we have an index big enough to contain an EOIE extension */
3580 if (mmap_size
< sizeof(struct cache_header
) + EOIE_SIZE_WITH_HEADER
+ the_hash_algo
->rawsz
)
3583 /* validate the extension signature */
3584 index
= eoie
= mmap
+ mmap_size
- EOIE_SIZE_WITH_HEADER
- the_hash_algo
->rawsz
;
3585 if (CACHE_EXT(index
) != CACHE_EXT_ENDOFINDEXENTRIES
)
3587 index
+= sizeof(uint32_t);
3589 /* validate the extension size */
3590 extsize
= get_be32(index
);
3591 if (extsize
!= EOIE_SIZE
)
3593 index
+= sizeof(uint32_t);
3596 * Validate the offset we're going to look for the first extension
3597 * signature is after the index header and before the eoie extension.
3599 offset
= get_be32(index
);
3600 if (mmap
+ offset
< mmap
+ sizeof(struct cache_header
))
3602 if (mmap
+ offset
>= eoie
)
3604 index
+= sizeof(uint32_t);
3607 * The hash is computed over extension types and their sizes (but not
3608 * their contents). E.g. if we have "TREE" extension that is N-bytes
3609 * long, "REUC" extension that is M-bytes long, followed by "EOIE",
3610 * then the hash would be:
3612 * SHA-1("TREE" + <binary representation of N> +
3613 * "REUC" + <binary representation of M>)
3615 src_offset
= offset
;
3616 the_hash_algo
->init_fn(&c
);
3617 while (src_offset
< mmap_size
- the_hash_algo
->rawsz
- EOIE_SIZE_WITH_HEADER
) {
3618 /* After an array of active_nr index entries,
3619 * there can be arbitrary number of extended
3620 * sections, each of which is prefixed with
3621 * extension name (4-byte) and section length
3622 * in 4-byte network byte order.
3625 memcpy(&extsize
, mmap
+ src_offset
+ 4, 4);
3626 extsize
= ntohl(extsize
);
3628 /* verify the extension size isn't so large it will wrap around */
3629 if (src_offset
+ 8 + extsize
< src_offset
)
3632 the_hash_algo
->update_fn(&c
, mmap
+ src_offset
, 8);
3635 src_offset
+= extsize
;
3637 the_hash_algo
->final_fn(hash
, &c
);
3638 if (!hasheq(hash
, (const unsigned char *)index
))
3641 /* Validate that the extension offsets returned us back to the eoie extension. */
3642 if (src_offset
!= mmap_size
- the_hash_algo
->rawsz
- EOIE_SIZE_WITH_HEADER
)
3648 static void write_eoie_extension(struct strbuf
*sb
, git_hash_ctx
*eoie_context
, size_t offset
)
3651 unsigned char hash
[GIT_MAX_RAWSZ
];
3654 put_be32(&buffer
, offset
);
3655 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3658 the_hash_algo
->final_fn(hash
, eoie_context
);
3659 strbuf_add(sb
, hash
, the_hash_algo
->rawsz
);
3662 #define IEOT_VERSION (1)
3664 static struct index_entry_offset_table
*read_ieot_extension(const char *mmap
, size_t mmap_size
, size_t offset
)
3666 const char *index
= NULL
;
3667 uint32_t extsize
, ext_version
;
3668 struct index_entry_offset_table
*ieot
;
3671 /* find the IEOT extension */
3674 while (offset
<= mmap_size
- the_hash_algo
->rawsz
- 8) {
3675 extsize
= get_be32(mmap
+ offset
+ 4);
3676 if (CACHE_EXT((mmap
+ offset
)) == CACHE_EXT_INDEXENTRYOFFSETTABLE
) {
3677 index
= mmap
+ offset
+ 4 + 4;
3686 /* validate the version is IEOT_VERSION */
3687 ext_version
= get_be32(index
);
3688 if (ext_version
!= IEOT_VERSION
) {
3689 error("invalid IEOT version %d", ext_version
);
3692 index
+= sizeof(uint32_t);
3694 /* extension size - version bytes / bytes per entry */
3695 nr
= (extsize
- sizeof(uint32_t)) / (sizeof(uint32_t) + sizeof(uint32_t));
3697 error("invalid number of IEOT entries %d", nr
);
3700 ieot
= xmalloc(sizeof(struct index_entry_offset_table
)
3701 + (nr
* sizeof(struct index_entry_offset
)));
3703 for (i
= 0; i
< nr
; i
++) {
3704 ieot
->entries
[i
].offset
= get_be32(index
);
3705 index
+= sizeof(uint32_t);
3706 ieot
->entries
[i
].nr
= get_be32(index
);
3707 index
+= sizeof(uint32_t);
3713 static void write_ieot_extension(struct strbuf
*sb
, struct index_entry_offset_table
*ieot
)
3719 put_be32(&buffer
, IEOT_VERSION
);
3720 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3723 for (i
= 0; i
< ieot
->nr
; i
++) {
3726 put_be32(&buffer
, ieot
->entries
[i
].offset
);
3727 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3730 put_be32(&buffer
, ieot
->entries
[i
].nr
);
3731 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3735 void prefetch_cache_entries(const struct index_state
*istate
,
3736 must_prefetch_predicate must_prefetch
)
3739 struct oid_array to_fetch
= OID_ARRAY_INIT
;
3741 for (i
= 0; i
< istate
->cache_nr
; i
++) {
3742 struct cache_entry
*ce
= istate
->cache
[i
];
3744 if (S_ISGITLINK(ce
->ce_mode
) || !must_prefetch(ce
))
3746 if (!oid_object_info_extended(the_repository
, &ce
->oid
,
3748 OBJECT_INFO_FOR_PREFETCH
))
3750 oid_array_append(&to_fetch
, &ce
->oid
);
3752 promisor_remote_get_direct(the_repository
,
3753 to_fetch
.oid
, to_fetch
.nr
);
3754 oid_array_clear(&to_fetch
);