2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 #define NO_THE_INDEX_COMPATIBILITY_MACROS
13 #include "cache-tree.h"
16 #include "object-store.h"
20 #include "resolve-undo.h"
23 #include "split-index.h"
25 #include "fsmonitor.h"
26 #include "thread-utils.h"
29 /* Mask for the name length in ce_flags in the on-disk index */
31 #define CE_NAMEMASK (0x0fff)
35 * The first letter should be 'A'..'Z' for extensions that are not
36 * necessary for a correct operation (i.e. optimization data).
37 * When new extensions are added that _needs_ to be understood in
38 * order to correctly interpret the index file, pick character that
39 * is outside the range, to cause the reader to abort.
42 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
43 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
44 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
45 #define CACHE_EXT_LINK 0x6c696e6b /* "link" */
46 #define CACHE_EXT_UNTRACKED 0x554E5452 /* "UNTR" */
47 #define CACHE_EXT_FSMONITOR 0x46534D4E /* "FSMN" */
48 #define CACHE_EXT_ENDOFINDEXENTRIES 0x454F4945 /* "EOIE" */
49 #define CACHE_EXT_INDEXENTRYOFFSETTABLE 0x49454F54 /* "IEOT" */
51 /* changes that can be kept in $GIT_DIR/index (basically all extensions) */
52 #define EXTMASK (RESOLVE_UNDO_CHANGED | CACHE_TREE_CHANGED | \
53 CE_ENTRY_ADDED | CE_ENTRY_REMOVED | CE_ENTRY_CHANGED | \
54 SPLIT_INDEX_ORDERED | UNTRACKED_CHANGED | FSMONITOR_CHANGED)
58 * This is an estimate of the pathname length in the index. We use
59 * this for V4 index files to guess the un-deltafied size of the index
60 * in memory because of pathname deltafication. This is not required
61 * for V2/V3 index formats because their pathnames are not compressed.
62 * If the initial amount of memory set aside is not sufficient, the
63 * mem pool will allocate extra memory.
65 #define CACHE_ENTRY_PATH_LENGTH 80
67 static inline struct cache_entry
*mem_pool__ce_alloc(struct mem_pool
*mem_pool
, size_t len
)
69 struct cache_entry
*ce
;
70 ce
= mem_pool_alloc(mem_pool
, cache_entry_size(len
));
71 ce
->mem_pool_allocated
= 1;
75 static inline struct cache_entry
*mem_pool__ce_calloc(struct mem_pool
*mem_pool
, size_t len
)
77 struct cache_entry
* ce
;
78 ce
= mem_pool_calloc(mem_pool
, 1, cache_entry_size(len
));
79 ce
->mem_pool_allocated
= 1;
83 static struct mem_pool
*find_mem_pool(struct index_state
*istate
)
85 struct mem_pool
**pool_ptr
;
87 if (istate
->split_index
&& istate
->split_index
->base
)
88 pool_ptr
= &istate
->split_index
->base
->ce_mem_pool
;
90 pool_ptr
= &istate
->ce_mem_pool
;
93 mem_pool_init(pool_ptr
, 0);
98 struct index_state the_index
;
99 static const char *alternate_index_output
;
101 static void set_index_entry(struct index_state
*istate
, int nr
, struct cache_entry
*ce
)
103 istate
->cache
[nr
] = ce
;
104 add_name_hash(istate
, ce
);
107 static void replace_index_entry(struct index_state
*istate
, int nr
, struct cache_entry
*ce
)
109 struct cache_entry
*old
= istate
->cache
[nr
];
111 replace_index_entry_in_base(istate
, old
, ce
);
112 remove_name_hash(istate
, old
);
113 discard_cache_entry(old
);
114 ce
->ce_flags
&= ~CE_HASHED
;
115 set_index_entry(istate
, nr
, ce
);
116 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
117 mark_fsmonitor_invalid(istate
, ce
);
118 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
121 void rename_index_entry_at(struct index_state
*istate
, int nr
, const char *new_name
)
123 struct cache_entry
*old_entry
= istate
->cache
[nr
], *new_entry
;
124 int namelen
= strlen(new_name
);
126 new_entry
= make_empty_cache_entry(istate
, namelen
);
127 copy_cache_entry(new_entry
, old_entry
);
128 new_entry
->ce_flags
&= ~CE_HASHED
;
129 new_entry
->ce_namelen
= namelen
;
130 new_entry
->index
= 0;
131 memcpy(new_entry
->name
, new_name
, namelen
+ 1);
133 cache_tree_invalidate_path(istate
, old_entry
->name
);
134 untracked_cache_remove_from_index(istate
, old_entry
->name
);
135 remove_index_entry_at(istate
, nr
);
136 add_index_entry(istate
, new_entry
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
139 void fill_stat_data(struct stat_data
*sd
, struct stat
*st
)
141 sd
->sd_ctime
.sec
= (unsigned int)st
->st_ctime
;
142 sd
->sd_mtime
.sec
= (unsigned int)st
->st_mtime
;
143 sd
->sd_ctime
.nsec
= ST_CTIME_NSEC(*st
);
144 sd
->sd_mtime
.nsec
= ST_MTIME_NSEC(*st
);
145 sd
->sd_dev
= st
->st_dev
;
146 sd
->sd_ino
= st
->st_ino
;
147 sd
->sd_uid
= st
->st_uid
;
148 sd
->sd_gid
= st
->st_gid
;
149 sd
->sd_size
= st
->st_size
;
152 int match_stat_data(const struct stat_data
*sd
, struct stat
*st
)
156 if (sd
->sd_mtime
.sec
!= (unsigned int)st
->st_mtime
)
157 changed
|= MTIME_CHANGED
;
158 if (trust_ctime
&& check_stat
&&
159 sd
->sd_ctime
.sec
!= (unsigned int)st
->st_ctime
)
160 changed
|= CTIME_CHANGED
;
163 if (check_stat
&& sd
->sd_mtime
.nsec
!= ST_MTIME_NSEC(*st
))
164 changed
|= MTIME_CHANGED
;
165 if (trust_ctime
&& check_stat
&&
166 sd
->sd_ctime
.nsec
!= ST_CTIME_NSEC(*st
))
167 changed
|= CTIME_CHANGED
;
171 if (sd
->sd_uid
!= (unsigned int) st
->st_uid
||
172 sd
->sd_gid
!= (unsigned int) st
->st_gid
)
173 changed
|= OWNER_CHANGED
;
174 if (sd
->sd_ino
!= (unsigned int) st
->st_ino
)
175 changed
|= INODE_CHANGED
;
180 * st_dev breaks on network filesystems where different
181 * clients will have different views of what "device"
182 * the filesystem is on
184 if (check_stat
&& sd
->sd_dev
!= (unsigned int) st
->st_dev
)
185 changed
|= INODE_CHANGED
;
188 if (sd
->sd_size
!= (unsigned int) st
->st_size
)
189 changed
|= DATA_CHANGED
;
195 * This only updates the "non-critical" parts of the directory
196 * cache, ie the parts that aren't tracked by GIT, and only used
197 * to validate the cache.
199 void fill_stat_cache_info(struct cache_entry
*ce
, struct stat
*st
)
201 fill_stat_data(&ce
->ce_stat_data
, st
);
203 if (assume_unchanged
)
204 ce
->ce_flags
|= CE_VALID
;
206 if (S_ISREG(st
->st_mode
)) {
207 ce_mark_uptodate(ce
);
208 mark_fsmonitor_valid(ce
);
212 static int ce_compare_data(struct index_state
*istate
,
213 const struct cache_entry
*ce
,
217 int fd
= git_open_cloexec(ce
->name
, O_RDONLY
);
220 struct object_id oid
;
221 if (!index_fd(istate
, &oid
, fd
, st
, OBJ_BLOB
, ce
->name
, 0))
222 match
= !oideq(&oid
, &ce
->oid
);
223 /* index_fd() closed the file descriptor already */
228 static int ce_compare_link(const struct cache_entry
*ce
, size_t expected_size
)
233 enum object_type type
;
234 struct strbuf sb
= STRBUF_INIT
;
236 if (strbuf_readlink(&sb
, ce
->name
, expected_size
))
239 buffer
= read_object_file(&ce
->oid
, &type
, &size
);
242 match
= memcmp(buffer
, sb
.buf
, size
);
249 static int ce_compare_gitlink(const struct cache_entry
*ce
)
251 struct object_id oid
;
254 * We don't actually require that the .git directory
255 * under GITLINK directory be a valid git directory. It
256 * might even be missing (in case nobody populated that
259 * If so, we consider it always to match.
261 if (resolve_gitlink_ref(ce
->name
, "HEAD", &oid
) < 0)
263 return !oideq(&oid
, &ce
->oid
);
266 static int ce_modified_check_fs(struct index_state
*istate
,
267 const struct cache_entry
*ce
,
270 switch (st
->st_mode
& S_IFMT
) {
272 if (ce_compare_data(istate
, ce
, st
))
276 if (ce_compare_link(ce
, xsize_t(st
->st_size
)))
280 if (S_ISGITLINK(ce
->ce_mode
))
281 return ce_compare_gitlink(ce
) ? DATA_CHANGED
: 0;
282 /* else fallthrough */
289 static int ce_match_stat_basic(const struct cache_entry
*ce
, struct stat
*st
)
291 unsigned int changed
= 0;
293 if (ce
->ce_flags
& CE_REMOVE
)
294 return MODE_CHANGED
| DATA_CHANGED
| TYPE_CHANGED
;
296 switch (ce
->ce_mode
& S_IFMT
) {
298 changed
|= !S_ISREG(st
->st_mode
) ? TYPE_CHANGED
: 0;
299 /* We consider only the owner x bit to be relevant for
302 if (trust_executable_bit
&&
303 (0100 & (ce
->ce_mode
^ st
->st_mode
)))
304 changed
|= MODE_CHANGED
;
307 if (!S_ISLNK(st
->st_mode
) &&
308 (has_symlinks
|| !S_ISREG(st
->st_mode
)))
309 changed
|= TYPE_CHANGED
;
312 /* We ignore most of the st_xxx fields for gitlinks */
313 if (!S_ISDIR(st
->st_mode
))
314 changed
|= TYPE_CHANGED
;
315 else if (ce_compare_gitlink(ce
))
316 changed
|= DATA_CHANGED
;
319 die("internal error: ce_mode is %o", ce
->ce_mode
);
322 changed
|= match_stat_data(&ce
->ce_stat_data
, st
);
324 /* Racily smudged entry? */
325 if (!ce
->ce_stat_data
.sd_size
) {
326 if (!is_empty_blob_sha1(ce
->oid
.hash
))
327 changed
|= DATA_CHANGED
;
333 static int is_racy_stat(const struct index_state
*istate
,
334 const struct stat_data
*sd
)
336 return (istate
->timestamp
.sec
&&
338 /* nanosecond timestamped files can also be racy! */
339 (istate
->timestamp
.sec
< sd
->sd_mtime
.sec
||
340 (istate
->timestamp
.sec
== sd
->sd_mtime
.sec
&&
341 istate
->timestamp
.nsec
<= sd
->sd_mtime
.nsec
))
343 istate
->timestamp
.sec
<= sd
->sd_mtime
.sec
348 int is_racy_timestamp(const struct index_state
*istate
,
349 const struct cache_entry
*ce
)
351 return (!S_ISGITLINK(ce
->ce_mode
) &&
352 is_racy_stat(istate
, &ce
->ce_stat_data
));
355 int match_stat_data_racy(const struct index_state
*istate
,
356 const struct stat_data
*sd
, struct stat
*st
)
358 if (is_racy_stat(istate
, sd
))
359 return MTIME_CHANGED
;
360 return match_stat_data(sd
, st
);
363 int ie_match_stat(struct index_state
*istate
,
364 const struct cache_entry
*ce
, struct stat
*st
,
365 unsigned int options
)
367 unsigned int changed
;
368 int ignore_valid
= options
& CE_MATCH_IGNORE_VALID
;
369 int ignore_skip_worktree
= options
& CE_MATCH_IGNORE_SKIP_WORKTREE
;
370 int assume_racy_is_modified
= options
& CE_MATCH_RACY_IS_DIRTY
;
371 int ignore_fsmonitor
= options
& CE_MATCH_IGNORE_FSMONITOR
;
373 if (!ignore_fsmonitor
)
374 refresh_fsmonitor(istate
);
376 * If it's marked as always valid in the index, it's
377 * valid whatever the checked-out copy says.
379 * skip-worktree has the same effect with higher precedence
381 if (!ignore_skip_worktree
&& ce_skip_worktree(ce
))
383 if (!ignore_valid
&& (ce
->ce_flags
& CE_VALID
))
385 if (!ignore_fsmonitor
&& (ce
->ce_flags
& CE_FSMONITOR_VALID
))
389 * Intent-to-add entries have not been added, so the index entry
390 * by definition never matches what is in the work tree until it
391 * actually gets added.
393 if (ce_intent_to_add(ce
))
394 return DATA_CHANGED
| TYPE_CHANGED
| MODE_CHANGED
;
396 changed
= ce_match_stat_basic(ce
, st
);
399 * Within 1 second of this sequence:
400 * echo xyzzy >file && git-update-index --add file
401 * running this command:
403 * would give a falsely clean cache entry. The mtime and
404 * length match the cache, and other stat fields do not change.
406 * We could detect this at update-index time (the cache entry
407 * being registered/updated records the same time as "now")
408 * and delay the return from git-update-index, but that would
409 * effectively mean we can make at most one commit per second,
410 * which is not acceptable. Instead, we check cache entries
411 * whose mtime are the same as the index file timestamp more
412 * carefully than others.
414 if (!changed
&& is_racy_timestamp(istate
, ce
)) {
415 if (assume_racy_is_modified
)
416 changed
|= DATA_CHANGED
;
418 changed
|= ce_modified_check_fs(istate
, ce
, st
);
424 int ie_modified(struct index_state
*istate
,
425 const struct cache_entry
*ce
,
426 struct stat
*st
, unsigned int options
)
428 int changed
, changed_fs
;
430 changed
= ie_match_stat(istate
, ce
, st
, options
);
434 * If the mode or type has changed, there's no point in trying
435 * to refresh the entry - it's not going to match
437 if (changed
& (MODE_CHANGED
| TYPE_CHANGED
))
441 * Immediately after read-tree or update-index --cacheinfo,
442 * the length field is zero, as we have never even read the
443 * lstat(2) information once, and we cannot trust DATA_CHANGED
444 * returned by ie_match_stat() which in turn was returned by
445 * ce_match_stat_basic() to signal that the filesize of the
446 * blob changed. We have to actually go to the filesystem to
447 * see if the contents match, and if so, should answer "unchanged".
449 * The logic does not apply to gitlinks, as ce_match_stat_basic()
450 * already has checked the actual HEAD from the filesystem in the
451 * subproject. If ie_match_stat() already said it is different,
452 * then we know it is.
454 if ((changed
& DATA_CHANGED
) &&
455 (S_ISGITLINK(ce
->ce_mode
) || ce
->ce_stat_data
.sd_size
!= 0))
458 changed_fs
= ce_modified_check_fs(istate
, ce
, st
);
460 return changed
| changed_fs
;
464 int base_name_compare(const char *name1
, int len1
, int mode1
,
465 const char *name2
, int len2
, int mode2
)
467 unsigned char c1
, c2
;
468 int len
= len1
< len2
? len1
: len2
;
471 cmp
= memcmp(name1
, name2
, len
);
476 if (!c1
&& S_ISDIR(mode1
))
478 if (!c2
&& S_ISDIR(mode2
))
480 return (c1
< c2
) ? -1 : (c1
> c2
) ? 1 : 0;
484 * df_name_compare() is identical to base_name_compare(), except it
485 * compares conflicting directory/file entries as equal. Note that
486 * while a directory name compares as equal to a regular file, they
487 * then individually compare _differently_ to a filename that has
488 * a dot after the basename (because '\0' < '.' < '/').
490 * This is used by routines that want to traverse the git namespace
491 * but then handle conflicting entries together when possible.
493 int df_name_compare(const char *name1
, int len1
, int mode1
,
494 const char *name2
, int len2
, int mode2
)
496 int len
= len1
< len2
? len1
: len2
, cmp
;
497 unsigned char c1
, c2
;
499 cmp
= memcmp(name1
, name2
, len
);
502 /* Directories and files compare equal (same length, same name) */
506 if (!c1
&& S_ISDIR(mode1
))
509 if (!c2
&& S_ISDIR(mode2
))
511 if (c1
== '/' && !c2
)
513 if (c2
== '/' && !c1
)
518 int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
)
520 size_t min_len
= (len1
< len2
) ? len1
: len2
;
521 int cmp
= memcmp(name1
, name2
, min_len
);
531 int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
)
535 cmp
= name_compare(name1
, len1
, name2
, len2
);
546 static int index_name_stage_pos(const struct index_state
*istate
, const char *name
, int namelen
, int stage
)
551 last
= istate
->cache_nr
;
552 while (last
> first
) {
553 int next
= (last
+ first
) >> 1;
554 struct cache_entry
*ce
= istate
->cache
[next
];
555 int cmp
= cache_name_stage_compare(name
, namelen
, stage
, ce
->name
, ce_namelen(ce
), ce_stage(ce
));
567 int index_name_pos(const struct index_state
*istate
, const char *name
, int namelen
)
569 return index_name_stage_pos(istate
, name
, namelen
, 0);
572 int remove_index_entry_at(struct index_state
*istate
, int pos
)
574 struct cache_entry
*ce
= istate
->cache
[pos
];
576 record_resolve_undo(istate
, ce
);
577 remove_name_hash(istate
, ce
);
578 save_or_free_index_entry(istate
, ce
);
579 istate
->cache_changed
|= CE_ENTRY_REMOVED
;
581 if (pos
>= istate
->cache_nr
)
583 MOVE_ARRAY(istate
->cache
+ pos
, istate
->cache
+ pos
+ 1,
584 istate
->cache_nr
- pos
);
589 * Remove all cache entries marked for removal, that is where
590 * CE_REMOVE is set in ce_flags. This is much more effective than
591 * calling remove_index_entry_at() for each entry to be removed.
593 void remove_marked_cache_entries(struct index_state
*istate
)
595 struct cache_entry
**ce_array
= istate
->cache
;
598 for (i
= j
= 0; i
< istate
->cache_nr
; i
++) {
599 if (ce_array
[i
]->ce_flags
& CE_REMOVE
) {
600 remove_name_hash(istate
, ce_array
[i
]);
601 save_or_free_index_entry(istate
, ce_array
[i
]);
604 ce_array
[j
++] = ce_array
[i
];
606 if (j
== istate
->cache_nr
)
608 istate
->cache_changed
|= CE_ENTRY_REMOVED
;
609 istate
->cache_nr
= j
;
612 int remove_file_from_index(struct index_state
*istate
, const char *path
)
614 int pos
= index_name_pos(istate
, path
, strlen(path
));
617 cache_tree_invalidate_path(istate
, path
);
618 untracked_cache_remove_from_index(istate
, path
);
619 while (pos
< istate
->cache_nr
&& !strcmp(istate
->cache
[pos
]->name
, path
))
620 remove_index_entry_at(istate
, pos
);
624 static int compare_name(struct cache_entry
*ce
, const char *path
, int namelen
)
626 return namelen
!= ce_namelen(ce
) || memcmp(path
, ce
->name
, namelen
);
629 static int index_name_pos_also_unmerged(struct index_state
*istate
,
630 const char *path
, int namelen
)
632 int pos
= index_name_pos(istate
, path
, namelen
);
633 struct cache_entry
*ce
;
638 /* maybe unmerged? */
640 if (pos
>= istate
->cache_nr
||
641 compare_name((ce
= istate
->cache
[pos
]), path
, namelen
))
644 /* order of preference: stage 2, 1, 3 */
645 if (ce_stage(ce
) == 1 && pos
+ 1 < istate
->cache_nr
&&
646 ce_stage((ce
= istate
->cache
[pos
+ 1])) == 2 &&
647 !compare_name(ce
, path
, namelen
))
652 static int different_name(struct cache_entry
*ce
, struct cache_entry
*alias
)
654 int len
= ce_namelen(ce
);
655 return ce_namelen(alias
) != len
|| memcmp(ce
->name
, alias
->name
, len
);
659 * If we add a filename that aliases in the cache, we will use the
660 * name that we already have - but we don't want to update the same
661 * alias twice, because that implies that there were actually two
662 * different files with aliasing names!
664 * So we use the CE_ADDED flag to verify that the alias was an old
665 * one before we accept it as
667 static struct cache_entry
*create_alias_ce(struct index_state
*istate
,
668 struct cache_entry
*ce
,
669 struct cache_entry
*alias
)
672 struct cache_entry
*new_entry
;
674 if (alias
->ce_flags
& CE_ADDED
)
675 die("Will not add file alias '%s' ('%s' already exists in index)", ce
->name
, alias
->name
);
677 /* Ok, create the new entry using the name of the existing alias */
678 len
= ce_namelen(alias
);
679 new_entry
= make_empty_cache_entry(istate
, len
);
680 memcpy(new_entry
->name
, alias
->name
, len
);
681 copy_cache_entry(new_entry
, ce
);
682 save_or_free_index_entry(istate
, ce
);
686 void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
)
688 struct object_id oid
;
689 if (write_object_file("", 0, blob_type
, &oid
))
690 die("cannot create an empty blob in the object database");
691 oidcpy(&ce
->oid
, &oid
);
694 int add_to_index(struct index_state
*istate
, const char *path
, struct stat
*st
, int flags
)
696 int namelen
, was_same
;
697 mode_t st_mode
= st
->st_mode
;
698 struct cache_entry
*ce
, *alias
= NULL
;
699 unsigned ce_option
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
|CE_MATCH_RACY_IS_DIRTY
;
700 int verbose
= flags
& (ADD_CACHE_VERBOSE
| ADD_CACHE_PRETEND
);
701 int pretend
= flags
& ADD_CACHE_PRETEND
;
702 int intent_only
= flags
& ADD_CACHE_INTENT
;
703 int add_option
= (ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
|
704 (intent_only
? ADD_CACHE_NEW_ONLY
: 0));
705 int newflags
= HASH_WRITE_OBJECT
;
707 if (flags
& HASH_RENORMALIZE
)
708 newflags
|= HASH_RENORMALIZE
;
710 if (!S_ISREG(st_mode
) && !S_ISLNK(st_mode
) && !S_ISDIR(st_mode
))
711 return error("%s: can only add regular files, symbolic links or git-directories", path
);
713 namelen
= strlen(path
);
714 if (S_ISDIR(st_mode
)) {
715 while (namelen
&& path
[namelen
-1] == '/')
718 ce
= make_empty_cache_entry(istate
, namelen
);
719 memcpy(ce
->name
, path
, namelen
);
720 ce
->ce_namelen
= namelen
;
722 fill_stat_cache_info(ce
, st
);
724 ce
->ce_flags
|= CE_INTENT_TO_ADD
;
727 if (trust_executable_bit
&& has_symlinks
) {
728 ce
->ce_mode
= create_ce_mode(st_mode
);
730 /* If there is an existing entry, pick the mode bits and type
731 * from it, otherwise assume unexecutable regular file.
733 struct cache_entry
*ent
;
734 int pos
= index_name_pos_also_unmerged(istate
, path
, namelen
);
736 ent
= (0 <= pos
) ? istate
->cache
[pos
] : NULL
;
737 ce
->ce_mode
= ce_mode_from_stat(ent
, st_mode
);
740 /* When core.ignorecase=true, determine if a directory of the same name but differing
741 * case already exists within the Git repository. If it does, ensure the directory
742 * case of the file being added to the repository matches (is folded into) the existing
743 * entry's directory case.
746 adjust_dirname_case(istate
, ce
->name
);
748 if (!(flags
& HASH_RENORMALIZE
)) {
749 alias
= index_file_exists(istate
, ce
->name
,
750 ce_namelen(ce
), ignore_case
);
753 !ie_match_stat(istate
, alias
, st
, ce_option
)) {
754 /* Nothing changed, really */
755 if (!S_ISGITLINK(alias
->ce_mode
))
756 ce_mark_uptodate(alias
);
757 alias
->ce_flags
|= CE_ADDED
;
759 discard_cache_entry(ce
);
764 if (index_path(istate
, &ce
->oid
, path
, st
, newflags
)) {
765 discard_cache_entry(ce
);
766 return error("unable to index file %s", path
);
769 set_object_name_for_intent_to_add_entry(ce
);
771 if (ignore_case
&& alias
&& different_name(ce
, alias
))
772 ce
= create_alias_ce(istate
, ce
, alias
);
773 ce
->ce_flags
|= CE_ADDED
;
775 /* It was suspected to be racily clean, but it turns out to be Ok */
778 oideq(&alias
->oid
, &ce
->oid
) &&
779 ce
->ce_mode
== alias
->ce_mode
);
782 discard_cache_entry(ce
);
783 else if (add_index_entry(istate
, ce
, add_option
)) {
784 discard_cache_entry(ce
);
785 return error("unable to add %s to index", path
);
787 if (verbose
&& !was_same
)
788 printf("add '%s'\n", path
);
792 int add_file_to_index(struct index_state
*istate
, const char *path
, int flags
)
795 if (lstat(path
, &st
))
796 die_errno("unable to stat '%s'", path
);
797 return add_to_index(istate
, path
, &st
, flags
);
800 struct cache_entry
*make_empty_cache_entry(struct index_state
*istate
, size_t len
)
802 return mem_pool__ce_calloc(find_mem_pool(istate
), len
);
805 struct cache_entry
*make_empty_transient_cache_entry(size_t len
)
807 return xcalloc(1, cache_entry_size(len
));
810 struct cache_entry
*make_cache_entry(struct index_state
*istate
,
812 const struct object_id
*oid
,
815 unsigned int refresh_options
)
817 struct cache_entry
*ce
, *ret
;
820 if (!verify_path(path
, mode
)) {
821 error("Invalid path '%s'", path
);
826 ce
= make_empty_cache_entry(istate
, len
);
828 oidcpy(&ce
->oid
, oid
);
829 memcpy(ce
->name
, path
, len
);
830 ce
->ce_flags
= create_ce_flags(stage
);
831 ce
->ce_namelen
= len
;
832 ce
->ce_mode
= create_ce_mode(mode
);
834 ret
= refresh_cache_entry(istate
, ce
, refresh_options
);
836 discard_cache_entry(ce
);
840 struct cache_entry
*make_transient_cache_entry(unsigned int mode
, const struct object_id
*oid
,
841 const char *path
, int stage
)
843 struct cache_entry
*ce
;
846 if (!verify_path(path
, mode
)) {
847 error("Invalid path '%s'", path
);
852 ce
= make_empty_transient_cache_entry(len
);
854 oidcpy(&ce
->oid
, oid
);
855 memcpy(ce
->name
, path
, len
);
856 ce
->ce_flags
= create_ce_flags(stage
);
857 ce
->ce_namelen
= len
;
858 ce
->ce_mode
= create_ce_mode(mode
);
864 * Chmod an index entry with either +x or -x.
866 * Returns -1 if the chmod for the particular cache entry failed (if it's
867 * not a regular file), -2 if an invalid flip argument is passed in, 0
870 int chmod_index_entry(struct index_state
*istate
, struct cache_entry
*ce
,
873 if (!S_ISREG(ce
->ce_mode
))
880 ce
->ce_mode
&= ~0111;
885 cache_tree_invalidate_path(istate
, ce
->name
);
886 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
887 mark_fsmonitor_invalid(istate
, ce
);
888 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
893 int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
)
895 int len
= ce_namelen(a
);
896 return ce_namelen(b
) == len
&& !memcmp(a
->name
, b
->name
, len
);
900 * We fundamentally don't like some paths: we don't want
901 * dot or dot-dot anywhere, and for obvious reasons don't
902 * want to recurse into ".git" either.
904 * Also, we don't want double slashes or slashes at the
905 * end that can make pathnames ambiguous.
907 static int verify_dotfile(const char *rest
, unsigned mode
)
910 * The first character was '.', but that
911 * has already been discarded, we now test
915 /* "." is not allowed */
916 if (*rest
== '\0' || is_dir_sep(*rest
))
921 * ".git" followed by NUL or slash is bad. Note that we match
922 * case-insensitively here, even if ignore_case is not set.
923 * This outlaws ".GIT" everywhere out of an abundance of caution,
924 * since there's really no good reason to allow it.
926 * Once we've seen ".git", we can also find ".gitmodules", etc (also
927 * case-insensitively).
931 if (rest
[1] != 'i' && rest
[1] != 'I')
933 if (rest
[2] != 't' && rest
[2] != 'T')
935 if (rest
[3] == '\0' || is_dir_sep(rest
[3]))
939 if (skip_iprefix(rest
, "modules", &rest
) &&
940 (*rest
== '\0' || is_dir_sep(*rest
)))
945 if (rest
[1] == '\0' || is_dir_sep(rest
[1]))
951 int verify_path(const char *path
, unsigned mode
)
955 if (has_dos_drive_prefix(path
))
965 if (is_hfs_dotgit(path
))
968 if (is_hfs_dotgitmodules(path
))
973 if (is_ntfs_dotgit(path
))
976 if (is_ntfs_dotgitmodules(path
))
982 if ((c
== '.' && !verify_dotfile(path
, mode
)) ||
983 is_dir_sep(c
) || c
== '\0')
991 * Do we have another file that has the beginning components being a
992 * proper superset of the name we're trying to add?
994 static int has_file_name(struct index_state
*istate
,
995 const struct cache_entry
*ce
, int pos
, int ok_to_replace
)
998 int len
= ce_namelen(ce
);
999 int stage
= ce_stage(ce
);
1000 const char *name
= ce
->name
;
1002 while (pos
< istate
->cache_nr
) {
1003 struct cache_entry
*p
= istate
->cache
[pos
++];
1005 if (len
>= ce_namelen(p
))
1007 if (memcmp(name
, p
->name
, len
))
1009 if (ce_stage(p
) != stage
)
1011 if (p
->name
[len
] != '/')
1013 if (p
->ce_flags
& CE_REMOVE
)
1018 remove_index_entry_at(istate
, --pos
);
1025 * Like strcmp(), but also return the offset of the first change.
1026 * If strings are equal, return the length.
1028 int strcmp_offset(const char *s1
, const char *s2
, size_t *first_change
)
1033 return strcmp(s1
, s2
);
1035 for (k
= 0; s1
[k
] == s2
[k
]; k
++)
1040 return (unsigned char)s1
[k
] - (unsigned char)s2
[k
];
1044 * Do we have another file with a pathname that is a proper
1045 * subset of the name we're trying to add?
1047 * That is, is there another file in the index with a path
1048 * that matches a sub-directory in the given entry?
1050 static int has_dir_name(struct index_state
*istate
,
1051 const struct cache_entry
*ce
, int pos
, int ok_to_replace
)
1054 int stage
= ce_stage(ce
);
1055 const char *name
= ce
->name
;
1056 const char *slash
= name
+ ce_namelen(ce
);
1061 * We are frequently called during an iteration on a sorted
1062 * list of pathnames and while building a new index. Therefore,
1063 * there is a high probability that this entry will eventually
1064 * be appended to the index, rather than inserted in the middle.
1065 * If we can confirm that, we can avoid binary searches on the
1066 * components of the pathname.
1068 * Compare the entry's full path with the last path in the index.
1070 if (istate
->cache_nr
> 0) {
1071 cmp_last
= strcmp_offset(name
,
1072 istate
->cache
[istate
->cache_nr
- 1]->name
,
1075 if (len_eq_last
== 0) {
1077 * The entry sorts AFTER the last one in the
1078 * index and their paths have no common prefix,
1079 * so there cannot be a F/D conflict.
1084 * The entry sorts AFTER the last one in the
1085 * index, but has a common prefix. Fall through
1086 * to the loop below to disect the entry's path
1087 * and see where the difference is.
1090 } else if (cmp_last
== 0) {
1092 * The entry exactly matches the last one in the
1093 * index, but because of multiple stage and CE_REMOVE
1094 * items, we fall through and let the regular search
1104 if (*--slash
== '/')
1106 if (slash
<= ce
->name
)
1113 * (len + 1) is a directory boundary (including
1114 * the trailing slash). And since the loop is
1115 * decrementing "slash", the first iteration is
1116 * the longest directory prefix; subsequent
1117 * iterations consider parent directories.
1120 if (len
+ 1 <= len_eq_last
) {
1122 * The directory prefix (including the trailing
1123 * slash) also appears as a prefix in the last
1124 * entry, so the remainder cannot collide (because
1125 * strcmp said the whole path was greater).
1130 * LT: last: xxx/file_A
1136 if (len
> len_eq_last
) {
1138 * This part of the directory prefix (excluding
1139 * the trailing slash) is longer than the known
1140 * equal portions, so this sub-directory cannot
1141 * collide with a file.
1149 if (istate
->cache_nr
> 0 &&
1150 ce_namelen(istate
->cache
[istate
->cache_nr
- 1]) > len
) {
1152 * The directory prefix lines up with part of
1153 * a longer file or directory name, but sorts
1154 * after it, so this sub-directory cannot
1155 * collide with a file.
1157 * last: xxx/yy-file (because '-' sorts before '/')
1164 * This is a possible collision. Fall through and
1165 * let the regular search code handle it.
1172 pos
= index_name_stage_pos(istate
, name
, len
, stage
);
1175 * Found one, but not so fast. This could
1176 * be a marker that says "I was here, but
1177 * I am being removed". Such an entry is
1178 * not a part of the resulting tree, and
1179 * it is Ok to have a directory at the same
1182 if (!(istate
->cache
[pos
]->ce_flags
& CE_REMOVE
)) {
1186 remove_index_entry_at(istate
, pos
);
1194 * Trivial optimization: if we find an entry that
1195 * already matches the sub-directory, then we know
1196 * we're ok, and we can exit.
1198 while (pos
< istate
->cache_nr
) {
1199 struct cache_entry
*p
= istate
->cache
[pos
];
1200 if ((ce_namelen(p
) <= len
) ||
1201 (p
->name
[len
] != '/') ||
1202 memcmp(p
->name
, name
, len
))
1203 break; /* not our subdirectory */
1204 if (ce_stage(p
) == stage
&& !(p
->ce_flags
& CE_REMOVE
))
1206 * p is at the same stage as our entry, and
1207 * is a subdirectory of what we are looking
1208 * at, so we cannot have conflicts at our
1209 * level or anything shorter.
1218 /* We may be in a situation where we already have path/file and path
1219 * is being added, or we already have path and path/file is being
1220 * added. Either one would result in a nonsense tree that has path
1221 * twice when git-write-tree tries to write it out. Prevent it.
1223 * If ok-to-replace is specified, we remove the conflicting entries
1224 * from the cache so the caller should recompute the insert position.
1225 * When this happens, we return non-zero.
1227 static int check_file_directory_conflict(struct index_state
*istate
,
1228 const struct cache_entry
*ce
,
1229 int pos
, int ok_to_replace
)
1234 * When ce is an "I am going away" entry, we allow it to be added
1236 if (ce
->ce_flags
& CE_REMOVE
)
1240 * We check if the path is a sub-path of a subsequent pathname
1241 * first, since removing those will not change the position
1244 retval
= has_file_name(istate
, ce
, pos
, ok_to_replace
);
1247 * Then check if the path might have a clashing sub-directory
1250 return retval
+ has_dir_name(istate
, ce
, pos
, ok_to_replace
);
1253 static int add_index_entry_with_check(struct index_state
*istate
, struct cache_entry
*ce
, int option
)
1256 int ok_to_add
= option
& ADD_CACHE_OK_TO_ADD
;
1257 int ok_to_replace
= option
& ADD_CACHE_OK_TO_REPLACE
;
1258 int skip_df_check
= option
& ADD_CACHE_SKIP_DFCHECK
;
1259 int new_only
= option
& ADD_CACHE_NEW_ONLY
;
1261 if (!(option
& ADD_CACHE_KEEP_CACHE_TREE
))
1262 cache_tree_invalidate_path(istate
, ce
->name
);
1265 * If this entry's path sorts after the last entry in the index,
1266 * we can avoid searching for it.
1268 if (istate
->cache_nr
> 0 &&
1269 strcmp(ce
->name
, istate
->cache
[istate
->cache_nr
- 1]->name
) > 0)
1270 pos
= -istate
->cache_nr
- 1;
1272 pos
= index_name_stage_pos(istate
, ce
->name
, ce_namelen(ce
), ce_stage(ce
));
1274 /* existing match? Just replace it. */
1277 replace_index_entry(istate
, pos
, ce
);
1282 if (!(option
& ADD_CACHE_KEEP_CACHE_TREE
))
1283 untracked_cache_add_to_index(istate
, ce
->name
);
1286 * Inserting a merged entry ("stage 0") into the index
1287 * will always replace all non-merged entries..
1289 if (pos
< istate
->cache_nr
&& ce_stage(ce
) == 0) {
1290 while (ce_same_name(istate
->cache
[pos
], ce
)) {
1292 if (!remove_index_entry_at(istate
, pos
))
1299 if (!verify_path(ce
->name
, ce
->ce_mode
))
1300 return error("Invalid path '%s'", ce
->name
);
1302 if (!skip_df_check
&&
1303 check_file_directory_conflict(istate
, ce
, pos
, ok_to_replace
)) {
1305 return error("'%s' appears as both a file and as a directory",
1307 pos
= index_name_stage_pos(istate
, ce
->name
, ce_namelen(ce
), ce_stage(ce
));
1313 int add_index_entry(struct index_state
*istate
, struct cache_entry
*ce
, int option
)
1317 if (option
& ADD_CACHE_JUST_APPEND
)
1318 pos
= istate
->cache_nr
;
1321 ret
= add_index_entry_with_check(istate
, ce
, option
);
1327 /* Make sure the array is big enough .. */
1328 ALLOC_GROW(istate
->cache
, istate
->cache_nr
+ 1, istate
->cache_alloc
);
1332 if (istate
->cache_nr
> pos
+ 1)
1333 MOVE_ARRAY(istate
->cache
+ pos
+ 1, istate
->cache
+ pos
,
1334 istate
->cache_nr
- pos
- 1);
1335 set_index_entry(istate
, pos
, ce
);
1336 istate
->cache_changed
|= CE_ENTRY_ADDED
;
1341 * "refresh" does not calculate a new sha1 file or bring the
1342 * cache up-to-date for mode/content changes. But what it
1343 * _does_ do is to "re-match" the stat information of a file
1344 * with the cache, so that you can refresh the cache for a
1345 * file that hasn't been changed but where the stat entry is
1348 * For example, you'd want to do this after doing a "git-read-tree",
1349 * to link up the stat cache details with the proper files.
1351 static struct cache_entry
*refresh_cache_ent(struct index_state
*istate
,
1352 struct cache_entry
*ce
,
1353 unsigned int options
, int *err
,
1357 struct cache_entry
*updated
;
1359 int refresh
= options
& CE_MATCH_REFRESH
;
1360 int ignore_valid
= options
& CE_MATCH_IGNORE_VALID
;
1361 int ignore_skip_worktree
= options
& CE_MATCH_IGNORE_SKIP_WORKTREE
;
1362 int ignore_missing
= options
& CE_MATCH_IGNORE_MISSING
;
1363 int ignore_fsmonitor
= options
& CE_MATCH_IGNORE_FSMONITOR
;
1365 if (!refresh
|| ce_uptodate(ce
))
1368 if (!ignore_fsmonitor
)
1369 refresh_fsmonitor(istate
);
1371 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1372 * that the change to the work tree does not matter and told
1375 if (!ignore_skip_worktree
&& ce_skip_worktree(ce
)) {
1376 ce_mark_uptodate(ce
);
1379 if (!ignore_valid
&& (ce
->ce_flags
& CE_VALID
)) {
1380 ce_mark_uptodate(ce
);
1383 if (!ignore_fsmonitor
&& (ce
->ce_flags
& CE_FSMONITOR_VALID
)) {
1384 ce_mark_uptodate(ce
);
1388 if (has_symlink_leading_path(ce
->name
, ce_namelen(ce
))) {
1396 if (lstat(ce
->name
, &st
) < 0) {
1397 if (ignore_missing
&& errno
== ENOENT
)
1404 changed
= ie_match_stat(istate
, ce
, &st
, options
);
1406 *changed_ret
= changed
;
1409 * The path is unchanged. If we were told to ignore
1410 * valid bit, then we did the actual stat check and
1411 * found that the entry is unmodified. If the entry
1412 * is not marked VALID, this is the place to mark it
1413 * valid again, under "assume unchanged" mode.
1415 if (ignore_valid
&& assume_unchanged
&&
1416 !(ce
->ce_flags
& CE_VALID
))
1417 ; /* mark this one VALID again */
1420 * We do not mark the index itself "modified"
1421 * because CE_UPTODATE flag is in-core only;
1422 * we are not going to write this change out.
1424 if (!S_ISGITLINK(ce
->ce_mode
)) {
1425 ce_mark_uptodate(ce
);
1426 mark_fsmonitor_valid(ce
);
1432 if (ie_modified(istate
, ce
, &st
, options
)) {
1438 updated
= make_empty_cache_entry(istate
, ce_namelen(ce
));
1439 copy_cache_entry(updated
, ce
);
1440 memcpy(updated
->name
, ce
->name
, ce
->ce_namelen
+ 1);
1441 fill_stat_cache_info(updated
, &st
);
1443 * If ignore_valid is not set, we should leave CE_VALID bit
1444 * alone. Otherwise, paths marked with --no-assume-unchanged
1445 * (i.e. things to be edited) will reacquire CE_VALID bit
1446 * automatically, which is not really what we want.
1448 if (!ignore_valid
&& assume_unchanged
&&
1449 !(ce
->ce_flags
& CE_VALID
))
1450 updated
->ce_flags
&= ~CE_VALID
;
1452 /* istate->cache_changed is updated in the caller */
1456 static void show_file(const char * fmt
, const char * name
, int in_porcelain
,
1457 int * first
, const char *header_msg
)
1459 if (in_porcelain
&& *first
&& header_msg
) {
1460 printf("%s\n", header_msg
);
1466 int refresh_index(struct index_state
*istate
, unsigned int flags
,
1467 const struct pathspec
*pathspec
,
1468 char *seen
, const char *header_msg
)
1472 int really
= (flags
& REFRESH_REALLY
) != 0;
1473 int allow_unmerged
= (flags
& REFRESH_UNMERGED
) != 0;
1474 int quiet
= (flags
& REFRESH_QUIET
) != 0;
1475 int not_new
= (flags
& REFRESH_IGNORE_MISSING
) != 0;
1476 int ignore_submodules
= (flags
& REFRESH_IGNORE_SUBMODULES
) != 0;
1478 int in_porcelain
= (flags
& REFRESH_IN_PORCELAIN
);
1479 unsigned int options
= (CE_MATCH_REFRESH
|
1480 (really
? CE_MATCH_IGNORE_VALID
: 0) |
1481 (not_new
? CE_MATCH_IGNORE_MISSING
: 0));
1482 const char *modified_fmt
;
1483 const char *deleted_fmt
;
1484 const char *typechange_fmt
;
1485 const char *added_fmt
;
1486 const char *unmerged_fmt
;
1487 struct progress
*progress
= NULL
;
1489 if (flags
& REFRESH_PROGRESS
&& isatty(2))
1490 progress
= start_delayed_progress(_("Refresh index"),
1493 trace_performance_enter();
1494 modified_fmt
= (in_porcelain
? "M\t%s\n" : "%s: needs update\n");
1495 deleted_fmt
= (in_porcelain
? "D\t%s\n" : "%s: needs update\n");
1496 typechange_fmt
= (in_porcelain
? "T\t%s\n" : "%s needs update\n");
1497 added_fmt
= (in_porcelain
? "A\t%s\n" : "%s needs update\n");
1498 unmerged_fmt
= (in_porcelain
? "U\t%s\n" : "%s: needs merge\n");
1499 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1500 struct cache_entry
*ce
, *new_entry
;
1501 int cache_errno
= 0;
1505 ce
= istate
->cache
[i
];
1506 if (ignore_submodules
&& S_ISGITLINK(ce
->ce_mode
))
1509 if (pathspec
&& !ce_path_match(istate
, ce
, pathspec
, seen
))
1513 while ((i
< istate
->cache_nr
) &&
1514 ! strcmp(istate
->cache
[i
]->name
, ce
->name
))
1520 show_file(unmerged_fmt
, ce
->name
, in_porcelain
,
1521 &first
, header_msg
);
1529 new_entry
= refresh_cache_ent(istate
, ce
, options
, &cache_errno
, &changed
);
1530 if (new_entry
== ce
)
1533 display_progress(progress
, i
);
1537 if (really
&& cache_errno
== EINVAL
) {
1538 /* If we are doing --really-refresh that
1539 * means the index is not valid anymore.
1541 ce
->ce_flags
&= ~CE_VALID
;
1542 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
1543 mark_fsmonitor_invalid(istate
, ce
);
1544 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
1549 if (cache_errno
== ENOENT
)
1551 else if (ce_intent_to_add(ce
))
1552 fmt
= added_fmt
; /* must be before other checks */
1553 else if (changed
& TYPE_CHANGED
)
1554 fmt
= typechange_fmt
;
1558 ce
->name
, in_porcelain
, &first
, header_msg
);
1563 replace_index_entry(istate
, i
, new_entry
);
1566 display_progress(progress
, istate
->cache_nr
);
1567 stop_progress(&progress
);
1569 trace_performance_leave("refresh index");
1573 struct cache_entry
*refresh_cache_entry(struct index_state
*istate
,
1574 struct cache_entry
*ce
,
1575 unsigned int options
)
1577 return refresh_cache_ent(istate
, ce
, options
, NULL
, NULL
);
1581 /*****************************************************************
1583 *****************************************************************/
1585 #define INDEX_FORMAT_DEFAULT 3
1587 static unsigned int get_index_format_default(void)
1589 char *envversion
= getenv("GIT_INDEX_VERSION");
1592 unsigned int version
= INDEX_FORMAT_DEFAULT
;
1595 if (!git_config_get_int("index.version", &value
))
1597 if (version
< INDEX_FORMAT_LB
|| INDEX_FORMAT_UB
< version
) {
1598 warning(_("index.version set, but the value is invalid.\n"
1599 "Using version %i"), INDEX_FORMAT_DEFAULT
);
1600 return INDEX_FORMAT_DEFAULT
;
1605 version
= strtoul(envversion
, &endp
, 10);
1607 version
< INDEX_FORMAT_LB
|| INDEX_FORMAT_UB
< version
) {
1608 warning(_("GIT_INDEX_VERSION set, but the value is invalid.\n"
1609 "Using version %i"), INDEX_FORMAT_DEFAULT
);
1610 version
= INDEX_FORMAT_DEFAULT
;
1616 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1617 * Again - this is just a (very strong in practice) heuristic that
1618 * the inode hasn't changed.
1620 * We save the fields in big-endian order to allow using the
1621 * index file over NFS transparently.
1623 struct ondisk_cache_entry
{
1624 struct cache_time ctime
;
1625 struct cache_time mtime
;
1632 unsigned char sha1
[20];
1634 char name
[FLEX_ARRAY
]; /* more */
1638 * This struct is used when CE_EXTENDED bit is 1
1639 * The struct must match ondisk_cache_entry exactly from
1642 struct ondisk_cache_entry_extended
{
1643 struct cache_time ctime
;
1644 struct cache_time mtime
;
1651 unsigned char sha1
[20];
1654 char name
[FLEX_ARRAY
]; /* more */
1657 /* These are only used for v3 or lower */
1658 #define align_padding_size(size, len) ((size + (len) + 8) & ~7) - (size + len)
1659 #define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
1660 #define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1661 #define ondisk_cache_entry_extended_size(len) align_flex_name(ondisk_cache_entry_extended,len)
1662 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
1663 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
1664 ondisk_cache_entry_size(ce_namelen(ce)))
1666 /* Allow fsck to force verification of the index checksum. */
1667 int verify_index_checksum
;
1669 /* Allow fsck to force verification of the cache entry order. */
1670 int verify_ce_order
;
1672 static int verify_hdr(const struct cache_header
*hdr
, unsigned long size
)
1675 unsigned char hash
[GIT_MAX_RAWSZ
];
1678 if (hdr
->hdr_signature
!= htonl(CACHE_SIGNATURE
))
1679 return error("bad signature");
1680 hdr_version
= ntohl(hdr
->hdr_version
);
1681 if (hdr_version
< INDEX_FORMAT_LB
|| INDEX_FORMAT_UB
< hdr_version
)
1682 return error("bad index version %d", hdr_version
);
1684 if (!verify_index_checksum
)
1687 the_hash_algo
->init_fn(&c
);
1688 the_hash_algo
->update_fn(&c
, hdr
, size
- the_hash_algo
->rawsz
);
1689 the_hash_algo
->final_fn(hash
, &c
);
1690 if (!hasheq(hash
, (unsigned char *)hdr
+ size
- the_hash_algo
->rawsz
))
1691 return error("bad index file sha1 signature");
1695 static int read_index_extension(struct index_state
*istate
,
1696 const char *ext
, const char *data
, unsigned long sz
)
1698 switch (CACHE_EXT(ext
)) {
1699 case CACHE_EXT_TREE
:
1700 istate
->cache_tree
= cache_tree_read(data
, sz
);
1702 case CACHE_EXT_RESOLVE_UNDO
:
1703 istate
->resolve_undo
= resolve_undo_read(data
, sz
);
1705 case CACHE_EXT_LINK
:
1706 if (read_link_extension(istate
, data
, sz
))
1709 case CACHE_EXT_UNTRACKED
:
1710 istate
->untracked
= read_untracked_extension(data
, sz
);
1712 case CACHE_EXT_FSMONITOR
:
1713 read_fsmonitor_extension(istate
, data
, sz
);
1715 case CACHE_EXT_ENDOFINDEXENTRIES
:
1716 case CACHE_EXT_INDEXENTRYOFFSETTABLE
:
1717 /* already handled in do_read_index() */
1720 if (*ext
< 'A' || 'Z' < *ext
)
1721 return error("index uses %.4s extension, which we do not understand",
1723 fprintf(stderr
, "ignoring %.4s extension\n", ext
);
1729 int hold_locked_index(struct lock_file
*lk
, int lock_flags
)
1731 return hold_lock_file_for_update(lk
, get_index_file(), lock_flags
);
1734 int read_index(struct index_state
*istate
)
1736 return read_index_from(istate
, get_index_file(), get_git_dir());
1739 static struct cache_entry
*create_from_disk(struct mem_pool
*ce_mem_pool
,
1740 unsigned int version
,
1741 struct ondisk_cache_entry
*ondisk
,
1742 unsigned long *ent_size
,
1743 const struct cache_entry
*previous_ce
)
1745 struct cache_entry
*ce
;
1749 size_t copy_len
= 0;
1751 * Adjacent cache entries tend to share the leading paths, so it makes
1752 * sense to only store the differences in later entries. In the v4
1753 * on-disk format of the index, each on-disk cache entry stores the
1754 * number of bytes to be stripped from the end of the previous name,
1755 * and the bytes to append to the result, to come up with its name.
1757 int expand_name_field
= version
== 4;
1759 /* On-disk flags are just 16 bits */
1760 flags
= get_be16(&ondisk
->flags
);
1761 len
= flags
& CE_NAMEMASK
;
1763 if (flags
& CE_EXTENDED
) {
1764 struct ondisk_cache_entry_extended
*ondisk2
;
1766 ondisk2
= (struct ondisk_cache_entry_extended
*)ondisk
;
1767 extended_flags
= get_be16(&ondisk2
->flags2
) << 16;
1768 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1769 if (extended_flags
& ~CE_EXTENDED_FLAGS
)
1770 die("Unknown index entry format %08x", extended_flags
);
1771 flags
|= extended_flags
;
1772 name
= ondisk2
->name
;
1775 name
= ondisk
->name
;
1777 if (expand_name_field
) {
1778 const unsigned char *cp
= (const unsigned char *)name
;
1779 size_t strip_len
, previous_len
;
1781 /* If we're at the begining of a block, ignore the previous name */
1782 strip_len
= decode_varint(&cp
);
1784 previous_len
= previous_ce
->ce_namelen
;
1785 if (previous_len
< strip_len
)
1786 die(_("malformed name field in the index, near path '%s'"),
1788 copy_len
= previous_len
- strip_len
;
1790 name
= (const char *)cp
;
1793 if (len
== CE_NAMEMASK
) {
1795 if (expand_name_field
)
1799 ce
= mem_pool__ce_alloc(ce_mem_pool
, len
);
1801 ce
->ce_stat_data
.sd_ctime
.sec
= get_be32(&ondisk
->ctime
.sec
);
1802 ce
->ce_stat_data
.sd_mtime
.sec
= get_be32(&ondisk
->mtime
.sec
);
1803 ce
->ce_stat_data
.sd_ctime
.nsec
= get_be32(&ondisk
->ctime
.nsec
);
1804 ce
->ce_stat_data
.sd_mtime
.nsec
= get_be32(&ondisk
->mtime
.nsec
);
1805 ce
->ce_stat_data
.sd_dev
= get_be32(&ondisk
->dev
);
1806 ce
->ce_stat_data
.sd_ino
= get_be32(&ondisk
->ino
);
1807 ce
->ce_mode
= get_be32(&ondisk
->mode
);
1808 ce
->ce_stat_data
.sd_uid
= get_be32(&ondisk
->uid
);
1809 ce
->ce_stat_data
.sd_gid
= get_be32(&ondisk
->gid
);
1810 ce
->ce_stat_data
.sd_size
= get_be32(&ondisk
->size
);
1811 ce
->ce_flags
= flags
& ~CE_NAMEMASK
;
1812 ce
->ce_namelen
= len
;
1814 hashcpy(ce
->oid
.hash
, ondisk
->sha1
);
1816 if (expand_name_field
) {
1818 memcpy(ce
->name
, previous_ce
->name
, copy_len
);
1819 memcpy(ce
->name
+ copy_len
, name
, len
+ 1 - copy_len
);
1820 *ent_size
= (name
- ((char *)ondisk
)) + len
+ 1 - copy_len
;
1822 memcpy(ce
->name
, name
, len
+ 1);
1823 *ent_size
= ondisk_ce_size(ce
);
1828 static void check_ce_order(struct index_state
*istate
)
1832 if (!verify_ce_order
)
1835 for (i
= 1; i
< istate
->cache_nr
; i
++) {
1836 struct cache_entry
*ce
= istate
->cache
[i
- 1];
1837 struct cache_entry
*next_ce
= istate
->cache
[i
];
1838 int name_compare
= strcmp(ce
->name
, next_ce
->name
);
1840 if (0 < name_compare
)
1841 die("unordered stage entries in index");
1842 if (!name_compare
) {
1844 die("multiple stage entries for merged file '%s'",
1846 if (ce_stage(ce
) > ce_stage(next_ce
))
1847 die("unordered stage entries for '%s'",
1853 static void tweak_untracked_cache(struct index_state
*istate
)
1855 switch (git_config_get_untracked_cache()) {
1856 case -1: /* keep: do nothing */
1859 remove_untracked_cache(istate
);
1862 add_untracked_cache(istate
);
1864 default: /* unknown value: do nothing */
1869 static void tweak_split_index(struct index_state
*istate
)
1871 switch (git_config_get_split_index()) {
1872 case -1: /* unset: do nothing */
1875 remove_split_index(istate
);
1878 add_split_index(istate
);
1880 default: /* unknown value: do nothing */
1885 static void post_read_index_from(struct index_state
*istate
)
1887 check_ce_order(istate
);
1888 tweak_untracked_cache(istate
);
1889 tweak_split_index(istate
);
1890 tweak_fsmonitor(istate
);
1893 static size_t estimate_cache_size_from_compressed(unsigned int entries
)
1895 return entries
* (sizeof(struct cache_entry
) + CACHE_ENTRY_PATH_LENGTH
);
1898 static size_t estimate_cache_size(size_t ondisk_size
, unsigned int entries
)
1900 long per_entry
= sizeof(struct cache_entry
) - sizeof(struct ondisk_cache_entry
);
1903 * Account for potential alignment differences.
1905 per_entry
+= align_padding_size(sizeof(struct cache_entry
), -sizeof(struct ondisk_cache_entry
));
1906 return ondisk_size
+ entries
* per_entry
;
1909 struct index_entry_offset
1911 /* starting byte offset into index file, count of index entries in this block */
1915 struct index_entry_offset_table
1918 struct index_entry_offset entries
[FLEX_ARRAY
];
1921 static struct index_entry_offset_table
*read_ieot_extension(const char *mmap
, size_t mmap_size
, size_t offset
);
1922 static void write_ieot_extension(struct strbuf
*sb
, struct index_entry_offset_table
*ieot
);
1924 static size_t read_eoie_extension(const char *mmap
, size_t mmap_size
);
1925 static void write_eoie_extension(struct strbuf
*sb
, git_hash_ctx
*eoie_context
, size_t offset
);
1927 struct load_index_extensions
1930 struct index_state
*istate
;
1933 unsigned long src_offset
;
1936 static void *load_index_extensions(void *_data
)
1938 struct load_index_extensions
*p
= _data
;
1939 unsigned long src_offset
= p
->src_offset
;
1941 while (src_offset
<= p
->mmap_size
- the_hash_algo
->rawsz
- 8) {
1942 /* After an array of active_nr index entries,
1943 * there can be arbitrary number of extended
1944 * sections, each of which is prefixed with
1945 * extension name (4-byte) and section length
1946 * in 4-byte network byte order.
1948 uint32_t extsize
= get_be32(p
->mmap
+ src_offset
+ 4);
1949 if (read_index_extension(p
->istate
,
1950 p
->mmap
+ src_offset
,
1951 p
->mmap
+ src_offset
+ 8,
1953 munmap((void *)p
->mmap
, p
->mmap_size
);
1954 die(_("index file corrupt"));
1957 src_offset
+= extsize
;
1964 * A helper function that will load the specified range of cache entries
1965 * from the memory mapped file and add them to the given index.
1967 static unsigned long load_cache_entry_block(struct index_state
*istate
,
1968 struct mem_pool
*ce_mem_pool
, int offset
, int nr
, const char *mmap
,
1969 unsigned long start_offset
, const struct cache_entry
*previous_ce
)
1972 unsigned long src_offset
= start_offset
;
1974 for (i
= offset
; i
< offset
+ nr
; i
++) {
1975 struct ondisk_cache_entry
*disk_ce
;
1976 struct cache_entry
*ce
;
1977 unsigned long consumed
;
1979 disk_ce
= (struct ondisk_cache_entry
*)(mmap
+ src_offset
);
1980 ce
= create_from_disk(ce_mem_pool
, istate
->version
, disk_ce
, &consumed
, previous_ce
);
1981 set_index_entry(istate
, i
, ce
);
1983 src_offset
+= consumed
;
1986 return src_offset
- start_offset
;
1989 static unsigned long load_all_cache_entries(struct index_state
*istate
,
1990 const char *mmap
, size_t mmap_size
, unsigned long src_offset
)
1992 unsigned long consumed
;
1994 if (istate
->version
== 4) {
1995 mem_pool_init(&istate
->ce_mem_pool
,
1996 estimate_cache_size_from_compressed(istate
->cache_nr
));
1998 mem_pool_init(&istate
->ce_mem_pool
,
1999 estimate_cache_size(mmap_size
, istate
->cache_nr
));
2002 consumed
= load_cache_entry_block(istate
, istate
->ce_mem_pool
,
2003 0, istate
->cache_nr
, mmap
, src_offset
, NULL
);
2008 * Mostly randomly chosen maximum thread counts: we
2009 * cap the parallelism to online_cpus() threads, and we want
2010 * to have at least 10000 cache entries per thread for it to
2011 * be worth starting a thread.
2014 #define THREAD_COST (10000)
2016 struct load_cache_entries_thread_data
2019 struct index_state
*istate
;
2020 struct mem_pool
*ce_mem_pool
;
2023 struct index_entry_offset_table
*ieot
;
2024 int ieot_start
; /* starting index into the ieot array */
2025 int ieot_blocks
; /* count of ieot entries to process */
2026 unsigned long consumed
; /* return # of bytes in index file processed */
2030 * A thread proc to run the load_cache_entries() computation
2031 * across multiple background threads.
2033 static void *load_cache_entries_thread(void *_data
)
2035 struct load_cache_entries_thread_data
*p
= _data
;
2038 /* iterate across all ieot blocks assigned to this thread */
2039 for (i
= p
->ieot_start
; i
< p
->ieot_start
+ p
->ieot_blocks
; i
++) {
2040 p
->consumed
+= load_cache_entry_block(p
->istate
, p
->ce_mem_pool
,
2041 p
->offset
, p
->ieot
->entries
[i
].nr
, p
->mmap
, p
->ieot
->entries
[i
].offset
, NULL
);
2042 p
->offset
+= p
->ieot
->entries
[i
].nr
;
2047 static unsigned long load_cache_entries_threaded(struct index_state
*istate
, const char *mmap
, size_t mmap_size
,
2048 unsigned long src_offset
, int nr_threads
, struct index_entry_offset_table
*ieot
)
2050 int i
, offset
, ieot_blocks
, ieot_start
, err
;
2051 struct load_cache_entries_thread_data
*data
;
2052 unsigned long consumed
= 0;
2054 /* a little sanity checking */
2055 if (istate
->name_hash_initialized
)
2056 BUG("the name hash isn't thread safe");
2058 mem_pool_init(&istate
->ce_mem_pool
, 0);
2060 /* ensure we have no more threads than we have blocks to process */
2061 if (nr_threads
> ieot
->nr
)
2062 nr_threads
= ieot
->nr
;
2063 data
= xcalloc(nr_threads
, sizeof(*data
));
2065 offset
= ieot_start
= 0;
2066 ieot_blocks
= DIV_ROUND_UP(ieot
->nr
, nr_threads
);
2067 for (i
= 0; i
< nr_threads
; i
++) {
2068 struct load_cache_entries_thread_data
*p
= &data
[i
];
2071 if (ieot_start
+ ieot_blocks
> ieot
->nr
)
2072 ieot_blocks
= ieot
->nr
- ieot_start
;
2078 p
->ieot_start
= ieot_start
;
2079 p
->ieot_blocks
= ieot_blocks
;
2081 /* create a mem_pool for each thread */
2083 for (j
= p
->ieot_start
; j
< p
->ieot_start
+ p
->ieot_blocks
; j
++)
2084 nr
+= p
->ieot
->entries
[j
].nr
;
2085 if (istate
->version
== 4) {
2086 mem_pool_init(&p
->ce_mem_pool
,
2087 estimate_cache_size_from_compressed(nr
));
2089 mem_pool_init(&p
->ce_mem_pool
,
2090 estimate_cache_size(mmap_size
, nr
));
2093 err
= pthread_create(&p
->pthread
, NULL
, load_cache_entries_thread
, p
);
2095 die(_("unable to create load_cache_entries thread: %s"), strerror(err
));
2097 /* increment by the number of cache entries in the ieot block being processed */
2098 for (j
= 0; j
< ieot_blocks
; j
++)
2099 offset
+= ieot
->entries
[ieot_start
+ j
].nr
;
2100 ieot_start
+= ieot_blocks
;
2103 for (i
= 0; i
< nr_threads
; i
++) {
2104 struct load_cache_entries_thread_data
*p
= &data
[i
];
2106 err
= pthread_join(p
->pthread
, NULL
);
2108 die(_("unable to join load_cache_entries thread: %s"), strerror(err
));
2109 mem_pool_combine(istate
->ce_mem_pool
, p
->ce_mem_pool
);
2110 consumed
+= p
->consumed
;
2118 /* remember to discard_cache() before reading a different cache! */
2119 int do_read_index(struct index_state
*istate
, const char *path
, int must_exist
)
2123 unsigned long src_offset
;
2124 const struct cache_header
*hdr
;
2127 struct load_index_extensions p
;
2128 size_t extension_offset
= 0;
2129 int nr_threads
, cpus
;
2130 struct index_entry_offset_table
*ieot
= NULL
;
2132 if (istate
->initialized
)
2133 return istate
->cache_nr
;
2135 istate
->timestamp
.sec
= 0;
2136 istate
->timestamp
.nsec
= 0;
2137 fd
= open(path
, O_RDONLY
);
2139 if (!must_exist
&& errno
== ENOENT
)
2141 die_errno("%s: index file open failed", path
);
2145 die_errno("cannot stat the open index");
2147 mmap_size
= xsize_t(st
.st_size
);
2148 if (mmap_size
< sizeof(struct cache_header
) + the_hash_algo
->rawsz
)
2149 die("index file smaller than expected");
2151 mmap
= xmmap(NULL
, mmap_size
, PROT_READ
, MAP_PRIVATE
, fd
, 0);
2152 if (mmap
== MAP_FAILED
)
2153 die_errno("unable to map index file");
2156 hdr
= (const struct cache_header
*)mmap
;
2157 if (verify_hdr(hdr
, mmap_size
) < 0)
2160 hashcpy(istate
->oid
.hash
, (const unsigned char *)hdr
+ mmap_size
- the_hash_algo
->rawsz
);
2161 istate
->version
= ntohl(hdr
->hdr_version
);
2162 istate
->cache_nr
= ntohl(hdr
->hdr_entries
);
2163 istate
->cache_alloc
= alloc_nr(istate
->cache_nr
);
2164 istate
->cache
= xcalloc(istate
->cache_alloc
, sizeof(*istate
->cache
));
2165 istate
->initialized
= 1;
2169 p
.mmap_size
= mmap_size
;
2171 src_offset
= sizeof(*hdr
);
2173 nr_threads
= git_config_get_index_threads();
2175 /* TODO: does creating more threads than cores help? */
2177 nr_threads
= istate
->cache_nr
/ THREAD_COST
;
2178 cpus
= online_cpus();
2179 if (nr_threads
> cpus
)
2186 if (nr_threads
> 1) {
2187 extension_offset
= read_eoie_extension(mmap
, mmap_size
);
2188 if (extension_offset
) {
2191 p
.src_offset
= extension_offset
;
2192 err
= pthread_create(&p
.pthread
, NULL
, load_index_extensions
, &p
);
2194 die(_("unable to create load_index_extensions thread: %s"), strerror(err
));
2201 * Locate and read the index entry offset table so that we can use it
2202 * to multi-thread the reading of the cache entries.
2204 if (extension_offset
&& nr_threads
> 1)
2205 ieot
= read_ieot_extension(mmap
, mmap_size
, extension_offset
);
2208 src_offset
+= load_cache_entries_threaded(istate
, mmap
, mmap_size
, src_offset
, nr_threads
, ieot
);
2211 src_offset
+= load_all_cache_entries(istate
, mmap
, mmap_size
, src_offset
);
2214 istate
->timestamp
.sec
= st
.st_mtime
;
2215 istate
->timestamp
.nsec
= ST_MTIME_NSEC(st
);
2217 /* if we created a thread, join it otherwise load the extensions on the primary thread */
2218 if (extension_offset
) {
2219 int ret
= pthread_join(p
.pthread
, NULL
);
2221 die(_("unable to join load_index_extensions thread: %s"), strerror(ret
));
2223 p
.src_offset
= src_offset
;
2224 load_index_extensions(&p
);
2226 munmap((void *)mmap
, mmap_size
);
2227 return istate
->cache_nr
;
2230 munmap((void *)mmap
, mmap_size
);
2231 die("index file corrupt");
2235 * Signal that the shared index is used by updating its mtime.
2237 * This way, shared index can be removed if they have not been used
2240 static void freshen_shared_index(const char *shared_index
, int warn
)
2242 if (!check_and_freshen_file(shared_index
, 1) && warn
)
2243 warning("could not freshen shared index '%s'", shared_index
);
2246 int read_index_from(struct index_state
*istate
, const char *path
,
2249 struct split_index
*split_index
;
2254 /* istate->initialized covers both .git/index and .git/sharedindex.xxx */
2255 if (istate
->initialized
)
2256 return istate
->cache_nr
;
2258 trace_performance_enter();
2259 ret
= do_read_index(istate
, path
, 0);
2260 trace_performance_leave("read cache %s", path
);
2262 split_index
= istate
->split_index
;
2263 if (!split_index
|| is_null_oid(&split_index
->base_oid
)) {
2264 post_read_index_from(istate
);
2268 trace_performance_enter();
2269 if (split_index
->base
)
2270 discard_index(split_index
->base
);
2272 split_index
->base
= xcalloc(1, sizeof(*split_index
->base
));
2274 base_oid_hex
= oid_to_hex(&split_index
->base_oid
);
2275 base_path
= xstrfmt("%s/sharedindex.%s", gitdir
, base_oid_hex
);
2276 ret
= do_read_index(split_index
->base
, base_path
, 1);
2277 if (!oideq(&split_index
->base_oid
, &split_index
->base
->oid
))
2278 die("broken index, expect %s in %s, got %s",
2279 base_oid_hex
, base_path
,
2280 oid_to_hex(&split_index
->base
->oid
));
2282 freshen_shared_index(base_path
, 0);
2283 merge_base_index(istate
);
2284 post_read_index_from(istate
);
2286 trace_performance_leave("read cache %s", base_path
);
2290 int is_index_unborn(struct index_state
*istate
)
2292 return (!istate
->cache_nr
&& !istate
->timestamp
.sec
);
2295 int discard_index(struct index_state
*istate
)
2298 * Cache entries in istate->cache[] should have been allocated
2299 * from the memory pool associated with this index, or from an
2300 * associated split_index. There is no need to free individual
2301 * cache entries. validate_cache_entries can detect when this
2302 * assertion does not hold.
2304 validate_cache_entries(istate
);
2306 resolve_undo_clear_index(istate
);
2307 istate
->cache_nr
= 0;
2308 istate
->cache_changed
= 0;
2309 istate
->timestamp
.sec
= 0;
2310 istate
->timestamp
.nsec
= 0;
2311 free_name_hash(istate
);
2312 cache_tree_free(&(istate
->cache_tree
));
2313 istate
->initialized
= 0;
2314 FREE_AND_NULL(istate
->cache
);
2315 istate
->cache_alloc
= 0;
2316 discard_split_index(istate
);
2317 free_untracked_cache(istate
->untracked
);
2318 istate
->untracked
= NULL
;
2320 if (istate
->ce_mem_pool
) {
2321 mem_pool_discard(istate
->ce_mem_pool
, should_validate_cache_entries());
2322 istate
->ce_mem_pool
= NULL
;
2329 * Validate the cache entries of this index.
2330 * All cache entries associated with this index
2331 * should have been allocated by the memory pool
2332 * associated with this index, or by a referenced
2335 void validate_cache_entries(const struct index_state
*istate
)
2339 if (!should_validate_cache_entries() ||!istate
|| !istate
->initialized
)
2342 for (i
= 0; i
< istate
->cache_nr
; i
++) {
2344 die("internal error: cache entry is not allocated from expected memory pool");
2345 } else if (!istate
->ce_mem_pool
||
2346 !mem_pool_contains(istate
->ce_mem_pool
, istate
->cache
[i
])) {
2347 if (!istate
->split_index
||
2348 !istate
->split_index
->base
||
2349 !istate
->split_index
->base
->ce_mem_pool
||
2350 !mem_pool_contains(istate
->split_index
->base
->ce_mem_pool
, istate
->cache
[i
])) {
2351 die("internal error: cache entry is not allocated from expected memory pool");
2356 if (istate
->split_index
)
2357 validate_cache_entries(istate
->split_index
->base
);
2360 int unmerged_index(const struct index_state
*istate
)
2363 for (i
= 0; i
< istate
->cache_nr
; i
++) {
2364 if (ce_stage(istate
->cache
[i
]))
2370 int index_has_changes(struct index_state
*istate
,
2374 struct object_id cmp
;
2377 if (istate
!= &the_index
) {
2378 BUG("index_has_changes cannot yet accept istate != &the_index; do_diff_cache needs updating first.");
2381 cmp
= tree
->object
.oid
;
2382 if (tree
|| !get_oid_tree("HEAD", &cmp
)) {
2383 struct diff_options opt
;
2385 repo_diff_setup(the_repository
, &opt
);
2386 opt
.flags
.exit_with_status
= 1;
2388 opt
.flags
.quick
= 1;
2389 do_diff_cache(&cmp
, &opt
);
2391 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
2393 strbuf_addch(sb
, ' ');
2394 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
2397 return opt
.flags
.has_changes
!= 0;
2399 for (i
= 0; sb
&& i
< istate
->cache_nr
; i
++) {
2401 strbuf_addch(sb
, ' ');
2402 strbuf_addstr(sb
, istate
->cache
[i
]->name
);
2404 return !!istate
->cache_nr
;
2408 #define WRITE_BUFFER_SIZE 8192
2409 static unsigned char write_buffer
[WRITE_BUFFER_SIZE
];
2410 static unsigned long write_buffer_len
;
2412 static int ce_write_flush(git_hash_ctx
*context
, int fd
)
2414 unsigned int buffered
= write_buffer_len
;
2416 the_hash_algo
->update_fn(context
, write_buffer
, buffered
);
2417 if (write_in_full(fd
, write_buffer
, buffered
) < 0)
2419 write_buffer_len
= 0;
2424 static int ce_write(git_hash_ctx
*context
, int fd
, void *data
, unsigned int len
)
2427 unsigned int buffered
= write_buffer_len
;
2428 unsigned int partial
= WRITE_BUFFER_SIZE
- buffered
;
2431 memcpy(write_buffer
+ buffered
, data
, partial
);
2432 buffered
+= partial
;
2433 if (buffered
== WRITE_BUFFER_SIZE
) {
2434 write_buffer_len
= buffered
;
2435 if (ce_write_flush(context
, fd
))
2439 write_buffer_len
= buffered
;
2441 data
= (char *) data
+ partial
;
2446 static int write_index_ext_header(git_hash_ctx
*context
, git_hash_ctx
*eoie_context
,
2447 int fd
, unsigned int ext
, unsigned int sz
)
2452 the_hash_algo
->update_fn(eoie_context
, &ext
, 4);
2453 the_hash_algo
->update_fn(eoie_context
, &sz
, 4);
2455 return ((ce_write(context
, fd
, &ext
, 4) < 0) ||
2456 (ce_write(context
, fd
, &sz
, 4) < 0)) ? -1 : 0;
2459 static int ce_flush(git_hash_ctx
*context
, int fd
, unsigned char *hash
)
2461 unsigned int left
= write_buffer_len
;
2464 write_buffer_len
= 0;
2465 the_hash_algo
->update_fn(context
, write_buffer
, left
);
2468 /* Flush first if not enough space for hash signature */
2469 if (left
+ the_hash_algo
->rawsz
> WRITE_BUFFER_SIZE
) {
2470 if (write_in_full(fd
, write_buffer
, left
) < 0)
2475 /* Append the hash signature at the end */
2476 the_hash_algo
->final_fn(write_buffer
+ left
, context
);
2477 hashcpy(hash
, write_buffer
+ left
);
2478 left
+= the_hash_algo
->rawsz
;
2479 return (write_in_full(fd
, write_buffer
, left
) < 0) ? -1 : 0;
2482 static void ce_smudge_racily_clean_entry(struct index_state
*istate
,
2483 struct cache_entry
*ce
)
2486 * The only thing we care about in this function is to smudge the
2487 * falsely clean entry due to touch-update-touch race, so we leave
2488 * everything else as they are. We are called for entries whose
2489 * ce_stat_data.sd_mtime match the index file mtime.
2491 * Note that this actually does not do much for gitlinks, for
2492 * which ce_match_stat_basic() always goes to the actual
2493 * contents. The caller checks with is_racy_timestamp() which
2494 * always says "no" for gitlinks, so we are not called for them ;-)
2498 if (lstat(ce
->name
, &st
) < 0)
2500 if (ce_match_stat_basic(ce
, &st
))
2502 if (ce_modified_check_fs(istate
, ce
, &st
)) {
2503 /* This is "racily clean"; smudge it. Note that this
2504 * is a tricky code. At first glance, it may appear
2505 * that it can break with this sequence:
2507 * $ echo xyzzy >frotz
2508 * $ git-update-index --add frotz
2511 * $ echo filfre >nitfol
2512 * $ git-update-index --add nitfol
2514 * but it does not. When the second update-index runs,
2515 * it notices that the entry "frotz" has the same timestamp
2516 * as index, and if we were to smudge it by resetting its
2517 * size to zero here, then the object name recorded
2518 * in index is the 6-byte file but the cached stat information
2519 * becomes zero --- which would then match what we would
2520 * obtain from the filesystem next time we stat("frotz").
2522 * However, the second update-index, before calling
2523 * this function, notices that the cached size is 6
2524 * bytes and what is on the filesystem is an empty
2525 * file, and never calls us, so the cached size information
2526 * for "frotz" stays 6 which does not match the filesystem.
2528 ce
->ce_stat_data
.sd_size
= 0;
2532 /* Copy miscellaneous fields but not the name */
2533 static void copy_cache_entry_to_ondisk(struct ondisk_cache_entry
*ondisk
,
2534 struct cache_entry
*ce
)
2538 ondisk
->ctime
.sec
= htonl(ce
->ce_stat_data
.sd_ctime
.sec
);
2539 ondisk
->mtime
.sec
= htonl(ce
->ce_stat_data
.sd_mtime
.sec
);
2540 ondisk
->ctime
.nsec
= htonl(ce
->ce_stat_data
.sd_ctime
.nsec
);
2541 ondisk
->mtime
.nsec
= htonl(ce
->ce_stat_data
.sd_mtime
.nsec
);
2542 ondisk
->dev
= htonl(ce
->ce_stat_data
.sd_dev
);
2543 ondisk
->ino
= htonl(ce
->ce_stat_data
.sd_ino
);
2544 ondisk
->mode
= htonl(ce
->ce_mode
);
2545 ondisk
->uid
= htonl(ce
->ce_stat_data
.sd_uid
);
2546 ondisk
->gid
= htonl(ce
->ce_stat_data
.sd_gid
);
2547 ondisk
->size
= htonl(ce
->ce_stat_data
.sd_size
);
2548 hashcpy(ondisk
->sha1
, ce
->oid
.hash
);
2550 flags
= ce
->ce_flags
& ~CE_NAMEMASK
;
2551 flags
|= (ce_namelen(ce
) >= CE_NAMEMASK
? CE_NAMEMASK
: ce_namelen(ce
));
2552 ondisk
->flags
= htons(flags
);
2553 if (ce
->ce_flags
& CE_EXTENDED
) {
2554 struct ondisk_cache_entry_extended
*ondisk2
;
2555 ondisk2
= (struct ondisk_cache_entry_extended
*)ondisk
;
2556 ondisk2
->flags2
= htons((ce
->ce_flags
& CE_EXTENDED_FLAGS
) >> 16);
2560 static int ce_write_entry(git_hash_ctx
*c
, int fd
, struct cache_entry
*ce
,
2561 struct strbuf
*previous_name
, struct ondisk_cache_entry
*ondisk
)
2565 unsigned int saved_namelen
;
2566 int stripped_name
= 0;
2567 static unsigned char padding
[8] = { 0x00 };
2569 if (ce
->ce_flags
& CE_STRIP_NAME
) {
2570 saved_namelen
= ce_namelen(ce
);
2575 if (ce
->ce_flags
& CE_EXTENDED
)
2576 size
= offsetof(struct ondisk_cache_entry_extended
, name
);
2578 size
= offsetof(struct ondisk_cache_entry
, name
);
2580 if (!previous_name
) {
2581 int len
= ce_namelen(ce
);
2582 copy_cache_entry_to_ondisk(ondisk
, ce
);
2583 result
= ce_write(c
, fd
, ondisk
, size
);
2585 result
= ce_write(c
, fd
, ce
->name
, len
);
2587 result
= ce_write(c
, fd
, padding
, align_padding_size(size
, len
));
2589 int common
, to_remove
, prefix_size
;
2590 unsigned char to_remove_vi
[16];
2592 (ce
->name
[common
] &&
2593 common
< previous_name
->len
&&
2594 ce
->name
[common
] == previous_name
->buf
[common
]);
2596 ; /* still matching */
2597 to_remove
= previous_name
->len
- common
;
2598 prefix_size
= encode_varint(to_remove
, to_remove_vi
);
2600 copy_cache_entry_to_ondisk(ondisk
, ce
);
2601 result
= ce_write(c
, fd
, ondisk
, size
);
2603 result
= ce_write(c
, fd
, to_remove_vi
, prefix_size
);
2605 result
= ce_write(c
, fd
, ce
->name
+ common
, ce_namelen(ce
) - common
);
2607 result
= ce_write(c
, fd
, padding
, 1);
2609 strbuf_splice(previous_name
, common
, to_remove
,
2610 ce
->name
+ common
, ce_namelen(ce
) - common
);
2612 if (stripped_name
) {
2613 ce
->ce_namelen
= saved_namelen
;
2614 ce
->ce_flags
&= ~CE_STRIP_NAME
;
2621 * This function verifies if index_state has the correct sha1 of the
2622 * index file. Don't die if we have any other failure, just return 0.
2624 static int verify_index_from(const struct index_state
*istate
, const char *path
)
2629 unsigned char hash
[GIT_MAX_RAWSZ
];
2631 if (!istate
->initialized
)
2634 fd
= open(path
, O_RDONLY
);
2641 if (st
.st_size
< sizeof(struct cache_header
) + the_hash_algo
->rawsz
)
2644 n
= pread_in_full(fd
, hash
, the_hash_algo
->rawsz
, st
.st_size
- the_hash_algo
->rawsz
);
2645 if (n
!= the_hash_algo
->rawsz
)
2648 if (!hasheq(istate
->oid
.hash
, hash
))
2659 static int verify_index(const struct index_state
*istate
)
2661 return verify_index_from(istate
, get_index_file());
2664 static int has_racy_timestamp(struct index_state
*istate
)
2666 int entries
= istate
->cache_nr
;
2669 for (i
= 0; i
< entries
; i
++) {
2670 struct cache_entry
*ce
= istate
->cache
[i
];
2671 if (is_racy_timestamp(istate
, ce
))
2677 void update_index_if_able(struct index_state
*istate
, struct lock_file
*lockfile
)
2679 if ((istate
->cache_changed
|| has_racy_timestamp(istate
)) &&
2680 verify_index(istate
))
2681 write_locked_index(istate
, lockfile
, COMMIT_LOCK
);
2683 rollback_lock_file(lockfile
);
2687 * On success, `tempfile` is closed. If it is the temporary file
2688 * of a `struct lock_file`, we will therefore effectively perform
2689 * a 'close_lock_file_gently()`. Since that is an implementation
2690 * detail of lockfiles, callers of `do_write_index()` should not
2693 static int do_write_index(struct index_state
*istate
, struct tempfile
*tempfile
,
2694 int strip_extensions
)
2696 uint64_t start
= getnanotime();
2697 int newfd
= tempfile
->fd
;
2698 git_hash_ctx c
, eoie_c
;
2699 struct cache_header hdr
;
2700 int i
, err
= 0, removed
, extended
, hdr_version
;
2701 struct cache_entry
**cache
= istate
->cache
;
2702 int entries
= istate
->cache_nr
;
2704 struct ondisk_cache_entry_extended ondisk
;
2705 struct strbuf previous_name_buf
= STRBUF_INIT
, *previous_name
;
2706 int drop_cache_tree
= istate
->drop_cache_tree
;
2708 int ieot_entries
= 1;
2709 struct index_entry_offset_table
*ieot
= NULL
;
2712 for (i
= removed
= extended
= 0; i
< entries
; i
++) {
2713 if (cache
[i
]->ce_flags
& CE_REMOVE
)
2716 /* reduce extended entries if possible */
2717 cache
[i
]->ce_flags
&= ~CE_EXTENDED
;
2718 if (cache
[i
]->ce_flags
& CE_EXTENDED_FLAGS
) {
2720 cache
[i
]->ce_flags
|= CE_EXTENDED
;
2724 if (!istate
->version
) {
2725 istate
->version
= get_index_format_default();
2726 if (git_env_bool("GIT_TEST_SPLIT_INDEX", 0))
2727 init_split_index(istate
);
2730 /* demote version 3 to version 2 when the latter suffices */
2731 if (istate
->version
== 3 || istate
->version
== 2)
2732 istate
->version
= extended
? 3 : 2;
2734 hdr_version
= istate
->version
;
2736 hdr
.hdr_signature
= htonl(CACHE_SIGNATURE
);
2737 hdr
.hdr_version
= htonl(hdr_version
);
2738 hdr
.hdr_entries
= htonl(entries
- removed
);
2740 the_hash_algo
->init_fn(&c
);
2741 if (ce_write(&c
, newfd
, &hdr
, sizeof(hdr
)) < 0)
2745 nr_threads
= git_config_get_index_threads();
2749 if (nr_threads
!= 1) {
2750 int ieot_blocks
, cpus
;
2753 * ensure default number of ieot blocks maps evenly to the
2754 * default number of threads that will process them leaving
2755 * room for the thread to load the index extensions.
2758 ieot_blocks
= istate
->cache_nr
/ THREAD_COST
;
2759 cpus
= online_cpus();
2760 if (ieot_blocks
> cpus
- 1)
2761 ieot_blocks
= cpus
- 1;
2763 ieot_blocks
= nr_threads
;
2764 if (ieot_blocks
> istate
->cache_nr
)
2765 ieot_blocks
= istate
->cache_nr
;
2769 * no reason to write out the IEOT extension if we don't
2770 * have enough blocks to utilize multi-threading
2772 if (ieot_blocks
> 1) {
2773 ieot
= xcalloc(1, sizeof(struct index_entry_offset_table
)
2774 + (ieot_blocks
* sizeof(struct index_entry_offset
)));
2775 ieot_entries
= DIV_ROUND_UP(entries
, ieot_blocks
);
2779 offset
= lseek(newfd
, 0, SEEK_CUR
);
2784 offset
+= write_buffer_len
;
2786 previous_name
= (hdr_version
== 4) ? &previous_name_buf
: NULL
;
2788 for (i
= 0; i
< entries
; i
++) {
2789 struct cache_entry
*ce
= cache
[i
];
2790 if (ce
->ce_flags
& CE_REMOVE
)
2792 if (!ce_uptodate(ce
) && is_racy_timestamp(istate
, ce
))
2793 ce_smudge_racily_clean_entry(istate
, ce
);
2794 if (is_null_oid(&ce
->oid
)) {
2795 static const char msg
[] = "cache entry has null sha1: %s";
2796 static int allow
= -1;
2799 allow
= git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
2801 warning(msg
, ce
->name
);
2803 err
= error(msg
, ce
->name
);
2805 drop_cache_tree
= 1;
2807 if (ieot
&& i
&& (i
% ieot_entries
== 0)) {
2808 ieot
->entries
[ieot
->nr
].nr
= nr
;
2809 ieot
->entries
[ieot
->nr
].offset
= offset
;
2812 * If we have a V4 index, set the first byte to an invalid
2813 * character to ensure there is nothing common with the previous
2817 previous_name
->buf
[0] = 0;
2819 offset
= lseek(newfd
, 0, SEEK_CUR
);
2824 offset
+= write_buffer_len
;
2826 if (ce_write_entry(&c
, newfd
, ce
, previous_name
, (struct ondisk_cache_entry
*)&ondisk
) < 0)
2834 ieot
->entries
[ieot
->nr
].nr
= nr
;
2835 ieot
->entries
[ieot
->nr
].offset
= offset
;
2838 strbuf_release(&previous_name_buf
);
2845 /* Write extension data here */
2846 offset
= lseek(newfd
, 0, SEEK_CUR
);
2851 offset
+= write_buffer_len
;
2852 the_hash_algo
->init_fn(&eoie_c
);
2855 * Lets write out CACHE_EXT_INDEXENTRYOFFSETTABLE first so that we
2856 * can minimize the number of extensions we have to scan through to
2857 * find it during load. Write it out regardless of the
2858 * strip_extensions parameter as we need it when loading the shared
2862 struct strbuf sb
= STRBUF_INIT
;
2864 write_ieot_extension(&sb
, ieot
);
2865 err
= write_index_ext_header(&c
, &eoie_c
, newfd
, CACHE_EXT_INDEXENTRYOFFSETTABLE
, sb
.len
) < 0
2866 || ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2867 strbuf_release(&sb
);
2873 if (!strip_extensions
&& istate
->split_index
) {
2874 struct strbuf sb
= STRBUF_INIT
;
2876 err
= write_link_extension(&sb
, istate
) < 0 ||
2877 write_index_ext_header(&c
, &eoie_c
, newfd
, CACHE_EXT_LINK
,
2879 ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2880 strbuf_release(&sb
);
2884 if (!strip_extensions
&& !drop_cache_tree
&& istate
->cache_tree
) {
2885 struct strbuf sb
= STRBUF_INIT
;
2887 cache_tree_write(&sb
, istate
->cache_tree
);
2888 err
= write_index_ext_header(&c
, &eoie_c
, newfd
, CACHE_EXT_TREE
, sb
.len
) < 0
2889 || ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2890 strbuf_release(&sb
);
2894 if (!strip_extensions
&& istate
->resolve_undo
) {
2895 struct strbuf sb
= STRBUF_INIT
;
2897 resolve_undo_write(&sb
, istate
->resolve_undo
);
2898 err
= write_index_ext_header(&c
, &eoie_c
, newfd
, CACHE_EXT_RESOLVE_UNDO
,
2900 || ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2901 strbuf_release(&sb
);
2905 if (!strip_extensions
&& istate
->untracked
) {
2906 struct strbuf sb
= STRBUF_INIT
;
2908 write_untracked_extension(&sb
, istate
->untracked
);
2909 err
= write_index_ext_header(&c
, &eoie_c
, newfd
, CACHE_EXT_UNTRACKED
,
2911 ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2912 strbuf_release(&sb
);
2916 if (!strip_extensions
&& istate
->fsmonitor_last_update
) {
2917 struct strbuf sb
= STRBUF_INIT
;
2919 write_fsmonitor_extension(&sb
, istate
);
2920 err
= write_index_ext_header(&c
, &eoie_c
, newfd
, CACHE_EXT_FSMONITOR
, sb
.len
) < 0
2921 || ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2922 strbuf_release(&sb
);
2928 * CACHE_EXT_ENDOFINDEXENTRIES must be written as the last entry before the SHA1
2929 * so that it can be found and processed before all the index entries are
2930 * read. Write it out regardless of the strip_extensions parameter as we need it
2931 * when loading the shared index.
2934 struct strbuf sb
= STRBUF_INIT
;
2936 write_eoie_extension(&sb
, &eoie_c
, offset
);
2937 err
= write_index_ext_header(&c
, NULL
, newfd
, CACHE_EXT_ENDOFINDEXENTRIES
, sb
.len
) < 0
2938 || ce_write(&c
, newfd
, sb
.buf
, sb
.len
) < 0;
2939 strbuf_release(&sb
);
2944 if (ce_flush(&c
, newfd
, istate
->oid
.hash
))
2946 if (close_tempfile_gently(tempfile
)) {
2947 error(_("could not close '%s'"), tempfile
->filename
.buf
);
2950 if (stat(tempfile
->filename
.buf
, &st
))
2952 istate
->timestamp
.sec
= (unsigned int)st
.st_mtime
;
2953 istate
->timestamp
.nsec
= ST_MTIME_NSEC(st
);
2954 trace_performance_since(start
, "write index, changed mask = %x", istate
->cache_changed
);
2958 void set_alternate_index_output(const char *name
)
2960 alternate_index_output
= name
;
2963 static int commit_locked_index(struct lock_file
*lk
)
2965 if (alternate_index_output
)
2966 return commit_lock_file_to(lk
, alternate_index_output
);
2968 return commit_lock_file(lk
);
2971 static int do_write_locked_index(struct index_state
*istate
, struct lock_file
*lock
,
2974 int ret
= do_write_index(istate
, lock
->tempfile
, 0);
2977 if (flags
& COMMIT_LOCK
)
2978 return commit_locked_index(lock
);
2979 return close_lock_file_gently(lock
);
2982 static int write_split_index(struct index_state
*istate
,
2983 struct lock_file
*lock
,
2987 prepare_to_write_split_index(istate
);
2988 ret
= do_write_locked_index(istate
, lock
, flags
);
2989 finish_writing_split_index(istate
);
2993 static const char *shared_index_expire
= "2.weeks.ago";
2995 static unsigned long get_shared_index_expire_date(void)
2997 static unsigned long shared_index_expire_date
;
2998 static int shared_index_expire_date_prepared
;
3000 if (!shared_index_expire_date_prepared
) {
3001 git_config_get_expiry("splitindex.sharedindexexpire",
3002 &shared_index_expire
);
3003 shared_index_expire_date
= approxidate(shared_index_expire
);
3004 shared_index_expire_date_prepared
= 1;
3007 return shared_index_expire_date
;
3010 static int should_delete_shared_index(const char *shared_index_path
)
3013 unsigned long expiration
;
3015 /* Check timestamp */
3016 expiration
= get_shared_index_expire_date();
3019 if (stat(shared_index_path
, &st
))
3020 return error_errno(_("could not stat '%s'"), shared_index_path
);
3021 if (st
.st_mtime
> expiration
)
3027 static int clean_shared_index_files(const char *current_hex
)
3030 DIR *dir
= opendir(get_git_dir());
3033 return error_errno(_("unable to open git dir: %s"), get_git_dir());
3035 while ((de
= readdir(dir
)) != NULL
) {
3036 const char *sha1_hex
;
3037 const char *shared_index_path
;
3038 if (!skip_prefix(de
->d_name
, "sharedindex.", &sha1_hex
))
3040 if (!strcmp(sha1_hex
, current_hex
))
3042 shared_index_path
= git_path("%s", de
->d_name
);
3043 if (should_delete_shared_index(shared_index_path
) > 0 &&
3044 unlink(shared_index_path
))
3045 warning_errno(_("unable to unlink: %s"), shared_index_path
);
3052 static int write_shared_index(struct index_state
*istate
,
3053 struct tempfile
**temp
)
3055 struct split_index
*si
= istate
->split_index
;
3058 move_cache_to_base_index(istate
);
3059 ret
= do_write_index(si
->base
, *temp
, 1);
3062 ret
= adjust_shared_perm(get_tempfile_path(*temp
));
3064 error("cannot fix permission bits on %s", get_tempfile_path(*temp
));
3067 ret
= rename_tempfile(temp
,
3068 git_path("sharedindex.%s", oid_to_hex(&si
->base
->oid
)));
3070 oidcpy(&si
->base_oid
, &si
->base
->oid
);
3071 clean_shared_index_files(oid_to_hex(&si
->base
->oid
));
3077 static const int default_max_percent_split_change
= 20;
3079 static int too_many_not_shared_entries(struct index_state
*istate
)
3081 int i
, not_shared
= 0;
3082 int max_split
= git_config_get_max_percent_split_change();
3084 switch (max_split
) {
3086 /* not or badly configured: use the default value */
3087 max_split
= default_max_percent_split_change
;
3090 return 1; /* 0% means always write a new shared index */
3092 return 0; /* 100% means never write a new shared index */
3094 break; /* just use the configured value */
3097 /* Count not shared entries */
3098 for (i
= 0; i
< istate
->cache_nr
; i
++) {
3099 struct cache_entry
*ce
= istate
->cache
[i
];
3104 return (int64_t)istate
->cache_nr
* max_split
< (int64_t)not_shared
* 100;
3107 int write_locked_index(struct index_state
*istate
, struct lock_file
*lock
,
3110 int new_shared_index
, ret
;
3111 struct split_index
*si
= istate
->split_index
;
3113 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
3114 cache_tree_verify(istate
);
3116 if ((flags
& SKIP_IF_UNCHANGED
) && !istate
->cache_changed
) {
3117 if (flags
& COMMIT_LOCK
)
3118 rollback_lock_file(lock
);
3122 if (istate
->fsmonitor_last_update
)
3123 fill_fsmonitor_bitmap(istate
);
3125 if (!si
|| alternate_index_output
||
3126 (istate
->cache_changed
& ~EXTMASK
)) {
3128 oidclr(&si
->base_oid
);
3129 ret
= do_write_locked_index(istate
, lock
, flags
);
3133 if (git_env_bool("GIT_TEST_SPLIT_INDEX", 0)) {
3134 int v
= si
->base_oid
.hash
[0];
3136 istate
->cache_changed
|= SPLIT_INDEX_ORDERED
;
3138 if (too_many_not_shared_entries(istate
))
3139 istate
->cache_changed
|= SPLIT_INDEX_ORDERED
;
3141 new_shared_index
= istate
->cache_changed
& SPLIT_INDEX_ORDERED
;
3143 if (new_shared_index
) {
3144 struct tempfile
*temp
;
3147 temp
= mks_tempfile(git_path("sharedindex_XXXXXX"));
3149 oidclr(&si
->base_oid
);
3150 ret
= do_write_locked_index(istate
, lock
, flags
);
3153 ret
= write_shared_index(istate
, &temp
);
3155 saved_errno
= errno
;
3156 if (is_tempfile_active(temp
))
3157 delete_tempfile(&temp
);
3158 errno
= saved_errno
;
3164 ret
= write_split_index(istate
, lock
, flags
);
3166 /* Freshen the shared index only if the split-index was written */
3167 if (!ret
&& !new_shared_index
) {
3168 const char *shared_index
= git_path("sharedindex.%s",
3169 oid_to_hex(&si
->base_oid
));
3170 freshen_shared_index(shared_index
, 1);
3174 if (flags
& COMMIT_LOCK
)
3175 rollback_lock_file(lock
);
3180 * Read the index file that is potentially unmerged into given
3181 * index_state, dropping any unmerged entries to stage #0 (potentially
3182 * resulting in a path appearing as both a file and a directory in the
3183 * index; the caller is responsible to clear out the extra entries
3184 * before writing the index to a tree). Returns true if the index is
3185 * unmerged. Callers who want to refuse to work from an unmerged
3186 * state can call this and check its return value, instead of calling
3189 int read_index_unmerged(struct index_state
*istate
)
3195 for (i
= 0; i
< istate
->cache_nr
; i
++) {
3196 struct cache_entry
*ce
= istate
->cache
[i
];
3197 struct cache_entry
*new_ce
;
3203 len
= ce_namelen(ce
);
3204 new_ce
= make_empty_cache_entry(istate
, len
);
3205 memcpy(new_ce
->name
, ce
->name
, len
);
3206 new_ce
->ce_flags
= create_ce_flags(0) | CE_CONFLICTED
;
3207 new_ce
->ce_namelen
= len
;
3208 new_ce
->ce_mode
= ce
->ce_mode
;
3209 if (add_index_entry(istate
, new_ce
, ADD_CACHE_SKIP_DFCHECK
))
3210 return error("%s: cannot drop to stage #0",
3217 * Returns 1 if the path is an "other" path with respect to
3218 * the index; that is, the path is not mentioned in the index at all,
3219 * either as a file, a directory with some files in the index,
3220 * or as an unmerged entry.
3222 * We helpfully remove a trailing "/" from directories so that
3223 * the output of read_directory can be used as-is.
3225 int index_name_is_other(const struct index_state
*istate
, const char *name
,
3229 if (namelen
&& name
[namelen
- 1] == '/')
3231 pos
= index_name_pos(istate
, name
, namelen
);
3233 return 0; /* exact match */
3235 if (pos
< istate
->cache_nr
) {
3236 struct cache_entry
*ce
= istate
->cache
[pos
];
3237 if (ce_namelen(ce
) == namelen
&&
3238 !memcmp(ce
->name
, name
, namelen
))
3239 return 0; /* Yup, this one exists unmerged */
3244 void *read_blob_data_from_index(const struct index_state
*istate
,
3245 const char *path
, unsigned long *size
)
3249 enum object_type type
;
3253 pos
= index_name_pos(istate
, path
, len
);
3256 * We might be in the middle of a merge, in which
3257 * case we would read stage #2 (ours).
3261 (pos
< 0 && i
< istate
->cache_nr
&&
3262 !strcmp(istate
->cache
[i
]->name
, path
));
3264 if (ce_stage(istate
->cache
[i
]) == 2)
3269 data
= read_object_file(&istate
->cache
[pos
]->oid
, &type
, &sz
);
3270 if (!data
|| type
!= OBJ_BLOB
) {
3279 void stat_validity_clear(struct stat_validity
*sv
)
3281 FREE_AND_NULL(sv
->sd
);
3284 int stat_validity_check(struct stat_validity
*sv
, const char *path
)
3288 if (stat(path
, &st
) < 0)
3289 return sv
->sd
== NULL
;
3292 return S_ISREG(st
.st_mode
) && !match_stat_data(sv
->sd
, &st
);
3295 void stat_validity_update(struct stat_validity
*sv
, int fd
)
3299 if (fstat(fd
, &st
) < 0 || !S_ISREG(st
.st_mode
))
3300 stat_validity_clear(sv
);
3303 sv
->sd
= xcalloc(1, sizeof(struct stat_data
));
3304 fill_stat_data(sv
->sd
, &st
);
3308 void move_index_extensions(struct index_state
*dst
, struct index_state
*src
)
3310 dst
->untracked
= src
->untracked
;
3311 src
->untracked
= NULL
;
3312 dst
->cache_tree
= src
->cache_tree
;
3313 src
->cache_tree
= NULL
;
3316 struct cache_entry
*dup_cache_entry(const struct cache_entry
*ce
,
3317 struct index_state
*istate
)
3319 unsigned int size
= ce_size(ce
);
3320 int mem_pool_allocated
;
3321 struct cache_entry
*new_entry
= make_empty_cache_entry(istate
, ce_namelen(ce
));
3322 mem_pool_allocated
= new_entry
->mem_pool_allocated
;
3324 memcpy(new_entry
, ce
, size
);
3325 new_entry
->mem_pool_allocated
= mem_pool_allocated
;
3329 void discard_cache_entry(struct cache_entry
*ce
)
3331 if (ce
&& should_validate_cache_entries())
3332 memset(ce
, 0xCD, cache_entry_size(ce
->ce_namelen
));
3334 if (ce
&& ce
->mem_pool_allocated
)
3340 int should_validate_cache_entries(void)
3342 static int validate_index_cache_entries
= -1;
3344 if (validate_index_cache_entries
< 0) {
3345 if (getenv("GIT_TEST_VALIDATE_INDEX_CACHE_ENTRIES"))
3346 validate_index_cache_entries
= 1;
3348 validate_index_cache_entries
= 0;
3351 return validate_index_cache_entries
;
3354 #define EOIE_SIZE (4 + GIT_SHA1_RAWSZ) /* <4-byte offset> + <20-byte hash> */
3355 #define EOIE_SIZE_WITH_HEADER (4 + 4 + EOIE_SIZE) /* <4-byte signature> + <4-byte length> + EOIE_SIZE */
3357 static size_t read_eoie_extension(const char *mmap
, size_t mmap_size
)
3360 * The end of index entries (EOIE) extension is guaranteed to be last
3361 * so that it can be found by scanning backwards from the EOF.
3368 const char *index
, *eoie
;
3370 size_t offset
, src_offset
;
3371 unsigned char hash
[GIT_MAX_RAWSZ
];
3374 /* ensure we have an index big enough to contain an EOIE extension */
3375 if (mmap_size
< sizeof(struct cache_header
) + EOIE_SIZE_WITH_HEADER
+ the_hash_algo
->rawsz
)
3378 /* validate the extension signature */
3379 index
= eoie
= mmap
+ mmap_size
- EOIE_SIZE_WITH_HEADER
- the_hash_algo
->rawsz
;
3380 if (CACHE_EXT(index
) != CACHE_EXT_ENDOFINDEXENTRIES
)
3382 index
+= sizeof(uint32_t);
3384 /* validate the extension size */
3385 extsize
= get_be32(index
);
3386 if (extsize
!= EOIE_SIZE
)
3388 index
+= sizeof(uint32_t);
3391 * Validate the offset we're going to look for the first extension
3392 * signature is after the index header and before the eoie extension.
3394 offset
= get_be32(index
);
3395 if (mmap
+ offset
< mmap
+ sizeof(struct cache_header
))
3397 if (mmap
+ offset
>= eoie
)
3399 index
+= sizeof(uint32_t);
3402 * The hash is computed over extension types and their sizes (but not
3403 * their contents). E.g. if we have "TREE" extension that is N-bytes
3404 * long, "REUC" extension that is M-bytes long, followed by "EOIE",
3405 * then the hash would be:
3407 * SHA-1("TREE" + <binary representation of N> +
3408 * "REUC" + <binary representation of M>)
3410 src_offset
= offset
;
3411 the_hash_algo
->init_fn(&c
);
3412 while (src_offset
< mmap_size
- the_hash_algo
->rawsz
- EOIE_SIZE_WITH_HEADER
) {
3413 /* After an array of active_nr index entries,
3414 * there can be arbitrary number of extended
3415 * sections, each of which is prefixed with
3416 * extension name (4-byte) and section length
3417 * in 4-byte network byte order.
3420 memcpy(&extsize
, mmap
+ src_offset
+ 4, 4);
3421 extsize
= ntohl(extsize
);
3423 /* verify the extension size isn't so large it will wrap around */
3424 if (src_offset
+ 8 + extsize
< src_offset
)
3427 the_hash_algo
->update_fn(&c
, mmap
+ src_offset
, 8);
3430 src_offset
+= extsize
;
3432 the_hash_algo
->final_fn(hash
, &c
);
3433 if (!hasheq(hash
, (const unsigned char *)index
))
3436 /* Validate that the extension offsets returned us back to the eoie extension. */
3437 if (src_offset
!= mmap_size
- the_hash_algo
->rawsz
- EOIE_SIZE_WITH_HEADER
)
3443 static void write_eoie_extension(struct strbuf
*sb
, git_hash_ctx
*eoie_context
, size_t offset
)
3446 unsigned char hash
[GIT_MAX_RAWSZ
];
3449 put_be32(&buffer
, offset
);
3450 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3453 the_hash_algo
->final_fn(hash
, eoie_context
);
3454 strbuf_add(sb
, hash
, the_hash_algo
->rawsz
);
3457 #define IEOT_VERSION (1)
3459 static struct index_entry_offset_table
*read_ieot_extension(const char *mmap
, size_t mmap_size
, size_t offset
)
3461 const char *index
= NULL
;
3462 uint32_t extsize
, ext_version
;
3463 struct index_entry_offset_table
*ieot
;
3466 /* find the IEOT extension */
3469 while (offset
<= mmap_size
- the_hash_algo
->rawsz
- 8) {
3470 extsize
= get_be32(mmap
+ offset
+ 4);
3471 if (CACHE_EXT((mmap
+ offset
)) == CACHE_EXT_INDEXENTRYOFFSETTABLE
) {
3472 index
= mmap
+ offset
+ 4 + 4;
3481 /* validate the version is IEOT_VERSION */
3482 ext_version
= get_be32(index
);
3483 if (ext_version
!= IEOT_VERSION
) {
3484 error("invalid IEOT version %d", ext_version
);
3487 index
+= sizeof(uint32_t);
3489 /* extension size - version bytes / bytes per entry */
3490 nr
= (extsize
- sizeof(uint32_t)) / (sizeof(uint32_t) + sizeof(uint32_t));
3492 error("invalid number of IEOT entries %d", nr
);
3495 ieot
= xmalloc(sizeof(struct index_entry_offset_table
)
3496 + (nr
* sizeof(struct index_entry_offset
)));
3498 for (i
= 0; i
< nr
; i
++) {
3499 ieot
->entries
[i
].offset
= get_be32(index
);
3500 index
+= sizeof(uint32_t);
3501 ieot
->entries
[i
].nr
= get_be32(index
);
3502 index
+= sizeof(uint32_t);
3508 static void write_ieot_extension(struct strbuf
*sb
, struct index_entry_offset_table
*ieot
)
3514 put_be32(&buffer
, IEOT_VERSION
);
3515 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3518 for (i
= 0; i
< ieot
->nr
; i
++) {
3521 put_be32(&buffer
, ieot
->entries
[i
].offset
);
3522 strbuf_add(sb
, &buffer
, sizeof(uint32_t));
3525 put_be32(&buffer
, ieot
->entries
[i
].nr
);
3526 strbuf_add(sb
, &buffer
, sizeof(uint32_t));