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