Coverage Report

Created: 2024-09-08 06:23

/src/git/setup.h
Line
Count
Source (jump to first uncovered line)
1
#ifndef SETUP_H
2
#define SETUP_H
3
4
#include "refs.h"
5
#include "string-list.h"
6
7
int is_inside_git_dir(void);
8
int is_inside_work_tree(void);
9
int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
10
int get_common_dir(struct strbuf *sb, const char *gitdir);
11
12
/*
13
 * Return true if the given path is a git directory; note that this _just_
14
 * looks at the directory itself. If you want to know whether "foo/.git"
15
 * is a repository, you must feed that path, not just "foo".
16
 */
17
int is_git_directory(const char *path);
18
19
/*
20
 * Return 1 if the given path is the root of a git repository or
21
 * submodule, else 0. Will not return 1 for bare repositories with the
22
 * exception of creating a bare repository in "foo/.git" and calling
23
 * is_git_repository("foo").
24
 *
25
 * If we run into read errors, we err on the side of saying "yes, it is",
26
 * as we usually consider sub-repos precious, and would prefer to err on the
27
 * side of not disrupting or deleting them.
28
 */
29
int is_nonbare_repository_dir(struct strbuf *path);
30
31
0
#define READ_GITFILE_ERR_STAT_FAILED 1
32
0
#define READ_GITFILE_ERR_NOT_A_FILE 2
33
0
#define READ_GITFILE_ERR_OPEN_FAILED 3
34
0
#define READ_GITFILE_ERR_READ_FAILED 4
35
0
#define READ_GITFILE_ERR_INVALID_FORMAT 5
36
0
#define READ_GITFILE_ERR_NO_PATH 6
37
0
#define READ_GITFILE_ERR_NOT_A_REPO 7
38
0
#define READ_GITFILE_ERR_TOO_LARGE 8
39
void read_gitfile_error_die(int error_code, const char *path, const char *dir);
40
const char *read_gitfile_gently(const char *path, int *return_error_code);
41
0
#define read_gitfile(path) read_gitfile_gently((path), NULL)
42
const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
43
0
#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
44
45
/*
46
 * Check if a repository is safe and die if it is not, by verifying the
47
 * ownership of the worktree (if any), the git directory, and the gitfile (if
48
 * any).
49
 *
50
 * Exemptions for known-safe repositories can be added via `safe.directory`
51
 * config settings; for non-bare repositories, their worktree needs to be
52
 * added, for bare ones their git directory.
53
 */
54
void die_upon_dubious_ownership(const char *gitfile, const char *worktree,
55
        const char *gitdir);
56
57
void setup_work_tree(void);
58
59
/*
60
 * discover_git_directory_reason() is similar to discover_git_directory(),
61
 * except it returns an enum value instead. It is important to note that
62
 * a zero-valued return here is actually GIT_DIR_NONE, which is different
63
 * from discover_git_directory.
64
 */
65
enum discovery_result {
66
  GIT_DIR_EXPLICIT = 1,
67
  GIT_DIR_DISCOVERED = 2,
68
  GIT_DIR_BARE = 3,
69
  /* these are errors */
70
  GIT_DIR_HIT_CEILING = -1,
71
  GIT_DIR_HIT_MOUNT_POINT = -2,
72
  GIT_DIR_INVALID_GITFILE = -3,
73
  GIT_DIR_INVALID_OWNERSHIP = -4,
74
  GIT_DIR_DISALLOWED_BARE = -5,
75
  GIT_DIR_INVALID_FORMAT = -6,
76
  GIT_DIR_CWD_FAILURE = -7,
77
};
78
enum discovery_result discover_git_directory_reason(struct strbuf *commondir,
79
                struct strbuf *gitdir);
80
81
/*
82
 * Find the commondir and gitdir of the repository that contains the current
83
 * working directory, without changing the working directory or other global
84
 * state. The result is appended to commondir and gitdir.  If the discovered
85
 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
86
 * both have the same result appended to the buffer.  The return value is
87
 * either 0 upon success and -1 if no repository was found.
88
 */
89
static inline int discover_git_directory(struct strbuf *commondir,
90
           struct strbuf *gitdir)
91
0
{
92
0
  if (discover_git_directory_reason(commondir, gitdir) <= 0)
93
0
    return -1;
94
0
  return 0;
95
0
}
Unexecuted instantiation: blame.c:discover_git_directory
Unexecuted instantiation: bugreport.c:discover_git_directory
Unexecuted instantiation: bundle.c:discover_git_directory
Unexecuted instantiation: check-attr.c:discover_git_directory
Unexecuted instantiation: check-ref-format.c:discover_git_directory
Unexecuted instantiation: checkout-index.c:discover_git_directory
Unexecuted instantiation: checkout.c:discover_git_directory
Unexecuted instantiation: clean.c:discover_git_directory
Unexecuted instantiation: clone.c:discover_git_directory
Unexecuted instantiation: config.c:discover_git_directory
Unexecuted instantiation: describe.c:discover_git_directory
Unexecuted instantiation: diff-index.c:discover_git_directory
Unexecuted instantiation: diff.c:discover_git_directory
Unexecuted instantiation: difftool.c:discover_git_directory
Unexecuted instantiation: gc.c:discover_git_directory
Unexecuted instantiation: grep.c:discover_git_directory
Unexecuted instantiation: hash-object.c:discover_git_directory
Unexecuted instantiation: help.c:discover_git_directory
Unexecuted instantiation: index-pack.c:discover_git_directory
Unexecuted instantiation: init-db.c:discover_git_directory
Unexecuted instantiation: ls-files.c:discover_git_directory
Unexecuted instantiation: merge-file.c:discover_git_directory
Unexecuted instantiation: mv.c:discover_git_directory
Unexecuted instantiation: patch-id.c:discover_git_directory
Unexecuted instantiation: read-tree.c:discover_git_directory
Unexecuted instantiation: reset.c:discover_git_directory
Unexecuted instantiation: rev-parse.c:discover_git_directory
Unexecuted instantiation: rm.c:discover_git_directory
Unexecuted instantiation: shortlog.c:discover_git_directory
Unexecuted instantiation: sparse-checkout.c:discover_git_directory
Unexecuted instantiation: stash.c:discover_git_directory
Unexecuted instantiation: stripspace.c:discover_git_directory
Unexecuted instantiation: submodule--helper.c:discover_git_directory
Unexecuted instantiation: update-index.c:discover_git_directory
Unexecuted instantiation: git.c:discover_git_directory
Unexecuted instantiation: apply.c:discover_git_directory
Unexecuted instantiation: archive.c:discover_git_directory
Unexecuted instantiation: attr.c:discover_git_directory
Unexecuted instantiation: commit.c:discover_git_directory
Unexecuted instantiation: dir.c:discover_git_directory
Unexecuted instantiation: environment.c:discover_git_directory
Unexecuted instantiation: hook.c:discover_git_directory
Unexecuted instantiation: line-log.c:discover_git_directory
Unexecuted instantiation: mailmap.c:discover_git_directory
Unexecuted instantiation: object-file.c:discover_git_directory
Unexecuted instantiation: object-name.c:discover_git_directory
Unexecuted instantiation: parse-options-cb.c:discover_git_directory
Unexecuted instantiation: path.c:discover_git_directory
Unexecuted instantiation: pathspec.c:discover_git_directory
Unexecuted instantiation: refs.c:discover_git_directory
Unexecuted instantiation: files-backend.c:discover_git_directory
Unexecuted instantiation: reftable-backend.c:discover_git_directory
Unexecuted instantiation: remote.c:discover_git_directory
Unexecuted instantiation: repository.c:discover_git_directory
Unexecuted instantiation: revision.c:discover_git_directory
Unexecuted instantiation: setup.c:discover_git_directory
Unexecuted instantiation: submodule.c:discover_git_directory
Unexecuted instantiation: symlinks.c:discover_git_directory
Unexecuted instantiation: trace.c:discover_git_directory
Unexecuted instantiation: unpack-trees.c:discover_git_directory
Unexecuted instantiation: worktree.c:discover_git_directory
Unexecuted instantiation: wt-status.c:discover_git_directory
Unexecuted instantiation: common-main.c:discover_git_directory
96
97
const char *setup_git_directory_gently(int *);
98
const char *setup_git_directory(void);
99
char *prefix_path(const char *prefix, int len, const char *path);
100
char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
101
102
int check_filename(const char *prefix, const char *name);
103
void verify_filename(const char *prefix,
104
         const char *name,
105
         int diagnose_misspelt_rev);
106
void verify_non_filename(const char *prefix, const char *name);
107
int path_inside_repo(const char *prefix, const char *path);
108
109
void sanitize_stdfds(void);
110
int daemonize(void);
111
112
/*
113
 * GIT_REPO_VERSION is the version we write by default. The
114
 * _READ variant is the highest number we know how to
115
 * handle.
116
 */
117
0
#define GIT_REPO_VERSION 0
118
0
#define GIT_REPO_VERSION_READ 1
119
120
/*
121
 * You _have_ to initialize a `struct repository_format` using
122
 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
123
 */
124
struct repository_format {
125
  int version;
126
  int precious_objects;
127
  char *partial_clone; /* value of extensions.partialclone */
128
  int worktree_config;
129
  int is_bare;
130
  int hash_algo;
131
  int compat_hash_algo;
132
  enum ref_storage_format ref_storage_format;
133
  int sparse_index;
134
  char *work_tree;
135
  struct string_list unknown_extensions;
136
  struct string_list v1_only_extensions;
137
};
138
139
/*
140
 * Always use this to initialize a `struct repository_format`
141
 * to a well-defined, default state before calling
142
 * `read_repository()`.
143
 */
144
0
#define REPOSITORY_FORMAT_INIT \
145
0
{ \
146
0
  .version = -1, \
147
0
  .is_bare = -1, \
148
0
  .hash_algo = GIT_HASH_SHA1, \
149
0
  .ref_storage_format = REF_STORAGE_FORMAT_FILES, \
150
0
  .unknown_extensions = STRING_LIST_INIT_DUP, \
151
0
  .v1_only_extensions = STRING_LIST_INIT_DUP, \
152
0
}
153
154
/*
155
 * Read the repository format characteristics from the config file "path" into
156
 * "format" struct. Returns the numeric version. On error, or if no version is
157
 * found in the configuration, -1 is returned, format->version is set to -1,
158
 * and all other fields in the struct are set to the default configuration
159
 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
160
 * REPOSITORY_FORMAT_INIT before calling this function.
161
 */
162
int read_repository_format(struct repository_format *format, const char *path);
163
164
/*
165
 * Free the memory held onto by `format`, but not the struct itself.
166
 * (No need to use this after `read_repository_format()` fails.)
167
 */
168
void clear_repository_format(struct repository_format *format);
169
170
/*
171
 * Verify that the repository described by repository_format is something we
172
 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
173
 * any errors encountered.
174
 */
175
int verify_repository_format(const struct repository_format *format,
176
           struct strbuf *err);
177
178
/*
179
 * Check the repository format version in the path found in get_git_dir(),
180
 * and die if it is a version we don't understand. Generally one would
181
 * set_git_dir() before calling this, and use it only for "are we in a valid
182
 * repo?".
183
 *
184
 * If successful and fmt is not NULL, fill fmt with data.
185
 */
186
void check_repository_format(struct repository_format *fmt);
187
188
const char *get_template_dir(const char *option_template);
189
190
0
#define INIT_DB_QUIET      (1 << 0)
191
0
#define INIT_DB_EXIST_OK   (1 << 1)
192
0
#define INIT_DB_SKIP_REFDB (1 << 2)
193
194
int init_db(const char *git_dir, const char *real_git_dir,
195
      const char *template_dir, int hash_algo,
196
      enum ref_storage_format ref_storage_format,
197
      const char *initial_branch, int init_shared_repository,
198
      unsigned int flags);
199
void initialize_repository_version(int hash_algo,
200
           enum ref_storage_format ref_storage_format,
201
           int reinit);
202
void create_reference_database(enum ref_storage_format ref_storage_format,
203
             const char *initial_branch, int quiet);
204
205
/*
206
 * NOTE NOTE NOTE!!
207
 *
208
 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
209
 * not be changed. Old repositories have core.sharedrepository written in
210
 * numeric format, and therefore these values are preserved for compatibility
211
 * reasons.
212
 */
213
enum sharedrepo {
214
  PERM_UMASK          = 0,
215
  OLD_PERM_GROUP      = 1,
216
  OLD_PERM_EVERYBODY  = 2,
217
  PERM_GROUP          = 0660,
218
  PERM_EVERYBODY      = 0664
219
};
220
int git_config_perm(const char *var, const char *value);
221
222
struct startup_info {
223
  int have_repository;
224
  const char *prefix;
225
  const char *original_cwd;
226
};
227
extern struct startup_info *startup_info;
228
extern const char *tmp_original_cwd;
229
230
#endif /* SETUP_H */