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"
18 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
22 * The first letter should be 'A'..'Z' for extensions that are not
23 * necessary for a correct operation (i.e. optimization data).
24 * When new extensions are added that _needs_ to be understood in
25 * order to correctly interpret the index file, pick character that
26 * is outside the range, to cause the reader to abort.
29 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
30 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
32 struct index_state the_index;
34 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
36 istate->cache[nr] = ce;
37 add_name_hash(istate, ce);
40 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
42 struct cache_entry *old = istate->cache[nr];
44 remove_name_hash(old);
45 set_index_entry(istate, nr, ce);
46 istate->cache_changed = 1;
49 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
51 struct cache_entry *old = istate->cache[nr], *new;
52 int namelen = strlen(new_name);
54 new = xmalloc(cache_entry_size(namelen));
55 copy_cache_entry(new, old);
56 new->ce_flags &= ~(CE_STATE_MASK | CE_NAMEMASK);
57 new->ce_flags |= (namelen >= CE_NAMEMASK ? CE_NAMEMASK : namelen);
58 memcpy(new->name, new_name, namelen + 1);
60 cache_tree_invalidate_path(istate->cache_tree, old->name);
61 remove_index_entry_at(istate, nr);
62 add_index_entry(istate, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
66 * This only updates the "non-critical" parts of the directory
67 * cache, ie the parts that aren't tracked by GIT, and only used
68 * to validate the cache.
70 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
72 ce->ce_ctime.sec = (unsigned int)st->st_ctime;
73 ce->ce_mtime.sec = (unsigned int)st->st_mtime;
74 ce->ce_ctime.nsec = ST_CTIME_NSEC(*st);
75 ce->ce_mtime.nsec = ST_MTIME_NSEC(*st);
76 ce->ce_dev = st->st_dev;
77 ce->ce_ino = st->st_ino;
78 ce->ce_uid = st->st_uid;
79 ce->ce_gid = st->st_gid;
80 ce->ce_size = st->st_size;
83 ce->ce_flags |= CE_VALID;
85 if (S_ISREG(st->st_mode))
89 static int ce_compare_data(struct cache_entry *ce, struct stat *st)
92 int fd = open(ce->name, O_RDONLY);
95 unsigned char sha1[20];
96 if (!index_fd(sha1, fd, st, 0, OBJ_BLOB, ce->name))
97 match = hashcmp(sha1, ce->sha1);
98 /* index_fd() closed the file descriptor already */
103 static int ce_compare_link(struct cache_entry *ce, size_t expected_size)
108 enum object_type type;
109 struct strbuf sb = STRBUF_INIT;
111 if (strbuf_readlink(&sb, ce->name, expected_size))
114 buffer = read_sha1_file(ce->sha1, &type, &size);
117 match = memcmp(buffer, sb.buf, size);
124 static int ce_compare_gitlink(struct cache_entry *ce)
126 unsigned char sha1[20];
129 * We don't actually require that the .git directory
130 * under GITLINK directory be a valid git directory. It
131 * might even be missing (in case nobody populated that
134 * If so, we consider it always to match.
136 if (resolve_gitlink_ref(ce->name, "HEAD", sha1) < 0)
138 return hashcmp(sha1, ce->sha1);
141 static int ce_modified_check_fs(struct cache_entry *ce, struct stat *st)
143 switch (st->st_mode & S_IFMT) {
145 if (ce_compare_data(ce, st))
149 if (ce_compare_link(ce, xsize_t(st->st_size)))
153 if (S_ISGITLINK(ce->ce_mode))
154 return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
161 static int is_empty_blob_sha1(const unsigned char *sha1)
163 static const unsigned char empty_blob_sha1[20] = {
164 0xe6,0x9d,0xe2,0x9b,0xb2,0xd1,0xd6,0x43,0x4b,0x8b,
165 0x29,0xae,0x77,0x5a,0xd8,0xc2,0xe4,0x8c,0x53,0x91
168 return !hashcmp(sha1, empty_blob_sha1);
171 static int ce_match_stat_basic(struct cache_entry *ce, struct stat *st)
173 unsigned int changed = 0;
175 if (ce->ce_flags & CE_REMOVE)
176 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
178 switch (ce->ce_mode & S_IFMT) {
180 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
181 /* We consider only the owner x bit to be relevant for
184 if (trust_executable_bit &&
185 (0100 & (ce->ce_mode ^ st->st_mode)))
186 changed |= MODE_CHANGED;
189 if (!S_ISLNK(st->st_mode) &&
190 (has_symlinks || !S_ISREG(st->st_mode)))
191 changed |= TYPE_CHANGED;
194 /* We ignore most of the st_xxx fields for gitlinks */
195 if (!S_ISDIR(st->st_mode))
196 changed |= TYPE_CHANGED;
197 else if (ce_compare_gitlink(ce))
198 changed |= DATA_CHANGED;
201 die("internal error: ce_mode is %o", ce->ce_mode);
203 if (ce->ce_mtime.sec != (unsigned int)st->st_mtime)
204 changed |= MTIME_CHANGED;
205 if (trust_ctime && ce->ce_ctime.sec != (unsigned int)st->st_ctime)
206 changed |= CTIME_CHANGED;
209 if (ce->ce_mtime.nsec != ST_MTIME_NSEC(*st))
210 changed |= MTIME_CHANGED;
211 if (trust_ctime && ce->ce_ctime.nsec != ST_CTIME_NSEC(*st))
212 changed |= CTIME_CHANGED;
215 if (ce->ce_uid != (unsigned int) st->st_uid ||
216 ce->ce_gid != (unsigned int) st->st_gid)
217 changed |= OWNER_CHANGED;
218 if (ce->ce_ino != (unsigned int) st->st_ino)
219 changed |= INODE_CHANGED;
223 * st_dev breaks on network filesystems where different
224 * clients will have different views of what "device"
225 * the filesystem is on
227 if (ce->ce_dev != (unsigned int) st->st_dev)
228 changed |= INODE_CHANGED;
231 if (ce->ce_size != (unsigned int) st->st_size)
232 changed |= DATA_CHANGED;
234 /* Racily smudged entry? */
236 if (!is_empty_blob_sha1(ce->sha1))
237 changed |= DATA_CHANGED;
243 static int is_racy_timestamp(const struct index_state *istate, struct cache_entry *ce)
245 return (!S_ISGITLINK(ce->ce_mode) &&
246 istate->timestamp.sec &&
248 /* nanosecond timestamped files can also be racy! */
249 (istate->timestamp.sec < ce->ce_mtime.sec ||
250 (istate->timestamp.sec == ce->ce_mtime.sec &&
251 istate->timestamp.nsec <= ce->ce_mtime.nsec))
253 istate->timestamp.sec <= ce->ce_mtime.sec
258 int ie_match_stat(const struct index_state *istate,
259 struct cache_entry *ce, struct stat *st,
260 unsigned int options)
262 unsigned int changed;
263 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
264 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
265 int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
268 * If it's marked as always valid in the index, it's
269 * valid whatever the checked-out copy says.
271 * skip-worktree has the same effect with higher precedence
273 if (!ignore_skip_worktree && ce_skip_worktree(ce))
275 if (!ignore_valid && (ce->ce_flags & CE_VALID))
279 * Intent-to-add entries have not been added, so the index entry
280 * by definition never matches what is in the work tree until it
281 * actually gets added.
283 if (ce->ce_flags & CE_INTENT_TO_ADD)
284 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
286 changed = ce_match_stat_basic(ce, st);
289 * Within 1 second of this sequence:
290 * echo xyzzy >file && git-update-index --add file
291 * running this command:
293 * would give a falsely clean cache entry. The mtime and
294 * length match the cache, and other stat fields do not change.
296 * We could detect this at update-index time (the cache entry
297 * being registered/updated records the same time as "now")
298 * and delay the return from git-update-index, but that would
299 * effectively mean we can make at most one commit per second,
300 * which is not acceptable. Instead, we check cache entries
301 * whose mtime are the same as the index file timestamp more
302 * carefully than others.
304 if (!changed && is_racy_timestamp(istate, ce)) {
305 if (assume_racy_is_modified)
306 changed |= DATA_CHANGED;
308 changed |= ce_modified_check_fs(ce, st);
314 int ie_modified(const struct index_state *istate,
315 struct cache_entry *ce, struct stat *st, unsigned int options)
317 int changed, changed_fs;
319 changed = ie_match_stat(istate, ce, st, options);
323 * If the mode or type has changed, there's no point in trying
324 * to refresh the entry - it's not going to match
326 if (changed & (MODE_CHANGED | TYPE_CHANGED))
330 * Immediately after read-tree or update-index --cacheinfo,
331 * the length field is zero, as we have never even read the
332 * lstat(2) information once, and we cannot trust DATA_CHANGED
333 * returned by ie_match_stat() which in turn was returned by
334 * ce_match_stat_basic() to signal that the filesize of the
335 * blob changed. We have to actually go to the filesystem to
336 * see if the contents match, and if so, should answer "unchanged".
338 * The logic does not apply to gitlinks, as ce_match_stat_basic()
339 * already has checked the actual HEAD from the filesystem in the
340 * subproject. If ie_match_stat() already said it is different,
341 * then we know it is.
343 if ((changed & DATA_CHANGED) &&
344 (S_ISGITLINK(ce->ce_mode) || ce->ce_size != 0))
347 changed_fs = ce_modified_check_fs(ce, st);
349 return changed | changed_fs;
353 int base_name_compare(const char *name1, int len1, int mode1,
354 const char *name2, int len2, int mode2)
356 unsigned char c1, c2;
357 int len = len1 < len2 ? len1 : len2;
360 cmp = memcmp(name1, name2, len);
365 if (!c1 && S_ISDIR(mode1))
367 if (!c2 && S_ISDIR(mode2))
369 return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
373 * df_name_compare() is identical to base_name_compare(), except it
374 * compares conflicting directory/file entries as equal. Note that
375 * while a directory name compares as equal to a regular file, they
376 * then individually compare _differently_ to a filename that has
377 * a dot after the basename (because '\0' < '.' < '/').
379 * This is used by routines that want to traverse the git namespace
380 * but then handle conflicting entries together when possible.
382 int df_name_compare(const char *name1, int len1, int mode1,
383 const char *name2, int len2, int mode2)
385 int len = len1 < len2 ? len1 : len2, cmp;
386 unsigned char c1, c2;
388 cmp = memcmp(name1, name2, len);
391 /* Directories and files compare equal (same length, same name) */
395 if (!c1 && S_ISDIR(mode1))
398 if (!c2 && S_ISDIR(mode2))
400 if (c1 == '/' && !c2)
402 if (c2 == '/' && !c1)
407 int cache_name_compare(const char *name1, int flags1, const char *name2, int flags2)
409 int len1 = flags1 & CE_NAMEMASK;
410 int len2 = flags2 & CE_NAMEMASK;
411 int len = len1 < len2 ? len1 : len2;
414 cmp = memcmp(name1, name2, len);
423 flags1 &= CE_STAGEMASK;
424 flags2 &= CE_STAGEMASK;
433 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
438 last = istate->cache_nr;
439 while (last > first) {
440 int next = (last + first) >> 1;
441 struct cache_entry *ce = istate->cache[next];
442 int cmp = cache_name_compare(name, namelen, ce->name, ce->ce_flags);
454 /* Remove entry, return true if there are more entries to go.. */
455 int remove_index_entry_at(struct index_state *istate, int pos)
457 struct cache_entry *ce = istate->cache[pos];
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 alias = index_name_exists(istate, ce->name, ce_namelen(ce), ignore_case);
612 if (alias && !ce_stage(alias) && !ie_match_stat(istate, alias, st, ce_option)) {
613 /* Nothing changed, really */
615 ce_mark_uptodate(alias);
616 alias->ce_flags |= CE_ADDED;
620 if (index_path(ce->sha1, path, st, 1))
621 return error("unable to index file %s", path);
623 record_intent_to_add(ce);
625 if (ignore_case && alias && different_name(ce, alias))
626 ce = create_alias_ce(ce, alias);
627 ce->ce_flags |= CE_ADDED;
629 /* It was suspected to be racily clean, but it turns out to be Ok */
632 !hashcmp(alias->sha1, ce->sha1) &&
633 ce->ce_mode == alias->ce_mode);
637 else if (add_index_entry(istate, ce, add_option))
638 return error("unable to add %s to index",path);
639 if (verbose && !was_same)
640 printf("add '%s'\n", path);
644 int add_file_to_index(struct index_state *istate, const char *path, int flags)
647 if (lstat(path, &st))
648 die_errno("unable to stat '%s'", path);
649 return add_to_index(istate, path, &st, flags);
652 struct cache_entry *make_cache_entry(unsigned int mode,
653 const unsigned char *sha1, const char *path, int stage,
657 struct cache_entry *ce;
659 if (!verify_path(path)) {
660 error("Invalid path '%s'", path);
665 size = cache_entry_size(len);
666 ce = xcalloc(1, size);
668 hashcpy(ce->sha1, sha1);
669 memcpy(ce->name, path, len);
670 ce->ce_flags = create_ce_flags(len, stage);
671 ce->ce_mode = create_ce_mode(mode);
674 return refresh_cache_entry(ce, 0);
679 int ce_same_name(struct cache_entry *a, struct cache_entry *b)
681 int len = ce_namelen(a);
682 return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
685 int ce_path_match(const struct cache_entry *ce, const char **pathspec)
687 const char *match, *name;
693 len = ce_namelen(ce);
695 while ((match = *pathspec++) != NULL) {
696 int matchlen = strlen(match);
699 if (memcmp(name, match, matchlen))
701 if (matchlen && name[matchlen-1] == '/')
703 if (name[matchlen] == '/' || !name[matchlen])
712 * We fundamentally don't like some paths: we don't want
713 * dot or dot-dot anywhere, and for obvious reasons don't
714 * want to recurse into ".git" either.
716 * Also, we don't want double slashes or slashes at the
717 * end that can make pathnames ambiguous.
719 static int verify_dotfile(const char *rest)
722 * The first character was '.', but that
723 * has already been discarded, we now test
727 /* "." is not allowed */
732 * ".git" followed by NUL or slash is bad. This
733 * shares the path end test with the ".." case.
743 if (rest[1] == '\0' || rest[1] == '/')
749 int verify_path(const char *path)
766 if (verify_dotfile(path))
776 * Do we have another file that has the beginning components being a
777 * proper superset of the name we're trying to add?
779 static int has_file_name(struct index_state *istate,
780 const struct cache_entry *ce, int pos, int ok_to_replace)
783 int len = ce_namelen(ce);
784 int stage = ce_stage(ce);
785 const char *name = ce->name;
787 while (pos < istate->cache_nr) {
788 struct cache_entry *p = istate->cache[pos++];
790 if (len >= ce_namelen(p))
792 if (memcmp(name, p->name, len))
794 if (ce_stage(p) != stage)
796 if (p->name[len] != '/')
798 if (p->ce_flags & CE_REMOVE)
803 remove_index_entry_at(istate, --pos);
809 * Do we have another file with a pathname that is a proper
810 * subset of the name we're trying to add?
812 static int has_dir_name(struct index_state *istate,
813 const struct cache_entry *ce, int pos, int ok_to_replace)
816 int stage = ce_stage(ce);
817 const char *name = ce->name;
818 const char *slash = name + ce_namelen(ce);
826 if (slash <= ce->name)
831 pos = index_name_pos(istate, name, create_ce_flags(len, stage));
834 * Found one, but not so fast. This could
835 * be a marker that says "I was here, but
836 * I am being removed". Such an entry is
837 * not a part of the resulting tree, and
838 * it is Ok to have a directory at the same
841 if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
845 remove_index_entry_at(istate, pos);
853 * Trivial optimization: if we find an entry that
854 * already matches the sub-directory, then we know
855 * we're ok, and we can exit.
857 while (pos < istate->cache_nr) {
858 struct cache_entry *p = istate->cache[pos];
859 if ((ce_namelen(p) <= len) ||
860 (p->name[len] != '/') ||
861 memcmp(p->name, name, len))
862 break; /* not our subdirectory */
863 if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
865 * p is at the same stage as our entry, and
866 * is a subdirectory of what we are looking
867 * at, so we cannot have conflicts at our
868 * level or anything shorter.
877 /* We may be in a situation where we already have path/file and path
878 * is being added, or we already have path and path/file is being
879 * added. Either one would result in a nonsense tree that has path
880 * twice when git-write-tree tries to write it out. Prevent it.
882 * If ok-to-replace is specified, we remove the conflicting entries
883 * from the cache so the caller should recompute the insert position.
884 * When this happens, we return non-zero.
886 static int check_file_directory_conflict(struct index_state *istate,
887 const struct cache_entry *ce,
888 int pos, int ok_to_replace)
893 * When ce is an "I am going away" entry, we allow it to be added
895 if (ce->ce_flags & CE_REMOVE)
899 * We check if the path is a sub-path of a subsequent pathname
900 * first, since removing those will not change the position
903 retval = has_file_name(istate, ce, pos, ok_to_replace);
906 * Then check if the path might have a clashing sub-directory
909 return retval + has_dir_name(istate, ce, pos, ok_to_replace);
912 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
915 int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
916 int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
917 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
918 int new_only = option & ADD_CACHE_NEW_ONLY;
920 cache_tree_invalidate_path(istate->cache_tree, ce->name);
921 pos = index_name_pos(istate, ce->name, ce->ce_flags);
923 /* existing match? Just replace it. */
926 replace_index_entry(istate, pos, ce);
932 * Inserting a merged entry ("stage 0") into the index
933 * will always replace all non-merged entries..
935 if (pos < istate->cache_nr && ce_stage(ce) == 0) {
936 while (ce_same_name(istate->cache[pos], ce)) {
938 if (!remove_index_entry_at(istate, pos))
945 if (!verify_path(ce->name))
946 return error("Invalid path '%s'", ce->name);
948 if (!skip_df_check &&
949 check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
951 return error("'%s' appears as both a file and as a directory",
953 pos = index_name_pos(istate, ce->name, ce->ce_flags);
959 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
963 if (option & ADD_CACHE_JUST_APPEND)
964 pos = istate->cache_nr;
967 ret = add_index_entry_with_check(istate, ce, option);
973 /* Make sure the array is big enough .. */
974 if (istate->cache_nr == istate->cache_alloc) {
975 istate->cache_alloc = alloc_nr(istate->cache_alloc);
976 istate->cache = xrealloc(istate->cache,
977 istate->cache_alloc * sizeof(struct cache_entry *));
982 if (istate->cache_nr > pos + 1)
983 memmove(istate->cache + pos + 1,
985 (istate->cache_nr - pos - 1) * sizeof(ce));
986 set_index_entry(istate, pos, ce);
987 istate->cache_changed = 1;
992 * "refresh" does not calculate a new sha1 file or bring the
993 * cache up-to-date for mode/content changes. But what it
994 * _does_ do is to "re-match" the stat information of a file
995 * with the cache, so that you can refresh the cache for a
996 * file that hasn't been changed but where the stat entry is
999 * For example, you'd want to do this after doing a "git-read-tree",
1000 * to link up the stat cache details with the proper files.
1002 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1003 struct cache_entry *ce,
1004 unsigned int options, int *err)
1007 struct cache_entry *updated;
1009 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1010 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1012 if (ce_uptodate(ce))
1016 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1017 * that the change to the work tree does not matter and told
1020 if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1021 ce_mark_uptodate(ce);
1024 if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1025 ce_mark_uptodate(ce);
1029 if (lstat(ce->name, &st) < 0) {
1035 changed = ie_match_stat(istate, ce, &st, options);
1038 * The path is unchanged. If we were told to ignore
1039 * valid bit, then we did the actual stat check and
1040 * found that the entry is unmodified. If the entry
1041 * is not marked VALID, this is the place to mark it
1042 * valid again, under "assume unchanged" mode.
1044 if (ignore_valid && assume_unchanged &&
1045 !(ce->ce_flags & CE_VALID))
1046 ; /* mark this one VALID again */
1049 * We do not mark the index itself "modified"
1050 * because CE_UPTODATE flag is in-core only;
1051 * we are not going to write this change out.
1053 ce_mark_uptodate(ce);
1058 if (ie_modified(istate, ce, &st, options)) {
1065 updated = xmalloc(size);
1066 memcpy(updated, ce, size);
1067 fill_stat_cache_info(updated, &st);
1069 * If ignore_valid is not set, we should leave CE_VALID bit
1070 * alone. Otherwise, paths marked with --no-assume-unchanged
1071 * (i.e. things to be edited) will reacquire CE_VALID bit
1072 * automatically, which is not really what we want.
1074 if (!ignore_valid && assume_unchanged &&
1075 !(ce->ce_flags & CE_VALID))
1076 updated->ce_flags &= ~CE_VALID;
1081 static void show_file(const char * fmt, const char * name, int in_porcelain,
1082 int * first, char *header_msg)
1084 if (in_porcelain && *first && header_msg) {
1085 printf("%s\n", header_msg);
1091 int refresh_index(struct index_state *istate, unsigned int flags, const char **pathspec,
1092 char *seen, char *header_msg)
1096 int really = (flags & REFRESH_REALLY) != 0;
1097 int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1098 int quiet = (flags & REFRESH_QUIET) != 0;
1099 int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1100 int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1102 int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1103 unsigned int options = really ? CE_MATCH_IGNORE_VALID : 0;
1104 const char *needs_update_fmt;
1105 const char *needs_merge_fmt;
1107 needs_update_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1108 needs_merge_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1109 for (i = 0; i < istate->cache_nr; i++) {
1110 struct cache_entry *ce, *new;
1111 int cache_errno = 0;
1113 ce = istate->cache[i];
1114 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1118 while ((i < istate->cache_nr) &&
1119 ! strcmp(istate->cache[i]->name, ce->name))
1124 show_file(needs_merge_fmt, ce->name, in_porcelain, &first, header_msg);
1129 if (pathspec && !match_pathspec(pathspec, ce->name, strlen(ce->name), 0, seen))
1132 new = refresh_cache_ent(istate, ce, options, &cache_errno);
1136 if (not_new && cache_errno == ENOENT)
1138 if (really && cache_errno == EINVAL) {
1139 /* If we are doing --really-refresh that
1140 * means the index is not valid anymore.
1142 ce->ce_flags &= ~CE_VALID;
1143 istate->cache_changed = 1;
1147 show_file(needs_update_fmt, ce->name, in_porcelain, &first, header_msg);
1152 replace_index_entry(istate, i, new);
1157 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really)
1159 return refresh_cache_ent(&the_index, ce, really, NULL);
1162 static int verify_hdr(struct cache_header *hdr, unsigned long size)
1165 unsigned char sha1[20];
1167 if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1168 return error("bad signature");
1169 if (hdr->hdr_version != htonl(2) && hdr->hdr_version != htonl(3))
1170 return error("bad index version");
1172 git_SHA1_Update(&c, hdr, size - 20);
1173 git_SHA1_Final(sha1, &c);
1174 if (hashcmp(sha1, (unsigned char *)hdr + size - 20))
1175 return error("bad index file sha1 signature");
1179 static int read_index_extension(struct index_state *istate,
1180 const char *ext, void *data, unsigned long sz)
1182 switch (CACHE_EXT(ext)) {
1183 case CACHE_EXT_TREE:
1184 istate->cache_tree = cache_tree_read(data, sz);
1187 if (*ext < 'A' || 'Z' < *ext)
1188 return error("index uses %.4s extension, which we do not understand",
1190 fprintf(stderr, "ignoring %.4s extension\n", ext);
1196 int read_index(struct index_state *istate)
1198 return read_index_from(istate, get_index_file());
1201 static void convert_from_disk(struct ondisk_cache_entry *ondisk, struct cache_entry *ce)
1206 ce->ce_ctime.sec = ntohl(ondisk->ctime.sec);
1207 ce->ce_mtime.sec = ntohl(ondisk->mtime.sec);
1208 ce->ce_ctime.nsec = ntohl(ondisk->ctime.nsec);
1209 ce->ce_mtime.nsec = ntohl(ondisk->mtime.nsec);
1210 ce->ce_dev = ntohl(ondisk->dev);
1211 ce->ce_ino = ntohl(ondisk->ino);
1212 ce->ce_mode = ntohl(ondisk->mode);
1213 ce->ce_uid = ntohl(ondisk->uid);
1214 ce->ce_gid = ntohl(ondisk->gid);
1215 ce->ce_size = ntohl(ondisk->size);
1216 /* On-disk flags are just 16 bits */
1217 ce->ce_flags = ntohs(ondisk->flags);
1219 hashcpy(ce->sha1, ondisk->sha1);
1221 len = ce->ce_flags & CE_NAMEMASK;
1223 if (ce->ce_flags & CE_EXTENDED) {
1224 struct ondisk_cache_entry_extended *ondisk2;
1226 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1227 extended_flags = ntohs(ondisk2->flags2) << 16;
1228 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1229 if (extended_flags & ~CE_EXTENDED_FLAGS)
1230 die("Unknown index entry format %08x", extended_flags);
1231 ce->ce_flags |= extended_flags;
1232 name = ondisk2->name;
1235 name = ondisk->name;
1237 if (len == CE_NAMEMASK)
1240 * NEEDSWORK: If the original index is crafted, this copy could
1243 memcpy(ce->name, name, len + 1);
1246 static inline size_t estimate_cache_size(size_t ondisk_size, unsigned int entries)
1250 per_entry = sizeof(struct cache_entry) - sizeof(struct ondisk_cache_entry);
1253 * Alignment can cause differences. This should be "alignof", but
1254 * since that's a gcc'ism, just use the size of a pointer.
1256 per_entry += sizeof(void *);
1257 return ondisk_size + entries*per_entry;
1260 /* remember to discard_cache() before reading a different cache! */
1261 int read_index_from(struct index_state *istate, const char *path)
1265 unsigned long src_offset, dst_offset;
1266 struct cache_header *hdr;
1271 if (istate->initialized)
1272 return istate->cache_nr;
1275 istate->timestamp.sec = 0;
1276 istate->timestamp.nsec = 0;
1277 fd = open(path, O_RDONLY);
1279 if (errno == ENOENT)
1281 die_errno("index file open failed");
1285 die_errno("cannot stat the open index");
1288 mmap_size = xsize_t(st.st_size);
1289 if (mmap_size < sizeof(struct cache_header) + 20)
1290 die("index file smaller than expected");
1292 mmap = xmmap(NULL, mmap_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0);
1294 if (mmap == MAP_FAILED)
1295 die_errno("unable to map index file");
1298 if (verify_hdr(hdr, mmap_size) < 0)
1301 istate->cache_nr = ntohl(hdr->hdr_entries);
1302 istate->cache_alloc = alloc_nr(istate->cache_nr);
1303 istate->cache = xcalloc(istate->cache_alloc, sizeof(struct cache_entry *));
1306 * The disk format is actually larger than the in-memory format,
1307 * due to space for nsec etc, so even though the in-memory one
1308 * has room for a few more flags, we can allocate using the same
1311 istate->alloc = xmalloc(estimate_cache_size(mmap_size, istate->cache_nr));
1312 istate->initialized = 1;
1314 src_offset = sizeof(*hdr);
1316 for (i = 0; i < istate->cache_nr; i++) {
1317 struct ondisk_cache_entry *disk_ce;
1318 struct cache_entry *ce;
1320 disk_ce = (struct ondisk_cache_entry *)((char *)mmap + src_offset);
1321 ce = (struct cache_entry *)((char *)istate->alloc + dst_offset);
1322 convert_from_disk(disk_ce, ce);
1323 set_index_entry(istate, i, ce);
1325 src_offset += ondisk_ce_size(ce);
1326 dst_offset += ce_size(ce);
1328 istate->timestamp.sec = st.st_mtime;
1329 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1331 while (src_offset <= mmap_size - 20 - 8) {
1332 /* After an array of active_nr index entries,
1333 * there can be arbitrary number of extended
1334 * sections, each of which is prefixed with
1335 * extension name (4-byte) and section length
1336 * in 4-byte network byte order.
1339 memcpy(&extsize, (char *)mmap + src_offset + 4, 4);
1340 extsize = ntohl(extsize);
1341 if (read_index_extension(istate,
1342 (const char *) mmap + src_offset,
1343 (char *) mmap + src_offset + 8,
1347 src_offset += extsize;
1349 munmap(mmap, mmap_size);
1350 return istate->cache_nr;
1353 munmap(mmap, mmap_size);
1355 die("index file corrupt");
1358 int is_index_unborn(struct index_state *istate)
1360 return (!istate->cache_nr && !istate->alloc && !istate->timestamp.sec);
1363 int discard_index(struct index_state *istate)
1365 istate->cache_nr = 0;
1366 istate->cache_changed = 0;
1367 istate->timestamp.sec = 0;
1368 istate->timestamp.nsec = 0;
1369 istate->name_hash_initialized = 0;
1370 free_hash(&istate->name_hash);
1371 cache_tree_free(&(istate->cache_tree));
1372 free(istate->alloc);
1373 istate->alloc = NULL;
1374 istate->initialized = 0;
1376 /* no need to throw away allocated active_cache */
1380 int unmerged_index(const struct index_state *istate)
1383 for (i = 0; i < istate->cache_nr; i++) {
1384 if (ce_stage(istate->cache[i]))
1390 #define WRITE_BUFFER_SIZE 8192
1391 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
1392 static unsigned long write_buffer_len;
1394 static int ce_write_flush(git_SHA_CTX *context, int fd)
1396 unsigned int buffered = write_buffer_len;
1398 git_SHA1_Update(context, write_buffer, buffered);
1399 if (write_in_full(fd, write_buffer, buffered) != buffered)
1401 write_buffer_len = 0;
1406 static int ce_write(git_SHA_CTX *context, int fd, void *data, unsigned int len)
1409 unsigned int buffered = write_buffer_len;
1410 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
1413 memcpy(write_buffer + buffered, data, partial);
1414 buffered += partial;
1415 if (buffered == WRITE_BUFFER_SIZE) {
1416 write_buffer_len = buffered;
1417 if (ce_write_flush(context, fd))
1421 write_buffer_len = buffered;
1423 data = (char *) data + partial;
1428 static int write_index_ext_header(git_SHA_CTX *context, int fd,
1429 unsigned int ext, unsigned int sz)
1433 return ((ce_write(context, fd, &ext, 4) < 0) ||
1434 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
1437 static int ce_flush(git_SHA_CTX *context, int fd)
1439 unsigned int left = write_buffer_len;
1442 write_buffer_len = 0;
1443 git_SHA1_Update(context, write_buffer, left);
1446 /* Flush first if not enough space for SHA1 signature */
1447 if (left + 20 > WRITE_BUFFER_SIZE) {
1448 if (write_in_full(fd, write_buffer, left) != left)
1453 /* Append the SHA1 signature at the end */
1454 git_SHA1_Final(write_buffer + left, context);
1456 return (write_in_full(fd, write_buffer, left) != left) ? -1 : 0;
1459 static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
1462 * The only thing we care about in this function is to smudge the
1463 * falsely clean entry due to touch-update-touch race, so we leave
1464 * everything else as they are. We are called for entries whose
1465 * ce_mtime match the index file mtime.
1467 * Note that this actually does not do much for gitlinks, for
1468 * which ce_match_stat_basic() always goes to the actual
1469 * contents. The caller checks with is_racy_timestamp() which
1470 * always says "no" for gitlinks, so we are not called for them ;-)
1474 if (lstat(ce->name, &st) < 0)
1476 if (ce_match_stat_basic(ce, &st))
1478 if (ce_modified_check_fs(ce, &st)) {
1479 /* This is "racily clean"; smudge it. Note that this
1480 * is a tricky code. At first glance, it may appear
1481 * that it can break with this sequence:
1483 * $ echo xyzzy >frotz
1484 * $ git-update-index --add frotz
1487 * $ echo filfre >nitfol
1488 * $ git-update-index --add nitfol
1490 * but it does not. When the second update-index runs,
1491 * it notices that the entry "frotz" has the same timestamp
1492 * as index, and if we were to smudge it by resetting its
1493 * size to zero here, then the object name recorded
1494 * in index is the 6-byte file but the cached stat information
1495 * becomes zero --- which would then match what we would
1496 * obtain from the filesystem next time we stat("frotz").
1498 * However, the second update-index, before calling
1499 * this function, notices that the cached size is 6
1500 * bytes and what is on the filesystem is an empty
1501 * file, and never calls us, so the cached size information
1502 * for "frotz" stays 6 which does not match the filesystem.
1508 static int ce_write_entry(git_SHA_CTX *c, int fd, struct cache_entry *ce)
1510 int size = ondisk_ce_size(ce);
1511 struct ondisk_cache_entry *ondisk = xcalloc(1, size);
1514 ondisk->ctime.sec = htonl(ce->ce_ctime.sec);
1515 ondisk->mtime.sec = htonl(ce->ce_mtime.sec);
1516 ondisk->ctime.nsec = htonl(ce->ce_ctime.nsec);
1517 ondisk->mtime.nsec = htonl(ce->ce_mtime.nsec);
1518 ondisk->dev = htonl(ce->ce_dev);
1519 ondisk->ino = htonl(ce->ce_ino);
1520 ondisk->mode = htonl(ce->ce_mode);
1521 ondisk->uid = htonl(ce->ce_uid);
1522 ondisk->gid = htonl(ce->ce_gid);
1523 ondisk->size = htonl(ce->ce_size);
1524 hashcpy(ondisk->sha1, ce->sha1);
1525 ondisk->flags = htons(ce->ce_flags);
1526 if (ce->ce_flags & CE_EXTENDED) {
1527 struct ondisk_cache_entry_extended *ondisk2;
1528 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1529 ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
1530 name = ondisk2->name;
1533 name = ondisk->name;
1534 memcpy(name, ce->name, ce_namelen(ce));
1536 return ce_write(c, fd, ondisk, size);
1539 int write_index(struct index_state *istate, int newfd)
1542 struct cache_header hdr;
1543 int i, err, removed, extended;
1544 struct cache_entry **cache = istate->cache;
1545 int entries = istate->cache_nr;
1548 for (i = removed = extended = 0; i < entries; i++) {
1549 if (cache[i]->ce_flags & CE_REMOVE)
1552 /* reduce extended entries if possible */
1553 cache[i]->ce_flags &= ~CE_EXTENDED;
1554 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
1556 cache[i]->ce_flags |= CE_EXTENDED;
1560 hdr.hdr_signature = htonl(CACHE_SIGNATURE);
1561 /* for extended format, increase version so older git won't try to read it */
1562 hdr.hdr_version = htonl(extended ? 3 : 2);
1563 hdr.hdr_entries = htonl(entries - removed);
1566 if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
1569 for (i = 0; i < entries; i++) {
1570 struct cache_entry *ce = cache[i];
1571 if (ce->ce_flags & CE_REMOVE)
1573 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
1574 ce_smudge_racily_clean_entry(ce);
1575 if (ce_write_entry(&c, newfd, ce) < 0)
1579 /* Write extension data here */
1580 if (istate->cache_tree) {
1581 struct strbuf sb = STRBUF_INIT;
1583 cache_tree_write(&sb, istate->cache_tree);
1584 err = write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sb.len) < 0
1585 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
1586 strbuf_release(&sb);
1591 if (ce_flush(&c, newfd) || fstat(newfd, &st))
1593 istate->timestamp.sec = (unsigned int)st.st_mtime;
1594 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1599 * Read the index file that is potentially unmerged into given
1600 * index_state, dropping any unmerged entries. Returns true if
1601 * the index is unmerged. Callers who want to refuse to work
1602 * from an unmerged state can call this and check its return value,
1603 * instead of calling read_cache().
1605 int read_index_unmerged(struct index_state *istate)
1611 for (i = 0; i < istate->cache_nr; i++) {
1612 struct cache_entry *ce = istate->cache[i];
1613 struct cache_entry *new_ce;
1619 len = strlen(ce->name);
1620 size = cache_entry_size(len);
1621 new_ce = xcalloc(1, size);
1622 memcpy(new_ce->name, ce->name, len);
1623 new_ce->ce_flags = create_ce_flags(len, 0) | CE_CONFLICTED;
1624 new_ce->ce_mode = ce->ce_mode;
1625 if (add_index_entry(istate, new_ce, 0))
1626 return error("%s: cannot drop to stage #0",
1628 i = index_name_pos(istate, new_ce->name, len);
1633 struct update_callback_data
1639 static void update_callback(struct diff_queue_struct *q,
1640 struct diff_options *opt, void *cbdata)
1643 struct update_callback_data *data = cbdata;
1645 for (i = 0; i < q->nr; i++) {
1646 struct diff_filepair *p = q->queue[i];
1647 const char *path = p->one->path;
1648 switch (p->status) {
1650 die("unexpected diff status %c", p->status);
1651 case DIFF_STATUS_UNMERGED:
1653 * ADD_CACHE_IGNORE_REMOVAL is unset if "git
1654 * add -u" is calling us, In such a case, a
1655 * missing work tree file needs to be removed
1656 * if there is an unmerged entry at stage #2,
1657 * but such a diff record is followed by
1658 * another with DIFF_STATUS_DELETED (and if
1659 * there is no stage #2, we won't see DELETED
1660 * nor MODIFIED). We can simply continue
1663 if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL))
1666 * Otherwise, it is "git add path" is asking
1667 * to explicitly add it; we fall through. A
1668 * missing work tree file is an error and is
1669 * caught by add_file_to_index() in such a
1672 case DIFF_STATUS_MODIFIED:
1673 case DIFF_STATUS_TYPE_CHANGED:
1674 if (add_file_to_index(&the_index, path, data->flags)) {
1675 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
1676 die("updating files failed");
1680 case DIFF_STATUS_DELETED:
1681 if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
1683 if (!(data->flags & ADD_CACHE_PRETEND))
1684 remove_file_from_index(&the_index, path);
1685 if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
1686 printf("remove '%s'\n", path);
1692 int add_files_to_cache(const char *prefix, const char **pathspec, int flags)
1694 struct update_callback_data data;
1695 struct rev_info rev;
1696 init_revisions(&rev, prefix);
1697 setup_revisions(0, NULL, &rev, NULL);
1698 rev.prune_data = pathspec;
1699 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1700 rev.diffopt.format_callback = update_callback;
1702 data.add_errors = 0;
1703 rev.diffopt.format_callback_data = &data;
1704 run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
1705 return !!data.add_errors;
1709 * Returns 1 if the path is an "other" path with respect to
1710 * the index; that is, the path is not mentioned in the index at all,
1711 * either as a file, a directory with some files in the index,
1712 * or as an unmerged entry.
1714 * We helpfully remove a trailing "/" from directories so that
1715 * the output of read_directory can be used as-is.
1717 int index_name_is_other(const struct index_state *istate, const char *name,
1721 if (namelen && name[namelen - 1] == '/')
1723 pos = index_name_pos(istate, name, namelen);
1725 return 0; /* exact match */
1727 if (pos < istate->cache_nr) {
1728 struct cache_entry *ce = istate->cache[pos];
1729 if (ce_namelen(ce) == namelen &&
1730 !memcmp(ce->name, name, namelen))
1731 return 0; /* Yup, this one exists unmerged */