Merge branch 'jt/http-redact-cookies' into maint
[git.git] / cache.h
blobd8b975a5715e8a5ec7c32e176958725cba61d67a
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "mru.h"
8 #include "advice.h"
9 #include "gettext.h"
10 #include "convert.h"
11 #include "trace.h"
12 #include "string-list.h"
13 #include "pack-revindex.h"
14 #include "hash.h"
15 #include "path.h"
16 #include "sha1-array.h"
17 #include "repository.h"
19 #ifndef platform_SHA_CTX
21 * platform's underlying implementation of SHA-1; could be OpenSSL,
22 * blk_SHA, Apple CommonCrypto, etc... Note that including
23 * SHA1_HEADER may have already defined platform_SHA_CTX for our
24 * own implementations like block-sha1 and ppc-sha1, so we list
25 * the default for OpenSSL compatible SHA-1 implementations here.
27 #define platform_SHA_CTX SHA_CTX
28 #define platform_SHA1_Init SHA1_Init
29 #define platform_SHA1_Update SHA1_Update
30 #define platform_SHA1_Final SHA1_Final
31 #endif
33 #define git_SHA_CTX platform_SHA_CTX
34 #define git_SHA1_Init platform_SHA1_Init
35 #define git_SHA1_Update platform_SHA1_Update
36 #define git_SHA1_Final platform_SHA1_Final
38 #ifdef SHA1_MAX_BLOCK_SIZE
39 #include "compat/sha1-chunked.h"
40 #undef git_SHA1_Update
41 #define git_SHA1_Update git_SHA1_Update_Chunked
42 #endif
44 #include <zlib.h>
45 typedef struct git_zstream {
46 z_stream z;
47 unsigned long avail_in;
48 unsigned long avail_out;
49 unsigned long total_in;
50 unsigned long total_out;
51 unsigned char *next_in;
52 unsigned char *next_out;
53 } git_zstream;
55 void git_inflate_init(git_zstream *);
56 void git_inflate_init_gzip_only(git_zstream *);
57 void git_inflate_end(git_zstream *);
58 int git_inflate(git_zstream *, int flush);
60 void git_deflate_init(git_zstream *, int level);
61 void git_deflate_init_gzip(git_zstream *, int level);
62 void git_deflate_init_raw(git_zstream *, int level);
63 void git_deflate_end(git_zstream *);
64 int git_deflate_abort(git_zstream *);
65 int git_deflate_end_gently(git_zstream *);
66 int git_deflate(git_zstream *, int flush);
67 unsigned long git_deflate_bound(git_zstream *, unsigned long);
69 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
70 #define GIT_SHA1_RAWSZ 20
71 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
73 /* The length in byte and in hex digits of the largest possible hash value. */
74 #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
75 #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
77 struct object_id {
78 unsigned char hash[GIT_MAX_RAWSZ];
81 #define the_hash_algo the_repository->hash_algo
83 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
84 #define DTYPE(de) ((de)->d_type)
85 #else
86 #undef DT_UNKNOWN
87 #undef DT_DIR
88 #undef DT_REG
89 #undef DT_LNK
90 #define DT_UNKNOWN 0
91 #define DT_DIR 1
92 #define DT_REG 2
93 #define DT_LNK 3
94 #define DTYPE(de) DT_UNKNOWN
95 #endif
97 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
98 #define S_IFINVALID 0030000
101 * A "directory link" is a link to another git directory.
103 * The value 0160000 is not normally a valid mode, and
104 * also just happens to be S_IFDIR + S_IFLNK
106 #define S_IFGITLINK 0160000
107 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
110 * Some mode bits are also used internally for computations.
112 * They *must* not overlap with any valid modes, and they *must* not be emitted
113 * to outside world - i.e. appear on disk or network. In other words, it's just
114 * temporary fields, which we internally use, but they have to stay in-house.
116 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
117 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
120 /* used internally in tree-diff */
121 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
125 * Intensive research over the course of many years has shown that
126 * port 9418 is totally unused by anything else. Or
128 * Your search - "port 9418" - did not match any documents.
130 * as www.google.com puts it.
132 * This port has been properly assigned for git use by IANA:
133 * git (Assigned-9418) [I06-050728-0001].
135 * git 9418/tcp git pack transfer service
136 * git 9418/udp git pack transfer service
138 * with Linus Torvalds <torvalds@osdl.org> as the point of
139 * contact. September 2005.
141 * See http://www.iana.org/assignments/port-numbers
143 #define DEFAULT_GIT_PORT 9418
146 * Basic data structures for the directory cache
149 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
150 struct cache_header {
151 uint32_t hdr_signature;
152 uint32_t hdr_version;
153 uint32_t hdr_entries;
156 #define INDEX_FORMAT_LB 2
157 #define INDEX_FORMAT_UB 4
160 * The "cache_time" is just the low 32 bits of the
161 * time. It doesn't matter if it overflows - we only
162 * check it for equality in the 32 bits we save.
164 struct cache_time {
165 uint32_t sec;
166 uint32_t nsec;
169 struct stat_data {
170 struct cache_time sd_ctime;
171 struct cache_time sd_mtime;
172 unsigned int sd_dev;
173 unsigned int sd_ino;
174 unsigned int sd_uid;
175 unsigned int sd_gid;
176 unsigned int sd_size;
179 struct cache_entry {
180 struct hashmap_entry ent;
181 struct stat_data ce_stat_data;
182 unsigned int ce_mode;
183 unsigned int ce_flags;
184 unsigned int ce_namelen;
185 unsigned int index; /* for link extension */
186 struct object_id oid;
187 char name[FLEX_ARRAY]; /* more */
190 #define CE_STAGEMASK (0x3000)
191 #define CE_EXTENDED (0x4000)
192 #define CE_VALID (0x8000)
193 #define CE_STAGESHIFT 12
196 * Range 0xFFFF0FFF in ce_flags is divided into
197 * two parts: in-memory flags and on-disk ones.
198 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
199 * if you want to save a new flag, add it in
200 * CE_EXTENDED_FLAGS
202 * In-memory only flags
204 #define CE_UPDATE (1 << 16)
205 #define CE_REMOVE (1 << 17)
206 #define CE_UPTODATE (1 << 18)
207 #define CE_ADDED (1 << 19)
209 #define CE_HASHED (1 << 20)
210 #define CE_FSMONITOR_VALID (1 << 21)
211 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
212 #define CE_CONFLICTED (1 << 23)
214 #define CE_UNPACKED (1 << 24)
215 #define CE_NEW_SKIP_WORKTREE (1 << 25)
217 /* used to temporarily mark paths matched by pathspecs */
218 #define CE_MATCHED (1 << 26)
220 #define CE_UPDATE_IN_BASE (1 << 27)
221 #define CE_STRIP_NAME (1 << 28)
224 * Extended on-disk flags
226 #define CE_INTENT_TO_ADD (1 << 29)
227 #define CE_SKIP_WORKTREE (1 << 30)
228 /* CE_EXTENDED2 is for future extension */
229 #define CE_EXTENDED2 (1U << 31)
231 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
234 * Safeguard to avoid saving wrong flags:
235 * - CE_EXTENDED2 won't get saved until its semantic is known
236 * - Bits in 0x0000FFFF have been saved in ce_flags already
237 * - Bits in 0x003F0000 are currently in-memory flags
239 #if CE_EXTENDED_FLAGS & 0x803FFFFF
240 #error "CE_EXTENDED_FLAGS out of range"
241 #endif
243 /* Forward structure decls */
244 struct pathspec;
245 struct child_process;
248 * Copy the sha1 and stat state of a cache entry from one to
249 * another. But we never change the name, or the hash state!
251 static inline void copy_cache_entry(struct cache_entry *dst,
252 const struct cache_entry *src)
254 unsigned int state = dst->ce_flags & CE_HASHED;
256 /* Don't copy hash chain and name */
257 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
258 offsetof(struct cache_entry, name) -
259 offsetof(struct cache_entry, ce_stat_data));
261 /* Restore the hash state */
262 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
265 static inline unsigned create_ce_flags(unsigned stage)
267 return (stage << CE_STAGESHIFT);
270 #define ce_namelen(ce) ((ce)->ce_namelen)
271 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
272 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
273 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
274 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
275 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
276 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
278 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
279 static inline unsigned int create_ce_mode(unsigned int mode)
281 if (S_ISLNK(mode))
282 return S_IFLNK;
283 if (S_ISDIR(mode) || S_ISGITLINK(mode))
284 return S_IFGITLINK;
285 return S_IFREG | ce_permissions(mode);
287 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
288 unsigned int mode)
290 extern int trust_executable_bit, has_symlinks;
291 if (!has_symlinks && S_ISREG(mode) &&
292 ce && S_ISLNK(ce->ce_mode))
293 return ce->ce_mode;
294 if (!trust_executable_bit && S_ISREG(mode)) {
295 if (ce && S_ISREG(ce->ce_mode))
296 return ce->ce_mode;
297 return create_ce_mode(0666);
299 return create_ce_mode(mode);
301 static inline int ce_to_dtype(const struct cache_entry *ce)
303 unsigned ce_mode = ntohl(ce->ce_mode);
304 if (S_ISREG(ce_mode))
305 return DT_REG;
306 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
307 return DT_DIR;
308 else if (S_ISLNK(ce_mode))
309 return DT_LNK;
310 else
311 return DT_UNKNOWN;
313 static inline unsigned int canon_mode(unsigned int mode)
315 if (S_ISREG(mode))
316 return S_IFREG | ce_permissions(mode);
317 if (S_ISLNK(mode))
318 return S_IFLNK;
319 if (S_ISDIR(mode))
320 return S_IFDIR;
321 return S_IFGITLINK;
324 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
326 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
327 #define CE_ENTRY_CHANGED (1 << 1)
328 #define CE_ENTRY_REMOVED (1 << 2)
329 #define CE_ENTRY_ADDED (1 << 3)
330 #define RESOLVE_UNDO_CHANGED (1 << 4)
331 #define CACHE_TREE_CHANGED (1 << 5)
332 #define SPLIT_INDEX_ORDERED (1 << 6)
333 #define UNTRACKED_CHANGED (1 << 7)
334 #define FSMONITOR_CHANGED (1 << 8)
336 struct split_index;
337 struct untracked_cache;
339 struct index_state {
340 struct cache_entry **cache;
341 unsigned int version;
342 unsigned int cache_nr, cache_alloc, cache_changed;
343 struct string_list *resolve_undo;
344 struct cache_tree *cache_tree;
345 struct split_index *split_index;
346 struct cache_time timestamp;
347 unsigned name_hash_initialized : 1,
348 initialized : 1;
349 struct hashmap name_hash;
350 struct hashmap dir_hash;
351 unsigned char sha1[20];
352 struct untracked_cache *untracked;
353 uint64_t fsmonitor_last_update;
354 struct ewah_bitmap *fsmonitor_dirty;
357 extern struct index_state the_index;
359 /* Name hashing */
360 extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
361 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
362 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
363 extern void free_name_hash(struct index_state *istate);
366 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
367 #define active_cache (the_index.cache)
368 #define active_nr (the_index.cache_nr)
369 #define active_alloc (the_index.cache_alloc)
370 #define active_cache_changed (the_index.cache_changed)
371 #define active_cache_tree (the_index.cache_tree)
373 #define read_cache() read_index(&the_index)
374 #define read_cache_from(path) read_index_from(&the_index, (path))
375 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
376 #define is_cache_unborn() is_index_unborn(&the_index)
377 #define read_cache_unmerged() read_index_unmerged(&the_index)
378 #define discard_cache() discard_index(&the_index)
379 #define unmerged_cache() unmerged_index(&the_index)
380 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
381 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
382 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
383 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
384 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
385 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
386 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
387 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
388 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
389 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
390 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
391 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
392 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
393 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
394 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
395 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
396 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
397 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
398 #endif
400 enum object_type {
401 OBJ_BAD = -1,
402 OBJ_NONE = 0,
403 OBJ_COMMIT = 1,
404 OBJ_TREE = 2,
405 OBJ_BLOB = 3,
406 OBJ_TAG = 4,
407 /* 5 for future expansion */
408 OBJ_OFS_DELTA = 6,
409 OBJ_REF_DELTA = 7,
410 OBJ_ANY,
411 OBJ_MAX
414 static inline enum object_type object_type(unsigned int mode)
416 return S_ISDIR(mode) ? OBJ_TREE :
417 S_ISGITLINK(mode) ? OBJ_COMMIT :
418 OBJ_BLOB;
421 /* Double-check local_repo_env below if you add to this list. */
422 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
423 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
424 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
425 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
426 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
427 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
428 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
429 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
430 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
431 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
432 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
433 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
434 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
435 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
436 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
437 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
438 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
439 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
440 #define GITATTRIBUTES_FILE ".gitattributes"
441 #define INFOATTRIBUTES_FILE "info/attributes"
442 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
443 #define GITMODULES_FILE ".gitmodules"
444 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
445 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
446 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
447 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
448 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
449 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
450 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
451 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
452 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
453 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
454 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
457 * Environment variable used in handshaking the wire protocol.
458 * Contains a colon ':' separated list of keys with optional values
459 * 'key[=value]'. Presence of unknown keys and values must be
460 * ignored.
462 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
463 /* HTTP header used to handshake the wire protocol */
464 #define GIT_PROTOCOL_HEADER "Git-Protocol"
467 * This environment variable is expected to contain a boolean indicating
468 * whether we should or should not treat:
470 * GIT_DIR=foo.git git ...
472 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
473 * of this, but we use it internally to communicate to sub-processes that we
474 * are in a bare repo. If not set, defaults to true.
476 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
479 * Repository-local GIT_* environment variables; these will be cleared
480 * when git spawns a sub-process that runs inside another repository.
481 * The array is NULL-terminated, which makes it easy to pass in the "env"
482 * parameter of a run-command invocation, or to do a simple walk.
484 extern const char * const local_repo_env[];
486 extern void setup_git_env(void);
489 * Returns true iff we have a configured git repository (either via
490 * setup_git_directory, or in the environment via $GIT_DIR).
492 int have_git_dir(void);
494 extern int is_bare_repository_cfg;
495 extern int is_bare_repository(void);
496 extern int is_inside_git_dir(void);
497 extern char *git_work_tree_cfg;
498 extern int is_inside_work_tree(void);
499 extern const char *get_git_dir(void);
500 extern const char *get_git_common_dir(void);
501 extern char *get_object_directory(void);
502 extern char *get_index_file(void);
503 extern char *get_graft_file(void);
504 extern int set_git_dir(const char *path);
505 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
506 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
507 extern const char *get_git_namespace(void);
508 extern const char *strip_namespace(const char *namespaced_ref);
509 extern const char *get_super_prefix(void);
510 extern const char *get_git_work_tree(void);
513 * Return true if the given path is a git directory; note that this _just_
514 * looks at the directory itself. If you want to know whether "foo/.git"
515 * is a repository, you must feed that path, not just "foo".
517 extern int is_git_directory(const char *path);
520 * Return 1 if the given path is the root of a git repository or
521 * submodule, else 0. Will not return 1 for bare repositories with the
522 * exception of creating a bare repository in "foo/.git" and calling
523 * is_git_repository("foo").
525 * If we run into read errors, we err on the side of saying "yes, it is",
526 * as we usually consider sub-repos precious, and would prefer to err on the
527 * side of not disrupting or deleting them.
529 extern int is_nonbare_repository_dir(struct strbuf *path);
531 #define READ_GITFILE_ERR_STAT_FAILED 1
532 #define READ_GITFILE_ERR_NOT_A_FILE 2
533 #define READ_GITFILE_ERR_OPEN_FAILED 3
534 #define READ_GITFILE_ERR_READ_FAILED 4
535 #define READ_GITFILE_ERR_INVALID_FORMAT 5
536 #define READ_GITFILE_ERR_NO_PATH 6
537 #define READ_GITFILE_ERR_NOT_A_REPO 7
538 #define READ_GITFILE_ERR_TOO_LARGE 8
539 extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
540 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
541 #define read_gitfile(path) read_gitfile_gently((path), NULL)
542 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
543 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
545 extern void set_git_work_tree(const char *tree);
547 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
549 extern void setup_work_tree(void);
551 * Find the commondir and gitdir of the repository that contains the current
552 * working directory, without changing the working directory or other global
553 * state. The result is appended to commondir and gitdir. If the discovered
554 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
555 * both have the same result appended to the buffer. The return value is
556 * either 0 upon success and non-zero if no repository was found.
558 extern int discover_git_directory(struct strbuf *commondir,
559 struct strbuf *gitdir);
560 extern const char *setup_git_directory_gently(int *);
561 extern const char *setup_git_directory(void);
562 extern char *prefix_path(const char *prefix, int len, const char *path);
563 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
566 * Concatenate "prefix" (if len is non-zero) and "path", with no
567 * connecting characters (so "prefix" should end with a "/").
568 * Unlike prefix_path, this should be used if the named file does
569 * not have to interact with index entry; i.e. name of a random file
570 * on the filesystem.
572 * The return value is always a newly allocated string (even if the
573 * prefix was empty).
575 extern char *prefix_filename(const char *prefix, const char *path);
577 extern int check_filename(const char *prefix, const char *name);
578 extern void verify_filename(const char *prefix,
579 const char *name,
580 int diagnose_misspelt_rev);
581 extern void verify_non_filename(const char *prefix, const char *name);
582 extern int path_inside_repo(const char *prefix, const char *path);
584 #define INIT_DB_QUIET 0x0001
585 #define INIT_DB_EXIST_OK 0x0002
587 extern int init_db(const char *git_dir, const char *real_git_dir,
588 const char *template_dir, unsigned int flags);
590 extern void sanitize_stdfds(void);
591 extern int daemonize(void);
593 #define alloc_nr(x) (((x)+16)*3/2)
596 * Realloc the buffer pointed at by variable 'x' so that it can hold
597 * at least 'nr' entries; the number of entries currently allocated
598 * is 'alloc', using the standard growing factor alloc_nr() macro.
600 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
602 #define ALLOC_GROW(x, nr, alloc) \
603 do { \
604 if ((nr) > alloc) { \
605 if (alloc_nr(alloc) < (nr)) \
606 alloc = (nr); \
607 else \
608 alloc = alloc_nr(alloc); \
609 REALLOC_ARRAY(x, alloc); \
611 } while (0)
613 /* Initialize and use the cache information */
614 struct lock_file;
615 extern int read_index(struct index_state *);
616 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
617 extern int do_read_index(struct index_state *istate, const char *path,
618 int must_exist); /* for testting only! */
619 extern int read_index_from(struct index_state *, const char *path);
620 extern int is_index_unborn(struct index_state *);
621 extern int read_index_unmerged(struct index_state *);
623 /* For use with `write_locked_index()`. */
624 #define COMMIT_LOCK (1 << 0)
627 * Write the index while holding an already-taken lock. Close the lock,
628 * and if `COMMIT_LOCK` is given, commit it.
630 * Unless a split index is in use, write the index into the lockfile.
632 * With a split index, write the shared index to a temporary file,
633 * adjust its permissions and rename it into place, then write the
634 * split index to the lockfile. If the temporary file for the shared
635 * index cannot be created, fall back to the behavior described in
636 * the previous paragraph.
638 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
639 * Without it, the lock is closed, but neither committed nor rolled
640 * back.
642 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
644 extern int discard_index(struct index_state *);
645 extern void move_index_extensions(struct index_state *dst, struct index_state *src);
646 extern int unmerged_index(const struct index_state *);
649 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
650 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
651 * strbuf is provided, the space-separated list of files that differ will be
652 * appended to it.
654 extern int index_has_changes(struct strbuf *sb);
656 extern int verify_path(const char *path);
657 extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
658 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
659 extern void adjust_dirname_case(struct index_state *istate, char *name);
660 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
663 * Searches for an entry defined by name and namelen in the given index.
664 * If the return value is positive (including 0) it is the position of an
665 * exact match. If the return value is negative, the negated value minus 1
666 * is the position where the entry would be inserted.
667 * Example: The current index consists of these files and its stages:
669 * b#0, d#0, f#1, f#3
671 * index_name_pos(&index, "a", 1) -> -1
672 * index_name_pos(&index, "b", 1) -> 0
673 * index_name_pos(&index, "c", 1) -> -2
674 * index_name_pos(&index, "d", 1) -> 1
675 * index_name_pos(&index, "e", 1) -> -3
676 * index_name_pos(&index, "f", 1) -> -3
677 * index_name_pos(&index, "g", 1) -> -5
679 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
681 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
682 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
683 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
684 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
685 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
686 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
687 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
688 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
690 /* Remove entry, return true if there are more entries to go. */
691 extern int remove_index_entry_at(struct index_state *, int pos);
693 extern void remove_marked_cache_entries(struct index_state *istate);
694 extern int remove_file_from_index(struct index_state *, const char *path);
695 #define ADD_CACHE_VERBOSE 1
696 #define ADD_CACHE_PRETEND 2
697 #define ADD_CACHE_IGNORE_ERRORS 4
698 #define ADD_CACHE_IGNORE_REMOVAL 8
699 #define ADD_CACHE_INTENT 16
701 * These two are used to add the contents of the file at path
702 * to the index, marking the working tree up-to-date by storing
703 * the cached stat info in the resulting cache entry. A caller
704 * that has already run lstat(2) on the path can call
705 * add_to_index(), and all others can call add_file_to_index();
706 * the latter will do necessary lstat(2) internally before
707 * calling the former.
709 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
710 extern int add_file_to_index(struct index_state *, const char *path, int flags);
712 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
713 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
714 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
715 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
716 extern int index_name_is_other(const struct index_state *, const char *, int);
717 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
719 /* do stat comparison even if CE_VALID is true */
720 #define CE_MATCH_IGNORE_VALID 01
721 /* do not check the contents but report dirty on racily-clean entries */
722 #define CE_MATCH_RACY_IS_DIRTY 02
723 /* do stat comparison even if CE_SKIP_WORKTREE is true */
724 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
725 /* ignore non-existent files during stat update */
726 #define CE_MATCH_IGNORE_MISSING 0x08
727 /* enable stat refresh */
728 #define CE_MATCH_REFRESH 0x10
729 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
730 #define CE_MATCH_IGNORE_FSMONITOR 0X20
731 extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
732 extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
734 #define HASH_WRITE_OBJECT 1
735 #define HASH_FORMAT_CHECK 2
736 #define HASH_RENORMALIZE 4
737 extern int index_fd(struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
738 extern int index_path(struct object_id *oid, const char *path, struct stat *st, unsigned flags);
741 * Record to sd the data from st that we use to check whether a file
742 * might have changed.
744 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
747 * Return 0 if st is consistent with a file not having been changed
748 * since sd was filled. If there are differences, return a
749 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
750 * INODE_CHANGED, and DATA_CHANGED.
752 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
753 extern int match_stat_data_racy(const struct index_state *istate,
754 const struct stat_data *sd, struct stat *st);
756 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
758 #define REFRESH_REALLY 0x0001 /* ignore_valid */
759 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
760 #define REFRESH_QUIET 0x0004 /* be quiet about it */
761 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
762 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
763 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
764 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
765 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
768 * Opportunistically update the index but do not complain if we can't.
769 * The lockfile is always committed or rolled back.
771 extern void update_index_if_able(struct index_state *, struct lock_file *);
773 extern int hold_locked_index(struct lock_file *, int);
774 extern void set_alternate_index_output(const char *);
776 extern int verify_index_checksum;
777 extern int verify_ce_order;
779 /* Environment bits from configuration mechanism */
780 extern int trust_executable_bit;
781 extern int trust_ctime;
782 extern int check_stat;
783 extern int quote_path_fully;
784 extern int has_symlinks;
785 extern int minimum_abbrev, default_abbrev;
786 extern int ignore_case;
787 extern int assume_unchanged;
788 extern int prefer_symlink_refs;
789 extern int warn_ambiguous_refs;
790 extern int warn_on_object_refname_ambiguity;
791 extern const char *apply_default_whitespace;
792 extern const char *apply_default_ignorewhitespace;
793 extern const char *git_attributes_file;
794 extern const char *git_hooks_path;
795 extern int zlib_compression_level;
796 extern int core_compression_level;
797 extern int pack_compression_level;
798 extern size_t packed_git_window_size;
799 extern size_t packed_git_limit;
800 extern size_t delta_base_cache_limit;
801 extern unsigned long big_file_threshold;
802 extern unsigned long pack_size_limit_cfg;
805 * Accessors for the core.sharedrepository config which lazy-load the value
806 * from the config (if not already set). The "reset" function can be
807 * used to unset "set" or cached value, meaning that the value will be loaded
808 * fresh from the config file on the next call to get_shared_repository().
810 void set_shared_repository(int value);
811 int get_shared_repository(void);
812 void reset_shared_repository(void);
815 * Do replace refs need to be checked this run? This variable is
816 * initialized to true unless --no-replace-object is used or
817 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
818 * commands that do not want replace references to be active. As an
819 * optimization it is also set to false if replace references have
820 * been sought but there were none.
822 extern int check_replace_refs;
823 extern char *git_replace_ref_base;
825 extern int fsync_object_files;
826 extern int core_preload_index;
827 extern int core_apply_sparse_checkout;
828 extern int precomposed_unicode;
829 extern int protect_hfs;
830 extern int protect_ntfs;
831 extern const char *core_fsmonitor;
834 * Include broken refs in all ref iterations, which will
835 * generally choke dangerous operations rather than letting
836 * them silently proceed without taking the broken ref into
837 * account.
839 extern int ref_paranoia;
842 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
844 int use_optional_locks(void);
847 * The character that begins a commented line in user-editable file
848 * that is subject to stripspace.
850 extern char comment_line_char;
851 extern int auto_comment_line_char;
853 /* Windows only */
854 enum hide_dotfiles_type {
855 HIDE_DOTFILES_FALSE = 0,
856 HIDE_DOTFILES_TRUE,
857 HIDE_DOTFILES_DOTGITONLY
859 extern enum hide_dotfiles_type hide_dotfiles;
861 enum log_refs_config {
862 LOG_REFS_UNSET = -1,
863 LOG_REFS_NONE = 0,
864 LOG_REFS_NORMAL,
865 LOG_REFS_ALWAYS
867 extern enum log_refs_config log_all_ref_updates;
869 enum branch_track {
870 BRANCH_TRACK_UNSPECIFIED = -1,
871 BRANCH_TRACK_NEVER = 0,
872 BRANCH_TRACK_REMOTE,
873 BRANCH_TRACK_ALWAYS,
874 BRANCH_TRACK_EXPLICIT,
875 BRANCH_TRACK_OVERRIDE
878 enum rebase_setup_type {
879 AUTOREBASE_NEVER = 0,
880 AUTOREBASE_LOCAL,
881 AUTOREBASE_REMOTE,
882 AUTOREBASE_ALWAYS
885 enum push_default_type {
886 PUSH_DEFAULT_NOTHING = 0,
887 PUSH_DEFAULT_MATCHING,
888 PUSH_DEFAULT_SIMPLE,
889 PUSH_DEFAULT_UPSTREAM,
890 PUSH_DEFAULT_CURRENT,
891 PUSH_DEFAULT_UNSPECIFIED
894 extern enum branch_track git_branch_track;
895 extern enum rebase_setup_type autorebase;
896 extern enum push_default_type push_default;
898 enum object_creation_mode {
899 OBJECT_CREATION_USES_HARDLINKS = 0,
900 OBJECT_CREATION_USES_RENAMES = 1
903 extern enum object_creation_mode object_creation_mode;
905 extern char *notes_ref_name;
907 extern int grafts_replace_parents;
910 * GIT_REPO_VERSION is the version we write by default. The
911 * _READ variant is the highest number we know how to
912 * handle.
914 #define GIT_REPO_VERSION 0
915 #define GIT_REPO_VERSION_READ 1
916 extern int repository_format_precious_objects;
918 struct repository_format {
919 int version;
920 int precious_objects;
921 int is_bare;
922 int hash_algo;
923 char *work_tree;
924 struct string_list unknown_extensions;
928 * Read the repository format characteristics from the config file "path" into
929 * "format" struct. Returns the numeric version. On error, -1 is returned,
930 * format->version is set to -1, and all other fields in the struct are
931 * undefined.
933 int read_repository_format(struct repository_format *format, const char *path);
936 * Verify that the repository described by repository_format is something we
937 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
938 * any errors encountered.
940 int verify_repository_format(const struct repository_format *format,
941 struct strbuf *err);
944 * Check the repository format version in the path found in get_git_dir(),
945 * and die if it is a version we don't understand. Generally one would
946 * set_git_dir() before calling this, and use it only for "are we in a valid
947 * repo?".
949 extern void check_repository_format(void);
951 #define MTIME_CHANGED 0x0001
952 #define CTIME_CHANGED 0x0002
953 #define OWNER_CHANGED 0x0004
954 #define MODE_CHANGED 0x0008
955 #define INODE_CHANGED 0x0010
956 #define DATA_CHANGED 0x0020
957 #define TYPE_CHANGED 0x0040
960 * Return the name of the file in the local object database that would
961 * be used to store a loose object with the specified sha1. The
962 * return value is a pointer to a statically allocated buffer that is
963 * overwritten each time the function is called.
965 extern const char *sha1_file_name(const unsigned char *sha1);
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.
972 * The non-`_r` version returns a static buffer which remains valid until 4
973 * more calls to find_unique_abbrev are made.
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).
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.
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);
985 extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
986 extern const struct object_id null_oid;
988 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
990 return memcmp(sha1, sha2, GIT_SHA1_RAWSZ);
993 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
995 return hashcmp(oid1->hash, oid2->hash);
998 static inline int is_null_sha1(const unsigned char *sha1)
1000 return !hashcmp(sha1, null_sha1);
1003 static inline int is_null_oid(const struct object_id *oid)
1005 return !hashcmp(oid->hash, null_sha1);
1008 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1010 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
1013 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1015 hashcpy(dst->hash, src->hash);
1018 static inline struct object_id *oiddup(const struct object_id *src)
1020 struct object_id *dst = xmalloc(sizeof(struct object_id));
1021 oidcpy(dst, src);
1022 return dst;
1025 static inline void hashclr(unsigned char *hash)
1027 memset(hash, 0, GIT_SHA1_RAWSZ);
1030 static inline void oidclr(struct object_id *oid)
1032 hashclr(oid->hash);
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)
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)
1053 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1055 return !hashcmp(sha1, the_hash_algo->empty_blob->hash);
1058 static inline int is_empty_blob_oid(const struct object_id *oid)
1060 return !oidcmp(oid, the_hash_algo->empty_blob);
1063 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1065 return !hashcmp(sha1, the_hash_algo->empty_tree->hash);
1068 static inline int is_empty_tree_oid(const struct object_id *oid)
1070 return !oidcmp(oid, the_hash_algo->empty_tree);
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);
1078 * NOTE NOTE NOTE!!
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.
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
1092 int git_config_perm(const char *var, const char *value);
1093 int adjust_shared_perm(const char *path);
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.
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.
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.
1113 enum scld_error {
1114 SCLD_OK = 0,
1115 SCLD_FAILED = -1,
1116 SCLD_PERMS = -2,
1117 SCLD_EXISTS = -3,
1118 SCLD_VANISHED = -4
1120 enum scld_error safe_create_leading_directories(char *path);
1121 enum scld_error safe_create_leading_directories_const(const char *path);
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:
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.
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.
1144 * Any other errno causes raceproof_create_file() to fail with the
1145 * callback's return value and errno.
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.
1151 typedef int create_file_fn(const char *path, void *cb);
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.
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.
1164 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
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)
1171 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
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);
1191 * Returns true iff "str" could be confused as a command-line option when
1192 * passed to a sub-program like "ssh". Note that this has nothing to do with
1193 * shell-quoting, which should be handled separately; we're assuming here that
1194 * the string makes it verbatim to the sub-program.
1196 int looks_like_command_line_option(const char *str);
1199 * Return a newly allocated string with the evaluation of
1200 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1201 * "$HOME/.config/git/$filename". Return NULL upon error.
1203 extern char *xdg_config_home(const char *filename);
1206 * Return a newly allocated string with the evaluation of
1207 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1208 * "$HOME/.cache/git/$filename". Return NULL upon error.
1210 extern char *xdg_cache_home(const char *filename);
1212 extern void *read_sha1_file_extended(const unsigned char *sha1,
1213 enum object_type *type,
1214 unsigned long *size, int lookup_replace);
1215 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1217 return read_sha1_file_extended(sha1, type, size, 1);
1221 * This internal function is only declared here for the benefit of
1222 * lookup_replace_object(). Please do not call it directly.
1224 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1227 * If object sha1 should be replaced, return the replacement object's
1228 * name (replaced recursively, if necessary). The return value is
1229 * either sha1 or a pointer to a permanently-allocated value. When
1230 * object replacement is suppressed, always return sha1.
1232 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1234 if (!check_replace_refs)
1235 return sha1;
1236 return do_lookup_replace_object(sha1);
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, struct object_id *oid, 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);
1252 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1254 extern int finalize_object_file(const char *tmpfile, const char *filename);
1257 * Open the loose object at path, check its sha1, and return the contents,
1258 * type, and size. If the object is a blob, then "contents" may return NULL,
1259 * to allow streaming of large blobs.
1261 * Returns 0 on success, negative on error (details may be written to stderr).
1263 int read_loose_object(const char *path,
1264 const unsigned char *expected_sha1,
1265 enum object_type *type,
1266 unsigned long *size,
1267 void **contents);
1270 * Convenience for sha1_object_info_extended() with a NULL struct
1271 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass
1272 * nonzero flags to also set other flags.
1274 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1275 static inline int has_sha1_file(const unsigned char *sha1)
1277 return has_sha1_file_with_flags(sha1, 0);
1280 /* Same as the above, except for struct object_id. */
1281 extern int has_object_file(const struct object_id *oid);
1282 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1285 * Return true iff an alternate object database has a loose object
1286 * with the specified name. This function does not respect replace
1287 * references.
1289 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1291 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1293 /* Helper to check and "touch" a file */
1294 extern int check_and_freshen_file(const char *fn, int freshen);
1296 extern const signed char hexval_table[256];
1297 static inline unsigned int hexval(unsigned char c)
1299 return hexval_table[c];
1303 * Convert two consecutive hexadecimal digits into a char. Return a
1304 * negative value on error. Don't run over the end of short strings.
1306 static inline int hex2chr(const char *s)
1308 unsigned int val = hexval(s[0]);
1309 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
1312 /* Convert to/from hex/sha1 representation */
1313 #define MINIMUM_ABBREV minimum_abbrev
1314 #define DEFAULT_ABBREV default_abbrev
1316 /* used when the code does not know or care what the default abbrev is */
1317 #define FALLBACK_DEFAULT_ABBREV 7
1319 struct object_context {
1320 unsigned char tree[20];
1321 unsigned mode;
1323 * symlink_path is only used by get_tree_entry_follow_symlinks,
1324 * and only for symlinks that point outside the repository.
1326 struct strbuf symlink_path;
1328 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1329 * found when resolving the name. The caller is responsible for
1330 * releasing the memory.
1332 char *path;
1335 #define GET_OID_QUIETLY 01
1336 #define GET_OID_COMMIT 02
1337 #define GET_OID_COMMITTISH 04
1338 #define GET_OID_TREE 010
1339 #define GET_OID_TREEISH 020
1340 #define GET_OID_BLOB 040
1341 #define GET_OID_FOLLOW_SYMLINKS 0100
1342 #define GET_OID_RECORD_PATH 0200
1343 #define GET_OID_ONLY_TO_DIE 04000
1345 #define GET_OID_DISAMBIGUATORS \
1346 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1347 GET_OID_TREE | GET_OID_TREEISH | \
1348 GET_OID_BLOB)
1350 extern int get_oid(const char *str, struct object_id *oid);
1351 extern int get_oid_commit(const char *str, struct object_id *oid);
1352 extern int get_oid_committish(const char *str, struct object_id *oid);
1353 extern int get_oid_tree(const char *str, struct object_id *oid);
1354 extern int get_oid_treeish(const char *str, struct object_id *oid);
1355 extern int get_oid_blob(const char *str, struct object_id *oid);
1356 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1357 extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);
1360 typedef int each_abbrev_fn(const struct object_id *oid, void *);
1361 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1363 extern int set_disambiguate_hint_config(const char *var, const char *value);
1366 * Try to read a SHA1 in hexadecimal format from the 40 characters
1367 * starting at hex. Write the 20-byte result to sha1 in binary form.
1368 * Return 0 on success. Reading stops if a NUL is encountered in the
1369 * input, so it is safe to pass this function an arbitrary
1370 * null-terminated string.
1372 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1373 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1376 * Read `len` pairs of hexadecimal digits from `hex` and write the
1377 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1378 * the input does not consist of hex digits).
1380 extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
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.
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:
1391 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
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 */
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.
1405 extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
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.
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.
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.
1422 * If the input is not of the accepted format, it returns a negative
1423 * number to signal an error.
1425 * If the input was ok but there are not N branch switches in the
1426 * reflog, it returns 0.
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.
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);
1440 extern int validate_headref(const char *ref);
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);
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);
1452 extern struct object *peel_to_type(const char *name, int namelen,
1453 struct object *o, enum object_type);
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;
1472 * Convenience helper for passing a constant type, like:
1474 * show_date(t, tz, DATE_MODE(NORMAL));
1476 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1477 struct date_mode *date_mode_from_type(enum date_mode_type type);
1479 const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1480 void show_date_relative(timestamp_t 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, timestamp_t *timestamp, int *offset);
1484 int parse_expiry_date(const char *date, timestamp_t *timestamp);
1485 void datestamp(struct strbuf *out);
1486 #define approxidate(s) approxidate_careful((s), NULL)
1487 timestamp_t approxidate_careful(const char *, int *);
1488 timestamp_t 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(timestamp_t date);
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 is_terminal_dumb(void);
1504 extern int git_ident_config(const char *, const char *, void *);
1505 extern void reset_ident_date(void);
1507 struct ident_split {
1508 const char *name_begin;
1509 const char *name_end;
1510 const char *mail_begin;
1511 const char *mail_end;
1512 const char *date_begin;
1513 const char *date_end;
1514 const char *tz_begin;
1515 const char *tz_end;
1518 * Signals an success with 0, but time part of the result may be NULL
1519 * if the input lacks timestamp and zone
1521 extern int split_ident_line(struct ident_split *, const char *, int);
1524 * Like show_date, but pull the timestamp and tz parameters from
1525 * the ident_split. It will also sanity-check the values and produce
1526 * a well-known sentinel date if they appear bogus.
1528 const char *show_ident_date(const struct ident_split *id,
1529 const struct date_mode *mode);
1532 * Compare split idents for equality or strict ordering. Note that we
1533 * compare only the ident part of the line, ignoring any timestamp.
1535 * Because there are two fields, we must choose one as the primary key; we
1536 * currently arbitrarily pick the email.
1538 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1540 struct checkout {
1541 struct index_state *istate;
1542 const char *base_dir;
1543 int base_dir_len;
1544 struct delayed_checkout *delayed_checkout;
1545 unsigned force:1,
1546 quiet:1,
1547 not_new:1,
1548 refresh_cache:1;
1550 #define CHECKOUT_INIT { NULL, "" }
1552 #define TEMPORARY_FILENAME_LENGTH 25
1553 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1554 extern void enable_delayed_checkout(struct checkout *state);
1555 extern int finish_delayed_checkout(struct checkout *state);
1557 struct cache_def {
1558 struct strbuf path;
1559 int flags;
1560 int track_flags;
1561 int prefix_len_stat_func;
1563 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1564 static inline void cache_def_clear(struct cache_def *cache)
1566 strbuf_release(&cache->path);
1569 extern int has_symlink_leading_path(const char *name, int len);
1570 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1571 extern int check_leading_path(const char *name, int len);
1572 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1573 extern void schedule_dir_for_removal(const char *name, int len);
1574 extern void remove_scheduled_dirs(void);
1576 extern struct alternate_object_database {
1577 struct alternate_object_database *next;
1579 /* see alt_scratch_buf() */
1580 struct strbuf scratch;
1581 size_t base_len;
1584 * Used to store the results of readdir(3) calls when searching
1585 * for unique abbreviated hashes. This cache is never
1586 * invalidated, thus it's racy and not necessarily accurate.
1587 * That's fine for its purpose; don't use it for tasks requiring
1588 * greater accuracy!
1590 char loose_objects_subdir_seen[256];
1591 struct oid_array loose_objects_cache;
1593 char path[FLEX_ARRAY];
1594 } *alt_odb_list;
1595 extern void prepare_alt_odb(void);
1596 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1597 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1598 extern int foreach_alt_odb(alt_odb_fn, void*);
1601 * Allocate a "struct alternate_object_database" but do _not_ actually
1602 * add it to the list of alternates.
1604 struct alternate_object_database *alloc_alt_odb(const char *dir);
1607 * Add the directory to the on-disk alternates file; the new entry will also
1608 * take effect in the current process.
1610 extern void add_to_alternates_file(const char *dir);
1613 * Add the directory to the in-memory list of alternates (along with any
1614 * recursive alternates it points to), but do not modify the on-disk alternates
1615 * file.
1617 extern void add_to_alternates_memory(const char *dir);
1620 * Returns a scratch strbuf pre-filled with the alternate object directory,
1621 * including a trailing slash, which can be used to access paths in the
1622 * alternate. Always use this over direct access to alt->scratch, as it
1623 * cleans up any previous use of the scratch buffer.
1625 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1627 struct pack_window {
1628 struct pack_window *next;
1629 unsigned char *base;
1630 off_t offset;
1631 size_t len;
1632 unsigned int last_used;
1633 unsigned int inuse_cnt;
1636 extern struct packed_git {
1637 struct packed_git *next;
1638 struct pack_window *windows;
1639 off_t pack_size;
1640 const void *index_data;
1641 size_t index_size;
1642 uint32_t num_objects;
1643 uint32_t num_bad_objects;
1644 unsigned char *bad_object_sha1;
1645 int index_version;
1646 time_t mtime;
1647 int pack_fd;
1648 unsigned pack_local:1,
1649 pack_keep:1,
1650 freshened:1,
1651 do_not_close:1;
1652 unsigned char sha1[20];
1653 struct revindex_entry *revindex;
1654 /* something like ".git/objects/pack/xxxxx.pack" */
1655 char pack_name[FLEX_ARRAY]; /* more */
1656 } *packed_git;
1659 * A most-recently-used ordered version of the packed_git list, which can
1660 * be iterated instead of packed_git (and marked via mru_mark).
1662 extern struct mru packed_git_mru;
1664 struct pack_entry {
1665 off_t offset;
1666 unsigned char sha1[20];
1667 struct packed_git *p;
1671 * Create a temporary file rooted in the object database directory, or
1672 * die on failure. The filename is taken from "pattern", which should have the
1673 * usual "XXXXXX" trailer, and the resulting filename is written into the
1674 * "template" buffer. Returns the open descriptor.
1676 extern int odb_mkstemp(struct strbuf *template, const char *pattern);
1679 * Create a pack .keep file named "name" (which should generally be the output
1680 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1681 * error.
1683 extern int odb_pack_keep(const char *name);
1686 * Iterate over the files in the loose-object parts of the object
1687 * directory "path", triggering the following callbacks:
1689 * - loose_object is called for each loose object we find.
1691 * - loose_cruft is called for any files that do not appear to be
1692 * loose objects. Note that we only look in the loose object
1693 * directories "objects/[0-9a-f]{2}/", so we will not report
1694 * "objects/foobar" as cruft.
1696 * - loose_subdir is called for each top-level hashed subdirectory
1697 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1698 * after the objects in the directory are processed.
1700 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1701 * will end the iteration.
1703 * In the "buf" variant, "path" is a strbuf which will also be used as a
1704 * scratch buffer, but restored to its original contents before
1705 * the function returns.
1707 typedef int each_loose_object_fn(const struct object_id *oid,
1708 const char *path,
1709 void *data);
1710 typedef int each_loose_cruft_fn(const char *basename,
1711 const char *path,
1712 void *data);
1713 typedef int each_loose_subdir_fn(unsigned int nr,
1714 const char *path,
1715 void *data);
1716 int for_each_file_in_obj_subdir(unsigned int subdir_nr,
1717 struct strbuf *path,
1718 each_loose_object_fn obj_cb,
1719 each_loose_cruft_fn cruft_cb,
1720 each_loose_subdir_fn subdir_cb,
1721 void *data);
1722 int for_each_loose_file_in_objdir(const char *path,
1723 each_loose_object_fn obj_cb,
1724 each_loose_cruft_fn cruft_cb,
1725 each_loose_subdir_fn subdir_cb,
1726 void *data);
1727 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1728 each_loose_object_fn obj_cb,
1729 each_loose_cruft_fn cruft_cb,
1730 each_loose_subdir_fn subdir_cb,
1731 void *data);
1734 * Iterate over loose objects in both the local
1735 * repository and any alternates repositories (unless the
1736 * LOCAL_ONLY flag is set).
1738 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1739 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1741 struct object_info {
1742 /* Request */
1743 enum object_type *typep;
1744 unsigned long *sizep;
1745 off_t *disk_sizep;
1746 unsigned char *delta_base_sha1;
1747 struct strbuf *typename;
1748 void **contentp;
1750 /* Response */
1751 enum {
1752 OI_CACHED,
1753 OI_LOOSE,
1754 OI_PACKED,
1755 OI_DBCACHED
1756 } whence;
1757 union {
1759 * struct {
1760 * ... Nothing to expose in this case
1761 * } cached;
1762 * struct {
1763 * ... Nothing to expose in this case
1764 * } loose;
1766 struct {
1767 struct packed_git *pack;
1768 off_t offset;
1769 unsigned int is_delta;
1770 } packed;
1771 } u;
1775 * Initializer for a "struct object_info" that wants no items. You may
1776 * also memset() the memory to all-zeroes.
1778 #define OBJECT_INFO_INIT {NULL}
1780 /* Invoke lookup_replace_object() on the given hash */
1781 #define OBJECT_INFO_LOOKUP_REPLACE 1
1782 /* Allow reading from a loose object file of unknown/bogus type */
1783 #define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
1784 /* Do not check cached storage */
1785 #define OBJECT_INFO_SKIP_CACHED 4
1786 /* Do not retry packed storage after checking packed and loose storage */
1787 #define OBJECT_INFO_QUICK 8
1788 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1790 /* Dumb servers support */
1791 extern int update_server_info(int);
1793 extern const char *get_log_output_encoding(void);
1794 extern const char *get_commit_output_encoding(void);
1797 * This is a hack for test programs like test-dump-untracked-cache to
1798 * ensure that they do not modify the untracked cache when reading it.
1799 * Do not use it otherwise!
1801 extern int ignore_untracked_cache_config;
1803 extern int committer_ident_sufficiently_given(void);
1804 extern int author_ident_sufficiently_given(void);
1806 extern const char *git_commit_encoding;
1807 extern const char *git_log_output_encoding;
1808 extern const char *git_mailmap_file;
1809 extern const char *git_mailmap_blob;
1811 /* IO helper functions */
1812 extern void maybe_flush_or_die(FILE *, const char *);
1813 __attribute__((format (printf, 2, 3)))
1814 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1816 #define COPY_READ_ERROR (-2)
1817 #define COPY_WRITE_ERROR (-3)
1818 extern int copy_fd(int ifd, int ofd);
1819 extern int copy_file(const char *dst, const char *src, int mode);
1820 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1822 extern void write_or_die(int fd, const void *buf, size_t count);
1823 extern void fsync_or_die(int fd, const char *);
1825 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1826 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1827 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1829 static inline ssize_t write_str_in_full(int fd, const char *str)
1831 return write_in_full(fd, str, strlen(str));
1835 * Open (and truncate) the file at path, write the contents of buf to it,
1836 * and close it. Dies if any errors are encountered.
1838 extern void write_file_buf(const char *path, const char *buf, size_t len);
1841 * Like write_file_buf(), but format the contents into a buffer first.
1842 * Additionally, write_file() will append a newline if one is not already
1843 * present, making it convenient to write text files:
1845 * write_file(path, "counter: %d", ctr);
1847 __attribute__((format (printf, 2, 3)))
1848 extern void write_file(const char *path, const char *fmt, ...);
1850 /* pager.c */
1851 extern void setup_pager(void);
1852 extern int pager_in_use(void);
1853 extern int pager_use_color;
1854 extern int term_columns(void);
1855 extern int decimal_width(uintmax_t);
1856 extern int check_pager_config(const char *cmd);
1857 extern void prepare_pager_args(struct child_process *, const char *pager);
1859 extern const char *editor_program;
1860 extern const char *askpass_program;
1861 extern const char *excludes_file;
1863 /* base85 */
1864 int decode_85(char *dst, const char *line, int linelen);
1865 void encode_85(char *buf, const unsigned char *data, int bytes);
1867 /* alloc.c */
1868 extern void *alloc_blob_node(void);
1869 extern void *alloc_tree_node(void);
1870 extern void *alloc_commit_node(void);
1871 extern void *alloc_tag_node(void);
1872 extern void *alloc_object_node(void);
1873 extern void alloc_report(void);
1874 extern unsigned int alloc_commit_index(void);
1876 /* pkt-line.c */
1877 void packet_trace_identity(const char *prog);
1879 /* add */
1881 * return 0 if success, 1 - if addition of a file failed and
1882 * ADD_FILES_IGNORE_ERRORS was specified in flags
1884 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1886 /* diff.c */
1887 extern int diff_auto_refresh_index;
1889 /* match-trees.c */
1890 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1891 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1894 * whitespace rules.
1895 * used by both diff and apply
1896 * last two digits are tab width
1898 #define WS_BLANK_AT_EOL 0100
1899 #define WS_SPACE_BEFORE_TAB 0200
1900 #define WS_INDENT_WITH_NON_TAB 0400
1901 #define WS_CR_AT_EOL 01000
1902 #define WS_BLANK_AT_EOF 02000
1903 #define WS_TAB_IN_INDENT 04000
1904 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1905 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1906 #define WS_TAB_WIDTH_MASK 077
1907 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1908 #define WS_RULE_MASK 07777
1909 extern unsigned whitespace_rule_cfg;
1910 extern unsigned whitespace_rule(const char *);
1911 extern unsigned parse_whitespace_rule(const char *);
1912 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1913 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1914 extern char *whitespace_error_string(unsigned ws);
1915 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1916 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1917 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1919 /* ls-files */
1920 void overlay_tree_on_index(struct index_state *istate,
1921 const char *tree_name, const char *prefix);
1923 char *alias_lookup(const char *alias);
1924 int split_cmdline(char *cmdline, const char ***argv);
1925 /* Takes a negative value returned by split_cmdline */
1926 const char *split_cmdline_strerror(int cmdline_errno);
1928 /* setup.c */
1929 struct startup_info {
1930 int have_repository;
1931 const char *prefix;
1933 extern struct startup_info *startup_info;
1935 /* merge.c */
1936 struct commit_list;
1937 int try_merge_command(const char *strategy, size_t xopts_nr,
1938 const char **xopts, struct commit_list *common,
1939 const char *head_arg, struct commit_list *remotes);
1940 int checkout_fast_forward(const struct object_id *from,
1941 const struct object_id *to,
1942 int overwrite_ignore);
1945 int sane_execvp(const char *file, char *const argv[]);
1948 * A struct to encapsulate the concept of whether a file has changed
1949 * since we last checked it. This uses criteria similar to those used
1950 * for the index.
1952 struct stat_validity {
1953 struct stat_data *sd;
1956 void stat_validity_clear(struct stat_validity *sv);
1959 * Returns 1 if the path is a regular file (or a symlink to a regular
1960 * file) and matches the saved stat_validity, 0 otherwise. A missing
1961 * or inaccessible file is considered a match if the struct was just
1962 * initialized, or if the previous update found an inaccessible file.
1964 int stat_validity_check(struct stat_validity *sv, const char *path);
1967 * Update the stat_validity from a file opened at descriptor fd. If
1968 * the file is missing, inaccessible, or not a regular file, then
1969 * future calls to stat_validity_check will match iff one of those
1970 * conditions continues to be true.
1972 void stat_validity_update(struct stat_validity *sv, int fd);
1974 int versioncmp(const char *s1, const char *s2);
1975 void sleep_millisec(int millisec);
1978 * Create a directory and (if share is nonzero) adjust its permissions
1979 * according to the shared_repository setting. Only use this for
1980 * directories under $GIT_DIR. Don't use it for working tree
1981 * directories.
1983 void safe_create_dir(const char *dir, int share);
1986 * Should we print an ellipsis after an abbreviated SHA-1 value
1987 * when doing diff-raw output or indicating a detached HEAD?
1989 extern int print_sha1_ellipsis(void);
1991 #endif /* CACHE_H */