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