fsmonitor: teach git to optionally utilize a file system monitor to speed up detectin...
[git/git.git] / entry.c
CommitLineData
12dccc16 1#include "cache.h"
8e440259 2#include "blob.h"
8ca12c0d 3#include "dir.h"
dd8e9121 4#include "streaming.h"
6d14eac3 5#include "submodule.h"
52f1d62e 6#include "progress.h"
883e248b 7#include "fsmonitor.h"
12dccc16 8
81a9aa60
KB
9static void create_directories(const char *path, int path_len,
10 const struct checkout *state)
12dccc16 11{
3733e694 12 char *buf = xmallocz(path_len);
81a9aa60
KB
13 int len = 0;
14
15 while (len < path_len) {
16 do {
17 buf[len] = path[len];
18 len++;
19 } while (len < path_len && path[len] != '/');
20 if (len >= path_len)
21 break;
12dccc16 22 buf[len] = 0;
fa2e71c9 23
bad4a54f
KB
24 /*
25 * For 'checkout-index --prefix=<dir>', <dir> is
26 * allowed to be a symlink to an existing directory,
27 * and we set 'state->base_dir_len' below, such that
28 * we test the path components of the prefix with the
29 * stat() function instead of the lstat() function.
30 */
57199892 31 if (has_dirs_only_path(buf, len, state->base_dir_len))
fa2e71c9
JH
32 continue; /* ok, it is already a directory. */
33
34 /*
bad4a54f
KB
35 * If this mkdir() would fail, it could be that there
36 * is already a symlink or something else exists
37 * there, therefore we then try to unlink it and try
38 * one more time to create the directory.
fa2e71c9 39 */
f312de01 40 if (mkdir(buf, 0777)) {
fa2e71c9 41 if (errno == EEXIST && state->force &&
691f1a28 42 !unlink_or_warn(buf) && !mkdir(buf, 0777))
fa2e71c9 43 continue;
0721c314 44 die_errno("cannot create directory at '%s'", buf);
12dccc16
LT
45 }
46 }
47 free(buf);
48}
49
2f29e0c6 50static void remove_subtree(struct strbuf *path)
12dccc16 51{
2f29e0c6 52 DIR *dir = opendir(path->buf);
12dccc16 53 struct dirent *de;
2f29e0c6 54 int origlen = path->len;
a6080a0a 55
12dccc16 56 if (!dir)
2f29e0c6 57 die_errno("cannot opendir '%s'", path->buf);
12dccc16
LT
58 while ((de = readdir(dir)) != NULL) {
59 struct stat st;
2f29e0c6 60
8ca12c0d 61 if (is_dot_or_dotdot(de->d_name))
12dccc16 62 continue;
2f29e0c6
MH
63
64 strbuf_addch(path, '/');
65 strbuf_addstr(path, de->d_name);
66 if (lstat(path->buf, &st))
67 die_errno("cannot lstat '%s'", path->buf);
12dccc16 68 if (S_ISDIR(st.st_mode))
2f29e0c6
MH
69 remove_subtree(path);
70 else if (unlink(path->buf))
71 die_errno("cannot unlink '%s'", path->buf);
72 strbuf_setlen(path, origlen);
12dccc16
LT
73 }
74 closedir(dir);
2f29e0c6
MH
75 if (rmdir(path->buf))
76 die_errno("cannot rmdir '%s'", path->buf);
12dccc16
LT
77}
78
d48a72f3 79static int create_file(const char *path, unsigned int mode)
12dccc16 80{
12dccc16 81 mode = (mode & 0100) ? 0777 : 0666;
781411ed 82 return open(path, O_WRONLY | O_CREAT | O_EXCL, mode);
12dccc16
LT
83}
84
9c5e6c80 85static void *read_blob_entry(const struct cache_entry *ce, unsigned long *size)
f0807e62
LT
86{
87 enum object_type type;
99d1a986 88 void *new = read_sha1_file(ce->oid.hash, &type, size);
f0807e62
LT
89
90 if (new) {
91 if (type == OBJ_BLOB)
92 return new;
93 free(new);
94 }
95 return NULL;
96}
97
9c5e6c80 98static int open_output_fd(char *path, const struct cache_entry *ce, int to_tempfile)
fd5db55d
JH
99{
100 int symlink = (ce->ce_mode & S_IFMT) != S_IFREG;
101 if (to_tempfile) {
330c8e26
JK
102 xsnprintf(path, TEMPORARY_FILENAME_LENGTH, "%s",
103 symlink ? ".merge_link_XXXXXX" : ".merge_file_XXXXXX");
fd5db55d
JH
104 return mkstemp(path);
105 } else {
106 return create_file(path, !symlink ? ce->ce_mode : 0666);
107 }
108}
109
110static int fstat_output(int fd, const struct checkout *state, struct stat *st)
111{
112 /* use fstat() only when path == ce->name */
113 if (fstat_is_reliable() &&
114 state->refresh_cache && !state->base_dir_len) {
115 fstat(fd, st);
116 return 1;
117 }
118 return 0;
119}
120
9c5e6c80 121static int streaming_write_entry(const struct cache_entry *ce, char *path,
b6691092 122 struct stream_filter *filter,
dd8e9121
JH
123 const struct checkout *state, int to_tempfile,
124 int *fstat_done, struct stat *statbuf)
125{
d9c31e14 126 int result = 0;
47a02ff2 127 int fd;
dd8e9121
JH
128
129 fd = open_output_fd(path, ce, to_tempfile);
d9c31e14
JK
130 if (fd < 0)
131 return -1;
132
7eda0e4f 133 result |= stream_blob_to_fd(fd, &ce->oid, filter, 1);
d9c31e14
JK
134 *fstat_done = fstat_output(fd, state, statbuf);
135 result |= close(fd);
136
137 if (result)
dd8e9121
JH
138 unlink(path);
139 return result;
140}
141
2841e8f8
LS
142void enable_delayed_checkout(struct checkout *state)
143{
144 if (!state->delayed_checkout) {
145 state->delayed_checkout = xmalloc(sizeof(*state->delayed_checkout));
146 state->delayed_checkout->state = CE_CAN_DELAY;
147 string_list_init(&state->delayed_checkout->filters, 0);
148 string_list_init(&state->delayed_checkout->paths, 0);
149 }
150}
151
152static int remove_available_paths(struct string_list_item *item, void *cb_data)
153{
154 struct string_list *available_paths = cb_data;
155 struct string_list_item *available;
156
157 available = string_list_lookup(available_paths, item->string);
158 if (available)
159 available->util = (void *)item->string;
160 return !available;
161}
162
163int finish_delayed_checkout(struct checkout *state)
164{
165 int errs = 0;
52f1d62e
LS
166 unsigned delayed_object_count;
167 off_t filtered_bytes = 0;
2841e8f8 168 struct string_list_item *filter, *path;
52f1d62e 169 struct progress *progress;
2841e8f8
LS
170 struct delayed_checkout *dco = state->delayed_checkout;
171
172 if (!state->delayed_checkout)
173 return errs;
174
175 dco->state = CE_RETRY;
52f1d62e 176 delayed_object_count = dco->paths.nr;
7fbbd3ec 177 progress = start_delayed_progress(_("Filtering content"), delayed_object_count);
2841e8f8
LS
178 while (dco->filters.nr > 0) {
179 for_each_string_list_item(filter, &dco->filters) {
180 struct string_list available_paths = STRING_LIST_INIT_NODUP;
52f1d62e 181 display_progress(progress, delayed_object_count - dco->paths.nr);
2841e8f8
LS
182
183 if (!async_query_available_blobs(filter->string, &available_paths)) {
184 /* Filter reported an error */
185 errs = 1;
186 filter->string = "";
187 continue;
188 }
189 if (available_paths.nr <= 0) {
190 /*
191 * Filter responded with no entries. That means
192 * the filter is done and we can remove the
193 * filter from the list (see
194 * "string_list_remove_empty_items" call below).
195 */
196 filter->string = "";
197 continue;
198 }
199
200 /*
201 * In dco->paths we store a list of all delayed paths.
202 * The filter just send us a list of available paths.
203 * Remove them from the list.
204 */
205 filter_string_list(&dco->paths, 0,
206 &remove_available_paths, &available_paths);
207
208 for_each_string_list_item(path, &available_paths) {
209 struct cache_entry* ce;
210
211 if (!path->util) {
212 error("external filter '%s' signaled that '%s' "
213 "is now available although it has not been "
214 "delayed earlier",
215 filter->string, path->string);
216 errs |= 1;
217
218 /*
219 * Do not ask the filter for available blobs,
220 * again, as the filter is likely buggy.
221 */
222 filter->string = "";
223 continue;
224 }
225 ce = index_file_exists(state->istate, path->string,
226 strlen(path->string), 0);
52f1d62e
LS
227 if (ce) {
228 errs |= checkout_entry(ce, state, NULL);
229 filtered_bytes += ce->ce_stat_data.sd_size;
230 display_throughput(progress, filtered_bytes);
231 } else
232 errs = 1;
2841e8f8
LS
233 }
234 }
235 string_list_remove_empty_items(&dco->filters, 0);
236 }
52f1d62e 237 stop_progress(&progress);
2841e8f8
LS
238 string_list_clear(&dco->filters, 0);
239
240 /* At this point we should not have any delayed paths anymore. */
241 errs |= dco->paths.nr;
242 for_each_string_list_item(path, &dco->paths) {
243 error("'%s' was not filtered properly", path->string);
244 }
245 string_list_clear(&dco->paths, 0);
246
247 free(dco);
248 state->delayed_checkout = NULL;
249
250 return errs;
251}
252
9c5e6c80
NTND
253static int write_entry(struct cache_entry *ce,
254 char *path, const struct checkout *state, int to_tempfile)
12dccc16 255{
4857c761 256 unsigned int ce_mode_s_ifmt = ce->ce_mode & S_IFMT;
e4c72923 257 int fd, ret, fstat_done = 0;
4857c761
KB
258 char *new;
259 struct strbuf buf = STRBUF_INIT;
260 unsigned long size;
261 size_t wrote, newsize = 0;
e4c72923 262 struct stat st;
6d14eac3 263 const struct submodule *sub;
4857c761 264
b6691092 265 if (ce_mode_s_ifmt == S_IFREG) {
99d1a986 266 struct stream_filter *filter = get_stream_filter(ce->name,
267 ce->oid.hash);
b6691092
JH
268 if (filter &&
269 !streaming_write_entry(ce, path, filter,
270 state, to_tempfile,
271 &fstat_done, &st))
272 goto finish;
273 }
dd8e9121 274
4857c761 275 switch (ce_mode_s_ifmt) {
12dccc16 276 case S_IFREG:
4857c761
KB
277 case S_IFLNK:
278 new = read_blob_entry(ce, &size);
f0807e62 279 if (!new)
d43e9073 280 return error("unable to read sha1 file of %s (%s)",
99d1a986 281 path, oid_to_hex(&ce->oid));
1a9d7e9b 282
4857c761
KB
283 if (ce_mode_s_ifmt == S_IFLNK && has_symlinks && !to_tempfile) {
284 ret = symlink(new, path);
285 free(new);
286 if (ret)
e1ebb3c2
NTND
287 return error_errno("unable to create symlink %s",
288 path);
4857c761
KB
289 break;
290 }
291
1a9d7e9b
JH
292 /*
293 * Convert from git internal format to working tree format
294 */
2841e8f8
LS
295 if (ce_mode_s_ifmt == S_IFREG) {
296 struct delayed_checkout *dco = state->delayed_checkout;
297 if (dco && dco->state != CE_NO_DELAY) {
298 /* Do not send the blob in case of a retry. */
299 if (dco->state == CE_RETRY) {
300 new = NULL;
301 size = 0;
302 }
303 ret = async_convert_to_working_tree(
304 ce->name, new, size, &buf, dco);
305 if (ret && string_list_has_string(&dco->paths, ce->name)) {
306 free(new);
307 goto finish;
308 }
309 } else
310 ret = convert_to_working_tree(
311 ce->name, new, size, &buf);
312
313 if (ret) {
314 free(new);
315 new = strbuf_detach(&buf, &newsize);
316 size = newsize;
317 }
318 /*
319 * No "else" here as errors from convert are OK at this
320 * point. If the error would have been fatal (e.g.
321 * filter is required), then we would have died already.
322 */
1a9d7e9b
JH
323 }
324
fd5db55d 325 fd = open_output_fd(path, ce, to_tempfile);
12dccc16
LT
326 if (fd < 0) {
327 free(new);
e1ebb3c2 328 return error_errno("unable to create file %s", path);
12dccc16 329 }
6c510bee 330
93822c22 331 wrote = write_in_full(fd, new, size);
fd5db55d
JH
332 if (!to_tempfile)
333 fstat_done = fstat_output(fd, state, &st);
12dccc16
LT
334 close(fd);
335 free(new);
336 if (wrote != size)
d43e9073 337 return error("unable to write file %s", path);
12dccc16 338 break;
302b9282 339 case S_IFGITLINK:
f0807e62 340 if (to_tempfile)
42063f95 341 return error("cannot create temporary submodule %s", path);
f0807e62 342 if (mkdir(path, 0777) < 0)
42063f95 343 return error("cannot create submodule directory %s", path);
6d14eac3
SB
344 sub = submodule_from_ce(ce);
345 if (sub)
346 return submodule_move_head(ce->name,
cd279e2e
SB
347 NULL, oid_to_hex(&ce->oid),
348 state->force ? SUBMODULE_MOVE_HEAD_FORCE : 0);
f0807e62 349 break;
12dccc16 350 default:
d43e9073 351 return error("unknown file mode for %s in index", path);
12dccc16
LT
352 }
353
dd8e9121 354finish:
6ee67f26 355 if (state->refresh_cache) {
d4a2024a 356 assert(state->istate);
e4c72923
KB
357 if (!fstat_done)
358 lstat(ce->name, &st);
12dccc16 359 fill_stat_cache_info(ce, &st);
078a58e8 360 ce->ce_flags |= CE_UPDATE_IN_BASE;
883e248b 361 mark_fsmonitor_invalid(state->istate, ce);
d4a2024a 362 state->istate->cache_changed |= CE_ENTRY_CHANGED;
12dccc16
LT
363 }
364 return 0;
365}
366
b6986d8a
LT
367/*
368 * This is like 'lstat()', except it refuses to follow symlinks
da02ca50 369 * in the path, after skipping "skiplen".
b6986d8a 370 */
61b97df7 371static int check_path(const char *path, int len, struct stat *st, int skiplen)
b6986d8a 372{
da02ca50
JH
373 const char *slash = path + len;
374
375 while (path < slash && *slash != '/')
376 slash--;
377 if (!has_dirs_only_path(path, slash - path, skiplen)) {
b6986d8a
LT
378 errno = ENOENT;
379 return -1;
380 }
381 return lstat(path, st);
382}
383
af2a651d
JH
384/*
385 * Write the contents from ce out to the working tree.
386 *
387 * When topath[] is not NULL, instead of writing to the working tree
388 * file named by ce, a temporary file is created by this function and
389 * its name is returned in topath[], which must be able to hold at
390 * least TEMPORARY_FILENAME_LENGTH bytes long.
391 */
9c5e6c80
NTND
392int checkout_entry(struct cache_entry *ce,
393 const struct checkout *state, char *topath)
12dccc16 394{
f63272a3 395 static struct strbuf path = STRBUF_INIT;
de84f99c 396 struct stat st;
12dccc16 397
de84f99c
SP
398 if (topath)
399 return write_entry(ce, topath, state, 1);
400
f63272a3
MH
401 strbuf_reset(&path);
402 strbuf_add(&path, state->base_dir, state->base_dir_len);
403 strbuf_add(&path, ce->name, ce_namelen(ce));
12dccc16 404
f63272a3 405 if (!check_path(path.buf, path.len, &st, state->base_dir_len)) {
6d14eac3 406 const struct submodule *sub;
56cac48c 407 unsigned changed = ce_match_stat(ce, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
6d14eac3
SB
408 /*
409 * Needs to be checked before !changed returns early,
410 * as the possibly empty directory was not changed
411 */
412 sub = submodule_from_ce(ce);
413 if (sub) {
414 int err;
415 if (!is_submodule_populated_gently(ce->name, &err)) {
416 struct stat sb;
417 if (lstat(ce->name, &sb))
418 die(_("could not stat file '%s'"), ce->name);
419 if (!(st.st_mode & S_IFDIR))
420 unlink_or_warn(ce->name);
421
422 return submodule_move_head(ce->name,
cd279e2e 423 NULL, oid_to_hex(&ce->oid), 0);
6d14eac3
SB
424 } else
425 return submodule_move_head(ce->name,
426 "HEAD", oid_to_hex(&ce->oid),
cd279e2e 427 state->force ? SUBMODULE_MOVE_HEAD_FORCE : 0);
6d14eac3
SB
428 }
429
12dccc16
LT
430 if (!changed)
431 return 0;
432 if (!state->force) {
433 if (!state->quiet)
f63272a3
MH
434 fprintf(stderr,
435 "%s already exists, no checkout\n",
436 path.buf);
4b12dae6 437 return -1;
12dccc16
LT
438 }
439
440 /*
441 * We unlink the old file, to get the new one with the
442 * right permissions (including umask, which is nasty
443 * to emulate by hand - much easier to let the system
444 * just do the right thing)
445 */
d48a72f3 446 if (S_ISDIR(st.st_mode)) {
f0807e62 447 /* If it is a gitlink, leave it alone! */
7a51ed66 448 if (S_ISGITLINK(ce->ce_mode))
f0807e62 449 return 0;
d48a72f3 450 if (!state->force)
f63272a3 451 return error("%s is a directory", path.buf);
2f29e0c6 452 remove_subtree(&path);
f63272a3 453 } else if (unlink(path.buf))
e1ebb3c2 454 return error_errno("unable to unlink old '%s'", path.buf);
de84f99c 455 } else if (state->not_new)
12dccc16 456 return 0;
f63272a3
MH
457
458 create_directories(path.buf, path.len, state);
459 return write_entry(ce, path.buf, state, 0);
12dccc16 460}