]> git.ipfire.org Git - thirdparty/git.git/blob - repository.h
reftable: read reftable files
[thirdparty/git.git] / repository.h
1 #ifndef REPOSITORY_H
2 #define REPOSITORY_H
3
4 #include "path.h"
5
6 struct config_set;
7 struct git_hash_algo;
8 struct index_state;
9 struct lock_file;
10 struct pathspec;
11 struct raw_object_store;
12 struct submodule_cache;
13 struct promisor_remote_config;
14
15 enum untracked_cache_setting {
16 UNTRACKED_CACHE_UNSET = -1,
17 UNTRACKED_CACHE_REMOVE = 0,
18 UNTRACKED_CACHE_KEEP = 1,
19 UNTRACKED_CACHE_WRITE = 2
20 };
21
22 enum fetch_negotiation_setting {
23 FETCH_NEGOTIATION_UNSET = -1,
24 FETCH_NEGOTIATION_NONE = 0,
25 FETCH_NEGOTIATION_DEFAULT = 1,
26 FETCH_NEGOTIATION_SKIPPING = 2,
27 FETCH_NEGOTIATION_NOOP = 3,
28 };
29
30 struct repo_settings {
31 int initialized;
32
33 int core_commit_graph;
34 int commit_graph_read_changed_paths;
35 int gc_write_commit_graph;
36 int fetch_write_commit_graph;
37
38 int index_version;
39 enum untracked_cache_setting core_untracked_cache;
40
41 int pack_use_sparse;
42 enum fetch_negotiation_setting fetch_negotiation_algorithm;
43
44 int core_multi_pack_index;
45
46 unsigned command_requires_full_index:1,
47 sparse_index:1;
48 };
49
50 struct repository {
51 /* Environment */
52 /*
53 * Path to the git directory.
54 * Cannot be NULL after initialization.
55 */
56 char *gitdir;
57
58 /*
59 * Path to the common git directory.
60 * Cannot be NULL after initialization.
61 */
62 char *commondir;
63
64 /*
65 * Holds any information related to accessing the raw object content.
66 */
67 struct raw_object_store *objects;
68
69 /*
70 * All objects in this repository that have been parsed. This structure
71 * owns all objects it references, so users of "struct object *"
72 * generally do not need to free them; instead, when a repository is no
73 * longer used, call parsed_object_pool_clear() on this structure, which
74 * is called by the repositories repo_clear on its desconstruction.
75 */
76 struct parsed_object_pool *parsed_objects;
77
78 /*
79 * The store in which the refs are held. This should generally only be
80 * accessed via get_main_ref_store(), as that will lazily initialize
81 * the ref object.
82 */
83 struct ref_store *refs_private;
84
85 /*
86 * Contains path to often used file names.
87 */
88 struct path_cache cached_paths;
89
90 /*
91 * Path to the repository's graft file.
92 * Cannot be NULL after initialization.
93 */
94 char *graft_file;
95
96 /*
97 * Path to the current worktree's index file.
98 * Cannot be NULL after initialization.
99 */
100 char *index_file;
101
102 /*
103 * Path to the working directory.
104 * A NULL value indicates that there is no working directory.
105 */
106 char *worktree;
107
108 /*
109 * Path from the root of the top-level superproject down to this
110 * repository. This is only non-NULL if the repository is initialized
111 * as a submodule of another repository.
112 */
113 char *submodule_prefix;
114
115 struct repo_settings settings;
116
117 /* Subsystems */
118 /*
119 * Repository's config which contains key-value pairs from the usual
120 * set of config files (i.e. repo specific .git/config, user wide
121 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
122 */
123 struct config_set *config;
124
125 /* Repository's submodule config as defined by '.gitmodules' */
126 struct submodule_cache *submodule_cache;
127
128 /*
129 * Repository's in-memory index.
130 * 'repo_read_index()' can be used to populate 'index'.
131 */
132 struct index_state *index;
133
134 /* Repository's current hash algorithm, as serialized on disk. */
135 const struct git_hash_algo *hash_algo;
136
137 /* A unique-id for tracing purposes. */
138 int trace2_repo_id;
139
140 /* True if commit-graph has been disabled within this process. */
141 int commit_graph_disabled;
142
143 /* Configurations related to promisor remotes. */
144 char *repository_format_partial_clone;
145 struct promisor_remote_config *promisor_remote_config;
146
147 /* Configurations */
148
149 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
150 unsigned different_commondir:1;
151 };
152
153 extern struct repository *the_repository;
154
155 /*
156 * Define a custom repository layout. Any field can be NULL, which
157 * will default back to the path according to the default layout.
158 */
159 struct set_gitdir_args {
160 const char *commondir;
161 const char *object_dir;
162 const char *graft_file;
163 const char *index_file;
164 const char *alternate_db;
165 };
166
167 void repo_set_gitdir(struct repository *repo, const char *root,
168 const struct set_gitdir_args *extra_args);
169 void repo_set_worktree(struct repository *repo, const char *path);
170 void repo_set_hash_algo(struct repository *repo, int algo);
171 void initialize_the_repository(void);
172 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
173
174 /*
175 * Initialize the repository 'subrepo' as the submodule given by the
176 * struct submodule 'sub' in parent repository 'superproject'.
177 * Return 0 upon success and a non-zero value upon failure, which may happen
178 * if the submodule is not found, or 'sub' is NULL.
179 */
180 struct submodule;
181 int repo_submodule_init(struct repository *subrepo,
182 struct repository *superproject,
183 const struct submodule *sub);
184 void repo_clear(struct repository *repo);
185
186 /*
187 * Populates the repository's index from its index_file, an index struct will
188 * be allocated if needed.
189 *
190 * Return the number of index entries in the populated index or a value less
191 * than zero if an error occurred. If the repository's index has already been
192 * populated then the number of entries will simply be returned.
193 */
194 int repo_read_index(struct repository *repo);
195 int repo_hold_locked_index(struct repository *repo,
196 struct lock_file *lf,
197 int flags);
198
199 int repo_read_index_preload(struct repository *,
200 const struct pathspec *pathspec,
201 unsigned refresh_flags);
202 int repo_read_index_unmerged(struct repository *);
203 /*
204 * Opportunistically update the index but do not complain if we can't.
205 * The lockfile is always committed or rolled back.
206 */
207 void repo_update_index_if_able(struct repository *, struct lock_file *);
208
209 void prepare_repo_settings(struct repository *r);
210
211 /*
212 * Return 1 if upgrade repository format to target_version succeeded,
213 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
214 */
215 int upgrade_repository_format(int target_version);
216
217 #endif /* REPOSITORY_H */