repository.h

   1 #ifndef REPOSITORY_H
   2 #define REPOSITORY_H
   3
   4 #include "git-compat-util.h"
   5 #include "path.h"
   6
   7 struct config_set;
   8 struct fsmonitor_settings;
   9 struct git_hash_algo;
  10 struct index_state;
  11 struct lock_file;
  12 struct pathspec;
  13 struct raw_object_store;
  14 struct submodule_cache;
  15 struct promisor_remote_config;
  16 struct remote_state;
  17
  18 enum untracked_cache_setting {
  19         UNTRACKED_CACHE_KEEP,
  20         UNTRACKED_CACHE_REMOVE,
  21         UNTRACKED_CACHE_WRITE,
  22 };
  23
  24 enum fetch_negotiation_setting {
  25         FETCH_NEGOTIATION_CONSECUTIVE,
  26         FETCH_NEGOTIATION_SKIPPING,
  27         FETCH_NEGOTIATION_NOOP,
  28 };
  29
  30 struct repo_settings {
  31         int initialized;
  32
  33         int core_commit_graph;
  34         int commit_graph_generation_version;
  35         int commit_graph_read_changed_paths;
  36         int gc_write_commit_graph;
  37         int gc_cruft_packs;
  38         int fetch_write_commit_graph;
  39         int command_requires_full_index;
  40         int sparse_index;
  41
  42         struct fsmonitor_settings *fsmonitor; /* lazily loaded */
  43
  44         int index_version;
  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
 167         /* Indicate if a repository has a different 'commondir' from 'gitdir' */
 168         unsigned different_commondir:1;
 169 };
 170
 171 extern struct repository *the_repository;
 172
 173 /*
 174  * Define a custom repository layout. Any field can be NULL, which
 175  * will default back to the path according to the default layout.
 176  */
 177 struct set_gitdir_args {
 178         const char *commondir;
 179         const char *object_dir;
 180         const char *graft_file;
 181         const char *index_file;
 182         const char *alternate_db;
 183         int disable_ref_updates;
 184 };
 185
 186 void repo_set_gitdir(struct repository *repo, const char *root,
 187                      const struct set_gitdir_args *extra_args);
 188 void repo_set_worktree(struct repository *repo, const char *path);
 189 void repo_set_hash_algo(struct repository *repo, int algo);
 190 void initialize_the_repository(void);
 191 RESULT_MUST_BE_USED
 192 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
 193
 194 /*
 195  * Initialize the repository 'subrepo' as the submodule at the given path. If
 196  * the submodule's gitdir cannot be found at <path>/.git, this function calls
 197  * submodule_from_path() to try to find it. treeish_name is only used if
 198  * submodule_from_path() needs to be called; see its documentation for more
 199  * information.
 200  * Return 0 upon success and a non-zero value upon failure.
 201  */
 202 struct object_id;
 203 RESULT_MUST_BE_USED
 204 int repo_submodule_init(struct repository *subrepo,
 205                         struct repository *superproject,
 206                         const char *path,
 207                         const struct object_id *treeish_name);
 208 void repo_clear(struct repository *repo);
 209
 210 /*
 211  * Populates the repository's index from its index_file, an index struct will
 212  * be allocated if needed.
 213  *
 214  * Return the number of index entries in the populated index or a value less
 215  * than zero if an error occurred.  If the repository's index has already been
 216  * populated then the number of entries will simply be returned.
 217  */
 218 int repo_read_index(struct repository *repo);
 219 int repo_hold_locked_index(struct repository *repo,
 220                            struct lock_file *lf,
 221                            int flags);
 222
 223 int repo_read_index_preload(struct repository *,
 224                             const struct pathspec *pathspec,
 225                             unsigned refresh_flags);
 226 int repo_read_index_unmerged(struct repository *);
 227 /*
 228  * Opportunistically update the index but do not complain if we can't.
 229  * The lockfile is always committed or rolled back.
 230  */
 231 void repo_update_index_if_able(struct repository *, struct lock_file *);
 232
 233 void prepare_repo_settings(struct repository *r);
 234
 235 /*
 236  * Return 1 if upgrade repository format to target_version succeeded,
 237  * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
 238  */
 239 int upgrade_repository_format(int target_version);
 240
 241 #endif /* REPOSITORY_H */