2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
7 #include "cache-tree.h"
11 * The first letter should be 'A'..'Z' for extensions that are not
12 * necessary for a correct operation (i.e. optimization data).
13 * When new extensions are added that _needs_ to be understood in
14 * order to correctly interpret the index file, pick character that
15 * is outside the range, to cause the reader to abort.
18 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
19 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
21 struct cache_entry **active_cache = NULL;
22 static time_t index_file_timestamp;
23 unsigned int active_nr = 0, active_alloc = 0, active_cache_changed = 0;
25 struct cache_tree *active_cache_tree = NULL;
28 * This only updates the "non-critical" parts of the directory
29 * cache, ie the parts that aren't tracked by GIT, and only used
30 * to validate the cache.
32 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
34 ce->ce_ctime.sec = htonl(st->st_ctime);
35 ce->ce_mtime.sec = htonl(st->st_mtime);
37 ce->ce_ctime.nsec = htonl(st->st_ctim.tv_nsec);
38 ce->ce_mtime.nsec = htonl(st->st_mtim.tv_nsec);
40 ce->ce_dev = htonl(st->st_dev);
41 ce->ce_ino = htonl(st->st_ino);
42 ce->ce_uid = htonl(st->st_uid);
43 ce->ce_gid = htonl(st->st_gid);
44 ce->ce_size = htonl(st->st_size);
47 ce->ce_flags |= htons(CE_VALID);
50 static int ce_compare_data(struct cache_entry *ce, struct stat *st)
53 int fd = open(ce->name, O_RDONLY);
56 unsigned char sha1[20];
57 if (!index_fd(sha1, fd, st, 0, NULL))
58 match = memcmp(sha1, ce->sha1, 20);
64 static int ce_compare_link(struct cache_entry *ce, unsigned long expected_size)
73 target = xmalloc(expected_size);
74 len = readlink(ce->name, target, expected_size);
75 if (len != expected_size) {
79 buffer = read_sha1_file(ce->sha1, type, &size);
84 if (size == expected_size)
85 match = memcmp(buffer, target, size);
91 static int ce_modified_check_fs(struct cache_entry *ce, struct stat *st)
93 switch (st->st_mode & S_IFMT) {
95 if (ce_compare_data(ce, st))
99 if (ce_compare_link(ce, st->st_size))
108 static int ce_match_stat_basic(struct cache_entry *ce, struct stat *st)
110 unsigned int changed = 0;
112 switch (ntohl(ce->ce_mode) & S_IFMT) {
114 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
115 /* We consider only the owner x bit to be relevant for
118 if (trust_executable_bit &&
119 (0100 & (ntohl(ce->ce_mode) ^ st->st_mode)))
120 changed |= MODE_CHANGED;
123 changed |= !S_ISLNK(st->st_mode) ? TYPE_CHANGED : 0;
126 die("internal error: ce_mode is %o", ntohl(ce->ce_mode));
128 if (ce->ce_mtime.sec != htonl(st->st_mtime))
129 changed |= MTIME_CHANGED;
130 if (ce->ce_ctime.sec != htonl(st->st_ctime))
131 changed |= CTIME_CHANGED;
135 * nsec seems unreliable - not all filesystems support it, so
136 * as long as it is in the inode cache you get right nsec
137 * but after it gets flushed, you get zero nsec.
139 if (ce->ce_mtime.nsec != htonl(st->st_mtim.tv_nsec))
140 changed |= MTIME_CHANGED;
141 if (ce->ce_ctime.nsec != htonl(st->st_ctim.tv_nsec))
142 changed |= CTIME_CHANGED;
145 if (ce->ce_uid != htonl(st->st_uid) ||
146 ce->ce_gid != htonl(st->st_gid))
147 changed |= OWNER_CHANGED;
148 if (ce->ce_ino != htonl(st->st_ino))
149 changed |= INODE_CHANGED;
153 * st_dev breaks on network filesystems where different
154 * clients will have different views of what "device"
155 * the filesystem is on
157 if (ce->ce_dev != htonl(st->st_dev))
158 changed |= INODE_CHANGED;
161 if (ce->ce_size != htonl(st->st_size))
162 changed |= DATA_CHANGED;
167 int ce_match_stat(struct cache_entry *ce, struct stat *st, int ignore_valid)
169 unsigned int changed;
172 * If it's marked as always valid in the index, it's
173 * valid whatever the checked-out copy says.
175 if (!ignore_valid && (ce->ce_flags & htons(CE_VALID)))
178 changed = ce_match_stat_basic(ce, st);
181 * Within 1 second of this sequence:
182 * echo xyzzy >file && git-update-index --add file
183 * running this command:
185 * would give a falsely clean cache entry. The mtime and
186 * length match the cache, and other stat fields do not change.
188 * We could detect this at update-index time (the cache entry
189 * being registered/updated records the same time as "now")
190 * and delay the return from git-update-index, but that would
191 * effectively mean we can make at most one commit per second,
192 * which is not acceptable. Instead, we check cache entries
193 * whose mtime are the same as the index file timestamp more
194 * carefully than others.
197 index_file_timestamp &&
198 index_file_timestamp <= ntohl(ce->ce_mtime.sec))
199 changed |= ce_modified_check_fs(ce, st);
204 int ce_modified(struct cache_entry *ce, struct stat *st, int really)
206 int changed, changed_fs;
207 changed = ce_match_stat(ce, st, really);
211 * If the mode or type has changed, there's no point in trying
212 * to refresh the entry - it's not going to match
214 if (changed & (MODE_CHANGED | TYPE_CHANGED))
217 /* Immediately after read-tree or update-index --cacheinfo,
218 * the length field is zero. For other cases the ce_size
219 * should match the SHA1 recorded in the index entry.
221 if ((changed & DATA_CHANGED) && ce->ce_size != htonl(0))
224 changed_fs = ce_modified_check_fs(ce, st);
226 return changed | changed_fs;
230 int base_name_compare(const char *name1, int len1, int mode1,
231 const char *name2, int len2, int mode2)
233 unsigned char c1, c2;
234 int len = len1 < len2 ? len1 : len2;
237 cmp = memcmp(name1, name2, len);
242 if (!c1 && S_ISDIR(mode1))
244 if (!c2 && S_ISDIR(mode2))
246 return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
249 int cache_name_compare(const char *name1, int flags1, const char *name2, int flags2)
251 int len1 = flags1 & CE_NAMEMASK;
252 int len2 = flags2 & CE_NAMEMASK;
253 int len = len1 < len2 ? len1 : len2;
256 cmp = memcmp(name1, name2, len);
265 flags1 &= CE_STAGEMASK;
266 flags2 &= CE_STAGEMASK;
275 int cache_name_pos(const char *name, int namelen)
281 while (last > first) {
282 int next = (last + first) >> 1;
283 struct cache_entry *ce = active_cache[next];
284 int cmp = cache_name_compare(name, namelen, ce->name, ntohs(ce->ce_flags));
296 /* Remove entry, return true if there are more entries to go.. */
297 int remove_cache_entry_at(int pos)
299 active_cache_changed = 1;
301 if (pos >= active_nr)
303 memmove(active_cache + pos, active_cache + pos + 1, (active_nr - pos) * sizeof(struct cache_entry *));
307 int remove_file_from_cache(const char *path)
309 int pos = cache_name_pos(path, strlen(path));
312 while (pos < active_nr && !strcmp(active_cache[pos]->name, path))
313 remove_cache_entry_at(pos);
317 int ce_same_name(struct cache_entry *a, struct cache_entry *b)
319 int len = ce_namelen(a);
320 return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
323 int ce_path_match(const struct cache_entry *ce, const char **pathspec)
325 const char *match, *name;
331 len = ce_namelen(ce);
333 while ((match = *pathspec++) != NULL) {
334 int matchlen = strlen(match);
337 if (memcmp(name, match, matchlen))
339 if (matchlen && name[matchlen-1] == '/')
341 if (name[matchlen] == '/' || !name[matchlen])
350 * Do we have another file that has the beginning components being a
351 * proper superset of the name we're trying to add?
353 static int has_file_name(const struct cache_entry *ce, int pos, int ok_to_replace)
356 int len = ce_namelen(ce);
357 int stage = ce_stage(ce);
358 const char *name = ce->name;
360 while (pos < active_nr) {
361 struct cache_entry *p = active_cache[pos++];
363 if (len >= ce_namelen(p))
365 if (memcmp(name, p->name, len))
367 if (ce_stage(p) != stage)
369 if (p->name[len] != '/')
374 remove_cache_entry_at(--pos);
380 * Do we have another file with a pathname that is a proper
381 * subset of the name we're trying to add?
383 static int has_dir_name(const struct cache_entry *ce, int pos, int ok_to_replace)
386 int stage = ce_stage(ce);
387 const char *name = ce->name;
388 const char *slash = name + ce_namelen(ce);
396 if (slash <= ce->name)
401 pos = cache_name_pos(name, ntohs(create_ce_flags(len, stage)));
406 remove_cache_entry_at(pos);
411 * Trivial optimization: if we find an entry that
412 * already matches the sub-directory, then we know
413 * we're ok, and we can exit.
416 while (pos < active_nr) {
417 struct cache_entry *p = active_cache[pos];
418 if ((ce_namelen(p) <= len) ||
419 (p->name[len] != '/') ||
420 memcmp(p->name, name, len))
421 break; /* not our subdirectory */
422 if (ce_stage(p) == stage)
423 /* p is at the same stage as our entry, and
424 * is a subdirectory of what we are looking
425 * at, so we cannot have conflicts at our
426 * level or anything shorter.
435 /* We may be in a situation where we already have path/file and path
436 * is being added, or we already have path and path/file is being
437 * added. Either one would result in a nonsense tree that has path
438 * twice when git-write-tree tries to write it out. Prevent it.
440 * If ok-to-replace is specified, we remove the conflicting entries
441 * from the cache so the caller should recompute the insert position.
442 * When this happens, we return non-zero.
444 static int check_file_directory_conflict(const struct cache_entry *ce, int pos, int ok_to_replace)
447 * We check if the path is a sub-path of a subsequent pathname
448 * first, since removing those will not change the position
451 int retval = has_file_name(ce, pos, ok_to_replace);
453 * Then check if the path might have a clashing sub-directory
456 return retval + has_dir_name(ce, pos, ok_to_replace);
459 int add_cache_entry(struct cache_entry *ce, int option)
462 int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
463 int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
464 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
466 pos = cache_name_pos(ce->name, ntohs(ce->ce_flags));
468 /* existing match? Just replace it. */
470 active_cache_changed = 1;
471 active_cache[pos] = ce;
477 * Inserting a merged entry ("stage 0") into the index
478 * will always replace all non-merged entries..
480 if (pos < active_nr && ce_stage(ce) == 0) {
481 while (ce_same_name(active_cache[pos], ce)) {
483 if (!remove_cache_entry_at(pos))
491 if (!skip_df_check &&
492 check_file_directory_conflict(ce, pos, ok_to_replace)) {
495 pos = cache_name_pos(ce->name, ntohs(ce->ce_flags));
499 /* Make sure the array is big enough .. */
500 if (active_nr == active_alloc) {
501 active_alloc = alloc_nr(active_alloc);
502 active_cache = xrealloc(active_cache, active_alloc * sizeof(struct cache_entry *));
508 memmove(active_cache + pos + 1, active_cache + pos, (active_nr - pos - 1) * sizeof(ce));
509 active_cache[pos] = ce;
510 active_cache_changed = 1;
514 static int verify_hdr(struct cache_header *hdr, unsigned long size)
517 unsigned char sha1[20];
519 if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
520 return error("bad signature");
521 if (hdr->hdr_version != htonl(2))
522 return error("bad index version");
524 SHA1_Update(&c, hdr, size - 20);
525 SHA1_Final(sha1, &c);
526 if (memcmp(sha1, (void *)hdr + size - 20, 20))
527 return error("bad index file sha1 signature");
531 static int read_index_extension(const char *ext, void *data, unsigned long sz)
533 switch (CACHE_EXT(ext)) {
535 active_cache_tree = cache_tree_read(data, sz);
538 if (*ext < 'A' || 'Z' < *ext)
539 return error("index uses %.4s extension, which we do not understand",
541 fprintf(stderr, "ignoring %.4s extension\n", ext);
551 unsigned long size, offset;
553 struct cache_header *hdr;
560 index_file_timestamp = 0;
561 fd = open(get_index_file(), O_RDONLY);
565 die("index file open failed (%s)", strerror(errno));
568 size = 0; // avoid gcc warning
570 if (!fstat(fd, &st)) {
573 if (size >= sizeof(struct cache_header) + 20)
574 map = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0);
577 if (map == MAP_FAILED)
578 die("index file mmap failed (%s)", strerror(errno));
581 if (verify_hdr(hdr, size) < 0)
584 active_nr = ntohl(hdr->hdr_entries);
585 active_alloc = alloc_nr(active_nr);
586 active_cache = xcalloc(active_alloc, sizeof(struct cache_entry *));
588 offset = sizeof(*hdr);
589 for (i = 0; i < active_nr; i++) {
590 struct cache_entry *ce = map + offset;
591 offset = offset + ce_size(ce);
592 active_cache[i] = ce;
594 index_file_timestamp = st.st_mtime;
595 while (offset <= size - 20 - 8) {
596 /* After an array of active_nr index entries,
597 * there can be arbitrary number of extended
598 * sections, each of which is prefixed with
599 * extension name (4-byte) and section length
600 * in 4-byte network byte order.
602 unsigned long extsize;
603 memcpy(&extsize, map + offset + 4, 4);
604 extsize = ntohl(extsize);
605 if (read_index_extension(map + offset,
606 map + offset + 8, extsize) < 0)
616 die("index file corrupt");
619 #define WRITE_BUFFER_SIZE 8192
620 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
621 static unsigned long write_buffer_len;
623 static int ce_write(SHA_CTX *context, int fd, void *data, unsigned int len)
626 unsigned int buffered = write_buffer_len;
627 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
630 memcpy(write_buffer + buffered, data, partial);
632 if (buffered == WRITE_BUFFER_SIZE) {
633 SHA1_Update(context, write_buffer, WRITE_BUFFER_SIZE);
634 if (write(fd, write_buffer, WRITE_BUFFER_SIZE) != WRITE_BUFFER_SIZE)
638 write_buffer_len = buffered;
645 static int write_index_ext_header(SHA_CTX *context, int fd,
646 unsigned long ext, unsigned long sz)
650 if ((ce_write(context, fd, &ext, 4) < 0) ||
651 (ce_write(context, fd, &sz, 4) < 0))
656 static int ce_flush(SHA_CTX *context, int fd)
658 unsigned int left = write_buffer_len;
661 write_buffer_len = 0;
662 SHA1_Update(context, write_buffer, left);
665 /* Flush first if not enough space for SHA1 signature */
666 if (left + 20 > WRITE_BUFFER_SIZE) {
667 if (write(fd, write_buffer, left) != left)
672 /* Append the SHA1 signature at the end */
673 SHA1_Final(write_buffer + left, context);
675 if (write(fd, write_buffer, left) != left)
680 static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
683 * The only thing we care about in this function is to smudge the
684 * falsely clean entry due to touch-update-touch race, so we leave
685 * everything else as they are. We are called for entries whose
686 * ce_mtime match the index file mtime.
690 if (lstat(ce->name, &st) < 0)
692 if (ce_match_stat_basic(ce, &st))
694 if (ce_modified_check_fs(ce, &st)) {
695 /* This is "racily clean"; smudge it. Note that this
696 * is a tricky code. At first glance, it may appear
697 * that it can break with this sequence:
699 * $ echo xyzzy >frotz
700 * $ git-update-index --add frotz
703 * $ echo filfre >nitfol
704 * $ git-update-index --add nitfol
706 * but it does not. Whe the second update-index runs,
707 * it notices that the entry "frotz" has the same timestamp
708 * as index, and if we were to smudge it by resetting its
709 * size to zero here, then the object name recorded
710 * in index is the 6-byte file but the cached stat information
711 * becomes zero --- which would then match what we would
712 * obtain from the filesystem next time we stat("frotz").
714 * However, the second update-index, before calling
715 * this function, notices that the cached size is 6
716 * bytes and what is on the filesystem is an empty
717 * file, and never calls us, so the cached size information
718 * for "frotz" stays 6 which does not match the filesystem.
720 ce->ce_size = htonl(0);
724 int write_cache(int newfd, struct cache_entry **cache, int entries)
727 struct cache_header hdr;
730 for (i = removed = 0; i < entries; i++)
731 if (!cache[i]->ce_mode)
734 hdr.hdr_signature = htonl(CACHE_SIGNATURE);
735 hdr.hdr_version = htonl(2);
736 hdr.hdr_entries = htonl(entries - removed);
739 if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
742 for (i = 0; i < entries; i++) {
743 struct cache_entry *ce = cache[i];
746 if (index_file_timestamp &&
747 index_file_timestamp <= ntohl(ce->ce_mtime.sec))
748 ce_smudge_racily_clean_entry(ce);
749 if (ce_write(&c, newfd, ce, ce_size(ce)) < 0)
753 /* Write extension data here */
754 if (active_cache_tree) {
756 void *data = cache_tree_write(active_cache_tree, &sz);
758 !write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sz) &&
759 !ce_write(&c, newfd, data, sz))
766 return ce_flush(&c, newfd);