repository.h

   1 #ifndef REPOSITORY_H
   2 #define REPOSITORY_H
   3
   4 #include "strmap.h"
   5
   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;
  16
  17 enum untracked_cache_setting {
  18         UNTRACKED_CACHE_KEEP,
  19         UNTRACKED_CACHE_REMOVE,
  20         UNTRACKED_CACHE_WRITE,
  21 };
  22
  23 enum fetch_negotiation_setting {
  24         FETCH_NEGOTIATION_CONSECUTIVE,
  25         FETCH_NEGOTIATION_SKIPPING,
  26         FETCH_NEGOTIATION_NOOP,
  27 };
  28
  29 enum ref_storage_format {
  30         REF_STORAGE_FORMAT_UNKNOWN,
  31         REF_STORAGE_FORMAT_FILES,
  32         REF_STORAGE_FORMAT_REFTABLE,
  33 };
  34
  35 struct repo_settings {
  36         int initialized;
  37
  38         int core_commit_graph;
  39         int commit_graph_generation_version;
  40         int commit_graph_read_changed_paths;
  41         int gc_write_commit_graph;
  42         int fetch_write_commit_graph;
  43         int command_requires_full_index;
  44         int sparse_index;
  45         int pack_read_reverse_index;
  46         int pack_use_bitmap_boundary_traversal;
  47         int pack_use_multi_pack_reuse;
  48
  49         /*
  50          * Does this repository have core.useReplaceRefs=true (on by
  51          * default)? This provides a repository-scoped version of this
  52          * config, though it could be disabled process-wide via some Git
  53          * builtins or the --no-replace-objects option. See
  54          * replace_refs_enabled() for more details.
  55          */
  56         int read_replace_refs;
  57
  58         struct fsmonitor_settings *fsmonitor; /* lazily loaded */
  59
  60         int index_version;
  61         int index_skip_hash;
  62         enum untracked_cache_setting core_untracked_cache;
  63
  64         int pack_use_sparse;
  65         enum fetch_negotiation_setting fetch_negotiation_algorithm;
  66
  67         int core_multi_pack_index;
  68 };
  69
  70 struct repo_path_cache {
  71         char *squash_msg;
  72         char *merge_msg;
  73         char *merge_rr;
  74         char *merge_mode;
  75         char *merge_head;
  76         char *fetch_head;
  77         char *shallow;
  78 };
  79
  80 struct repository {
  81         /* Environment */
  82         /*
  83          * Path to the git directory.
  84          * Cannot be NULL after initialization.
  85          */
  86         char *gitdir;
  87
  88         /*
  89          * Path to the common git directory.
  90          * Cannot be NULL after initialization.
  91          */
  92         char *commondir;
  93
  94         /*
  95          * Holds any information related to accessing the raw object content.
  96          */
  97         struct raw_object_store *objects;
  98
  99         /*
 100          * All objects in this repository that have been parsed. This structure
 101          * owns all objects it references, so users of "struct object *"
 102          * generally do not need to free them; instead, when a repository is no
 103          * longer used, call parsed_object_pool_clear() on this structure, which
 104          * is called by the repositories repo_clear on its desconstruction.
 105          */
 106         struct parsed_object_pool *parsed_objects;
 107
 108         /*
 109          * The store in which the refs are held. This should generally only be
 110          * accessed via get_main_ref_store(), as that will lazily initialize
 111          * the ref object.
 112          */
 113         struct ref_store *refs_private;
 114
 115         /*
 116          * A strmap of ref_stores, stored by submodule name, accessible via
 117          * `repo_get_submodule_ref_store()`.
 118          */
 119         struct strmap submodule_ref_stores;
 120
 121         /*
 122          * A strmap of ref_stores, stored by worktree id, accessible via
 123          * `get_worktree_ref_store()`.
 124          */
 125         struct strmap worktree_ref_stores;
 126
 127         /*
 128          * Contains path to often used file names.
 129          */
 130         struct repo_path_cache cached_paths;
 131
 132         /*
 133          * Path to the repository's graft file.
 134          * Cannot be NULL after initialization.
 135          */
 136         char *graft_file;
 137
 138         /*
 139          * Path to the current worktree's index file.
 140          * Cannot be NULL after initialization.
 141          */
 142         char *index_file;
 143
 144         /*
 145          * Path to the working directory.
 146          * A NULL value indicates that there is no working directory.
 147          */
 148         char *worktree;
 149
 150         /*
 151          * Path from the root of the top-level superproject down to this
 152          * repository.  This is only non-NULL if the repository is initialized
 153          * as a submodule of another repository.
 154          */
 155         char *submodule_prefix;
 156
 157         struct repo_settings settings;
 158
 159         /* Subsystems */
 160         /*
 161          * Repository's config which contains key-value pairs from the usual
 162          * set of config files (i.e. repo specific .git/config, user wide
 163          * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
 164          */
 165         struct config_set *config;
 166
 167         /* Repository's submodule config as defined by '.gitmodules' */
 168         struct submodule_cache *submodule_cache;
 169
 170         /*
 171          * Repository's in-memory index.
 172          * 'repo_read_index()' can be used to populate 'index'.
 173          */
 174         struct index_state *index;
 175
 176         /* Repository's remotes and associated structures. */
 177         struct remote_state *remote_state;
 178
 179         /* Repository's current hash algorithm, as serialized on disk. */
 180         const struct git_hash_algo *hash_algo;
 181
 182         /* Repository's compatibility hash algorithm. */
 183         const struct git_hash_algo *compat_hash_algo;
 184
 185         /* Repository's reference storage format, as serialized on disk. */
 186         enum ref_storage_format ref_storage_format;
 187
 188         /* A unique-id for tracing purposes. */
 189         int trace2_repo_id;
 190
 191         /* True if commit-graph has been disabled within this process. */
 192         int commit_graph_disabled;
 193
 194         /* Configurations related to promisor remotes. */
 195         char *repository_format_partial_clone;
 196         struct promisor_remote_config *promisor_remote_config;
 197
 198         /* Configurations */
 199         int repository_format_worktree_config;
 200
 201         /* Indicate if a repository has a different 'commondir' from 'gitdir' */
 202         unsigned different_commondir:1;
 203 };
 204
 205 #ifdef USE_THE_REPOSITORY_VARIABLE
 206 extern struct repository *the_repository;
 207 #endif
 208
 209 /*
 210  * Define a custom repository layout. Any field can be NULL, which
 211  * will default back to the path according to the default layout.
 212  */
 213 struct set_gitdir_args {
 214         const char *commondir;
 215         const char *object_dir;
 216         const char *graft_file;
 217         const char *index_file;
 218         const char *alternate_db;
 219         int disable_ref_updates;
 220 };
 221
 222 void repo_set_gitdir(struct repository *repo, const char *root,
 223                      const struct set_gitdir_args *extra_args);
 224 void repo_set_worktree(struct repository *repo, const char *path);
 225 void repo_set_hash_algo(struct repository *repo, int algo);
 226 void repo_set_compat_hash_algo(struct repository *repo, int compat_algo);
 227 void repo_set_ref_storage_format(struct repository *repo,
 228                                  enum ref_storage_format format);
 229 void initialize_repository(struct repository *repo);
 230 RESULT_MUST_BE_USED
 231 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
 232
 233 /*
 234  * Initialize the repository 'subrepo' as the submodule at the given path. If
 235  * the submodule's gitdir cannot be found at <path>/.git, this function calls
 236  * submodule_from_path() to try to find it. treeish_name is only used if
 237  * submodule_from_path() needs to be called; see its documentation for more
 238  * information.
 239  * Return 0 upon success and a non-zero value upon failure.
 240  */
 241 struct object_id;
 242 RESULT_MUST_BE_USED
 243 int repo_submodule_init(struct repository *subrepo,
 244                         struct repository *superproject,
 245                         const char *path,
 246                         const struct object_id *treeish_name);
 247 void repo_clear(struct repository *repo);
 248
 249 /*
 250  * Populates the repository's index from its index_file, an index struct will
 251  * be allocated if needed.
 252  *
 253  * Return the number of index entries in the populated index or a value less
 254  * than zero if an error occurred.  If the repository's index has already been
 255  * populated then the number of entries will simply be returned.
 256  */
 257 int repo_read_index(struct repository *repo);
 258 int repo_hold_locked_index(struct repository *repo,
 259                            struct lock_file *lf,
 260                            int flags);
 261
 262 int repo_read_index_unmerged(struct repository *);
 263 /*
 264  * Opportunistically update the index but do not complain if we can't.
 265  * The lockfile is always committed or rolled back.
 266  */
 267 void repo_update_index_if_able(struct repository *, struct lock_file *);
 268
 269 void prepare_repo_settings(struct repository *r);
 270
 271 /*
 272  * Return 1 if upgrade repository format to target_version succeeded,
 273  * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
 274  */
 275 int upgrade_repository_format(int target_version);
 276
 277 #endif /* REPOSITORY_H */