Merge branch 'jk/execv-dashed-external' into next
[git] / read-cache.c
1 /*
2  * GIT - The information manager from hell
3  *
4  * Copyright (C) Linus Torvalds, 2005
5  */
6 #define NO_THE_INDEX_COMPATIBILITY_MACROS
7 #include "cache.h"
8 #include "tempfile.h"
9 #include "lockfile.h"
10 #include "cache-tree.h"
11 #include "refs.h"
12 #include "dir.h"
13 #include "tree.h"
14 #include "commit.h"
15 #include "blob.h"
16 #include "resolve-undo.h"
17 #include "strbuf.h"
18 #include "varint.h"
19 #include "split-index.h"
20 #include "utf8.h"
21
22 /* Mask for the name length in ce_flags in the on-disk index */
23
24 #define CE_NAMEMASK  (0x0fff)
25
26 /* Index extensions.
27  *
28  * The first letter should be 'A'..'Z' for extensions that are not
29  * necessary for a correct operation (i.e. optimization data).
30  * When new extensions are added that _needs_ to be understood in
31  * order to correctly interpret the index file, pick character that
32  * is outside the range, to cause the reader to abort.
33  */
34
35 #define CACHE_EXT(s) ( (s[0]<<24)|(s[1]<<16)|(s[2]<<8)|(s[3]) )
36 #define CACHE_EXT_TREE 0x54524545       /* "TREE" */
37 #define CACHE_EXT_RESOLVE_UNDO 0x52455543 /* "REUC" */
38 #define CACHE_EXT_LINK 0x6c696e6b         /* "link" */
39 #define CACHE_EXT_UNTRACKED 0x554E5452    /* "UNTR" */
40
41 /* changes that can be kept in $GIT_DIR/index (basically all extensions) */
42 #define EXTMASK (RESOLVE_UNDO_CHANGED | CACHE_TREE_CHANGED | \
43                  CE_ENTRY_ADDED | CE_ENTRY_REMOVED | CE_ENTRY_CHANGED | \
44                  SPLIT_INDEX_ORDERED | UNTRACKED_CHANGED)
45
46 struct index_state the_index;
47 static const char *alternate_index_output;
48
49 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
50 {
51         istate->cache[nr] = ce;
52         add_name_hash(istate, ce);
53 }
54
55 static void replace_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
56 {
57         struct cache_entry *old = istate->cache[nr];
58
59         replace_index_entry_in_base(istate, old, ce);
60         remove_name_hash(istate, old);
61         free(old);
62         set_index_entry(istate, nr, ce);
63         ce->ce_flags |= CE_UPDATE_IN_BASE;
64         istate->cache_changed |= CE_ENTRY_CHANGED;
65 }
66
67 void rename_index_entry_at(struct index_state *istate, int nr, const char *new_name)
68 {
69         struct cache_entry *old = istate->cache[nr], *new;
70         int namelen = strlen(new_name);
71
72         new = xmalloc(cache_entry_size(namelen));
73         copy_cache_entry(new, old);
74         new->ce_flags &= ~CE_HASHED;
75         new->ce_namelen = namelen;
76         new->index = 0;
77         memcpy(new->name, new_name, namelen + 1);
78
79         cache_tree_invalidate_path(istate, old->name);
80         untracked_cache_remove_from_index(istate, old->name);
81         remove_index_entry_at(istate, nr);
82         add_index_entry(istate, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
83 }
84
85 void fill_stat_data(struct stat_data *sd, struct stat *st)
86 {
87         sd->sd_ctime.sec = (unsigned int)st->st_ctime;
88         sd->sd_mtime.sec = (unsigned int)st->st_mtime;
89         sd->sd_ctime.nsec = ST_CTIME_NSEC(*st);
90         sd->sd_mtime.nsec = ST_MTIME_NSEC(*st);
91         sd->sd_dev = st->st_dev;
92         sd->sd_ino = st->st_ino;
93         sd->sd_uid = st->st_uid;
94         sd->sd_gid = st->st_gid;
95         sd->sd_size = st->st_size;
96 }
97
98 int match_stat_data(const struct stat_data *sd, struct stat *st)
99 {
100         int changed = 0;
101
102         if (sd->sd_mtime.sec != (unsigned int)st->st_mtime)
103                 changed |= MTIME_CHANGED;
104         if (trust_ctime && check_stat &&
105             sd->sd_ctime.sec != (unsigned int)st->st_ctime)
106                 changed |= CTIME_CHANGED;
107
108 #ifdef USE_NSEC
109         if (check_stat && sd->sd_mtime.nsec != ST_MTIME_NSEC(*st))
110                 changed |= MTIME_CHANGED;
111         if (trust_ctime && check_stat &&
112             sd->sd_ctime.nsec != ST_CTIME_NSEC(*st))
113                 changed |= CTIME_CHANGED;
114 #endif
115
116         if (check_stat) {
117                 if (sd->sd_uid != (unsigned int) st->st_uid ||
118                         sd->sd_gid != (unsigned int) st->st_gid)
119                         changed |= OWNER_CHANGED;
120                 if (sd->sd_ino != (unsigned int) st->st_ino)
121                         changed |= INODE_CHANGED;
122         }
123
124 #ifdef USE_STDEV
125         /*
126          * st_dev breaks on network filesystems where different
127          * clients will have different views of what "device"
128          * the filesystem is on
129          */
130         if (check_stat && sd->sd_dev != (unsigned int) st->st_dev)
131                         changed |= INODE_CHANGED;
132 #endif
133
134         if (sd->sd_size != (unsigned int) st->st_size)
135                 changed |= DATA_CHANGED;
136
137         return changed;
138 }
139
140 /*
141  * This only updates the "non-critical" parts of the directory
142  * cache, ie the parts that aren't tracked by GIT, and only used
143  * to validate the cache.
144  */
145 void fill_stat_cache_info(struct cache_entry *ce, struct stat *st)
146 {
147         fill_stat_data(&ce->ce_stat_data, st);
148
149         if (assume_unchanged)
150                 ce->ce_flags |= CE_VALID;
151
152         if (S_ISREG(st->st_mode))
153                 ce_mark_uptodate(ce);
154 }
155
156 static int ce_compare_data(const struct cache_entry *ce, struct stat *st)
157 {
158         int match = -1;
159         int fd = git_open_cloexec(ce->name, O_RDONLY);
160
161         if (fd >= 0) {
162                 unsigned char sha1[20];
163                 if (!index_fd(sha1, fd, st, OBJ_BLOB, ce->name, 0))
164                         match = hashcmp(sha1, ce->oid.hash);
165                 /* index_fd() closed the file descriptor already */
166         }
167         return match;
168 }
169
170 static int ce_compare_link(const struct cache_entry *ce, size_t expected_size)
171 {
172         int match = -1;
173         void *buffer;
174         unsigned long size;
175         enum object_type type;
176         struct strbuf sb = STRBUF_INIT;
177
178         if (strbuf_readlink(&sb, ce->name, expected_size))
179                 return -1;
180
181         buffer = read_sha1_file(ce->oid.hash, &type, &size);
182         if (buffer) {
183                 if (size == sb.len)
184                         match = memcmp(buffer, sb.buf, size);
185                 free(buffer);
186         }
187         strbuf_release(&sb);
188         return match;
189 }
190
191 static int ce_compare_gitlink(const struct cache_entry *ce)
192 {
193         unsigned char sha1[20];
194
195         /*
196          * We don't actually require that the .git directory
197          * under GITLINK directory be a valid git directory. It
198          * might even be missing (in case nobody populated that
199          * sub-project).
200          *
201          * If so, we consider it always to match.
202          */
203         if (resolve_gitlink_ref(ce->name, "HEAD", sha1) < 0)
204                 return 0;
205         return hashcmp(sha1, ce->oid.hash);
206 }
207
208 static int ce_modified_check_fs(const struct cache_entry *ce, struct stat *st)
209 {
210         switch (st->st_mode & S_IFMT) {
211         case S_IFREG:
212                 if (ce_compare_data(ce, st))
213                         return DATA_CHANGED;
214                 break;
215         case S_IFLNK:
216                 if (ce_compare_link(ce, xsize_t(st->st_size)))
217                         return DATA_CHANGED;
218                 break;
219         case S_IFDIR:
220                 if (S_ISGITLINK(ce->ce_mode))
221                         return ce_compare_gitlink(ce) ? DATA_CHANGED : 0;
222         default:
223                 return TYPE_CHANGED;
224         }
225         return 0;
226 }
227
228 static int ce_match_stat_basic(const struct cache_entry *ce, struct stat *st)
229 {
230         unsigned int changed = 0;
231
232         if (ce->ce_flags & CE_REMOVE)
233                 return MODE_CHANGED | DATA_CHANGED | TYPE_CHANGED;
234
235         switch (ce->ce_mode & S_IFMT) {
236         case S_IFREG:
237                 changed |= !S_ISREG(st->st_mode) ? TYPE_CHANGED : 0;
238                 /* We consider only the owner x bit to be relevant for
239                  * "mode changes"
240                  */
241                 if (trust_executable_bit &&
242                     (0100 & (ce->ce_mode ^ st->st_mode)))
243                         changed |= MODE_CHANGED;
244                 break;
245         case S_IFLNK:
246                 if (!S_ISLNK(st->st_mode) &&
247                     (has_symlinks || !S_ISREG(st->st_mode)))
248                         changed |= TYPE_CHANGED;
249                 break;
250         case S_IFGITLINK:
251                 /* We ignore most of the st_xxx fields for gitlinks */
252                 if (!S_ISDIR(st->st_mode))
253                         changed |= TYPE_CHANGED;
254                 else if (ce_compare_gitlink(ce))
255                         changed |= DATA_CHANGED;
256                 return changed;
257         default:
258                 die("internal error: ce_mode is %o", ce->ce_mode);
259         }
260
261         changed |= match_stat_data(&ce->ce_stat_data, st);
262
263         /* Racily smudged entry? */
264         if (!ce->ce_stat_data.sd_size) {
265                 if (!is_empty_blob_sha1(ce->oid.hash))
266                         changed |= DATA_CHANGED;
267         }
268
269         return changed;
270 }
271
272 static int is_racy_stat(const struct index_state *istate,
273                         const struct stat_data *sd)
274 {
275         return (istate->timestamp.sec &&
276 #ifdef USE_NSEC
277                  /* nanosecond timestamped files can also be racy! */
278                 (istate->timestamp.sec < sd->sd_mtime.sec ||
279                  (istate->timestamp.sec == sd->sd_mtime.sec &&
280                   istate->timestamp.nsec <= sd->sd_mtime.nsec))
281 #else
282                 istate->timestamp.sec <= sd->sd_mtime.sec
283 #endif
284                 );
285 }
286
287 static int is_racy_timestamp(const struct index_state *istate,
288                              const struct cache_entry *ce)
289 {
290         return (!S_ISGITLINK(ce->ce_mode) &&
291                 is_racy_stat(istate, &ce->ce_stat_data));
292 }
293
294 int match_stat_data_racy(const struct index_state *istate,
295                          const struct stat_data *sd, struct stat *st)
296 {
297         if (is_racy_stat(istate, sd))
298                 return MTIME_CHANGED;
299         return match_stat_data(sd, st);
300 }
301
302 int ie_match_stat(const struct index_state *istate,
303                   const struct cache_entry *ce, struct stat *st,
304                   unsigned int options)
305 {
306         unsigned int changed;
307         int ignore_valid = options & CE_MATCH_IGNORE_VALID;
308         int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
309         int assume_racy_is_modified = options & CE_MATCH_RACY_IS_DIRTY;
310
311         /*
312          * If it's marked as always valid in the index, it's
313          * valid whatever the checked-out copy says.
314          *
315          * skip-worktree has the same effect with higher precedence
316          */
317         if (!ignore_skip_worktree && ce_skip_worktree(ce))
318                 return 0;
319         if (!ignore_valid && (ce->ce_flags & CE_VALID))
320                 return 0;
321
322         /*
323          * Intent-to-add entries have not been added, so the index entry
324          * by definition never matches what is in the work tree until it
325          * actually gets added.
326          */
327         if (ce_intent_to_add(ce))
328                 return DATA_CHANGED | TYPE_CHANGED | MODE_CHANGED;
329
330         changed = ce_match_stat_basic(ce, st);
331
332         /*
333          * Within 1 second of this sequence:
334          *      echo xyzzy >file && git-update-index --add file
335          * running this command:
336          *      echo frotz >file
337          * would give a falsely clean cache entry.  The mtime and
338          * length match the cache, and other stat fields do not change.
339          *
340          * We could detect this at update-index time (the cache entry
341          * being registered/updated records the same time as "now")
342          * and delay the return from git-update-index, but that would
343          * effectively mean we can make at most one commit per second,
344          * which is not acceptable.  Instead, we check cache entries
345          * whose mtime are the same as the index file timestamp more
346          * carefully than others.
347          */
348         if (!changed && is_racy_timestamp(istate, ce)) {
349                 if (assume_racy_is_modified)
350                         changed |= DATA_CHANGED;
351                 else
352                         changed |= ce_modified_check_fs(ce, st);
353         }
354
355         return changed;
356 }
357
358 int ie_modified(const struct index_state *istate,
359                 const struct cache_entry *ce,
360                 struct stat *st, unsigned int options)
361 {
362         int changed, changed_fs;
363
364         changed = ie_match_stat(istate, ce, st, options);
365         if (!changed)
366                 return 0;
367         /*
368          * If the mode or type has changed, there's no point in trying
369          * to refresh the entry - it's not going to match
370          */
371         if (changed & (MODE_CHANGED | TYPE_CHANGED))
372                 return changed;
373
374         /*
375          * Immediately after read-tree or update-index --cacheinfo,
376          * the length field is zero, as we have never even read the
377          * lstat(2) information once, and we cannot trust DATA_CHANGED
378          * returned by ie_match_stat() which in turn was returned by
379          * ce_match_stat_basic() to signal that the filesize of the
380          * blob changed.  We have to actually go to the filesystem to
381          * see if the contents match, and if so, should answer "unchanged".
382          *
383          * The logic does not apply to gitlinks, as ce_match_stat_basic()
384          * already has checked the actual HEAD from the filesystem in the
385          * subproject.  If ie_match_stat() already said it is different,
386          * then we know it is.
387          */
388         if ((changed & DATA_CHANGED) &&
389             (S_ISGITLINK(ce->ce_mode) || ce->ce_stat_data.sd_size != 0))
390                 return changed;
391
392         changed_fs = ce_modified_check_fs(ce, st);
393         if (changed_fs)
394                 return changed | changed_fs;
395         return 0;
396 }
397
398 int base_name_compare(const char *name1, int len1, int mode1,
399                       const char *name2, int len2, int mode2)
400 {
401         unsigned char c1, c2;
402         int len = len1 < len2 ? len1 : len2;
403         int cmp;
404
405         cmp = memcmp(name1, name2, len);
406         if (cmp)
407                 return cmp;
408         c1 = name1[len];
409         c2 = name2[len];
410         if (!c1 && S_ISDIR(mode1))
411                 c1 = '/';
412         if (!c2 && S_ISDIR(mode2))
413                 c2 = '/';
414         return (c1 < c2) ? -1 : (c1 > c2) ? 1 : 0;
415 }
416
417 /*
418  * df_name_compare() is identical to base_name_compare(), except it
419  * compares conflicting directory/file entries as equal. Note that
420  * while a directory name compares as equal to a regular file, they
421  * then individually compare _differently_ to a filename that has
422  * a dot after the basename (because '\0' < '.' < '/').
423  *
424  * This is used by routines that want to traverse the git namespace
425  * but then handle conflicting entries together when possible.
426  */
427 int df_name_compare(const char *name1, int len1, int mode1,
428                     const char *name2, int len2, int mode2)
429 {
430         int len = len1 < len2 ? len1 : len2, cmp;
431         unsigned char c1, c2;
432
433         cmp = memcmp(name1, name2, len);
434         if (cmp)
435                 return cmp;
436         /* Directories and files compare equal (same length, same name) */
437         if (len1 == len2)
438                 return 0;
439         c1 = name1[len];
440         if (!c1 && S_ISDIR(mode1))
441                 c1 = '/';
442         c2 = name2[len];
443         if (!c2 && S_ISDIR(mode2))
444                 c2 = '/';
445         if (c1 == '/' && !c2)
446                 return 0;
447         if (c2 == '/' && !c1)
448                 return 0;
449         return c1 - c2;
450 }
451
452 int name_compare(const char *name1, size_t len1, const char *name2, size_t len2)
453 {
454         size_t min_len = (len1 < len2) ? len1 : len2;
455         int cmp = memcmp(name1, name2, min_len);
456         if (cmp)
457                 return cmp;
458         if (len1 < len2)
459                 return -1;
460         if (len1 > len2)
461                 return 1;
462         return 0;
463 }
464
465 int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2)
466 {
467         int cmp;
468
469         cmp = name_compare(name1, len1, name2, len2);
470         if (cmp)
471                 return cmp;
472
473         if (stage1 < stage2)
474                 return -1;
475         if (stage1 > stage2)
476                 return 1;
477         return 0;
478 }
479
480 static int index_name_stage_pos(const struct index_state *istate, const char *name, int namelen, int stage)
481 {
482         int first, last;
483
484         first = 0;
485         last = istate->cache_nr;
486         while (last > first) {
487                 int next = (last + first) >> 1;
488                 struct cache_entry *ce = istate->cache[next];
489                 int cmp = cache_name_stage_compare(name, namelen, stage, ce->name, ce_namelen(ce), ce_stage(ce));
490                 if (!cmp)
491                         return next;
492                 if (cmp < 0) {
493                         last = next;
494                         continue;
495                 }
496                 first = next+1;
497         }
498         return -first-1;
499 }
500
501 int index_name_pos(const struct index_state *istate, const char *name, int namelen)
502 {
503         return index_name_stage_pos(istate, name, namelen, 0);
504 }
505
506 /* Remove entry, return true if there are more entries to go.. */
507 int remove_index_entry_at(struct index_state *istate, int pos)
508 {
509         struct cache_entry *ce = istate->cache[pos];
510
511         record_resolve_undo(istate, ce);
512         remove_name_hash(istate, ce);
513         save_or_free_index_entry(istate, ce);
514         istate->cache_changed |= CE_ENTRY_REMOVED;
515         istate->cache_nr--;
516         if (pos >= istate->cache_nr)
517                 return 0;
518         memmove(istate->cache + pos,
519                 istate->cache + pos + 1,
520                 (istate->cache_nr - pos) * sizeof(struct cache_entry *));
521         return 1;
522 }
523
524 /*
525  * Remove all cache entries marked for removal, that is where
526  * CE_REMOVE is set in ce_flags.  This is much more effective than
527  * calling remove_index_entry_at() for each entry to be removed.
528  */
529 void remove_marked_cache_entries(struct index_state *istate)
530 {
531         struct cache_entry **ce_array = istate->cache;
532         unsigned int i, j;
533
534         for (i = j = 0; i < istate->cache_nr; i++) {
535                 if (ce_array[i]->ce_flags & CE_REMOVE) {
536                         remove_name_hash(istate, ce_array[i]);
537                         save_or_free_index_entry(istate, ce_array[i]);
538                 }
539                 else
540                         ce_array[j++] = ce_array[i];
541         }
542         if (j == istate->cache_nr)
543                 return;
544         istate->cache_changed |= CE_ENTRY_REMOVED;
545         istate->cache_nr = j;
546 }
547
548 int remove_file_from_index(struct index_state *istate, const char *path)
549 {
550         int pos = index_name_pos(istate, path, strlen(path));
551         if (pos < 0)
552                 pos = -pos-1;
553         cache_tree_invalidate_path(istate, path);
554         untracked_cache_remove_from_index(istate, path);
555         while (pos < istate->cache_nr && !strcmp(istate->cache[pos]->name, path))
556                 remove_index_entry_at(istate, pos);
557         return 0;
558 }
559
560 static int compare_name(struct cache_entry *ce, const char *path, int namelen)
561 {
562         return namelen != ce_namelen(ce) || memcmp(path, ce->name, namelen);
563 }
564
565 static int index_name_pos_also_unmerged(struct index_state *istate,
566         const char *path, int namelen)
567 {
568         int pos = index_name_pos(istate, path, namelen);
569         struct cache_entry *ce;
570
571         if (pos >= 0)
572                 return pos;
573
574         /* maybe unmerged? */
575         pos = -1 - pos;
576         if (pos >= istate->cache_nr ||
577                         compare_name((ce = istate->cache[pos]), path, namelen))
578                 return -1;
579
580         /* order of preference: stage 2, 1, 3 */
581         if (ce_stage(ce) == 1 && pos + 1 < istate->cache_nr &&
582                         ce_stage((ce = istate->cache[pos + 1])) == 2 &&
583                         !compare_name(ce, path, namelen))
584                 pos++;
585         return pos;
586 }
587
588 static int different_name(struct cache_entry *ce, struct cache_entry *alias)
589 {
590         int len = ce_namelen(ce);
591         return ce_namelen(alias) != len || memcmp(ce->name, alias->name, len);
592 }
593
594 /*
595  * If we add a filename that aliases in the cache, we will use the
596  * name that we already have - but we don't want to update the same
597  * alias twice, because that implies that there were actually two
598  * different files with aliasing names!
599  *
600  * So we use the CE_ADDED flag to verify that the alias was an old
601  * one before we accept it as
602  */
603 static struct cache_entry *create_alias_ce(struct index_state *istate,
604                                            struct cache_entry *ce,
605                                            struct cache_entry *alias)
606 {
607         int len;
608         struct cache_entry *new;
609
610         if (alias->ce_flags & CE_ADDED)
611                 die("Will not add file alias '%s' ('%s' already exists in index)", ce->name, alias->name);
612
613         /* Ok, create the new entry using the name of the existing alias */
614         len = ce_namelen(alias);
615         new = xcalloc(1, cache_entry_size(len));
616         memcpy(new->name, alias->name, len);
617         copy_cache_entry(new, ce);
618         save_or_free_index_entry(istate, ce);
619         return new;
620 }
621
622 void set_object_name_for_intent_to_add_entry(struct cache_entry *ce)
623 {
624         unsigned char sha1[20];
625         if (write_sha1_file("", 0, blob_type, sha1))
626                 die("cannot create an empty blob in the object database");
627         hashcpy(ce->oid.hash, sha1);
628 }
629
630 int add_to_index(struct index_state *istate, const char *path, struct stat *st, int flags)
631 {
632         int size, namelen, was_same;
633         mode_t st_mode = st->st_mode;
634         struct cache_entry *ce, *alias;
635         unsigned ce_option = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE|CE_MATCH_RACY_IS_DIRTY;
636         int verbose = flags & (ADD_CACHE_VERBOSE | ADD_CACHE_PRETEND);
637         int pretend = flags & ADD_CACHE_PRETEND;
638         int intent_only = flags & ADD_CACHE_INTENT;
639         int add_option = (ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|
640                           (intent_only ? ADD_CACHE_NEW_ONLY : 0));
641
642         if (!S_ISREG(st_mode) && !S_ISLNK(st_mode) && !S_ISDIR(st_mode))
643                 return error("%s: can only add regular files, symbolic links or git-directories", path);
644
645         namelen = strlen(path);
646         if (S_ISDIR(st_mode)) {
647                 while (namelen && path[namelen-1] == '/')
648                         namelen--;
649         }
650         size = cache_entry_size(namelen);
651         ce = xcalloc(1, size);
652         memcpy(ce->name, path, namelen);
653         ce->ce_namelen = namelen;
654         if (!intent_only)
655                 fill_stat_cache_info(ce, st);
656         else
657                 ce->ce_flags |= CE_INTENT_TO_ADD;
658
659
660         if (trust_executable_bit && has_symlinks) {
661                 ce->ce_mode = create_ce_mode(st_mode);
662         } else {
663                 /* If there is an existing entry, pick the mode bits and type
664                  * from it, otherwise assume unexecutable regular file.
665                  */
666                 struct cache_entry *ent;
667                 int pos = index_name_pos_also_unmerged(istate, path, namelen);
668
669                 ent = (0 <= pos) ? istate->cache[pos] : NULL;
670                 ce->ce_mode = ce_mode_from_stat(ent, st_mode);
671         }
672
673         /* When core.ignorecase=true, determine if a directory of the same name but differing
674          * case already exists within the Git repository.  If it does, ensure the directory
675          * case of the file being added to the repository matches (is folded into) the existing
676          * entry's directory case.
677          */
678         if (ignore_case) {
679                 adjust_dirname_case(istate, ce->name);
680         }
681
682         alias = index_file_exists(istate, ce->name, ce_namelen(ce), ignore_case);
683         if (alias && !ce_stage(alias) && !ie_match_stat(istate, alias, st, ce_option)) {
684                 /* Nothing changed, really */
685                 if (!S_ISGITLINK(alias->ce_mode))
686                         ce_mark_uptodate(alias);
687                 alias->ce_flags |= CE_ADDED;
688
689                 free(ce);
690                 return 0;
691         }
692         if (!intent_only) {
693                 if (index_path(ce->oid.hash, path, st, HASH_WRITE_OBJECT)) {
694                         free(ce);
695                         return error("unable to index file %s", path);
696                 }
697         } else
698                 set_object_name_for_intent_to_add_entry(ce);
699
700         if (ignore_case && alias && different_name(ce, alias))
701                 ce = create_alias_ce(istate, ce, alias);
702         ce->ce_flags |= CE_ADDED;
703
704         /* It was suspected to be racily clean, but it turns out to be Ok */
705         was_same = (alias &&
706                     !ce_stage(alias) &&
707                     !oidcmp(&alias->oid, &ce->oid) &&
708                     ce->ce_mode == alias->ce_mode);
709
710         if (pretend)
711                 free(ce);
712         else if (add_index_entry(istate, ce, add_option)) {
713                 free(ce);
714                 return error("unable to add %s to index", path);
715         }
716         if (verbose && !was_same)
717                 printf("add '%s'\n", path);
718         return 0;
719 }
720
721 int add_file_to_index(struct index_state *istate, const char *path, int flags)
722 {
723         struct stat st;
724         if (lstat(path, &st))
725                 die_errno("unable to stat '%s'", path);
726         return add_to_index(istate, path, &st, flags);
727 }
728
729 struct cache_entry *make_cache_entry(unsigned int mode,
730                 const unsigned char *sha1, const char *path, int stage,
731                 unsigned int refresh_options)
732 {
733         int size, len;
734         struct cache_entry *ce, *ret;
735
736         if (!verify_path(path)) {
737                 error("Invalid path '%s'", path);
738                 return NULL;
739         }
740
741         len = strlen(path);
742         size = cache_entry_size(len);
743         ce = xcalloc(1, size);
744
745         hashcpy(ce->oid.hash, sha1);
746         memcpy(ce->name, path, len);
747         ce->ce_flags = create_ce_flags(stage);
748         ce->ce_namelen = len;
749         ce->ce_mode = create_ce_mode(mode);
750
751         ret = refresh_cache_entry(ce, refresh_options);
752         if (ret != ce)
753                 free(ce);
754         return ret;
755 }
756
757 /*
758  * Chmod an index entry with either +x or -x.
759  *
760  * Returns -1 if the chmod for the particular cache entry failed (if it's
761  * not a regular file), -2 if an invalid flip argument is passed in, 0
762  * otherwise.
763  */
764 int chmod_index_entry(struct index_state *istate, struct cache_entry *ce,
765                       char flip)
766 {
767         if (!S_ISREG(ce->ce_mode))
768                 return -1;
769         switch (flip) {
770         case '+':
771                 ce->ce_mode |= 0111;
772                 break;
773         case '-':
774                 ce->ce_mode &= ~0111;
775                 break;
776         default:
777                 return -2;
778         }
779         cache_tree_invalidate_path(istate, ce->name);
780         ce->ce_flags |= CE_UPDATE_IN_BASE;
781         istate->cache_changed |= CE_ENTRY_CHANGED;
782
783         return 0;
784 }
785
786 int ce_same_name(const struct cache_entry *a, const struct cache_entry *b)
787 {
788         int len = ce_namelen(a);
789         return ce_namelen(b) == len && !memcmp(a->name, b->name, len);
790 }
791
792 /*
793  * We fundamentally don't like some paths: we don't want
794  * dot or dot-dot anywhere, and for obvious reasons don't
795  * want to recurse into ".git" either.
796  *
797  * Also, we don't want double slashes or slashes at the
798  * end that can make pathnames ambiguous.
799  */
800 static int verify_dotfile(const char *rest)
801 {
802         /*
803          * The first character was '.', but that
804          * has already been discarded, we now test
805          * the rest.
806          */
807
808         /* "." is not allowed */
809         if (*rest == '\0' || is_dir_sep(*rest))
810                 return 0;
811
812         switch (*rest) {
813         /*
814          * ".git" followed by  NUL or slash is bad. This
815          * shares the path end test with the ".." case.
816          */
817         case 'g':
818         case 'G':
819                 if (rest[1] != 'i' && rest[1] != 'I')
820                         break;
821                 if (rest[2] != 't' && rest[2] != 'T')
822                         break;
823                 rest += 2;
824         /* fallthrough */
825         case '.':
826                 if (rest[1] == '\0' || is_dir_sep(rest[1]))
827                         return 0;
828         }
829         return 1;
830 }
831
832 int verify_path(const char *path)
833 {
834         char c;
835
836         if (has_dos_drive_prefix(path))
837                 return 0;
838
839         goto inside;
840         for (;;) {
841                 if (!c)
842                         return 1;
843                 if (is_dir_sep(c)) {
844 inside:
845                         if (protect_hfs && is_hfs_dotgit(path))
846                                 return 0;
847                         if (protect_ntfs && is_ntfs_dotgit(path))
848                                 return 0;
849                         c = *path++;
850                         if ((c == '.' && !verify_dotfile(path)) ||
851                             is_dir_sep(c) || c == '\0')
852                                 return 0;
853                 }
854                 c = *path++;
855         }
856 }
857
858 /*
859  * Do we have another file that has the beginning components being a
860  * proper superset of the name we're trying to add?
861  */
862 static int has_file_name(struct index_state *istate,
863                          const struct cache_entry *ce, int pos, int ok_to_replace)
864 {
865         int retval = 0;
866         int len = ce_namelen(ce);
867         int stage = ce_stage(ce);
868         const char *name = ce->name;
869
870         while (pos < istate->cache_nr) {
871                 struct cache_entry *p = istate->cache[pos++];
872
873                 if (len >= ce_namelen(p))
874                         break;
875                 if (memcmp(name, p->name, len))
876                         break;
877                 if (ce_stage(p) != stage)
878                         continue;
879                 if (p->name[len] != '/')
880                         continue;
881                 if (p->ce_flags & CE_REMOVE)
882                         continue;
883                 retval = -1;
884                 if (!ok_to_replace)
885                         break;
886                 remove_index_entry_at(istate, --pos);
887         }
888         return retval;
889 }
890
891 /*
892  * Do we have another file with a pathname that is a proper
893  * subset of the name we're trying to add?
894  */
895 static int has_dir_name(struct index_state *istate,
896                         const struct cache_entry *ce, int pos, int ok_to_replace)
897 {
898         int retval = 0;
899         int stage = ce_stage(ce);
900         const char *name = ce->name;
901         const char *slash = name + ce_namelen(ce);
902
903         for (;;) {
904                 int len;
905
906                 for (;;) {
907                         if (*--slash == '/')
908                                 break;
909                         if (slash <= ce->name)
910                                 return retval;
911                 }
912                 len = slash - name;
913
914                 pos = index_name_stage_pos(istate, name, len, stage);
915                 if (pos >= 0) {
916                         /*
917                          * Found one, but not so fast.  This could
918                          * be a marker that says "I was here, but
919                          * I am being removed".  Such an entry is
920                          * not a part of the resulting tree, and
921                          * it is Ok to have a directory at the same
922                          * path.
923                          */
924                         if (!(istate->cache[pos]->ce_flags & CE_REMOVE)) {
925                                 retval = -1;
926                                 if (!ok_to_replace)
927                                         break;
928                                 remove_index_entry_at(istate, pos);
929                                 continue;
930                         }
931                 }
932                 else
933                         pos = -pos-1;
934
935                 /*
936                  * Trivial optimization: if we find an entry that
937                  * already matches the sub-directory, then we know
938                  * we're ok, and we can exit.
939                  */
940                 while (pos < istate->cache_nr) {
941                         struct cache_entry *p = istate->cache[pos];
942                         if ((ce_namelen(p) <= len) ||
943                             (p->name[len] != '/') ||
944                             memcmp(p->name, name, len))
945                                 break; /* not our subdirectory */
946                         if (ce_stage(p) == stage && !(p->ce_flags & CE_REMOVE))
947                                 /*
948                                  * p is at the same stage as our entry, and
949                                  * is a subdirectory of what we are looking
950                                  * at, so we cannot have conflicts at our
951                                  * level or anything shorter.
952                                  */
953                                 return retval;
954                         pos++;
955                 }
956         }
957         return retval;
958 }
959
960 /* We may be in a situation where we already have path/file and path
961  * is being added, or we already have path and path/file is being
962  * added.  Either one would result in a nonsense tree that has path
963  * twice when git-write-tree tries to write it out.  Prevent it.
964  *
965  * If ok-to-replace is specified, we remove the conflicting entries
966  * from the cache so the caller should recompute the insert position.
967  * When this happens, we return non-zero.
968  */
969 static int check_file_directory_conflict(struct index_state *istate,
970                                          const struct cache_entry *ce,
971                                          int pos, int ok_to_replace)
972 {
973         int retval;
974
975         /*
976          * When ce is an "I am going away" entry, we allow it to be added
977          */
978         if (ce->ce_flags & CE_REMOVE)
979                 return 0;
980
981         /*
982          * We check if the path is a sub-path of a subsequent pathname
983          * first, since removing those will not change the position
984          * in the array.
985          */
986         retval = has_file_name(istate, ce, pos, ok_to_replace);
987
988         /*
989          * Then check if the path might have a clashing sub-directory
990          * before it.
991          */
992         return retval + has_dir_name(istate, ce, pos, ok_to_replace);
993 }
994
995 static int add_index_entry_with_check(struct index_state *istate, struct cache_entry *ce, int option)
996 {
997         int pos;
998         int ok_to_add = option & ADD_CACHE_OK_TO_ADD;
999         int ok_to_replace = option & ADD_CACHE_OK_TO_REPLACE;
1000         int skip_df_check = option & ADD_CACHE_SKIP_DFCHECK;
1001         int new_only = option & ADD_CACHE_NEW_ONLY;
1002
1003         if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1004                 cache_tree_invalidate_path(istate, ce->name);
1005         pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1006
1007         /* existing match? Just replace it. */
1008         if (pos >= 0) {
1009                 if (!new_only)
1010                         replace_index_entry(istate, pos, ce);
1011                 return 0;
1012         }
1013         pos = -pos-1;
1014
1015         if (!(option & ADD_CACHE_KEEP_CACHE_TREE))
1016                 untracked_cache_add_to_index(istate, ce->name);
1017
1018         /*
1019          * Inserting a merged entry ("stage 0") into the index
1020          * will always replace all non-merged entries..
1021          */
1022         if (pos < istate->cache_nr && ce_stage(ce) == 0) {
1023                 while (ce_same_name(istate->cache[pos], ce)) {
1024                         ok_to_add = 1;
1025                         if (!remove_index_entry_at(istate, pos))
1026                                 break;
1027                 }
1028         }
1029
1030         if (!ok_to_add)
1031                 return -1;
1032         if (!verify_path(ce->name))
1033                 return error("Invalid path '%s'", ce->name);
1034
1035         if (!skip_df_check &&
1036             check_file_directory_conflict(istate, ce, pos, ok_to_replace)) {
1037                 if (!ok_to_replace)
1038                         return error("'%s' appears as both a file and as a directory",
1039                                      ce->name);
1040                 pos = index_name_stage_pos(istate, ce->name, ce_namelen(ce), ce_stage(ce));
1041                 pos = -pos-1;
1042         }
1043         return pos + 1;
1044 }
1045
1046 int add_index_entry(struct index_state *istate, struct cache_entry *ce, int option)
1047 {
1048         int pos;
1049
1050         if (option & ADD_CACHE_JUST_APPEND)
1051                 pos = istate->cache_nr;
1052         else {
1053                 int ret;
1054                 ret = add_index_entry_with_check(istate, ce, option);
1055                 if (ret <= 0)
1056                         return ret;
1057                 pos = ret - 1;
1058         }
1059
1060         /* Make sure the array is big enough .. */
1061         ALLOC_GROW(istate->cache, istate->cache_nr + 1, istate->cache_alloc);
1062
1063         /* Add it in.. */
1064         istate->cache_nr++;
1065         if (istate->cache_nr > pos + 1)
1066                 memmove(istate->cache + pos + 1,
1067                         istate->cache + pos,
1068                         (istate->cache_nr - pos - 1) * sizeof(ce));
1069         set_index_entry(istate, pos, ce);
1070         istate->cache_changed |= CE_ENTRY_ADDED;
1071         return 0;
1072 }
1073
1074 /*
1075  * "refresh" does not calculate a new sha1 file or bring the
1076  * cache up-to-date for mode/content changes. But what it
1077  * _does_ do is to "re-match" the stat information of a file
1078  * with the cache, so that you can refresh the cache for a
1079  * file that hasn't been changed but where the stat entry is
1080  * out of date.
1081  *
1082  * For example, you'd want to do this after doing a "git-read-tree",
1083  * to link up the stat cache details with the proper files.
1084  */
1085 static struct cache_entry *refresh_cache_ent(struct index_state *istate,
1086                                              struct cache_entry *ce,
1087                                              unsigned int options, int *err,
1088                                              int *changed_ret)
1089 {
1090         struct stat st;
1091         struct cache_entry *updated;
1092         int changed, size;
1093         int refresh = options & CE_MATCH_REFRESH;
1094         int ignore_valid = options & CE_MATCH_IGNORE_VALID;
1095         int ignore_skip_worktree = options & CE_MATCH_IGNORE_SKIP_WORKTREE;
1096         int ignore_missing = options & CE_MATCH_IGNORE_MISSING;
1097
1098         if (!refresh || ce_uptodate(ce))
1099                 return ce;
1100
1101         /*
1102          * CE_VALID or CE_SKIP_WORKTREE means the user promised us
1103          * that the change to the work tree does not matter and told
1104          * us not to worry.
1105          */
1106         if (!ignore_skip_worktree && ce_skip_worktree(ce)) {
1107                 ce_mark_uptodate(ce);
1108                 return ce;
1109         }
1110         if (!ignore_valid && (ce->ce_flags & CE_VALID)) {
1111                 ce_mark_uptodate(ce);
1112                 return ce;
1113         }
1114
1115         if (has_symlink_leading_path(ce->name, ce_namelen(ce))) {
1116                 if (ignore_missing)
1117                         return ce;
1118                 if (err)
1119                         *err = ENOENT;
1120                 return NULL;
1121         }
1122
1123         if (lstat(ce->name, &st) < 0) {
1124                 if (ignore_missing && errno == ENOENT)
1125                         return ce;
1126                 if (err)
1127                         *err = errno;
1128                 return NULL;
1129         }
1130
1131         changed = ie_match_stat(istate, ce, &st, options);
1132         if (changed_ret)
1133                 *changed_ret = changed;
1134         if (!changed) {
1135                 /*
1136                  * The path is unchanged.  If we were told to ignore
1137                  * valid bit, then we did the actual stat check and
1138                  * found that the entry is unmodified.  If the entry
1139                  * is not marked VALID, this is the place to mark it
1140                  * valid again, under "assume unchanged" mode.
1141                  */
1142                 if (ignore_valid && assume_unchanged &&
1143                     !(ce->ce_flags & CE_VALID))
1144                         ; /* mark this one VALID again */
1145                 else {
1146                         /*
1147                          * We do not mark the index itself "modified"
1148                          * because CE_UPTODATE flag is in-core only;
1149                          * we are not going to write this change out.
1150                          */
1151                         if (!S_ISGITLINK(ce->ce_mode))
1152                                 ce_mark_uptodate(ce);
1153                         return ce;
1154                 }
1155         }
1156
1157         if (ie_modified(istate, ce, &st, options)) {
1158                 if (err)
1159                         *err = EINVAL;
1160                 return NULL;
1161         }
1162
1163         size = ce_size(ce);
1164         updated = xmalloc(size);
1165         memcpy(updated, ce, size);
1166         fill_stat_cache_info(updated, &st);
1167         /*
1168          * If ignore_valid is not set, we should leave CE_VALID bit
1169          * alone.  Otherwise, paths marked with --no-assume-unchanged
1170          * (i.e. things to be edited) will reacquire CE_VALID bit
1171          * automatically, which is not really what we want.
1172          */
1173         if (!ignore_valid && assume_unchanged &&
1174             !(ce->ce_flags & CE_VALID))
1175                 updated->ce_flags &= ~CE_VALID;
1176
1177         /* istate->cache_changed is updated in the caller */
1178         return updated;
1179 }
1180
1181 static void show_file(const char * fmt, const char * name, int in_porcelain,
1182                       int * first, const char *header_msg)
1183 {
1184         if (in_porcelain && *first && header_msg) {
1185                 printf("%s\n", header_msg);
1186                 *first = 0;
1187         }
1188         printf(fmt, name);
1189 }
1190
1191 int refresh_index(struct index_state *istate, unsigned int flags,
1192                   const struct pathspec *pathspec,
1193                   char *seen, const char *header_msg)
1194 {
1195         int i;
1196         int has_errors = 0;
1197         int really = (flags & REFRESH_REALLY) != 0;
1198         int allow_unmerged = (flags & REFRESH_UNMERGED) != 0;
1199         int quiet = (flags & REFRESH_QUIET) != 0;
1200         int not_new = (flags & REFRESH_IGNORE_MISSING) != 0;
1201         int ignore_submodules = (flags & REFRESH_IGNORE_SUBMODULES) != 0;
1202         int first = 1;
1203         int in_porcelain = (flags & REFRESH_IN_PORCELAIN);
1204         unsigned int options = (CE_MATCH_REFRESH |
1205                                 (really ? CE_MATCH_IGNORE_VALID : 0) |
1206                                 (not_new ? CE_MATCH_IGNORE_MISSING : 0));
1207         const char *modified_fmt;
1208         const char *deleted_fmt;
1209         const char *typechange_fmt;
1210         const char *added_fmt;
1211         const char *unmerged_fmt;
1212
1213         modified_fmt = (in_porcelain ? "M\t%s\n" : "%s: needs update\n");
1214         deleted_fmt = (in_porcelain ? "D\t%s\n" : "%s: needs update\n");
1215         typechange_fmt = (in_porcelain ? "T\t%s\n" : "%s needs update\n");
1216         added_fmt = (in_porcelain ? "A\t%s\n" : "%s needs update\n");
1217         unmerged_fmt = (in_porcelain ? "U\t%s\n" : "%s: needs merge\n");
1218         for (i = 0; i < istate->cache_nr; i++) {
1219                 struct cache_entry *ce, *new;
1220                 int cache_errno = 0;
1221                 int changed = 0;
1222                 int filtered = 0;
1223
1224                 ce = istate->cache[i];
1225                 if (ignore_submodules && S_ISGITLINK(ce->ce_mode))
1226                         continue;
1227
1228                 if (pathspec && !ce_path_match(ce, pathspec, seen))
1229                         filtered = 1;
1230
1231                 if (ce_stage(ce)) {
1232                         while ((i < istate->cache_nr) &&
1233                                ! strcmp(istate->cache[i]->name, ce->name))
1234                                 i++;
1235                         i--;
1236                         if (allow_unmerged)
1237                                 continue;
1238                         if (!filtered)
1239                                 show_file(unmerged_fmt, ce->name, in_porcelain,
1240                                           &first, header_msg);
1241                         has_errors = 1;
1242                         continue;
1243                 }
1244
1245                 if (filtered)
1246                         continue;
1247
1248                 new = refresh_cache_ent(istate, ce, options, &cache_errno, &changed);
1249                 if (new == ce)
1250                         continue;
1251                 if (!new) {
1252                         const char *fmt;
1253
1254                         if (really && cache_errno == EINVAL) {
1255                                 /* If we are doing --really-refresh that
1256                                  * means the index is not valid anymore.
1257                                  */
1258                                 ce->ce_flags &= ~CE_VALID;
1259                                 ce->ce_flags |= CE_UPDATE_IN_BASE;
1260                                 istate->cache_changed |= CE_ENTRY_CHANGED;
1261                         }
1262                         if (quiet)
1263                                 continue;
1264
1265                         if (cache_errno == ENOENT)
1266                                 fmt = deleted_fmt;
1267                         else if (ce_intent_to_add(ce))
1268                                 fmt = added_fmt; /* must be before other checks */
1269                         else if (changed & TYPE_CHANGED)
1270                                 fmt = typechange_fmt;
1271                         else
1272                                 fmt = modified_fmt;
1273                         show_file(fmt,
1274                                   ce->name, in_porcelain, &first, header_msg);
1275                         has_errors = 1;
1276                         continue;
1277                 }
1278
1279                 replace_index_entry(istate, i, new);
1280         }
1281         return has_errors;
1282 }
1283
1284 struct cache_entry *refresh_cache_entry(struct cache_entry *ce,
1285                                                unsigned int options)
1286 {
1287         return refresh_cache_ent(&the_index, ce, options, NULL, NULL);
1288 }
1289
1290
1291 /*****************************************************************
1292  * Index File I/O
1293  *****************************************************************/
1294
1295 #define INDEX_FORMAT_DEFAULT 3
1296
1297 static unsigned int get_index_format_default(void)
1298 {
1299         char *envversion = getenv("GIT_INDEX_VERSION");
1300         char *endp;
1301         int value;
1302         unsigned int version = INDEX_FORMAT_DEFAULT;
1303
1304         if (!envversion) {
1305                 if (!git_config_get_int("index.version", &value))
1306                         version = value;
1307                 if (version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1308                         warning(_("index.version set, but the value is invalid.\n"
1309                                   "Using version %i"), INDEX_FORMAT_DEFAULT);
1310                         return INDEX_FORMAT_DEFAULT;
1311                 }
1312                 return version;
1313         }
1314
1315         version = strtoul(envversion, &endp, 10);
1316         if (*endp ||
1317             version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < version) {
1318                 warning(_("GIT_INDEX_VERSION set, but the value is invalid.\n"
1319                           "Using version %i"), INDEX_FORMAT_DEFAULT);
1320                 version = INDEX_FORMAT_DEFAULT;
1321         }
1322         return version;
1323 }
1324
1325 /*
1326  * dev/ino/uid/gid/size are also just tracked to the low 32 bits
1327  * Again - this is just a (very strong in practice) heuristic that
1328  * the inode hasn't changed.
1329  *
1330  * We save the fields in big-endian order to allow using the
1331  * index file over NFS transparently.
1332  */
1333 struct ondisk_cache_entry {
1334         struct cache_time ctime;
1335         struct cache_time mtime;
1336         uint32_t dev;
1337         uint32_t ino;
1338         uint32_t mode;
1339         uint32_t uid;
1340         uint32_t gid;
1341         uint32_t size;
1342         unsigned char sha1[20];
1343         uint16_t flags;
1344         char name[FLEX_ARRAY]; /* more */
1345 };
1346
1347 /*
1348  * This struct is used when CE_EXTENDED bit is 1
1349  * The struct must match ondisk_cache_entry exactly from
1350  * ctime till flags
1351  */
1352 struct ondisk_cache_entry_extended {
1353         struct cache_time ctime;
1354         struct cache_time mtime;
1355         uint32_t dev;
1356         uint32_t ino;
1357         uint32_t mode;
1358         uint32_t uid;
1359         uint32_t gid;
1360         uint32_t size;
1361         unsigned char sha1[20];
1362         uint16_t flags;
1363         uint16_t flags2;
1364         char name[FLEX_ARRAY]; /* more */
1365 };
1366
1367 /* These are only used for v3 or lower */
1368 #define align_flex_name(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
1369 #define ondisk_cache_entry_size(len) align_flex_name(ondisk_cache_entry,len)
1370 #define ondisk_cache_entry_extended_size(len) align_flex_name(ondisk_cache_entry_extended,len)
1371 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
1372                             ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
1373                             ondisk_cache_entry_size(ce_namelen(ce)))
1374
1375 static int verify_hdr(struct cache_header *hdr, unsigned long size)
1376 {
1377         git_SHA_CTX c;
1378         unsigned char sha1[20];
1379         int hdr_version;
1380
1381         if (hdr->hdr_signature != htonl(CACHE_SIGNATURE))
1382                 return error("bad signature");
1383         hdr_version = ntohl(hdr->hdr_version);
1384         if (hdr_version < INDEX_FORMAT_LB || INDEX_FORMAT_UB < hdr_version)
1385                 return error("bad index version %d", hdr_version);
1386         git_SHA1_Init(&c);
1387         git_SHA1_Update(&c, hdr, size - 20);
1388         git_SHA1_Final(sha1, &c);
1389         if (hashcmp(sha1, (unsigned char *)hdr + size - 20))
1390                 return error("bad index file sha1 signature");
1391         return 0;
1392 }
1393
1394 static int read_index_extension(struct index_state *istate,
1395                                 const char *ext, void *data, unsigned long sz)
1396 {
1397         switch (CACHE_EXT(ext)) {
1398         case CACHE_EXT_TREE:
1399                 istate->cache_tree = cache_tree_read(data, sz);
1400                 break;
1401         case CACHE_EXT_RESOLVE_UNDO:
1402                 istate->resolve_undo = resolve_undo_read(data, sz);
1403                 break;
1404         case CACHE_EXT_LINK:
1405                 if (read_link_extension(istate, data, sz))
1406                         return -1;
1407                 break;
1408         case CACHE_EXT_UNTRACKED:
1409                 istate->untracked = read_untracked_extension(data, sz);
1410                 break;
1411         default:
1412                 if (*ext < 'A' || 'Z' < *ext)
1413                         return error("index uses %.4s extension, which we do not understand",
1414                                      ext);
1415                 fprintf(stderr, "ignoring %.4s extension\n", ext);
1416                 break;
1417         }
1418         return 0;
1419 }
1420
1421 int hold_locked_index(struct lock_file *lk, int lock_flags)
1422 {
1423         return hold_lock_file_for_update(lk, get_index_file(), lock_flags);
1424 }
1425
1426 int read_index(struct index_state *istate)
1427 {
1428         return read_index_from(istate, get_index_file());
1429 }
1430
1431 static struct cache_entry *cache_entry_from_ondisk(struct ondisk_cache_entry *ondisk,
1432                                                    unsigned int flags,
1433                                                    const char *name,
1434                                                    size_t len)
1435 {
1436         struct cache_entry *ce = xmalloc(cache_entry_size(len));
1437
1438         ce->ce_stat_data.sd_ctime.sec = get_be32(&ondisk->ctime.sec);
1439         ce->ce_stat_data.sd_mtime.sec = get_be32(&ondisk->mtime.sec);
1440         ce->ce_stat_data.sd_ctime.nsec = get_be32(&ondisk->ctime.nsec);
1441         ce->ce_stat_data.sd_mtime.nsec = get_be32(&ondisk->mtime.nsec);
1442         ce->ce_stat_data.sd_dev   = get_be32(&ondisk->dev);
1443         ce->ce_stat_data.sd_ino   = get_be32(&ondisk->ino);
1444         ce->ce_mode  = get_be32(&ondisk->mode);
1445         ce->ce_stat_data.sd_uid   = get_be32(&ondisk->uid);
1446         ce->ce_stat_data.sd_gid   = get_be32(&ondisk->gid);
1447         ce->ce_stat_data.sd_size  = get_be32(&ondisk->size);
1448         ce->ce_flags = flags & ~CE_NAMEMASK;
1449         ce->ce_namelen = len;
1450         ce->index = 0;
1451         hashcpy(ce->oid.hash, ondisk->sha1);
1452         memcpy(ce->name, name, len);
1453         ce->name[len] = '\0';
1454         return ce;
1455 }
1456
1457 /*
1458  * Adjacent cache entries tend to share the leading paths, so it makes
1459  * sense to only store the differences in later entries.  In the v4
1460  * on-disk format of the index, each on-disk cache entry stores the
1461  * number of bytes to be stripped from the end of the previous name,
1462  * and the bytes to append to the result, to come up with its name.
1463  */
1464 static unsigned long expand_name_field(struct strbuf *name, const char *cp_)
1465 {
1466         const unsigned char *ep, *cp = (const unsigned char *)cp_;
1467         size_t len = decode_varint(&cp);
1468
1469         if (name->len < len)
1470                 die("malformed name field in the index");
1471         strbuf_remove(name, name->len - len, len);
1472         for (ep = cp; *ep; ep++)
1473                 ; /* find the end */
1474         strbuf_add(name, cp, ep - cp);
1475         return (const char *)ep + 1 - cp_;
1476 }
1477
1478 static struct cache_entry *create_from_disk(struct ondisk_cache_entry *ondisk,
1479                                             unsigned long *ent_size,
1480                                             struct strbuf *previous_name)
1481 {
1482         struct cache_entry *ce;
1483         size_t len;
1484         const char *name;
1485         unsigned int flags;
1486
1487         /* On-disk flags are just 16 bits */
1488         flags = get_be16(&ondisk->flags);
1489         len = flags & CE_NAMEMASK;
1490
1491         if (flags & CE_EXTENDED) {
1492                 struct ondisk_cache_entry_extended *ondisk2;
1493                 int extended_flags;
1494                 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1495                 extended_flags = get_be16(&ondisk2->flags2) << 16;
1496                 /* We do not yet understand any bit out of CE_EXTENDED_FLAGS */
1497                 if (extended_flags & ~CE_EXTENDED_FLAGS)
1498                         die("Unknown index entry format %08x", extended_flags);
1499                 flags |= extended_flags;
1500                 name = ondisk2->name;
1501         }
1502         else
1503                 name = ondisk->name;
1504
1505         if (!previous_name) {
1506                 /* v3 and earlier */
1507                 if (len == CE_NAMEMASK)
1508                         len = strlen(name);
1509                 ce = cache_entry_from_ondisk(ondisk, flags, name, len);
1510
1511                 *ent_size = ondisk_ce_size(ce);
1512         } else {
1513                 unsigned long consumed;
1514                 consumed = expand_name_field(previous_name, name);
1515                 ce = cache_entry_from_ondisk(ondisk, flags,
1516                                              previous_name->buf,
1517                                              previous_name->len);
1518
1519                 *ent_size = (name - ((char *)ondisk)) + consumed;
1520         }
1521         return ce;
1522 }
1523
1524 static void check_ce_order(struct index_state *istate)
1525 {
1526         unsigned int i;
1527
1528         for (i = 1; i < istate->cache_nr; i++) {
1529                 struct cache_entry *ce = istate->cache[i - 1];
1530                 struct cache_entry *next_ce = istate->cache[i];
1531                 int name_compare = strcmp(ce->name, next_ce->name);
1532
1533                 if (0 < name_compare)
1534                         die("unordered stage entries in index");
1535                 if (!name_compare) {
1536                         if (!ce_stage(ce))
1537                                 die("multiple stage entries for merged file '%s'",
1538                                     ce->name);
1539                         if (ce_stage(ce) > ce_stage(next_ce))
1540                                 die("unordered stage entries for '%s'",
1541                                     ce->name);
1542                 }
1543         }
1544 }
1545
1546 static void tweak_untracked_cache(struct index_state *istate)
1547 {
1548         switch (git_config_get_untracked_cache()) {
1549         case -1: /* keep: do nothing */
1550                 break;
1551         case 0: /* false */
1552                 remove_untracked_cache(istate);
1553                 break;
1554         case 1: /* true */
1555                 add_untracked_cache(istate);
1556                 break;
1557         default: /* unknown value: do nothing */
1558                 break;
1559         }
1560 }
1561
1562 static void post_read_index_from(struct index_state *istate)
1563 {
1564         check_ce_order(istate);
1565         tweak_untracked_cache(istate);
1566 }
1567
1568 /* remember to discard_cache() before reading a different cache! */
1569 int do_read_index(struct index_state *istate, const char *path, int must_exist)
1570 {
1571         int fd, i;
1572         struct stat st;
1573         unsigned long src_offset;
1574         struct cache_header *hdr;
1575         void *mmap;
1576         size_t mmap_size;
1577         struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
1578
1579         if (istate->initialized)
1580                 return istate->cache_nr;
1581
1582         istate->timestamp.sec = 0;
1583         istate->timestamp.nsec = 0;
1584         fd = open(path, O_RDONLY);
1585         if (fd < 0) {
1586                 if (!must_exist && errno == ENOENT)
1587                         return 0;
1588                 die_errno("%s: index file open failed", path);
1589         }
1590
1591         if (fstat(fd, &st))
1592                 die_errno("cannot stat the open index");
1593
1594         mmap_size = xsize_t(st.st_size);
1595         if (mmap_size < sizeof(struct cache_header) + 20)
1596                 die("index file smaller than expected");
1597
1598         mmap = xmmap(NULL, mmap_size, PROT_READ, MAP_PRIVATE, fd, 0);
1599         if (mmap == MAP_FAILED)
1600                 die_errno("unable to map index file");
1601         close(fd);
1602
1603         hdr = mmap;
1604         if (verify_hdr(hdr, mmap_size) < 0)
1605                 goto unmap;
1606
1607         hashcpy(istate->sha1, (const unsigned char *)hdr + mmap_size - 20);
1608         istate->version = ntohl(hdr->hdr_version);
1609         istate->cache_nr = ntohl(hdr->hdr_entries);
1610         istate->cache_alloc = alloc_nr(istate->cache_nr);
1611         istate->cache = xcalloc(istate->cache_alloc, sizeof(*istate->cache));
1612         istate->initialized = 1;
1613
1614         if (istate->version == 4)
1615                 previous_name = &previous_name_buf;
1616         else
1617                 previous_name = NULL;
1618
1619         src_offset = sizeof(*hdr);
1620         for (i = 0; i < istate->cache_nr; i++) {
1621                 struct ondisk_cache_entry *disk_ce;
1622                 struct cache_entry *ce;
1623                 unsigned long consumed;
1624
1625                 disk_ce = (struct ondisk_cache_entry *)((char *)mmap + src_offset);
1626                 ce = create_from_disk(disk_ce, &consumed, previous_name);
1627                 set_index_entry(istate, i, ce);
1628
1629                 src_offset += consumed;
1630         }
1631         strbuf_release(&previous_name_buf);
1632         istate->timestamp.sec = st.st_mtime;
1633         istate->timestamp.nsec = ST_MTIME_NSEC(st);
1634
1635         while (src_offset <= mmap_size - 20 - 8) {
1636                 /* After an array of active_nr index entries,
1637                  * there can be arbitrary number of extended
1638                  * sections, each of which is prefixed with
1639                  * extension name (4-byte) and section length
1640                  * in 4-byte network byte order.
1641                  */
1642                 uint32_t extsize;
1643                 memcpy(&extsize, (char *)mmap + src_offset + 4, 4);
1644                 extsize = ntohl(extsize);
1645                 if (read_index_extension(istate,
1646                                          (const char *) mmap + src_offset,
1647                                          (char *) mmap + src_offset + 8,
1648                                          extsize) < 0)
1649                         goto unmap;
1650                 src_offset += 8;
1651                 src_offset += extsize;
1652         }
1653         munmap(mmap, mmap_size);
1654         return istate->cache_nr;
1655
1656 unmap:
1657         munmap(mmap, mmap_size);
1658         die("index file corrupt");
1659 }
1660
1661 int read_index_from(struct index_state *istate, const char *path)
1662 {
1663         struct split_index *split_index;
1664         int ret;
1665
1666         /* istate->initialized covers both .git/index and .git/sharedindex.xxx */
1667         if (istate->initialized)
1668                 return istate->cache_nr;
1669
1670         ret = do_read_index(istate, path, 0);
1671
1672         split_index = istate->split_index;
1673         if (!split_index || is_null_sha1(split_index->base_sha1)) {
1674                 post_read_index_from(istate);
1675                 return ret;
1676         }
1677
1678         if (split_index->base)
1679                 discard_index(split_index->base);
1680         else
1681                 split_index->base = xcalloc(1, sizeof(*split_index->base));
1682         ret = do_read_index(split_index->base,
1683                             git_path("sharedindex.%s",
1684                                      sha1_to_hex(split_index->base_sha1)), 1);
1685         if (hashcmp(split_index->base_sha1, split_index->base->sha1))
1686                 die("broken index, expect %s in %s, got %s",
1687                     sha1_to_hex(split_index->base_sha1),
1688                     git_path("sharedindex.%s",
1689                              sha1_to_hex(split_index->base_sha1)),
1690                     sha1_to_hex(split_index->base->sha1));
1691         merge_base_index(istate);
1692         post_read_index_from(istate);
1693         return ret;
1694 }
1695
1696 int is_index_unborn(struct index_state *istate)
1697 {
1698         return (!istate->cache_nr && !istate->timestamp.sec);
1699 }
1700
1701 int discard_index(struct index_state *istate)
1702 {
1703         int i;
1704
1705         for (i = 0; i < istate->cache_nr; i++) {
1706                 if (istate->cache[i]->index &&
1707                     istate->split_index &&
1708                     istate->split_index->base &&
1709                     istate->cache[i]->index <= istate->split_index->base->cache_nr &&
1710                     istate->cache[i] == istate->split_index->base->cache[istate->cache[i]->index - 1])
1711                         continue;
1712                 free(istate->cache[i]);
1713         }
1714         resolve_undo_clear_index(istate);
1715         istate->cache_nr = 0;
1716         istate->cache_changed = 0;
1717         istate->timestamp.sec = 0;
1718         istate->timestamp.nsec = 0;
1719         free_name_hash(istate);
1720         cache_tree_free(&(istate->cache_tree));
1721         istate->initialized = 0;
1722         free(istate->cache);
1723         istate->cache = NULL;
1724         istate->cache_alloc = 0;
1725         discard_split_index(istate);
1726         free_untracked_cache(istate->untracked);
1727         istate->untracked = NULL;
1728         return 0;
1729 }
1730
1731 int unmerged_index(const struct index_state *istate)
1732 {
1733         int i;
1734         for (i = 0; i < istate->cache_nr; i++) {
1735                 if (ce_stage(istate->cache[i]))
1736                         return 1;
1737         }
1738         return 0;
1739 }
1740
1741 #define WRITE_BUFFER_SIZE 8192
1742 static unsigned char write_buffer[WRITE_BUFFER_SIZE];
1743 static unsigned long write_buffer_len;
1744
1745 static int ce_write_flush(git_SHA_CTX *context, int fd)
1746 {
1747         unsigned int buffered = write_buffer_len;
1748         if (buffered) {
1749                 git_SHA1_Update(context, write_buffer, buffered);
1750                 if (write_in_full(fd, write_buffer, buffered) != buffered)
1751                         return -1;
1752                 write_buffer_len = 0;
1753         }
1754         return 0;
1755 }
1756
1757 static int ce_write(git_SHA_CTX *context, int fd, void *data, unsigned int len)
1758 {
1759         while (len) {
1760                 unsigned int buffered = write_buffer_len;
1761                 unsigned int partial = WRITE_BUFFER_SIZE - buffered;
1762                 if (partial > len)
1763                         partial = len;
1764                 memcpy(write_buffer + buffered, data, partial);
1765                 buffered += partial;
1766                 if (buffered == WRITE_BUFFER_SIZE) {
1767                         write_buffer_len = buffered;
1768                         if (ce_write_flush(context, fd))
1769                                 return -1;
1770                         buffered = 0;
1771                 }
1772                 write_buffer_len = buffered;
1773                 len -= partial;
1774                 data = (char *) data + partial;
1775         }
1776         return 0;
1777 }
1778
1779 static int write_index_ext_header(git_SHA_CTX *context, int fd,
1780                                   unsigned int ext, unsigned int sz)
1781 {
1782         ext = htonl(ext);
1783         sz = htonl(sz);
1784         return ((ce_write(context, fd, &ext, 4) < 0) ||
1785                 (ce_write(context, fd, &sz, 4) < 0)) ? -1 : 0;
1786 }
1787
1788 static int ce_flush(git_SHA_CTX *context, int fd, unsigned char *sha1)
1789 {
1790         unsigned int left = write_buffer_len;
1791
1792         if (left) {
1793                 write_buffer_len = 0;
1794                 git_SHA1_Update(context, write_buffer, left);
1795         }
1796
1797         /* Flush first if not enough space for SHA1 signature */
1798         if (left + 20 > WRITE_BUFFER_SIZE) {
1799                 if (write_in_full(fd, write_buffer, left) != left)
1800                         return -1;
1801                 left = 0;
1802         }
1803
1804         /* Append the SHA1 signature at the end */
1805         git_SHA1_Final(write_buffer + left, context);
1806         hashcpy(sha1, write_buffer + left);
1807         left += 20;
1808         return (write_in_full(fd, write_buffer, left) != left) ? -1 : 0;
1809 }
1810
1811 static void ce_smudge_racily_clean_entry(struct cache_entry *ce)
1812 {
1813         /*
1814          * The only thing we care about in this function is to smudge the
1815          * falsely clean entry due to touch-update-touch race, so we leave
1816          * everything else as they are.  We are called for entries whose
1817          * ce_stat_data.sd_mtime match the index file mtime.
1818          *
1819          * Note that this actually does not do much for gitlinks, for
1820          * which ce_match_stat_basic() always goes to the actual
1821          * contents.  The caller checks with is_racy_timestamp() which
1822          * always says "no" for gitlinks, so we are not called for them ;-)
1823          */
1824         struct stat st;
1825
1826         if (lstat(ce->name, &st) < 0)
1827                 return;
1828         if (ce_match_stat_basic(ce, &st))
1829                 return;
1830         if (ce_modified_check_fs(ce, &st)) {
1831                 /* This is "racily clean"; smudge it.  Note that this
1832                  * is a tricky code.  At first glance, it may appear
1833                  * that it can break with this sequence:
1834                  *
1835                  * $ echo xyzzy >frotz
1836                  * $ git-update-index --add frotz
1837                  * $ : >frotz
1838                  * $ sleep 3
1839                  * $ echo filfre >nitfol
1840                  * $ git-update-index --add nitfol
1841                  *
1842                  * but it does not.  When the second update-index runs,
1843                  * it notices that the entry "frotz" has the same timestamp
1844                  * as index, and if we were to smudge it by resetting its
1845                  * size to zero here, then the object name recorded
1846                  * in index is the 6-byte file but the cached stat information
1847                  * becomes zero --- which would then match what we would
1848                  * obtain from the filesystem next time we stat("frotz").
1849                  *
1850                  * However, the second update-index, before calling
1851                  * this function, notices that the cached size is 6
1852                  * bytes and what is on the filesystem is an empty
1853                  * file, and never calls us, so the cached size information
1854                  * for "frotz" stays 6 which does not match the filesystem.
1855                  */
1856                 ce->ce_stat_data.sd_size = 0;
1857         }
1858 }
1859
1860 /* Copy miscellaneous fields but not the name */
1861 static char *copy_cache_entry_to_ondisk(struct ondisk_cache_entry *ondisk,
1862                                        struct cache_entry *ce)
1863 {
1864         short flags;
1865
1866         ondisk->ctime.sec = htonl(ce->ce_stat_data.sd_ctime.sec);
1867         ondisk->mtime.sec = htonl(ce->ce_stat_data.sd_mtime.sec);
1868         ondisk->ctime.nsec = htonl(ce->ce_stat_data.sd_ctime.nsec);
1869         ondisk->mtime.nsec = htonl(ce->ce_stat_data.sd_mtime.nsec);
1870         ondisk->dev  = htonl(ce->ce_stat_data.sd_dev);
1871         ondisk->ino  = htonl(ce->ce_stat_data.sd_ino);
1872         ondisk->mode = htonl(ce->ce_mode);
1873         ondisk->uid  = htonl(ce->ce_stat_data.sd_uid);
1874         ondisk->gid  = htonl(ce->ce_stat_data.sd_gid);
1875         ondisk->size = htonl(ce->ce_stat_data.sd_size);
1876         hashcpy(ondisk->sha1, ce->oid.hash);
1877
1878         flags = ce->ce_flags & ~CE_NAMEMASK;
1879         flags |= (ce_namelen(ce) >= CE_NAMEMASK ? CE_NAMEMASK : ce_namelen(ce));
1880         ondisk->flags = htons(flags);
1881         if (ce->ce_flags & CE_EXTENDED) {
1882                 struct ondisk_cache_entry_extended *ondisk2;
1883                 ondisk2 = (struct ondisk_cache_entry_extended *)ondisk;
1884                 ondisk2->flags2 = htons((ce->ce_flags & CE_EXTENDED_FLAGS) >> 16);
1885                 return ondisk2->name;
1886         }
1887         else {
1888                 return ondisk->name;
1889         }
1890 }
1891
1892 static int ce_write_entry(git_SHA_CTX *c, int fd, struct cache_entry *ce,
1893                           struct strbuf *previous_name)
1894 {
1895         int size;
1896         struct ondisk_cache_entry *ondisk;
1897         int saved_namelen = saved_namelen; /* compiler workaround */
1898         char *name;
1899         int result;
1900
1901         if (ce->ce_flags & CE_STRIP_NAME) {
1902                 saved_namelen = ce_namelen(ce);
1903                 ce->ce_namelen = 0;
1904         }
1905
1906         if (!previous_name) {
1907                 size = ondisk_ce_size(ce);
1908                 ondisk = xcalloc(1, size);
1909                 name = copy_cache_entry_to_ondisk(ondisk, ce);
1910                 memcpy(name, ce->name, ce_namelen(ce));
1911         } else {
1912                 int common, to_remove, prefix_size;
1913                 unsigned char to_remove_vi[16];
1914                 for (common = 0;
1915                      (ce->name[common] &&
1916                       common < previous_name->len &&
1917                       ce->name[common] == previous_name->buf[common]);
1918                      common++)
1919                         ; /* still matching */
1920                 to_remove = previous_name->len - common;
1921                 prefix_size = encode_varint(to_remove, to_remove_vi);
1922
1923                 if (ce->ce_flags & CE_EXTENDED)
1924                         size = offsetof(struct ondisk_cache_entry_extended, name);
1925                 else
1926                         size = offsetof(struct ondisk_cache_entry, name);
1927                 size += prefix_size + (ce_namelen(ce) - common + 1);
1928
1929                 ondisk = xcalloc(1, size);
1930                 name = copy_cache_entry_to_ondisk(ondisk, ce);
1931                 memcpy(name, to_remove_vi, prefix_size);
1932                 memcpy(name + prefix_size, ce->name + common, ce_namelen(ce) - common);
1933
1934                 strbuf_splice(previous_name, common, to_remove,
1935                               ce->name + common, ce_namelen(ce) - common);
1936         }
1937         if (ce->ce_flags & CE_STRIP_NAME) {
1938                 ce->ce_namelen = saved_namelen;
1939                 ce->ce_flags &= ~CE_STRIP_NAME;
1940         }
1941
1942         result = ce_write(c, fd, ondisk, size);
1943         free(ondisk);
1944         return result;
1945 }
1946
1947 /*
1948  * This function verifies if index_state has the correct sha1 of the
1949  * index file.  Don't die if we have any other failure, just return 0.
1950  */
1951 static int verify_index_from(const struct index_state *istate, const char *path)
1952 {
1953         int fd;
1954         ssize_t n;
1955         struct stat st;
1956         unsigned char sha1[20];
1957
1958         if (!istate->initialized)
1959                 return 0;
1960
1961         fd = open(path, O_RDONLY);
1962         if (fd < 0)
1963                 return 0;
1964
1965         if (fstat(fd, &st))
1966                 goto out;
1967
1968         if (st.st_size < sizeof(struct cache_header) + 20)
1969                 goto out;
1970
1971         n = pread_in_full(fd, sha1, 20, st.st_size - 20);
1972         if (n != 20)
1973                 goto out;
1974
1975         if (hashcmp(istate->sha1, sha1))
1976                 goto out;
1977
1978         close(fd);
1979         return 1;
1980
1981 out:
1982         close(fd);
1983         return 0;
1984 }
1985
1986 static int verify_index(const struct index_state *istate)
1987 {
1988         return verify_index_from(istate, get_index_file());
1989 }
1990
1991 static int has_racy_timestamp(struct index_state *istate)
1992 {
1993         int entries = istate->cache_nr;
1994         int i;
1995
1996         for (i = 0; i < entries; i++) {
1997                 struct cache_entry *ce = istate->cache[i];
1998                 if (is_racy_timestamp(istate, ce))
1999                         return 1;
2000         }
2001         return 0;
2002 }
2003
2004 /*
2005  * Opportunistically update the index but do not complain if we can't
2006  */
2007 void update_index_if_able(struct index_state *istate, struct lock_file *lockfile)
2008 {
2009         if ((istate->cache_changed || has_racy_timestamp(istate)) &&
2010             verify_index(istate) &&
2011             write_locked_index(istate, lockfile, COMMIT_LOCK))
2012                 rollback_lock_file(lockfile);
2013 }
2014
2015 static int do_write_index(struct index_state *istate, int newfd,
2016                           int strip_extensions)
2017 {
2018         git_SHA_CTX c;
2019         struct cache_header hdr;
2020         int i, err, removed, extended, hdr_version;
2021         struct cache_entry **cache = istate->cache;
2022         int entries = istate->cache_nr;
2023         struct stat st;
2024         struct strbuf previous_name_buf = STRBUF_INIT, *previous_name;
2025
2026         for (i = removed = extended = 0; i < entries; i++) {
2027                 if (cache[i]->ce_flags & CE_REMOVE)
2028                         removed++;
2029
2030                 /* reduce extended entries if possible */
2031                 cache[i]->ce_flags &= ~CE_EXTENDED;
2032                 if (cache[i]->ce_flags & CE_EXTENDED_FLAGS) {
2033                         extended++;
2034                         cache[i]->ce_flags |= CE_EXTENDED;
2035                 }
2036         }
2037
2038         if (!istate->version) {
2039                 istate->version = get_index_format_default();
2040                 if (getenv("GIT_TEST_SPLIT_INDEX"))
2041                         init_split_index(istate);
2042         }
2043
2044         /* demote version 3 to version 2 when the latter suffices */
2045         if (istate->version == 3 || istate->version == 2)
2046                 istate->version = extended ? 3 : 2;
2047
2048         hdr_version = istate->version;
2049
2050         hdr.hdr_signature = htonl(CACHE_SIGNATURE);
2051         hdr.hdr_version = htonl(hdr_version);
2052         hdr.hdr_entries = htonl(entries - removed);
2053
2054         git_SHA1_Init(&c);
2055         if (ce_write(&c, newfd, &hdr, sizeof(hdr)) < 0)
2056                 return -1;
2057
2058         previous_name = (hdr_version == 4) ? &previous_name_buf : NULL;
2059         for (i = 0; i < entries; i++) {
2060                 struct cache_entry *ce = cache[i];
2061                 if (ce->ce_flags & CE_REMOVE)
2062                         continue;
2063                 if (!ce_uptodate(ce) && is_racy_timestamp(istate, ce))
2064                         ce_smudge_racily_clean_entry(ce);
2065                 if (is_null_oid(&ce->oid)) {
2066                         static const char msg[] = "cache entry has null sha1: %s";
2067                         static int allow = -1;
2068
2069                         if (allow < 0)
2070                                 allow = git_env_bool("GIT_ALLOW_NULL_SHA1", 0);
2071                         if (allow)
2072                                 warning(msg, ce->name);
2073                         else
2074                                 return error(msg, ce->name);
2075                 }
2076                 if (ce_write_entry(&c, newfd, ce, previous_name) < 0)
2077                         return -1;
2078         }
2079         strbuf_release(&previous_name_buf);
2080
2081         /* Write extension data here */
2082         if (!strip_extensions && istate->split_index) {
2083                 struct strbuf sb = STRBUF_INIT;
2084
2085                 err = write_link_extension(&sb, istate) < 0 ||
2086                         write_index_ext_header(&c, newfd, CACHE_EXT_LINK,
2087                                                sb.len) < 0 ||
2088                         ce_write(&c, newfd, sb.buf, sb.len) < 0;
2089                 strbuf_release(&sb);
2090                 if (err)
2091                         return -1;
2092         }
2093         if (!strip_extensions && istate->cache_tree) {
2094                 struct strbuf sb = STRBUF_INIT;
2095
2096                 cache_tree_write(&sb, istate->cache_tree);
2097                 err = write_index_ext_header(&c, newfd, CACHE_EXT_TREE, sb.len) < 0
2098                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2099                 strbuf_release(&sb);
2100                 if (err)
2101                         return -1;
2102         }
2103         if (!strip_extensions && istate->resolve_undo) {
2104                 struct strbuf sb = STRBUF_INIT;
2105
2106                 resolve_undo_write(&sb, istate->resolve_undo);
2107                 err = write_index_ext_header(&c, newfd, CACHE_EXT_RESOLVE_UNDO,
2108                                              sb.len) < 0
2109                         || ce_write(&c, newfd, sb.buf, sb.len) < 0;
2110                 strbuf_release(&sb);
2111                 if (err)
2112                         return -1;
2113         }
2114         if (!strip_extensions && istate->untracked) {
2115                 struct strbuf sb = STRBUF_INIT;
2116
2117                 write_untracked_extension(&sb, istate->untracked);
2118                 err = write_index_ext_header(&c, newfd, CACHE_EXT_UNTRACKED,
2119                                              sb.len) < 0 ||
2120                         ce_write(&c, newfd, sb.buf, sb.len) < 0;
2121                 strbuf_release(&sb);
2122                 if (err)
2123                         return -1;
2124         }
2125
2126         if (ce_flush(&c, newfd, istate->sha1) || fstat(newfd, &st))
2127                 return -1;
2128         istate->timestamp.sec = (unsigned int)st.st_mtime;
2129         istate->timestamp.nsec = ST_MTIME_NSEC(st);
2130         return 0;
2131 }
2132
2133 void set_alternate_index_output(const char *name)
2134 {
2135         alternate_index_output = name;
2136 }
2137
2138 static int commit_locked_index(struct lock_file *lk)
2139 {
2140         if (alternate_index_output)
2141                 return commit_lock_file_to(lk, alternate_index_output);
2142         else
2143                 return commit_lock_file(lk);
2144 }
2145
2146 static int do_write_locked_index(struct index_state *istate, struct lock_file *lock,
2147                                  unsigned flags)
2148 {
2149         int ret = do_write_index(istate, get_lock_file_fd(lock), 0);
2150         if (ret)
2151                 return ret;
2152         assert((flags & (COMMIT_LOCK | CLOSE_LOCK)) !=
2153                (COMMIT_LOCK | CLOSE_LOCK));
2154         if (flags & COMMIT_LOCK)
2155                 return commit_locked_index(lock);
2156         else if (flags & CLOSE_LOCK)
2157                 return close_lock_file(lock);
2158         else
2159                 return ret;
2160 }
2161
2162 static int write_split_index(struct index_state *istate,
2163                              struct lock_file *lock,
2164                              unsigned flags)
2165 {
2166         int ret;
2167         prepare_to_write_split_index(istate);
2168         ret = do_write_locked_index(istate, lock, flags);
2169         finish_writing_split_index(istate);
2170         return ret;
2171 }
2172
2173 static struct tempfile temporary_sharedindex;
2174
2175 static int write_shared_index(struct index_state *istate,
2176                               struct lock_file *lock, unsigned flags)
2177 {
2178         struct split_index *si = istate->split_index;
2179         int fd, ret;
2180
2181         fd = mks_tempfile(&temporary_sharedindex, git_path("sharedindex_XXXXXX"));
2182         if (fd < 0) {
2183                 hashclr(si->base_sha1);
2184                 return do_write_locked_index(istate, lock, flags);
2185         }
2186         move_cache_to_base_index(istate);
2187         ret = do_write_index(si->base, fd, 1);
2188         if (ret) {
2189                 delete_tempfile(&temporary_sharedindex);
2190                 return ret;
2191         }
2192         ret = rename_tempfile(&temporary_sharedindex,
2193                               git_path("sharedindex.%s", sha1_to_hex(si->base->sha1)));
2194         if (!ret)
2195                 hashcpy(si->base_sha1, si->base->sha1);
2196         return ret;
2197 }
2198
2199 int write_locked_index(struct index_state *istate, struct lock_file *lock,
2200                        unsigned flags)
2201 {
2202         struct split_index *si = istate->split_index;
2203
2204         if (!si || alternate_index_output ||
2205             (istate->cache_changed & ~EXTMASK)) {
2206                 if (si)
2207                         hashclr(si->base_sha1);
2208                 return do_write_locked_index(istate, lock, flags);
2209         }
2210
2211         if (getenv("GIT_TEST_SPLIT_INDEX")) {
2212                 int v = si->base_sha1[0];
2213                 if ((v & 15) < 6)
2214                         istate->cache_changed |= SPLIT_INDEX_ORDERED;
2215         }
2216         if (istate->cache_changed & SPLIT_INDEX_ORDERED) {
2217                 int ret = write_shared_index(istate, lock, flags);
2218                 if (ret)
2219                         return ret;
2220         }
2221
2222         return write_split_index(istate, lock, flags);
2223 }
2224
2225 /*
2226  * Read the index file that is potentially unmerged into given
2227  * index_state, dropping any unmerged entries.  Returns true if
2228  * the index is unmerged.  Callers who want to refuse to work
2229  * from an unmerged state can call this and check its return value,
2230  * instead of calling read_cache().
2231  */
2232 int read_index_unmerged(struct index_state *istate)
2233 {
2234         int i;
2235         int unmerged = 0;
2236
2237         read_index(istate);
2238         for (i = 0; i < istate->cache_nr; i++) {
2239                 struct cache_entry *ce = istate->cache[i];
2240                 struct cache_entry *new_ce;
2241                 int size, len;
2242
2243                 if (!ce_stage(ce))
2244                         continue;
2245                 unmerged = 1;
2246                 len = ce_namelen(ce);
2247                 size = cache_entry_size(len);
2248                 new_ce = xcalloc(1, size);
2249                 memcpy(new_ce->name, ce->name, len);
2250                 new_ce->ce_flags = create_ce_flags(0) | CE_CONFLICTED;
2251                 new_ce->ce_namelen = len;
2252                 new_ce->ce_mode = ce->ce_mode;
2253                 if (add_index_entry(istate, new_ce, 0))
2254                         return error("%s: cannot drop to stage #0",
2255                                      new_ce->name);
2256         }
2257         return unmerged;
2258 }
2259
2260 /*
2261  * Returns 1 if the path is an "other" path with respect to
2262  * the index; that is, the path is not mentioned in the index at all,
2263  * either as a file, a directory with some files in the index,
2264  * or as an unmerged entry.
2265  *
2266  * We helpfully remove a trailing "/" from directories so that
2267  * the output of read_directory can be used as-is.
2268  */
2269 int index_name_is_other(const struct index_state *istate, const char *name,
2270                 int namelen)
2271 {
2272         int pos;
2273         if (namelen && name[namelen - 1] == '/')
2274                 namelen--;
2275         pos = index_name_pos(istate, name, namelen);
2276         if (0 <= pos)
2277                 return 0;       /* exact match */
2278         pos = -pos - 1;
2279         if (pos < istate->cache_nr) {
2280                 struct cache_entry *ce = istate->cache[pos];
2281                 if (ce_namelen(ce) == namelen &&
2282                     !memcmp(ce->name, name, namelen))
2283                         return 0; /* Yup, this one exists unmerged */
2284         }
2285         return 1;
2286 }
2287
2288 void *read_blob_data_from_index(struct index_state *istate, const char *path, unsigned long *size)
2289 {
2290         int pos, len;
2291         unsigned long sz;
2292         enum object_type type;
2293         void *data;
2294
2295         len = strlen(path);
2296         pos = index_name_pos(istate, path, len);
2297         if (pos < 0) {
2298                 /*
2299                  * We might be in the middle of a merge, in which
2300                  * case we would read stage #2 (ours).
2301                  */
2302                 int i;
2303                 for (i = -pos - 1;
2304                      (pos < 0 && i < istate->cache_nr &&
2305                       !strcmp(istate->cache[i]->name, path));
2306                      i++)
2307                         if (ce_stage(istate->cache[i]) == 2)
2308                                 pos = i;
2309         }
2310         if (pos < 0)
2311                 return NULL;
2312         data = read_sha1_file(istate->cache[pos]->oid.hash, &type, &sz);
2313         if (!data || type != OBJ_BLOB) {
2314                 free(data);
2315                 return NULL;
2316         }
2317         if (size)
2318                 *size = sz;
2319         return data;
2320 }
2321
2322 void stat_validity_clear(struct stat_validity *sv)
2323 {
2324         free(sv->sd);
2325         sv->sd = NULL;
2326 }
2327
2328 int stat_validity_check(struct stat_validity *sv, const char *path)
2329 {
2330         struct stat st;
2331
2332         if (stat(path, &st) < 0)
2333                 return sv->sd == NULL;
2334         if (!sv->sd)
2335                 return 0;
2336         return S_ISREG(st.st_mode) && !match_stat_data(sv->sd, &st);
2337 }
2338
2339 void stat_validity_update(struct stat_validity *sv, int fd)
2340 {
2341         struct stat st;
2342
2343         if (fstat(fd, &st) < 0 || !S_ISREG(st.st_mode))
2344                 stat_validity_clear(sv);
2345         else {
2346                 if (!sv->sd)
2347                         sv->sd = xcalloc(1, sizeof(struct stat_data));
2348                 fill_stat_data(sv->sd, &st);
2349         }
2350 }