Merge branch 'nd/conditional-config-include'
[git/git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
10 #include "trace.h"
11 #include "string-list.h"
12 #include "pack-revindex.h"
13 #include "hash.h"
14
15 #ifndef platform_SHA_CTX
16 /*
17 * platform's underlying implementation of SHA-1; could be OpenSSL,
18 * blk_SHA, Apple CommonCrypto, etc... Note that including
19 * SHA1_HEADER may have already defined platform_SHA_CTX for our
20 * own implementations like block-sha1 and ppc-sha1, so we list
21 * the default for OpenSSL compatible SHA-1 implementations here.
22 */
23 #define platform_SHA_CTX SHA_CTX
24 #define platform_SHA1_Init SHA1_Init
25 #define platform_SHA1_Update SHA1_Update
26 #define platform_SHA1_Final SHA1_Final
27 #endif
28
29 #define git_SHA_CTX platform_SHA_CTX
30 #define git_SHA1_Init platform_SHA1_Init
31 #define git_SHA1_Update platform_SHA1_Update
32 #define git_SHA1_Final platform_SHA1_Final
33
34 #ifdef SHA1_MAX_BLOCK_SIZE
35 #include "compat/sha1-chunked.h"
36 #undef git_SHA1_Update
37 #define git_SHA1_Update git_SHA1_Update_Chunked
38 #endif
39
40 #include <zlib.h>
41 typedef struct git_zstream {
42 z_stream z;
43 unsigned long avail_in;
44 unsigned long avail_out;
45 unsigned long total_in;
46 unsigned long total_out;
47 unsigned char *next_in;
48 unsigned char *next_out;
49 } git_zstream;
50
51 void git_inflate_init(git_zstream *);
52 void git_inflate_init_gzip_only(git_zstream *);
53 void git_inflate_end(git_zstream *);
54 int git_inflate(git_zstream *, int flush);
55
56 void git_deflate_init(git_zstream *, int level);
57 void git_deflate_init_gzip(git_zstream *, int level);
58 void git_deflate_init_raw(git_zstream *, int level);
59 void git_deflate_end(git_zstream *);
60 int git_deflate_abort(git_zstream *);
61 int git_deflate_end_gently(git_zstream *);
62 int git_deflate(git_zstream *, int flush);
63 unsigned long git_deflate_bound(git_zstream *, unsigned long);
64
65 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
66 #define GIT_SHA1_RAWSZ 20
67 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
68
69 /* The length in byte and in hex digits of the largest possible hash value. */
70 #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
71 #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
72
73 struct object_id {
74 unsigned char hash[GIT_MAX_RAWSZ];
75 };
76
77 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
78 #define DTYPE(de) ((de)->d_type)
79 #else
80 #undef DT_UNKNOWN
81 #undef DT_DIR
82 #undef DT_REG
83 #undef DT_LNK
84 #define DT_UNKNOWN 0
85 #define DT_DIR 1
86 #define DT_REG 2
87 #define DT_LNK 3
88 #define DTYPE(de) DT_UNKNOWN
89 #endif
90
91 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
92 #define S_IFINVALID 0030000
93
94 /*
95 * A "directory link" is a link to another git directory.
96 *
97 * The value 0160000 is not normally a valid mode, and
98 * also just happens to be S_IFDIR + S_IFLNK
99 */
100 #define S_IFGITLINK 0160000
101 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
102
103 /*
104 * Some mode bits are also used internally for computations.
105 *
106 * They *must* not overlap with any valid modes, and they *must* not be emitted
107 * to outside world - i.e. appear on disk or network. In other words, it's just
108 * temporary fields, which we internally use, but they have to stay in-house.
109 *
110 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
111 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
112 */
113
114 /* used internally in tree-diff */
115 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
116
117
118 /*
119 * Intensive research over the course of many years has shown that
120 * port 9418 is totally unused by anything else. Or
121 *
122 * Your search - "port 9418" - did not match any documents.
123 *
124 * as www.google.com puts it.
125 *
126 * This port has been properly assigned for git use by IANA:
127 * git (Assigned-9418) [I06-050728-0001].
128 *
129 * git 9418/tcp git pack transfer service
130 * git 9418/udp git pack transfer service
131 *
132 * with Linus Torvalds <torvalds@osdl.org> as the point of
133 * contact. September 2005.
134 *
135 * See http://www.iana.org/assignments/port-numbers
136 */
137 #define DEFAULT_GIT_PORT 9418
138
139 /*
140 * Basic data structures for the directory cache
141 */
142
143 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
144 struct cache_header {
145 uint32_t hdr_signature;
146 uint32_t hdr_version;
147 uint32_t hdr_entries;
148 };
149
150 #define INDEX_FORMAT_LB 2
151 #define INDEX_FORMAT_UB 4
152
153 /*
154 * The "cache_time" is just the low 32 bits of the
155 * time. It doesn't matter if it overflows - we only
156 * check it for equality in the 32 bits we save.
157 */
158 struct cache_time {
159 uint32_t sec;
160 uint32_t nsec;
161 };
162
163 struct stat_data {
164 struct cache_time sd_ctime;
165 struct cache_time sd_mtime;
166 unsigned int sd_dev;
167 unsigned int sd_ino;
168 unsigned int sd_uid;
169 unsigned int sd_gid;
170 unsigned int sd_size;
171 };
172
173 struct cache_entry {
174 struct hashmap_entry ent;
175 struct stat_data ce_stat_data;
176 unsigned int ce_mode;
177 unsigned int ce_flags;
178 unsigned int ce_namelen;
179 unsigned int index; /* for link extension */
180 struct object_id oid;
181 char name[FLEX_ARRAY]; /* more */
182 };
183
184 #define CE_STAGEMASK (0x3000)
185 #define CE_EXTENDED (0x4000)
186 #define CE_VALID (0x8000)
187 #define CE_STAGESHIFT 12
188
189 /*
190 * Range 0xFFFF0FFF in ce_flags is divided into
191 * two parts: in-memory flags and on-disk ones.
192 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
193 * if you want to save a new flag, add it in
194 * CE_EXTENDED_FLAGS
195 *
196 * In-memory only flags
197 */
198 #define CE_UPDATE (1 << 16)
199 #define CE_REMOVE (1 << 17)
200 #define CE_UPTODATE (1 << 18)
201 #define CE_ADDED (1 << 19)
202
203 #define CE_HASHED (1 << 20)
204 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
205 #define CE_CONFLICTED (1 << 23)
206
207 #define CE_UNPACKED (1 << 24)
208 #define CE_NEW_SKIP_WORKTREE (1 << 25)
209
210 /* used to temporarily mark paths matched by pathspecs */
211 #define CE_MATCHED (1 << 26)
212
213 #define CE_UPDATE_IN_BASE (1 << 27)
214 #define CE_STRIP_NAME (1 << 28)
215
216 /*
217 * Extended on-disk flags
218 */
219 #define CE_INTENT_TO_ADD (1 << 29)
220 #define CE_SKIP_WORKTREE (1 << 30)
221 /* CE_EXTENDED2 is for future extension */
222 #define CE_EXTENDED2 (1U << 31)
223
224 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
225
226 /*
227 * Safeguard to avoid saving wrong flags:
228 * - CE_EXTENDED2 won't get saved until its semantic is known
229 * - Bits in 0x0000FFFF have been saved in ce_flags already
230 * - Bits in 0x003F0000 are currently in-memory flags
231 */
232 #if CE_EXTENDED_FLAGS & 0x803FFFFF
233 #error "CE_EXTENDED_FLAGS out of range"
234 #endif
235
236 /* Forward structure decls */
237 struct pathspec;
238 struct child_process;
239
240 /*
241 * Copy the sha1 and stat state of a cache entry from one to
242 * another. But we never change the name, or the hash state!
243 */
244 static inline void copy_cache_entry(struct cache_entry *dst,
245 const struct cache_entry *src)
246 {
247 unsigned int state = dst->ce_flags & CE_HASHED;
248
249 /* Don't copy hash chain and name */
250 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
251 offsetof(struct cache_entry, name) -
252 offsetof(struct cache_entry, ce_stat_data));
253
254 /* Restore the hash state */
255 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
256 }
257
258 static inline unsigned create_ce_flags(unsigned stage)
259 {
260 return (stage << CE_STAGESHIFT);
261 }
262
263 #define ce_namelen(ce) ((ce)->ce_namelen)
264 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
265 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
266 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
267 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
268 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
269 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
270
271 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
272 static inline unsigned int create_ce_mode(unsigned int mode)
273 {
274 if (S_ISLNK(mode))
275 return S_IFLNK;
276 if (S_ISDIR(mode) || S_ISGITLINK(mode))
277 return S_IFGITLINK;
278 return S_IFREG | ce_permissions(mode);
279 }
280 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
281 unsigned int mode)
282 {
283 extern int trust_executable_bit, has_symlinks;
284 if (!has_symlinks && S_ISREG(mode) &&
285 ce && S_ISLNK(ce->ce_mode))
286 return ce->ce_mode;
287 if (!trust_executable_bit && S_ISREG(mode)) {
288 if (ce && S_ISREG(ce->ce_mode))
289 return ce->ce_mode;
290 return create_ce_mode(0666);
291 }
292 return create_ce_mode(mode);
293 }
294 static inline int ce_to_dtype(const struct cache_entry *ce)
295 {
296 unsigned ce_mode = ntohl(ce->ce_mode);
297 if (S_ISREG(ce_mode))
298 return DT_REG;
299 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
300 return DT_DIR;
301 else if (S_ISLNK(ce_mode))
302 return DT_LNK;
303 else
304 return DT_UNKNOWN;
305 }
306 static inline unsigned int canon_mode(unsigned int mode)
307 {
308 if (S_ISREG(mode))
309 return S_IFREG | ce_permissions(mode);
310 if (S_ISLNK(mode))
311 return S_IFLNK;
312 if (S_ISDIR(mode))
313 return S_IFDIR;
314 return S_IFGITLINK;
315 }
316
317 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
318
319 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
320 #define CE_ENTRY_CHANGED (1 << 1)
321 #define CE_ENTRY_REMOVED (1 << 2)
322 #define CE_ENTRY_ADDED (1 << 3)
323 #define RESOLVE_UNDO_CHANGED (1 << 4)
324 #define CACHE_TREE_CHANGED (1 << 5)
325 #define SPLIT_INDEX_ORDERED (1 << 6)
326 #define UNTRACKED_CHANGED (1 << 7)
327
328 struct split_index;
329 struct untracked_cache;
330
331 struct index_state {
332 struct cache_entry **cache;
333 unsigned int version;
334 unsigned int cache_nr, cache_alloc, cache_changed;
335 struct string_list *resolve_undo;
336 struct cache_tree *cache_tree;
337 struct split_index *split_index;
338 struct cache_time timestamp;
339 unsigned name_hash_initialized : 1,
340 initialized : 1;
341 struct hashmap name_hash;
342 struct hashmap dir_hash;
343 unsigned char sha1[20];
344 struct untracked_cache *untracked;
345 };
346
347 extern struct index_state the_index;
348
349 /* Name hashing */
350 extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
351 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
352 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
353 extern void free_name_hash(struct index_state *istate);
354
355
356 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
357 #define active_cache (the_index.cache)
358 #define active_nr (the_index.cache_nr)
359 #define active_alloc (the_index.cache_alloc)
360 #define active_cache_changed (the_index.cache_changed)
361 #define active_cache_tree (the_index.cache_tree)
362
363 #define read_cache() read_index(&the_index)
364 #define read_cache_from(path) read_index_from(&the_index, (path))
365 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
366 #define is_cache_unborn() is_index_unborn(&the_index)
367 #define read_cache_unmerged() read_index_unmerged(&the_index)
368 #define discard_cache() discard_index(&the_index)
369 #define unmerged_cache() unmerged_index(&the_index)
370 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
371 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
372 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
373 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
374 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
375 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
376 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
377 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
378 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
379 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
380 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
381 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
382 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
383 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
384 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
385 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
386 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
387 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
388 #endif
389
390 enum object_type {
391 OBJ_BAD = -1,
392 OBJ_NONE = 0,
393 OBJ_COMMIT = 1,
394 OBJ_TREE = 2,
395 OBJ_BLOB = 3,
396 OBJ_TAG = 4,
397 /* 5 for future expansion */
398 OBJ_OFS_DELTA = 6,
399 OBJ_REF_DELTA = 7,
400 OBJ_ANY,
401 OBJ_MAX
402 };
403
404 static inline enum object_type object_type(unsigned int mode)
405 {
406 return S_ISDIR(mode) ? OBJ_TREE :
407 S_ISGITLINK(mode) ? OBJ_COMMIT :
408 OBJ_BLOB;
409 }
410
411 /* Double-check local_repo_env below if you add to this list. */
412 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
413 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
414 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
415 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
416 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
417 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
418 #define GIT_TOPLEVEL_PREFIX_ENVIRONMENT "GIT_INTERNAL_TOPLEVEL_PREFIX"
419 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
420 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
421 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
422 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
423 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
424 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
425 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
426 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
427 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
428 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
429 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
430 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
431 #define GITATTRIBUTES_FILE ".gitattributes"
432 #define INFOATTRIBUTES_FILE "info/attributes"
433 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
434 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
435 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
436 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
437 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
438 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
439 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
440 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
441 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
442 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
443 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
444
445 /*
446 * This environment variable is expected to contain a boolean indicating
447 * whether we should or should not treat:
448 *
449 * GIT_DIR=foo.git git ...
450 *
451 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
452 * of this, but we use it internally to communicate to sub-processes that we
453 * are in a bare repo. If not set, defaults to true.
454 */
455 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
456
457 /*
458 * Repository-local GIT_* environment variables; these will be cleared
459 * when git spawns a sub-process that runs inside another repository.
460 * The array is NULL-terminated, which makes it easy to pass in the "env"
461 * parameter of a run-command invocation, or to do a simple walk.
462 */
463 extern const char * const local_repo_env[];
464
465 /*
466 * Returns true iff we have a configured git repository (either via
467 * setup_git_directory, or in the environment via $GIT_DIR).
468 */
469 int have_git_dir(void);
470
471 extern int is_bare_repository_cfg;
472 extern int is_bare_repository(void);
473 extern int is_inside_git_dir(void);
474 extern char *git_work_tree_cfg;
475 extern int is_inside_work_tree(void);
476 extern const char *get_git_dir(void);
477 extern const char *get_git_common_dir(void);
478 extern char *get_object_directory(void);
479 extern char *get_index_file(void);
480 extern char *get_graft_file(void);
481 extern int set_git_dir(const char *path);
482 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
483 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
484 extern const char *get_git_namespace(void);
485 extern const char *strip_namespace(const char *namespaced_ref);
486 extern const char *get_super_prefix(void);
487 extern const char *get_git_work_tree(void);
488
489 /*
490 * Return true if the given path is a git directory; note that this _just_
491 * looks at the directory itself. If you want to know whether "foo/.git"
492 * is a repository, you must feed that path, not just "foo".
493 */
494 extern int is_git_directory(const char *path);
495
496 /*
497 * Return 1 if the given path is the root of a git repository or
498 * submodule, else 0. Will not return 1 for bare repositories with the
499 * exception of creating a bare repository in "foo/.git" and calling
500 * is_git_repository("foo").
501 *
502 * If we run into read errors, we err on the side of saying "yes, it is",
503 * as we usually consider sub-repos precious, and would prefer to err on the
504 * side of not disrupting or deleting them.
505 */
506 extern int is_nonbare_repository_dir(struct strbuf *path);
507
508 #define READ_GITFILE_ERR_STAT_FAILED 1
509 #define READ_GITFILE_ERR_NOT_A_FILE 2
510 #define READ_GITFILE_ERR_OPEN_FAILED 3
511 #define READ_GITFILE_ERR_READ_FAILED 4
512 #define READ_GITFILE_ERR_INVALID_FORMAT 5
513 #define READ_GITFILE_ERR_NO_PATH 6
514 #define READ_GITFILE_ERR_NOT_A_REPO 7
515 #define READ_GITFILE_ERR_TOO_LARGE 8
516 extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
517 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
518 #define read_gitfile(path) read_gitfile_gently((path), NULL)
519 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
520 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
521
522 extern void set_git_work_tree(const char *tree);
523
524 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
525
526 extern void setup_work_tree(void);
527 /*
528 * Find GIT_DIR of the repository that contains the current working directory,
529 * without changing the working directory or other global state. The result is
530 * appended to gitdir. The return value is either NULL if no repository was
531 * found, or pointing to the path inside gitdir's buffer.
532 */
533 extern const char *discover_git_directory(struct strbuf *gitdir);
534 extern const char *setup_git_directory_gently(int *);
535 extern const char *setup_git_directory(void);
536 extern char *prefix_path(const char *prefix, int len, const char *path);
537 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
538
539 /*
540 * Concatenate "prefix" (if len is non-zero) and "path", with no
541 * connecting characters (so "prefix" should end with a "/").
542 * Unlike prefix_path, this should be used if the named file does
543 * not have to interact with index entry; i.e. name of a random file
544 * on the filesystem.
545 *
546 * The return value is always a newly allocated string (even if the
547 * prefix was empty).
548 */
549 extern char *prefix_filename(const char *prefix, const char *path);
550
551 extern int check_filename(const char *prefix, const char *name);
552 extern void verify_filename(const char *prefix,
553 const char *name,
554 int diagnose_misspelt_rev);
555 extern void verify_non_filename(const char *prefix, const char *name);
556 extern int path_inside_repo(const char *prefix, const char *path);
557
558 #define INIT_DB_QUIET 0x0001
559 #define INIT_DB_EXIST_OK 0x0002
560
561 extern int init_db(const char *git_dir, const char *real_git_dir,
562 const char *template_dir, unsigned int flags);
563
564 extern void sanitize_stdfds(void);
565 extern int daemonize(void);
566
567 #define alloc_nr(x) (((x)+16)*3/2)
568
569 /*
570 * Realloc the buffer pointed at by variable 'x' so that it can hold
571 * at least 'nr' entries; the number of entries currently allocated
572 * is 'alloc', using the standard growing factor alloc_nr() macro.
573 *
574 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
575 */
576 #define ALLOC_GROW(x, nr, alloc) \
577 do { \
578 if ((nr) > alloc) { \
579 if (alloc_nr(alloc) < (nr)) \
580 alloc = (nr); \
581 else \
582 alloc = alloc_nr(alloc); \
583 REALLOC_ARRAY(x, alloc); \
584 } \
585 } while (0)
586
587 /* Initialize and use the cache information */
588 struct lock_file;
589 extern int read_index(struct index_state *);
590 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
591 extern int do_read_index(struct index_state *istate, const char *path,
592 int must_exist); /* for testting only! */
593 extern int read_index_from(struct index_state *, const char *path);
594 extern int is_index_unborn(struct index_state *);
595 extern int read_index_unmerged(struct index_state *);
596 #define COMMIT_LOCK (1 << 0)
597 #define CLOSE_LOCK (1 << 1)
598 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
599 extern int discard_index(struct index_state *);
600 extern int unmerged_index(const struct index_state *);
601 extern int verify_path(const char *path);
602 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
603 extern void adjust_dirname_case(struct index_state *istate, char *name);
604 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
605
606 /*
607 * Searches for an entry defined by name and namelen in the given index.
608 * If the return value is positive (including 0) it is the position of an
609 * exact match. If the return value is negative, the negated value minus 1
610 * is the position where the entry would be inserted.
611 * Example: The current index consists of these files and its stages:
612 *
613 * b#0, d#0, f#1, f#3
614 *
615 * index_name_pos(&index, "a", 1) -> -1
616 * index_name_pos(&index, "b", 1) -> 0
617 * index_name_pos(&index, "c", 1) -> -2
618 * index_name_pos(&index, "d", 1) -> 1
619 * index_name_pos(&index, "e", 1) -> -3
620 * index_name_pos(&index, "f", 1) -> -3
621 * index_name_pos(&index, "g", 1) -> -5
622 */
623 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
624
625 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
626 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
627 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
628 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
629 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
630 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
631 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
632 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
633
634 /* Remove entry, return true if there are more entries to go. */
635 extern int remove_index_entry_at(struct index_state *, int pos);
636
637 extern void remove_marked_cache_entries(struct index_state *istate);
638 extern int remove_file_from_index(struct index_state *, const char *path);
639 #define ADD_CACHE_VERBOSE 1
640 #define ADD_CACHE_PRETEND 2
641 #define ADD_CACHE_IGNORE_ERRORS 4
642 #define ADD_CACHE_IGNORE_REMOVAL 8
643 #define ADD_CACHE_INTENT 16
644 /*
645 * These two are used to add the contents of the file at path
646 * to the index, marking the working tree up-to-date by storing
647 * the cached stat info in the resulting cache entry. A caller
648 * that has already run lstat(2) on the path can call
649 * add_to_index(), and all others can call add_file_to_index();
650 * the latter will do necessary lstat(2) internally before
651 * calling the former.
652 */
653 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
654 extern int add_file_to_index(struct index_state *, const char *path, int flags);
655
656 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
657 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
658 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
659 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
660 extern int index_name_is_other(const struct index_state *, const char *, int);
661 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
662
663 /* do stat comparison even if CE_VALID is true */
664 #define CE_MATCH_IGNORE_VALID 01
665 /* do not check the contents but report dirty on racily-clean entries */
666 #define CE_MATCH_RACY_IS_DIRTY 02
667 /* do stat comparison even if CE_SKIP_WORKTREE is true */
668 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
669 /* ignore non-existent files during stat update */
670 #define CE_MATCH_IGNORE_MISSING 0x08
671 /* enable stat refresh */
672 #define CE_MATCH_REFRESH 0x10
673 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
674 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
675
676 #define HASH_WRITE_OBJECT 1
677 #define HASH_FORMAT_CHECK 2
678 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
679 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
680
681 /*
682 * Record to sd the data from st that we use to check whether a file
683 * might have changed.
684 */
685 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
686
687 /*
688 * Return 0 if st is consistent with a file not having been changed
689 * since sd was filled. If there are differences, return a
690 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
691 * INODE_CHANGED, and DATA_CHANGED.
692 */
693 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
694 extern int match_stat_data_racy(const struct index_state *istate,
695 const struct stat_data *sd, struct stat *st);
696
697 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
698
699 #define REFRESH_REALLY 0x0001 /* ignore_valid */
700 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
701 #define REFRESH_QUIET 0x0004 /* be quiet about it */
702 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
703 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
704 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
705 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
706 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
707
708 extern void update_index_if_able(struct index_state *, struct lock_file *);
709
710 extern int hold_locked_index(struct lock_file *, int);
711 extern void set_alternate_index_output(const char *);
712
713 /* Environment bits from configuration mechanism */
714 extern int trust_executable_bit;
715 extern int trust_ctime;
716 extern int check_stat;
717 extern int quote_path_fully;
718 extern int has_symlinks;
719 extern int minimum_abbrev, default_abbrev;
720 extern int ignore_case;
721 extern int assume_unchanged;
722 extern int prefer_symlink_refs;
723 extern int warn_ambiguous_refs;
724 extern int warn_on_object_refname_ambiguity;
725 extern const char *apply_default_whitespace;
726 extern const char *apply_default_ignorewhitespace;
727 extern const char *git_attributes_file;
728 extern const char *git_hooks_path;
729 extern int zlib_compression_level;
730 extern int core_compression_level;
731 extern int pack_compression_level;
732 extern size_t packed_git_window_size;
733 extern size_t packed_git_limit;
734 extern size_t delta_base_cache_limit;
735 extern unsigned long big_file_threshold;
736 extern unsigned long pack_size_limit_cfg;
737
738 /*
739 * Accessors for the core.sharedrepository config which lazy-load the value
740 * from the config (if not already set). The "reset" function can be
741 * used to unset "set" or cached value, meaning that the value will be loaded
742 * fresh from the config file on the next call to get_shared_repository().
743 */
744 void set_shared_repository(int value);
745 int get_shared_repository(void);
746 void reset_shared_repository(void);
747
748 /*
749 * Do replace refs need to be checked this run? This variable is
750 * initialized to true unless --no-replace-object is used or
751 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
752 * commands that do not want replace references to be active. As an
753 * optimization it is also set to false if replace references have
754 * been sought but there were none.
755 */
756 extern int check_replace_refs;
757 extern char *git_replace_ref_base;
758
759 extern int fsync_object_files;
760 extern int core_preload_index;
761 extern int core_apply_sparse_checkout;
762 extern int precomposed_unicode;
763 extern int protect_hfs;
764 extern int protect_ntfs;
765 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
766
767 /*
768 * Include broken refs in all ref iterations, which will
769 * generally choke dangerous operations rather than letting
770 * them silently proceed without taking the broken ref into
771 * account.
772 */
773 extern int ref_paranoia;
774
775 /*
776 * The character that begins a commented line in user-editable file
777 * that is subject to stripspace.
778 */
779 extern char comment_line_char;
780 extern int auto_comment_line_char;
781
782 /* Windows only */
783 enum hide_dotfiles_type {
784 HIDE_DOTFILES_FALSE = 0,
785 HIDE_DOTFILES_TRUE,
786 HIDE_DOTFILES_DOTGITONLY
787 };
788 extern enum hide_dotfiles_type hide_dotfiles;
789
790 enum log_refs_config {
791 LOG_REFS_UNSET = -1,
792 LOG_REFS_NONE = 0,
793 LOG_REFS_NORMAL,
794 LOG_REFS_ALWAYS
795 };
796 extern enum log_refs_config log_all_ref_updates;
797
798 enum branch_track {
799 BRANCH_TRACK_UNSPECIFIED = -1,
800 BRANCH_TRACK_NEVER = 0,
801 BRANCH_TRACK_REMOTE,
802 BRANCH_TRACK_ALWAYS,
803 BRANCH_TRACK_EXPLICIT,
804 BRANCH_TRACK_OVERRIDE
805 };
806
807 enum rebase_setup_type {
808 AUTOREBASE_NEVER = 0,
809 AUTOREBASE_LOCAL,
810 AUTOREBASE_REMOTE,
811 AUTOREBASE_ALWAYS
812 };
813
814 enum push_default_type {
815 PUSH_DEFAULT_NOTHING = 0,
816 PUSH_DEFAULT_MATCHING,
817 PUSH_DEFAULT_SIMPLE,
818 PUSH_DEFAULT_UPSTREAM,
819 PUSH_DEFAULT_CURRENT,
820 PUSH_DEFAULT_UNSPECIFIED
821 };
822
823 extern enum branch_track git_branch_track;
824 extern enum rebase_setup_type autorebase;
825 extern enum push_default_type push_default;
826
827 enum object_creation_mode {
828 OBJECT_CREATION_USES_HARDLINKS = 0,
829 OBJECT_CREATION_USES_RENAMES = 1
830 };
831
832 extern enum object_creation_mode object_creation_mode;
833
834 extern char *notes_ref_name;
835
836 extern int grafts_replace_parents;
837
838 /*
839 * GIT_REPO_VERSION is the version we write by default. The
840 * _READ variant is the highest number we know how to
841 * handle.
842 */
843 #define GIT_REPO_VERSION 0
844 #define GIT_REPO_VERSION_READ 1
845 extern int repository_format_precious_objects;
846
847 struct repository_format {
848 int version;
849 int precious_objects;
850 int is_bare;
851 char *work_tree;
852 struct string_list unknown_extensions;
853 };
854
855 /*
856 * Read the repository format characteristics from the config file "path" into
857 * "format" struct. Returns the numeric version. On error, -1 is returned,
858 * format->version is set to -1, and all other fields in the struct are
859 * undefined.
860 */
861 int read_repository_format(struct repository_format *format, const char *path);
862
863 /*
864 * Verify that the repository described by repository_format is something we
865 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
866 * any errors encountered.
867 */
868 int verify_repository_format(const struct repository_format *format,
869 struct strbuf *err);
870
871 /*
872 * Check the repository format version in the path found in get_git_dir(),
873 * and die if it is a version we don't understand. Generally one would
874 * set_git_dir() before calling this, and use it only for "are we in a valid
875 * repo?".
876 */
877 extern void check_repository_format(void);
878
879 #define MTIME_CHANGED 0x0001
880 #define CTIME_CHANGED 0x0002
881 #define OWNER_CHANGED 0x0004
882 #define MODE_CHANGED 0x0008
883 #define INODE_CHANGED 0x0010
884 #define DATA_CHANGED 0x0020
885 #define TYPE_CHANGED 0x0040
886
887 /*
888 * Return a statically allocated filename, either generically (mkpath), in
889 * the repository directory (git_path), or in a submodule's repository
890 * directory (git_path_submodule). In all cases, note that the result
891 * may be overwritten by another call to _any_ of the functions. Consider
892 * using the safer "dup" or "strbuf" formats below (in some cases, the
893 * unsafe versions have already been removed).
894 */
895 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
896 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
897 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
898
899 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
900 __attribute__((format (printf, 3, 4)));
901 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
902 __attribute__((format (printf, 2, 3)));
903 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
904 __attribute__((format (printf, 2, 3)));
905 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
906 __attribute__((format (printf, 2, 3)));
907 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
908 const char *fmt, ...)
909 __attribute__((format (printf, 3, 4)));
910 extern char *git_pathdup(const char *fmt, ...)
911 __attribute__((format (printf, 1, 2)));
912 extern char *mkpathdup(const char *fmt, ...)
913 __attribute__((format (printf, 1, 2)));
914 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
915 __attribute__((format (printf, 2, 3)));
916
917 extern void report_linked_checkout_garbage(void);
918
919 /*
920 * You can define a static memoized git path like:
921 *
922 * static GIT_PATH_FUNC(git_path_foo, "FOO");
923 *
924 * or use one of the global ones below.
925 */
926 #define GIT_PATH_FUNC(func, filename) \
927 const char *func(void) \
928 { \
929 static char *ret; \
930 if (!ret) \
931 ret = git_pathdup(filename); \
932 return ret; \
933 }
934
935 const char *git_path_cherry_pick_head(void);
936 const char *git_path_revert_head(void);
937 const char *git_path_squash_msg(void);
938 const char *git_path_merge_msg(void);
939 const char *git_path_merge_rr(void);
940 const char *git_path_merge_mode(void);
941 const char *git_path_merge_head(void);
942 const char *git_path_fetch_head(void);
943 const char *git_path_shallow(void);
944
945 /*
946 * Return the name of the file in the local object database that would
947 * be used to store a loose object with the specified sha1. The
948 * return value is a pointer to a statically allocated buffer that is
949 * overwritten each time the function is called.
950 */
951 extern const char *sha1_file_name(const unsigned char *sha1);
952
953 /*
954 * Return the name of the (local) packfile with the specified sha1 in
955 * its name. The return value is a pointer to memory that is
956 * overwritten each time this function is called.
957 */
958 extern char *sha1_pack_name(const unsigned char *sha1);
959
960 /*
961 * Return the name of the (local) pack index file with the specified
962 * sha1 in its name. The return value is a pointer to memory that is
963 * overwritten each time this function is called.
964 */
965 extern char *sha1_pack_index_name(const unsigned char *sha1);
966
967 /*
968 * Return an abbreviated sha1 unique within this repository's object database.
969 * The result will be at least `len` characters long, and will be NUL
970 * terminated.
971 *
972 * The non-`_r` version returns a static buffer which remains valid until 4
973 * more calls to find_unique_abbrev are made.
974 *
975 * The `_r` variant writes to a buffer supplied by the caller, which must be at
976 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
977 * written (excluding the NUL terminator).
978 *
979 * Note that while this version avoids the static buffer, it is not fully
980 * reentrant, as it calls into other non-reentrant git code.
981 */
982 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
983 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
984
985 extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
986 extern const struct object_id null_oid;
987
988 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
989 {
990 int i;
991
992 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
993 if (*sha1 != *sha2)
994 return *sha1 - *sha2;
995 }
996
997 return 0;
998 }
999
1000 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
1001 {
1002 return hashcmp(oid1->hash, oid2->hash);
1003 }
1004
1005 static inline int is_null_sha1(const unsigned char *sha1)
1006 {
1007 return !hashcmp(sha1, null_sha1);
1008 }
1009
1010 static inline int is_null_oid(const struct object_id *oid)
1011 {
1012 return !hashcmp(oid->hash, null_sha1);
1013 }
1014
1015 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1016 {
1017 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
1018 }
1019
1020 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1021 {
1022 hashcpy(dst->hash, src->hash);
1023 }
1024
1025 static inline void hashclr(unsigned char *hash)
1026 {
1027 memset(hash, 0, GIT_SHA1_RAWSZ);
1028 }
1029
1030 static inline void oidclr(struct object_id *oid)
1031 {
1032 hashclr(oid->hash);
1033 }
1034
1035
1036 #define EMPTY_TREE_SHA1_HEX \
1037 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
1038 #define EMPTY_TREE_SHA1_BIN_LITERAL \
1039 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
1040 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
1041 extern const struct object_id empty_tree_oid;
1042 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
1043
1044 #define EMPTY_BLOB_SHA1_HEX \
1045 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1046 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
1047 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1048 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
1049 extern const struct object_id empty_blob_oid;
1050 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1051
1052
1053 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1054 {
1055 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
1056 }
1057
1058 static inline int is_empty_blob_oid(const struct object_id *oid)
1059 {
1060 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
1061 }
1062
1063 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1064 {
1065 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1066 }
1067
1068 static inline int is_empty_tree_oid(const struct object_id *oid)
1069 {
1070 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1071 }
1072
1073 /* set default permissions by passing mode arguments to open(2) */
1074 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1075 int git_mkstemp_mode(char *pattern, int mode);
1076
1077 /*
1078 * NOTE NOTE NOTE!!
1079 *
1080 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1081 * not be changed. Old repositories have core.sharedrepository written in
1082 * numeric format, and therefore these values are preserved for compatibility
1083 * reasons.
1084 */
1085 enum sharedrepo {
1086 PERM_UMASK = 0,
1087 OLD_PERM_GROUP = 1,
1088 OLD_PERM_EVERYBODY = 2,
1089 PERM_GROUP = 0660,
1090 PERM_EVERYBODY = 0664
1091 };
1092 int git_config_perm(const char *var, const char *value);
1093 int adjust_shared_perm(const char *path);
1094
1095 /*
1096 * Create the directory containing the named path, using care to be
1097 * somewhat safe against races. Return one of the scld_error values to
1098 * indicate success/failure. On error, set errno to describe the
1099 * problem.
1100 *
1101 * SCLD_VANISHED indicates that one of the ancestor directories of the
1102 * path existed at one point during the function call and then
1103 * suddenly vanished, probably because another process pruned the
1104 * directory while we were working. To be robust against this kind of
1105 * race, callers might want to try invoking the function again when it
1106 * returns SCLD_VANISHED.
1107 *
1108 * safe_create_leading_directories() temporarily changes path while it
1109 * is working but restores it before returning.
1110 * safe_create_leading_directories_const() doesn't modify path, even
1111 * temporarily.
1112 */
1113 enum scld_error {
1114 SCLD_OK = 0,
1115 SCLD_FAILED = -1,
1116 SCLD_PERMS = -2,
1117 SCLD_EXISTS = -3,
1118 SCLD_VANISHED = -4
1119 };
1120 enum scld_error safe_create_leading_directories(char *path);
1121 enum scld_error safe_create_leading_directories_const(const char *path);
1122
1123 /*
1124 * Callback function for raceproof_create_file(). This function is
1125 * expected to do something that makes dirname(path) permanent despite
1126 * the fact that other processes might be cleaning up empty
1127 * directories at the same time. Usually it will create a file named
1128 * path, but alternatively it could create another file in that
1129 * directory, or even chdir() into that directory. The function should
1130 * return 0 if the action was completed successfully. On error, it
1131 * should return a nonzero result and set errno.
1132 * raceproof_create_file() treats two errno values specially:
1133 *
1134 * - ENOENT -- dirname(path) does not exist. In this case,
1135 * raceproof_create_file() tries creating dirname(path)
1136 * (and any parent directories, if necessary) and calls
1137 * the function again.
1138 *
1139 * - EISDIR -- the file already exists and is a directory. In this
1140 * case, raceproof_create_file() removes the directory if
1141 * it is empty (and recursively any empty directories that
1142 * it contains) and calls the function again.
1143 *
1144 * Any other errno causes raceproof_create_file() to fail with the
1145 * callback's return value and errno.
1146 *
1147 * Obviously, this function should be OK with being called again if it
1148 * fails with ENOENT or EISDIR. In other scenarios it will not be
1149 * called again.
1150 */
1151 typedef int create_file_fn(const char *path, void *cb);
1152
1153 /*
1154 * Create a file in dirname(path) by calling fn, creating leading
1155 * directories if necessary. Retry a few times in case we are racing
1156 * with another process that is trying to clean up the directory that
1157 * contains path. See the documentation for create_file_fn for more
1158 * details.
1159 *
1160 * Return the value and set the errno that resulted from the most
1161 * recent call of fn. fn is always called at least once, and will be
1162 * called more than once if it returns ENOENT or EISDIR.
1163 */
1164 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1165
1166 int mkdir_in_gitdir(const char *path);
1167 extern char *expand_user_path(const char *path, int real_home);
1168 const char *enter_repo(const char *path, int strict);
1169 static inline int is_absolute_path(const char *path)
1170 {
1171 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1172 }
1173 int is_directory(const char *);
1174 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1175 int die_on_error);
1176 const char *real_path(const char *path);
1177 const char *real_path_if_valid(const char *path);
1178 char *real_pathdup(const char *path, int die_on_error);
1179 const char *absolute_path(const char *path);
1180 char *absolute_pathdup(const char *path);
1181 const char *remove_leading_path(const char *in, const char *prefix);
1182 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1183 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1184 int normalize_path_copy(char *dst, const char *src);
1185 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1186 char *strip_path_suffix(const char *path, const char *suffix);
1187 int daemon_avoid_alias(const char *path);
1188 extern int is_ntfs_dotgit(const char *name);
1189
1190 /**
1191 * Return a newly allocated string with the evaluation of
1192 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1193 * "$HOME/.config/git/$filename". Return NULL upon error.
1194 */
1195 extern char *xdg_config_home(const char *filename);
1196
1197 /**
1198 * Return a newly allocated string with the evaluation of
1199 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1200 * "$HOME/.cache/git/$filename". Return NULL upon error.
1201 */
1202 extern char *xdg_cache_home(const char *filename);
1203
1204 /* object replacement */
1205 #define LOOKUP_REPLACE_OBJECT 1
1206 #define LOOKUP_UNKNOWN_OBJECT 2
1207 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1208 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1209 {
1210 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1211 }
1212
1213 /*
1214 * This internal function is only declared here for the benefit of
1215 * lookup_replace_object(). Please do not call it directly.
1216 */
1217 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1218
1219 /*
1220 * If object sha1 should be replaced, return the replacement object's
1221 * name (replaced recursively, if necessary). The return value is
1222 * either sha1 or a pointer to a permanently-allocated value. When
1223 * object replacement is suppressed, always return sha1.
1224 */
1225 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1226 {
1227 if (!check_replace_refs)
1228 return sha1;
1229 return do_lookup_replace_object(sha1);
1230 }
1231
1232 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1233 {
1234 if (!(flag & LOOKUP_REPLACE_OBJECT))
1235 return sha1;
1236 return lookup_replace_object(sha1);
1237 }
1238
1239 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1240 extern int sha1_object_info(const unsigned char *, unsigned long *);
1241 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1242 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1243 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1244 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1245 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1246 extern int git_open_cloexec(const char *name, int flags);
1247 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1248 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1249 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1250 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1251
1252 /* global flag to enable extra checks when accessing packed objects */
1253 extern int do_check_packed_object_crc;
1254
1255 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1256
1257 extern int finalize_object_file(const char *tmpfile, const char *filename);
1258
1259 extern int has_sha1_pack(const unsigned char *sha1);
1260
1261 /*
1262 * Open the loose object at path, check its sha1, and return the contents,
1263 * type, and size. If the object is a blob, then "contents" may return NULL,
1264 * to allow streaming of large blobs.
1265 *
1266 * Returns 0 on success, negative on error (details may be written to stderr).
1267 */
1268 int read_loose_object(const char *path,
1269 const unsigned char *expected_sha1,
1270 enum object_type *type,
1271 unsigned long *size,
1272 void **contents);
1273
1274 /*
1275 * Return true iff we have an object named sha1, whether local or in
1276 * an alternate object database, and whether packed or loose. This
1277 * function does not respect replace references.
1278 *
1279 * If the QUICK flag is set, do not re-check the pack directory
1280 * when we cannot find the object (this means we may give a false
1281 * negative answer if another process is simultaneously repacking).
1282 */
1283 #define HAS_SHA1_QUICK 0x1
1284 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1285 static inline int has_sha1_file(const unsigned char *sha1)
1286 {
1287 return has_sha1_file_with_flags(sha1, 0);
1288 }
1289
1290 /* Same as the above, except for struct object_id. */
1291 extern int has_object_file(const struct object_id *oid);
1292 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1293
1294 /*
1295 * Return true iff an alternate object database has a loose object
1296 * with the specified name. This function does not respect replace
1297 * references.
1298 */
1299 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1300
1301 extern int has_pack_index(const unsigned char *sha1);
1302
1303 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1304
1305 /* Helper to check and "touch" a file */
1306 extern int check_and_freshen_file(const char *fn, int freshen);
1307
1308 extern const signed char hexval_table[256];
1309 static inline unsigned int hexval(unsigned char c)
1310 {
1311 return hexval_table[c];
1312 }
1313
1314 /*
1315 * Convert two consecutive hexadecimal digits into a char. Return a
1316 * negative value on error. Don't run over the end of short strings.
1317 */
1318 static inline int hex2chr(const char *s)
1319 {
1320 int val = hexval(s[0]);
1321 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1322 }
1323
1324 /* Convert to/from hex/sha1 representation */
1325 #define MINIMUM_ABBREV minimum_abbrev
1326 #define DEFAULT_ABBREV default_abbrev
1327
1328 /* used when the code does not know or care what the default abbrev is */
1329 #define FALLBACK_DEFAULT_ABBREV 7
1330
1331 struct object_context {
1332 unsigned char tree[20];
1333 char path[PATH_MAX];
1334 unsigned mode;
1335 /*
1336 * symlink_path is only used by get_tree_entry_follow_symlinks,
1337 * and only for symlinks that point outside the repository.
1338 */
1339 struct strbuf symlink_path;
1340 };
1341
1342 #define GET_SHA1_QUIETLY 01
1343 #define GET_SHA1_COMMIT 02
1344 #define GET_SHA1_COMMITTISH 04
1345 #define GET_SHA1_TREE 010
1346 #define GET_SHA1_TREEISH 020
1347 #define GET_SHA1_BLOB 040
1348 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1349 #define GET_SHA1_ONLY_TO_DIE 04000
1350
1351 #define GET_SHA1_DISAMBIGUATORS \
1352 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1353 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1354 GET_SHA1_BLOB)
1355
1356 extern int get_sha1(const char *str, unsigned char *sha1);
1357 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1358 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1359 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1360 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1361 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1362 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1363 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1364
1365 extern int get_oid(const char *str, struct object_id *oid);
1366
1367 typedef int each_abbrev_fn(const struct object_id *oid, void *);
1368 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1369
1370 extern int set_disambiguate_hint_config(const char *var, const char *value);
1371
1372 /*
1373 * Try to read a SHA1 in hexadecimal format from the 40 characters
1374 * starting at hex. Write the 20-byte result to sha1 in binary form.
1375 * Return 0 on success. Reading stops if a NUL is encountered in the
1376 * input, so it is safe to pass this function an arbitrary
1377 * null-terminated string.
1378 */
1379 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1380 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1381
1382 /*
1383 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1384 * and writes the NUL-terminated output to the buffer `out`, which must be at
1385 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1386 * convenience.
1387 *
1388 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1389 * buffers, making it safe to make multiple calls for a single statement, like:
1390 *
1391 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1392 */
1393 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1394 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1395 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1396 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1397
1398 /*
1399 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1400 * pointer specified by end when parsing stops. The resulting object ID is
1401 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1402 * other invalid character. end is only updated on success; otherwise, it is
1403 * unmodified.
1404 */
1405 extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1406
1407 /*
1408 * This reads short-hand syntax that not only evaluates to a commit
1409 * object name, but also can act as if the end user spelled the name
1410 * of the branch from the command line.
1411 *
1412 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1413 * places the name of the branch in the given buf and returns the
1414 * number of characters parsed if successful.
1415 *
1416 * - "<branch>@{upstream}" finds the name of the other ref that
1417 * <branch> is configured to merge with (missing <branch> defaults
1418 * to the current branch), and places the name of the branch in the
1419 * given buf and returns the number of characters parsed if
1420 * successful.
1421 *
1422 * If the input is not of the accepted format, it returns a negative
1423 * number to signal an error.
1424 *
1425 * If the input was ok but there are not N branch switches in the
1426 * reflog, it returns 0.
1427 *
1428 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1429 * expansions: local branches ("refs/heads/"), remote branches
1430 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1431 * allowed, even ones to refs outside of those namespaces.
1432 */
1433 #define INTERPRET_BRANCH_LOCAL (1<<0)
1434 #define INTERPRET_BRANCH_REMOTE (1<<1)
1435 #define INTERPRET_BRANCH_HEAD (1<<2)
1436 extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1437 unsigned allowed);
1438 extern int get_oid_mb(const char *str, struct object_id *oid);
1439
1440 extern int validate_headref(const char *ref);
1441
1442 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1443 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1444 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1445 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1446
1447 extern void *read_object_with_reference(const unsigned char *sha1,
1448 const char *required_type,
1449 unsigned long *size,
1450 unsigned char *sha1_ret);
1451
1452 extern struct object *peel_to_type(const char *name, int namelen,
1453 struct object *o, enum object_type);
1454
1455 struct date_mode {
1456 enum date_mode_type {
1457 DATE_NORMAL = 0,
1458 DATE_RELATIVE,
1459 DATE_SHORT,
1460 DATE_ISO8601,
1461 DATE_ISO8601_STRICT,
1462 DATE_RFC2822,
1463 DATE_STRFTIME,
1464 DATE_RAW,
1465 DATE_UNIX
1466 } type;
1467 const char *strftime_fmt;
1468 int local;
1469 };
1470
1471 /*
1472 * Convenience helper for passing a constant type, like:
1473 *
1474 * show_date(t, tz, DATE_MODE(NORMAL));
1475 */
1476 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1477 struct date_mode *date_mode_from_type(enum date_mode_type type);
1478
1479 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1480 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1481 struct strbuf *timebuf);
1482 int parse_date(const char *date, struct strbuf *out);
1483 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1484 int parse_expiry_date(const char *date, unsigned long *timestamp);
1485 void datestamp(struct strbuf *out);
1486 #define approxidate(s) approxidate_careful((s), NULL)
1487 unsigned long approxidate_careful(const char *, int *);
1488 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1489 void parse_date_format(const char *format, struct date_mode *mode);
1490 int date_overflows(unsigned long date);
1491
1492 #define IDENT_STRICT 1
1493 #define IDENT_NO_DATE 2
1494 #define IDENT_NO_NAME 4
1495 extern const char *git_author_info(int);
1496 extern const char *git_committer_info(int);
1497 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1498 extern const char *fmt_name(const char *name, const char *email);
1499 extern const char *ident_default_name(void);
1500 extern const char *ident_default_email(void);
1501 extern const char *git_editor(void);
1502 extern const char *git_pager(int stdout_is_tty);
1503 extern int git_ident_config(const char *, const char *, void *);
1504 extern void reset_ident_date(void);
1505
1506 struct ident_split {
1507 const char *name_begin;
1508 const char *name_end;
1509 const char *mail_begin;
1510 const char *mail_end;
1511 const char *date_begin;
1512 const char *date_end;
1513 const char *tz_begin;
1514 const char *tz_end;
1515 };
1516 /*
1517 * Signals an success with 0, but time part of the result may be NULL
1518 * if the input lacks timestamp and zone
1519 */
1520 extern int split_ident_line(struct ident_split *, const char *, int);
1521
1522 /*
1523 * Like show_date, but pull the timestamp and tz parameters from
1524 * the ident_split. It will also sanity-check the values and produce
1525 * a well-known sentinel date if they appear bogus.
1526 */
1527 const char *show_ident_date(const struct ident_split *id,
1528 const struct date_mode *mode);
1529
1530 /*
1531 * Compare split idents for equality or strict ordering. Note that we
1532 * compare only the ident part of the line, ignoring any timestamp.
1533 *
1534 * Because there are two fields, we must choose one as the primary key; we
1535 * currently arbitrarily pick the email.
1536 */
1537 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1538
1539 struct checkout {
1540 struct index_state *istate;
1541 const char *base_dir;
1542 int base_dir_len;
1543 unsigned force:1,
1544 quiet:1,
1545 not_new:1,
1546 refresh_cache:1;
1547 };
1548 #define CHECKOUT_INIT { NULL, "" }
1549
1550 #define TEMPORARY_FILENAME_LENGTH 25
1551 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1552
1553 struct cache_def {
1554 struct strbuf path;
1555 int flags;
1556 int track_flags;
1557 int prefix_len_stat_func;
1558 };
1559 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1560 static inline void cache_def_clear(struct cache_def *cache)
1561 {
1562 strbuf_release(&cache->path);
1563 }
1564
1565 extern int has_symlink_leading_path(const char *name, int len);
1566 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1567 extern int check_leading_path(const char *name, int len);
1568 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1569 extern void schedule_dir_for_removal(const char *name, int len);
1570 extern void remove_scheduled_dirs(void);
1571
1572 extern struct alternate_object_database {
1573 struct alternate_object_database *next;
1574
1575 /* see alt_scratch_buf() */
1576 struct strbuf scratch;
1577 size_t base_len;
1578
1579 char path[FLEX_ARRAY];
1580 } *alt_odb_list;
1581 extern void prepare_alt_odb(void);
1582 extern void read_info_alternates(const char * relative_base, int depth);
1583 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1584 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1585 extern int foreach_alt_odb(alt_odb_fn, void*);
1586
1587 /*
1588 * Allocate a "struct alternate_object_database" but do _not_ actually
1589 * add it to the list of alternates.
1590 */
1591 struct alternate_object_database *alloc_alt_odb(const char *dir);
1592
1593 /*
1594 * Add the directory to the on-disk alternates file; the new entry will also
1595 * take effect in the current process.
1596 */
1597 extern void add_to_alternates_file(const char *dir);
1598
1599 /*
1600 * Add the directory to the in-memory list of alternates (along with any
1601 * recursive alternates it points to), but do not modify the on-disk alternates
1602 * file.
1603 */
1604 extern void add_to_alternates_memory(const char *dir);
1605
1606 /*
1607 * Returns a scratch strbuf pre-filled with the alternate object directory,
1608 * including a trailing slash, which can be used to access paths in the
1609 * alternate. Always use this over direct access to alt->scratch, as it
1610 * cleans up any previous use of the scratch buffer.
1611 */
1612 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1613
1614 struct pack_window {
1615 struct pack_window *next;
1616 unsigned char *base;
1617 off_t offset;
1618 size_t len;
1619 unsigned int last_used;
1620 unsigned int inuse_cnt;
1621 };
1622
1623 extern struct packed_git {
1624 struct packed_git *next;
1625 struct pack_window *windows;
1626 off_t pack_size;
1627 const void *index_data;
1628 size_t index_size;
1629 uint32_t num_objects;
1630 uint32_t num_bad_objects;
1631 unsigned char *bad_object_sha1;
1632 int index_version;
1633 time_t mtime;
1634 int pack_fd;
1635 unsigned pack_local:1,
1636 pack_keep:1,
1637 freshened:1,
1638 do_not_close:1;
1639 unsigned char sha1[20];
1640 struct revindex_entry *revindex;
1641 /* something like ".git/objects/pack/xxxxx.pack" */
1642 char pack_name[FLEX_ARRAY]; /* more */
1643 } *packed_git;
1644
1645 /*
1646 * A most-recently-used ordered version of the packed_git list, which can
1647 * be iterated instead of packed_git (and marked via mru_mark).
1648 */
1649 struct mru;
1650 extern struct mru *packed_git_mru;
1651
1652 struct pack_entry {
1653 off_t offset;
1654 unsigned char sha1[20];
1655 struct packed_git *p;
1656 };
1657
1658 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1659
1660 /* A hook to report invalid files in pack directory */
1661 #define PACKDIR_FILE_PACK 1
1662 #define PACKDIR_FILE_IDX 2
1663 #define PACKDIR_FILE_GARBAGE 4
1664 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1665
1666 extern void prepare_packed_git(void);
1667 extern void reprepare_packed_git(void);
1668 extern void install_packed_git(struct packed_git *pack);
1669
1670 /*
1671 * Give a rough count of objects in the repository. This sacrifices accuracy
1672 * for speed.
1673 */
1674 unsigned long approximate_object_count(void);
1675
1676 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1677 struct packed_git *packs);
1678
1679 extern void pack_report(void);
1680
1681 /*
1682 * Create a temporary file rooted in the object database directory, or
1683 * die on failure. The filename is taken from "pattern", which should have the
1684 * usual "XXXXXX" trailer, and the resulting filename is written into the
1685 * "template" buffer. Returns the open descriptor.
1686 */
1687 extern int odb_mkstemp(struct strbuf *template, const char *pattern);
1688
1689 /*
1690 * Generate the filename to be used for a pack file with checksum "sha1" and
1691 * extension "ext". The result is written into the strbuf "buf", overwriting
1692 * any existing contents. A pointer to buf->buf is returned as a convenience.
1693 *
1694 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
1695 */
1696 extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
1697
1698 /*
1699 * Create a pack .keep file named "name" (which should generally be the output
1700 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1701 * error.
1702 */
1703 extern int odb_pack_keep(const char *name);
1704
1705 /*
1706 * mmap the index file for the specified packfile (if it is not
1707 * already mmapped). Return 0 on success.
1708 */
1709 extern int open_pack_index(struct packed_git *);
1710
1711 /*
1712 * munmap the index file for the specified packfile (if it is
1713 * currently mmapped).
1714 */
1715 extern void close_pack_index(struct packed_git *);
1716
1717 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1718 extern void close_pack_windows(struct packed_git *);
1719 extern void close_all_packs(void);
1720 extern void unuse_pack(struct pack_window **);
1721 extern void clear_delta_base_cache(void);
1722 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1723
1724 /*
1725 * Make sure that a pointer access into an mmap'd index file is within bounds,
1726 * and can provide at least 8 bytes of data.
1727 *
1728 * Note that this is only necessary for variable-length segments of the file
1729 * (like the 64-bit extended offset table), as we compare the size to the
1730 * fixed-length parts when we open the file.
1731 */
1732 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1733
1734 /*
1735 * Return the SHA-1 of the nth object within the specified packfile.
1736 * Open the index if it is not already open. The return value points
1737 * at the SHA-1 within the mmapped index. Return NULL if there is an
1738 * error.
1739 */
1740 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1741 /*
1742 * Like nth_packed_object_sha1, but write the data into the object specified by
1743 * the the first argument. Returns the first argument on success, and NULL on
1744 * error.
1745 */
1746 extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
1747
1748 /*
1749 * Return the offset of the nth object within the specified packfile.
1750 * The index must already be opened.
1751 */
1752 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1753
1754 /*
1755 * If the object named sha1 is present in the specified packfile,
1756 * return its offset within the packfile; otherwise, return 0.
1757 */
1758 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1759
1760 extern int is_pack_valid(struct packed_git *);
1761 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1762 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1763 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1764 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1765
1766 /*
1767 * Iterate over the files in the loose-object parts of the object
1768 * directory "path", triggering the following callbacks:
1769 *
1770 * - loose_object is called for each loose object we find.
1771 *
1772 * - loose_cruft is called for any files that do not appear to be
1773 * loose objects. Note that we only look in the loose object
1774 * directories "objects/[0-9a-f]{2}/", so we will not report
1775 * "objects/foobar" as cruft.
1776 *
1777 * - loose_subdir is called for each top-level hashed subdirectory
1778 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1779 * after the objects in the directory are processed.
1780 *
1781 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1782 * will end the iteration.
1783 *
1784 * In the "buf" variant, "path" is a strbuf which will also be used as a
1785 * scratch buffer, but restored to its original contents before
1786 * the function returns.
1787 */
1788 typedef int each_loose_object_fn(const struct object_id *oid,
1789 const char *path,
1790 void *data);
1791 typedef int each_loose_cruft_fn(const char *basename,
1792 const char *path,
1793 void *data);
1794 typedef int each_loose_subdir_fn(int nr,
1795 const char *path,
1796 void *data);
1797 int for_each_loose_file_in_objdir(const char *path,
1798 each_loose_object_fn obj_cb,
1799 each_loose_cruft_fn cruft_cb,
1800 each_loose_subdir_fn subdir_cb,
1801 void *data);
1802 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1803 each_loose_object_fn obj_cb,
1804 each_loose_cruft_fn cruft_cb,
1805 each_loose_subdir_fn subdir_cb,
1806 void *data);
1807
1808 /*
1809 * Iterate over loose and packed objects in both the local
1810 * repository and any alternates repositories (unless the
1811 * LOCAL_ONLY flag is set).
1812 */
1813 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1814 typedef int each_packed_object_fn(const struct object_id *oid,
1815 struct packed_git *pack,
1816 uint32_t pos,
1817 void *data);
1818 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1819 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1820
1821 struct object_info {
1822 /* Request */
1823 enum object_type *typep;
1824 unsigned long *sizep;
1825 off_t *disk_sizep;
1826 unsigned char *delta_base_sha1;
1827 struct strbuf *typename;
1828
1829 /* Response */
1830 enum {
1831 OI_CACHED,
1832 OI_LOOSE,
1833 OI_PACKED,
1834 OI_DBCACHED
1835 } whence;
1836 union {
1837 /*
1838 * struct {
1839 * ... Nothing to expose in this case
1840 * } cached;
1841 * struct {
1842 * ... Nothing to expose in this case
1843 * } loose;
1844 */
1845 struct {
1846 struct packed_git *pack;
1847 off_t offset;
1848 unsigned int is_delta;
1849 } packed;
1850 } u;
1851 };
1852
1853 /*
1854 * Initializer for a "struct object_info" that wants no items. You may
1855 * also memset() the memory to all-zeroes.
1856 */
1857 #define OBJECT_INFO_INIT {NULL}
1858
1859 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1860 extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
1861
1862 /* Dumb servers support */
1863 extern int update_server_info(int);
1864
1865 /* git_config_parse_key() returns these negated: */
1866 #define CONFIG_INVALID_KEY 1
1867 #define CONFIG_NO_SECTION_OR_NAME 2
1868 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1869 #define CONFIG_NO_LOCK -1
1870 #define CONFIG_INVALID_FILE 3
1871 #define CONFIG_NO_WRITE 4
1872 #define CONFIG_NOTHING_SET 5
1873 #define CONFIG_INVALID_PATTERN 6
1874 #define CONFIG_GENERIC_ERROR 7
1875
1876 #define CONFIG_REGEX_NONE ((void *)1)
1877
1878 struct git_config_source {
1879 unsigned int use_stdin:1;
1880 const char *file;
1881 const char *blob;
1882 };
1883
1884 enum config_origin_type {
1885 CONFIG_ORIGIN_BLOB,
1886 CONFIG_ORIGIN_FILE,
1887 CONFIG_ORIGIN_STDIN,
1888 CONFIG_ORIGIN_SUBMODULE_BLOB,
1889 CONFIG_ORIGIN_CMDLINE
1890 };
1891
1892 typedef int (*config_fn_t)(const char *, const char *, void *);
1893 extern int git_default_config(const char *, const char *, void *);
1894 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1895 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1896 const char *name, const char *buf, size_t len, void *data);
1897 extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,
1898 const unsigned char *sha1, void *data);
1899 extern void git_config_push_parameter(const char *text);
1900 extern int git_config_from_parameters(config_fn_t fn, void *data);
1901 extern void read_early_config(config_fn_t cb, void *data);
1902 extern void git_config(config_fn_t fn, void *);
1903 extern int git_config_with_options(config_fn_t fn, void *,
1904 struct git_config_source *config_source,
1905 int respect_includes);
1906 extern int git_parse_ulong(const char *, unsigned long *);
1907 extern int git_parse_maybe_bool(const char *);
1908 extern int git_config_int(const char *, const char *);
1909 extern int64_t git_config_int64(const char *, const char *);
1910 extern unsigned long git_config_ulong(const char *, const char *);
1911 extern ssize_t git_config_ssize_t(const char *, const char *);
1912 extern int git_config_bool_or_int(const char *, const char *, int *);
1913 extern int git_config_bool(const char *, const char *);
1914 extern int git_config_maybe_bool(const char *, const char *);
1915 extern int git_config_string(const char **, const char *, const char *);
1916 extern int git_config_pathname(const char **, const char *, const char *);
1917 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1918 extern void git_config_set_in_file(const char *, const char *, const char *);
1919 extern int git_config_set_gently(const char *, const char *);
1920 extern void git_config_set(const char *, const char *);
1921 extern int git_config_parse_key(const char *, char **, int *);
1922 extern int git_config_key_is_valid(const char *key);
1923 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1924 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1925 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1926 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1927 extern int git_config_rename_section(const char *, const char *);
1928 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1929 extern const char *git_etc_gitconfig(void);
1930 extern int git_env_bool(const char *, int);
1931 extern unsigned long git_env_ulong(const char *, unsigned long);
1932 extern int git_config_system(void);
1933 extern int config_error_nonbool(const char *);
1934 #if defined(__GNUC__)
1935 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1936 #endif
1937 extern const char *get_log_output_encoding(void);
1938 extern const char *get_commit_output_encoding(void);
1939
1940 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1941
1942 enum config_scope {
1943 CONFIG_SCOPE_UNKNOWN = 0,
1944 CONFIG_SCOPE_SYSTEM,
1945 CONFIG_SCOPE_GLOBAL,
1946 CONFIG_SCOPE_REPO,
1947 CONFIG_SCOPE_CMDLINE,
1948 };
1949
1950 extern enum config_scope current_config_scope(void);
1951 extern const char *current_config_origin_type(void);
1952 extern const char *current_config_name(void);
1953
1954 struct config_include_data {
1955 int depth;
1956 config_fn_t fn;
1957 void *data;
1958 };
1959 #define CONFIG_INCLUDE_INIT { 0 }
1960 extern int git_config_include(const char *name, const char *value, void *data);
1961
1962 /*
1963 * Match and parse a config key of the form:
1964 *
1965 * section.(subsection.)?key
1966 *
1967 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1968 * we return -1 if it does not match, 0 otherwise. The subsection and key
1969 * out-parameters are filled by the function (and *subsection is NULL if it is
1970 * missing).
1971 *
1972 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
1973 * there is no subsection at all.
1974 */
1975 extern int parse_config_key(const char *var,
1976 const char *section,
1977 const char **subsection, int *subsection_len,
1978 const char **key);
1979
1980 struct config_set_element {
1981 struct hashmap_entry ent;
1982 char *key;
1983 struct string_list value_list;
1984 };
1985
1986 struct configset_list_item {
1987 struct config_set_element *e;
1988 int value_index;
1989 };
1990
1991 /*
1992 * the contents of the list are ordered according to their
1993 * position in the config files and order of parsing the files.
1994 * (i.e. key-value pair at the last position of .git/config will
1995 * be at the last item of the list)
1996 */
1997 struct configset_list {
1998 struct configset_list_item *items;
1999 unsigned int nr, alloc;
2000 };
2001
2002 struct config_set {
2003 struct hashmap config_hash;
2004 int hash_initialized;
2005 struct configset_list list;
2006 };
2007
2008 extern void git_configset_init(struct config_set *cs);
2009 extern int git_configset_add_file(struct config_set *cs, const char *filename);
2010 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
2011 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
2012 extern void git_configset_clear(struct config_set *cs);
2013 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
2014 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
2015 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
2016 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
2017 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
2018 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
2019 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
2020 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
2021
2022 extern int git_config_get_value(const char *key, const char **value);
2023 extern const struct string_list *git_config_get_value_multi(const char *key);
2024 extern void git_config_clear(void);
2025 extern void git_config_iter(config_fn_t fn, void *data);
2026 extern int git_config_get_string_const(const char *key, const char **dest);
2027 extern int git_config_get_string(const char *key, char **dest);
2028 extern int git_config_get_int(const char *key, int *dest);
2029 extern int git_config_get_ulong(const char *key, unsigned long *dest);
2030 extern int git_config_get_bool(const char *key, int *dest);
2031 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
2032 extern int git_config_get_maybe_bool(const char *key, int *dest);
2033 extern int git_config_get_pathname(const char *key, const char **dest);
2034 extern int git_config_get_untracked_cache(void);
2035 extern int git_config_get_split_index(void);
2036 extern int git_config_get_max_percent_split_change(void);
2037
2038 /* This dies if the configured or default date is in the future */
2039 extern int git_config_get_expiry(const char *key, const char **output);
2040
2041 /*
2042 * This is a hack for test programs like test-dump-untracked-cache to
2043 * ensure that they do not modify the untracked cache when reading it.
2044 * Do not use it otherwise!
2045 */
2046 extern int ignore_untracked_cache_config;
2047
2048 struct key_value_info {
2049 const char *filename;
2050 int linenr;
2051 enum config_origin_type origin_type;
2052 enum config_scope scope;
2053 };
2054
2055 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
2056 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
2057
2058 extern int committer_ident_sufficiently_given(void);
2059 extern int author_ident_sufficiently_given(void);
2060
2061 extern const char *git_commit_encoding;
2062 extern const char *git_log_output_encoding;
2063 extern const char *git_mailmap_file;
2064 extern const char *git_mailmap_blob;
2065
2066 /* IO helper functions */
2067 extern void maybe_flush_or_die(FILE *, const char *);
2068 __attribute__((format (printf, 2, 3)))
2069 extern void fprintf_or_die(FILE *, const char *fmt, ...);
2070
2071 #define COPY_READ_ERROR (-2)
2072 #define COPY_WRITE_ERROR (-3)
2073 extern int copy_fd(int ifd, int ofd);
2074 extern int copy_file(const char *dst, const char *src, int mode);
2075 extern int copy_file_with_time(const char *dst, const char *src, int mode);
2076
2077 extern void write_or_die(int fd, const void *buf, size_t count);
2078 extern void fsync_or_die(int fd, const char *);
2079
2080 extern ssize_t read_in_full(int fd, void *buf, size_t count);
2081 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
2082 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
2083
2084 static inline ssize_t write_str_in_full(int fd, const char *str)
2085 {
2086 return write_in_full(fd, str, strlen(str));
2087 }
2088
2089 /**
2090 * Open (and truncate) the file at path, write the contents of buf to it,
2091 * and close it. Dies if any errors are encountered.
2092 */
2093 extern void write_file_buf(const char *path, const char *buf, size_t len);
2094
2095 /**
2096 * Like write_file_buf(), but format the contents into a buffer first.
2097 * Additionally, write_file() will append a newline if one is not already
2098 * present, making it convenient to write text files:
2099 *
2100 * write_file(path, "counter: %d", ctr);
2101 */
2102 __attribute__((format (printf, 2, 3)))
2103 extern void write_file(const char *path, const char *fmt, ...);
2104
2105 /* pager.c */
2106 extern void setup_pager(void);
2107 extern int pager_in_use(void);
2108 extern int pager_use_color;
2109 extern int term_columns(void);
2110 extern int decimal_width(uintmax_t);
2111 extern int check_pager_config(const char *cmd);
2112 extern void prepare_pager_args(struct child_process *, const char *pager);
2113
2114 extern const char *editor_program;
2115 extern const char *askpass_program;
2116 extern const char *excludes_file;
2117
2118 /* base85 */
2119 int decode_85(char *dst, const char *line, int linelen);
2120 void encode_85(char *buf, const unsigned char *data, int bytes);
2121
2122 /* alloc.c */
2123 extern void *alloc_blob_node(void);
2124 extern void *alloc_tree_node(void);
2125 extern void *alloc_commit_node(void);
2126 extern void *alloc_tag_node(void);
2127 extern void *alloc_object_node(void);
2128 extern void alloc_report(void);
2129 extern unsigned int alloc_commit_index(void);
2130
2131 /* pkt-line.c */
2132 void packet_trace_identity(const char *prog);
2133
2134 /* add */
2135 /*
2136 * return 0 if success, 1 - if addition of a file failed and
2137 * ADD_FILES_IGNORE_ERRORS was specified in flags
2138 */
2139 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
2140
2141 /* diff.c */
2142 extern int diff_auto_refresh_index;
2143
2144 /* match-trees.c */
2145 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
2146 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
2147
2148 /*
2149 * whitespace rules.
2150 * used by both diff and apply
2151 * last two digits are tab width
2152 */
2153 #define WS_BLANK_AT_EOL 0100
2154 #define WS_SPACE_BEFORE_TAB 0200
2155 #define WS_INDENT_WITH_NON_TAB 0400
2156 #define WS_CR_AT_EOL 01000
2157 #define WS_BLANK_AT_EOF 02000
2158 #define WS_TAB_IN_INDENT 04000
2159 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
2160 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
2161 #define WS_TAB_WIDTH_MASK 077
2162 extern unsigned whitespace_rule_cfg;
2163 extern unsigned whitespace_rule(const char *);
2164 extern unsigned parse_whitespace_rule(const char *);
2165 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
2166 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
2167 extern char *whitespace_error_string(unsigned ws);
2168 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
2169 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
2170 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
2171
2172 /* ls-files */
2173 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
2174
2175 char *alias_lookup(const char *alias);
2176 int split_cmdline(char *cmdline, const char ***argv);
2177 /* Takes a negative value returned by split_cmdline */
2178 const char *split_cmdline_strerror(int cmdline_errno);
2179
2180 /* setup.c */
2181 struct startup_info {
2182 int have_repository;
2183 const char *prefix;
2184 };
2185 extern struct startup_info *startup_info;
2186
2187 /* merge.c */
2188 struct commit_list;
2189 int try_merge_command(const char *strategy, size_t xopts_nr,
2190 const char **xopts, struct commit_list *common,
2191 const char *head_arg, struct commit_list *remotes);
2192 int checkout_fast_forward(const unsigned char *from,
2193 const unsigned char *to,
2194 int overwrite_ignore);
2195
2196
2197 int sane_execvp(const char *file, char *const argv[]);
2198
2199 /*
2200 * A struct to encapsulate the concept of whether a file has changed
2201 * since we last checked it. This uses criteria similar to those used
2202 * for the index.
2203 */
2204 struct stat_validity {
2205 struct stat_data *sd;
2206 };
2207
2208 void stat_validity_clear(struct stat_validity *sv);
2209
2210 /*
2211 * Returns 1 if the path is a regular file (or a symlink to a regular
2212 * file) and matches the saved stat_validity, 0 otherwise. A missing
2213 * or inaccessible file is considered a match if the struct was just
2214 * initialized, or if the previous update found an inaccessible file.
2215 */
2216 int stat_validity_check(struct stat_validity *sv, const char *path);
2217
2218 /*
2219 * Update the stat_validity from a file opened at descriptor fd. If
2220 * the file is missing, inaccessible, or not a regular file, then
2221 * future calls to stat_validity_check will match iff one of those
2222 * conditions continues to be true.
2223 */
2224 void stat_validity_update(struct stat_validity *sv, int fd);
2225
2226 int versioncmp(const char *s1, const char *s2);
2227 void sleep_millisec(int millisec);
2228
2229 /*
2230 * Create a directory and (if share is nonzero) adjust its permissions
2231 * according to the shared_repository setting. Only use this for
2232 * directories under $GIT_DIR. Don't use it for working tree
2233 * directories.
2234 */
2235 void safe_create_dir(const char *dir, int share);
2236
2237 #endif /* CACHE_H */