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"
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" */
30 struct index_state the_index;
32 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
34 istate->cache[nr] = ce;
35 add_name_hash(istate, ce);
38 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
40 struct cache_entry *old = istate->cache[nr];
42 remove_name_hash(old);
43 set_index_entry(istate, nr, ce);
44 istate->cache_changed = 1;
47 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
49 struct cache_entry *old = istate->cache[nr], *new;
50 int namelen = strlen(new_name);
52 new = xmalloc(cache_entry_size(namelen));
53 copy_cache_entry(new, old);
54 new->ce_flags &= ~(CE_STATE_MASK | CE_NAMEMASK);
55 new->ce_flags |= (namelen >= CE_NAMEMASK ? CE_NAMEMASK : namelen);
56 memcpy(new->name, new_name, namelen + 1);
58 cache_tree_invalidate_path(istate->cache_tree, old->name);
59 remove_index_entry_at(istate, nr);
60 add_index_entry(istate, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
64 * This only updates the "non-critical" parts of the directory
65 * cache, ie the parts that aren't tracked by GIT, and only used
66 * to validate the cache.
68 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
70 ce->ce_ctime.sec = (unsigned int)st->st_ctime;
71 ce->ce_mtime.sec = (unsigned int)st->st_mtime;
72 ce->ce_ctime.nsec = ST_CTIME_NSEC(*st);
73 ce->ce_mtime.nsec = ST_MTIME_NSEC(*st);
74 ce->ce_dev = st->st_dev;
75 ce->ce_ino = st->st_ino;
76 ce->ce_uid = st->st_uid;
77 ce->ce_gid = st->st_gid;
78 ce->ce_size = st->st_size;
81 ce->ce_flags |= CE_VALID;
83 if (S_ISREG(st->st_mode))
87 static int ce_compare_data(struct cache_entry *ce, struct stat *st)
90 int fd = open(ce->name, O_RDONLY);
93 unsigned char sha1[20];
94 if (!index_fd(sha1, fd, st, 0, OBJ_BLOB, ce->name))
95 match = hashcmp(sha1, ce->sha1);
96 /* index_fd() closed the file descriptor already */
101 static int ce_compare_link(struct cache_entry *ce, size_t expected_size)
106 enum object_type type;
107 struct strbuf sb = STRBUF_INIT;
109 if (strbuf_readlink(&sb, ce->name, expected_size))
112 buffer = read_sha1_file(ce->sha1, &type, &size);
115 match = memcmp(buffer, sb.buf, size);
122 static int ce_compare_gitlink(struct cache_entry *ce)
124 unsigned char sha1[20];
127 * We don't actually require that the .git directory
128 * under GITLINK directory be a valid git directory. It
129 * might even be missing (in case nobody populated that
132 * If so, we consider it always to match.
134 if (resolve_gitlink_ref(ce->name, "HEAD", sha1) < 0)
136 return hashcmp(sha1, ce->sha1);
139 static int ce_modified_check_fs(struct cache_entry *ce, struct stat *st)
141 switch (st->st_mode & S_IFMT) {
143 if (ce_compare_data(ce, st))
147 if (ce_compare_link(ce, xsize_t(st->st_size)))
151 if (S_ISGITLINK(ce->ce_mode))
152 return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
159 int is_empty_blob_sha1(const unsigned char *sha1)
161 static const unsigned char empty_blob_sha1[20] = {
162 0xe6,0x9d,0xe2,0x9b,0xb2,0xd1,0xd6,0x43,0x4b,0x8b,
163 0x29,0xae,0x77,0x5a,0xd8,0xc2,0xe4,0x8c,0x53,0x91
166 return !hashcmp(sha1, empty_blob_sha1);
169 static int ce_match_stat_basic(struct cache_entry *ce, struct stat *st)
171 unsigned int changed = 0;
173 if (ce->ce_flags & CE_REMOVE)
174 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
176 switch (ce->ce_mode & S_IFMT) {
178 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
179 /* We consider only the owner x bit to be relevant for
182 if (trust_executable_bit &&
183 (0100 & (ce->ce_mode ^ st->st_mode)))
184 changed |= MODE_CHANGED;
187 if (!S_ISLNK(st->st_mode) &&
188 (has_symlinks || !S_ISREG(st->st_mode)))
189 changed |= TYPE_CHANGED;
192 /* We ignore most of the st_xxx fields for gitlinks */
193 if (!S_ISDIR(st->st_mode))
194 changed |= TYPE_CHANGED;
195 else if (ce_compare_gitlink(ce))
196 changed |= DATA_CHANGED;
199 die("internal error: ce_mode is %o", ce->ce_mode);
201 if (ce->ce_mtime.sec != (unsigned int)st->st_mtime)
202 changed |= MTIME_CHANGED;
203 if (trust_ctime && ce->ce_ctime.sec != (unsigned int)st->st_ctime)
204 changed |= CTIME_CHANGED;
207 if (ce->ce_mtime.nsec != ST_MTIME_NSEC(*st))
208 changed |= MTIME_CHANGED;
209 if (trust_ctime && ce->ce_ctime.nsec != ST_CTIME_NSEC(*st))
210 changed |= CTIME_CHANGED;
213 if (ce->ce_uid != (unsigned int) st->st_uid ||
214 ce->ce_gid != (unsigned int) st->st_gid)
215 changed |= OWNER_CHANGED;
216 if (ce->ce_ino != (unsigned int) st->st_ino)
217 changed |= INODE_CHANGED;
221 * st_dev breaks on network filesystems where different
222 * clients will have different views of what "device"
223 * the filesystem is on
225 if (ce->ce_dev != (unsigned int) st->st_dev)
226 changed |= INODE_CHANGED;
229 if (ce->ce_size != (unsigned int) st->st_size)
230 changed |= DATA_CHANGED;
232 /* Racily smudged entry? */
234 if (!is_empty_blob_sha1(ce->sha1))
235 changed |= DATA_CHANGED;
241 static int is_racy_timestamp(const struct index_state *istate, struct cache_entry *ce)
243 return (!S_ISGITLINK(ce->ce_mode) &&
244 istate->timestamp.sec &&
246 /* nanosecond timestamped files can also be racy! */
247 (istate->timestamp.sec < ce->ce_mtime.sec ||
248 (istate->timestamp.sec == ce->ce_mtime.sec &&
249 istate->timestamp.nsec <= ce->ce_mtime.nsec))
251 istate->timestamp.sec <= ce->ce_mtime.sec
256 int ie_match_stat(const struct index_state *istate,
257 struct cache_entry *ce, struct stat *st,
258 unsigned int options)
260 unsigned int changed;
261 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
262 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
263 int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
266 * If it's marked as always valid in the index, it's
267 * valid whatever the checked-out copy says.
269 * skip-worktree has the same effect with higher precedence
271 if (!ignore_skip_worktree && ce_skip_worktree(ce))
273 if (!ignore_valid && (ce->ce_flags & CE_VALID))
277 * Intent-to-add entries have not been added, so the index entry
278 * by definition never matches what is in the work tree until it
279 * actually gets added.
281 if (ce->ce_flags & CE_INTENT_TO_ADD)
282 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
284 changed = ce_match_stat_basic(ce, st);
287 * Within 1 second of this sequence:
288 * echo xyzzy >file && git-update-index --add file
289 * running this command:
291 * would give a falsely clean cache entry. The mtime and
292 * length match the cache, and other stat fields do not change.
294 * We could detect this at update-index time (the cache entry
295 * being registered/updated records the same time as "now")
296 * and delay the return from git-update-index, but that would
297 * effectively mean we can make at most one commit per second,
298 * which is not acceptable. Instead, we check cache entries
299 * whose mtime are the same as the index file timestamp more
300 * carefully than others.
302 if (!changed && is_racy_timestamp(istate, ce)) {
303 if (assume_racy_is_modified)
304 changed |= DATA_CHANGED;
306 changed |= ce_modified_check_fs(ce, st);
312 int ie_modified(const struct index_state *istate,
313 struct cache_entry *ce, struct stat *st, unsigned int options)
315 int changed, changed_fs;
317 changed = ie_match_stat(istate, ce, st, options);
321 * If the mode or type has changed, there's no point in trying
322 * to refresh the entry - it's not going to match
324 if (changed & (MODE_CHANGED | TYPE_CHANGED))
328 * Immediately after read-tree or update-index --cacheinfo,
329 * the length field is zero, as we have never even read the
330 * lstat(2) information once, and we cannot trust DATA_CHANGED
331 * returned by ie_match_stat() which in turn was returned by
332 * ce_match_stat_basic() to signal that the filesize of the
333 * blob changed. We have to actually go to the filesystem to
334 * see if the contents match, and if so, should answer "unchanged".
336 * The logic does not apply to gitlinks, as ce_match_stat_basic()
337 * already has checked the actual HEAD from the filesystem in the
338 * subproject. If ie_match_stat() already said it is different,
339 * then we know it is.
341 if ((changed & DATA_CHANGED) &&
342 (S_ISGITLINK(ce->ce_mode) || ce->ce_size != 0))
345 changed_fs = ce_modified_check_fs(ce, st);
347 return changed | changed_fs;
351 int base_name_compare(const char *name1, int len1, int mode1,
352 const char *name2, int len2, int mode2)
354 unsigned char c1, c2;
355 int len = len1 < len2 ? len1 : len2;
358 cmp = memcmp(name1, name2, len);
363 if (!c1 && S_ISDIR(mode1))
365 if (!c2 && S_ISDIR(mode2))
367 return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
371 * df_name_compare() is identical to base_name_compare(), except it
372 * compares conflicting directory/file entries as equal. Note that
373 * while a directory name compares as equal to a regular file, they
374 * then individually compare _differently_ to a filename that has
375 * a dot after the basename (because '\0' < '.' < '/').
377 * This is used by routines that want to traverse the git namespace
378 * but then handle conflicting entries together when possible.
380 int df_name_compare(const char *name1, int len1, int mode1,
381 const char *name2, int len2, int mode2)
383 int len = len1 < len2 ? len1 : len2, cmp;
384 unsigned char c1, c2;
386 cmp = memcmp(name1, name2, len);
389 /* Directories and files compare equal (same length, same name) */
393 if (!c1 && S_ISDIR(mode1))
396 if (!c2 && S_ISDIR(mode2))
398 if (c1 == '/' && !c2)
400 if (c2 == '/' && !c1)
405 int cache_name_compare(const char *name1, int flags1, const char *name2, int flags2)
407 int len1 = flags1 & CE_NAMEMASK;
408 int len2 = flags2 & CE_NAMEMASK;
409 int len = len1 < len2 ? len1 : len2;
412 cmp = memcmp(name1, name2, len);
421 flags1 &= CE_STAGEMASK;
422 flags2 &= CE_STAGEMASK;
431 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
436 last = istate->cache_nr;
437 while (last > first) {
438 int next = (last + first) >> 1;
439 struct cache_entry *ce = istate->cache[next];
440 int cmp = cache_name_compare(name, namelen, ce->name, ce->ce_flags);
452 /* Remove entry, return true if there are more entries to go.. */
453 int remove_index_entry_at(struct index_state *istate, int pos)
455 struct cache_entry *ce = istate->cache[pos];
457 remove_name_hash(ce);
458 istate->cache_changed = 1;
460 if (pos >= istate->cache_nr)
462 memmove(istate->cache + pos,
463 istate->cache + pos + 1,
464 (istate->cache_nr - pos) * sizeof(struct cache_entry *));
469 * Remove all cache ententries marked for removal, that is where
470 * CE_REMOVE is set in ce_flags. This is much more effective than
471 * calling remove_index_entry_at() for each entry to be removed.
473 void remove_marked_cache_entries(struct index_state *istate)
475 struct cache_entry **ce_array = istate->cache;
478 for (i = j = 0; i < istate->cache_nr; i++) {
479 if (ce_array[i]->ce_flags & CE_REMOVE)
480 remove_name_hash(ce_array[i]);
482 ce_array[j++] = ce_array[i];
484 istate->cache_changed = 1;
485 istate->cache_nr = j;
488 int remove_file_from_index(struct index_state *istate, const char *path)
490 int pos = index_name_pos(istate, path, strlen(path));
493 cache_tree_invalidate_path(istate->cache_tree, path);
494 while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
495 remove_index_entry_at(istate, pos);
499 static int compare_name(struct cache_entry *ce, const char *path, int namelen)
501 return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
504 static int index_name_pos_also_unmerged(struct index_state *istate,
505 const char *path, int namelen)
507 int pos = index_name_pos(istate, path, namelen);
508 struct cache_entry *ce;
513 /* maybe unmerged? */
515 if (pos >= istate->cache_nr ||
516 compare_name((ce = istate->cache[pos]), path, namelen))
519 /* order of preference: stage 2, 1, 3 */
520 if (ce_stage(ce) == 1 && pos + 1 < istate->cache_nr &&
521 ce_stage((ce = istate->cache[pos + 1])) == 2 &&
522 !compare_name(ce, path, namelen))
527 static int different_name(struct cache_entry *ce, struct cache_entry *alias)
529 int len = ce_namelen(ce);
530 return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
534 * If we add a filename that aliases in the cache, we will use the
535 * name that we already have - but we don't want to update the same
536 * alias twice, because that implies that there were actually two
537 * different files with aliasing names!
539 * So we use the CE_ADDED flag to verify that the alias was an old
540 * one before we accept it as
542 static struct cache_entry *create_alias_ce(struct cache_entry *ce, struct cache_entry *alias)
545 struct cache_entry *new;
547 if (alias->ce_flags & CE_ADDED)
548 die("Will not add file alias '%s' ('%s' already exists in index)", ce->name, alias->name);
550 /* Ok, create the new entry using the name of the existing alias */
551 len = ce_namelen(alias);
552 new = xcalloc(1, cache_entry_size(len));
553 memcpy(new->name, alias->name, len);
554 copy_cache_entry(new, ce);
559 static void record_intent_to_add(struct cache_entry *ce)
561 unsigned char sha1[20];
562 if (write_sha1_file("", 0, blob_type, sha1))
563 die("cannot create an empty blob in the object database");
564 hashcpy(ce->sha1, sha1);
567 int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
569 int size, namelen, was_same;
570 mode_t st_mode = st->st_mode;
571 struct cache_entry *ce, *alias;
572 unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
573 int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
574 int pretend = flags & ADD_CACHE_PRETEND;
575 int intent_only = flags & ADD_CACHE_INTENT;
576 int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
577 (intent_only ? ADD_CACHE_NEW_ONLY : 0));
579 if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
580 return error("%s: can only add regular files, symbolic links or git-directories", path);
582 namelen = strlen(path);
583 if (S_ISDIR(st_mode)) {
584 while (namelen && path[namelen-1] == '/')
587 size = cache_entry_size(namelen);
588 ce = xcalloc(1, size);
589 memcpy(ce->name, path, namelen);
590 ce->ce_flags = namelen;
592 fill_stat_cache_info(ce, st);
594 ce->ce_flags |= CE_INTENT_TO_ADD;
596 if (trust_executable_bit && has_symlinks)
597 ce->ce_mode = create_ce_mode(st_mode);
599 /* If there is an existing entry, pick the mode bits and type
600 * from it, otherwise assume unexecutable regular file.
602 struct cache_entry *ent;
603 int pos = index_name_pos_also_unmerged(istate, path, namelen);
605 ent = (0 <= pos) ? istate->cache[pos] : NULL;
606 ce->ce_mode = ce_mode_from_stat(ent, st_mode);
609 alias = index_name_exists(istate, ce->name, ce_namelen(ce), ignore_case);
610 if (alias && !ce_stage(alias) && !ie_match_stat(istate, alias, st, ce_option)) {
611 /* Nothing changed, really */
613 ce_mark_uptodate(alias);
614 alias->ce_flags |= CE_ADDED;
618 if (index_path(ce->sha1, path, st, 1))
619 return error("unable to index file %s", path);
621 record_intent_to_add(ce);
623 if (ignore_case && alias && different_name(ce, alias))
624 ce = create_alias_ce(ce, alias);
625 ce->ce_flags |= CE_ADDED;
627 /* It was suspected to be racily clean, but it turns out to be Ok */
630 !hashcmp(alias->sha1, ce->sha1) &&
631 ce->ce_mode == alias->ce_mode);
635 else if (add_index_entry(istate, ce, add_option))
636 return error("unable to add %s to index",path);
637 if (verbose && !was_same)
638 printf("add '%s'\n", path);
642 int add_file_to_index(struct index_state *istate, const char *path, int flags)
645 if (lstat(path, &st))
646 die_errno("unable to stat '%s'", path);
647 return add_to_index(istate, path, &st, flags);
650 struct cache_entry *make_cache_entry(unsigned int mode,
651 const unsigned char *sha1, const char *path, int stage,
655 struct cache_entry *ce;
657 if (!verify_path(path)) {
658 error("Invalid path '%s'", path);
663 size = cache_entry_size(len);
664 ce = xcalloc(1, size);
666 hashcpy(ce->sha1, sha1);
667 memcpy(ce->name, path, len);
668 ce->ce_flags = create_ce_flags(len, stage);
669 ce->ce_mode = create_ce_mode(mode);
672 return refresh_cache_entry(ce, 0);
677 int ce_same_name(struct cache_entry *a, struct cache_entry *b)
679 int len = ce_namelen(a);
680 return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
683 int ce_path_match(const struct cache_entry *ce, const char **pathspec)
685 const char *match, *name;
691 len = ce_namelen(ce);
693 while ((match = *pathspec++) != NULL) {
694 int matchlen = strlen(match);
697 if (memcmp(name, match, matchlen))
699 if (matchlen && name[matchlen-1] == '/')
701 if (name[matchlen] == '/' || !name[matchlen])
710 * We fundamentally don't like some paths: we don't want
711 * dot or dot-dot anywhere, and for obvious reasons don't
712 * want to recurse into ".git" either.
714 * Also, we don't want double slashes or slashes at the
715 * end that can make pathnames ambiguous.
717 static int verify_dotfile(const char *rest)
720 * The first character was '.', but that
721 * has already been discarded, we now test
725 /* "." is not allowed */
730 * ".git" followed by NUL or slash is bad. This
731 * shares the path end test with the ".." case.
741 if (rest[1] == '\0' || rest[1] == '/')
747 int verify_path(const char *path)
764 if (verify_dotfile(path))
774 * Do we have another file that has the beginning components being a
775 * proper superset of the name we're trying to add?
777 static int has_file_name(struct index_state *istate,
778 const struct cache_entry *ce, int pos, int ok_to_replace)
781 int len = ce_namelen(ce);
782 int stage = ce_stage(ce);
783 const char *name = ce->name;
785 while (pos < istate->cache_nr) {
786 struct cache_entry *p = istate->cache[pos++];
788 if (len >= ce_namelen(p))
790 if (memcmp(name, p->name, len))
792 if (ce_stage(p) != stage)
794 if (p->name[len] != '/')
796 if (p->ce_flags & CE_REMOVE)
801 remove_index_entry_at(istate, --pos);
807 * Do we have another file with a pathname that is a proper
808 * subset of the name we're trying to add?
810 static int has_dir_name(struct index_state *istate,
811 const struct cache_entry *ce, int pos, int ok_to_replace)
814 int stage = ce_stage(ce);
815 const char *name = ce->name;
816 const char *slash = name + ce_namelen(ce);
824 if (slash <= ce->name)
829 pos = index_name_pos(istate, name, create_ce_flags(len, stage));
832 * Found one, but not so fast. This could
833 * be a marker that says "I was here, but
834 * I am being removed". Such an entry is
835 * not a part of the resulting tree, and
836 * it is Ok to have a directory at the same
839 if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
843 remove_index_entry_at(istate, pos);
851 * Trivial optimization: if we find an entry that
852 * already matches the sub-directory, then we know
853 * we're ok, and we can exit.
855 while (pos < istate->cache_nr) {
856 struct cache_entry *p = istate->cache[pos];
857 if ((ce_namelen(p) <= len) ||
858 (p->name[len] != '/') ||
859 memcmp(p->name, name, len))
860 break; /* not our subdirectory */
861 if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
863 * p is at the same stage as our entry, and
864 * is a subdirectory of what we are looking
865 * at, so we cannot have conflicts at our
866 * level or anything shorter.
875 /* We may be in a situation where we already have path/file and path
876 * is being added, or we already have path and path/file is being
877 * added. Either one would result in a nonsense tree that has path
878 * twice when git-write-tree tries to write it out. Prevent it.
880 * If ok-to-replace is specified, we remove the conflicting entries
881 * from the cache so the caller should recompute the insert position.
882 * When this happens, we return non-zero.
884 static int check_file_directory_conflict(struct index_state *istate,
885 const struct cache_entry *ce,
886 int pos, int ok_to_replace)
891 * When ce is an "I am going away" entry, we allow it to be added
893 if (ce->ce_flags & CE_REMOVE)
897 * We check if the path is a sub-path of a subsequent pathname
898 * first, since removing those will not change the position
901 retval = has_file_name(istate, ce, pos, ok_to_replace);
904 * Then check if the path might have a clashing sub-directory
907 return retval + has_dir_name(istate, ce, pos, ok_to_replace);
910 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
913 int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
914 int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
915 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
916 int new_only = option & ADD_CACHE_NEW_ONLY;
918 cache_tree_invalidate_path(istate->cache_tree, ce->name);
919 pos = index_name_pos(istate, ce->name, ce->ce_flags);
921 /* existing match? Just replace it. */
924 replace_index_entry(istate, pos, ce);
930 * Inserting a merged entry ("stage 0") into the index
931 * will always replace all non-merged entries..
933 if (pos < istate->cache_nr && ce_stage(ce) == 0) {
934 while (ce_same_name(istate->cache[pos], ce)) {
936 if (!remove_index_entry_at(istate, pos))
943 if (!verify_path(ce->name))
944 return error("Invalid path '%s'", ce->name);
946 if (!skip_df_check &&
947 check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
949 return error("'%s' appears as both a file and as a directory",
951 pos = index_name_pos(istate, ce->name, ce->ce_flags);
957 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
961 if (option & ADD_CACHE_JUST_APPEND)
962 pos = istate->cache_nr;
965 ret = add_index_entry_with_check(istate, ce, option);
971 /* Make sure the array is big enough .. */
972 if (istate->cache_nr == istate->cache_alloc) {
973 istate->cache_alloc = alloc_nr(istate->cache_alloc);
974 istate->cache = xrealloc(istate->cache,
975 istate->cache_alloc * sizeof(struct cache_entry *));
980 if (istate->cache_nr > pos + 1)
981 memmove(istate->cache + pos + 1,
983 (istate->cache_nr - pos - 1) * sizeof(ce));
984 set_index_entry(istate, pos, ce);
985 istate->cache_changed = 1;
990 * "refresh" does not calculate a new sha1 file or bring the
991 * cache up-to-date for mode/content changes. But what it
992 * _does_ do is to "re-match" the stat information of a file
993 * with the cache, so that you can refresh the cache for a
994 * file that hasn't been changed but where the stat entry is
997 * For example, you'd want to do this after doing a "git-read-tree",
998 * to link up the stat cache details with the proper files.
1000 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1001 struct cache_entry *ce,
1002 unsigned int options, int *err)
1005 struct cache_entry *updated;
1007 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1008 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1010 if (ce_uptodate(ce))
1014 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1015 * that the change to the work tree does not matter and told
1018 if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1019 ce_mark_uptodate(ce);
1022 if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1023 ce_mark_uptodate(ce);
1027 if (lstat(ce->name, &st) < 0) {
1033 changed = ie_match_stat(istate, ce, &st, options);
1036 * The path is unchanged. If we were told to ignore
1037 * valid bit, then we did the actual stat check and
1038 * found that the entry is unmodified. If the entry
1039 * is not marked VALID, this is the place to mark it
1040 * valid again, under "assume unchanged" mode.
1042 if (ignore_valid && assume_unchanged &&
1043 !(ce->ce_flags & CE_VALID))
1044 ; /* mark this one VALID again */
1047 * We do not mark the index itself "modified"
1048 * because CE_UPTODATE flag is in-core only;
1049 * we are not going to write this change out.
1051 ce_mark_uptodate(ce);
1056 if (ie_modified(istate, ce, &st, options)) {
1063 updated = xmalloc(size);
1064 memcpy(updated, ce, size);
1065 fill_stat_cache_info(updated, &st);
1067 * If ignore_valid is not set, we should leave CE_VALID bit
1068 * alone. Otherwise, paths marked with --no-assume-unchanged
1069 * (i.e. things to be edited) will reacquire CE_VALID bit
1070 * automatically, which is not really what we want.
1072 if (!ignore_valid && assume_unchanged &&
1073 !(ce->ce_flags & CE_VALID))
1074 updated->ce_flags &= ~CE_VALID;
1079 static void show_file(const char * fmt, const char * name, int in_porcelain,
1080 int * first, char *header_msg)
1082 if (in_porcelain && *first && header_msg) {
1083 printf("%s\n", header_msg);
1089 int refresh_index(struct index_state *istate, unsigned int flags, const char **pathspec,
1090 char *seen, char *header_msg)
1094 int really = (flags & REFRESH_REALLY) != 0;
1095 int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1096 int quiet = (flags & REFRESH_QUIET) != 0;
1097 int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1098 int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1100 int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1101 unsigned int options = really ? CE_MATCH_IGNORE_VALID : 0;
1102 const char *needs_update_fmt;
1103 const char *needs_merge_fmt;
1105 needs_update_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1106 needs_merge_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1107 for (i = 0; i < istate->cache_nr; i++) {
1108 struct cache_entry *ce, *new;
1109 int cache_errno = 0;
1111 ce = istate->cache[i];
1112 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1116 while ((i < istate->cache_nr) &&
1117 ! strcmp(istate->cache[i]->name, ce->name))
1122 show_file(needs_merge_fmt, ce->name, in_porcelain, &first, header_msg);
1127 if (pathspec && !match_pathspec(pathspec, ce->name, strlen(ce->name), 0, seen))
1130 new = refresh_cache_ent(istate, ce, options, &cache_errno);
1134 if (not_new && cache_errno == ENOENT)
1136 if (really && cache_errno == EINVAL) {
1137 /* If we are doing --really-refresh that
1138 * means the index is not valid anymore.
1140 ce->ce_flags &= ~CE_VALID;
1141 istate->cache_changed = 1;
1145 show_file(needs_update_fmt, ce->name, in_porcelain, &first, header_msg);
1150 replace_index_entry(istate, i, new);
1155 struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really)
1157 return refresh_cache_ent(&the_index, ce, really, NULL);
1160 static int verify_hdr(struct cache_header *hdr, unsigned long size)
1163 unsigned char sha1[20];
1165 if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1166 return error("bad signature");
1167 if (hdr->hdr_version != htonl(2) && hdr->hdr_version != htonl(3))
1168 return error("bad index version");
1170 git_SHA1_Update(&c, hdr, size - 20);
1171 git_SHA1_Final(sha1, &c);
1172 if (hashcmp(sha1, (unsigned char *)hdr + size - 20))
1173 return error("bad index file sha1 signature");
1177 static int read_index_extension(struct index_state *istate,
1178 const char *ext, void *data, unsigned long sz)
1180 switch (CACHE_EXT(ext)) {
1181 case CACHE_EXT_TREE:
1182 istate->cache_tree = cache_tree_read(data, sz);
1185 if (*ext < 'A' || 'Z' < *ext)
1186 return error("index uses %.4s extension, which we do not understand",
1188 fprintf(stderr, "ignoring %.4s extension\n", ext);
1194 int read_index(struct index_state *istate)
1196 return read_index_from(istate, get_index_file());
1199 static void convert_from_disk(struct ondisk_cache_entry *ondisk, struct cache_entry *ce)
1204 ce->ce_ctime.sec = ntohl(ondisk->ctime.sec);
1205 ce->ce_mtime.sec = ntohl(ondisk->mtime.sec);
1206 ce->ce_ctime.nsec = ntohl(ondisk->ctime.nsec);
1207 ce->ce_mtime.nsec = ntohl(ondisk->mtime.nsec);
1208 ce->ce_dev = ntohl(ondisk->dev);
1209 ce->ce_ino = ntohl(ondisk->ino);
1210 ce->ce_mode = ntohl(ondisk->mode);
1211 ce->ce_uid = ntohl(ondisk->uid);
1212 ce->ce_gid = ntohl(ondisk->gid);
1213 ce->ce_size = ntohl(ondisk->size);
1214 /* On-disk flags are just 16 bits */
1215 ce->ce_flags = ntohs(ondisk->flags);
1217 hashcpy(ce->sha1, ondisk->sha1);
1219 len = ce->ce_flags & CE_NAMEMASK;
1221 if (ce->ce_flags & CE_EXTENDED) {
1222 struct ondisk_cache_entry_extended *ondisk2;
1224 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1225 extended_flags = ntohs(ondisk2->flags2) << 16;
1226 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1227 if (extended_flags & ~CE_EXTENDED_FLAGS)
1228 die("Unknown index entry format %08x", extended_flags);
1229 ce->ce_flags |= extended_flags;
1230 name = ondisk2->name;
1233 name = ondisk->name;
1235 if (len == CE_NAMEMASK)
1238 * NEEDSWORK: If the original index is crafted, this copy could
1241 memcpy(ce->name, name, len + 1);
1244 static inline size_t estimate_cache_size(size_t ondisk_size, unsigned int entries)
1248 per_entry = sizeof(struct cache_entry) - sizeof(struct ondisk_cache_entry);
1251 * Alignment can cause differences. This should be "alignof", but
1252 * since that's a gcc'ism, just use the size of a pointer.
1254 per_entry += sizeof(void *);
1255 return ondisk_size + entries*per_entry;
1258 /* remember to discard_cache() before reading a different cache! */
1259 int read_index_from(struct index_state *istate, const char *path)
1263 unsigned long src_offset, dst_offset;
1264 struct cache_header *hdr;
1269 if (istate->initialized)
1270 return istate->cache_nr;
1273 istate->timestamp.sec = 0;
1274 istate->timestamp.nsec = 0;
1275 fd = open(path, O_RDONLY);
1277 if (errno == ENOENT)
1279 die_errno("index file open failed");
1283 die_errno("cannot stat the open index");
1286 mmap_size = xsize_t(st.st_size);
1287 if (mmap_size < sizeof(struct cache_header) + 20)
1288 die("index file smaller than expected");
1290 mmap = xmmap(NULL, mmap_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0);
1292 if (mmap == MAP_FAILED)
1293 die_errno("unable to map index file");
1296 if (verify_hdr(hdr, mmap_size) < 0)
1299 istate->cache_nr = ntohl(hdr->hdr_entries);
1300 istate->cache_alloc = alloc_nr(istate->cache_nr);
1301 istate->cache = xcalloc(istate->cache_alloc, sizeof(struct cache_entry *));
1304 * The disk format is actually larger than the in-memory format,
1305 * due to space for nsec etc, so even though the in-memory one
1306 * has room for a few more flags, we can allocate using the same
1309 istate->alloc = xmalloc(estimate_cache_size(mmap_size, istate->cache_nr));
1310 istate->initialized = 1;
1312 src_offset = sizeof(*hdr);
1314 for (i = 0; i < istate->cache_nr; i++) {
1315 struct ondisk_cache_entry *disk_ce;
1316 struct cache_entry *ce;
1318 disk_ce = (struct ondisk_cache_entry *)((char *)mmap + src_offset);
1319 ce = (struct cache_entry *)((char *)istate->alloc + dst_offset);
1320 convert_from_disk(disk_ce, ce);
1321 set_index_entry(istate, i, ce);
1323 src_offset += ondisk_ce_size(ce);
1324 dst_offset += ce_size(ce);
1326 istate->timestamp.sec = st.st_mtime;
1327 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1329 while (src_offset <= mmap_size - 20 - 8) {
1330 /* After an array of active_nr index entries,
1331 * there can be arbitrary number of extended
1332 * sections, each of which is prefixed with
1333 * extension name (4-byte) and section length
1334 * in 4-byte network byte order.
1337 memcpy(&extsize, (char *)mmap + src_offset + 4, 4);
1338 extsize = ntohl(extsize);
1339 if (read_index_extension(istate,
1340 (const char *) mmap + src_offset,
1341 (char *) mmap + src_offset + 8,
1345 src_offset += extsize;
1347 munmap(mmap, mmap_size);
1348 return istate->cache_nr;
1351 munmap(mmap, mmap_size);
1353 die("index file corrupt");
1356 int is_index_unborn(struct index_state *istate)
1358 return (!istate->cache_nr && !istate->alloc && !istate->timestamp.sec);
1361 int discard_index(struct index_state *istate)
1363 istate->cache_nr = 0;
1364 istate->cache_changed = 0;
1365 istate->timestamp.sec = 0;
1366 istate->timestamp.nsec = 0;
1367 istate->name_hash_initialized = 0;
1368 free_hash(&istate->name_hash);
1369 cache_tree_free(&(istate->cache_tree));
1370 free(istate->alloc);
1371 istate->alloc = NULL;
1372 istate->initialized = 0;
1374 /* no need to throw away allocated active_cache */
1378 int unmerged_index(const struct index_state *istate)
1381 for (i = 0; i < istate->cache_nr; i++) {
1382 if (ce_stage(istate->cache[i]))
1388 #define WRITE_BUFFER_SIZE 8192
1389 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
1390 static unsigned long write_buffer_len;
1392 static int ce_write_flush(git_SHA_CTX *context, int fd)
1394 unsigned int buffered = write_buffer_len;
1396 git_SHA1_Update(context, write_buffer, buffered);
1397 if (write_in_full(fd, write_buffer, buffered) != buffered)
1399 write_buffer_len = 0;
1404 static int ce_write(git_SHA_CTX *context, int fd, void *data, unsigned int len)
1407 unsigned int buffered = write_buffer_len;
1408 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
1411 memcpy(write_buffer + buffered, data, partial);
1412 buffered += partial;
1413 if (buffered == WRITE_BUFFER_SIZE) {
1414 write_buffer_len = buffered;
1415 if (ce_write_flush(context, fd))
1419 write_buffer_len = buffered;
1421 data = (char *) data + partial;
1426 static int write_index_ext_header(git_SHA_CTX *context, int fd,
1427 unsigned int ext, unsigned int sz)
1431 return ((ce_write(context, fd, &ext, 4) < 0) ||
1432 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
1435 static int ce_flush(git_SHA_CTX *context, int fd)
1437 unsigned int left = write_buffer_len;
1440 write_buffer_len = 0;
1441 git_SHA1_Update(context, write_buffer, left);
1444 /* Flush first if not enough space for SHA1 signature */
1445 if (left + 20 > WRITE_BUFFER_SIZE) {
1446 if (write_in_full(fd, write_buffer, left) != left)
1451 /* Append the SHA1 signature at the end */
1452 git_SHA1_Final(write_buffer + left, context);
1454 return (write_in_full(fd, write_buffer, left) != left) ? -1 : 0;
1457 static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
1460 * The only thing we care about in this function is to smudge the
1461 * falsely clean entry due to touch-update-touch race, so we leave
1462 * everything else as they are. We are called for entries whose
1463 * ce_mtime match the index file mtime.
1465 * Note that this actually does not do much for gitlinks, for
1466 * which ce_match_stat_basic() always goes to the actual
1467 * contents. The caller checks with is_racy_timestamp() which
1468 * always says "no" for gitlinks, so we are not called for them ;-)
1472 if (lstat(ce->name, &st) < 0)
1474 if (ce_match_stat_basic(ce, &st))
1476 if (ce_modified_check_fs(ce, &st)) {
1477 /* This is "racily clean"; smudge it. Note that this
1478 * is a tricky code. At first glance, it may appear
1479 * that it can break with this sequence:
1481 * $ echo xyzzy >frotz
1482 * $ git-update-index --add frotz
1485 * $ echo filfre >nitfol
1486 * $ git-update-index --add nitfol
1488 * but it does not. When the second update-index runs,
1489 * it notices that the entry "frotz" has the same timestamp
1490 * as index, and if we were to smudge it by resetting its
1491 * size to zero here, then the object name recorded
1492 * in index is the 6-byte file but the cached stat information
1493 * becomes zero --- which would then match what we would
1494 * obtain from the filesystem next time we stat("frotz").
1496 * However, the second update-index, before calling
1497 * this function, notices that the cached size is 6
1498 * bytes and what is on the filesystem is an empty
1499 * file, and never calls us, so the cached size information
1500 * for "frotz" stays 6 which does not match the filesystem.
1506 static int ce_write_entry(git_SHA_CTX *c, int fd, struct cache_entry *ce)
1508 int size = ondisk_ce_size(ce);
1509 struct ondisk_cache_entry *ondisk = xcalloc(1, size);
1512 ondisk->ctime.sec = htonl(ce->ce_ctime.sec);
1513 ondisk->mtime.sec = htonl(ce->ce_mtime.sec);
1514 ondisk->ctime.nsec = htonl(ce->ce_ctime.nsec);
1515 ondisk->mtime.nsec = htonl(ce->ce_mtime.nsec);
1516 ondisk->dev = htonl(ce->ce_dev);
1517 ondisk->ino = htonl(ce->ce_ino);
1518 ondisk->mode = htonl(ce->ce_mode);
1519 ondisk->uid = htonl(ce->ce_uid);
1520 ondisk->gid = htonl(ce->ce_gid);
1521 ondisk->size = htonl(ce->ce_size);
1522 hashcpy(ondisk->sha1, ce->sha1);
1523 ondisk->flags = htons(ce->ce_flags);
1524 if (ce->ce_flags & CE_EXTENDED) {
1525 struct ondisk_cache_entry_extended *ondisk2;
1526 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1527 ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
1528 name = ondisk2->name;
1531 name = ondisk->name;
1532 memcpy(name, ce->name, ce_namelen(ce));
1534 return ce_write(c, fd, ondisk, size);
1537 int write_index(struct index_state *istate, int newfd)
1540 struct cache_header hdr;
1541 int i, err, removed, extended;
1542 struct cache_entry **cache = istate->cache;
1543 int entries = istate->cache_nr;
1546 for (i = removed = extended = 0; i < entries; i++) {
1547 if (cache[i]->ce_flags & CE_REMOVE)
1550 /* reduce extended entries if possible */
1551 cache[i]->ce_flags &= ~CE_EXTENDED;
1552 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
1554 cache[i]->ce_flags |= CE_EXTENDED;
1558 hdr.hdr_signature = htonl(CACHE_SIGNATURE);
1559 /* for extended format, increase version so older git won't try to read it */
1560 hdr.hdr_version = htonl(extended ? 3 : 2);
1561 hdr.hdr_entries = htonl(entries - removed);
1564 if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
1567 for (i = 0; i < entries; i++) {
1568 struct cache_entry *ce = cache[i];
1569 if (ce->ce_flags & CE_REMOVE)
1571 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
1572 ce_smudge_racily_clean_entry(ce);
1573 if (ce_write_entry(&c, newfd, ce) < 0)
1577 /* Write extension data here */
1578 if (istate->cache_tree) {
1579 struct strbuf sb = STRBUF_INIT;
1581 cache_tree_write(&sb, istate->cache_tree);
1582 err = write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sb.len) < 0
1583 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
1584 strbuf_release(&sb);
1589 if (ce_flush(&c, newfd) || fstat(newfd, &st))
1591 istate->timestamp.sec = (unsigned int)st.st_mtime;
1592 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1597 * Read the index file that is potentially unmerged into given
1598 * index_state, dropping any unmerged entries. Returns true if
1599 * the index is unmerged. Callers who want to refuse to work
1600 * from an unmerged state can call this and check its return value,
1601 * instead of calling read_cache().
1603 int read_index_unmerged(struct index_state *istate)
1609 for (i = 0; i < istate->cache_nr; i++) {
1610 struct cache_entry *ce = istate->cache[i];
1611 struct cache_entry *new_ce;
1617 len = strlen(ce->name);
1618 size = cache_entry_size(len);
1619 new_ce = xcalloc(1, size);
1620 memcpy(new_ce->name, ce->name, len);
1621 new_ce->ce_flags = create_ce_flags(len, 0) | CE_CONFLICTED;
1622 new_ce->ce_mode = ce->ce_mode;
1623 if (add_index_entry(istate, new_ce, 0))
1624 return error("%s: cannot drop to stage #0",
1626 i = index_name_pos(istate, new_ce->name, len);
1631 struct update_callback_data
1637 static void update_callback(struct diff_queue_struct *q,
1638 struct diff_options *opt, void *cbdata)
1641 struct update_callback_data *data = cbdata;
1643 for (i = 0; i < q->nr; i++) {
1644 struct diff_filepair *p = q->queue[i];
1645 const char *path = p->one->path;
1646 switch (p->status) {
1648 die("unexpected diff status %c", p->status);
1649 case DIFF_STATUS_UNMERGED:
1651 * ADD_CACHE_IGNORE_REMOVAL is unset if "git
1652 * add -u" is calling us, In such a case, a
1653 * missing work tree file needs to be removed
1654 * if there is an unmerged entry at stage #2,
1655 * but such a diff record is followed by
1656 * another with DIFF_STATUS_DELETED (and if
1657 * there is no stage #2, we won't see DELETED
1658 * nor MODIFIED). We can simply continue
1661 if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL))
1664 * Otherwise, it is "git add path" is asking
1665 * to explicitly add it; we fall through. A
1666 * missing work tree file is an error and is
1667 * caught by add_file_to_index() in such a
1670 case DIFF_STATUS_MODIFIED:
1671 case DIFF_STATUS_TYPE_CHANGED:
1672 if (add_file_to_index(&the_index, path, data->flags)) {
1673 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
1674 die("updating files failed");
1678 case DIFF_STATUS_DELETED:
1679 if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
1681 if (!(data->flags & ADD_CACHE_PRETEND))
1682 remove_file_from_index(&the_index, path);
1683 if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
1684 printf("remove '%s'\n", path);
1690 int add_files_to_cache(const char *prefix, const char **pathspec, int flags)
1692 struct update_callback_data data;
1693 struct rev_info rev;
1694 init_revisions(&rev, prefix);
1695 setup_revisions(0, NULL, &rev, NULL);
1696 rev.prune_data = pathspec;
1697 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
1698 rev.diffopt.format_callback = update_callback;
1700 data.add_errors = 0;
1701 rev.diffopt.format_callback_data = &data;
1702 run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
1703 return !!data.add_errors;
1707 * Returns 1 if the path is an "other" path with respect to
1708 * the index; that is, the path is not mentioned in the index at all,
1709 * either as a file, a directory with some files in the index,
1710 * or as an unmerged entry.
1712 * We helpfully remove a trailing "/" from directories so that
1713 * the output of read_directory can be used as-is.
1715 int index_name_is_other(const struct index_state *istate, const char *name,
1719 if (namelen && name[namelen - 1] == '/')
1721 pos = index_name_pos(istate, name, namelen);
1723 return 0; /* exact match */
1725 if (pos < istate->cache_nr) {
1726 struct cache_entry *ce = istate->cache[pos];
1727 if (ce_namelen(ce) == namelen &&
1728 !memcmp(ce->name, name, namelen))
1729 return 0; /* Yup, this one exists unmerged */