repository.h

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