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