[thirdparty/git.git] / repository.c

/*
 * not really _using_ the compat macros, just make sure the_index
 * declaration matches the definition in this file.
 */
#define USE_THE_INDEX_VARIABLE
#include "git-compat-util.h"
#include "abspath.h"
#include "repository.h"
#include "object-store-ll.h"
#include "config.h"
#include "object.h"
#include "lockfile.h"
#include "path.h"
#include "read-cache-ll.h"
#include "remote.h"
#include "setup.h"
#include "submodule-config.h"
#include "sparse-index.h"
#include "trace2.h"
#include "promisor-remote.h"

/* The main repository */
static struct repository the_repo;
struct repository *the_repository;
struct index_state the_index;

void initialize_the_repository(void)
{
	the_repository = &the_repo;

	the_repo.index = &the_index;
	the_repo.objects = raw_object_store_new();
	the_repo.remote_state = remote_state_new();
	the_repo.parsed_objects = parsed_object_pool_new();

	index_state_init(&the_index, the_repository);

	repo_set_hash_algo(&the_repo, GIT_HASH_SHA1);
}

static void expand_base_dir(char **out, const char *in,
			    const char *base_dir, const char *def_in)
{
	free(*out);
	if (in)
		*out = xstrdup(in);
	else
		*out = xstrfmt("%s/%s", base_dir, def_in);
}

static void repo_set_commondir(struct repository *repo,
			       const char *commondir)
{
	struct strbuf sb = STRBUF_INIT;

	free(repo->commondir);

	if (commondir) {
		repo->different_commondir = 1;
		repo->commondir = xstrdup(commondir);
		return;
	}

	repo->different_commondir = get_common_dir_noenv(&sb, repo->gitdir);
	repo->commondir = strbuf_detach(&sb, NULL);
}

void repo_set_gitdir(struct repository *repo,
		     const char *root,
		     const struct set_gitdir_args *o)
{
	const char *gitfile = read_gitfile(root);
	/*
	 * repo->gitdir is saved because the caller could pass "root"
	 * that also points to repo->gitdir. We want to keep it alive
	 * until after xstrdup(root). Then we can free it.
	 */
	char *old_gitdir = repo->gitdir;

	repo->gitdir = xstrdup(gitfile ? gitfile : root);
	free(old_gitdir);

	repo_set_commondir(repo, o->commondir);

	if (!repo->objects->odb) {
		CALLOC_ARRAY(repo->objects->odb, 1);
		repo->objects->odb_tail = &repo->objects->odb->next;
	}
	expand_base_dir(&repo->objects->odb->path, o->object_dir,
			repo->commondir, "objects");

	repo->objects->odb->disable_ref_updates = o->disable_ref_updates;

	free(repo->objects->alternate_db);
	repo->objects->alternate_db = xstrdup_or_null(o->alternate_db);
	expand_base_dir(&repo->graft_file, o->graft_file,
			repo->commondir, "info/grafts");
	expand_base_dir(&repo->index_file, o->index_file,
			repo->gitdir, "index");
}

void repo_set_hash_algo(struct repository *repo, int hash_algo)
{
	repo->hash_algo = &hash_algos[hash_algo];
}

void repo_set_ref_storage_format(struct repository *repo, unsigned int format)
{
	repo->ref_storage_format = format;
}

/*
 * Attempt to resolve and set the provided 'gitdir' for repository 'repo'.
 * Return 0 upon success and a non-zero value upon failure.
 */
static int repo_init_gitdir(struct repository *repo, const char *gitdir)
{
	int ret = 0;
	int error = 0;
	char *abspath = NULL;
	const char *resolved_gitdir;
	struct set_gitdir_args args = { NULL };

	abspath = real_pathdup(gitdir, 0);
	if (!abspath) {
		ret = -1;
		goto out;
	}

	/* 'gitdir' must reference the gitdir directly */
	resolved_gitdir = resolve_gitdir_gently(abspath, &error);
	if (!resolved_gitdir) {
		ret = -1;
		goto out;
	}

	repo_set_gitdir(repo, resolved_gitdir, &args);

out:
	free(abspath);
	return ret;
}

void repo_set_worktree(struct repository *repo, const char *path)
{
	repo->worktree = real_pathdup(path, 1);

	trace2_def_repo(repo);
}

static int read_and_verify_repository_format(struct repository_format *format,
					     const char *commondir)
{
	int ret = 0;
	struct strbuf sb = STRBUF_INIT;

	strbuf_addf(&sb, "%s/config", commondir);
	read_repository_format(format, sb.buf);
	strbuf_reset(&sb);

	if (verify_repository_format(format, &sb) < 0) {
		warning("%s", sb.buf);
		ret = -1;
	}

	strbuf_release(&sb);
	return ret;
}

/*
 * Initialize 'repo' based on the provided 'gitdir'.
 * Return 0 upon success and a non-zero value upon failure.
 */
int repo_init(struct repository *repo,
	      const char *gitdir,
	      const char *worktree)
{
	struct repository_format format = REPOSITORY_FORMAT_INIT;
	memset(repo, 0, sizeof(*repo));

	repo->objects = raw_object_store_new();
	repo->parsed_objects = parsed_object_pool_new();
	repo->remote_state = remote_state_new();

	if (repo_init_gitdir(repo, gitdir))
		goto error;

	if (read_and_verify_repository_format(&format, repo->commondir))
		goto error;

	repo_set_hash_algo(repo, format.hash_algo);
	repo_set_ref_storage_format(repo, format.ref_storage_format);
	repo->repository_format_worktree_config = format.worktree_config;

	/* take ownership of format.partial_clone */
	repo->repository_format_partial_clone = format.partial_clone;
	format.partial_clone = NULL;

	if (worktree)
		repo_set_worktree(repo, worktree);

	clear_repository_format(&format);
	return 0;

error:
	repo_clear(repo);
	return -1;
}

int repo_submodule_init(struct repository *subrepo,
			struct repository *superproject,
			const char *path,
			const struct object_id *treeish_name)
{
	struct strbuf gitdir = STRBUF_INIT;
	struct strbuf worktree = STRBUF_INIT;
	int ret = 0;

	strbuf_repo_worktree_path(&gitdir, superproject, "%s/.git", path);
	strbuf_repo_worktree_path(&worktree, superproject, "%s", path);

	if (repo_init(subrepo, gitdir.buf, worktree.buf)) {
		/*
		 * If initialization fails then it may be due to the submodule
		 * not being populated in the superproject's worktree.  Instead
		 * we can try to initialize the submodule by finding it's gitdir
		 * in the superproject's 'modules' directory.  In this case the
		 * submodule would not have a worktree.
		 */
		const struct submodule *sub =
			submodule_from_path(superproject, treeish_name, path);
		if (!sub) {
			ret = -1;
			goto out;
		}

		strbuf_reset(&gitdir);
		submodule_name_to_gitdir(&gitdir, superproject, sub->name);

		if (repo_init(subrepo, gitdir.buf, NULL)) {
			ret = -1;
			goto out;
		}
	}

	subrepo->submodule_prefix = xstrfmt("%s%s/",
					    superproject->submodule_prefix ?
					    superproject->submodule_prefix :
					    "", path);

out:
	strbuf_release(&gitdir);
	strbuf_release(&worktree);
	return ret;
}

static void repo_clear_path_cache(struct repo_path_cache *cache)
{
	FREE_AND_NULL(cache->squash_msg);
	FREE_AND_NULL(cache->squash_msg);
	FREE_AND_NULL(cache->merge_msg);
	FREE_AND_NULL(cache->merge_rr);
	FREE_AND_NULL(cache->merge_mode);
	FREE_AND_NULL(cache->merge_head);
	FREE_AND_NULL(cache->fetch_head);
	FREE_AND_NULL(cache->shallow);
}

void repo_clear(struct repository *repo)
{
	FREE_AND_NULL(repo->gitdir);
	FREE_AND_NULL(repo->commondir);
	FREE_AND_NULL(repo->graft_file);
	FREE_AND_NULL(repo->index_file);
	FREE_AND_NULL(repo->worktree);
	FREE_AND_NULL(repo->submodule_prefix);

	raw_object_store_clear(repo->objects);
	FREE_AND_NULL(repo->objects);

	parsed_object_pool_clear(repo->parsed_objects);
	FREE_AND_NULL(repo->parsed_objects);

	if (repo->config) {
		git_configset_clear(repo->config);
		FREE_AND_NULL(repo->config);
	}

	if (repo->submodule_cache) {
		submodule_cache_free(repo->submodule_cache);
		repo->submodule_cache = NULL;
	}

	if (repo->index) {
		discard_index(repo->index);
		if (repo->index != &the_index)
			FREE_AND_NULL(repo->index);
	}

	if (repo->promisor_remote_config) {
		promisor_remote_clear(repo->promisor_remote_config);
		FREE_AND_NULL(repo->promisor_remote_config);
	}

	if (repo->remote_state) {
		remote_state_clear(repo->remote_state);
		FREE_AND_NULL(repo->remote_state);
	}

	repo_clear_path_cache(&repo->cached_paths);
}

int repo_read_index(struct repository *repo)
{
	int res;

	/* Complete the double-reference */
	if (!repo->index) {
		ALLOC_ARRAY(repo->index, 1);
		index_state_init(repo->index, repo);
	} else if (repo->index->repo != repo) {
		BUG("repo's index should point back at itself");
	}

	res = read_index_from(repo->index, repo->index_file, repo->gitdir);

	prepare_repo_settings(repo);
	if (repo->settings.command_requires_full_index)
		ensure_full_index(repo->index);

	/*
	 * If sparse checkouts are in use, check whether paths with the
	 * SKIP_WORKTREE attribute are missing from the worktree; if not,
	 * clear that attribute for that path.
	 */
	clear_skip_worktree_from_present_files(repo->index);

	return res;
}

int repo_hold_locked_index(struct repository *repo,
			   struct lock_file *lf,
			   int flags)
{
	if (!repo->index_file)
		BUG("the repo hasn't been setup");
	return hold_lock_file_for_update(lf, repo->index_file, flags);
}
Commit	Line	Data
f8adbec9 NTND	1	/*
	2	* not really _using_ the compat macros, just make sure the_index
	3	* declaration matches the definition in this file.
	4	*/
666f53eb	5	#define USE_THE_INDEX_VARIABLE
bc5c5ec0	6	#include "git-compat-util.h"
0b027f6c	7	#include "abspath.h"
359efeff	8	#include "repository.h"
a034e910	9	#include "object-store-ll.h"
3b256228	10	#include "config.h"
99bf115c	11	#include "object.h"
3a95f31d	12	#include "lockfile.h"
c339932b	13	#include "path.h"
08c46a49	14	#include "read-cache-ll.h"
fd3cb050	15	#include "remote.h"
e38da487	16	#include "setup.h"
bf12fcdf	17	#include "submodule-config.h"
3964fc2a	18	#include "sparse-index.h"
74ea5c95	19	#include "trace2.h"
ef7dc2e9	20	#include "promisor-remote.h"
359efeff BW	21
359efeff BW	22	/* The main repository */
b2f0ecee NTND	23	static struct repository the_repo;
b2f0ecee NTND	24	struct repository *the_repository;
f8adbec9	25	struct index_state the_index;
b2f0ecee NTND	26
	27	void initialize_the_repository(void)
	28	{
	29	the_repository = &the_repo;
	30
	31	the_repo.index = &the_index;
90c62155	32	the_repo.objects = raw_object_store_new();
fd3cb050	33	the_repo.remote_state = remote_state_new();
99bf115c SB	34	the_repo.parsed_objects = parsed_object_pool_new();
99bf115c SB	35
6269f8ea ÆAB	36	index_state_init(&the_index, the_repository);
6269f8ea ÆAB	37
b2f0ecee NTND	38	repo_set_hash_algo(&the_repo, GIT_HASH_SHA1);
b2f0ecee NTND	39	}
359efeff	40
357a03eb NTND	41	static void expand_base_dir(char *out, const char in,
	42	const char base_dir, const char def_in)
	43	{
	44	free(*out);
	45	if (in)
	46	*out = xstrdup(in);
	47	else
	48	*out = xstrfmt("%s/%s", base_dir, def_in);
	49	}
	50
	51	static void repo_set_commondir(struct repository *repo,
	52	const char *commondir)
359efeff BW	53	{
	54	struct strbuf sb = STRBUF_INIT;
	55
f9b7573f	56	free(repo->commondir);
357a03eb NTND	57
	58	if (commondir) {
	59	repo->different_commondir = 1;
	60	repo->commondir = xstrdup(commondir);
	61	return;
	62	}
	63
	64	repo->different_commondir = get_common_dir_noenv(&sb, repo->gitdir);
359efeff	65	repo->commondir = strbuf_detach(&sb, NULL);
359efeff BW	66	}
359efeff BW	67
357a03eb NTND	68	void repo_set_gitdir(struct repository *repo,
	69	const char *root,
	70	const struct set_gitdir_args *o)
359efeff	71	{
357a03eb NTND	72	const char *gitfile = read_gitfile(root);
	73	/*
	74	* repo->gitdir is saved because the caller could pass "root"
	75	* that also points to repo->gitdir. We want to keep it alive
	76	* until after xstrdup(root). Then we can free it.
	77	*/
1fb2b636	78	char *old_gitdir = repo->gitdir;
359efeff	79
357a03eb	80	repo->gitdir = xstrdup(gitfile ? gitfile : root);
1fb2b636	81	free(old_gitdir);
357a03eb NTND	82
357a03eb NTND	83	repo_set_commondir(repo, o->commondir);
f0eaf638 JK	84
f0eaf638 JK	85	if (!repo->objects->odb) {
ca56dadb	86	CALLOC_ARRAY(repo->objects->odb, 1);
f0eaf638 JK	87	repo->objects->odb_tail = &repo->objects->odb->next;
	88	}
	89	expand_base_dir(&repo->objects->odb->path, o->object_dir,
357a03eb	90	repo->commondir, "objects");
f0eaf638	91
ecd81dfc NS	92	repo->objects->odb->disable_ref_updates = o->disable_ref_updates;
ecd81dfc NS	93
90c62155 SB	94	free(repo->objects->alternate_db);
90c62155 SB	95	repo->objects->alternate_db = xstrdup_or_null(o->alternate_db);
357a03eb NTND	96	expand_base_dir(&repo->graft_file, o->graft_file,
	97	repo->commondir, "info/grafts");
	98	expand_base_dir(&repo->index_file, o->index_file,
	99	repo->gitdir, "index");
359efeff BW	100	}
359efeff BW	101
78a67668	102	void repo_set_hash_algo(struct repository *repo, int hash_algo)
	103	{
	104	repo->hash_algo = &hash_algos[hash_algo];
	105	}
	106
173761e2 PS	107	void repo_set_ref_storage_format(struct repository *repo, unsigned int format)
	108	{
	109	repo->ref_storage_format = format;
	110	}
	111
359efeff BW	112	/*
	113	* Attempt to resolve and set the provided 'gitdir' for repository 'repo'.
	114	* Return 0 upon success and a non-zero value upon failure.
	115	*/
	116	static int repo_init_gitdir(struct repository repo, const char gitdir)
	117	{
	118	int ret = 0;
	119	int error = 0;
	120	char *abspath = NULL;
	121	const char *resolved_gitdir;
357a03eb	122	struct set_gitdir_args args = { NULL };
359efeff BW	123
	124	abspath = real_pathdup(gitdir, 0);
	125	if (!abspath) {
	126	ret = -1;
	127	goto out;
	128	}
	129
	130	/* 'gitdir' must reference the gitdir directly */
	131	resolved_gitdir = resolve_gitdir_gently(abspath, &error);
	132	if (!resolved_gitdir) {
	133	ret = -1;
	134	goto out;
	135	}
	136
357a03eb	137	repo_set_gitdir(repo, resolved_gitdir, &args);
359efeff BW	138
	139	out:
	140	free(abspath);
	141	return ret;
	142	}
	143
	144	void repo_set_worktree(struct repository repo, const char path)
	145	{
	146	repo->worktree = real_pathdup(path, 1);
ee4512ed JH	147
ee4512ed JH	148	trace2_def_repo(repo);
359efeff BW	149	}
	150
	151	static int read_and_verify_repository_format(struct repository_format *format,
	152	const char *commondir)
	153	{
	154	int ret = 0;
	155	struct strbuf sb = STRBUF_INIT;
	156
	157	strbuf_addf(&sb, "%s/config", commondir);
	158	read_repository_format(format, sb.buf);
	159	strbuf_reset(&sb);
	160
	161	if (verify_repository_format(format, &sb) < 0) {
	162	warning("%s", sb.buf);
	163	ret = -1;
	164	}
	165
	166	strbuf_release(&sb);
	167	return ret;
	168	}
	169
	170	/*
	171	* Initialize 'repo' based on the provided 'gitdir'.
	172	* Return 0 upon success and a non-zero value upon failure.
	173	*/
da62f786 SB	174	int repo_init(struct repository *repo,
	175	const char *gitdir,
	176	const char *worktree)
359efeff	177	{
e8805af1	178	struct repository_format format = REPOSITORY_FORMAT_INIT;
359efeff BW	179	memset(repo, 0, sizeof(*repo));
359efeff BW	180
90c62155	181	repo->objects = raw_object_store_new();
99bf115c	182	repo->parsed_objects = parsed_object_pool_new();
fd3cb050	183	repo->remote_state = remote_state_new();
90c62155	184
359efeff BW	185	if (repo_init_gitdir(repo, gitdir))
	186	goto error;
	187
	188	if (read_and_verify_repository_format(&format, repo->commondir))
	189	goto error;
	190
78a67668	191	repo_set_hash_algo(repo, format.hash_algo);
173761e2	192	repo_set_ref_storage_format(repo, format.ref_storage_format);
3867f6d6	193	repo->repository_format_worktree_config = format.worktree_config;
78a67668	194
ebaf3bcf JT	195	/* take ownership of format.partial_clone */
	196	repo->repository_format_partial_clone = format.partial_clone;
	197	format.partial_clone = NULL;
	198
359efeff BW	199	if (worktree)
	200	repo_set_worktree(repo, worktree);
	201
e8805af1	202	clear_repository_format(&format);
359efeff BW	203	return 0;
	204
	205	error:
	206	repo_clear(repo);
	207	return -1;
	208	}
	209
d5498e08	210	int repo_submodule_init(struct repository *subrepo,
96dc883b	211	struct repository *superproject,
8eb8dcf9 JT	212	const char *path,
8eb8dcf9 JT	213	const struct object_id *treeish_name)
96dc883b	214	{
96dc883b BW	215	struct strbuf gitdir = STRBUF_INIT;
	216	struct strbuf worktree = STRBUF_INIT;
	217	int ret = 0;
	218
8eb8dcf9 JT	219	strbuf_repo_worktree_path(&gitdir, superproject, "%s/.git", path);
8eb8dcf9 JT	220	strbuf_repo_worktree_path(&worktree, superproject, "%s", path);
96dc883b	221
d5498e08	222	if (repo_init(subrepo, gitdir.buf, worktree.buf)) {
96dc883b	223	/*
15beaaa3	224	* If initialization fails then it may be due to the submodule
96dc883b	225	* not being populated in the superproject's worktree. Instead
15beaaa3	226	* we can try to initialize the submodule by finding it's gitdir
96dc883b BW	227	* in the superproject's 'modules' directory. In this case the
	228	* submodule would not have a worktree.
	229	*/
8eb8dcf9 JT	230	const struct submodule *sub =
	231	submodule_from_path(superproject, treeish_name, path);
	232	if (!sub) {
	233	ret = -1;
	234	goto out;
	235	}
	236
96dc883b	237	strbuf_reset(&gitdir);
ce125d43	238	submodule_name_to_gitdir(&gitdir, superproject, sub->name);
96dc883b	239
d5498e08	240	if (repo_init(subrepo, gitdir.buf, NULL)) {
96dc883b BW	241	ret = -1;
	242	goto out;
	243	}
	244	}
	245
d5498e08 SB	246	subrepo->submodule_prefix = xstrfmt("%s%s/",
	247	superproject->submodule_prefix ?
	248	superproject->submodule_prefix :
8eb8dcf9	249	"", path);
96dc883b BW	250
	251	out:
	252	strbuf_release(&gitdir);
	253	strbuf_release(&worktree);
	254	return ret;
	255	}
	256
759f3407 ÆAB	257	static void repo_clear_path_cache(struct repo_path_cache *cache)
	258	{
	259	FREE_AND_NULL(cache->squash_msg);
	260	FREE_AND_NULL(cache->squash_msg);
	261	FREE_AND_NULL(cache->merge_msg);
	262	FREE_AND_NULL(cache->merge_rr);
	263	FREE_AND_NULL(cache->merge_mode);
	264	FREE_AND_NULL(cache->merge_head);
759f3407 ÆAB	265	FREE_AND_NULL(cache->fetch_head);
	266	FREE_AND_NULL(cache->shallow);
	267	}
	268
359efeff BW	269	void repo_clear(struct repository *repo)
359efeff BW	270	{
90dd04aa RS	271	FREE_AND_NULL(repo->gitdir);
90dd04aa RS	272	FREE_AND_NULL(repo->commondir);
90dd04aa RS	273	FREE_AND_NULL(repo->graft_file);
	274	FREE_AND_NULL(repo->index_file);
	275	FREE_AND_NULL(repo->worktree);
	276	FREE_AND_NULL(repo->submodule_prefix);
3b256228	277
90c62155 SB	278	raw_object_store_clear(repo->objects);
	279	FREE_AND_NULL(repo->objects);
	280
99bf115c SB	281	parsed_object_pool_clear(repo->parsed_objects);
	282	FREE_AND_NULL(repo->parsed_objects);
	283
3b256228 BW	284	if (repo->config) {
3b256228 BW	285	git_configset_clear(repo->config);
90dd04aa	286	FREE_AND_NULL(repo->config);
3b256228	287	}
639e30b5	288
bf12fcdf BW	289	if (repo->submodule_cache) {
	290	submodule_cache_free(repo->submodule_cache);
	291	repo->submodule_cache = NULL;
	292	}
	293
639e30b5 BW	294	if (repo->index) {
639e30b5 BW	295	discard_index(repo->index);
74373b5f NTND	296	if (repo->index != &the_index)
74373b5f NTND	297	FREE_AND_NULL(repo->index);
639e30b5	298	}
ef7dc2e9 JT	299
	300	if (repo->promisor_remote_config) {
	301	promisor_remote_clear(repo->promisor_remote_config);
	302	FREE_AND_NULL(repo->promisor_remote_config);
	303	}
fd3cb050 GC	304
	305	if (repo->remote_state) {
	306	remote_state_clear(repo->remote_state);
	307	FREE_AND_NULL(repo->remote_state);
	308	}
759f3407 ÆAB	309
759f3407 ÆAB	310	repo_clear_path_cache(&repo->cached_paths);
639e30b5 BW	311	}
	312
	313	int repo_read_index(struct repository *repo)
	314	{
3964fc2a DS	315	int res;
3964fc2a DS	316
6269f8ea	317	/* Complete the double-reference */
2f6b1eb7 ÆAB	318	if (!repo->index) {
2f6b1eb7 ÆAB	319	ALLOC_ARRAY(repo->index, 1);
6269f8ea ÆAB	320	index_state_init(repo->index, repo);
6269f8ea ÆAB	321	} else if (repo->index->repo != repo) {
1fd9ae51	322	BUG("repo's index should point back at itself");
6269f8ea	323	}
1fd9ae51	324
3964fc2a DS	325	res = read_index_from(repo->index, repo->index_file, repo->gitdir);
	326
	327	prepare_repo_settings(repo);
	328	if (repo->settings.command_requires_full_index)
	329	ensure_full_index(repo->index);
	330
af6a5187 EN	331	/*
	332	* If sparse checkouts are in use, check whether paths with the
	333	* SKIP_WORKTREE attribute are missing from the worktree; if not,
	334	* clear that attribute for that path.
	335	*/
	336	clear_skip_worktree_from_present_files(repo->index);
	337
3964fc2a	338	return res;
359efeff	339	}
3a95f31d NTND	340
	341	int repo_hold_locked_index(struct repository *repo,
	342	struct lock_file *lf,
	343	int flags)
	344	{
	345	if (!repo->index_file)
	346	BUG("the repo hasn't been setup");
	347	return hold_lock_file_for_update(lf, repo->index_file, flags);
	348	}