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