Merge branch 'jt/midx-doc-fix'
[git/debian.git] / repository.c
blobc7ea706c205fee1f84301668c620906ec5c06650
1 /*
2 * not really _using_ the compat macros, just make sure the_index
3 * declaration matches the definition in this file.
4 */
5 #define USE_THE_INDEX_COMPATIBILITY_MACROS
6 #include "cache.h"
7 #include "repository.h"
8 #include "object-store.h"
9 #include "config.h"
10 #include "object.h"
11 #include "lockfile.h"
12 #include "remote.h"
13 #include "submodule-config.h"
14 #include "sparse-index.h"
15 #include "promisor-remote.h"
17 /* The main repository */
18 static struct repository the_repo;
19 struct repository *the_repository;
20 struct index_state the_index;
22 void initialize_the_repository(void)
24 the_repository = &the_repo;
26 the_repo.index = &the_index;
27 the_repo.objects = raw_object_store_new();
28 the_repo.remote_state = remote_state_new();
29 the_repo.parsed_objects = parsed_object_pool_new();
31 repo_set_hash_algo(&the_repo, GIT_HASH_SHA1);
34 static void expand_base_dir(char **out, const char *in,
35 const char *base_dir, const char *def_in)
37 free(*out);
38 if (in)
39 *out = xstrdup(in);
40 else
41 *out = xstrfmt("%s/%s", base_dir, def_in);
44 static void repo_set_commondir(struct repository *repo,
45 const char *commondir)
47 struct strbuf sb = STRBUF_INIT;
49 free(repo->commondir);
51 if (commondir) {
52 repo->different_commondir = 1;
53 repo->commondir = xstrdup(commondir);
54 return;
57 repo->different_commondir = get_common_dir_noenv(&sb, repo->gitdir);
58 repo->commondir = strbuf_detach(&sb, NULL);
61 void repo_set_gitdir(struct repository *repo,
62 const char *root,
63 const struct set_gitdir_args *o)
65 const char *gitfile = read_gitfile(root);
67 * repo->gitdir is saved because the caller could pass "root"
68 * that also points to repo->gitdir. We want to keep it alive
69 * until after xstrdup(root). Then we can free it.
71 char *old_gitdir = repo->gitdir;
73 repo->gitdir = xstrdup(gitfile ? gitfile : root);
74 free(old_gitdir);
76 repo_set_commondir(repo, o->commondir);
78 if (!repo->objects->odb) {
79 CALLOC_ARRAY(repo->objects->odb, 1);
80 repo->objects->odb_tail = &repo->objects->odb->next;
82 expand_base_dir(&repo->objects->odb->path, o->object_dir,
83 repo->commondir, "objects");
85 free(repo->objects->alternate_db);
86 repo->objects->alternate_db = xstrdup_or_null(o->alternate_db);
87 expand_base_dir(&repo->graft_file, o->graft_file,
88 repo->commondir, "info/grafts");
89 expand_base_dir(&repo->index_file, o->index_file,
90 repo->gitdir, "index");
93 void repo_set_hash_algo(struct repository *repo, int hash_algo)
95 repo->hash_algo = &hash_algos[hash_algo];
99 * Attempt to resolve and set the provided 'gitdir' for repository 'repo'.
100 * Return 0 upon success and a non-zero value upon failure.
102 static int repo_init_gitdir(struct repository *repo, const char *gitdir)
104 int ret = 0;
105 int error = 0;
106 char *abspath = NULL;
107 const char *resolved_gitdir;
108 struct set_gitdir_args args = { NULL };
110 abspath = real_pathdup(gitdir, 0);
111 if (!abspath) {
112 ret = -1;
113 goto out;
116 /* 'gitdir' must reference the gitdir directly */
117 resolved_gitdir = resolve_gitdir_gently(abspath, &error);
118 if (!resolved_gitdir) {
119 ret = -1;
120 goto out;
123 repo_set_gitdir(repo, resolved_gitdir, &args);
125 out:
126 free(abspath);
127 return ret;
130 void repo_set_worktree(struct repository *repo, const char *path)
132 repo->worktree = real_pathdup(path, 1);
134 trace2_def_repo(repo);
137 static int read_and_verify_repository_format(struct repository_format *format,
138 const char *commondir)
140 int ret = 0;
141 struct strbuf sb = STRBUF_INIT;
143 strbuf_addf(&sb, "%s/config", commondir);
144 read_repository_format(format, sb.buf);
145 strbuf_reset(&sb);
147 if (verify_repository_format(format, &sb) < 0) {
148 warning("%s", sb.buf);
149 ret = -1;
152 strbuf_release(&sb);
153 return ret;
157 * Initialize 'repo' based on the provided 'gitdir'.
158 * Return 0 upon success and a non-zero value upon failure.
160 int repo_init(struct repository *repo,
161 const char *gitdir,
162 const char *worktree)
164 struct repository_format format = REPOSITORY_FORMAT_INIT;
165 memset(repo, 0, sizeof(*repo));
167 repo->objects = raw_object_store_new();
168 repo->parsed_objects = parsed_object_pool_new();
169 repo->remote_state = remote_state_new();
171 if (repo_init_gitdir(repo, gitdir))
172 goto error;
174 if (read_and_verify_repository_format(&format, repo->commondir))
175 goto error;
177 repo_set_hash_algo(repo, format.hash_algo);
179 /* take ownership of format.partial_clone */
180 repo->repository_format_partial_clone = format.partial_clone;
181 format.partial_clone = NULL;
183 if (worktree)
184 repo_set_worktree(repo, worktree);
186 clear_repository_format(&format);
187 return 0;
189 error:
190 repo_clear(repo);
191 return -1;
194 int repo_submodule_init(struct repository *subrepo,
195 struct repository *superproject,
196 const char *path,
197 const struct object_id *treeish_name)
199 struct strbuf gitdir = STRBUF_INIT;
200 struct strbuf worktree = STRBUF_INIT;
201 int ret = 0;
203 strbuf_repo_worktree_path(&gitdir, superproject, "%s/.git", path);
204 strbuf_repo_worktree_path(&worktree, superproject, "%s", path);
206 if (repo_init(subrepo, gitdir.buf, worktree.buf)) {
208 * If initialization fails then it may be due to the submodule
209 * not being populated in the superproject's worktree. Instead
210 * we can try to initialize the submodule by finding it's gitdir
211 * in the superproject's 'modules' directory. In this case the
212 * submodule would not have a worktree.
214 const struct submodule *sub =
215 submodule_from_path(superproject, treeish_name, path);
216 if (!sub) {
217 ret = -1;
218 goto out;
221 strbuf_reset(&gitdir);
222 submodule_name_to_gitdir(&gitdir, superproject, sub->name);
224 if (repo_init(subrepo, gitdir.buf, NULL)) {
225 ret = -1;
226 goto out;
230 subrepo->submodule_prefix = xstrfmt("%s%s/",
231 superproject->submodule_prefix ?
232 superproject->submodule_prefix :
233 "", path);
235 out:
236 strbuf_release(&gitdir);
237 strbuf_release(&worktree);
238 return ret;
241 void repo_clear(struct repository *repo)
243 FREE_AND_NULL(repo->gitdir);
244 FREE_AND_NULL(repo->commondir);
245 FREE_AND_NULL(repo->graft_file);
246 FREE_AND_NULL(repo->index_file);
247 FREE_AND_NULL(repo->worktree);
248 FREE_AND_NULL(repo->submodule_prefix);
250 raw_object_store_clear(repo->objects);
251 FREE_AND_NULL(repo->objects);
253 parsed_object_pool_clear(repo->parsed_objects);
254 FREE_AND_NULL(repo->parsed_objects);
256 if (repo->config) {
257 git_configset_clear(repo->config);
258 FREE_AND_NULL(repo->config);
261 if (repo->submodule_cache) {
262 submodule_cache_free(repo->submodule_cache);
263 repo->submodule_cache = NULL;
266 if (repo->index) {
267 discard_index(repo->index);
268 if (repo->index != &the_index)
269 FREE_AND_NULL(repo->index);
272 if (repo->promisor_remote_config) {
273 promisor_remote_clear(repo->promisor_remote_config);
274 FREE_AND_NULL(repo->promisor_remote_config);
277 if (repo->remote_state) {
278 remote_state_clear(repo->remote_state);
279 FREE_AND_NULL(repo->remote_state);
283 int repo_read_index(struct repository *repo)
285 int res;
287 if (!repo->index)
288 CALLOC_ARRAY(repo->index, 1);
290 /* Complete the double-reference */
291 if (!repo->index->repo)
292 repo->index->repo = repo;
293 else if (repo->index->repo != repo)
294 BUG("repo's index should point back at itself");
296 res = read_index_from(repo->index, repo->index_file, repo->gitdir);
298 prepare_repo_settings(repo);
299 if (repo->settings.command_requires_full_index)
300 ensure_full_index(repo->index);
302 return res;
305 int repo_hold_locked_index(struct repository *repo,
306 struct lock_file *lf,
307 int flags)
309 if (!repo->index_file)
310 BUG("the repo hasn't been setup");
311 return hold_lock_file_for_update(lf, repo->index_file, flags);