repository.h

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