Merge branch 'nd/diff-quiet-stat-dirty' into maint
[git/mingw.git] / read-cache.c
blob23eb2513c139fa1f775040fe1a5ffd2558a3c418
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #define NO_THE_INDEX_COMPATIBILITY_MACROS
7 #include "cache.h"
8 #include "cache-tree.h"
9 #include "refs.h"
10 #include "dir.h"
11 #include "tree.h"
12 #include "commit.h"
13 #include "blob.h"
14 #include "resolve-undo.h"
15 #include "strbuf.h"
16 #include "varint.h"
18 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
20 /* Mask for the name length in ce_flags in the on-disk index */
22 #define CE_NAMEMASK (0x0fff)
24 /* Index extensions.
26 * The first letter should be 'A'..'Z' for extensions that are not
27 * necessary for a correct operation (i.e. optimization data).
28 * When new extensions are added that _needs_ to be understood in
29 * order to correctly interpret the index file, pick character that
30 * is outside the range, to cause the reader to abort.
33 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
34 #define CACHE_EXT_TREE 0x54524545 /* "TREE" */
35 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
37 struct index_state the_index;
39 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
41 istate->cache[nr] = ce;
42 add_name_hash(istate, ce);
45 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
47 struct cache_entry *old = istate->cache[nr];
49 remove_name_hash(istate, old);
50 set_index_entry(istate, nr, ce);
51 istate->cache_changed = 1;
54 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
56 struct cache_entry *old = istate->cache[nr], *new;
57 int namelen = strlen(new_name);
59 new = xmalloc(cache_entry_size(namelen));
60 copy_cache_entry(new, old);
61 new->ce_flags &= ~CE_STATE_MASK;
62 new->ce_namelen = namelen;
63 memcpy(new->name, new_name, namelen + 1);
65 cache_tree_invalidate_path(istate->cache_tree, old->name);
66 remove_index_entry_at(istate, nr);
67 add_index_entry(istate, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
70 void fill_stat_data(struct stat_data *sd, struct stat *st)
72 sd->sd_ctime.sec = (unsigned int)st->st_ctime;
73 sd->sd_mtime.sec = (unsigned int)st->st_mtime;
74 sd->sd_ctime.nsec = ST_CTIME_NSEC(*st);
75 sd->sd_mtime.nsec = ST_MTIME_NSEC(*st);
76 sd->sd_dev = st->st_dev;
77 sd->sd_ino = st->st_ino;
78 sd->sd_uid = st->st_uid;
79 sd->sd_gid = st->st_gid;
80 sd->sd_size = st->st_size;
83 int match_stat_data(const struct stat_data *sd, struct stat *st)
85 int changed = 0;
87 if (sd->sd_mtime.sec != (unsigned int)st->st_mtime)
88 changed |= MTIME_CHANGED;
89 if (trust_ctime && check_stat &&
90 sd->sd_ctime.sec != (unsigned int)st->st_ctime)
91 changed |= CTIME_CHANGED;
93 #ifdef USE_NSEC
94 if (check_stat && sd->sd_mtime.nsec != ST_MTIME_NSEC(*st))
95 changed |= MTIME_CHANGED;
96 if (trust_ctime && check_stat &&
97 sd->sd_ctime.nsec != ST_CTIME_NSEC(*st))
98 changed |= CTIME_CHANGED;
99 #endif
101 if (check_stat) {
102 if (sd->sd_uid != (unsigned int) st->st_uid ||
103 sd->sd_gid != (unsigned int) st->st_gid)
104 changed |= OWNER_CHANGED;
105 if (sd->sd_ino != (unsigned int) st->st_ino)
106 changed |= INODE_CHANGED;
109 #ifdef USE_STDEV
111 * st_dev breaks on network filesystems where different
112 * clients will have different views of what "device"
113 * the filesystem is on
115 if (check_stat && sd->sd_dev != (unsigned int) st->st_dev)
116 changed |= INODE_CHANGED;
117 #endif
119 if (sd->sd_size != (unsigned int) st->st_size)
120 changed |= DATA_CHANGED;
122 return changed;
126 * This only updates the "non-critical" parts of the directory
127 * cache, ie the parts that aren't tracked by GIT, and only used
128 * to validate the cache.
130 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
132 fill_stat_data(&ce->ce_stat_data, st);
134 if (assume_unchanged)
135 ce->ce_flags |= CE_VALID;
137 if (S_ISREG(st->st_mode))
138 ce_mark_uptodate(ce);
141 static int ce_compare_data(const struct cache_entry *ce, struct stat *st)
143 int match = -1;
144 int fd = open(ce->name, O_RDONLY);
146 if (fd >= 0) {
147 unsigned char sha1[20];
148 if (!index_fd(sha1, fd, st, OBJ_BLOB, ce->name, 0))
149 match = hashcmp(sha1, ce->sha1);
150 /* index_fd() closed the file descriptor already */
152 return match;
155 static int ce_compare_link(const struct cache_entry *ce, size_t expected_size)
157 int match = -1;
158 void *buffer;
159 unsigned long size;
160 enum object_type type;
161 struct strbuf sb = STRBUF_INIT;
163 if (strbuf_readlink(&sb, ce->name, expected_size))
164 return -1;
166 buffer = read_sha1_file(ce->sha1, &type, &size);
167 if (buffer) {
168 if (size == sb.len)
169 match = memcmp(buffer, sb.buf, size);
170 free(buffer);
172 strbuf_release(&sb);
173 return match;
176 static int ce_compare_gitlink(const struct cache_entry *ce)
178 unsigned char sha1[20];
181 * We don't actually require that the .git directory
182 * under GITLINK directory be a valid git directory. It
183 * might even be missing (in case nobody populated that
184 * sub-project).
186 * If so, we consider it always to match.
188 if (resolve_gitlink_ref(ce->name, "HEAD", sha1) < 0)
189 return 0;
190 return hashcmp(sha1, ce->sha1);
193 static int ce_modified_check_fs(const struct cache_entry *ce, struct stat *st)
195 switch (st->st_mode & S_IFMT) {
196 case S_IFREG:
197 if (ce_compare_data(ce, st))
198 return DATA_CHANGED;
199 break;
200 case S_IFLNK:
201 if (ce_compare_link(ce, xsize_t(st->st_size)))
202 return DATA_CHANGED;
203 break;
204 case S_IFDIR:
205 if (S_ISGITLINK(ce->ce_mode))
206 return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
207 default:
208 return TYPE_CHANGED;
210 return 0;
213 static int ce_match_stat_basic(const struct cache_entry *ce, struct stat *st)
215 unsigned int changed = 0;
217 if (ce->ce_flags & CE_REMOVE)
218 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
220 switch (ce->ce_mode & S_IFMT) {
221 case S_IFREG:
222 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
223 /* We consider only the owner x bit to be relevant for
224 * "mode changes"
226 if (trust_executable_bit &&
227 (0100 & (ce->ce_mode ^ st->st_mode)))
228 changed |= MODE_CHANGED;
229 break;
230 case S_IFLNK:
231 if (!S_ISLNK(st->st_mode) &&
232 (has_symlinks || !S_ISREG(st->st_mode)))
233 changed |= TYPE_CHANGED;
234 break;
235 case S_IFGITLINK:
236 /* We ignore most of the st_xxx fields for gitlinks */
237 if (!S_ISDIR(st->st_mode))
238 changed |= TYPE_CHANGED;
239 else if (ce_compare_gitlink(ce))
240 changed |= DATA_CHANGED;
241 return changed;
242 default:
243 die("internal error: ce_mode is %o", ce->ce_mode);
246 changed |= match_stat_data(&ce->ce_stat_data, st);
248 /* Racily smudged entry? */
249 if (!ce->ce_stat_data.sd_size) {
250 if (!is_empty_blob_sha1(ce->sha1))
251 changed |= DATA_CHANGED;
254 return changed;
257 static int is_racy_timestamp(const struct index_state *istate,
258 const struct cache_entry *ce)
260 return (!S_ISGITLINK(ce->ce_mode) &&
261 istate->timestamp.sec &&
262 #ifdef USE_NSEC
263 /* nanosecond timestamped files can also be racy! */
264 (istate->timestamp.sec < ce->ce_stat_data.sd_mtime.sec ||
265 (istate->timestamp.sec == ce->ce_stat_data.sd_mtime.sec &&
266 istate->timestamp.nsec <= ce->ce_stat_data.sd_mtime.nsec))
267 #else
268 istate->timestamp.sec <= ce->ce_stat_data.sd_mtime.sec
269 #endif
273 int ie_match_stat(const struct index_state *istate,
274 const struct cache_entry *ce, struct stat *st,
275 unsigned int options)
277 unsigned int changed;
278 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
279 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
280 int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
283 * If it's marked as always valid in the index, it's
284 * valid whatever the checked-out copy says.
286 * skip-worktree has the same effect with higher precedence
288 if (!ignore_skip_worktree && ce_skip_worktree(ce))
289 return 0;
290 if (!ignore_valid && (ce->ce_flags & CE_VALID))
291 return 0;
294 * Intent-to-add entries have not been added, so the index entry
295 * by definition never matches what is in the work tree until it
296 * actually gets added.
298 if (ce->ce_flags & CE_INTENT_TO_ADD)
299 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
301 changed = ce_match_stat_basic(ce, st);
304 * Within 1 second of this sequence:
305 * echo xyzzy >file && git-update-index --add file
306 * running this command:
307 * echo frotz >file
308 * would give a falsely clean cache entry. The mtime and
309 * length match the cache, and other stat fields do not change.
311 * We could detect this at update-index time (the cache entry
312 * being registered/updated records the same time as "now")
313 * and delay the return from git-update-index, but that would
314 * effectively mean we can make at most one commit per second,
315 * which is not acceptable. Instead, we check cache entries
316 * whose mtime are the same as the index file timestamp more
317 * carefully than others.
319 if (!changed && is_racy_timestamp(istate, ce)) {
320 if (assume_racy_is_modified)
321 changed |= DATA_CHANGED;
322 else
323 changed |= ce_modified_check_fs(ce, st);
326 return changed;
329 int ie_modified(const struct index_state *istate,
330 const struct cache_entry *ce,
331 struct stat *st, unsigned int options)
333 int changed, changed_fs;
335 changed = ie_match_stat(istate, ce, st, options);
336 if (!changed)
337 return 0;
339 * If the mode or type has changed, there's no point in trying
340 * to refresh the entry - it's not going to match
342 if (changed & (MODE_CHANGED | TYPE_CHANGED))
343 return changed;
346 * Immediately after read-tree or update-index --cacheinfo,
347 * the length field is zero, as we have never even read the
348 * lstat(2) information once, and we cannot trust DATA_CHANGED
349 * returned by ie_match_stat() which in turn was returned by
350 * ce_match_stat_basic() to signal that the filesize of the
351 * blob changed. We have to actually go to the filesystem to
352 * see if the contents match, and if so, should answer "unchanged".
354 * The logic does not apply to gitlinks, as ce_match_stat_basic()
355 * already has checked the actual HEAD from the filesystem in the
356 * subproject. If ie_match_stat() already said it is different,
357 * then we know it is.
359 if ((changed & DATA_CHANGED) &&
360 (S_ISGITLINK(ce->ce_mode) || ce->ce_stat_data.sd_size != 0))
361 return changed;
363 changed_fs = ce_modified_check_fs(ce, st);
364 if (changed_fs)
365 return changed | changed_fs;
366 return 0;
369 int base_name_compare(const char *name1, int len1, int mode1,
370 const char *name2, int len2, int mode2)
372 unsigned char c1, c2;
373 int len = len1 < len2 ? len1 : len2;
374 int cmp;
376 cmp = memcmp(name1, name2, len);
377 if (cmp)
378 return cmp;
379 c1 = name1[len];
380 c2 = name2[len];
381 if (!c1 && S_ISDIR(mode1))
382 c1 = '/';
383 if (!c2 && S_ISDIR(mode2))
384 c2 = '/';
385 return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
389 * df_name_compare() is identical to base_name_compare(), except it
390 * compares conflicting directory/file entries as equal. Note that
391 * while a directory name compares as equal to a regular file, they
392 * then individually compare _differently_ to a filename that has
393 * a dot after the basename (because '\0' < '.' < '/').
395 * This is used by routines that want to traverse the git namespace
396 * but then handle conflicting entries together when possible.
398 int df_name_compare(const char *name1, int len1, int mode1,
399 const char *name2, int len2, int mode2)
401 int len = len1 < len2 ? len1 : len2, cmp;
402 unsigned char c1, c2;
404 cmp = memcmp(name1, name2, len);
405 if (cmp)
406 return cmp;
407 /* Directories and files compare equal (same length, same name) */
408 if (len1 == len2)
409 return 0;
410 c1 = name1[len];
411 if (!c1 && S_ISDIR(mode1))
412 c1 = '/';
413 c2 = name2[len];
414 if (!c2 && S_ISDIR(mode2))
415 c2 = '/';
416 if (c1 == '/' && !c2)
417 return 0;
418 if (c2 == '/' && !c1)
419 return 0;
420 return c1 - c2;
423 int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2)
425 int len = len1 < len2 ? len1 : len2;
426 int cmp;
428 cmp = memcmp(name1, name2, len);
429 if (cmp)
430 return cmp;
431 if (len1 < len2)
432 return -1;
433 if (len1 > len2)
434 return 1;
436 if (stage1 < stage2)
437 return -1;
438 if (stage1 > stage2)
439 return 1;
440 return 0;
443 int cache_name_compare(const char *name1, int len1, const char *name2, int len2)
445 return cache_name_stage_compare(name1, len1, 0, name2, len2, 0);
448 static int index_name_stage_pos(const struct index_state *istate, const char *name, int namelen, int stage)
450 int first, last;
452 first = 0;
453 last = istate->cache_nr;
454 while (last > first) {
455 int next = (last + first) >> 1;
456 struct cache_entry *ce = istate->cache[next];
457 int cmp = cache_name_stage_compare(name, namelen, stage, ce->name, ce_namelen(ce), ce_stage(ce));
458 if (!cmp)
459 return next;
460 if (cmp < 0) {
461 last = next;
462 continue;
464 first = next+1;
466 return -first-1;
469 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
471 return index_name_stage_pos(istate, name, namelen, 0);
474 /* Remove entry, return true if there are more entries to go.. */
475 int remove_index_entry_at(struct index_state *istate, int pos)
477 struct cache_entry *ce = istate->cache[pos];
479 record_resolve_undo(istate, ce);
480 remove_name_hash(istate, ce);
481 istate->cache_changed = 1;
482 istate->cache_nr--;
483 if (pos >= istate->cache_nr)
484 return 0;
485 memmove(istate->cache + pos,
486 istate->cache + pos + 1,
487 (istate->cache_nr - pos) * sizeof(struct cache_entry *));
488 return 1;
492 * Remove all cache entries marked for removal, that is where
493 * CE_REMOVE is set in ce_flags. This is much more effective than
494 * calling remove_index_entry_at() for each entry to be removed.
496 void remove_marked_cache_entries(struct index_state *istate)
498 struct cache_entry **ce_array = istate->cache;
499 unsigned int i, j;
501 for (i = j = 0; i < istate->cache_nr; i++) {
502 if (ce_array[i]->ce_flags & CE_REMOVE)
503 remove_name_hash(istate, ce_array[i]);
504 else
505 ce_array[j++] = ce_array[i];
507 istate->cache_changed = 1;
508 istate->cache_nr = j;
511 int remove_file_from_index(struct index_state *istate, const char *path)
513 int pos = index_name_pos(istate, path, strlen(path));
514 if (pos < 0)
515 pos = -pos-1;
516 cache_tree_invalidate_path(istate->cache_tree, path);
517 while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
518 remove_index_entry_at(istate, pos);
519 return 0;
522 static int compare_name(struct cache_entry *ce, const char *path, int namelen)
524 return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
527 static int index_name_pos_also_unmerged(struct index_state *istate,
528 const char *path, int namelen)
530 int pos = index_name_pos(istate, path, namelen);
531 struct cache_entry *ce;
533 if (pos >= 0)
534 return pos;
536 /* maybe unmerged? */
537 pos = -1 - pos;
538 if (pos >= istate->cache_nr ||
539 compare_name((ce = istate->cache[pos]), path, namelen))
540 return -1;
542 /* order of preference: stage 2, 1, 3 */
543 if (ce_stage(ce) == 1 && pos + 1 < istate->cache_nr &&
544 ce_stage((ce = istate->cache[pos + 1])) == 2 &&
545 !compare_name(ce, path, namelen))
546 pos++;
547 return pos;
550 static int different_name(struct cache_entry *ce, struct cache_entry *alias)
552 int len = ce_namelen(ce);
553 return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
557 * If we add a filename that aliases in the cache, we will use the
558 * name that we already have - but we don't want to update the same
559 * alias twice, because that implies that there were actually two
560 * different files with aliasing names!
562 * So we use the CE_ADDED flag to verify that the alias was an old
563 * one before we accept it as
565 static struct cache_entry *create_alias_ce(struct cache_entry *ce, struct cache_entry *alias)
567 int len;
568 struct cache_entry *new;
570 if (alias->ce_flags & CE_ADDED)
571 die("Will not add file alias '%s' ('%s' already exists in index)", ce->name, alias->name);
573 /* Ok, create the new entry using the name of the existing alias */
574 len = ce_namelen(alias);
575 new = xcalloc(1, cache_entry_size(len));
576 memcpy(new->name, alias->name, len);
577 copy_cache_entry(new, ce);
578 free(ce);
579 return new;
582 static void record_intent_to_add(struct cache_entry *ce)
584 unsigned char sha1[20];
585 if (write_sha1_file("", 0, blob_type, sha1))
586 die("cannot create an empty blob in the object database");
587 hashcpy(ce->sha1, sha1);
590 int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
592 int size, namelen, was_same;
593 mode_t st_mode = st->st_mode;
594 struct cache_entry *ce, *alias;
595 unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
596 int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
597 int pretend = flags & ADD_CACHE_PRETEND;
598 int intent_only = flags & ADD_CACHE_INTENT;
599 int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
600 (intent_only ? ADD_CACHE_NEW_ONLY : 0));
602 if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
603 return error("%s: can only add regular files, symbolic links or git-directories", path);
605 namelen = strlen(path);
606 if (S_ISDIR(st_mode)) {
607 while (namelen && path[namelen-1] == '/')
608 namelen--;
610 size = cache_entry_size(namelen);
611 ce = xcalloc(1, size);
612 memcpy(ce->name, path, namelen);
613 ce->ce_namelen = namelen;
614 if (!intent_only)
615 fill_stat_cache_info(ce, st);
616 else
617 ce->ce_flags |= CE_INTENT_TO_ADD;
619 if (trust_executable_bit && has_symlinks)
620 ce->ce_mode = create_ce_mode(st_mode);
621 else {
622 /* If there is an existing entry, pick the mode bits and type
623 * from it, otherwise assume unexecutable regular file.
625 struct cache_entry *ent;
626 int pos = index_name_pos_also_unmerged(istate, path, namelen);
628 ent = (0 <= pos) ? istate->cache[pos] : NULL;
629 ce->ce_mode = ce_mode_from_stat(ent, st_mode);
632 /* When core.ignorecase=true, determine if a directory of the same name but differing
633 * case already exists within the Git repository. If it does, ensure the directory
634 * case of the file being added to the repository matches (is folded into) the existing
635 * entry's directory case.
637 if (ignore_case) {
638 const char *startPtr = ce->name;
639 const char *ptr = startPtr;
640 while (*ptr) {
641 while (*ptr && *ptr != '/')
642 ++ptr;
643 if (*ptr == '/') {
644 struct cache_entry *foundce;
645 ++ptr;
646 foundce = index_dir_exists(istate, ce->name, ptr - ce->name - 1);
647 if (foundce) {
648 memcpy((void *)startPtr, foundce->name + (startPtr - ce->name), ptr - startPtr);
649 startPtr = ptr;
655 alias = index_file_exists(istate, ce->name, ce_namelen(ce), ignore_case);
656 if (alias && !ce_stage(alias) && !ie_match_stat(istate, alias, st, ce_option)) {
657 /* Nothing changed, really */
658 free(ce);
659 if (!S_ISGITLINK(alias->ce_mode))
660 ce_mark_uptodate(alias);
661 alias->ce_flags |= CE_ADDED;
662 return 0;
664 if (!intent_only) {
665 if (index_path(ce->sha1, path, st, HASH_WRITE_OBJECT))
666 return error("unable to index file %s", path);
667 } else
668 record_intent_to_add(ce);
670 if (ignore_case && alias && different_name(ce, alias))
671 ce = create_alias_ce(ce, alias);
672 ce->ce_flags |= CE_ADDED;
674 /* It was suspected to be racily clean, but it turns out to be Ok */
675 was_same = (alias &&
676 !ce_stage(alias) &&
677 !hashcmp(alias->sha1, ce->sha1) &&
678 ce->ce_mode == alias->ce_mode);
680 if (pretend)
682 else if (add_index_entry(istate, ce, add_option))
683 return error("unable to add %s to index",path);
684 if (verbose && !was_same)
685 printf("add '%s'\n", path);
686 return 0;
689 int add_file_to_index(struct index_state *istate, const char *path, int flags)
691 struct stat st;
692 if (lstat(path, &st))
693 die_errno("unable to stat '%s'", path);
694 return add_to_index(istate, path, &st, flags);
697 struct cache_entry *make_cache_entry(unsigned int mode,
698 const unsigned char *sha1, const char *path, int stage,
699 int refresh)
701 int size, len;
702 struct cache_entry *ce;
704 if (!verify_path(path)) {
705 error("Invalid path '%s'", path);
706 return NULL;
709 len = strlen(path);
710 size = cache_entry_size(len);
711 ce = xcalloc(1, size);
713 hashcpy(ce->sha1, sha1);
714 memcpy(ce->name, path, len);
715 ce->ce_flags = create_ce_flags(stage);
716 ce->ce_namelen = len;
717 ce->ce_mode = create_ce_mode(mode);
719 if (refresh)
720 return refresh_cache_entry(ce, 0);
722 return ce;
725 int ce_same_name(const struct cache_entry *a, const struct cache_entry *b)
727 int len = ce_namelen(a);
728 return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
732 * We fundamentally don't like some paths: we don't want
733 * dot or dot-dot anywhere, and for obvious reasons don't
734 * want to recurse into ".git" either.
736 * Also, we don't want double slashes or slashes at the
737 * end that can make pathnames ambiguous.
739 static int verify_dotfile(const char *rest)
742 * The first character was '.', but that
743 * has already been discarded, we now test
744 * the rest.
747 /* "." is not allowed */
748 if (*rest == '\0' || is_dir_sep(*rest))
749 return 0;
751 switch (*rest) {
753 * ".git" followed by NUL or slash is bad. This
754 * shares the path end test with the ".." case.
756 case 'g':
757 if (rest[1] != 'i')
758 break;
759 if (rest[2] != 't')
760 break;
761 rest += 2;
762 /* fallthrough */
763 case '.':
764 if (rest[1] == '\0' || is_dir_sep(rest[1]))
765 return 0;
767 return 1;
770 int verify_path(const char *path)
772 char c;
774 if (has_dos_drive_prefix(path))
775 return 0;
777 goto inside;
778 for (;;) {
779 if (!c)
780 return 1;
781 if (is_dir_sep(c)) {
782 inside:
783 c = *path++;
784 if ((c == '.' && !verify_dotfile(path)) ||
785 is_dir_sep(c) || c == '\0')
786 return 0;
788 c = *path++;
793 * Do we have another file that has the beginning components being a
794 * proper superset of the name we're trying to add?
796 static int has_file_name(struct index_state *istate,
797 const struct cache_entry *ce, int pos, int ok_to_replace)
799 int retval = 0;
800 int len = ce_namelen(ce);
801 int stage = ce_stage(ce);
802 const char *name = ce->name;
804 while (pos < istate->cache_nr) {
805 struct cache_entry *p = istate->cache[pos++];
807 if (len >= ce_namelen(p))
808 break;
809 if (memcmp(name, p->name, len))
810 break;
811 if (ce_stage(p) != stage)
812 continue;
813 if (p->name[len] != '/')
814 continue;
815 if (p->ce_flags & CE_REMOVE)
816 continue;
817 retval = -1;
818 if (!ok_to_replace)
819 break;
820 remove_index_entry_at(istate, --pos);
822 return retval;
826 * Do we have another file with a pathname that is a proper
827 * subset of the name we're trying to add?
829 static int has_dir_name(struct index_state *istate,
830 const struct cache_entry *ce, int pos, int ok_to_replace)
832 int retval = 0;
833 int stage = ce_stage(ce);
834 const char *name = ce->name;
835 const char *slash = name + ce_namelen(ce);
837 for (;;) {
838 int len;
840 for (;;) {
841 if (*--slash == '/')
842 break;
843 if (slash <= ce->name)
844 return retval;
846 len = slash - name;
848 pos = index_name_stage_pos(istate, name, len, stage);
849 if (pos >= 0) {
851 * Found one, but not so fast. This could
852 * be a marker that says "I was here, but
853 * I am being removed". Such an entry is
854 * not a part of the resulting tree, and
855 * it is Ok to have a directory at the same
856 * path.
858 if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
859 retval = -1;
860 if (!ok_to_replace)
861 break;
862 remove_index_entry_at(istate, pos);
863 continue;
866 else
867 pos = -pos-1;
870 * Trivial optimization: if we find an entry that
871 * already matches the sub-directory, then we know
872 * we're ok, and we can exit.
874 while (pos < istate->cache_nr) {
875 struct cache_entry *p = istate->cache[pos];
876 if ((ce_namelen(p) <= len) ||
877 (p->name[len] != '/') ||
878 memcmp(p->name, name, len))
879 break; /* not our subdirectory */
880 if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
882 * p is at the same stage as our entry, and
883 * is a subdirectory of what we are looking
884 * at, so we cannot have conflicts at our
885 * level or anything shorter.
887 return retval;
888 pos++;
891 return retval;
894 /* We may be in a situation where we already have path/file and path
895 * is being added, or we already have path and path/file is being
896 * added. Either one would result in a nonsense tree that has path
897 * twice when git-write-tree tries to write it out. Prevent it.
899 * If ok-to-replace is specified, we remove the conflicting entries
900 * from the cache so the caller should recompute the insert position.
901 * When this happens, we return non-zero.
903 static int check_file_directory_conflict(struct index_state *istate,
904 const struct cache_entry *ce,
905 int pos, int ok_to_replace)
907 int retval;
910 * When ce is an "I am going away" entry, we allow it to be added
912 if (ce->ce_flags & CE_REMOVE)
913 return 0;
916 * We check if the path is a sub-path of a subsequent pathname
917 * first, since removing those will not change the position
918 * in the array.
920 retval = has_file_name(istate, ce, pos, ok_to_replace);
923 * Then check if the path might have a clashing sub-directory
924 * before it.
926 return retval + has_dir_name(istate, ce, pos, ok_to_replace);
929 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
931 int pos;
932 int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
933 int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
934 int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
935 int new_only = option & ADD_CACHE_NEW_ONLY;
937 cache_tree_invalidate_path(istate->cache_tree, ce->name);
938 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
940 /* existing match? Just replace it. */
941 if (pos >= 0) {
942 if (!new_only)
943 replace_index_entry(istate, pos, ce);
944 return 0;
946 pos = -pos-1;
949 * Inserting a merged entry ("stage 0") into the index
950 * will always replace all non-merged entries..
952 if (pos < istate->cache_nr && ce_stage(ce) == 0) {
953 while (ce_same_name(istate->cache[pos], ce)) {
954 ok_to_add = 1;
955 if (!remove_index_entry_at(istate, pos))
956 break;
960 if (!ok_to_add)
961 return -1;
962 if (!verify_path(ce->name))
963 return error("Invalid path '%s'", ce->name);
965 if (!skip_df_check &&
966 check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
967 if (!ok_to_replace)
968 return error("'%s' appears as both a file and as a directory",
969 ce->name);
970 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
971 pos = -pos-1;
973 return pos + 1;
976 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
978 int pos;
980 if (option & ADD_CACHE_JUST_APPEND)
981 pos = istate->cache_nr;
982 else {
983 int ret;
984 ret = add_index_entry_with_check(istate, ce, option);
985 if (ret <= 0)
986 return ret;
987 pos = ret - 1;
990 /* Make sure the array is big enough .. */
991 if (istate->cache_nr == istate->cache_alloc) {
992 istate->cache_alloc = alloc_nr(istate->cache_alloc);
993 istate->cache = xrealloc(istate->cache,
994 istate->cache_alloc * sizeof(*istate->cache));
997 /* Add it in.. */
998 istate->cache_nr++;
999 if (istate->cache_nr > pos + 1)
1000 memmove(istate->cache + pos + 1,
1001 istate->cache + pos,
1002 (istate->cache_nr - pos - 1) * sizeof(ce));
1003 set_index_entry(istate, pos, ce);
1004 istate->cache_changed = 1;
1005 return 0;
1009 * "refresh" does not calculate a new sha1 file or bring the
1010 * cache up-to-date for mode/content changes. But what it
1011 * _does_ do is to "re-match" the stat information of a file
1012 * with the cache, so that you can refresh the cache for a
1013 * file that hasn't been changed but where the stat entry is
1014 * out of date.
1016 * For example, you'd want to do this after doing a "git-read-tree",
1017 * to link up the stat cache details with the proper files.
1019 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1020 struct cache_entry *ce,
1021 unsigned int options, int *err,
1022 int *changed_ret)
1024 struct stat st;
1025 struct cache_entry *updated;
1026 int changed, size;
1027 int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1028 int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1030 if (ce_uptodate(ce))
1031 return ce;
1034 * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1035 * that the change to the work tree does not matter and told
1036 * us not to worry.
1038 if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1039 ce_mark_uptodate(ce);
1040 return ce;
1042 if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1043 ce_mark_uptodate(ce);
1044 return ce;
1047 if (lstat(ce->name, &st) < 0) {
1048 if (err)
1049 *err = errno;
1050 return NULL;
1053 changed = ie_match_stat(istate, ce, &st, options);
1054 if (changed_ret)
1055 *changed_ret = changed;
1056 if (!changed) {
1058 * The path is unchanged. If we were told to ignore
1059 * valid bit, then we did the actual stat check and
1060 * found that the entry is unmodified. If the entry
1061 * is not marked VALID, this is the place to mark it
1062 * valid again, under "assume unchanged" mode.
1064 if (ignore_valid && assume_unchanged &&
1065 !(ce->ce_flags & CE_VALID))
1066 ; /* mark this one VALID again */
1067 else {
1069 * We do not mark the index itself "modified"
1070 * because CE_UPTODATE flag is in-core only;
1071 * we are not going to write this change out.
1073 if (!S_ISGITLINK(ce->ce_mode))
1074 ce_mark_uptodate(ce);
1075 return ce;
1079 if (ie_modified(istate, ce, &st, options)) {
1080 if (err)
1081 *err = EINVAL;
1082 return NULL;
1085 size = ce_size(ce);
1086 updated = xmalloc(size);
1087 memcpy(updated, ce, size);
1088 fill_stat_cache_info(updated, &st);
1090 * If ignore_valid is not set, we should leave CE_VALID bit
1091 * alone. Otherwise, paths marked with --no-assume-unchanged
1092 * (i.e. things to be edited) will reacquire CE_VALID bit
1093 * automatically, which is not really what we want.
1095 if (!ignore_valid && assume_unchanged &&
1096 !(ce->ce_flags & CE_VALID))
1097 updated->ce_flags &= ~CE_VALID;
1099 return updated;
1102 static void show_file(const char * fmt, const char * name, int in_porcelain,
1103 int * first, const char *header_msg)
1105 if (in_porcelain && *first && header_msg) {
1106 printf("%s\n", header_msg);
1107 *first = 0;
1109 printf(fmt, name);
1112 int refresh_index(struct index_state *istate, unsigned int flags,
1113 const struct pathspec *pathspec,
1114 char *seen, const char *header_msg)
1116 int i;
1117 int has_errors = 0;
1118 int really = (flags & REFRESH_REALLY) != 0;
1119 int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1120 int quiet = (flags & REFRESH_QUIET) != 0;
1121 int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1122 int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1123 int first = 1;
1124 int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1125 unsigned int options = really ? CE_MATCH_IGNORE_VALID : 0;
1126 const char *modified_fmt;
1127 const char *deleted_fmt;
1128 const char *typechange_fmt;
1129 const char *added_fmt;
1130 const char *unmerged_fmt;
1132 modified_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1133 deleted_fmt = (in_porcelain ? "D\t%s\n" : "%s: needs update\n");
1134 typechange_fmt = (in_porcelain ? "T\t%s\n" : "%s needs update\n");
1135 added_fmt = (in_porcelain ? "A\t%s\n" : "%s needs update\n");
1136 unmerged_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1137 for (i = 0; i < istate->cache_nr; i++) {
1138 struct cache_entry *ce, *new;
1139 int cache_errno = 0;
1140 int changed = 0;
1141 int filtered = 0;
1143 ce = istate->cache[i];
1144 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1145 continue;
1147 if (pathspec && !ce_path_match(ce, pathspec, seen))
1148 filtered = 1;
1150 if (ce_stage(ce)) {
1151 while ((i < istate->cache_nr) &&
1152 ! strcmp(istate->cache[i]->name, ce->name))
1153 i++;
1154 i--;
1155 if (allow_unmerged)
1156 continue;
1157 if (!filtered)
1158 show_file(unmerged_fmt, ce->name, in_porcelain,
1159 &first, header_msg);
1160 has_errors = 1;
1161 continue;
1164 if (filtered)
1165 continue;
1167 new = refresh_cache_ent(istate, ce, options, &cache_errno, &changed);
1168 if (new == ce)
1169 continue;
1170 if (!new) {
1171 const char *fmt;
1173 if (not_new && cache_errno == ENOENT)
1174 continue;
1175 if (really && cache_errno == EINVAL) {
1176 /* If we are doing --really-refresh that
1177 * means the index is not valid anymore.
1179 ce->ce_flags &= ~CE_VALID;
1180 istate->cache_changed = 1;
1182 if (quiet)
1183 continue;
1185 if (cache_errno == ENOENT)
1186 fmt = deleted_fmt;
1187 else if (ce->ce_flags & CE_INTENT_TO_ADD)
1188 fmt = added_fmt; /* must be before other checks */
1189 else if (changed & TYPE_CHANGED)
1190 fmt = typechange_fmt;
1191 else
1192 fmt = modified_fmt;
1193 show_file(fmt,
1194 ce->name, in_porcelain, &first, header_msg);
1195 has_errors = 1;
1196 continue;
1199 replace_index_entry(istate, i, new);
1201 return has_errors;
1204 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really)
1206 return refresh_cache_ent(&the_index, ce, really, NULL, NULL);
1210 /*****************************************************************
1211 * Index File I/O
1212 *****************************************************************/
1214 #define INDEX_FORMAT_DEFAULT 3
1217 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1218 * Again - this is just a (very strong in practice) heuristic that
1219 * the inode hasn't changed.
1221 * We save the fields in big-endian order to allow using the
1222 * index file over NFS transparently.
1224 struct ondisk_cache_entry {
1225 struct cache_time ctime;
1226 struct cache_time mtime;
1227 uint32_t dev;
1228 uint32_t ino;
1229 uint32_t mode;
1230 uint32_t uid;
1231 uint32_t gid;
1232 uint32_t size;
1233 unsigned char sha1[20];
1234 uint16_t flags;
1235 char name[FLEX_ARRAY]; /* more */
1239 * This struct is used when CE_EXTENDED bit is 1
1240 * The struct must match ondisk_cache_entry exactly from
1241 * ctime till flags
1243 struct ondisk_cache_entry_extended {
1244 struct cache_time ctime;
1245 struct cache_time mtime;
1246 uint32_t dev;
1247 uint32_t ino;
1248 uint32_t mode;
1249 uint32_t uid;
1250 uint32_t gid;
1251 uint32_t size;
1252 unsigned char sha1[20];
1253 uint16_t flags;
1254 uint16_t flags2;
1255 char name[FLEX_ARRAY]; /* more */
1258 /* These are only used for v3 or lower */
1259 #define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
1260 #define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1261 #define ondisk_cache_entry_extended_size(len) align_flex_name(ondisk_cache_entry_extended,len)
1262 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
1263 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
1264 ondisk_cache_entry_size(ce_namelen(ce)))
1266 static int verify_hdr(struct cache_header *hdr, unsigned long size)
1268 git_SHA_CTX c;
1269 unsigned char sha1[20];
1270 int hdr_version;
1272 if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1273 return error("bad signature");
1274 hdr_version = ntohl(hdr->hdr_version);
1275 if (hdr_version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < hdr_version)
1276 return error("bad index version %d", hdr_version);
1277 git_SHA1_Init(&c);
1278 git_SHA1_Update(&c, hdr, size - 20);
1279 git_SHA1_Final(sha1, &c);
1280 if (hashcmp(sha1, (unsigned char *)hdr + size - 20))
1281 return error("bad index file sha1 signature");
1282 return 0;
1285 static int read_index_extension(struct index_state *istate,
1286 const char *ext, void *data, unsigned long sz)
1288 switch (CACHE_EXT(ext)) {
1289 case CACHE_EXT_TREE:
1290 istate->cache_tree = cache_tree_read(data, sz);
1291 break;
1292 case CACHE_EXT_RESOLVE_UNDO:
1293 istate->resolve_undo = resolve_undo_read(data, sz);
1294 break;
1295 default:
1296 if (*ext < 'A' || 'Z' < *ext)
1297 return error("index uses %.4s extension, which we do not understand",
1298 ext);
1299 fprintf(stderr, "ignoring %.4s extension\n", ext);
1300 break;
1302 return 0;
1305 int read_index(struct index_state *istate)
1307 return read_index_from(istate, get_index_file());
1310 #ifndef NEEDS_ALIGNED_ACCESS
1311 #define ntoh_s(var) ntohs(var)
1312 #define ntoh_l(var) ntohl(var)
1313 #else
1314 static inline uint16_t ntoh_s_force_align(void *p)
1316 uint16_t x;
1317 memcpy(&x, p, sizeof(x));
1318 return ntohs(x);
1320 static inline uint32_t ntoh_l_force_align(void *p)
1322 uint32_t x;
1323 memcpy(&x, p, sizeof(x));
1324 return ntohl(x);
1326 #define ntoh_s(var) ntoh_s_force_align(&(var))
1327 #define ntoh_l(var) ntoh_l_force_align(&(var))
1328 #endif
1330 static struct cache_entry *cache_entry_from_ondisk(struct ondisk_cache_entry *ondisk,
1331 unsigned int flags,
1332 const char *name,
1333 size_t len)
1335 struct cache_entry *ce = xmalloc(cache_entry_size(len));
1337 ce->ce_stat_data.sd_ctime.sec = ntoh_l(ondisk->ctime.sec);
1338 ce->ce_stat_data.sd_mtime.sec = ntoh_l(ondisk->mtime.sec);
1339 ce->ce_stat_data.sd_ctime.nsec = ntoh_l(ondisk->ctime.nsec);
1340 ce->ce_stat_data.sd_mtime.nsec = ntoh_l(ondisk->mtime.nsec);
1341 ce->ce_stat_data.sd_dev = ntoh_l(ondisk->dev);
1342 ce->ce_stat_data.sd_ino = ntoh_l(ondisk->ino);
1343 ce->ce_mode = ntoh_l(ondisk->mode);
1344 ce->ce_stat_data.sd_uid = ntoh_l(ondisk->uid);
1345 ce->ce_stat_data.sd_gid = ntoh_l(ondisk->gid);
1346 ce->ce_stat_data.sd_size = ntoh_l(ondisk->size);
1347 ce->ce_flags = flags & ~CE_NAMEMASK;
1348 ce->ce_namelen = len;
1349 hashcpy(ce->sha1, ondisk->sha1);
1350 memcpy(ce->name, name, len);
1351 ce->name[len] = '\0';
1352 return ce;
1356 * Adjacent cache entries tend to share the leading paths, so it makes
1357 * sense to only store the differences in later entries. In the v4
1358 * on-disk format of the index, each on-disk cache entry stores the
1359 * number of bytes to be stripped from the end of the previous name,
1360 * and the bytes to append to the result, to come up with its name.
1362 static unsigned long expand_name_field(struct strbuf *name, const char *cp_)
1364 const unsigned char *ep, *cp = (const unsigned char *)cp_;
1365 size_t len = decode_varint(&cp);
1367 if (name->len < len)
1368 die("malformed name field in the index");
1369 strbuf_remove(name, name->len - len, len);
1370 for (ep = cp; *ep; ep++)
1371 ; /* find the end */
1372 strbuf_add(name, cp, ep - cp);
1373 return (const char *)ep + 1 - cp_;
1376 static struct cache_entry *create_from_disk(struct ondisk_cache_entry *ondisk,
1377 unsigned long *ent_size,
1378 struct strbuf *previous_name)
1380 struct cache_entry *ce;
1381 size_t len;
1382 const char *name;
1383 unsigned int flags;
1385 /* On-disk flags are just 16 bits */
1386 flags = ntoh_s(ondisk->flags);
1387 len = flags & CE_NAMEMASK;
1389 if (flags & CE_EXTENDED) {
1390 struct ondisk_cache_entry_extended *ondisk2;
1391 int extended_flags;
1392 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1393 extended_flags = ntoh_s(ondisk2->flags2) << 16;
1394 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1395 if (extended_flags & ~CE_EXTENDED_FLAGS)
1396 die("Unknown index entry format %08x", extended_flags);
1397 flags |= extended_flags;
1398 name = ondisk2->name;
1400 else
1401 name = ondisk->name;
1403 if (!previous_name) {
1404 /* v3 and earlier */
1405 if (len == CE_NAMEMASK)
1406 len = strlen(name);
1407 ce = cache_entry_from_ondisk(ondisk, flags, name, len);
1409 *ent_size = ondisk_ce_size(ce);
1410 } else {
1411 unsigned long consumed;
1412 consumed = expand_name_field(previous_name, name);
1413 ce = cache_entry_from_ondisk(ondisk, flags,
1414 previous_name->buf,
1415 previous_name->len);
1417 *ent_size = (name - ((char *)ondisk)) + consumed;
1419 return ce;
1422 /* remember to discard_cache() before reading a different cache! */
1423 int read_index_from(struct index_state *istate, const char *path)
1425 int fd, i;
1426 struct stat st;
1427 unsigned long src_offset;
1428 struct cache_header *hdr;
1429 void *mmap;
1430 size_t mmap_size;
1431 struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
1433 if (istate->initialized)
1434 return istate->cache_nr;
1436 istate->timestamp.sec = 0;
1437 istate->timestamp.nsec = 0;
1438 fd = open(path, O_RDONLY);
1439 if (fd < 0) {
1440 if (errno == ENOENT)
1441 return 0;
1442 die_errno("index file open failed");
1445 if (fstat(fd, &st))
1446 die_errno("cannot stat the open index");
1448 mmap_size = xsize_t(st.st_size);
1449 if (mmap_size < sizeof(struct cache_header) + 20)
1450 die("index file smaller than expected");
1452 mmap = xmmap(NULL, mmap_size, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0);
1453 if (mmap == MAP_FAILED)
1454 die_errno("unable to map index file");
1455 close(fd);
1457 hdr = mmap;
1458 if (verify_hdr(hdr, mmap_size) < 0)
1459 goto unmap;
1461 istate->version = ntohl(hdr->hdr_version);
1462 istate->cache_nr = ntohl(hdr->hdr_entries);
1463 istate->cache_alloc = alloc_nr(istate->cache_nr);
1464 istate->cache = xcalloc(istate->cache_alloc, sizeof(*istate->cache));
1465 istate->initialized = 1;
1467 if (istate->version == 4)
1468 previous_name = &previous_name_buf;
1469 else
1470 previous_name = NULL;
1472 src_offset = sizeof(*hdr);
1473 for (i = 0; i < istate->cache_nr; i++) {
1474 struct ondisk_cache_entry *disk_ce;
1475 struct cache_entry *ce;
1476 unsigned long consumed;
1478 disk_ce = (struct ondisk_cache_entry *)((char *)mmap + src_offset);
1479 ce = create_from_disk(disk_ce, &consumed, previous_name);
1480 set_index_entry(istate, i, ce);
1482 src_offset += consumed;
1484 strbuf_release(&previous_name_buf);
1485 istate->timestamp.sec = st.st_mtime;
1486 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1488 while (src_offset <= mmap_size - 20 - 8) {
1489 /* After an array of active_nr index entries,
1490 * there can be arbitrary number of extended
1491 * sections, each of which is prefixed with
1492 * extension name (4-byte) and section length
1493 * in 4-byte network byte order.
1495 uint32_t extsize;
1496 memcpy(&extsize, (char *)mmap + src_offset + 4, 4);
1497 extsize = ntohl(extsize);
1498 if (read_index_extension(istate,
1499 (const char *) mmap + src_offset,
1500 (char *) mmap + src_offset + 8,
1501 extsize) < 0)
1502 goto unmap;
1503 src_offset += 8;
1504 src_offset += extsize;
1506 munmap(mmap, mmap_size);
1507 return istate->cache_nr;
1509 unmap:
1510 munmap(mmap, mmap_size);
1511 die("index file corrupt");
1514 int is_index_unborn(struct index_state *istate)
1516 return (!istate->cache_nr && !istate->timestamp.sec);
1519 int discard_index(struct index_state *istate)
1521 int i;
1523 for (i = 0; i < istate->cache_nr; i++)
1524 free(istate->cache[i]);
1525 resolve_undo_clear_index(istate);
1526 istate->cache_nr = 0;
1527 istate->cache_changed = 0;
1528 istate->timestamp.sec = 0;
1529 istate->timestamp.nsec = 0;
1530 free_name_hash(istate);
1531 cache_tree_free(&(istate->cache_tree));
1532 istate->initialized = 0;
1533 free(istate->cache);
1534 istate->cache = NULL;
1535 istate->cache_alloc = 0;
1536 return 0;
1539 int unmerged_index(const struct index_state *istate)
1541 int i;
1542 for (i = 0; i < istate->cache_nr; i++) {
1543 if (ce_stage(istate->cache[i]))
1544 return 1;
1546 return 0;
1549 #define WRITE_BUFFER_SIZE 8192
1550 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
1551 static unsigned long write_buffer_len;
1553 static int ce_write_flush(git_SHA_CTX *context, int fd)
1555 unsigned int buffered = write_buffer_len;
1556 if (buffered) {
1557 git_SHA1_Update(context, write_buffer, buffered);
1558 if (write_in_full(fd, write_buffer, buffered) != buffered)
1559 return -1;
1560 write_buffer_len = 0;
1562 return 0;
1565 static int ce_write(git_SHA_CTX *context, int fd, void *data, unsigned int len)
1567 while (len) {
1568 unsigned int buffered = write_buffer_len;
1569 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
1570 if (partial > len)
1571 partial = len;
1572 memcpy(write_buffer + buffered, data, partial);
1573 buffered += partial;
1574 if (buffered == WRITE_BUFFER_SIZE) {
1575 write_buffer_len = buffered;
1576 if (ce_write_flush(context, fd))
1577 return -1;
1578 buffered = 0;
1580 write_buffer_len = buffered;
1581 len -= partial;
1582 data = (char *) data + partial;
1584 return 0;
1587 static int write_index_ext_header(git_SHA_CTX *context, int fd,
1588 unsigned int ext, unsigned int sz)
1590 ext = htonl(ext);
1591 sz = htonl(sz);
1592 return ((ce_write(context, fd, &ext, 4) < 0) ||
1593 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
1596 static int ce_flush(git_SHA_CTX *context, int fd)
1598 unsigned int left = write_buffer_len;
1600 if (left) {
1601 write_buffer_len = 0;
1602 git_SHA1_Update(context, write_buffer, left);
1605 /* Flush first if not enough space for SHA1 signature */
1606 if (left + 20 > WRITE_BUFFER_SIZE) {
1607 if (write_in_full(fd, write_buffer, left) != left)
1608 return -1;
1609 left = 0;
1612 /* Append the SHA1 signature at the end */
1613 git_SHA1_Final(write_buffer + left, context);
1614 left += 20;
1615 return (write_in_full(fd, write_buffer, left) != left) ? -1 : 0;
1618 static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
1621 * The only thing we care about in this function is to smudge the
1622 * falsely clean entry due to touch-update-touch race, so we leave
1623 * everything else as they are. We are called for entries whose
1624 * ce_stat_data.sd_mtime match the index file mtime.
1626 * Note that this actually does not do much for gitlinks, for
1627 * which ce_match_stat_basic() always goes to the actual
1628 * contents. The caller checks with is_racy_timestamp() which
1629 * always says "no" for gitlinks, so we are not called for them ;-)
1631 struct stat st;
1633 if (lstat(ce->name, &st) < 0)
1634 return;
1635 if (ce_match_stat_basic(ce, &st))
1636 return;
1637 if (ce_modified_check_fs(ce, &st)) {
1638 /* This is "racily clean"; smudge it. Note that this
1639 * is a tricky code. At first glance, it may appear
1640 * that it can break with this sequence:
1642 * $ echo xyzzy >frotz
1643 * $ git-update-index --add frotz
1644 * $ : >frotz
1645 * $ sleep 3
1646 * $ echo filfre >nitfol
1647 * $ git-update-index --add nitfol
1649 * but it does not. When the second update-index runs,
1650 * it notices that the entry "frotz" has the same timestamp
1651 * as index, and if we were to smudge it by resetting its
1652 * size to zero here, then the object name recorded
1653 * in index is the 6-byte file but the cached stat information
1654 * becomes zero --- which would then match what we would
1655 * obtain from the filesystem next time we stat("frotz").
1657 * However, the second update-index, before calling
1658 * this function, notices that the cached size is 6
1659 * bytes and what is on the filesystem is an empty
1660 * file, and never calls us, so the cached size information
1661 * for "frotz" stays 6 which does not match the filesystem.
1663 ce->ce_stat_data.sd_size = 0;
1667 /* Copy miscellaneous fields but not the name */
1668 static char *copy_cache_entry_to_ondisk(struct ondisk_cache_entry *ondisk,
1669 struct cache_entry *ce)
1671 short flags;
1673 ondisk->ctime.sec = htonl(ce->ce_stat_data.sd_ctime.sec);
1674 ondisk->mtime.sec = htonl(ce->ce_stat_data.sd_mtime.sec);
1675 ondisk->ctime.nsec = htonl(ce->ce_stat_data.sd_ctime.nsec);
1676 ondisk->mtime.nsec = htonl(ce->ce_stat_data.sd_mtime.nsec);
1677 ondisk->dev = htonl(ce->ce_stat_data.sd_dev);
1678 ondisk->ino = htonl(ce->ce_stat_data.sd_ino);
1679 ondisk->mode = htonl(ce->ce_mode);
1680 ondisk->uid = htonl(ce->ce_stat_data.sd_uid);
1681 ondisk->gid = htonl(ce->ce_stat_data.sd_gid);
1682 ondisk->size = htonl(ce->ce_stat_data.sd_size);
1683 hashcpy(ondisk->sha1, ce->sha1);
1685 flags = ce->ce_flags;
1686 flags |= (ce_namelen(ce) >= CE_NAMEMASK ? CE_NAMEMASK : ce_namelen(ce));
1687 ondisk->flags = htons(flags);
1688 if (ce->ce_flags & CE_EXTENDED) {
1689 struct ondisk_cache_entry_extended *ondisk2;
1690 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1691 ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
1692 return ondisk2->name;
1694 else {
1695 return ondisk->name;
1699 static int ce_write_entry(git_SHA_CTX *c, int fd, struct cache_entry *ce,
1700 struct strbuf *previous_name)
1702 int size;
1703 struct ondisk_cache_entry *ondisk;
1704 char *name;
1705 int result;
1707 if (!previous_name) {
1708 size = ondisk_ce_size(ce);
1709 ondisk = xcalloc(1, size);
1710 name = copy_cache_entry_to_ondisk(ondisk, ce);
1711 memcpy(name, ce->name, ce_namelen(ce));
1712 } else {
1713 int common, to_remove, prefix_size;
1714 unsigned char to_remove_vi[16];
1715 for (common = 0;
1716 (ce->name[common] &&
1717 common < previous_name->len &&
1718 ce->name[common] == previous_name->buf[common]);
1719 common++)
1720 ; /* still matching */
1721 to_remove = previous_name->len - common;
1722 prefix_size = encode_varint(to_remove, to_remove_vi);
1724 if (ce->ce_flags & CE_EXTENDED)
1725 size = offsetof(struct ondisk_cache_entry_extended, name);
1726 else
1727 size = offsetof(struct ondisk_cache_entry, name);
1728 size += prefix_size + (ce_namelen(ce) - common + 1);
1730 ondisk = xcalloc(1, size);
1731 name = copy_cache_entry_to_ondisk(ondisk, ce);
1732 memcpy(name, to_remove_vi, prefix_size);
1733 memcpy(name + prefix_size, ce->name + common, ce_namelen(ce) - common);
1735 strbuf_splice(previous_name, common, to_remove,
1736 ce->name + common, ce_namelen(ce) - common);
1739 result = ce_write(c, fd, ondisk, size);
1740 free(ondisk);
1741 return result;
1744 static int has_racy_timestamp(struct index_state *istate)
1746 int entries = istate->cache_nr;
1747 int i;
1749 for (i = 0; i < entries; i++) {
1750 struct cache_entry *ce = istate->cache[i];
1751 if (is_racy_timestamp(istate, ce))
1752 return 1;
1754 return 0;
1758 * Opportunistically update the index but do not complain if we can't
1760 void update_index_if_able(struct index_state *istate, struct lock_file *lockfile)
1762 if ((istate->cache_changed || has_racy_timestamp(istate)) &&
1763 !write_index(istate, lockfile->fd))
1764 commit_locked_index(lockfile);
1765 else
1766 rollback_lock_file(lockfile);
1769 int write_index(struct index_state *istate, int newfd)
1771 git_SHA_CTX c;
1772 struct cache_header hdr;
1773 int i, err, removed, extended, hdr_version;
1774 struct cache_entry **cache = istate->cache;
1775 int entries = istate->cache_nr;
1776 struct stat st;
1777 struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
1779 for (i = removed = extended = 0; i < entries; i++) {
1780 if (cache[i]->ce_flags & CE_REMOVE)
1781 removed++;
1783 /* reduce extended entries if possible */
1784 cache[i]->ce_flags &= ~CE_EXTENDED;
1785 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
1786 extended++;
1787 cache[i]->ce_flags |= CE_EXTENDED;
1791 if (!istate->version)
1792 istate->version = INDEX_FORMAT_DEFAULT;
1794 /* demote version 3 to version 2 when the latter suffices */
1795 if (istate->version == 3 || istate->version == 2)
1796 istate->version = extended ? 3 : 2;
1798 hdr_version = istate->version;
1800 hdr.hdr_signature = htonl(CACHE_SIGNATURE);
1801 hdr.hdr_version = htonl(hdr_version);
1802 hdr.hdr_entries = htonl(entries - removed);
1804 git_SHA1_Init(&c);
1805 if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
1806 return -1;
1808 previous_name = (hdr_version == 4) ? &previous_name_buf : NULL;
1809 for (i = 0; i < entries; i++) {
1810 struct cache_entry *ce = cache[i];
1811 if (ce->ce_flags & CE_REMOVE)
1812 continue;
1813 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
1814 ce_smudge_racily_clean_entry(ce);
1815 if (is_null_sha1(ce->sha1)) {
1816 static const char msg[] = "cache entry has null sha1: %s";
1817 static int allow = -1;
1819 if (allow < 0)
1820 allow = git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
1821 if (allow)
1822 warning(msg, ce->name);
1823 else
1824 return error(msg, ce->name);
1826 if (ce_write_entry(&c, newfd, ce, previous_name) < 0)
1827 return -1;
1829 strbuf_release(&previous_name_buf);
1831 /* Write extension data here */
1832 if (istate->cache_tree) {
1833 struct strbuf sb = STRBUF_INIT;
1835 cache_tree_write(&sb, istate->cache_tree);
1836 err = write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sb.len) < 0
1837 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
1838 strbuf_release(&sb);
1839 if (err)
1840 return -1;
1842 if (istate->resolve_undo) {
1843 struct strbuf sb = STRBUF_INIT;
1845 resolve_undo_write(&sb, istate->resolve_undo);
1846 err = write_index_ext_header(&c, newfd, CACHE_EXT_RESOLVE_UNDO,
1847 sb.len) < 0
1848 || ce_write(&c, newfd, sb.buf, sb.len) < 0;
1849 strbuf_release(&sb);
1850 if (err)
1851 return -1;
1854 if (ce_flush(&c, newfd) || fstat(newfd, &st))
1855 return -1;
1856 istate->timestamp.sec = (unsigned int)st.st_mtime;
1857 istate->timestamp.nsec = ST_MTIME_NSEC(st);
1858 return 0;
1862 * Read the index file that is potentially unmerged into given
1863 * index_state, dropping any unmerged entries. Returns true if
1864 * the index is unmerged. Callers who want to refuse to work
1865 * from an unmerged state can call this and check its return value,
1866 * instead of calling read_cache().
1868 int read_index_unmerged(struct index_state *istate)
1870 int i;
1871 int unmerged = 0;
1873 read_index(istate);
1874 for (i = 0; i < istate->cache_nr; i++) {
1875 struct cache_entry *ce = istate->cache[i];
1876 struct cache_entry *new_ce;
1877 int size, len;
1879 if (!ce_stage(ce))
1880 continue;
1881 unmerged = 1;
1882 len = ce_namelen(ce);
1883 size = cache_entry_size(len);
1884 new_ce = xcalloc(1, size);
1885 memcpy(new_ce->name, ce->name, len);
1886 new_ce->ce_flags = create_ce_flags(0) | CE_CONFLICTED;
1887 new_ce->ce_namelen = len;
1888 new_ce->ce_mode = ce->ce_mode;
1889 if (add_index_entry(istate, new_ce, 0))
1890 return error("%s: cannot drop to stage #0",
1891 ce->name);
1892 i = index_name_pos(istate, new_ce->name, len);
1894 return unmerged;
1898 * Returns 1 if the path is an "other" path with respect to
1899 * the index; that is, the path is not mentioned in the index at all,
1900 * either as a file, a directory with some files in the index,
1901 * or as an unmerged entry.
1903 * We helpfully remove a trailing "/" from directories so that
1904 * the output of read_directory can be used as-is.
1906 int index_name_is_other(const struct index_state *istate, const char *name,
1907 int namelen)
1909 int pos;
1910 if (namelen && name[namelen - 1] == '/')
1911 namelen--;
1912 pos = index_name_pos(istate, name, namelen);
1913 if (0 <= pos)
1914 return 0; /* exact match */
1915 pos = -pos - 1;
1916 if (pos < istate->cache_nr) {
1917 struct cache_entry *ce = istate->cache[pos];
1918 if (ce_namelen(ce) == namelen &&
1919 !memcmp(ce->name, name, namelen))
1920 return 0; /* Yup, this one exists unmerged */
1922 return 1;
1925 void *read_blob_data_from_index(struct index_state *istate, const char *path, unsigned long *size)
1927 int pos, len;
1928 unsigned long sz;
1929 enum object_type type;
1930 void *data;
1932 len = strlen(path);
1933 pos = index_name_pos(istate, path, len);
1934 if (pos < 0) {
1936 * We might be in the middle of a merge, in which
1937 * case we would read stage #2 (ours).
1939 int i;
1940 for (i = -pos - 1;
1941 (pos < 0 && i < istate->cache_nr &&
1942 !strcmp(istate->cache[i]->name, path));
1943 i++)
1944 if (ce_stage(istate->cache[i]) == 2)
1945 pos = i;
1947 if (pos < 0)
1948 return NULL;
1949 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
1950 if (!data || type != OBJ_BLOB) {
1951 free(data);
1952 return NULL;
1954 if (size)
1955 *size = sz;
1956 return data;
1959 void stat_validity_clear(struct stat_validity *sv)
1961 free(sv->sd);
1962 sv->sd = NULL;
1965 int stat_validity_check(struct stat_validity *sv, const char *path)
1967 struct stat st;
1969 if (stat(path, &st) < 0)
1970 return sv->sd == NULL;
1971 if (!sv->sd)
1972 return 0;
1973 return S_ISREG(st.st_mode) && !match_stat_data(sv->sd, &st);
1976 void stat_validity_update(struct stat_validity *sv, int fd)
1978 struct stat st;
1980 if (fstat(fd, &st) < 0 || !S_ISREG(st.st_mode))
1981 stat_validity_clear(sv);
1982 else {
1983 if (!sv->sd)
1984 sv->sd = xcalloc(1, sizeof(struct stat_data));
1985 fill_stat_data(sv->sd, &st);