2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 #define NO_THE_INDEX_COMPATIBILITY_MACROS
8 #include "cache-tree.h"
14 #include "resolve-undo.h"
16 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
20 * The first letter should be 'A'..'Z' for extensions that are not
21 * necessary for a correct operation (i.e. optimization data).
22 * When new extensions are added that _needs_ to be understood in
23 * order to correctly interpret the index file, pick character that
24 * is outside the range, to cause the reader to abort.
27 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
28 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
29 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
31 struct index_state the_index;
33 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
35 istate->cache[nr] = ce;
36 add_name_hash(istate, ce);
39 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
41 struct cache_entry *old = istate->cache[nr];
43 remove_name_hash(old);
44 set_index_entry(istate, nr, ce);
45 istate->cache_changed = 1;
48 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
50 struct cache_entry *old = istate->cache[nr], *new;
51 int namelen = strlen(new_name);
53 new = xmalloc(cache_entry_size(namelen));
54 copy_cache_entry(new, old);
55 new->ce_flags &= ~(CE_STATE_MASK | CE_NAMEMASK);
56 new->ce_flags |= (namelen >= CE_NAMEMASK ? CE_NAMEMASK : namelen);
57 memcpy(new->name, new_name, namelen + 1);
59 cache_tree_invalidate_path(istate->cache_tree, old->name);
60 remove_index_entry_at(istate, nr);
61 add_index_entry(istate, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
65 * This only updates the "non-critical" parts of the directory
66 * cache, ie the parts that aren't tracked by GIT, and only used
67 * to validate the cache.
69 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
71 ce->ce_ctime.sec = (unsigned int)st->st_ctime;
72 ce->ce_mtime.sec = (unsigned int)st->st_mtime;
73 ce->ce_ctime.nsec = ST_CTIME_NSEC(*st);
74 ce->ce_mtime.nsec = ST_MTIME_NSEC(*st);
75 ce->ce_dev = st->st_dev;
76 ce->ce_ino = st->st_ino;
77 ce->ce_uid = st->st_uid;
78 ce->ce_gid = st->st_gid;
79 ce->ce_size = st->st_size;
82 ce->ce_flags |= CE_VALID;
84 if (S_ISREG(st->st_mode))
88 static int ce_compare_data(struct cache_entry *ce, struct stat *st)
91 int fd = open(ce->name, O_RDONLY);
94 unsigned char sha1[20];
95 if (!index_fd(sha1, fd, st, 0, OBJ_BLOB, ce->name))
96 match = hashcmp(sha1, ce->sha1);
97 /* index_fd() closed the file descriptor already */
102 static int ce_compare_link(struct cache_entry *ce, size_t expected_size)
107 enum object_type type;
108 struct strbuf sb = STRBUF_INIT;
110 if (strbuf_readlink(&sb, ce->name, expected_size))
113 buffer = read_sha1_file(ce->sha1, &type, &size);
116 match = memcmp(buffer, sb.buf, size);
123 static int ce_compare_gitlink(struct cache_entry *ce)
125 unsigned char sha1[20];
128 * We don't actually require that the .git directory
129 * under GITLINK directory be a valid git directory. It
130 * might even be missing (in case nobody populated that
133 * If so, we consider it always to match.
135 if (resolve_gitlink_ref(ce->name, "HEAD", sha1) < 0)
137 return hashcmp(sha1, ce->sha1);
140 static int ce_modified_check_fs(struct cache_entry *ce, struct stat *st)
142 switch (st->st_mode & S_IFMT) {
144 if (ce_compare_data(ce, st))
148 if (ce_compare_link(ce, xsize_t(st->st_size)))
152 if (S_ISGITLINK(ce->ce_mode))
153 return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
160 static int is_empty_blob_sha1(const unsigned char *sha1)
162 static const unsigned char empty_blob_sha1[20] = {
163 0xe6,0x9d,0xe2,0x9b,0xb2,0xd1,0xd6,0x43,0x4b,0x8b,
164 0x29,0xae,0x77,0x5a,0xd8,0xc2,0xe4,0x8c,0x53,0x91
167 return !hashcmp(sha1, empty_blob_sha1);
170 static int ce_match_stat_basic(struct cache_entry *ce, struct stat *st)
172 unsigned int changed = 0;
174 if (ce->ce_flags & CE_REMOVE)
175 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
177 switch (ce->ce_mode & S_IFMT) {
179 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
180 /* We consider only the owner x bit to be relevant for
183 if (trust_executable_bit &&
184 (0100 & (ce->ce_mode ^ st->st_mode)))
185 changed |= MODE_CHANGED;
188 if (!S_ISLNK(st->st_mode) &&
189 (has_symlinks || !S_ISREG(st->st_mode)))
190 changed |= TYPE_CHANGED;
193 /* We ignore most of the st_xxx fields for gitlinks */
194 if (!S_ISDIR(st->st_mode))
195 changed |= TYPE_CHANGED;
196 else if (ce_compare_gitlink(ce))
197 changed |= DATA_CHANGED;
200 die("internal error: ce_mode is %o", ce->ce_mode);
202 if (ce->ce_mtime.sec != (unsigned int)st->st_mtime)
203 changed |= MTIME_CHANGED;
204 if (trust_ctime && ce->ce_ctime.sec != (unsigned int)st->st_ctime)
205 changed |= CTIME_CHANGED;
208 if (ce->ce_mtime.nsec != ST_MTIME_NSEC(*st))
209 changed |= MTIME_CHANGED;
210 if (trust_ctime && ce->ce_ctime.nsec != ST_CTIME_NSEC(*st))
211 changed |= CTIME_CHANGED;
214 if (ce->ce_uid != (unsigned int) st->st_uid ||
215 ce->ce_gid != (unsigned int) st->st_gid)
216 changed |= OWNER_CHANGED;
217 if (ce->ce_ino != (unsigned int) st->st_ino)
218 changed |= INODE_CHANGED;
222 * st_dev breaks on network filesystems where different
223 * clients will have different views of what "device"
224 * the filesystem is on
226 if (ce->ce_dev != (unsigned int) st->st_dev)
227 changed |= INODE_CHANGED;
230 if (ce->ce_size != (unsigned int) st->st_size)
231 changed |= DATA_CHANGED;
233 /* Racily smudged entry? */
235 if (!is_empty_blob_sha1(ce->sha1))
236 changed |= DATA_CHANGED;
242 static int is_racy_timestamp(const struct index_state *istate, struct cache_entry *ce)
244 return (!S_ISGITLINK(ce->ce_mode) &&
245 istate->timestamp.sec &&
247 /* nanosecond timestamped files can also be racy! */
248 (istate->timestamp.sec < ce->ce_mtime.sec ||
249 (istate->timestamp.sec == ce->ce_mtime.sec &&
250 istate->timestamp.nsec <= ce->ce_mtime.nsec))
252 istate->timestamp.sec <= ce->ce_mtime.sec
257 int ie_match_stat(const struct index_state *istate,
258 struct cache_entry *ce, struct stat *st,
259 unsigned int options)
261 unsigned int changed;
262 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
263 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
264 int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
267 * If it's marked as always valid in the index, it's
268 * valid whatever the checked-out copy says.
270 * skip-worktree has the same effect with higher precedence
272 if (!ignore_skip_worktree && ce_skip_worktree(ce))
274 if (!ignore_valid && (ce->ce_flags & CE_VALID))
278 * Intent-to-add entries have not been added, so the index entry
279 * by definition never matches what is in the work tree until it
280 * actually gets added.
282 if (ce->ce_flags & CE_INTENT_TO_ADD)
283 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
285 changed = ce_match_stat_basic(ce, st);
288 * Within 1 second of this sequence:
289 * echo xyzzy >file && git-update-index --add file
290 * running this command:
292 * would give a falsely clean cache entry. The mtime and
293 * length match the cache, and other stat fields do not change.
295 * We could detect this at update-index time (the cache entry
296 * being registered/updated records the same time as "now")
297 * and delay the return from git-update-index, but that would
298 * effectively mean we can make at most one commit per second,
299 * which is not acceptable. Instead, we check cache entries
300 * whose mtime are the same as the index file timestamp more
301 * carefully than others.
303 if (!changed && is_racy_timestamp(istate, ce)) {
304 if (assume_racy_is_modified)
305 changed |= DATA_CHANGED;
307 changed |= ce_modified_check_fs(ce, st);
313 int ie_modified(const struct index_state *istate,
314 struct cache_entry *ce, struct stat *st, unsigned int options)
316 int changed, changed_fs;
318 changed = ie_match_stat(istate, ce, st, options);
322 * If the mode or type has changed, there's no point in trying
323 * to refresh the entry - it's not going to match
325 if (changed & (MODE_CHANGED | TYPE_CHANGED))
329 * Immediately after read-tree or update-index --cacheinfo,
330 * the length field is zero, as we have never even read the
331 * lstat(2) information once, and we cannot trust DATA_CHANGED
332 * returned by ie_match_stat() which in turn was returned by
333 * ce_match_stat_basic() to signal that the filesize of the
334 * blob changed. We have to actually go to the filesystem to
335 * see if the contents match, and if so, should answer "unchanged".
337 * The logic does not apply to gitlinks, as ce_match_stat_basic()
338 * already has checked the actual HEAD from the filesystem in the
339 * subproject. If ie_match_stat() already said it is different,
340 * then we know it is.
342 if ((changed & DATA_CHANGED) &&
343 (S_ISGITLINK(ce->ce_mode) || ce->ce_size != 0))
346 changed_fs = ce_modified_check_fs(ce, st);
348 return changed | changed_fs;
352 int base_name_compare(const char *name1, int len1, int mode1,
353 const char *name2, int len2, int mode2)
355 unsigned char c1, c2;
356 int len = len1 < len2 ? len1 : len2;
359 cmp = memcmp(name1, name2, len);
364 if (!c1 && S_ISDIR(mode1))
366 if (!c2 && S_ISDIR(mode2))
368 return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
372 * df_name_compare() is identical to base_name_compare(), except it
373 * compares conflicting directory/file entries as equal. Note that
374 * while a directory name compares as equal to a regular file, they
375 * then individually compare _differently_ to a filename that has
376 * a dot after the basename (because '\0' < '.' < '/').
378 * This is used by routines that want to traverse the git namespace
379 * but then handle conflicting entries together when possible.
381 int df_name_compare(const char *name1, int len1, int mode1,
382 const char *name2, int len2, int mode2)
384 int len = len1 < len2 ? len1 : len2, cmp;
385 unsigned char c1, c2;
387 cmp = memcmp(name1, name2, len);
390 /* Directories and files compare equal (same length, same name) */
394 if (!c1 && S_ISDIR(mode1))
397 if (!c2 && S_ISDIR(mode2))
399 if (c1 == '/' && !c2)
401 if (c2 == '/' && !c1)
406 int cache_name_compare(const char *name1, int flags1, const char *name2, int flags2)
408 int len1 = flags1 & CE_NAMEMASK;
409 int len2 = flags2 & CE_NAMEMASK;
410 int len = len1 < len2 ? len1 : len2;
413 cmp = memcmp(name1, name2, len);
422 flags1 &= CE_STAGEMASK;
423 flags2 &= CE_STAGEMASK;
432 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
437 last = istate->cache_nr;
438 while (last > first) {
439 int next = (last + first) >> 1;
440 struct cache_entry *ce = istate->cache[next];
441 int cmp = cache_name_compare(name, namelen, ce->name, ce->ce_flags);
453 /* Remove entry, return true if there are more entries to go.. */
454 int remove_index_entry_at(struct index_state *istate, int pos)
456 struct cache_entry *ce = istate->cache[pos];
458 record_resolve_undo(istate, ce);
459 remove_name_hash(ce);
460 istate->cache_changed = 1;
462 if (pos >= istate->cache_nr)
464 memmove(istate->cache + pos,
465 istate->cache + pos + 1,
466 (istate->cache_nr - pos) * sizeof(struct cache_entry *));
471 * Remove all cache ententries marked for removal, that is where
472 * CE_REMOVE is set in ce_flags. This is much more effective than
473 * calling remove_index_entry_at() for each entry to be removed.
475 void remove_marked_cache_entries(struct index_state *istate)
477 struct cache_entry **ce_array = istate->cache;
480 for (i = j = 0; i < istate->cache_nr; i++) {
481 if (ce_array[i]->ce_flags & CE_REMOVE)
482 remove_name_hash(ce_array[i]);
484 ce_array[j++] = ce_array[i];
486 istate->cache_changed = 1;
487 istate->cache_nr = j;
490 int remove_file_from_index(struct index_state *istate, const char *path)
492 int pos = index_name_pos(istate, path, strlen(path));
495 cache_tree_invalidate_path(istate->cache_tree, path);
496 while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
497 remove_index_entry_at(istate, pos);
501 static int compare_name(struct cache_entry *ce, const char *path, int namelen)
503 return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
506 static int index_name_pos_also_unmerged(struct index_state *istate,
507 const char *path, int namelen)
509 int pos = index_name_pos(istate, path, namelen);
510 struct cache_entry *ce;
515 /* maybe unmerged? */
517 if (pos >= istate->cache_nr ||
518 compare_name((ce = istate->cache[pos]), path, namelen))
521 /* order of preference: stage 2, 1, 3 */
522 if (ce_stage(ce) == 1 && pos + 1 < istate->cache_nr &&
523 ce_stage((ce = istate->cache[pos + 1])) == 2 &&
524 !compare_name(ce, path, namelen))
529 static int different_name(struct cache_entry *ce, struct cache_entry *alias)
531 int len = ce_namelen(ce);
532 return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
536 * If we add a filename that aliases in the cache, we will use the
537 * name that we already have - but we don't want to update the same
538 * alias twice, because that implies that there were actually two
539 * different files with aliasing names!
541 * So we use the CE_ADDED flag to verify that the alias was an old
542 * one before we accept it as
544 static struct cache_entry *create_alias_ce(struct cache_entry *ce, struct cache_entry *alias)
547 struct cache_entry *new;
549 if (alias->ce_flags & CE_ADDED)
550 die("Will not add file alias '%s' ('%s' already exists in index)", ce->name, alias->name);
552 /* Ok, create the new entry using the name of the existing alias */
553 len = ce_namelen(alias);
554 new = xcalloc(1, cache_entry_size(len));
555 memcpy(new->name, alias->name, len);
556 copy_cache_entry(new, ce);
561 static void record_intent_to_add(struct cache_entry *ce)
563 unsigned char sha1[20];
564 if (write_sha1_file("", 0, blob_type, sha1))
565 die("cannot create an empty blob in the object database");
566 hashcpy(ce->sha1, sha1);
569 int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
571 int size, namelen, was_same;
572 mode_t st_mode = st->st_mode;
573 struct cache_entry *ce, *alias;
574 unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
575 int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
576 int pretend = flags & ADD_CACHE_PRETEND;
577 int intent_only = flags & ADD_CACHE_INTENT;
578 int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
579 (intent_only ? ADD_CACHE_NEW_ONLY : 0));
581 if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
582 return error("%s: can only add regular files, symbolic links or git-directories", path);
584 namelen = strlen(path);
585 if (S_ISDIR(st_mode)) {
586 while (namelen && path[namelen-1] == '/')
589 size = cache_entry_size(namelen);
590 ce = xcalloc(1, size);
591 memcpy(ce->name, path, namelen);
592 ce->ce_flags = namelen;
594 fill_stat_cache_info(ce, st);
596 ce->ce_flags |= CE_INTENT_TO_ADD;
598 if (trust_executable_bit && has_symlinks)
599 ce->ce_mode = create_ce_mode(st_mode);
601 /* If there is an existing entry, pick the mode bits and type
602 * from it, otherwise assume unexecutable regular file.
604 struct cache_entry *ent;
605 int pos = index_name_pos_also_unmerged(istate, path, namelen);
607 ent = (0 <= pos) ? istate->cache[pos] : NULL;
608 ce->ce_mode = ce_mode_from_stat(ent, st_mode);
611 /* When core.ignorecase=true, determine if a directory of the same name but differing
612 * case already exists within the Git repository. If it does, ensure the directory
613 * case of the file being added to the repository matches (is folded into) the existing
614 * entry's directory case.
617 const char *startPtr = ce->name;
618 const char *ptr = startPtr;
620 while (*ptr && *ptr != '/')
623 struct cache_entry *foundce;
625 foundce = index_name_exists(&the_index, ce->name, ptr - ce->name, ignore_case);
627 memcpy((void *)startPtr, foundce->name + (startPtr - ce->name), ptr - startPtr);
634 alias = index_name_exists(istate, ce->name, ce_namelen(ce), ignore_case);
635 if (alias && !ce_stage(alias) && !ie_match_stat(istate, alias, st, ce_option)) {
636 /* Nothing changed, really */
638 if (!S_ISGITLINK(alias->ce_mode))
639 ce_mark_uptodate(alias);
640 alias->ce_flags |= CE_ADDED;
644 if (index_path(ce->sha1, path, st, 1))
645 return error("unable to index file %s", path);
647 record_intent_to_add(ce);
649 if (ignore_case && alias && different_name(ce, alias))
650 ce = create_alias_ce(ce, alias);
651 ce->ce_flags |= CE_ADDED;
653 /* It was suspected to be racily clean, but it turns out to be Ok */
656 !hashcmp(alias->sha1, ce->sha1) &&
657 ce->ce_mode == alias->ce_mode);
661 else if (add_index_entry(istate, ce, add_option))
662 return error("unable to add %s to index",path);
663 if (verbose && !was_same)
664 printf("add '%s'\n", path);
668 int add_file_to_index(struct index_state *istate, const char *path, int flags)
671 if (lstat(path, &st))
672 die_errno("unable to stat '%s'", path);
673 return add_to_index(istate, path, &st, flags);
676 struct cache_entry *make_cache_entry(unsigned int mode,
677 const unsigned char *sha1, const char *path, int stage,
681 struct cache_entry *ce;
683 if (!verify_path(path)) {
684 error("Invalid path '%s'", path);
689 size = cache_entry_size(len);
690 ce = xcalloc(1, size);
692 hashcpy(ce->sha1, sha1);
693 memcpy(ce->name, path, len);
694 ce->ce_flags = create_ce_flags(len, stage);
695 ce->ce_mode = create_ce_mode(mode);
698 return refresh_cache_entry(ce, 0);
703 int ce_same_name(struct cache_entry *a, struct cache_entry *b)
705 int len = ce_namelen(a);
706 return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
709 int ce_path_match(const struct cache_entry *ce, const char **pathspec)
711 const char *match, *name;
717 len = ce_namelen(ce);
719 while ((match = *pathspec++) != NULL) {
720 int matchlen = strlen(match);
723 if (memcmp(name, match, matchlen))
725 if (matchlen && name[matchlen-1] == '/')
727 if (name[matchlen] == '/' || !name[matchlen])
736 * We fundamentally don't like some paths: we don't want
737 * dot or dot-dot anywhere, and for obvious reasons don't
738 * want to recurse into ".git" either.
740 * Also, we don't want double slashes or slashes at the
741 * end that can make pathnames ambiguous.
743 static int verify_dotfile(const char *rest)
746 * The first character was '.', but that
747 * has already been discarded, we now test
751 /* "." is not allowed */
756 * ".git" followed by NUL or slash is bad. This
757 * shares the path end test with the ".." case.
767 if (rest[1] == '\0' || rest[1] == '/')
773 int verify_path(const char *path)
790 if (verify_dotfile(path))
800 * Do we have another file that has the beginning components being a
801 * proper superset of the name we're trying to add?
803 static int has_file_name(struct index_state *istate,
804 const struct cache_entry *ce, int pos, int ok_to_replace)
807 int len = ce_namelen(ce);
808 int stage = ce_stage(ce);
809 const char *name = ce->name;
811 while (pos < istate->cache_nr) {
812 struct cache_entry *p = istate->cache[pos++];
814 if (len >= ce_namelen(p))
816 if (memcmp(name, p->name, len))
818 if (ce_stage(p) != stage)
820 if (p->name[len] != '/')
822 if (p->ce_flags & CE_REMOVE)
827 remove_index_entry_at(istate, --pos);
833 * Do we have another file with a pathname that is a proper
834 * subset of the name we're trying to add?
836 static int has_dir_name(struct index_state *istate,
837 const struct cache_entry *ce, int pos, int ok_to_replace)
840 int stage = ce_stage(ce);
841 const char *name = ce->name;
842 const char *slash = name + ce_namelen(ce);
850 if (slash <= ce->name)
855 pos = index_name_pos(istate, name, create_ce_flags(len, stage));
858 * Found one, but not so fast. This could
859 * be a marker that says "I was here, but
860 * I am being removed". Such an entry is
861 * not a part of the resulting tree, and
862 * it is Ok to have a directory at the same
865 if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
869 remove_index_entry_at(istate, pos);
877 * Trivial optimization: if we find an entry that
878 * already matches the sub-directory, then we know
879 * we're ok, and we can exit.
881 while (pos < istate->cache_nr) {
882 struct cache_entry *p = istate->cache[pos];
883 if ((ce_namelen(p) <= len) ||
884 (p->name[len] != '/') ||
885 memcmp(p->name, name, len))
886 break; /* not our subdirectory */
887 if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
889 * p is at the same stage as our entry, and
890 * is a subdirectory of what we are looking
891 * at, so we cannot have conflicts at our
892 * level or anything shorter.
901 /* We may be in a situation where we already have path/file and path
902 * is being added, or we already have path and path/file is being
903 * added. Either one would result in a nonsense tree that has path
904 * twice when git-write-tree tries to write it out. Prevent it.
906 * If ok-to-replace is specified, we remove the conflicting entries
907 * from the cache so the caller should recompute the insert position.
908 * When this happens, we return non-zero.
910 static int check_file_directory_conflict(struct index_state *istate,
911 const struct cache_entry *ce,
912 int pos, int ok_to_replace)
917 * When ce is an "I am going away" entry, we allow it to be added
919 if (ce->ce_flags & CE_REMOVE)
923 * We check if the path is a sub-path of a subsequent pathname
924 * first, since removing those will not change the position
927 retval = has_file_name(istate, ce, pos, ok_to_replace);
930 * Then check if the path might have a clashing sub-directory
933 return retval + has_dir_name(istate, ce, pos, ok_to_replace);
936 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
939 int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
940 int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
941 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
942 int new_only = option & ADD_CACHE_NEW_ONLY;
944 cache_tree_invalidate_path(istate->cache_tree, ce->name);
945 pos = index_name_pos(istate, ce->name, ce->ce_flags);
947 /* existing match? Just replace it. */
950 replace_index_entry(istate, pos, ce);
956 * Inserting a merged entry ("stage 0") into the index
957 * will always replace all non-merged entries..
959 if (pos < istate->cache_nr && ce_stage(ce) == 0) {
960 while (ce_same_name(istate->cache[pos], ce)) {
962 if (!remove_index_entry_at(istate, pos))
969 if (!verify_path(ce->name))
970 return error("Invalid path '%s'", ce->name);
972 if (!skip_df_check &&
973 check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
975 return error("'%s' appears as both a file and as a directory",
977 pos = index_name_pos(istate, ce->name, ce->ce_flags);
983 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
987 if (option & ADD_CACHE_JUST_APPEND)
988 pos = istate->cache_nr;
991 ret = add_index_entry_with_check(istate, ce, option);
997 /* Make sure the array is big enough .. */
998 if (istate->cache_nr == istate->cache_alloc) {
999 istate->cache_alloc = alloc_nr(istate->cache_alloc);
1000 istate->cache = xrealloc(istate->cache,
1001 istate->cache_alloc * sizeof(struct cache_entry *));
1006 if (istate->cache_nr > pos + 1)
1007 memmove(istate->cache + pos + 1,
1008 istate->cache + pos,
1009 (istate->cache_nr - pos - 1) * sizeof(ce));
1010 set_index_entry(istate, pos, ce);
1011 istate->cache_changed = 1;
1016 * "refresh" does not calculate a new sha1 file or bring the
1017 * cache up-to-date for mode/content changes. But what it
1018 * _does_ do is to "re-match" the stat information of a file
1019 * with the cache, so that you can refresh the cache for a
1020 * file that hasn't been changed but where the stat entry is
1023 * For example, you'd want to do this after doing a "git-read-tree",
1024 * to link up the stat cache details with the proper files.
1026 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1027 struct cache_entry *ce,
1028 unsigned int options, int *err)
1031 struct cache_entry *updated;
1033 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1034 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1036 if (ce_uptodate(ce))
1040 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1041 * that the change to the work tree does not matter and told
1044 if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1045 ce_mark_uptodate(ce);
1048 if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1049 ce_mark_uptodate(ce);
1053 if (lstat(ce->name, &st) < 0) {
1059 changed = ie_match_stat(istate, ce, &st, options);
1062 * The path is unchanged. If we were told to ignore
1063 * valid bit, then we did the actual stat check and
1064 * found that the entry is unmodified. If the entry
1065 * is not marked VALID, this is the place to mark it
1066 * valid again, under "assume unchanged" mode.
1068 if (ignore_valid && assume_unchanged &&
1069 !(ce->ce_flags & CE_VALID))
1070 ; /* mark this one VALID again */
1073 * We do not mark the index itself "modified"
1074 * because CE_UPTODATE flag is in-core only;
1075 * we are not going to write this change out.
1077 if (!S_ISGITLINK(ce->ce_mode))
1078 ce_mark_uptodate(ce);
1083 if (ie_modified(istate, ce, &st, options)) {
1090 updated = xmalloc(size);
1091 memcpy(updated, ce, size);
1092 fill_stat_cache_info(updated, &st);
1094 * If ignore_valid is not set, we should leave CE_VALID bit
1095 * alone. Otherwise, paths marked with --no-assume-unchanged
1096 * (i.e. things to be edited) will reacquire CE_VALID bit
1097 * automatically, which is not really what we want.
1099 if (!ignore_valid && assume_unchanged &&
1100 !(ce->ce_flags & CE_VALID))
1101 updated->ce_flags &= ~CE_VALID;
1106 static void show_file(const char * fmt, const char * name, int in_porcelain,
1107 int * first, char *header_msg)
1109 if (in_porcelain && *first && header_msg) {
1110 printf("%s\n", header_msg);
1116 int refresh_index(struct index_state *istate, unsigned int flags, const char **pathspec,
1117 char *seen, char *header_msg)
1121 int really = (flags & REFRESH_REALLY) != 0;
1122 int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1123 int quiet = (flags & REFRESH_QUIET) != 0;
1124 int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1125 int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1127 int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1128 unsigned int options = really ? CE_MATCH_IGNORE_VALID : 0;
1129 const char *needs_update_fmt;
1130 const char *needs_merge_fmt;
1132 needs_update_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1133 needs_merge_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1134 for (i = 0; i < istate->cache_nr; i++) {
1135 struct cache_entry *ce, *new;
1136 int cache_errno = 0;
1138 ce = istate->cache[i];
1139 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1143 while ((i < istate->cache_nr) &&
1144 ! strcmp(istate->cache[i]->name, ce->name))
1149 show_file(needs_merge_fmt, ce->name, in_porcelain, &first, header_msg);
1154 if (pathspec && !match_pathspec(pathspec, ce->name, strlen(ce->name), 0, seen))
1157 new = refresh_cache_ent(istate, ce, options, &cache_errno);
1161 if (not_new && cache_errno == ENOENT)
1163 if (really && cache_errno == EINVAL) {
1164 /* If we are doing --really-refresh that
1165 * means the index is not valid anymore.
1167 ce->ce_flags &= ~CE_VALID;
1168 istate->cache_changed = 1;
1172 show_file(needs_update_fmt, ce->name, in_porcelain, &first, header_msg);
1177 replace_index_entry(istate, i, new);
1182 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really)
1184 return refresh_cache_ent(&the_index, ce, really, NULL);
1187 static int verify_hdr(struct cache_header *hdr, unsigned long size)
1190 unsigned char sha1[20];
1192 if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1193 return error("bad signature");
1194 if (hdr->hdr_version != htonl(2) && hdr->hdr_version != htonl(3))
1195 return error("bad index version");
1197 git_SHA1_Update(&c, hdr, size - 20);
1198 git_SHA1_Final(sha1, &c);
1199 if (hashcmp(sha1, (unsigned char *)hdr + size - 20))
1200 return error("bad index file sha1 signature");
1204 static int read_index_extension(struct index_state *istate,
1205 const char *ext, void *data, unsigned long sz)
1207 switch (CACHE_EXT(ext)) {
1208 case CACHE_EXT_TREE:
1209 istate->cache_tree = cache_tree_read(data, sz);
1211 case CACHE_EXT_RESOLVE_UNDO:
1212 istate->resolve_undo = resolve_undo_read(data, sz);
1215 if (*ext < 'A' || 'Z' < *ext)
1216 return error("index uses %.4s extension, which we do not understand",
1218 fprintf(stderr, "ignoring %.4s extension\n", ext);
1224 int read_index(struct index_state *istate)
1226 return read_index_from(istate, get_index_file());
1229 static void convert_from_disk(struct ondisk_cache_entry *ondisk, struct cache_entry *ce)
1234 ce->ce_ctime.sec = ntohl(ondisk->ctime.sec);
1235 ce->ce_mtime.sec = ntohl(ondisk->mtime.sec);
1236 ce->ce_ctime.nsec = ntohl(ondisk->ctime.nsec);
1237 ce->ce_mtime.nsec = ntohl(ondisk->mtime.nsec);
1238 ce->ce_dev = ntohl(ondisk->dev);
1239 ce->ce_ino = ntohl(ondisk->ino);
1240 ce->ce_mode = ntohl(ondisk->mode);
1241 ce->ce_uid = ntohl(ondisk->uid);
1242 ce->ce_gid = ntohl(ondisk->gid);
1243 ce->ce_size = ntohl(ondisk->size);
1244 /* On-disk flags are just 16 bits */
1245 ce->ce_flags = ntohs(ondisk->flags);
1247 hashcpy(ce->sha1, ondisk->sha1);
1249 len = ce->ce_flags & CE_NAMEMASK;
1251 if (ce->ce_flags & CE_EXTENDED) {
1252 struct ondisk_cache_entry_extended *ondisk2;
1254 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1255 extended_flags = ntohs(ondisk2->flags2) << 16;
1256 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1257 if (extended_flags & ~CE_EXTENDED_FLAGS)
1258 die("Unknown index entry format %08x", extended_flags);
1259 ce->ce_flags |= extended_flags;
1260 name = ondisk2->name;
1263 name = ondisk->name;
1265 if (len == CE_NAMEMASK)
1268 * NEEDSWORK: If the original index is crafted, this copy could
1271 memcpy(ce->name, name, len + 1);
1274 static inline size_t estimate_cache_size(size_t ondisk_size, unsigned int entries)
1278 per_entry = sizeof(struct cache_entry) - sizeof(struct ondisk_cache_entry);
1281 * Alignment can cause differences. This should be "alignof", but
1282 * since that's a gcc'ism, just use the size of a pointer.
1284 per_entry += sizeof(void *);
1285 return ondisk_size + entries*per_entry;
1288 /* remember to discard_cache() before reading a different cache! */
1289 int read_index_from(struct index_state *istate, const char *path)
1293 unsigned long src_offset, dst_offset;
1294 struct cache_header *hdr;
1299 if (istate->initialized)
1300 return istate->cache_nr;
1303 istate->timestamp.sec = 0;
1304 istate->timestamp.nsec = 0;
1305 fd = open(path, O_RDONLY);
1307 if (errno == ENOENT)
1309 die_errno("index file open failed");
1313 die_errno("cannot stat the open index");
1316 mmap_size = xsize_t(st.st_size);
1317 if (mmap_size < sizeof(struct cache_header) + 20)
1318 die("index file smaller than expected");
1320 mmap = xmmap(NULL, mmap_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0);
1322 if (mmap == MAP_FAILED)
1323 die_errno("unable to map index file");
1326 if (verify_hdr(hdr, mmap_size) < 0)
1329 istate->cache_nr = ntohl(hdr->hdr_entries);
1330 istate->cache_alloc = alloc_nr(istate->cache_nr);
1331 istate->cache = xcalloc(istate->cache_alloc, sizeof(struct cache_entry *));
1334 * The disk format is actually larger than the in-memory format,
1335 * due to space for nsec etc, so even though the in-memory one
1336 * has room for a few more flags, we can allocate using the same
1339 istate->alloc = xmalloc(estimate_cache_size(mmap_size, istate->cache_nr));
1340 istate->initialized = 1;
1342 src_offset = sizeof(*hdr);
1344 for (i = 0; i < istate->cache_nr; i++) {
1345 struct ondisk_cache_entry *disk_ce;
1346 struct cache_entry *ce;
1348 disk_ce = (struct ondisk_cache_entry *)((char *)mmap + src_offset);
1349 ce = (struct cache_entry *)((char *)istate->alloc + dst_offset);
1350 convert_from_disk(disk_ce, ce);
1351 set_index_entry(istate, i, ce);
1353 src_offset += ondisk_ce_size(ce);
1354 dst_offset += ce_size(ce);
1356 istate->timestamp.sec = st.st_mtime;
1357 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1359 while (src_offset <= mmap_size - 20 - 8) {
1360 /* After an array of active_nr index entries,
1361 * there can be arbitrary number of extended
1362 * sections, each of which is prefixed with
1363 * extension name (4-byte) and section length
1364 * in 4-byte network byte order.
1367 memcpy(&extsize, (char *)mmap + src_offset + 4, 4);
1368 extsize = ntohl(extsize);
1369 if (read_index_extension(istate,
1370 (const char *) mmap + src_offset,
1371 (char *) mmap + src_offset + 8,
1375 src_offset += extsize;
1377 munmap(mmap, mmap_size);
1378 return istate->cache_nr;
1381 munmap(mmap, mmap_size);
1383 die("index file corrupt");
1386 int is_index_unborn(struct index_state *istate)
1388 return (!istate->cache_nr && !istate->alloc && !istate->timestamp.sec);
1391 int discard_index(struct index_state *istate)
1393 resolve_undo_clear_index(istate);
1394 istate->cache_nr = 0;
1395 istate->cache_changed = 0;
1396 istate->timestamp.sec = 0;
1397 istate->timestamp.nsec = 0;
1398 istate->name_hash_initialized = 0;
1399 free_hash(&istate->name_hash);
1400 cache_tree_free(&(istate->cache_tree));
1401 free(istate->alloc);
1402 istate->alloc = NULL;
1403 istate->initialized = 0;
1405 /* no need to throw away allocated active_cache */
1409 int unmerged_index(const struct index_state *istate)
1412 for (i = 0; i < istate->cache_nr; i++) {
1413 if (ce_stage(istate->cache[i]))
1419 #define WRITE_BUFFER_SIZE 8192
1420 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
1421 static unsigned long write_buffer_len;
1423 static int ce_write_flush(git_SHA_CTX *context, int fd)
1425 unsigned int buffered = write_buffer_len;
1427 git_SHA1_Update(context, write_buffer, buffered);
1428 if (write_in_full(fd, write_buffer, buffered) != buffered)
1430 write_buffer_len = 0;
1435 static int ce_write(git_SHA_CTX *context, int fd, void *data, unsigned int len)
1438 unsigned int buffered = write_buffer_len;
1439 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
1442 memcpy(write_buffer + buffered, data, partial);
1443 buffered += partial;
1444 if (buffered == WRITE_BUFFER_SIZE) {
1445 write_buffer_len = buffered;
1446 if (ce_write_flush(context, fd))
1450 write_buffer_len = buffered;
1452 data = (char *) data + partial;
1457 static int write_index_ext_header(git_SHA_CTX *context, int fd,
1458 unsigned int ext, unsigned int sz)
1462 return ((ce_write(context, fd, &ext, 4) < 0) ||
1463 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
1466 static int ce_flush(git_SHA_CTX *context, int fd)
1468 unsigned int left = write_buffer_len;
1471 write_buffer_len = 0;
1472 git_SHA1_Update(context, write_buffer, left);
1475 /* Flush first if not enough space for SHA1 signature */
1476 if (left + 20 > WRITE_BUFFER_SIZE) {
1477 if (write_in_full(fd, write_buffer, left) != left)
1482 /* Append the SHA1 signature at the end */
1483 git_SHA1_Final(write_buffer + left, context);
1485 return (write_in_full(fd, write_buffer, left) != left) ? -1 : 0;
1488 static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
1491 * The only thing we care about in this function is to smudge the
1492 * falsely clean entry due to touch-update-touch race, so we leave
1493 * everything else as they are. We are called for entries whose
1494 * ce_mtime match the index file mtime.
1496 * Note that this actually does not do much for gitlinks, for
1497 * which ce_match_stat_basic() always goes to the actual
1498 * contents. The caller checks with is_racy_timestamp() which
1499 * always says "no" for gitlinks, so we are not called for them ;-)
1503 if (lstat(ce->name, &st) < 0)
1505 if (ce_match_stat_basic(ce, &st))
1507 if (ce_modified_check_fs(ce, &st)) {
1508 /* This is "racily clean"; smudge it. Note that this
1509 * is a tricky code. At first glance, it may appear
1510 * that it can break with this sequence:
1512 * $ echo xyzzy >frotz
1513 * $ git-update-index --add frotz
1516 * $ echo filfre >nitfol
1517 * $ git-update-index --add nitfol
1519 * but it does not. When the second update-index runs,
1520 * it notices that the entry "frotz" has the same timestamp
1521 * as index, and if we were to smudge it by resetting its
1522 * size to zero here, then the object name recorded
1523 * in index is the 6-byte file but the cached stat information
1524 * becomes zero --- which would then match what we would
1525 * obtain from the filesystem next time we stat("frotz").
1527 * However, the second update-index, before calling
1528 * this function, notices that the cached size is 6
1529 * bytes and what is on the filesystem is an empty
1530 * file, and never calls us, so the cached size information
1531 * for "frotz" stays 6 which does not match the filesystem.
1537 static int ce_write_entry(git_SHA_CTX *c, int fd, struct cache_entry *ce)
1539 int size = ondisk_ce_size(ce);
1540 struct ondisk_cache_entry *ondisk = xcalloc(1, size);
1544 ondisk->ctime.sec = htonl(ce->ce_ctime.sec);
1545 ondisk->mtime.sec = htonl(ce->ce_mtime.sec);
1546 ondisk->ctime.nsec = htonl(ce->ce_ctime.nsec);
1547 ondisk->mtime.nsec = htonl(ce->ce_mtime.nsec);
1548 ondisk->dev = htonl(ce->ce_dev);
1549 ondisk->ino = htonl(ce->ce_ino);
1550 ondisk->mode = htonl(ce->ce_mode);
1551 ondisk->uid = htonl(ce->ce_uid);
1552 ondisk->gid = htonl(ce->ce_gid);
1553 ondisk->size = htonl(ce->ce_size);
1554 hashcpy(ondisk->sha1, ce->sha1);
1555 ondisk->flags = htons(ce->ce_flags);
1556 if (ce->ce_flags & CE_EXTENDED) {
1557 struct ondisk_cache_entry_extended *ondisk2;
1558 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1559 ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
1560 name = ondisk2->name;
1563 name = ondisk->name;
1564 memcpy(name, ce->name, ce_namelen(ce));
1566 result = ce_write(c, fd, ondisk, size);
1571 static int has_racy_timestamp(struct index_state *istate)
1573 int entries = istate->cache_nr;
1576 for (i = 0; i < entries; i++) {
1577 struct cache_entry *ce = istate->cache[i];
1578 if (is_racy_timestamp(istate, ce))
1585 * Opportunisticly update the index but do not complain if we can't
1587 void update_index_if_able(struct index_state *istate, struct lock_file *lockfile)
1589 if ((istate->cache_changed || has_racy_timestamp(istate)) &&
1590 !write_index(istate, lockfile->fd))
1591 commit_locked_index(lockfile);
1593 rollback_lock_file(lockfile);
1596 int write_index(struct index_state *istate, int newfd)
1599 struct cache_header hdr;
1600 int i, err, removed, extended;
1601 struct cache_entry **cache = istate->cache;
1602 int entries = istate->cache_nr;
1605 for (i = removed = extended = 0; i < entries; i++) {
1606 if (cache[i]->ce_flags & CE_REMOVE)
1609 /* reduce extended entries if possible */
1610 cache[i]->ce_flags &= ~CE_EXTENDED;
1611 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
1613 cache[i]->ce_flags |= CE_EXTENDED;
1617 hdr.hdr_signature = htonl(CACHE_SIGNATURE);
1618 /* for extended format, increase version so older git won't try to read it */
1619 hdr.hdr_version = htonl(extended ? 3 : 2);
1620 hdr.hdr_entries = htonl(entries - removed);
1623 if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
1626 for (i = 0; i < entries; i++) {
1627 struct cache_entry *ce = cache[i];
1628 if (ce->ce_flags & CE_REMOVE)
1630 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
1631 ce_smudge_racily_clean_entry(ce);
1632 if (ce_write_entry(&c, newfd, ce) < 0)
1636 /* Write extension data here */
1637 if (istate->cache_tree) {
1638 struct strbuf sb = STRBUF_INIT;
1640 cache_tree_write(&sb, istate->cache_tree);
1641 err = write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sb.len) < 0
1642 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
1643 strbuf_release(&sb);
1647 if (istate->resolve_undo) {
1648 struct strbuf sb = STRBUF_INIT;
1650 resolve_undo_write(&sb, istate->resolve_undo);
1651 err = write_index_ext_header(&c, newfd, CACHE_EXT_RESOLVE_UNDO,
1653 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
1654 strbuf_release(&sb);
1659 if (ce_flush(&c, newfd) || fstat(newfd, &st))
1661 istate->timestamp.sec = (unsigned int)st.st_mtime;
1662 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1667 * Read the index file that is potentially unmerged into given
1668 * index_state, dropping any unmerged entries. Returns true if
1669 * the index is unmerged. Callers who want to refuse to work
1670 * from an unmerged state can call this and check its return value,
1671 * instead of calling read_cache().
1673 int read_index_unmerged(struct index_state *istate)
1679 for (i = 0; i < istate->cache_nr; i++) {
1680 struct cache_entry *ce = istate->cache[i];
1681 struct cache_entry *new_ce;
1687 len = strlen(ce->name);
1688 size = cache_entry_size(len);
1689 new_ce = xcalloc(1, size);
1690 memcpy(new_ce->name, ce->name, len);
1691 new_ce->ce_flags = create_ce_flags(len, 0) | CE_CONFLICTED;
1692 new_ce->ce_mode = ce->ce_mode;
1693 if (add_index_entry(istate, new_ce, 0))
1694 return error("%s: cannot drop to stage #0",
1696 i = index_name_pos(istate, new_ce->name, len);
1702 * Returns 1 if the path is an "other" path with respect to
1703 * the index; that is, the path is not mentioned in the index at all,
1704 * either as a file, a directory with some files in the index,
1705 * or as an unmerged entry.
1707 * We helpfully remove a trailing "/" from directories so that
1708 * the output of read_directory can be used as-is.
1710 int index_name_is_other(const struct index_state *istate, const char *name,
1714 if (namelen && name[namelen - 1] == '/')
1716 pos = index_name_pos(istate, name, namelen);
1718 return 0; /* exact match */
1720 if (pos < istate->cache_nr) {
1721 struct cache_entry *ce = istate->cache[pos];
1722 if (ce_namelen(ce) == namelen &&
1723 !memcmp(ce->name, name, namelen))
1724 return 0; /* Yup, this one exists unmerged */