blob: 9e7dbe33d56c2efc3f10ae6dba53b0eec40692fd [file] [log] [blame]
Linus Torvalds12dccc12005-06-05 21:59:54 -07001#include "cache.h"
Peter Eriksen8e440252006-04-02 14:44:09 +02002#include "blob.h"
Stefan Bellercbd53a22018-05-15 16:42:15 -07003#include "object-store.h"
Alexander Potashev8ca12c02009-01-10 15:07:50 +03004#include "dir.h"
Junio C Hamanodd8e9122011-05-12 14:31:08 -07005#include "streaming.h"
Stefan Beller6d14eac2017-03-14 14:46:40 -07006#include "submodule.h"
Lars Schneider52f1d622017-08-20 17:47:20 +02007#include "progress.h"
Ben Peart883e2482017-09-22 12:35:40 -04008#include "fsmonitor.h"
Matheus Tavaresd052cc02021-03-23 11:19:32 -03009#include "entry.h"
Matheus Tavares04155bd2021-04-18 21:14:53 -030010#include "parallel-checkout.h"
Linus Torvalds12dccc12005-06-05 21:59:54 -070011
Kjetil Barvik81a9aa62009-02-09 21:54:08 +010012static void create_directories(const char *path, int path_len,
13 const struct checkout *state)
Linus Torvalds12dccc12005-06-05 21:59:54 -070014{
Jeff King3733e692016-02-22 17:44:28 -050015 char *buf = xmallocz(path_len);
Kjetil Barvik81a9aa62009-02-09 21:54:08 +010016 int len = 0;
Linus Torvalds12dccc12005-06-05 21:59:54 -070017
Kjetil Barvik81a9aa62009-02-09 21:54:08 +010018 while (len < path_len) {
19 do {
20 buf[len] = path[len];
21 len++;
22 } while (len < path_len && path[len] != '/');
23 if (len >= path_len)
24 break;
Linus Torvalds12dccc12005-06-05 21:59:54 -070025 buf[len] = 0;
Junio C Hamanofa2e71c2007-07-17 22:58:28 -070026
Kjetil Barvikbad4a542009-01-18 16:14:52 +010027 /*
28 * For 'checkout-index --prefix=<dir>', <dir> is
29 * allowed to be a symlink to an existing directory,
30 * and we set 'state->base_dir_len' below, such that
31 * we test the path components of the prefix with the
32 * stat() function instead of the lstat() function.
33 */
Kjetil Barvik57199892009-02-09 21:54:06 +010034 if (has_dirs_only_path(buf, len, state->base_dir_len))
Junio C Hamanofa2e71c2007-07-17 22:58:28 -070035 continue; /* ok, it is already a directory. */
36
37 /*
Kjetil Barvikbad4a542009-01-18 16:14:52 +010038 * If this mkdir() would fail, it could be that there
39 * is already a symlink or something else exists
40 * there, therefore we then try to unlink it and try
41 * one more time to create the directory.
Junio C Hamanofa2e71c2007-07-17 22:58:28 -070042 */
Junio C Hamanof312de02005-07-06 01:21:46 -070043 if (mkdir(buf, 0777)) {
Junio C Hamanofa2e71c2007-07-17 22:58:28 -070044 if (errno == EEXIST && state->force &&
Alex Riesen691f1a22009-04-29 23:22:56 +020045 !unlink_or_warn(buf) && !mkdir(buf, 0777))
Junio C Hamanofa2e71c2007-07-17 22:58:28 -070046 continue;
Thomas Rast0721c312009-06-27 17:58:47 +020047 die_errno("cannot create directory at '%s'", buf);
Linus Torvalds12dccc12005-06-05 21:59:54 -070048 }
49 }
50 free(buf);
51}
52
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010053static void remove_subtree(struct strbuf *path)
Linus Torvalds12dccc12005-06-05 21:59:54 -070054{
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010055 DIR *dir = opendir(path->buf);
Linus Torvalds12dccc12005-06-05 21:59:54 -070056 struct dirent *de;
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010057 int origlen = path->len;
Junio C Hamanoa6080a02007-06-07 00:04:01 -070058
Linus Torvalds12dccc12005-06-05 21:59:54 -070059 if (!dir)
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010060 die_errno("cannot opendir '%s'", path->buf);
Elijah Newrenb548f0f2021-05-12 17:28:22 +000061 while ((de = readdir_skip_dot_and_dotdot(dir)) != NULL) {
Linus Torvalds12dccc12005-06-05 21:59:54 -070062 struct stat st;
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010063
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010064 strbuf_addch(path, '/');
65 strbuf_addstr(path, de->d_name);
66 if (lstat(path->buf, &st))
67 die_errno("cannot lstat '%s'", path->buf);
Linus Torvalds12dccc12005-06-05 21:59:54 -070068 if (S_ISDIR(st.st_mode))
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010069 remove_subtree(path);
70 else if (unlink(path->buf))
71 die_errno("cannot unlink '%s'", path->buf);
72 strbuf_setlen(path, origlen);
Linus Torvalds12dccc12005-06-05 21:59:54 -070073 }
74 closedir(dir);
Michael Haggerty2f29e0c2014-03-13 10:19:08 +010075 if (rmdir(path->buf))
76 die_errno("cannot rmdir '%s'", path->buf);
Linus Torvalds12dccc12005-06-05 21:59:54 -070077}
78
Linus Torvaldsd48a72f2005-07-14 09:58:45 -070079static int create_file(const char *path, unsigned int mode)
Linus Torvalds12dccc12005-06-05 21:59:54 -070080{
Linus Torvalds12dccc12005-06-05 21:59:54 -070081 mode = (mode & 0100) ? 0777 : 0666;
Alex Riesen781411e2006-01-05 09:58:06 +010082 return open(path, O_WRONLY | O_CREAT | O_EXCL, mode);
Linus Torvalds12dccc12005-06-05 21:59:54 -070083}
84
Matt Coopere9aa7622021-11-02 15:46:08 +000085void *read_blob_entry(const struct cache_entry *ce, size_t *size)
Linus Torvaldsf0807e62007-04-13 09:26:04 -070086{
87 enum object_type type;
Matt Coopere9aa7622021-11-02 15:46:08 +000088 unsigned long ul;
89 void *blob_data = read_object_file(&ce->oid, &type, &ul);
Linus Torvaldsf0807e62007-04-13 09:26:04 -070090
Matt Coopere9aa7622021-11-02 15:46:08 +000091 *size = ul;
Brandon Williamsd8f71802018-02-14 10:59:41 -080092 if (blob_data) {
Linus Torvaldsf0807e62007-04-13 09:26:04 -070093 if (type == OBJ_BLOB)
Brandon Williamsd8f71802018-02-14 10:59:41 -080094 return blob_data;
95 free(blob_data);
Linus Torvaldsf0807e62007-04-13 09:26:04 -070096 }
97 return NULL;
98}
99
Nguyễn Thái Ngọc Duy9c5e6c82013-07-09 22:29:00 +0700100static int open_output_fd(char *path, const struct cache_entry *ce, int to_tempfile)
Junio C Hamanofd5db552011-05-12 21:36:42 -0700101{
102 int symlink = (ce->ce_mode & S_IFMT) != S_IFREG;
103 if (to_tempfile) {
Jeff King330c8e22015-09-24 17:06:53 -0400104 xsnprintf(path, TEMPORARY_FILENAME_LENGTH, "%s",
105 symlink ? ".merge_link_XXXXXX" : ".merge_file_XXXXXX");
Junio C Hamanofd5db552011-05-12 21:36:42 -0700106 return mkstemp(path);
107 } else {
108 return create_file(path, !symlink ? ce->ce_mode : 0666);
109 }
110}
111
Matheus Tavares49cfd902021-03-23 11:19:33 -0300112int fstat_checkout_output(int fd, const struct checkout *state, struct stat *st)
Junio C Hamanofd5db552011-05-12 21:36:42 -0700113{
114 /* use fstat() only when path == ce->name */
115 if (fstat_is_reliable() &&
116 state->refresh_cache && !state->base_dir_len) {
Matheus Tavares35e6e212020-07-08 23:10:39 -0300117 return !fstat(fd, st);
Junio C Hamanofd5db552011-05-12 21:36:42 -0700118 }
119 return 0;
120}
121
Nguyễn Thái Ngọc Duy9c5e6c82013-07-09 22:29:00 +0700122static int streaming_write_entry(const struct cache_entry *ce, char *path,
Junio C Hamanob6691092011-05-20 14:33:31 -0700123 struct stream_filter *filter,
Junio C Hamanodd8e9122011-05-12 14:31:08 -0700124 const struct checkout *state, int to_tempfile,
125 int *fstat_done, struct stat *statbuf)
126{
Jeff Kingd9c31e12013-03-25 17:49:36 -0400127 int result = 0;
Junio C Hamano47a02ff2012-03-07 17:54:15 +0700128 int fd;
Junio C Hamanodd8e9122011-05-12 14:31:08 -0700129
130 fd = open_output_fd(path, ce, to_tempfile);
Jeff Kingd9c31e12013-03-25 17:49:36 -0400131 if (fd < 0)
132 return -1;
133
brian m. carlson7eda0e42016-09-05 20:07:59 +0000134 result |= stream_blob_to_fd(fd, &ce->oid, filter, 1);
Matheus Tavares49cfd902021-03-23 11:19:33 -0300135 *fstat_done = fstat_checkout_output(fd, state, statbuf);
Jeff Kingd9c31e12013-03-25 17:49:36 -0400136 result |= close(fd);
137
138 if (result)
Junio C Hamanodd8e9122011-05-12 14:31:08 -0700139 unlink(path);
140 return result;
141}
142
Lars Schneider2841e8f2017-06-30 22:41:28 +0200143void enable_delayed_checkout(struct checkout *state)
144{
145 if (!state->delayed_checkout) {
146 state->delayed_checkout = xmalloc(sizeof(*state->delayed_checkout));
147 state->delayed_checkout->state = CE_CAN_DELAY;
Ævar Arnfjörð Bjarmasonbc40dfb2021-07-01 12:51:29 +0200148 string_list_init_nodup(&state->delayed_checkout->filters);
149 string_list_init_nodup(&state->delayed_checkout->paths);
Lars Schneider2841e8f2017-06-30 22:41:28 +0200150 }
151}
152
153static int remove_available_paths(struct string_list_item *item, void *cb_data)
154{
155 struct string_list *available_paths = cb_data;
156 struct string_list_item *available;
157
158 available = string_list_lookup(available_paths, item->string);
159 if (available)
Matheus Tavares611c7782022-07-14 08:49:12 -0300160 available->util = item->util;
Lars Schneider2841e8f2017-06-30 22:41:28 +0200161 return !available;
162}
163
Matheus Tavares611c7782022-07-14 08:49:12 -0300164int finish_delayed_checkout(struct checkout *state, int show_progress)
Lars Schneider2841e8f2017-06-30 22:41:28 +0200165{
166 int errs = 0;
SZEDER Gáborbf6d8192021-09-09 03:10:12 +0200167 unsigned processed_paths = 0;
Lars Schneider52f1d622017-08-20 17:47:20 +0200168 off_t filtered_bytes = 0;
Lars Schneider2841e8f2017-06-30 22:41:28 +0200169 struct string_list_item *filter, *path;
SZEDER Gáborbf6d8192021-09-09 03:10:12 +0200170 struct progress *progress = NULL;
Lars Schneider2841e8f2017-06-30 22:41:28 +0200171 struct delayed_checkout *dco = state->delayed_checkout;
172
173 if (!state->delayed_checkout)
174 return errs;
175
176 dco->state = CE_RETRY;
SZEDER Gáborbf6d8192021-09-09 03:10:12 +0200177 if (show_progress)
178 progress = start_delayed_progress(_("Filtering content"), dco->paths.nr);
Lars Schneider2841e8f2017-06-30 22:41:28 +0200179 while (dco->filters.nr > 0) {
180 for_each_string_list_item(filter, &dco->filters) {
181 struct string_list available_paths = STRING_LIST_INIT_NODUP;
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);
Lars Schneider52f1d622017-08-20 17:47:20 +0200227 if (ce) {
SZEDER Gáborbf6d8192021-09-09 03:10:12 +0200228 display_progress(progress, ++processed_paths);
Matheus Tavares611c7782022-07-14 08:49:12 -0300229 errs |= checkout_entry(ce, state, NULL, path->util);
Lars Schneider52f1d622017-08-20 17:47:20 +0200230 filtered_bytes += ce->ce_stat_data.sd_size;
231 display_throughput(progress, filtered_bytes);
232 } else
233 errs = 1;
Lars Schneider2841e8f2017-06-30 22:41:28 +0200234 }
235 }
236 string_list_remove_empty_items(&dco->filters, 0);
237 }
Lars Schneider52f1d622017-08-20 17:47:20 +0200238 stop_progress(&progress);
Lars Schneider2841e8f2017-06-30 22:41:28 +0200239 string_list_clear(&dco->filters, 0);
240
241 /* At this point we should not have any delayed paths anymore. */
242 errs |= dco->paths.nr;
243 for_each_string_list_item(path, &dco->paths) {
244 error("'%s' was not filtered properly", path->string);
245 }
246 string_list_clear(&dco->paths, 0);
247
248 free(dco);
249 state->delayed_checkout = NULL;
250
251 return errs;
252}
253
Matheus Tavares584a0d12021-03-23 11:19:34 -0300254void update_ce_after_write(const struct checkout *state, struct cache_entry *ce,
255 struct stat *st)
256{
257 if (state->refresh_cache) {
258 assert(state->istate);
259 fill_stat_cache_info(state->istate, ce, st);
260 ce->ce_flags |= CE_UPDATE_IN_BASE;
261 mark_fsmonitor_invalid(state->istate, ce);
262 state->istate->cache_changed |= CE_ENTRY_CHANGED;
263 }
264}
265
Matheus Tavares30419e72021-03-23 11:19:35 -0300266/* Note: ca is used (and required) iff the entry refers to a regular file. */
267static int write_entry(struct cache_entry *ce, char *path, struct conv_attrs *ca,
Matheus Tavares611c7782022-07-14 08:49:12 -0300268 const struct checkout *state, int to_tempfile,
269 int *nr_checkouts)
Linus Torvalds12dccc12005-06-05 21:59:54 -0700270{
Kjetil Barvik4857c762009-02-09 21:54:50 +0100271 unsigned int ce_mode_s_ifmt = ce->ce_mode & S_IFMT;
Jeff Kingc602d3a2017-10-09 13:48:52 -0400272 struct delayed_checkout *dco = state->delayed_checkout;
Kjetil Barvike4c72922009-02-09 21:54:51 +0100273 int fd, ret, fstat_done = 0;
Brandon Williamsd8f71802018-02-14 10:59:41 -0800274 char *new_blob;
Kjetil Barvik4857c762009-02-09 21:54:50 +0100275 struct strbuf buf = STRBUF_INIT;
Matt Coopere9aa7622021-11-02 15:46:08 +0000276 size_t size;
Jeff King564bde92017-09-13 13:16:28 -0400277 ssize_t wrote;
278 size_t newsize = 0;
Kjetil Barvike4c72922009-02-09 21:54:51 +0100279 struct stat st;
Stefan Beller6d14eac2017-03-14 14:46:40 -0700280 const struct submodule *sub;
brian m. carlsonc397aac2020-03-16 18:05:03 +0000281 struct checkout_metadata meta;
Matheus Tavares611c7782022-07-14 08:49:12 -0300282 static int scratch_nr_checkouts;
brian m. carlsonc397aac2020-03-16 18:05:03 +0000283
284 clone_checkout_metadata(&meta, &state->meta, &ce->oid);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700285
Junio C Hamanob6691092011-05-20 14:33:31 -0700286 if (ce_mode_s_ifmt == S_IFREG) {
Matheus Tavares30419e72021-03-23 11:19:35 -0300287 struct stream_filter *filter = get_stream_filter_ca(ca, &ce->oid);
Junio C Hamanob6691092011-05-20 14:33:31 -0700288 if (filter &&
289 !streaming_write_entry(ce, path, filter,
290 state, to_tempfile,
291 &fstat_done, &st))
292 goto finish;
293 }
Junio C Hamanodd8e9122011-05-12 14:31:08 -0700294
Kjetil Barvik4857c762009-02-09 21:54:50 +0100295 switch (ce_mode_s_ifmt) {
Kjetil Barvik4857c762009-02-09 21:54:50 +0100296 case S_IFLNK:
Brandon Williamsd8f71802018-02-14 10:59:41 -0800297 new_blob = read_blob_entry(ce, &size);
298 if (!new_blob)
Nguyễn Thái Ngọc Duyd43e9072010-11-28 11:36:38 +0700299 return error("unable to read sha1 file of %s (%s)",
Matheus Tavares9334ea82021-02-16 11:06:51 -0300300 ce->name, oid_to_hex(&ce->oid));
Junio C Hamano1a9d7e92007-08-14 01:41:02 -0700301
Jeff King7cbbf9d2017-10-09 13:50:05 -0400302 /*
303 * We can't make a real symlink; write out a regular file entry
304 * with the symlink destination as its contents.
305 */
306 if (!has_symlinks || to_tempfile)
307 goto write_file_entry;
308
Brandon Williamsd8f71802018-02-14 10:59:41 -0800309 ret = symlink(new_blob, path);
310 free(new_blob);
Jeff King7cbbf9d2017-10-09 13:50:05 -0400311 if (ret)
312 return error_errno("unable to create symlink %s", path);
313 break;
314
315 case S_IFREG:
Jeff Kingc602d3a2017-10-09 13:48:52 -0400316 /*
317 * We do not send the blob in case of a retry, so do not
318 * bother reading it at all.
319 */
Jeff King7cbbf9d2017-10-09 13:50:05 -0400320 if (dco && dco->state == CE_RETRY) {
Brandon Williamsd8f71802018-02-14 10:59:41 -0800321 new_blob = NULL;
Jeff Kingc602d3a2017-10-09 13:48:52 -0400322 size = 0;
323 } else {
Brandon Williamsd8f71802018-02-14 10:59:41 -0800324 new_blob = read_blob_entry(ce, &size);
325 if (!new_blob)
Jeff Kingc602d3a2017-10-09 13:48:52 -0400326 return error("unable to read sha1 file of %s (%s)",
Matheus Tavares9334ea82021-02-16 11:06:51 -0300327 ce->name, oid_to_hex(&ce->oid));
Kjetil Barvik4857c762009-02-09 21:54:50 +0100328 }
329
Junio C Hamano1a9d7e92007-08-14 01:41:02 -0700330 /*
331 * Convert from git internal format to working tree format
332 */
Jeff King7cbbf9d2017-10-09 13:50:05 -0400333 if (dco && dco->state != CE_NO_DELAY) {
Matheus Tavares30419e72021-03-23 11:19:35 -0300334 ret = async_convert_to_working_tree_ca(ca, ce->name,
335 new_blob, size,
336 &buf, &meta, dco);
Matheus Tavares611c7782022-07-14 08:49:12 -0300337 if (ret) {
338 struct string_list_item *item =
339 string_list_lookup(&dco->paths, ce->name);
340 if (item) {
341 item->util = nr_checkouts ? nr_checkouts
342 : &scratch_nr_checkouts;
343 free(new_blob);
344 goto delayed;
345 }
Lars Schneider2841e8f2017-06-30 22:41:28 +0200346 }
Matheus Tavares30419e72021-03-23 11:19:35 -0300347 } else {
348 ret = convert_to_working_tree_ca(ca, ce->name, new_blob,
349 size, &buf, &meta);
350 }
Junio C Hamano1a9d7e92007-08-14 01:41:02 -0700351
Jeff King7cbbf9d2017-10-09 13:50:05 -0400352 if (ret) {
Brandon Williamsd8f71802018-02-14 10:59:41 -0800353 free(new_blob);
354 new_blob = strbuf_detach(&buf, &newsize);
Jeff King7cbbf9d2017-10-09 13:50:05 -0400355 size = newsize;
356 }
357 /*
358 * No "else" here as errors from convert are OK at this
359 * point. If the error would have been fatal (e.g.
360 * filter is required), then we would have died already.
361 */
362
363 write_file_entry:
Junio C Hamanofd5db552011-05-12 21:36:42 -0700364 fd = open_output_fd(path, ce, to_tempfile);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700365 if (fd < 0) {
Brandon Williamsd8f71802018-02-14 10:59:41 -0800366 free(new_blob);
Nguyễn Thái Ngọc Duye1ebb3c2016-05-08 16:47:44 +0700367 return error_errno("unable to create file %s", path);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700368 }
Linus Torvalds6c510be2007-02-13 11:07:23 -0800369
Brandon Williamsd8f71802018-02-14 10:59:41 -0800370 wrote = write_in_full(fd, new_blob, size);
Junio C Hamanofd5db552011-05-12 21:36:42 -0700371 if (!to_tempfile)
Matheus Tavares49cfd902021-03-23 11:19:33 -0300372 fstat_done = fstat_checkout_output(fd, state, &st);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700373 close(fd);
Brandon Williamsd8f71802018-02-14 10:59:41 -0800374 free(new_blob);
Jeff King564bde92017-09-13 13:16:28 -0400375 if (wrote < 0)
Nguyễn Thái Ngọc Duyd43e9072010-11-28 11:36:38 +0700376 return error("unable to write file %s", path);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700377 break;
Jeff King7cbbf9d2017-10-09 13:50:05 -0400378
Martin Waitz302b9282007-05-21 22:08:28 +0200379 case S_IFGITLINK:
Linus Torvaldsf0807e62007-04-13 09:26:04 -0700380 if (to_tempfile)
Matheus Tavares9334ea82021-02-16 11:06:51 -0300381 return error("cannot create temporary submodule %s", ce->name);
Linus Torvaldsf0807e62007-04-13 09:26:04 -0700382 if (mkdir(path, 0777) < 0)
Thomas Rast42063f92013-07-18 14:26:55 +0200383 return error("cannot create submodule directory %s", path);
Stefan Beller6d14eac2017-03-14 14:46:40 -0700384 sub = submodule_from_ce(ce);
385 if (sub)
Ævar Arnfjörð Bjarmason4002ec32022-12-20 13:39:56 +0100386 return submodule_move_head(ce->name, state->super_prefix,
Stefan Bellercd279e22017-04-18 14:37:22 -0700387 NULL, oid_to_hex(&ce->oid),
388 state->force ? SUBMODULE_MOVE_HEAD_FORCE : 0);
Linus Torvaldsf0807e62007-04-13 09:26:04 -0700389 break;
Jeff King7cbbf9d2017-10-09 13:50:05 -0400390
Linus Torvalds12dccc12005-06-05 21:59:54 -0700391 default:
Matheus Tavares9334ea82021-02-16 11:06:51 -0300392 return error("unknown file mode for %s in index", ce->name);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700393 }
394
Junio C Hamanodd8e9122011-05-12 14:31:08 -0700395finish:
Linus Torvalds6ee67f22005-06-05 23:15:40 -0700396 if (state->refresh_cache) {
Matheus Tavares584a0d12021-03-23 11:19:34 -0300397 if (!fstat_done && lstat(ce->name, &st) < 0)
398 return error_errno("unable to stat just-written file %s",
399 ce->name);
400 update_ce_after_write(state, ce , &st);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700401 }
Matheus Tavares611c7782022-07-14 08:49:12 -0300402 if (nr_checkouts)
403 (*nr_checkouts)++;
Lars Schneider03b95332017-10-05 12:44:06 +0200404delayed:
Linus Torvalds12dccc12005-06-05 21:59:54 -0700405 return 0;
406}
407
Linus Torvaldsb6986d82009-07-29 20:22:25 -0700408/*
409 * This is like 'lstat()', except it refuses to follow symlinks
Junio C Hamanoda02ca52009-08-16 23:53:12 -0700410 * in the path, after skipping "skiplen".
Linus Torvaldsb6986d82009-07-29 20:22:25 -0700411 */
Junio C Hamano61b97df2010-01-11 22:27:31 -0800412static int check_path(const char *path, int len, struct stat *st, int skiplen)
Linus Torvaldsb6986d82009-07-29 20:22:25 -0700413{
Junio C Hamanoda02ca52009-08-16 23:53:12 -0700414 const char *slash = path + len;
415
416 while (path < slash && *slash != '/')
417 slash--;
418 if (!has_dirs_only_path(path, slash - path, skiplen)) {
Linus Torvaldsb6986d82009-07-29 20:22:25 -0700419 errno = ENOENT;
420 return -1;
421 }
422 return lstat(path, st);
423}
424
Duy Nguyenb8785792018-08-17 20:00:39 +0200425static void mark_colliding_entries(const struct checkout *state,
426 struct cache_entry *ce, struct stat *st)
427{
428 int i, trust_ino = check_stat;
429
Nguyễn Thái Ngọc Duye66ceca2018-11-20 17:28:53 +0100430#if defined(GIT_WINDOWS_NATIVE) || defined(__CYGWIN__)
Duy Nguyenb8785792018-08-17 20:00:39 +0200431 trust_ino = 0;
432#endif
433
434 ce->ce_flags |= CE_MATCHED;
435
Derrick Stolee3450a302021-04-01 01:49:55 +0000436 /* TODO: audit for interaction with sparse-index. */
437 ensure_full_index(state->istate);
Duy Nguyenb8785792018-08-17 20:00:39 +0200438 for (i = 0; i < state->istate->cache_nr; i++) {
439 struct cache_entry *dup = state->istate->cache[i];
440
Matheus Tavares04155bd2021-04-18 21:14:53 -0300441 if (dup == ce) {
442 /*
443 * Parallel checkout doesn't create the files in index
444 * order. So the other side of the collision may appear
445 * after the given cache_entry in the array.
446 */
447 if (parallel_checkout_status() == PC_RUNNING)
448 continue;
449 else
450 break;
451 }
Duy Nguyenb8785792018-08-17 20:00:39 +0200452
453 if (dup->ce_flags & (CE_MATCHED | CE_VALID | CE_SKIP_WORKTREE))
454 continue;
455
Nguyễn Thái Ngọc Duye66ceca2018-11-20 17:28:53 +0100456 if ((trust_ino && !match_stat_data(&dup->ce_stat_data, st)) ||
Johannes Schindelin850c3a22024-03-28 09:44:28 +0100457 paths_collide(ce->name, dup->name)) {
Duy Nguyenb8785792018-08-17 20:00:39 +0200458 dup->ce_flags |= CE_MATCHED;
459 break;
460 }
461 }
462}
463
Matheus Tavaresae227512021-03-23 11:19:36 -0300464int checkout_entry_ca(struct cache_entry *ce, struct conv_attrs *ca,
465 const struct checkout *state, char *topath,
466 int *nr_checkouts)
Linus Torvalds12dccc12005-06-05 21:59:54 -0700467{
Michael Haggertyf63272a2014-03-13 10:19:07 +0100468 static struct strbuf path = STRBUF_INIT;
Shawn Pearcede84f992006-03-05 03:24:15 -0500469 struct stat st;
Matheus Tavaresae227512021-03-23 11:19:36 -0300470 struct conv_attrs ca_buf;
Linus Torvalds12dccc12005-06-05 21:59:54 -0700471
Thomas Gummerer536ec182018-12-20 13:48:15 +0000472 if (ce->ce_flags & CE_WT_REMOVE) {
473 if (topath)
474 /*
475 * No content and thus no path to create, so we have
476 * no pathname to return.
477 */
478 BUG("Can't remove entry to a path");
Ævar Arnfjörð Bjarmason4002ec32022-12-20 13:39:56 +0100479 unlink_entry(ce, state->super_prefix);
Thomas Gummerer536ec182018-12-20 13:48:15 +0000480 return 0;
481 }
482
Matheus Tavares30419e72021-03-23 11:19:35 -0300483 if (topath) {
Matheus Tavaresae227512021-03-23 11:19:36 -0300484 if (S_ISREG(ce->ce_mode) && !ca) {
Matheus Tavares30419e72021-03-23 11:19:35 -0300485 convert_attrs(state->istate, &ca_buf, ce->name);
486 ca = &ca_buf;
487 }
Matheus Tavares611c7782022-07-14 08:49:12 -0300488 return write_entry(ce, topath, ca, state, 1, nr_checkouts);
Matheus Tavares30419e72021-03-23 11:19:35 -0300489 }
Shawn Pearcede84f992006-03-05 03:24:15 -0500490
Michael Haggertyf63272a2014-03-13 10:19:07 +0100491 strbuf_reset(&path);
492 strbuf_add(&path, state->base_dir, state->base_dir_len);
493 strbuf_add(&path, ce->name, ce_namelen(ce));
Linus Torvalds12dccc12005-06-05 21:59:54 -0700494
Michael Haggertyf63272a2014-03-13 10:19:07 +0100495 if (!check_path(path.buf, path.len, &st, state->base_dir_len)) {
Stefan Beller6d14eac2017-03-14 14:46:40 -0700496 const struct submodule *sub;
Nguyễn Thái Ngọc Duy74cfc0e2018-08-13 18:14:32 +0200497 unsigned changed = ie_match_stat(state->istate, ce, &st,
498 CE_MATCH_IGNORE_VALID | CE_MATCH_IGNORE_SKIP_WORKTREE);
Stefan Beller6d14eac2017-03-14 14:46:40 -0700499 /*
500 * Needs to be checked before !changed returns early,
501 * as the possibly empty directory was not changed
502 */
503 sub = submodule_from_ce(ce);
504 if (sub) {
505 int err;
506 if (!is_submodule_populated_gently(ce->name, &err)) {
507 struct stat sb;
508 if (lstat(ce->name, &sb))
509 die(_("could not stat file '%s'"), ce->name);
510 if (!(st.st_mode & S_IFDIR))
511 unlink_or_warn(ce->name);
512
Ævar Arnfjörð Bjarmason4002ec32022-12-20 13:39:56 +0100513 return submodule_move_head(ce->name, state->super_prefix,
Stefan Bellercd279e22017-04-18 14:37:22 -0700514 NULL, oid_to_hex(&ce->oid), 0);
Stefan Beller6d14eac2017-03-14 14:46:40 -0700515 } else
Ævar Arnfjörð Bjarmason4002ec32022-12-20 13:39:56 +0100516 return submodule_move_head(ce->name, state->super_prefix,
Stefan Beller6d14eac2017-03-14 14:46:40 -0700517 "HEAD", oid_to_hex(&ce->oid),
Stefan Bellercd279e22017-04-18 14:37:22 -0700518 state->force ? SUBMODULE_MOVE_HEAD_FORCE : 0);
Stefan Beller6d14eac2017-03-14 14:46:40 -0700519 }
520
Linus Torvalds12dccc12005-06-05 21:59:54 -0700521 if (!changed)
522 return 0;
523 if (!state->force) {
524 if (!state->quiet)
Michael Haggertyf63272a2014-03-13 10:19:07 +0100525 fprintf(stderr,
526 "%s already exists, no checkout\n",
527 path.buf);
Junio C Hamano4b12dae2005-10-03 12:44:48 -0700528 return -1;
Linus Torvalds12dccc12005-06-05 21:59:54 -0700529 }
530
Duy Nguyenb8785792018-08-17 20:00:39 +0200531 if (state->clone)
532 mark_colliding_entries(state, ce, &st);
533
Linus Torvalds12dccc12005-06-05 21:59:54 -0700534 /*
535 * We unlink the old file, to get the new one with the
536 * right permissions (including umask, which is nasty
537 * to emulate by hand - much easier to let the system
538 * just do the right thing)
539 */
Linus Torvaldsd48a72f2005-07-14 09:58:45 -0700540 if (S_ISDIR(st.st_mode)) {
Linus Torvaldsf0807e62007-04-13 09:26:04 -0700541 /* If it is a gitlink, leave it alone! */
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800542 if (S_ISGITLINK(ce->ce_mode))
Linus Torvaldsf0807e62007-04-13 09:26:04 -0700543 return 0;
Johannes Schindelin31572dc2024-03-28 10:55:07 +0100544 /*
545 * We must avoid replacing submodules' leading
546 * directories with symbolic links, lest recursive
547 * clones can write into arbitrary locations.
548 *
549 * Technically, this logic is not limited
550 * to recursive clones, or for that matter to
551 * submodules' paths colliding with symbolic links'
552 * paths. Yet it strikes a balance in favor of
553 * simplicity, and if paths are colliding, we might
554 * just as well keep the directories during a clone.
555 */
556 if (state->clone && S_ISLNK(ce->ce_mode))
557 return 0;
Michael Haggerty2f29e0c2014-03-13 10:19:08 +0100558 remove_subtree(&path);
Michael Haggertyf63272a2014-03-13 10:19:07 +0100559 } else if (unlink(path.buf))
Nguyễn Thái Ngọc Duye1ebb3c2016-05-08 16:47:44 +0700560 return error_errno("unable to unlink old '%s'", path.buf);
Shawn Pearcede84f992006-03-05 03:24:15 -0500561 } else if (state->not_new)
Linus Torvalds12dccc12005-06-05 21:59:54 -0700562 return 0;
Michael Haggertyf63272a2014-03-13 10:19:07 +0100563
564 create_directories(path.buf, path.len, state);
Matheus Tavares30419e72021-03-23 11:19:35 -0300565
Matheus Tavaresae227512021-03-23 11:19:36 -0300566 if (S_ISREG(ce->ce_mode) && !ca) {
Matheus Tavares30419e72021-03-23 11:19:35 -0300567 convert_attrs(state->istate, &ca_buf, ce->name);
568 ca = &ca_buf;
569 }
570
Matheus Tavares611c7782022-07-14 08:49:12 -0300571 if (!enqueue_checkout(ce, ca, nr_checkouts))
Matheus Tavares04155bd2021-04-18 21:14:53 -0300572 return 0;
573
Matheus Tavares611c7782022-07-14 08:49:12 -0300574 return write_entry(ce, path.buf, ca, state, 0, nr_checkouts);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700575}
Thomas Gummererb702dd12018-12-20 13:48:14 +0000576
Ævar Arnfjörð Bjarmason4002ec32022-12-20 13:39:56 +0100577void unlink_entry(const struct cache_entry *ce, const char *super_prefix)
Thomas Gummererb702dd12018-12-20 13:48:14 +0000578{
579 const struct submodule *sub = submodule_from_ce(ce);
580 if (sub) {
581 /* state.force is set at the caller. */
Ævar Arnfjörð Bjarmason4002ec32022-12-20 13:39:56 +0100582 submodule_move_head(ce->name, super_prefix, "HEAD", NULL,
Thomas Gummererb702dd12018-12-20 13:48:14 +0000583 SUBMODULE_MOVE_HEAD_FORCE);
584 }
Matheus Tavaresfab78a02021-03-18 15:43:47 -0300585 if (check_leading_path(ce->name, ce_namelen(ce), 1) >= 0)
Thomas Gummererb702dd12018-12-20 13:48:14 +0000586 return;
587 if (remove_or_warn(ce->ce_mode, ce->name))
588 return;
589 schedule_dir_for_removal(ce->name, ce_namelen(ce));
590}