repository.h

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