sparse-index: add index.sparse config option
[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;
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 static int enable_sparse_index(struct repository *repo)
106 {
107         const char *config_path = repo_git_path(repo, "config.worktree");
108
109         git_config_set_in_file_gently(config_path,
110                                       "index.sparse",
111                                       "true");
112
113         prepare_repo_settings(repo);
114         repo->settings.sparse_index = 1;
115         return 0;
116 }
117
118 int convert_to_sparse(struct index_state *istate)
119 {
120         if (istate->split_index || istate->sparse_index ||
121             !core_apply_sparse_checkout || !core_sparse_checkout_cone)
122                 return 0;
123
124         if (!istate->repo)
125                 istate->repo = the_repository;
126
127         /*
128          * The GIT_TEST_SPARSE_INDEX environment variable triggers the
129          * index.sparse config variable to be on.
130          */
131         if (git_env_bool("GIT_TEST_SPARSE_INDEX", 0)) {
132                 int err = enable_sparse_index(istate->repo);
133                 if (err < 0)
134                         return err;
135         }
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         istate->drop_cache_tree = 1;
167         istate->sparse_index = 1;
168         trace2_region_leave("index", "convert_to_sparse", istate->repo);
169         return 0;
170 }
171
172 static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
173 {
174         ALLOC_GROW(istate->cache, nr + 1, istate->cache_alloc);
175
176         istate->cache[nr] = ce;
177         add_name_hash(istate, ce);
178 }
179
180 static int add_path_to_index(const struct object_id *oid,
181                              struct strbuf *base, const char *path,
182                              unsigned int mode, void *context)
183 {
184         struct index_state *istate = (struct index_state *)context;
185         struct cache_entry *ce;
186         size_t len = base->len;
187
188         if (S_ISDIR(mode))
189                 return READ_TREE_RECURSIVE;
190
191         strbuf_addstr(base, path);
192
193         ce = make_cache_entry(istate, mode, oid, base->buf, 0, 0);
194         ce->ce_flags |= CE_SKIP_WORKTREE;
195         set_index_entry(istate, istate->cache_nr++, ce);
196
197         strbuf_setlen(base, len);
198         return 0;
199 }
200
201 void ensure_full_index(struct index_state *istate)
202 {
203         int i;
204         struct index_state *full;
205         struct strbuf base = STRBUF_INIT;
206
207         if (!istate || !istate->sparse_index)
208                 return;
209
210         if (!istate->repo)
211                 istate->repo = the_repository;
212
213         trace2_region_enter("index", "ensure_full_index", istate->repo);
214
215         /* initialize basics of new index */
216         full = xcalloc(1, sizeof(struct index_state));
217         memcpy(full, istate, sizeof(struct index_state));
218
219         /* then change the necessary things */
220         full->sparse_index = 0;
221         full->cache_alloc = (3 * istate->cache_alloc) / 2;
222         full->cache_nr = 0;
223         ALLOC_ARRAY(full->cache, full->cache_alloc);
224
225         for (i = 0; i < istate->cache_nr; i++) {
226                 struct cache_entry *ce = istate->cache[i];
227                 struct tree *tree;
228                 struct pathspec ps;
229
230                 if (!S_ISSPARSEDIR(ce->ce_mode)) {
231                         set_index_entry(full, full->cache_nr++, ce);
232                         continue;
233                 }
234                 if (!(ce->ce_flags & CE_SKIP_WORKTREE))
235                         warning(_("index entry is a directory, but not sparse (%08x)"),
236                                 ce->ce_flags);
237
238                 /* recursively walk into cd->name */
239                 tree = lookup_tree(istate->repo, &ce->oid);
240
241                 memset(&ps, 0, sizeof(ps));
242                 ps.recursive = 1;
243                 ps.has_wildcard = 1;
244                 ps.max_depth = -1;
245
246                 strbuf_setlen(&base, 0);
247                 strbuf_add(&base, ce->name, strlen(ce->name));
248
249                 read_tree_at(istate->repo, tree, &base, &ps,
250                              add_path_to_index, full);
251
252                 /* free directory entries. full entries are re-used */
253                 discard_cache_entry(ce);
254         }
255
256         /* Copy back into original index. */
257         memcpy(&istate->name_hash, &full->name_hash, sizeof(full->name_hash));
258         istate->sparse_index = 0;
259         free(istate->cache);
260         istate->cache = full->cache;
261         istate->cache_nr = full->cache_nr;
262         istate->cache_alloc = full->cache_alloc;
263
264         strbuf_release(&base);
265         free(full);
266
267         trace2_region_leave("index", "ensure_full_index", istate->repo);
268 }