Git 2.32
[git] / sparse-index.c
1 #include "cache.h"
2 #include "repository.h"
3 #include "sparse-index.h"
4 #include "tree.h"
5 #include "pathspec.h"
6 #include "trace2.h"
7 #include "cache-tree.h"
8 #include "config.h"
9 #include "dir.h"
10 #include "fsmonitor.h"
11
12 static struct cache_entry *construct_sparse_dir_entry(
13                                 struct index_state *istate,
14                                 const char *sparse_dir,
15                                 struct cache_tree *tree)
16 {
17         struct cache_entry *de;
18
19         de = make_cache_entry(istate, S_IFDIR, &tree->oid, sparse_dir, 0, 0);
20
21         de->ce_flags |= CE_SKIP_WORKTREE;
22         return de;
23 }
24
25 /*
26  * Returns the number of entries "inserted" into the index.
27  */
28 static int convert_to_sparse_rec(struct index_state *istate,
29                                  int num_converted,
30                                  int start, int end,
31                                  const char *ct_path, size_t ct_pathlen,
32                                  struct cache_tree *ct)
33 {
34         int i, can_convert = 1;
35         int start_converted = num_converted;
36         enum pattern_match_result match;
37         int dtype = DT_UNKNOWN;
38         struct strbuf child_path = STRBUF_INIT;
39         struct pattern_list *pl = istate->sparse_checkout_patterns;
40
41         /*
42          * Is the current path outside of the sparse cone?
43          * Then check if the region can be replaced by a sparse
44          * directory entry (everything is sparse and merged).
45          */
46         match = path_matches_pattern_list(ct_path, ct_pathlen,
47                                           NULL, &dtype, pl, istate);
48         if (match != NOT_MATCHED)
49                 can_convert = 0;
50
51         for (i = start; can_convert && i < end; i++) {
52                 struct cache_entry *ce = istate->cache[i];
53
54                 if (ce_stage(ce) ||
55                     S_ISGITLINK(ce->ce_mode) ||
56                     !(ce->ce_flags & CE_SKIP_WORKTREE))
57                         can_convert = 0;
58         }
59
60         if (can_convert) {
61                 struct cache_entry *se;
62                 se = construct_sparse_dir_entry(istate, ct_path, ct);
63
64                 istate->cache[num_converted++] = se;
65                 return 1;
66         }
67
68         for (i = start; i < end; ) {
69                 int count, span, pos = -1;
70                 const char *base, *slash;
71                 struct cache_entry *ce = istate->cache[i];
72
73                 /*
74                  * Detect if this is a normal entry outside of any subtree
75                  * entry.
76                  */
77                 base = ce->name + ct_pathlen;
78                 slash = strchr(base, '/');
79
80                 if (slash)
81                         pos = cache_tree_subtree_pos(ct, base, slash - base);
82
83                 if (pos < 0) {
84                         istate->cache[num_converted++] = ce;
85                         i++;
86                         continue;
87                 }
88
89                 strbuf_setlen(&child_path, 0);
90                 strbuf_add(&child_path, ce->name, slash - ce->name + 1);
91
92                 span = ct->down[pos]->cache_tree->entry_count;
93                 count = convert_to_sparse_rec(istate,
94                                               num_converted, i, i + span,
95                                               child_path.buf, child_path.len,
96                                               ct->down[pos]->cache_tree);
97                 num_converted += count;
98                 i += span;
99         }
100
101         strbuf_release(&child_path);
102         return num_converted - start_converted;
103 }
104
105 int set_sparse_index_config(struct repository *repo, int enable)
106 {
107         int res;
108         char *config_path = repo_git_path(repo, "config.worktree");
109         res = git_config_set_in_file_gently(config_path,
110                                             "index.sparse",
111                                             enable ? "true" : NULL);
112         free(config_path);
113
114         prepare_repo_settings(repo);
115         repo->settings.sparse_index = enable;
116         return res;
117 }
118
119 int convert_to_sparse(struct index_state *istate)
120 {
121         int test_env;
122         if (istate->split_index || istate->sparse_index ||
123             !core_apply_sparse_checkout || !core_sparse_checkout_cone)
124                 return 0;
125
126         if (!istate->repo)
127                 istate->repo = the_repository;
128
129         /*
130          * The GIT_TEST_SPARSE_INDEX environment variable triggers the
131          * index.sparse config variable to be on.
132          */
133         test_env = git_env_bool("GIT_TEST_SPARSE_INDEX", -1);
134         if (test_env >= 0)
135                 set_sparse_index_config(istate->repo, test_env);
136
137         /*
138          * Only convert to sparse if index.sparse is set.
139          */
140         prepare_repo_settings(istate->repo);
141         if (!istate->repo->settings.sparse_index)
142                 return 0;
143
144         if (!istate->sparse_checkout_patterns) {
145                 istate->sparse_checkout_patterns = xcalloc(1, sizeof(struct pattern_list));
146                 if (get_sparse_checkout_patterns(istate->sparse_checkout_patterns) < 0)
147                         return 0;
148         }
149
150         if (!istate->sparse_checkout_patterns->use_cone_patterns) {
151                 warning(_("attempting to use sparse-index without cone mode"));
152                 return -1;
153         }
154
155         if (cache_tree_update(istate, 0)) {
156                 warning(_("unable to update cache-tree, staying full"));
157                 return -1;
158         }
159
160         remove_fsmonitor(istate);
161
162         trace2_region_enter("index", "convert_to_sparse", istate->repo);
163         istate->cache_nr = convert_to_sparse_rec(istate,
164                                                  0, 0, istate->cache_nr,
165                                                  "", 0, istate->cache_tree);
166
167         /* Clear and recompute the cache-tree */
168         cache_tree_free(&istate->cache_tree);
169         cache_tree_update(istate, 0);
170
171         istate->sparse_index = 1;
172         trace2_region_leave("index", "convert_to_sparse", istate->repo);
173         return 0;
174 }
175
176 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
177 {
178         ALLOC_GROW(istate->cache, nr + 1, istate->cache_alloc);
179
180         istate->cache[nr] = ce;
181         add_name_hash(istate, ce);
182 }
183
184 static int add_path_to_index(const struct object_id *oid,
185                              struct strbuf *base, const char *path,
186                              unsigned int mode, void *context)
187 {
188         struct index_state *istate = (struct index_state *)context;
189         struct cache_entry *ce;
190         size_t len = base->len;
191
192         if (S_ISDIR(mode))
193                 return READ_TREE_RECURSIVE;
194
195         strbuf_addstr(base, path);
196
197         ce = make_cache_entry(istate, mode, oid, base->buf, 0, 0);
198         ce->ce_flags |= CE_SKIP_WORKTREE;
199         set_index_entry(istate, istate->cache_nr++, ce);
200
201         strbuf_setlen(base, len);
202         return 0;
203 }
204
205 void ensure_full_index(struct index_state *istate)
206 {
207         int i;
208         struct index_state *full;
209         struct strbuf base = STRBUF_INIT;
210
211         if (!istate || !istate->sparse_index)
212                 return;
213
214         if (!istate->repo)
215                 istate->repo = the_repository;
216
217         trace2_region_enter("index", "ensure_full_index", istate->repo);
218
219         /* initialize basics of new index */
220         full = xcalloc(1, sizeof(struct index_state));
221         memcpy(full, istate, sizeof(struct index_state));
222
223         /* then change the necessary things */
224         full->sparse_index = 0;
225         full->cache_alloc = (3 * istate->cache_alloc) / 2;
226         full->cache_nr = 0;
227         ALLOC_ARRAY(full->cache, full->cache_alloc);
228
229         for (i = 0; i < istate->cache_nr; i++) {
230                 struct cache_entry *ce = istate->cache[i];
231                 struct tree *tree;
232                 struct pathspec ps;
233
234                 if (!S_ISSPARSEDIR(ce->ce_mode)) {
235                         set_index_entry(full, full->cache_nr++, ce);
236                         continue;
237                 }
238                 if (!(ce->ce_flags & CE_SKIP_WORKTREE))
239                         warning(_("index entry is a directory, but not sparse (%08x)"),
240                                 ce->ce_flags);
241
242                 /* recursively walk into cd->name */
243                 tree = lookup_tree(istate->repo, &ce->oid);
244
245                 memset(&ps, 0, sizeof(ps));
246                 ps.recursive = 1;
247                 ps.has_wildcard = 1;
248                 ps.max_depth = -1;
249
250                 strbuf_setlen(&base, 0);
251                 strbuf_add(&base, ce->name, strlen(ce->name));
252
253                 read_tree_at(istate->repo, tree, &base, &ps,
254                              add_path_to_index, full);
255
256                 /* free directory entries. full entries are re-used */
257                 discard_cache_entry(ce);
258         }
259
260         /* Copy back into original index. */
261         memcpy(&istate->name_hash, &full->name_hash, sizeof(full->name_hash));
262         istate->sparse_index = 0;
263         free(istate->cache);
264         istate->cache = full->cache;
265         istate->cache_nr = full->cache_nr;
266         istate->cache_alloc = full->cache_alloc;
267
268         strbuf_release(&base);
269         free(full);
270
271         /* Clear and recompute the cache-tree */
272         cache_tree_free(&istate->cache_tree);
273         cache_tree_update(istate, 0);
274
275         trace2_region_leave("index", "ensure_full_index", istate->repo);
276 }
277
278 /*
279  * This static global helps avoid infinite recursion between
280  * expand_to_path() and index_file_exists().
281  */
282 static int in_expand_to_path = 0;
283
284 void expand_to_path(struct index_state *istate,
285                     const char *path, size_t pathlen, int icase)
286 {
287         struct strbuf path_mutable = STRBUF_INIT;
288         size_t substr_len;
289
290         /* prevent extra recursion */
291         if (in_expand_to_path)
292                 return;
293
294         if (!istate || !istate->sparse_index)
295                 return;
296
297         if (!istate->repo)
298                 istate->repo = the_repository;
299
300         in_expand_to_path = 1;
301
302         /*
303          * We only need to actually expand a region if the
304          * following are both true:
305          *
306          * 1. 'path' is not already in the index.
307          * 2. Some parent directory of 'path' is a sparse directory.
308          */
309
310         if (index_file_exists(istate, path, pathlen, icase))
311                 goto cleanup;
312
313         strbuf_add(&path_mutable, path, pathlen);
314         strbuf_addch(&path_mutable, '/');
315
316         /* Check the name hash for all parent directories */
317         substr_len = 0;
318         while (substr_len < pathlen) {
319                 char temp;
320                 char *replace = strchr(path_mutable.buf + substr_len, '/');
321
322                 if (!replace)
323                         break;
324
325                 /* replace the character _after_ the slash */
326                 replace++;
327                 temp = *replace;
328                 *replace = '\0';
329                 if (index_file_exists(istate, path_mutable.buf,
330                                       path_mutable.len, icase)) {
331                         /*
332                          * We found a parent directory in the name-hash
333                          * hashtable, because only sparse directory entries
334                          * have a trailing '/' character.  Since "path" wasn't
335                          * in the index, perhaps it exists within this
336                          * sparse-directory.  Expand accordingly.
337                          */
338                         ensure_full_index(istate);
339                         break;
340                 }
341
342                 *replace = temp;
343                 substr_len = replace - path_mutable.buf;
344         }
345
346 cleanup:
347         strbuf_release(&path_mutable);
348         in_expand_to_path = 0;
349 }