[thirdparty/git.git] / sparse-index.c

#include "cache.h"
#include "repository.h"
#include "sparse-index.h"
#include "tree.h"
#include "pathspec.h"
#include "trace2.h"
#include "cache-tree.h"
#include "config.h"
#include "dir.h"
#include "fsmonitor.h"

static struct cache_entry *construct_sparse_dir_entry(
				struct index_state *istate,
				const char *sparse_dir,
				struct cache_tree *tree)
{
	struct cache_entry *de;

	de = make_cache_entry(istate, S_IFDIR, &tree->oid, sparse_dir, 0, 0);

	de->ce_flags |= CE_SKIP_WORKTREE;
	return de;
}

/*
 * Returns the number of entries "inserted" into the index.
 */
static int convert_to_sparse_rec(struct index_state *istate,
				 int num_converted,
				 int start, int end,
				 const char *ct_path, size_t ct_pathlen,
				 struct cache_tree *ct)
{
	int i, can_convert = 1;
	int start_converted = num_converted;
	enum pattern_match_result match;
	int dtype;
	struct strbuf child_path = STRBUF_INIT;
	struct pattern_list *pl = istate->sparse_checkout_patterns;

	/*
	 * Is the current path outside of the sparse cone?
	 * Then check if the region can be replaced by a sparse
	 * directory entry (everything is sparse and merged).
	 */
	match = path_matches_pattern_list(ct_path, ct_pathlen,
					  NULL, &dtype, pl, istate);
	if (match != NOT_MATCHED)
		can_convert = 0;

	for (i = start; can_convert && i < end; i++) {
		struct cache_entry *ce = istate->cache[i];

		if (ce_stage(ce) ||
		    S_ISGITLINK(ce->ce_mode) ||
		    !(ce->ce_flags & CE_SKIP_WORKTREE))
			can_convert = 0;
	}

	if (can_convert) {
		struct cache_entry *se;
		se = construct_sparse_dir_entry(istate, ct_path, ct);

		istate->cache[num_converted++] = se;
		return 1;
	}

	for (i = start; i < end; ) {
		int count, span, pos = -1;
		const char *base, *slash;
		struct cache_entry *ce = istate->cache[i];

		/*
		 * Detect if this is a normal entry outside of any subtree
		 * entry.
		 */
		base = ce->name + ct_pathlen;
		slash = strchr(base, '/');

		if (slash)
			pos = cache_tree_subtree_pos(ct, base, slash - base);

		if (pos < 0) {
			istate->cache[num_converted++] = ce;
			i++;
			continue;
		}

		strbuf_setlen(&child_path, 0);
		strbuf_add(&child_path, ce->name, slash - ce->name + 1);

		span = ct->down[pos]->cache_tree->entry_count;
		count = convert_to_sparse_rec(istate,
					      num_converted, i, i + span,
					      child_path.buf, child_path.len,
					      ct->down[pos]->cache_tree);
		num_converted += count;
		i += span;
	}

	strbuf_release(&child_path);
	return num_converted - start_converted;
}

static int set_index_sparse_config(struct repository *repo, int enable)
{
	int res;
	char *config_path = repo_git_path(repo, "config.worktree");
	res = git_config_set_in_file_gently(config_path,
					    "index.sparse",
					    enable ? "true" : NULL);
	free(config_path);

	prepare_repo_settings(repo);
	repo->settings.sparse_index = 1;
	return res;
}

int set_sparse_index_config(struct repository *repo, int enable)
{
	int res = set_index_sparse_config(repo, enable);

	prepare_repo_settings(repo);
	repo->settings.sparse_index = enable;
	return res;
}

int convert_to_sparse(struct index_state *istate)
{
	int test_env;
	if (istate->split_index || istate->sparse_index ||
	    !core_apply_sparse_checkout || !core_sparse_checkout_cone)
		return 0;

	if (!istate->repo)
		istate->repo = the_repository;

	/*
	 * The GIT_TEST_SPARSE_INDEX environment variable triggers the
	 * index.sparse config variable to be on.
	 */
	test_env = git_env_bool("GIT_TEST_SPARSE_INDEX", -1);
	if (test_env >= 0)
		set_sparse_index_config(istate->repo, test_env);

	/*
	 * Only convert to sparse if index.sparse is set.
	 */
	prepare_repo_settings(istate->repo);
	if (!istate->repo->settings.sparse_index)
		return 0;

	if (!istate->sparse_checkout_patterns) {
		istate->sparse_checkout_patterns = xcalloc(1, sizeof(struct pattern_list));
		if (get_sparse_checkout_patterns(istate->sparse_checkout_patterns) < 0)
			return 0;
	}

	if (!istate->sparse_checkout_patterns->use_cone_patterns) {
		warning(_("attempting to use sparse-index without cone mode"));
		return -1;
	}

	if (cache_tree_update(istate, 0)) {
		warning(_("unable to update cache-tree, staying full"));
		return -1;
	}

	remove_fsmonitor(istate);

	trace2_region_enter("index", "convert_to_sparse", istate->repo);
	istate->cache_nr = convert_to_sparse_rec(istate,
						 0, 0, istate->cache_nr,
						 "", 0, istate->cache_tree);

	/* Clear and recompute the cache-tree */
	cache_tree_free(&istate->cache_tree);
	cache_tree_update(istate, 0);

	istate->sparse_index = 1;
	trace2_region_leave("index", "convert_to_sparse", istate->repo);
	return 0;
}

static void set_index_entry(struct index_state *istate, int nr, struct cache_entry *ce)
{
	ALLOC_GROW(istate->cache, nr + 1, istate->cache_alloc);

	istate->cache[nr] = ce;
	add_name_hash(istate, ce);
}

static int add_path_to_index(const struct object_id *oid,
			     struct strbuf *base, const char *path,
			     unsigned int mode, void *context)
{
	struct index_state *istate = (struct index_state *)context;
	struct cache_entry *ce;
	size_t len = base->len;

	if (S_ISDIR(mode))
		return READ_TREE_RECURSIVE;

	strbuf_addstr(base, path);

	ce = make_cache_entry(istate, mode, oid, base->buf, 0, 0);
	ce->ce_flags |= CE_SKIP_WORKTREE;
	set_index_entry(istate, istate->cache_nr++, ce);

	strbuf_setlen(base, len);
	return 0;
}

void ensure_full_index(struct index_state *istate)
{
	int i;
	struct index_state *full;
	struct strbuf base = STRBUF_INIT;

	if (!istate || !istate->sparse_index)
		return;

	if (!istate->repo)
		istate->repo = the_repository;

	trace2_region_enter("index", "ensure_full_index", istate->repo);

	/* initialize basics of new index */
	full = xcalloc(1, sizeof(struct index_state));
	memcpy(full, istate, sizeof(struct index_state));

	/* then change the necessary things */
	full->sparse_index = 0;
	full->cache_alloc = (3 * istate->cache_alloc) / 2;
	full->cache_nr = 0;
	ALLOC_ARRAY(full->cache, full->cache_alloc);

	for (i = 0; i < istate->cache_nr; i++) {
		struct cache_entry *ce = istate->cache[i];
		struct tree *tree;
		struct pathspec ps;

		if (!S_ISSPARSEDIR(ce->ce_mode)) {
			set_index_entry(full, full->cache_nr++, ce);
			continue;
		}
		if (!(ce->ce_flags & CE_SKIP_WORKTREE))
			warning(_("index entry is a directory, but not sparse (%08x)"),
				ce->ce_flags);

		/* recursively walk into cd->name */
		tree = lookup_tree(istate->repo, &ce->oid);

		memset(&ps, 0, sizeof(ps));
		ps.recursive = 1;
		ps.has_wildcard = 1;
		ps.max_depth = -1;

		strbuf_setlen(&base, 0);
		strbuf_add(&base, ce->name, strlen(ce->name));

		read_tree_at(istate->repo, tree, &base, &ps,
			     add_path_to_index, full);

		/* free directory entries. full entries are re-used */
		discard_cache_entry(ce);
	}

	/* Copy back into original index. */
	memcpy(&istate->name_hash, &full->name_hash, sizeof(full->name_hash));
	istate->sparse_index = 0;
	free(istate->cache);
	istate->cache = full->cache;
	istate->cache_nr = full->cache_nr;
	istate->cache_alloc = full->cache_alloc;

	strbuf_release(&base);
	free(full);

	/* Clear and recompute the cache-tree */
	cache_tree_free(&istate->cache_tree);
	cache_tree_update(istate, 0);

	trace2_region_leave("index", "ensure_full_index", istate->repo);
}

/*
 * This static global helps avoid infinite recursion between
 * expand_to_path() and index_file_exists().
 */
static int in_expand_to_path = 0;

void expand_to_path(struct index_state *istate,
		    const char *path, size_t pathlen, int icase)
{
	struct strbuf path_mutable = STRBUF_INIT;
	size_t substr_len;

	/* prevent extra recursion */
	if (in_expand_to_path)
		return;

	if (!istate || !istate->sparse_index)
		return;

	if (!istate->repo)
		istate->repo = the_repository;

	in_expand_to_path = 1;

	/*
	 * We only need to actually expand a region if the
	 * following are both true:
	 *
	 * 1. 'path' is not already in the index.
	 * 2. Some parent directory of 'path' is a sparse directory.
	 */

	if (index_file_exists(istate, path, pathlen, icase))
		goto cleanup;

	strbuf_add(&path_mutable, path, pathlen);
	strbuf_addch(&path_mutable, '/');

	/* Check the name hash for all parent directories */
	substr_len = 0;
	while (substr_len < pathlen) {
		char temp;
		char *replace = strchr(path_mutable.buf + substr_len, '/');

		if (!replace)
			break;

		/* replace the character _after_ the slash */
		replace++;
		temp = *replace;
		*replace = '\0';
		if (index_file_exists(istate, path_mutable.buf,
				      path_mutable.len, icase)) {
			/*
			 * We found a parent directory in the name-hash
			 * hashtable, because only sparse directory entries
			 * have a trailing '/' character.  Since "path" wasn't
			 * in the index, perhaps it exists within this
			 * sparse-directory.  Expand accordingly.
			 */
			ensure_full_index(istate);
			break;
		}

		*replace = temp;
		substr_len = replace - path_mutable.buf;
	}

cleanup:
	strbuf_release(&path_mutable);
	in_expand_to_path = 0;
}
Commit	Line	Data
3964fc2a DS	1	#include "cache.h"
	2	#include "repository.h"
	3	#include "sparse-index.h"
4300f844 DS	4	#include "tree.h"
	5	#include "pathspec.h"
	6	#include "trace2.h"
6e773527 DS	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) \|\|
f442313e	55	S_ISGITLINK(ce->ce_mode) \|\|
6e773527 DS	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
122ba1f7	105	static int set_index_sparse_config(struct repository *repo, int enable)
58300f47	106	{
122ba1f7 DS	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);
58300f47 DS	113
	114	prepare_repo_settings(repo);
	115	repo->settings.sparse_index = 1;
122ba1f7 DS	116	return res;
	117	}
	118
	119	int set_sparse_index_config(struct repository *repo, int enable)
	120	{
	121	int res = set_index_sparse_config(repo, enable);
	122
	123	prepare_repo_settings(repo);
	124	repo->settings.sparse_index = enable;
	125	return res;
58300f47 DS	126	}
58300f47 DS	127
6e773527 DS	128	int convert_to_sparse(struct index_state *istate)
6e773527 DS	129	{
122ba1f7	130	int test_env;
6e773527 DS	131	if (istate->split_index \|\| istate->sparse_index \|\|
	132	!core_apply_sparse_checkout \|\| !core_sparse_checkout_cone)
	133	return 0;
	134
58300f47 DS	135	if (!istate->repo)
	136	istate->repo = the_repository;
	137
	138	/*
	139	* The GIT_TEST_SPARSE_INDEX environment variable triggers the
	140	* index.sparse config variable to be on.
	141	*/
122ba1f7 DS	142	test_env = git_env_bool("GIT_TEST_SPARSE_INDEX", -1);
	143	if (test_env >= 0)
	144	set_sparse_index_config(istate->repo, test_env);
58300f47	145
6e773527	146	/*
58300f47	147	* Only convert to sparse if index.sparse is set.
6e773527	148	*/
58300f47 DS	149	prepare_repo_settings(istate->repo);
58300f47 DS	150	if (!istate->repo->settings.sparse_index)
6e773527 DS	151	return 0;
	152
	153	if (!istate->sparse_checkout_patterns) {
	154	istate->sparse_checkout_patterns = xcalloc(1, sizeof(struct pattern_list));
	155	if (get_sparse_checkout_patterns(istate->sparse_checkout_patterns) < 0)
	156	return 0;
	157	}
	158
	159	if (!istate->sparse_checkout_patterns->use_cone_patterns) {
	160	warning(_("attempting to use sparse-index without cone mode"));
	161	return -1;
	162	}
	163
	164	if (cache_tree_update(istate, 0)) {
	165	warning(_("unable to update cache-tree, staying full"));
	166	return -1;
	167	}
	168
	169	remove_fsmonitor(istate);
	170
	171	trace2_region_enter("index", "convert_to_sparse", istate->repo);
	172	istate->cache_nr = convert_to_sparse_rec(istate,
	173	0, 0, istate->cache_nr,
	174	"", 0, istate->cache_tree);
2de37c53 DS	175
	176	/* Clear and recompute the cache-tree */
	177	cache_tree_free(&istate->cache_tree);
	178	cache_tree_update(istate, 0);
	179
6e773527 DS	180	istate->sparse_index = 1;
	181	trace2_region_leave("index", "convert_to_sparse", istate->repo);
	182	return 0;
	183	}
4300f844 DS	184
	185	static void set_index_entry(struct index_state istate, int nr, struct cache_entry ce)
	186	{
	187	ALLOC_GROW(istate->cache, nr + 1, istate->cache_alloc);
	188
	189	istate->cache[nr] = ce;
	190	add_name_hash(istate, ce);
	191	}
	192
	193	static int add_path_to_index(const struct object_id *oid,
	194	struct strbuf base, const char path,
	195	unsigned int mode, void *context)
	196	{
	197	struct index_state istate = (struct index_state )context;
	198	struct cache_entry *ce;
	199	size_t len = base->len;
	200
	201	if (S_ISDIR(mode))
	202	return READ_TREE_RECURSIVE;
	203
	204	strbuf_addstr(base, path);
	205
	206	ce = make_cache_entry(istate, mode, oid, base->buf, 0, 0);
	207	ce->ce_flags \|= CE_SKIP_WORKTREE;
	208	set_index_entry(istate, istate->cache_nr++, ce);
	209
	210	strbuf_setlen(base, len);
	211	return 0;
	212	}
3964fc2a DS	213
	214	void ensure_full_index(struct index_state *istate)
	215	{
4300f844 DS	216	int i;
	217	struct index_state *full;
	218	struct strbuf base = STRBUF_INIT;
	219
	220	if (!istate \|\| !istate->sparse_index)
	221	return;
	222
	223	if (!istate->repo)
	224	istate->repo = the_repository;
	225
	226	trace2_region_enter("index", "ensure_full_index", istate->repo);
	227
	228	/* initialize basics of new index */
	229	full = xcalloc(1, sizeof(struct index_state));
	230	memcpy(full, istate, sizeof(struct index_state));
	231
	232	/* then change the necessary things */
	233	full->sparse_index = 0;
	234	full->cache_alloc = (3 * istate->cache_alloc) / 2;
	235	full->cache_nr = 0;
	236	ALLOC_ARRAY(full->cache, full->cache_alloc);
	237
	238	for (i = 0; i < istate->cache_nr; i++) {
	239	struct cache_entry *ce = istate->cache[i];
	240	struct tree *tree;
	241	struct pathspec ps;
	242
	243	if (!S_ISSPARSEDIR(ce->ce_mode)) {
	244	set_index_entry(full, full->cache_nr++, ce);
	245	continue;
	246	}
	247	if (!(ce->ce_flags & CE_SKIP_WORKTREE))
	248	warning(_("index entry is a directory, but not sparse (%08x)"),
	249	ce->ce_flags);
	250
	251	/* recursively walk into cd->name */
	252	tree = lookup_tree(istate->repo, &ce->oid);
	253
	254	memset(&ps, 0, sizeof(ps));
	255	ps.recursive = 1;
	256	ps.has_wildcard = 1;
	257	ps.max_depth = -1;
	258
	259	strbuf_setlen(&base, 0);
	260	strbuf_add(&base, ce->name, strlen(ce->name));
	261
	262	read_tree_at(istate->repo, tree, &base, &ps,
	263	add_path_to_index, full);
	264
	265	/* free directory entries. full entries are re-used */
	266	discard_cache_entry(ce);
	267	}
	268
	269	/* Copy back into original index. */
	270	memcpy(&istate->name_hash, &full->name_hash, sizeof(full->name_hash));
	271	istate->sparse_index = 0;
	272	free(istate->cache);
	273	istate->cache = full->cache;
	274	istate->cache_nr = full->cache_nr;
	275	istate->cache_alloc = full->cache_alloc;
	276
	277	strbuf_release(&base);
	278	free(full);
	279
2de37c53 DS	280	/* Clear and recompute the cache-tree */
	281	cache_tree_free(&istate->cache_tree);
	282	cache_tree_update(istate, 0);
	283
4300f844	284	trace2_region_leave("index", "ensure_full_index", istate->repo);
3964fc2a	285	}
71f82d03 DS	286
	287	/*
	288	* This static global helps avoid infinite recursion between
	289	* expand_to_path() and index_file_exists().
	290	*/
	291	static int in_expand_to_path = 0;
	292
	293	void expand_to_path(struct index_state *istate,
	294	const char *path, size_t pathlen, int icase)
	295	{
	296	struct strbuf path_mutable = STRBUF_INIT;
	297	size_t substr_len;
	298
	299	/* prevent extra recursion */
	300	if (in_expand_to_path)
	301	return;
	302
	303	if (!istate \|\| !istate->sparse_index)
	304	return;
	305
	306	if (!istate->repo)
	307	istate->repo = the_repository;
	308
	309	in_expand_to_path = 1;
	310
	311	/*
	312	* We only need to actually expand a region if the
	313	* following are both true:
	314	*
	315	* 1. 'path' is not already in the index.
	316	* 2. Some parent directory of 'path' is a sparse directory.
	317	*/
	318
	319	if (index_file_exists(istate, path, pathlen, icase))
	320	goto cleanup;
	321
	322	strbuf_add(&path_mutable, path, pathlen);
	323	strbuf_addch(&path_mutable, '/');
	324
	325	/* Check the name hash for all parent directories */
	326	substr_len = 0;
	327	while (substr_len < pathlen) {
	328	char temp;
	329	char *replace = strchr(path_mutable.buf + substr_len, '/');
	330
	331	if (!replace)
	332	break;
	333
	334	/* replace the character _after_ the slash */
	335	replace++;
	336	temp = *replace;
	337	*replace = '\0';
	338	if (index_file_exists(istate, path_mutable.buf,
	339	path_mutable.len, icase)) {
	340	/*
	341	* We found a parent directory in the name-hash
	342	* hashtable, because only sparse directory entries
	343	* have a trailing '/' character. Since "path" wasn't
	344	* in the index, perhaps it exists within this
	345	* sparse-directory. Expand accordingly.
	346	*/
	347	ensure_full_index(istate);
	348	break;
	349	}
350
351	*replace = temp;
352	substr_len = replace - path_mutable.buf;
353	}
354
355	cleanup:
356	strbuf_release(&path_mutable);
357	in_expand_to_path = 0;
358	}