Start post 2.11 cycle
[git.git] / cache.h
bloba50a61a19787de94daa9d66caa9fcccca58081fe
1 #ifndef CACHE_H
2 #define CACHE_H
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"
14 #include SHA1_HEADER
15 #ifndef platform_SHA_CTX
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.
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
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
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
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;
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);
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);
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)
69 struct object_id {
70 unsigned char hash[GIT_SHA1_RAWSZ];
73 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
74 #define DTYPE(de) ((de)->d_type)
75 #else
76 #undef DT_UNKNOWN
77 #undef DT_DIR
78 #undef DT_REG
79 #undef DT_LNK
80 #define DT_UNKNOWN 0
81 #define DT_DIR 1
82 #define DT_REG 2
83 #define DT_LNK 3
84 #define DTYPE(de) DT_UNKNOWN
85 #endif
87 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
88 #define S_IFINVALID 0030000
91 * A "directory link" is a link to another git directory.
93 * The value 0160000 is not normally a valid mode, and
94 * also just happens to be S_IFDIR + S_IFLNK
96 #define S_IFGITLINK 0160000
97 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
100 * Some mode bits are also used internally for computations.
102 * They *must* not overlap with any valid modes, and they *must* not be emitted
103 * to outside world - i.e. appear on disk or network. In other words, it's just
104 * temporary fields, which we internally use, but they have to stay in-house.
106 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
107 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
110 /* used internally in tree-diff */
111 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
115 * Intensive research over the course of many years has shown that
116 * port 9418 is totally unused by anything else. Or
118 * Your search - "port 9418" - did not match any documents.
120 * as www.google.com puts it.
122 * This port has been properly assigned for git use by IANA:
123 * git (Assigned-9418) [I06-050728-0001].
125 * git 9418/tcp git pack transfer service
126 * git 9418/udp git pack transfer service
128 * with Linus Torvalds <torvalds@osdl.org> as the point of
129 * contact. September 2005.
131 * See http://www.iana.org/assignments/port-numbers
133 #define DEFAULT_GIT_PORT 9418
136 * Basic data structures for the directory cache
139 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
140 struct cache_header {
141 uint32_t hdr_signature;
142 uint32_t hdr_version;
143 uint32_t hdr_entries;
146 #define INDEX_FORMAT_LB 2
147 #define INDEX_FORMAT_UB 4
150 * The "cache_time" is just the low 32 bits of the
151 * time. It doesn't matter if it overflows - we only
152 * check it for equality in the 32 bits we save.
154 struct cache_time {
155 uint32_t sec;
156 uint32_t nsec;
159 struct stat_data {
160 struct cache_time sd_ctime;
161 struct cache_time sd_mtime;
162 unsigned int sd_dev;
163 unsigned int sd_ino;
164 unsigned int sd_uid;
165 unsigned int sd_gid;
166 unsigned int sd_size;
169 struct cache_entry {
170 struct hashmap_entry ent;
171 struct stat_data ce_stat_data;
172 unsigned int ce_mode;
173 unsigned int ce_flags;
174 unsigned int ce_namelen;
175 unsigned int index; /* for link extension */
176 struct object_id oid;
177 char name[FLEX_ARRAY]; /* more */
180 #define CE_STAGEMASK (0x3000)
181 #define CE_EXTENDED (0x4000)
182 #define CE_VALID (0x8000)
183 #define CE_STAGESHIFT 12
186 * Range 0xFFFF0FFF in ce_flags is divided into
187 * two parts: in-memory flags and on-disk ones.
188 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
189 * if you want to save a new flag, add it in
190 * CE_EXTENDED_FLAGS
192 * In-memory only flags
194 #define CE_UPDATE (1 << 16)
195 #define CE_REMOVE (1 << 17)
196 #define CE_UPTODATE (1 << 18)
197 #define CE_ADDED (1 << 19)
199 #define CE_HASHED (1 << 20)
200 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
201 #define CE_CONFLICTED (1 << 23)
203 #define CE_UNPACKED (1 << 24)
204 #define CE_NEW_SKIP_WORKTREE (1 << 25)
206 /* used to temporarily mark paths matched by pathspecs */
207 #define CE_MATCHED (1 << 26)
209 #define CE_UPDATE_IN_BASE (1 << 27)
210 #define CE_STRIP_NAME (1 << 28)
213 * Extended on-disk flags
215 #define CE_INTENT_TO_ADD (1 << 29)
216 #define CE_SKIP_WORKTREE (1 << 30)
217 /* CE_EXTENDED2 is for future extension */
218 #define CE_EXTENDED2 (1U << 31)
220 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
223 * Safeguard to avoid saving wrong flags:
224 * - CE_EXTENDED2 won't get saved until its semantic is known
225 * - Bits in 0x0000FFFF have been saved in ce_flags already
226 * - Bits in 0x003F0000 are currently in-memory flags
228 #if CE_EXTENDED_FLAGS & 0x803FFFFF
229 #error "CE_EXTENDED_FLAGS out of range"
230 #endif
232 /* Forward structure decls */
233 struct pathspec;
234 struct child_process;
237 * Copy the sha1 and stat state of a cache entry from one to
238 * another. But we never change the name, or the hash state!
240 static inline void copy_cache_entry(struct cache_entry *dst,
241 const struct cache_entry *src)
243 unsigned int state = dst->ce_flags & CE_HASHED;
245 /* Don't copy hash chain and name */
246 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
247 offsetof(struct cache_entry, name) -
248 offsetof(struct cache_entry, ce_stat_data));
250 /* Restore the hash state */
251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
254 static inline unsigned create_ce_flags(unsigned stage)
256 return (stage << CE_STAGESHIFT);
259 #define ce_namelen(ce) ((ce)->ce_namelen)
260 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
261 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
262 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
263 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
264 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
265 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
267 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
268 static inline unsigned int create_ce_mode(unsigned int mode)
270 if (S_ISLNK(mode))
271 return S_IFLNK;
272 if (S_ISDIR(mode) || S_ISGITLINK(mode))
273 return S_IFGITLINK;
274 return S_IFREG | ce_permissions(mode);
276 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
277 unsigned int mode)
279 extern int trust_executable_bit, has_symlinks;
280 if (!has_symlinks && S_ISREG(mode) &&
281 ce && S_ISLNK(ce->ce_mode))
282 return ce->ce_mode;
283 if (!trust_executable_bit && S_ISREG(mode)) {
284 if (ce && S_ISREG(ce->ce_mode))
285 return ce->ce_mode;
286 return create_ce_mode(0666);
288 return create_ce_mode(mode);
290 static inline int ce_to_dtype(const struct cache_entry *ce)
292 unsigned ce_mode = ntohl(ce->ce_mode);
293 if (S_ISREG(ce_mode))
294 return DT_REG;
295 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
296 return DT_DIR;
297 else if (S_ISLNK(ce_mode))
298 return DT_LNK;
299 else
300 return DT_UNKNOWN;
302 static inline unsigned int canon_mode(unsigned int mode)
304 if (S_ISREG(mode))
305 return S_IFREG | ce_permissions(mode);
306 if (S_ISLNK(mode))
307 return S_IFLNK;
308 if (S_ISDIR(mode))
309 return S_IFDIR;
310 return S_IFGITLINK;
313 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
315 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
316 #define CE_ENTRY_CHANGED (1 << 1)
317 #define CE_ENTRY_REMOVED (1 << 2)
318 #define CE_ENTRY_ADDED (1 << 3)
319 #define RESOLVE_UNDO_CHANGED (1 << 4)
320 #define CACHE_TREE_CHANGED (1 << 5)
321 #define SPLIT_INDEX_ORDERED (1 << 6)
322 #define UNTRACKED_CHANGED (1 << 7)
324 struct split_index;
325 struct untracked_cache;
327 struct index_state {
328 struct cache_entry **cache;
329 unsigned int version;
330 unsigned int cache_nr, cache_alloc, cache_changed;
331 struct string_list *resolve_undo;
332 struct cache_tree *cache_tree;
333 struct split_index *split_index;
334 struct cache_time timestamp;
335 unsigned name_hash_initialized : 1,
336 initialized : 1;
337 struct hashmap name_hash;
338 struct hashmap dir_hash;
339 unsigned char sha1[20];
340 struct untracked_cache *untracked;
343 extern struct index_state the_index;
345 /* Name hashing */
346 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
347 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
348 extern void free_name_hash(struct index_state *istate);
351 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
352 #define active_cache (the_index.cache)
353 #define active_nr (the_index.cache_nr)
354 #define active_alloc (the_index.cache_alloc)
355 #define active_cache_changed (the_index.cache_changed)
356 #define active_cache_tree (the_index.cache_tree)
358 #define read_cache() read_index(&the_index)
359 #define read_cache_from(path) read_index_from(&the_index, (path))
360 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
361 #define is_cache_unborn() is_index_unborn(&the_index)
362 #define read_cache_unmerged() read_index_unmerged(&the_index)
363 #define discard_cache() discard_index(&the_index)
364 #define unmerged_cache() unmerged_index(&the_index)
365 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
366 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
367 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
368 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
369 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
370 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
371 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
372 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
373 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
374 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
375 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
376 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
377 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
378 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
379 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
380 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
381 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
382 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
383 #endif
385 enum object_type {
386 OBJ_BAD = -1,
387 OBJ_NONE = 0,
388 OBJ_COMMIT = 1,
389 OBJ_TREE = 2,
390 OBJ_BLOB = 3,
391 OBJ_TAG = 4,
392 /* 5 for future expansion */
393 OBJ_OFS_DELTA = 6,
394 OBJ_REF_DELTA = 7,
395 OBJ_ANY,
396 OBJ_MAX
399 static inline enum object_type object_type(unsigned int mode)
401 return S_ISDIR(mode) ? OBJ_TREE :
402 S_ISGITLINK(mode) ? OBJ_COMMIT :
403 OBJ_BLOB;
406 /* Double-check local_repo_env below if you add to this list. */
407 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
408 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
409 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
410 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
411 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
412 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
413 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
414 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
415 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
416 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
417 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
418 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
419 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
420 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
421 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
422 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
423 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
424 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
425 #define GITATTRIBUTES_FILE ".gitattributes"
426 #define INFOATTRIBUTES_FILE "info/attributes"
427 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
428 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
429 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
430 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
431 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
432 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
433 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
434 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
435 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
436 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
437 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
440 * This environment variable is expected to contain a boolean indicating
441 * whether we should or should not treat:
443 * GIT_DIR=foo.git git ...
445 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
446 * of this, but we use it internally to communicate to sub-processes that we
447 * are in a bare repo. If not set, defaults to true.
449 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
452 * Repository-local GIT_* environment variables; these will be cleared
453 * when git spawns a sub-process that runs inside another repository.
454 * The array is NULL-terminated, which makes it easy to pass in the "env"
455 * parameter of a run-command invocation, or to do a simple walk.
457 extern const char * const local_repo_env[];
460 * Returns true iff we have a configured git repository (either via
461 * setup_git_directory, or in the environment via $GIT_DIR).
463 int have_git_dir(void);
465 extern int is_bare_repository_cfg;
466 extern int is_bare_repository(void);
467 extern int is_inside_git_dir(void);
468 extern char *git_work_tree_cfg;
469 extern int is_inside_work_tree(void);
470 extern const char *get_git_dir(void);
471 extern const char *get_git_common_dir(void);
472 extern char *get_object_directory(void);
473 extern char *get_index_file(void);
474 extern char *get_graft_file(void);
475 extern int set_git_dir(const char *path);
476 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
477 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
478 extern const char *get_git_namespace(void);
479 extern const char *strip_namespace(const char *namespaced_ref);
480 extern const char *get_super_prefix(void);
481 extern const char *get_git_work_tree(void);
484 * Return true if the given path is a git directory; note that this _just_
485 * looks at the directory itself. If you want to know whether "foo/.git"
486 * is a repository, you must feed that path, not just "foo".
488 extern int is_git_directory(const char *path);
491 * Return 1 if the given path is the root of a git repository or
492 * submodule, else 0. Will not return 1 for bare repositories with the
493 * exception of creating a bare repository in "foo/.git" and calling
494 * is_git_repository("foo").
496 * If we run into read errors, we err on the side of saying "yes, it is",
497 * as we usually consider sub-repos precious, and would prefer to err on the
498 * side of not disrupting or deleting them.
500 extern int is_nonbare_repository_dir(struct strbuf *path);
502 #define READ_GITFILE_ERR_STAT_FAILED 1
503 #define READ_GITFILE_ERR_NOT_A_FILE 2
504 #define READ_GITFILE_ERR_OPEN_FAILED 3
505 #define READ_GITFILE_ERR_READ_FAILED 4
506 #define READ_GITFILE_ERR_INVALID_FORMAT 5
507 #define READ_GITFILE_ERR_NO_PATH 6
508 #define READ_GITFILE_ERR_NOT_A_REPO 7
509 #define READ_GITFILE_ERR_TOO_LARGE 8
510 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
511 #define read_gitfile(path) read_gitfile_gently((path), NULL)
512 extern const char *resolve_gitdir(const char *suspect);
513 extern void set_git_work_tree(const char *tree);
515 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
517 extern const char **get_pathspec(const char *prefix, const char **pathspec);
518 extern void setup_work_tree(void);
519 extern const char *setup_git_directory_gently(int *);
520 extern const char *setup_git_directory(void);
521 extern char *prefix_path(const char *prefix, int len, const char *path);
522 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
523 extern const char *prefix_filename(const char *prefix, int len, const char *path);
524 extern int check_filename(const char *prefix, const char *name);
525 extern void verify_filename(const char *prefix,
526 const char *name,
527 int diagnose_misspelt_rev);
528 extern void verify_non_filename(const char *prefix, const char *name);
529 extern int path_inside_repo(const char *prefix, const char *path);
531 #define INIT_DB_QUIET 0x0001
532 #define INIT_DB_EXIST_OK 0x0002
534 extern int init_db(const char *git_dir, const char *real_git_dir,
535 const char *template_dir, unsigned int flags);
537 extern void sanitize_stdfds(void);
538 extern int daemonize(void);
540 #define alloc_nr(x) (((x)+16)*3/2)
543 * Realloc the buffer pointed at by variable 'x' so that it can hold
544 * at least 'nr' entries; the number of entries currently allocated
545 * is 'alloc', using the standard growing factor alloc_nr() macro.
547 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
549 #define ALLOC_GROW(x, nr, alloc) \
550 do { \
551 if ((nr) > alloc) { \
552 if (alloc_nr(alloc) < (nr)) \
553 alloc = (nr); \
554 else \
555 alloc = alloc_nr(alloc); \
556 REALLOC_ARRAY(x, alloc); \
558 } while (0)
560 /* Initialize and use the cache information */
561 struct lock_file;
562 extern int read_index(struct index_state *);
563 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
564 extern int do_read_index(struct index_state *istate, const char *path,
565 int must_exist); /* for testting only! */
566 extern int read_index_from(struct index_state *, const char *path);
567 extern int is_index_unborn(struct index_state *);
568 extern int read_index_unmerged(struct index_state *);
569 #define COMMIT_LOCK (1 << 0)
570 #define CLOSE_LOCK (1 << 1)
571 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
572 extern int discard_index(struct index_state *);
573 extern int unmerged_index(const struct index_state *);
574 extern int verify_path(const char *path);
575 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
576 extern void adjust_dirname_case(struct index_state *istate, char *name);
577 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
578 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
579 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
580 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
581 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
582 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
583 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
584 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
585 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
586 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
587 extern int remove_index_entry_at(struct index_state *, int pos);
588 extern void remove_marked_cache_entries(struct index_state *istate);
589 extern int remove_file_from_index(struct index_state *, const char *path);
590 #define ADD_CACHE_VERBOSE 1
591 #define ADD_CACHE_PRETEND 2
592 #define ADD_CACHE_IGNORE_ERRORS 4
593 #define ADD_CACHE_IGNORE_REMOVAL 8
594 #define ADD_CACHE_INTENT 16
595 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
596 extern int add_file_to_index(struct index_state *, const char *path, int flags);
597 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
598 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
599 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
600 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
601 extern int index_name_is_other(const struct index_state *, const char *, int);
602 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
604 /* do stat comparison even if CE_VALID is true */
605 #define CE_MATCH_IGNORE_VALID 01
606 /* do not check the contents but report dirty on racily-clean entries */
607 #define CE_MATCH_RACY_IS_DIRTY 02
608 /* do stat comparison even if CE_SKIP_WORKTREE is true */
609 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
610 /* ignore non-existent files during stat update */
611 #define CE_MATCH_IGNORE_MISSING 0x08
612 /* enable stat refresh */
613 #define CE_MATCH_REFRESH 0x10
614 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
615 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
617 #define HASH_WRITE_OBJECT 1
618 #define HASH_FORMAT_CHECK 2
619 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
620 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
623 * Record to sd the data from st that we use to check whether a file
624 * might have changed.
626 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
629 * Return 0 if st is consistent with a file not having been changed
630 * since sd was filled. If there are differences, return a
631 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
632 * INODE_CHANGED, and DATA_CHANGED.
634 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
635 extern int match_stat_data_racy(const struct index_state *istate,
636 const struct stat_data *sd, struct stat *st);
638 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
640 #define REFRESH_REALLY 0x0001 /* ignore_valid */
641 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
642 #define REFRESH_QUIET 0x0004 /* be quiet about it */
643 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
644 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
645 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
646 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
647 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
649 extern void update_index_if_able(struct index_state *, struct lock_file *);
651 extern int hold_locked_index(struct lock_file *, int);
652 extern void set_alternate_index_output(const char *);
654 /* Environment bits from configuration mechanism */
655 extern int trust_executable_bit;
656 extern int trust_ctime;
657 extern int check_stat;
658 extern int quote_path_fully;
659 extern int has_symlinks;
660 extern int minimum_abbrev, default_abbrev;
661 extern int ignore_case;
662 extern int assume_unchanged;
663 extern int prefer_symlink_refs;
664 extern int log_all_ref_updates;
665 extern int warn_ambiguous_refs;
666 extern int warn_on_object_refname_ambiguity;
667 extern const char *apply_default_whitespace;
668 extern const char *apply_default_ignorewhitespace;
669 extern const char *git_attributes_file;
670 extern const char *git_hooks_path;
671 extern int zlib_compression_level;
672 extern int core_compression_level;
673 extern int core_compression_seen;
674 extern size_t packed_git_window_size;
675 extern size_t packed_git_limit;
676 extern size_t delta_base_cache_limit;
677 extern unsigned long big_file_threshold;
678 extern unsigned long pack_size_limit_cfg;
681 * Accessors for the core.sharedrepository config which lazy-load the value
682 * from the config (if not already set). The "reset" function can be
683 * used to unset "set" or cached value, meaning that the value will be loaded
684 * fresh from the config file on the next call to get_shared_repository().
686 void set_shared_repository(int value);
687 int get_shared_repository(void);
688 void reset_shared_repository(void);
691 * Do replace refs need to be checked this run? This variable is
692 * initialized to true unless --no-replace-object is used or
693 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
694 * commands that do not want replace references to be active. As an
695 * optimization it is also set to false if replace references have
696 * been sought but there were none.
698 extern int check_replace_refs;
699 extern char *git_replace_ref_base;
701 extern int fsync_object_files;
702 extern int core_preload_index;
703 extern int core_apply_sparse_checkout;
704 extern int precomposed_unicode;
705 extern int protect_hfs;
706 extern int protect_ntfs;
707 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
710 * Include broken refs in all ref iterations, which will
711 * generally choke dangerous operations rather than letting
712 * them silently proceed without taking the broken ref into
713 * account.
715 extern int ref_paranoia;
718 * The character that begins a commented line in user-editable file
719 * that is subject to stripspace.
721 extern char comment_line_char;
722 extern int auto_comment_line_char;
724 /* Windows only */
725 enum hide_dotfiles_type {
726 HIDE_DOTFILES_FALSE = 0,
727 HIDE_DOTFILES_TRUE,
728 HIDE_DOTFILES_DOTGITONLY
730 extern enum hide_dotfiles_type hide_dotfiles;
732 enum branch_track {
733 BRANCH_TRACK_UNSPECIFIED = -1,
734 BRANCH_TRACK_NEVER = 0,
735 BRANCH_TRACK_REMOTE,
736 BRANCH_TRACK_ALWAYS,
737 BRANCH_TRACK_EXPLICIT,
738 BRANCH_TRACK_OVERRIDE
741 enum rebase_setup_type {
742 AUTOREBASE_NEVER = 0,
743 AUTOREBASE_LOCAL,
744 AUTOREBASE_REMOTE,
745 AUTOREBASE_ALWAYS
748 enum push_default_type {
749 PUSH_DEFAULT_NOTHING = 0,
750 PUSH_DEFAULT_MATCHING,
751 PUSH_DEFAULT_SIMPLE,
752 PUSH_DEFAULT_UPSTREAM,
753 PUSH_DEFAULT_CURRENT,
754 PUSH_DEFAULT_UNSPECIFIED
757 extern enum branch_track git_branch_track;
758 extern enum rebase_setup_type autorebase;
759 extern enum push_default_type push_default;
761 enum object_creation_mode {
762 OBJECT_CREATION_USES_HARDLINKS = 0,
763 OBJECT_CREATION_USES_RENAMES = 1
766 extern enum object_creation_mode object_creation_mode;
768 extern char *notes_ref_name;
770 extern int grafts_replace_parents;
773 * GIT_REPO_VERSION is the version we write by default. The
774 * _READ variant is the highest number we know how to
775 * handle.
777 #define GIT_REPO_VERSION 0
778 #define GIT_REPO_VERSION_READ 1
779 extern int repository_format_precious_objects;
781 struct repository_format {
782 int version;
783 int precious_objects;
784 int is_bare;
785 char *work_tree;
786 struct string_list unknown_extensions;
790 * Read the repository format characteristics from the config file "path" into
791 * "format" struct. Returns the numeric version. On error, -1 is returned,
792 * format->version is set to -1, and all other fields in the struct are
793 * undefined.
795 int read_repository_format(struct repository_format *format, const char *path);
798 * Verify that the repository described by repository_format is something we
799 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
800 * any errors encountered.
802 int verify_repository_format(const struct repository_format *format,
803 struct strbuf *err);
806 * Check the repository format version in the path found in get_git_dir(),
807 * and die if it is a version we don't understand. Generally one would
808 * set_git_dir() before calling this, and use it only for "are we in a valid
809 * repo?".
811 extern void check_repository_format(void);
813 #define MTIME_CHANGED 0x0001
814 #define CTIME_CHANGED 0x0002
815 #define OWNER_CHANGED 0x0004
816 #define MODE_CHANGED 0x0008
817 #define INODE_CHANGED 0x0010
818 #define DATA_CHANGED 0x0020
819 #define TYPE_CHANGED 0x0040
822 * Return a statically allocated filename, either generically (mkpath), in
823 * the repository directory (git_path), or in a submodule's repository
824 * directory (git_path_submodule). In all cases, note that the result
825 * may be overwritten by another call to _any_ of the functions. Consider
826 * using the safer "dup" or "strbuf" formats below (in some cases, the
827 * unsafe versions have already been removed).
829 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
830 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
831 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
833 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
834 __attribute__((format (printf, 3, 4)));
835 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
836 __attribute__((format (printf, 2, 3)));
837 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
838 __attribute__((format (printf, 2, 3)));
839 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
840 __attribute__((format (printf, 2, 3)));
841 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
842 const char *fmt, ...)
843 __attribute__((format (printf, 3, 4)));
844 extern char *git_pathdup(const char *fmt, ...)
845 __attribute__((format (printf, 1, 2)));
846 extern char *mkpathdup(const char *fmt, ...)
847 __attribute__((format (printf, 1, 2)));
848 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
849 __attribute__((format (printf, 2, 3)));
851 extern void report_linked_checkout_garbage(void);
854 * You can define a static memoized git path like:
856 * static GIT_PATH_FUNC(git_path_foo, "FOO");
858 * or use one of the global ones below.
860 #define GIT_PATH_FUNC(func, filename) \
861 const char *func(void) \
863 static char *ret; \
864 if (!ret) \
865 ret = git_pathdup(filename); \
866 return ret; \
869 const char *git_path_cherry_pick_head(void);
870 const char *git_path_revert_head(void);
871 const char *git_path_squash_msg(void);
872 const char *git_path_merge_msg(void);
873 const char *git_path_merge_rr(void);
874 const char *git_path_merge_mode(void);
875 const char *git_path_merge_head(void);
876 const char *git_path_fetch_head(void);
877 const char *git_path_shallow(void);
880 * Return the name of the file in the local object database that would
881 * be used to store a loose object with the specified sha1. The
882 * return value is a pointer to a statically allocated buffer that is
883 * overwritten each time the function is called.
885 extern const char *sha1_file_name(const unsigned char *sha1);
888 * Return the name of the (local) packfile with the specified sha1 in
889 * its name. The return value is a pointer to memory that is
890 * overwritten each time this function is called.
892 extern char *sha1_pack_name(const unsigned char *sha1);
895 * Return the name of the (local) pack index file with the specified
896 * sha1 in its name. The return value is a pointer to memory that is
897 * overwritten each time this function is called.
899 extern char *sha1_pack_index_name(const unsigned char *sha1);
902 * Return an abbreviated sha1 unique within this repository's object database.
903 * The result will be at least `len` characters long, and will be NUL
904 * terminated.
906 * The non-`_r` version returns a static buffer which remains valid until 4
907 * more calls to find_unique_abbrev are made.
909 * The `_r` variant writes to a buffer supplied by the caller, which must be at
910 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
911 * written (excluding the NUL terminator).
913 * Note that while this version avoids the static buffer, it is not fully
914 * reentrant, as it calls into other non-reentrant git code.
916 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
917 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
919 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
920 extern const struct object_id null_oid;
922 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
924 int i;
926 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
927 if (*sha1 != *sha2)
928 return *sha1 - *sha2;
931 return 0;
934 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
936 return hashcmp(oid1->hash, oid2->hash);
939 static inline int is_null_sha1(const unsigned char *sha1)
941 return !hashcmp(sha1, null_sha1);
944 static inline int is_null_oid(const struct object_id *oid)
946 return !hashcmp(oid->hash, null_sha1);
949 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
951 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
954 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
956 hashcpy(dst->hash, src->hash);
959 static inline void hashclr(unsigned char *hash)
961 memset(hash, 0, GIT_SHA1_RAWSZ);
964 static inline void oidclr(struct object_id *oid)
966 hashclr(oid->hash);
970 #define EMPTY_TREE_SHA1_HEX \
971 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
972 #define EMPTY_TREE_SHA1_BIN_LITERAL \
973 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
974 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
975 extern const struct object_id empty_tree_oid;
976 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
978 #define EMPTY_BLOB_SHA1_HEX \
979 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
980 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
981 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
982 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
983 extern const struct object_id empty_blob_oid;
984 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
987 static inline int is_empty_blob_sha1(const unsigned char *sha1)
989 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
992 static inline int is_empty_blob_oid(const struct object_id *oid)
994 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
997 static inline int is_empty_tree_sha1(const unsigned char *sha1)
999 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1002 static inline int is_empty_tree_oid(const struct object_id *oid)
1004 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1008 int git_mkstemp(char *path, size_t n, const char *template);
1010 /* set default permissions by passing mode arguments to open(2) */
1011 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1012 int git_mkstemp_mode(char *pattern, int mode);
1015 * NOTE NOTE NOTE!!
1017 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1018 * not be changed. Old repositories have core.sharedrepository written in
1019 * numeric format, and therefore these values are preserved for compatibility
1020 * reasons.
1022 enum sharedrepo {
1023 PERM_UMASK = 0,
1024 OLD_PERM_GROUP = 1,
1025 OLD_PERM_EVERYBODY = 2,
1026 PERM_GROUP = 0660,
1027 PERM_EVERYBODY = 0664
1029 int git_config_perm(const char *var, const char *value);
1030 int adjust_shared_perm(const char *path);
1033 * Create the directory containing the named path, using care to be
1034 * somewhat safe against races. Return one of the scld_error values
1035 * to indicate success/failure.
1037 * SCLD_VANISHED indicates that one of the ancestor directories of the
1038 * path existed at one point during the function call and then
1039 * suddenly vanished, probably because another process pruned the
1040 * directory while we were working. To be robust against this kind of
1041 * race, callers might want to try invoking the function again when it
1042 * returns SCLD_VANISHED.
1044 * safe_create_leading_directories() temporarily changes path while it
1045 * is working but restores it before returning.
1046 * safe_create_leading_directories_const() doesn't modify path, even
1047 * temporarily.
1049 enum scld_error {
1050 SCLD_OK = 0,
1051 SCLD_FAILED = -1,
1052 SCLD_PERMS = -2,
1053 SCLD_EXISTS = -3,
1054 SCLD_VANISHED = -4
1056 enum scld_error safe_create_leading_directories(char *path);
1057 enum scld_error safe_create_leading_directories_const(const char *path);
1059 int mkdir_in_gitdir(const char *path);
1060 extern char *expand_user_path(const char *path);
1061 const char *enter_repo(const char *path, int strict);
1062 static inline int is_absolute_path(const char *path)
1064 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1066 int is_directory(const char *);
1067 const char *real_path(const char *path);
1068 const char *real_path_if_valid(const char *path);
1069 const char *absolute_path(const char *path);
1070 const char *remove_leading_path(const char *in, const char *prefix);
1071 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1072 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1073 int normalize_path_copy(char *dst, const char *src);
1074 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1075 char *strip_path_suffix(const char *path, const char *suffix);
1076 int daemon_avoid_alias(const char *path);
1077 extern int is_ntfs_dotgit(const char *name);
1080 * Return a newly allocated string with the evaluation of
1081 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1082 * "$HOME/.config/git/$filename". Return NULL upon error.
1084 extern char *xdg_config_home(const char *filename);
1086 /* object replacement */
1087 #define LOOKUP_REPLACE_OBJECT 1
1088 #define LOOKUP_UNKNOWN_OBJECT 2
1089 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1090 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1092 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1096 * This internal function is only declared here for the benefit of
1097 * lookup_replace_object(). Please do not call it directly.
1099 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1102 * If object sha1 should be replaced, return the replacement object's
1103 * name (replaced recursively, if necessary). The return value is
1104 * either sha1 or a pointer to a permanently-allocated value. When
1105 * object replacement is suppressed, always return sha1.
1107 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1109 if (!check_replace_refs)
1110 return sha1;
1111 return do_lookup_replace_object(sha1);
1114 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1116 if (!(flag & LOOKUP_REPLACE_OBJECT))
1117 return sha1;
1118 return lookup_replace_object(sha1);
1121 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1122 extern int sha1_object_info(const unsigned char *, unsigned long *);
1123 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1124 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1125 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1126 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1127 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1128 extern int git_open(const char *name);
1129 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1130 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1131 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1133 /* global flag to enable extra checks when accessing packed objects */
1134 extern int do_check_packed_object_crc;
1136 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1138 extern int finalize_object_file(const char *tmpfile, const char *filename);
1140 extern int has_sha1_pack(const unsigned char *sha1);
1143 * Return true iff we have an object named sha1, whether local or in
1144 * an alternate object database, and whether packed or loose. This
1145 * function does not respect replace references.
1147 * If the QUICK flag is set, do not re-check the pack directory
1148 * when we cannot find the object (this means we may give a false
1149 * negative answer if another process is simultaneously repacking).
1151 #define HAS_SHA1_QUICK 0x1
1152 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1153 static inline int has_sha1_file(const unsigned char *sha1)
1155 return has_sha1_file_with_flags(sha1, 0);
1158 /* Same as the above, except for struct object_id. */
1159 extern int has_object_file(const struct object_id *oid);
1160 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1163 * Return true iff an alternate object database has a loose object
1164 * with the specified name. This function does not respect replace
1165 * references.
1167 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1169 extern int has_pack_index(const unsigned char *sha1);
1171 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1173 extern const signed char hexval_table[256];
1174 static inline unsigned int hexval(unsigned char c)
1176 return hexval_table[c];
1180 * Convert two consecutive hexadecimal digits into a char. Return a
1181 * negative value on error. Don't run over the end of short strings.
1183 static inline int hex2chr(const char *s)
1185 int val = hexval(s[0]);
1186 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1189 /* Convert to/from hex/sha1 representation */
1190 #define MINIMUM_ABBREV minimum_abbrev
1191 #define DEFAULT_ABBREV default_abbrev
1193 /* used when the code does not know or care what the default abbrev is */
1194 #define FALLBACK_DEFAULT_ABBREV 7
1196 struct object_context {
1197 unsigned char tree[20];
1198 char path[PATH_MAX];
1199 unsigned mode;
1201 * symlink_path is only used by get_tree_entry_follow_symlinks,
1202 * and only for symlinks that point outside the repository.
1204 struct strbuf symlink_path;
1207 #define GET_SHA1_QUIETLY 01
1208 #define GET_SHA1_COMMIT 02
1209 #define GET_SHA1_COMMITTISH 04
1210 #define GET_SHA1_TREE 010
1211 #define GET_SHA1_TREEISH 020
1212 #define GET_SHA1_BLOB 040
1213 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1214 #define GET_SHA1_ONLY_TO_DIE 04000
1216 #define GET_SHA1_DISAMBIGUATORS \
1217 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1218 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1219 GET_SHA1_BLOB)
1221 extern int get_sha1(const char *str, unsigned char *sha1);
1222 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1223 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1224 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1225 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1226 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1227 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1228 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1230 extern int get_oid(const char *str, struct object_id *oid);
1232 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1233 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1235 extern int set_disambiguate_hint_config(const char *var, const char *value);
1238 * Try to read a SHA1 in hexadecimal format from the 40 characters
1239 * starting at hex. Write the 20-byte result to sha1 in binary form.
1240 * Return 0 on success. Reading stops if a NUL is encountered in the
1241 * input, so it is safe to pass this function an arbitrary
1242 * null-terminated string.
1244 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1245 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1248 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1249 * and writes the NUL-terminated output to the buffer `out`, which must be at
1250 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1251 * convenience.
1253 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1254 * buffers, making it safe to make multiple calls for a single statement, like:
1256 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1258 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1259 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1260 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1261 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1263 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1264 extern int get_oid_mb(const char *str, struct object_id *oid);
1266 extern int validate_headref(const char *ref);
1268 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1269 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1270 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1271 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1273 extern void *read_object_with_reference(const unsigned char *sha1,
1274 const char *required_type,
1275 unsigned long *size,
1276 unsigned char *sha1_ret);
1278 extern struct object *peel_to_type(const char *name, int namelen,
1279 struct object *o, enum object_type);
1281 struct date_mode {
1282 enum date_mode_type {
1283 DATE_NORMAL = 0,
1284 DATE_RELATIVE,
1285 DATE_SHORT,
1286 DATE_ISO8601,
1287 DATE_ISO8601_STRICT,
1288 DATE_RFC2822,
1289 DATE_STRFTIME,
1290 DATE_RAW,
1291 DATE_UNIX
1292 } type;
1293 const char *strftime_fmt;
1294 int local;
1298 * Convenience helper for passing a constant type, like:
1300 * show_date(t, tz, DATE_MODE(NORMAL));
1302 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1303 struct date_mode *date_mode_from_type(enum date_mode_type type);
1305 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1306 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1307 struct strbuf *timebuf);
1308 int parse_date(const char *date, struct strbuf *out);
1309 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1310 int parse_expiry_date(const char *date, unsigned long *timestamp);
1311 void datestamp(struct strbuf *out);
1312 #define approxidate(s) approxidate_careful((s), NULL)
1313 unsigned long approxidate_careful(const char *, int *);
1314 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1315 void parse_date_format(const char *format, struct date_mode *mode);
1316 int date_overflows(unsigned long date);
1318 #define IDENT_STRICT 1
1319 #define IDENT_NO_DATE 2
1320 #define IDENT_NO_NAME 4
1321 extern const char *git_author_info(int);
1322 extern const char *git_committer_info(int);
1323 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1324 extern const char *fmt_name(const char *name, const char *email);
1325 extern const char *ident_default_name(void);
1326 extern const char *ident_default_email(void);
1327 extern const char *git_editor(void);
1328 extern const char *git_pager(int stdout_is_tty);
1329 extern int git_ident_config(const char *, const char *, void *);
1330 extern void reset_ident_date(void);
1332 struct ident_split {
1333 const char *name_begin;
1334 const char *name_end;
1335 const char *mail_begin;
1336 const char *mail_end;
1337 const char *date_begin;
1338 const char *date_end;
1339 const char *tz_begin;
1340 const char *tz_end;
1343 * Signals an success with 0, but time part of the result may be NULL
1344 * if the input lacks timestamp and zone
1346 extern int split_ident_line(struct ident_split *, const char *, int);
1349 * Like show_date, but pull the timestamp and tz parameters from
1350 * the ident_split. It will also sanity-check the values and produce
1351 * a well-known sentinel date if they appear bogus.
1353 const char *show_ident_date(const struct ident_split *id,
1354 const struct date_mode *mode);
1357 * Compare split idents for equality or strict ordering. Note that we
1358 * compare only the ident part of the line, ignoring any timestamp.
1360 * Because there are two fields, we must choose one as the primary key; we
1361 * currently arbitrarily pick the email.
1363 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1365 struct checkout {
1366 struct index_state *istate;
1367 const char *base_dir;
1368 int base_dir_len;
1369 unsigned force:1,
1370 quiet:1,
1371 not_new:1,
1372 refresh_cache:1;
1374 #define CHECKOUT_INIT { NULL, "" }
1376 #define TEMPORARY_FILENAME_LENGTH 25
1377 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1379 struct cache_def {
1380 struct strbuf path;
1381 int flags;
1382 int track_flags;
1383 int prefix_len_stat_func;
1385 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1386 static inline void cache_def_clear(struct cache_def *cache)
1388 strbuf_release(&cache->path);
1391 extern int has_symlink_leading_path(const char *name, int len);
1392 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1393 extern int check_leading_path(const char *name, int len);
1394 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1395 extern void schedule_dir_for_removal(const char *name, int len);
1396 extern void remove_scheduled_dirs(void);
1398 extern struct alternate_object_database {
1399 struct alternate_object_database *next;
1401 /* see alt_scratch_buf() */
1402 struct strbuf scratch;
1403 size_t base_len;
1405 char path[FLEX_ARRAY];
1406 } *alt_odb_list;
1407 extern void prepare_alt_odb(void);
1408 extern void read_info_alternates(const char * relative_base, int depth);
1409 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1410 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1411 extern int foreach_alt_odb(alt_odb_fn, void*);
1414 * Allocate a "struct alternate_object_database" but do _not_ actually
1415 * add it to the list of alternates.
1417 struct alternate_object_database *alloc_alt_odb(const char *dir);
1420 * Add the directory to the on-disk alternates file; the new entry will also
1421 * take effect in the current process.
1423 extern void add_to_alternates_file(const char *dir);
1426 * Add the directory to the in-memory list of alternates (along with any
1427 * recursive alternates it points to), but do not modify the on-disk alternates
1428 * file.
1430 extern void add_to_alternates_memory(const char *dir);
1433 * Returns a scratch strbuf pre-filled with the alternate object directory,
1434 * including a trailing slash, which can be used to access paths in the
1435 * alternate. Always use this over direct access to alt->scratch, as it
1436 * cleans up any previous use of the scratch buffer.
1438 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1440 struct pack_window {
1441 struct pack_window *next;
1442 unsigned char *base;
1443 off_t offset;
1444 size_t len;
1445 unsigned int last_used;
1446 unsigned int inuse_cnt;
1449 extern struct packed_git {
1450 struct packed_git *next;
1451 struct pack_window *windows;
1452 off_t pack_size;
1453 const void *index_data;
1454 size_t index_size;
1455 uint32_t num_objects;
1456 uint32_t num_bad_objects;
1457 unsigned char *bad_object_sha1;
1458 int index_version;
1459 time_t mtime;
1460 int pack_fd;
1461 unsigned pack_local:1,
1462 pack_keep:1,
1463 freshened:1,
1464 do_not_close:1;
1465 unsigned char sha1[20];
1466 struct revindex_entry *revindex;
1467 /* something like ".git/objects/pack/xxxxx.pack" */
1468 char pack_name[FLEX_ARRAY]; /* more */
1469 } *packed_git;
1472 * A most-recently-used ordered version of the packed_git list, which can
1473 * be iterated instead of packed_git (and marked via mru_mark).
1475 struct mru;
1476 extern struct mru *packed_git_mru;
1478 struct pack_entry {
1479 off_t offset;
1480 unsigned char sha1[20];
1481 struct packed_git *p;
1484 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1486 /* A hook to report invalid files in pack directory */
1487 #define PACKDIR_FILE_PACK 1
1488 #define PACKDIR_FILE_IDX 2
1489 #define PACKDIR_FILE_GARBAGE 4
1490 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1492 extern void prepare_packed_git(void);
1493 extern void reprepare_packed_git(void);
1494 extern void install_packed_git(struct packed_git *pack);
1497 * Give a rough count of objects in the repository. This sacrifices accuracy
1498 * for speed.
1500 unsigned long approximate_object_count(void);
1502 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1503 struct packed_git *packs);
1505 extern void pack_report(void);
1508 * mmap the index file for the specified packfile (if it is not
1509 * already mmapped). Return 0 on success.
1511 extern int open_pack_index(struct packed_git *);
1514 * munmap the index file for the specified packfile (if it is
1515 * currently mmapped).
1517 extern void close_pack_index(struct packed_git *);
1519 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1520 extern void close_pack_windows(struct packed_git *);
1521 extern void close_all_packs(void);
1522 extern void unuse_pack(struct pack_window **);
1523 extern void clear_delta_base_cache(void);
1524 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1527 * Make sure that a pointer access into an mmap'd index file is within bounds,
1528 * and can provide at least 8 bytes of data.
1530 * Note that this is only necessary for variable-length segments of the file
1531 * (like the 64-bit extended offset table), as we compare the size to the
1532 * fixed-length parts when we open the file.
1534 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1537 * Return the SHA-1 of the nth object within the specified packfile.
1538 * Open the index if it is not already open. The return value points
1539 * at the SHA-1 within the mmapped index. Return NULL if there is an
1540 * error.
1542 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1545 * Return the offset of the nth object within the specified packfile.
1546 * The index must already be opened.
1548 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1551 * If the object named sha1 is present in the specified packfile,
1552 * return its offset within the packfile; otherwise, return 0.
1554 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1556 extern int is_pack_valid(struct packed_git *);
1557 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1558 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1559 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1560 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1563 * Iterate over the files in the loose-object parts of the object
1564 * directory "path", triggering the following callbacks:
1566 * - loose_object is called for each loose object we find.
1568 * - loose_cruft is called for any files that do not appear to be
1569 * loose objects. Note that we only look in the loose object
1570 * directories "objects/[0-9a-f]{2}/", so we will not report
1571 * "objects/foobar" as cruft.
1573 * - loose_subdir is called for each top-level hashed subdirectory
1574 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1575 * after the objects in the directory are processed.
1577 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1578 * will end the iteration.
1580 * In the "buf" variant, "path" is a strbuf which will also be used as a
1581 * scratch buffer, but restored to its original contents before
1582 * the function returns.
1584 typedef int each_loose_object_fn(const unsigned char *sha1,
1585 const char *path,
1586 void *data);
1587 typedef int each_loose_cruft_fn(const char *basename,
1588 const char *path,
1589 void *data);
1590 typedef int each_loose_subdir_fn(int nr,
1591 const char *path,
1592 void *data);
1593 int for_each_loose_file_in_objdir(const char *path,
1594 each_loose_object_fn obj_cb,
1595 each_loose_cruft_fn cruft_cb,
1596 each_loose_subdir_fn subdir_cb,
1597 void *data);
1598 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1599 each_loose_object_fn obj_cb,
1600 each_loose_cruft_fn cruft_cb,
1601 each_loose_subdir_fn subdir_cb,
1602 void *data);
1605 * Iterate over loose and packed objects in both the local
1606 * repository and any alternates repositories (unless the
1607 * LOCAL_ONLY flag is set).
1609 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1610 typedef int each_packed_object_fn(const unsigned char *sha1,
1611 struct packed_git *pack,
1612 uint32_t pos,
1613 void *data);
1614 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1615 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1617 struct object_info {
1618 /* Request */
1619 enum object_type *typep;
1620 unsigned long *sizep;
1621 off_t *disk_sizep;
1622 unsigned char *delta_base_sha1;
1623 struct strbuf *typename;
1625 /* Response */
1626 enum {
1627 OI_CACHED,
1628 OI_LOOSE,
1629 OI_PACKED,
1630 OI_DBCACHED
1631 } whence;
1632 union {
1634 * struct {
1635 * ... Nothing to expose in this case
1636 * } cached;
1637 * struct {
1638 * ... Nothing to expose in this case
1639 * } loose;
1641 struct {
1642 struct packed_git *pack;
1643 off_t offset;
1644 unsigned int is_delta;
1645 } packed;
1646 } u;
1650 * Initializer for a "struct object_info" that wants no items. You may
1651 * also memset() the memory to all-zeroes.
1653 #define OBJECT_INFO_INIT {NULL}
1655 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1656 extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
1658 /* Dumb servers support */
1659 extern int update_server_info(int);
1661 /* git_config_parse_key() returns these negated: */
1662 #define CONFIG_INVALID_KEY 1
1663 #define CONFIG_NO_SECTION_OR_NAME 2
1664 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1665 #define CONFIG_NO_LOCK -1
1666 #define CONFIG_INVALID_FILE 3
1667 #define CONFIG_NO_WRITE 4
1668 #define CONFIG_NOTHING_SET 5
1669 #define CONFIG_INVALID_PATTERN 6
1670 #define CONFIG_GENERIC_ERROR 7
1672 #define CONFIG_REGEX_NONE ((void *)1)
1674 struct git_config_source {
1675 unsigned int use_stdin:1;
1676 const char *file;
1677 const char *blob;
1680 enum config_origin_type {
1681 CONFIG_ORIGIN_BLOB,
1682 CONFIG_ORIGIN_FILE,
1683 CONFIG_ORIGIN_STDIN,
1684 CONFIG_ORIGIN_SUBMODULE_BLOB,
1685 CONFIG_ORIGIN_CMDLINE
1688 typedef int (*config_fn_t)(const char *, const char *, void *);
1689 extern int git_default_config(const char *, const char *, void *);
1690 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1691 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1692 const char *name, const char *buf, size_t len, void *data);
1693 extern void git_config_push_parameter(const char *text);
1694 extern int git_config_from_parameters(config_fn_t fn, void *data);
1695 extern void git_config(config_fn_t fn, void *);
1696 extern int git_config_with_options(config_fn_t fn, void *,
1697 struct git_config_source *config_source,
1698 int respect_includes);
1699 extern int git_parse_ulong(const char *, unsigned long *);
1700 extern int git_parse_maybe_bool(const char *);
1701 extern int git_config_int(const char *, const char *);
1702 extern int64_t git_config_int64(const char *, const char *);
1703 extern unsigned long git_config_ulong(const char *, const char *);
1704 extern int git_config_bool_or_int(const char *, const char *, int *);
1705 extern int git_config_bool(const char *, const char *);
1706 extern int git_config_maybe_bool(const char *, const char *);
1707 extern int git_config_string(const char **, const char *, const char *);
1708 extern int git_config_pathname(const char **, const char *, const char *);
1709 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1710 extern void git_config_set_in_file(const char *, const char *, const char *);
1711 extern int git_config_set_gently(const char *, const char *);
1712 extern void git_config_set(const char *, const char *);
1713 extern int git_config_parse_key(const char *, char **, int *);
1714 extern int git_config_key_is_valid(const char *key);
1715 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1716 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1717 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1718 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1719 extern int git_config_rename_section(const char *, const char *);
1720 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1721 extern const char *git_etc_gitconfig(void);
1722 extern int git_env_bool(const char *, int);
1723 extern unsigned long git_env_ulong(const char *, unsigned long);
1724 extern int git_config_system(void);
1725 extern int config_error_nonbool(const char *);
1726 #if defined(__GNUC__)
1727 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1728 #endif
1729 extern const char *get_log_output_encoding(void);
1730 extern const char *get_commit_output_encoding(void);
1732 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1734 enum config_scope {
1735 CONFIG_SCOPE_UNKNOWN = 0,
1736 CONFIG_SCOPE_SYSTEM,
1737 CONFIG_SCOPE_GLOBAL,
1738 CONFIG_SCOPE_REPO,
1739 CONFIG_SCOPE_CMDLINE,
1742 extern enum config_scope current_config_scope(void);
1743 extern const char *current_config_origin_type(void);
1744 extern const char *current_config_name(void);
1746 struct config_include_data {
1747 int depth;
1748 config_fn_t fn;
1749 void *data;
1751 #define CONFIG_INCLUDE_INIT { 0 }
1752 extern int git_config_include(const char *name, const char *value, void *data);
1755 * Match and parse a config key of the form:
1757 * section.(subsection.)?key
1759 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1760 * we return -1 if it does not match, 0 otherwise. The subsection and key
1761 * out-parameters are filled by the function (and subsection is NULL if it is
1762 * missing).
1764 extern int parse_config_key(const char *var,
1765 const char *section,
1766 const char **subsection, int *subsection_len,
1767 const char **key);
1769 struct config_set_element {
1770 struct hashmap_entry ent;
1771 char *key;
1772 struct string_list value_list;
1775 struct configset_list_item {
1776 struct config_set_element *e;
1777 int value_index;
1781 * the contents of the list are ordered according to their
1782 * position in the config files and order of parsing the files.
1783 * (i.e. key-value pair at the last position of .git/config will
1784 * be at the last item of the list)
1786 struct configset_list {
1787 struct configset_list_item *items;
1788 unsigned int nr, alloc;
1791 struct config_set {
1792 struct hashmap config_hash;
1793 int hash_initialized;
1794 struct configset_list list;
1797 extern void git_configset_init(struct config_set *cs);
1798 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1799 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1800 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1801 extern void git_configset_clear(struct config_set *cs);
1802 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1803 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1804 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1805 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1806 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1807 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1808 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1809 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1811 extern int git_config_get_value(const char *key, const char **value);
1812 extern const struct string_list *git_config_get_value_multi(const char *key);
1813 extern void git_config_clear(void);
1814 extern void git_config_iter(config_fn_t fn, void *data);
1815 extern int git_config_get_string_const(const char *key, const char **dest);
1816 extern int git_config_get_string(const char *key, char **dest);
1817 extern int git_config_get_int(const char *key, int *dest);
1818 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1819 extern int git_config_get_bool(const char *key, int *dest);
1820 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1821 extern int git_config_get_maybe_bool(const char *key, int *dest);
1822 extern int git_config_get_pathname(const char *key, const char **dest);
1823 extern int git_config_get_untracked_cache(void);
1826 * This is a hack for test programs like test-dump-untracked-cache to
1827 * ensure that they do not modify the untracked cache when reading it.
1828 * Do not use it otherwise!
1830 extern int ignore_untracked_cache_config;
1832 struct key_value_info {
1833 const char *filename;
1834 int linenr;
1835 enum config_origin_type origin_type;
1836 enum config_scope scope;
1839 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1840 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1842 extern int committer_ident_sufficiently_given(void);
1843 extern int author_ident_sufficiently_given(void);
1845 extern const char *git_commit_encoding;
1846 extern const char *git_log_output_encoding;
1847 extern const char *git_mailmap_file;
1848 extern const char *git_mailmap_blob;
1850 /* IO helper functions */
1851 extern void maybe_flush_or_die(FILE *, const char *);
1852 __attribute__((format (printf, 2, 3)))
1853 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1855 #define COPY_READ_ERROR (-2)
1856 #define COPY_WRITE_ERROR (-3)
1857 extern int copy_fd(int ifd, int ofd);
1858 extern int copy_file(const char *dst, const char *src, int mode);
1859 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1861 extern void write_or_die(int fd, const void *buf, size_t count);
1862 extern void fsync_or_die(int fd, const char *);
1864 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1865 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1866 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1868 static inline ssize_t write_str_in_full(int fd, const char *str)
1870 return write_in_full(fd, str, strlen(str));
1874 * Open (and truncate) the file at path, write the contents of buf to it,
1875 * and close it. Dies if any errors are encountered.
1877 extern void write_file_buf(const char *path, const char *buf, size_t len);
1880 * Like write_file_buf(), but format the contents into a buffer first.
1881 * Additionally, write_file() will append a newline if one is not already
1882 * present, making it convenient to write text files:
1884 * write_file(path, "counter: %d", ctr);
1886 __attribute__((format (printf, 2, 3)))
1887 extern void write_file(const char *path, const char *fmt, ...);
1889 /* pager.c */
1890 extern void setup_pager(void);
1891 extern int pager_in_use(void);
1892 extern int pager_use_color;
1893 extern int term_columns(void);
1894 extern int decimal_width(uintmax_t);
1895 extern int check_pager_config(const char *cmd);
1896 extern void prepare_pager_args(struct child_process *, const char *pager);
1898 extern const char *editor_program;
1899 extern const char *askpass_program;
1900 extern const char *excludes_file;
1902 /* base85 */
1903 int decode_85(char *dst, const char *line, int linelen);
1904 void encode_85(char *buf, const unsigned char *data, int bytes);
1906 /* alloc.c */
1907 extern void *alloc_blob_node(void);
1908 extern void *alloc_tree_node(void);
1909 extern void *alloc_commit_node(void);
1910 extern void *alloc_tag_node(void);
1911 extern void *alloc_object_node(void);
1912 extern void alloc_report(void);
1913 extern unsigned int alloc_commit_index(void);
1915 /* pkt-line.c */
1916 void packet_trace_identity(const char *prog);
1918 /* add */
1920 * return 0 if success, 1 - if addition of a file failed and
1921 * ADD_FILES_IGNORE_ERRORS was specified in flags
1923 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1925 /* diff.c */
1926 extern int diff_auto_refresh_index;
1928 /* match-trees.c */
1929 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1930 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1933 * whitespace rules.
1934 * used by both diff and apply
1935 * last two digits are tab width
1937 #define WS_BLANK_AT_EOL 0100
1938 #define WS_SPACE_BEFORE_TAB 0200
1939 #define WS_INDENT_WITH_NON_TAB 0400
1940 #define WS_CR_AT_EOL 01000
1941 #define WS_BLANK_AT_EOF 02000
1942 #define WS_TAB_IN_INDENT 04000
1943 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1944 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1945 #define WS_TAB_WIDTH_MASK 077
1946 extern unsigned whitespace_rule_cfg;
1947 extern unsigned whitespace_rule(const char *);
1948 extern unsigned parse_whitespace_rule(const char *);
1949 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1950 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1951 extern char *whitespace_error_string(unsigned ws);
1952 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1953 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1954 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1956 /* ls-files */
1957 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1959 char *alias_lookup(const char *alias);
1960 int split_cmdline(char *cmdline, const char ***argv);
1961 /* Takes a negative value returned by split_cmdline */
1962 const char *split_cmdline_strerror(int cmdline_errno);
1964 /* setup.c */
1965 struct startup_info {
1966 int have_repository;
1967 const char *prefix;
1969 extern struct startup_info *startup_info;
1971 /* merge.c */
1972 struct commit_list;
1973 int try_merge_command(const char *strategy, size_t xopts_nr,
1974 const char **xopts, struct commit_list *common,
1975 const char *head_arg, struct commit_list *remotes);
1976 int checkout_fast_forward(const unsigned char *from,
1977 const unsigned char *to,
1978 int overwrite_ignore);
1981 int sane_execvp(const char *file, char *const argv[]);
1984 * A struct to encapsulate the concept of whether a file has changed
1985 * since we last checked it. This uses criteria similar to those used
1986 * for the index.
1988 struct stat_validity {
1989 struct stat_data *sd;
1992 void stat_validity_clear(struct stat_validity *sv);
1995 * Returns 1 if the path is a regular file (or a symlink to a regular
1996 * file) and matches the saved stat_validity, 0 otherwise. A missing
1997 * or inaccessible file is considered a match if the struct was just
1998 * initialized, or if the previous update found an inaccessible file.
2000 int stat_validity_check(struct stat_validity *sv, const char *path);
2003 * Update the stat_validity from a file opened at descriptor fd. If
2004 * the file is missing, inaccessible, or not a regular file, then
2005 * future calls to stat_validity_check will match iff one of those
2006 * conditions continues to be true.
2008 void stat_validity_update(struct stat_validity *sv, int fd);
2010 int versioncmp(const char *s1, const char *s2);
2011 void sleep_millisec(int millisec);
2014 * Create a directory and (if share is nonzero) adjust its permissions
2015 * according to the shared_repository setting. Only use this for
2016 * directories under $GIT_DIR. Don't use it for working tree
2017 * directories.
2019 void safe_create_dir(const char *dir, int share);
2021 #endif /* CACHE_H */