fetch-pack: add tracing for negotiation rounds
[git.git] / repository.h
blob797f471cce9a5501ead146933d71f33bd45827e4
1 #ifndef REPOSITORY_H
2 #define REPOSITORY_H
4 #include "path.h"
6 struct config_set;
7 struct fsmonitor_settings;
8 struct git_hash_algo;
9 struct index_state;
10 struct lock_file;
11 struct pathspec;
12 struct raw_object_store;
13 struct submodule_cache;
14 struct promisor_remote_config;
15 struct remote_state;
17 enum untracked_cache_setting {
18 UNTRACKED_CACHE_KEEP,
19 UNTRACKED_CACHE_REMOVE,
20 UNTRACKED_CACHE_WRITE,
23 enum fetch_negotiation_setting {
24 FETCH_NEGOTIATION_CONSECUTIVE,
25 FETCH_NEGOTIATION_SKIPPING,
26 FETCH_NEGOTIATION_NOOP,
29 struct repo_settings {
30 int initialized;
32 int core_commit_graph;
33 int commit_graph_generation_version;
34 int commit_graph_read_changed_paths;
35 int gc_write_commit_graph;
36 int fetch_write_commit_graph;
37 int command_requires_full_index;
38 int sparse_index;
40 struct fsmonitor_settings *fsmonitor; /* lazily loaded */
42 int index_version;
43 enum untracked_cache_setting core_untracked_cache;
45 int pack_use_sparse;
46 enum fetch_negotiation_setting fetch_negotiation_algorithm;
48 int core_multi_pack_index;
51 struct repo_path_cache {
52 char *squash_msg;
53 char *merge_msg;
54 char *merge_rr;
55 char *merge_mode;
56 char *merge_head;
57 char *merge_autostash;
58 char *auto_merge;
59 char *fetch_head;
60 char *shallow;
63 struct repository {
64 /* Environment */
66 * Path to the git directory.
67 * Cannot be NULL after initialization.
69 char *gitdir;
72 * Path to the common git directory.
73 * Cannot be NULL after initialization.
75 char *commondir;
78 * Holds any information related to accessing the raw object content.
80 struct raw_object_store *objects;
83 * All objects in this repository that have been parsed. This structure
84 * owns all objects it references, so users of "struct object *"
85 * generally do not need to free them; instead, when a repository is no
86 * longer used, call parsed_object_pool_clear() on this structure, which
87 * is called by the repositories repo_clear on its desconstruction.
89 struct parsed_object_pool *parsed_objects;
92 * The store in which the refs are held. This should generally only be
93 * accessed via get_main_ref_store(), as that will lazily initialize
94 * the ref object.
96 struct ref_store *refs_private;
99 * Contains path to often used file names.
101 struct repo_path_cache cached_paths;
104 * Path to the repository's graft file.
105 * Cannot be NULL after initialization.
107 char *graft_file;
110 * Path to the current worktree's index file.
111 * Cannot be NULL after initialization.
113 char *index_file;
116 * Path to the working directory.
117 * A NULL value indicates that there is no working directory.
119 char *worktree;
122 * Path from the root of the top-level superproject down to this
123 * repository. This is only non-NULL if the repository is initialized
124 * as a submodule of another repository.
126 char *submodule_prefix;
128 struct repo_settings settings;
130 /* Subsystems */
132 * Repository's config which contains key-value pairs from the usual
133 * set of config files (i.e. repo specific .git/config, user wide
134 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
136 struct config_set *config;
138 /* Repository's submodule config as defined by '.gitmodules' */
139 struct submodule_cache *submodule_cache;
142 * Repository's in-memory index.
143 * 'repo_read_index()' can be used to populate 'index'.
145 struct index_state *index;
147 /* Repository's remotes and associated structures. */
148 struct remote_state *remote_state;
150 /* Repository's current hash algorithm, as serialized on disk. */
151 const struct git_hash_algo *hash_algo;
153 /* A unique-id for tracing purposes. */
154 int trace2_repo_id;
156 /* True if commit-graph has been disabled within this process. */
157 int commit_graph_disabled;
159 /* Configurations related to promisor remotes. */
160 char *repository_format_partial_clone;
161 struct promisor_remote_config *promisor_remote_config;
163 /* Configurations */
165 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
166 unsigned different_commondir:1;
169 extern struct repository *the_repository;
172 * Define a custom repository layout. Any field can be NULL, which
173 * will default back to the path according to the default layout.
175 struct set_gitdir_args {
176 const char *commondir;
177 const char *object_dir;
178 const char *graft_file;
179 const char *index_file;
180 const char *alternate_db;
181 int disable_ref_updates;
184 void repo_set_gitdir(struct repository *repo, const char *root,
185 const struct set_gitdir_args *extra_args);
186 void repo_set_worktree(struct repository *repo, const char *path);
187 void repo_set_hash_algo(struct repository *repo, int algo);
188 void initialize_the_repository(void);
189 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
192 * Initialize the repository 'subrepo' as the submodule at the given path. If
193 * the submodule's gitdir cannot be found at <path>/.git, this function calls
194 * submodule_from_path() to try to find it. treeish_name is only used if
195 * submodule_from_path() needs to be called; see its documentation for more
196 * information.
197 * Return 0 upon success and a non-zero value upon failure.
199 struct object_id;
200 int repo_submodule_init(struct repository *subrepo,
201 struct repository *superproject,
202 const char *path,
203 const struct object_id *treeish_name);
204 void repo_clear(struct repository *repo);
207 * Populates the repository's index from its index_file, an index struct will
208 * be allocated if needed.
210 * Return the number of index entries in the populated index or a value less
211 * than zero if an error occurred. If the repository's index has already been
212 * populated then the number of entries will simply be returned.
214 int repo_read_index(struct repository *repo);
215 int repo_hold_locked_index(struct repository *repo,
216 struct lock_file *lf,
217 int flags);
219 int repo_read_index_preload(struct repository *,
220 const struct pathspec *pathspec,
221 unsigned refresh_flags);
222 int repo_read_index_unmerged(struct repository *);
224 * Opportunistically update the index but do not complain if we can't.
225 * The lockfile is always committed or rolled back.
227 void repo_update_index_if_able(struct repository *, struct lock_file *);
229 void prepare_repo_settings(struct repository *r);
232 * Return 1 if upgrade repository format to target_version succeeded,
233 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
235 int upgrade_repository_format(int target_version);
237 #endif /* REPOSITORY_H */