refs: reject ref updates while GIT_QUARANTINE_PATH is set
[alt-git.git] / cache.h
blobc898a1dd7d5f5dd20ee8830bb7e91b620fb18423
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 DEFAULT_GIT_DIR_ENVIRONMENT ".git"
413 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
414 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
415 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
416 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
417 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
418 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
419 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
420 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
421 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
422 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
423 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
424 #define GITATTRIBUTES_FILE ".gitattributes"
425 #define INFOATTRIBUTES_FILE "info/attributes"
426 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
427 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
428 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
429 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
430 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
431 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
432 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
433 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
434 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
435 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
436 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
439 * This environment variable is expected to contain a boolean indicating
440 * whether we should or should not treat:
442 * GIT_DIR=foo.git git ...
444 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
445 * of this, but we use it internally to communicate to sub-processes that we
446 * are in a bare repo. If not set, defaults to true.
448 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
451 * Repository-local GIT_* environment variables; these will be cleared
452 * when git spawns a sub-process that runs inside another repository.
453 * The array is NULL-terminated, which makes it easy to pass in the "env"
454 * parameter of a run-command invocation, or to do a simple walk.
456 extern const char * const local_repo_env[];
459 * Returns true iff we have a configured git repository (either via
460 * setup_git_directory, or in the environment via $GIT_DIR).
462 int have_git_dir(void);
464 extern int is_bare_repository_cfg;
465 extern int is_bare_repository(void);
466 extern int is_inside_git_dir(void);
467 extern char *git_work_tree_cfg;
468 extern int is_inside_work_tree(void);
469 extern const char *get_git_dir(void);
470 extern const char *get_git_common_dir(void);
471 extern char *get_object_directory(void);
472 extern char *get_index_file(void);
473 extern char *get_graft_file(void);
474 extern int set_git_dir(const char *path);
475 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
476 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
477 extern const char *get_git_namespace(void);
478 extern const char *strip_namespace(const char *namespaced_ref);
479 extern const char *get_git_work_tree(void);
482 * Return true if the given path is a git directory; note that this _just_
483 * looks at the directory itself. If you want to know whether "foo/.git"
484 * is a repository, you must feed that path, not just "foo".
486 extern int is_git_directory(const char *path);
489 * Return 1 if the given path is the root of a git repository or
490 * submodule, else 0. Will not return 1 for bare repositories with the
491 * exception of creating a bare repository in "foo/.git" and calling
492 * is_git_repository("foo").
494 * If we run into read errors, we err on the side of saying "yes, it is",
495 * as we usually consider sub-repos precious, and would prefer to err on the
496 * side of not disrupting or deleting them.
498 extern int is_nonbare_repository_dir(struct strbuf *path);
500 #define READ_GITFILE_ERR_STAT_FAILED 1
501 #define READ_GITFILE_ERR_NOT_A_FILE 2
502 #define READ_GITFILE_ERR_OPEN_FAILED 3
503 #define READ_GITFILE_ERR_READ_FAILED 4
504 #define READ_GITFILE_ERR_INVALID_FORMAT 5
505 #define READ_GITFILE_ERR_NO_PATH 6
506 #define READ_GITFILE_ERR_NOT_A_REPO 7
507 #define READ_GITFILE_ERR_TOO_LARGE 8
508 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
509 #define read_gitfile(path) read_gitfile_gently((path), NULL)
510 extern const char *resolve_gitdir(const char *suspect);
511 extern void set_git_work_tree(const char *tree);
513 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
515 extern const char **get_pathspec(const char *prefix, const char **pathspec);
516 extern void setup_work_tree(void);
517 extern const char *setup_git_directory_gently(int *);
518 extern const char *setup_git_directory(void);
519 extern char *prefix_path(const char *prefix, int len, const char *path);
520 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
521 extern const char *prefix_filename(const char *prefix, int len, const char *path);
522 extern int check_filename(const char *prefix, const char *name);
523 extern void verify_filename(const char *prefix,
524 const char *name,
525 int diagnose_misspelt_rev);
526 extern void verify_non_filename(const char *prefix, const char *name);
527 extern int path_inside_repo(const char *prefix, const char *path);
529 #define INIT_DB_QUIET 0x0001
530 #define INIT_DB_EXIST_OK 0x0002
532 extern int init_db(const char *git_dir, const char *real_git_dir,
533 const char *template_dir, unsigned int flags);
535 extern void sanitize_stdfds(void);
536 extern int daemonize(void);
538 #define alloc_nr(x) (((x)+16)*3/2)
541 * Realloc the buffer pointed at by variable 'x' so that it can hold
542 * at least 'nr' entries; the number of entries currently allocated
543 * is 'alloc', using the standard growing factor alloc_nr() macro.
545 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
547 #define ALLOC_GROW(x, nr, alloc) \
548 do { \
549 if ((nr) > alloc) { \
550 if (alloc_nr(alloc) < (nr)) \
551 alloc = (nr); \
552 else \
553 alloc = alloc_nr(alloc); \
554 REALLOC_ARRAY(x, alloc); \
556 } while (0)
558 /* Initialize and use the cache information */
559 struct lock_file;
560 extern int read_index(struct index_state *);
561 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
562 extern int do_read_index(struct index_state *istate, const char *path,
563 int must_exist); /* for testting only! */
564 extern int read_index_from(struct index_state *, const char *path);
565 extern int is_index_unborn(struct index_state *);
566 extern int read_index_unmerged(struct index_state *);
567 #define COMMIT_LOCK (1 << 0)
568 #define CLOSE_LOCK (1 << 1)
569 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
570 extern int discard_index(struct index_state *);
571 extern int unmerged_index(const struct index_state *);
572 extern int verify_path(const char *path);
573 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
574 extern void adjust_dirname_case(struct index_state *istate, char *name);
575 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
576 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
577 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
578 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
579 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
580 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
581 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
582 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
583 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
584 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
585 extern int remove_index_entry_at(struct index_state *, int pos);
586 extern void remove_marked_cache_entries(struct index_state *istate);
587 extern int remove_file_from_index(struct index_state *, const char *path);
588 #define ADD_CACHE_VERBOSE 1
589 #define ADD_CACHE_PRETEND 2
590 #define ADD_CACHE_IGNORE_ERRORS 4
591 #define ADD_CACHE_IGNORE_REMOVAL 8
592 #define ADD_CACHE_INTENT 16
593 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
594 extern int add_file_to_index(struct index_state *, const char *path, int flags);
595 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
596 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
597 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
598 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
599 extern int index_name_is_other(const struct index_state *, const char *, int);
600 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
602 /* do stat comparison even if CE_VALID is true */
603 #define CE_MATCH_IGNORE_VALID 01
604 /* do not check the contents but report dirty on racily-clean entries */
605 #define CE_MATCH_RACY_IS_DIRTY 02
606 /* do stat comparison even if CE_SKIP_WORKTREE is true */
607 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
608 /* ignore non-existent files during stat update */
609 #define CE_MATCH_IGNORE_MISSING 0x08
610 /* enable stat refresh */
611 #define CE_MATCH_REFRESH 0x10
612 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
613 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
615 #define HASH_WRITE_OBJECT 1
616 #define HASH_FORMAT_CHECK 2
617 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
618 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
621 * Record to sd the data from st that we use to check whether a file
622 * might have changed.
624 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
627 * Return 0 if st is consistent with a file not having been changed
628 * since sd was filled. If there are differences, return a
629 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
630 * INODE_CHANGED, and DATA_CHANGED.
632 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
633 extern int match_stat_data_racy(const struct index_state *istate,
634 const struct stat_data *sd, struct stat *st);
636 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
638 #define REFRESH_REALLY 0x0001 /* ignore_valid */
639 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
640 #define REFRESH_QUIET 0x0004 /* be quiet about it */
641 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
642 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
643 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
644 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
645 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
647 extern void update_index_if_able(struct index_state *, struct lock_file *);
649 extern int hold_locked_index(struct lock_file *, int);
650 extern void set_alternate_index_output(const char *);
652 /* Environment bits from configuration mechanism */
653 extern int trust_executable_bit;
654 extern int trust_ctime;
655 extern int check_stat;
656 extern int quote_path_fully;
657 extern int has_symlinks;
658 extern int minimum_abbrev, default_abbrev;
659 extern int ignore_case;
660 extern int assume_unchanged;
661 extern int prefer_symlink_refs;
662 extern int log_all_ref_updates;
663 extern int warn_ambiguous_refs;
664 extern int warn_on_object_refname_ambiguity;
665 extern const char *apply_default_whitespace;
666 extern const char *apply_default_ignorewhitespace;
667 extern const char *git_attributes_file;
668 extern const char *git_hooks_path;
669 extern int zlib_compression_level;
670 extern int core_compression_level;
671 extern int core_compression_seen;
672 extern size_t packed_git_window_size;
673 extern size_t packed_git_limit;
674 extern size_t delta_base_cache_limit;
675 extern unsigned long big_file_threshold;
676 extern unsigned long pack_size_limit_cfg;
679 * Accessors for the core.sharedrepository config which lazy-load the value
680 * from the config (if not already set). The "reset" function can be
681 * used to unset "set" or cached value, meaning that the value will be loaded
682 * fresh from the config file on the next call to get_shared_repository().
684 void set_shared_repository(int value);
685 int get_shared_repository(void);
686 void reset_shared_repository(void);
689 * Do replace refs need to be checked this run? This variable is
690 * initialized to true unless --no-replace-object is used or
691 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
692 * commands that do not want replace references to be active. As an
693 * optimization it is also set to false if replace references have
694 * been sought but there were none.
696 extern int check_replace_refs;
697 extern char *git_replace_ref_base;
699 extern int fsync_object_files;
700 extern int core_preload_index;
701 extern int core_apply_sparse_checkout;
702 extern int precomposed_unicode;
703 extern int protect_hfs;
704 extern int protect_ntfs;
705 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
708 * Include broken refs in all ref iterations, which will
709 * generally choke dangerous operations rather than letting
710 * them silently proceed without taking the broken ref into
711 * account.
713 extern int ref_paranoia;
716 * The character that begins a commented line in user-editable file
717 * that is subject to stripspace.
719 extern char comment_line_char;
720 extern int auto_comment_line_char;
722 /* Windows only */
723 enum hide_dotfiles_type {
724 HIDE_DOTFILES_FALSE = 0,
725 HIDE_DOTFILES_TRUE,
726 HIDE_DOTFILES_DOTGITONLY
728 extern enum hide_dotfiles_type hide_dotfiles;
730 enum branch_track {
731 BRANCH_TRACK_UNSPECIFIED = -1,
732 BRANCH_TRACK_NEVER = 0,
733 BRANCH_TRACK_REMOTE,
734 BRANCH_TRACK_ALWAYS,
735 BRANCH_TRACK_EXPLICIT,
736 BRANCH_TRACK_OVERRIDE
739 enum rebase_setup_type {
740 AUTOREBASE_NEVER = 0,
741 AUTOREBASE_LOCAL,
742 AUTOREBASE_REMOTE,
743 AUTOREBASE_ALWAYS
746 enum push_default_type {
747 PUSH_DEFAULT_NOTHING = 0,
748 PUSH_DEFAULT_MATCHING,
749 PUSH_DEFAULT_SIMPLE,
750 PUSH_DEFAULT_UPSTREAM,
751 PUSH_DEFAULT_CURRENT,
752 PUSH_DEFAULT_UNSPECIFIED
755 extern enum branch_track git_branch_track;
756 extern enum rebase_setup_type autorebase;
757 extern enum push_default_type push_default;
759 enum object_creation_mode {
760 OBJECT_CREATION_USES_HARDLINKS = 0,
761 OBJECT_CREATION_USES_RENAMES = 1
764 extern enum object_creation_mode object_creation_mode;
766 extern char *notes_ref_name;
768 extern int grafts_replace_parents;
771 * GIT_REPO_VERSION is the version we write by default. The
772 * _READ variant is the highest number we know how to
773 * handle.
775 #define GIT_REPO_VERSION 0
776 #define GIT_REPO_VERSION_READ 1
777 extern int repository_format_precious_objects;
779 struct repository_format {
780 int version;
781 int precious_objects;
782 int is_bare;
783 char *work_tree;
784 struct string_list unknown_extensions;
788 * Read the repository format characteristics from the config file "path" into
789 * "format" struct. Returns the numeric version. On error, -1 is returned,
790 * format->version is set to -1, and all other fields in the struct are
791 * undefined.
793 int read_repository_format(struct repository_format *format, const char *path);
796 * Verify that the repository described by repository_format is something we
797 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
798 * any errors encountered.
800 int verify_repository_format(const struct repository_format *format,
801 struct strbuf *err);
804 * Check the repository format version in the path found in get_git_dir(),
805 * and die if it is a version we don't understand. Generally one would
806 * set_git_dir() before calling this, and use it only for "are we in a valid
807 * repo?".
809 extern void check_repository_format(void);
811 #define MTIME_CHANGED 0x0001
812 #define CTIME_CHANGED 0x0002
813 #define OWNER_CHANGED 0x0004
814 #define MODE_CHANGED 0x0008
815 #define INODE_CHANGED 0x0010
816 #define DATA_CHANGED 0x0020
817 #define TYPE_CHANGED 0x0040
820 * Return a statically allocated filename, either generically (mkpath), in
821 * the repository directory (git_path), or in a submodule's repository
822 * directory (git_path_submodule). In all cases, note that the result
823 * may be overwritten by another call to _any_ of the functions. Consider
824 * using the safer "dup" or "strbuf" formats below (in some cases, the
825 * unsafe versions have already been removed).
827 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
828 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
829 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
831 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
832 __attribute__((format (printf, 3, 4)));
833 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
834 __attribute__((format (printf, 2, 3)));
835 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
836 __attribute__((format (printf, 2, 3)));
837 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
838 __attribute__((format (printf, 2, 3)));
839 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
840 const char *fmt, ...)
841 __attribute__((format (printf, 3, 4)));
842 extern char *git_pathdup(const char *fmt, ...)
843 __attribute__((format (printf, 1, 2)));
844 extern char *mkpathdup(const char *fmt, ...)
845 __attribute__((format (printf, 1, 2)));
846 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
847 __attribute__((format (printf, 2, 3)));
849 extern void report_linked_checkout_garbage(void);
852 * You can define a static memoized git path like:
854 * static GIT_PATH_FUNC(git_path_foo, "FOO");
856 * or use one of the global ones below.
858 #define GIT_PATH_FUNC(func, filename) \
859 const char *func(void) \
861 static char *ret; \
862 if (!ret) \
863 ret = git_pathdup(filename); \
864 return ret; \
867 const char *git_path_cherry_pick_head(void);
868 const char *git_path_revert_head(void);
869 const char *git_path_squash_msg(void);
870 const char *git_path_merge_msg(void);
871 const char *git_path_merge_rr(void);
872 const char *git_path_merge_mode(void);
873 const char *git_path_merge_head(void);
874 const char *git_path_fetch_head(void);
875 const char *git_path_shallow(void);
878 * Return the name of the file in the local object database that would
879 * be used to store a loose object with the specified sha1. The
880 * return value is a pointer to a statically allocated buffer that is
881 * overwritten each time the function is called.
883 extern const char *sha1_file_name(const unsigned char *sha1);
886 * Return the name of the (local) packfile with the specified sha1 in
887 * its name. The return value is a pointer to memory that is
888 * overwritten each time this function is called.
890 extern char *sha1_pack_name(const unsigned char *sha1);
893 * Return the name of the (local) pack index file with the specified
894 * sha1 in its name. The return value is a pointer to memory that is
895 * overwritten each time this function is called.
897 extern char *sha1_pack_index_name(const unsigned char *sha1);
900 * Return an abbreviated sha1 unique within this repository's object database.
901 * The result will be at least `len` characters long, and will be NUL
902 * terminated.
904 * The non-`_r` version returns a static buffer which will be overwritten by
905 * subsequent calls.
907 * The `_r` variant writes to a buffer supplied by the caller, which must be at
908 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
909 * written (excluding the NUL terminator).
911 * Note that while this version avoids the static buffer, it is not fully
912 * reentrant, as it calls into other non-reentrant git code.
914 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
915 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
917 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
918 extern const struct object_id null_oid;
920 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
922 int i;
924 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
925 if (*sha1 != *sha2)
926 return *sha1 - *sha2;
929 return 0;
932 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
934 return hashcmp(oid1->hash, oid2->hash);
937 static inline int is_null_sha1(const unsigned char *sha1)
939 return !hashcmp(sha1, null_sha1);
942 static inline int is_null_oid(const struct object_id *oid)
944 return !hashcmp(oid->hash, null_sha1);
947 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
949 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
952 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
954 hashcpy(dst->hash, src->hash);
957 static inline void hashclr(unsigned char *hash)
959 memset(hash, 0, GIT_SHA1_RAWSZ);
962 static inline void oidclr(struct object_id *oid)
964 hashclr(oid->hash);
968 #define EMPTY_TREE_SHA1_HEX \
969 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
970 #define EMPTY_TREE_SHA1_BIN_LITERAL \
971 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
972 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
973 extern const struct object_id empty_tree_oid;
974 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
976 #define EMPTY_BLOB_SHA1_HEX \
977 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
978 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
979 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
980 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
981 extern const struct object_id empty_blob_oid;
982 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
985 static inline int is_empty_blob_sha1(const unsigned char *sha1)
987 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
990 static inline int is_empty_blob_oid(const struct object_id *oid)
992 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
995 static inline int is_empty_tree_sha1(const unsigned char *sha1)
997 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1000 static inline int is_empty_tree_oid(const struct object_id *oid)
1002 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1006 int git_mkstemp(char *path, size_t n, const char *template);
1008 /* set default permissions by passing mode arguments to open(2) */
1009 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1010 int git_mkstemp_mode(char *pattern, int mode);
1013 * NOTE NOTE NOTE!!
1015 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1016 * not be changed. Old repositories have core.sharedrepository written in
1017 * numeric format, and therefore these values are preserved for compatibility
1018 * reasons.
1020 enum sharedrepo {
1021 PERM_UMASK = 0,
1022 OLD_PERM_GROUP = 1,
1023 OLD_PERM_EVERYBODY = 2,
1024 PERM_GROUP = 0660,
1025 PERM_EVERYBODY = 0664
1027 int git_config_perm(const char *var, const char *value);
1028 int adjust_shared_perm(const char *path);
1031 * Create the directory containing the named path, using care to be
1032 * somewhat safe against races. Return one of the scld_error values
1033 * to indicate success/failure.
1035 * SCLD_VANISHED indicates that one of the ancestor directories of the
1036 * path existed at one point during the function call and then
1037 * suddenly vanished, probably because another process pruned the
1038 * directory while we were working. To be robust against this kind of
1039 * race, callers might want to try invoking the function again when it
1040 * returns SCLD_VANISHED.
1042 * safe_create_leading_directories() temporarily changes path while it
1043 * is working but restores it before returning.
1044 * safe_create_leading_directories_const() doesn't modify path, even
1045 * temporarily.
1047 enum scld_error {
1048 SCLD_OK = 0,
1049 SCLD_FAILED = -1,
1050 SCLD_PERMS = -2,
1051 SCLD_EXISTS = -3,
1052 SCLD_VANISHED = -4
1054 enum scld_error safe_create_leading_directories(char *path);
1055 enum scld_error safe_create_leading_directories_const(const char *path);
1057 int mkdir_in_gitdir(const char *path);
1058 extern char *expand_user_path(const char *path);
1059 const char *enter_repo(const char *path, int strict);
1060 static inline int is_absolute_path(const char *path)
1062 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1064 int is_directory(const char *);
1065 const char *real_path(const char *path);
1066 const char *real_path_if_valid(const char *path);
1067 const char *absolute_path(const char *path);
1068 const char *remove_leading_path(const char *in, const char *prefix);
1069 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1070 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1071 int normalize_path_copy(char *dst, const char *src);
1072 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1073 char *strip_path_suffix(const char *path, const char *suffix);
1074 int daemon_avoid_alias(const char *path);
1075 extern int is_ntfs_dotgit(const char *name);
1078 * Return a newly allocated string with the evaluation of
1079 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1080 * "$HOME/.config/git/$filename". Return NULL upon error.
1082 extern char *xdg_config_home(const char *filename);
1084 /* object replacement */
1085 #define LOOKUP_REPLACE_OBJECT 1
1086 #define LOOKUP_UNKNOWN_OBJECT 2
1087 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1088 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1090 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1094 * This internal function is only declared here for the benefit of
1095 * lookup_replace_object(). Please do not call it directly.
1097 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1100 * If object sha1 should be replaced, return the replacement object's
1101 * name (replaced recursively, if necessary). The return value is
1102 * either sha1 or a pointer to a permanently-allocated value. When
1103 * object replacement is suppressed, always return sha1.
1105 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1107 if (!check_replace_refs)
1108 return sha1;
1109 return do_lookup_replace_object(sha1);
1112 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1114 if (!(flag & LOOKUP_REPLACE_OBJECT))
1115 return sha1;
1116 return lookup_replace_object(sha1);
1119 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1120 extern int sha1_object_info(const unsigned char *, unsigned long *);
1121 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1122 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1123 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1124 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1125 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1126 extern int git_open_noatime(const char *name);
1127 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1128 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1129 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1131 /* global flag to enable extra checks when accessing packed objects */
1132 extern int do_check_packed_object_crc;
1134 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1136 extern int finalize_object_file(const char *tmpfile, const char *filename);
1138 extern int has_sha1_pack(const unsigned char *sha1);
1141 * Return true iff we have an object named sha1, whether local or in
1142 * an alternate object database, and whether packed or loose. This
1143 * function does not respect replace references.
1145 * If the QUICK flag is set, do not re-check the pack directory
1146 * when we cannot find the object (this means we may give a false
1147 * negative answer if another process is simultaneously repacking).
1149 #define HAS_SHA1_QUICK 0x1
1150 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1151 static inline int has_sha1_file(const unsigned char *sha1)
1153 return has_sha1_file_with_flags(sha1, 0);
1156 /* Same as the above, except for struct object_id. */
1157 extern int has_object_file(const struct object_id *oid);
1160 * Return true iff an alternate object database has a loose object
1161 * with the specified name. This function does not respect replace
1162 * references.
1164 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1166 extern int has_pack_index(const unsigned char *sha1);
1168 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1170 extern const signed char hexval_table[256];
1171 static inline unsigned int hexval(unsigned char c)
1173 return hexval_table[c];
1177 * Convert two consecutive hexadecimal digits into a char. Return a
1178 * negative value on error. Don't run over the end of short strings.
1180 static inline int hex2chr(const char *s)
1182 int val = hexval(s[0]);
1183 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1186 /* Convert to/from hex/sha1 representation */
1187 #define MINIMUM_ABBREV minimum_abbrev
1188 #define DEFAULT_ABBREV default_abbrev
1190 struct object_context {
1191 unsigned char tree[20];
1192 char path[PATH_MAX];
1193 unsigned mode;
1195 * symlink_path is only used by get_tree_entry_follow_symlinks,
1196 * and only for symlinks that point outside the repository.
1198 struct strbuf symlink_path;
1201 #define GET_SHA1_QUIETLY 01
1202 #define GET_SHA1_COMMIT 02
1203 #define GET_SHA1_COMMITTISH 04
1204 #define GET_SHA1_TREE 010
1205 #define GET_SHA1_TREEISH 020
1206 #define GET_SHA1_BLOB 040
1207 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1208 #define GET_SHA1_ONLY_TO_DIE 04000
1210 extern int get_sha1(const char *str, unsigned char *sha1);
1211 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1212 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1213 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1214 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1215 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1216 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1217 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1219 extern int get_oid(const char *str, struct object_id *oid);
1221 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1222 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1225 * Try to read a SHA1 in hexadecimal format from the 40 characters
1226 * starting at hex. Write the 20-byte result to sha1 in binary form.
1227 * Return 0 on success. Reading stops if a NUL is encountered in the
1228 * input, so it is safe to pass this function an arbitrary
1229 * null-terminated string.
1231 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1232 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1235 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1236 * and writes the NUL-terminated output to the buffer `out`, which must be at
1237 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1238 * convenience.
1240 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1241 * buffers, making it safe to make multiple calls for a single statement, like:
1243 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1245 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1246 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1247 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1248 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1250 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1251 extern int get_oid_mb(const char *str, struct object_id *oid);
1253 extern int validate_headref(const char *ref);
1255 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1256 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1257 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1258 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1260 extern void *read_object_with_reference(const unsigned char *sha1,
1261 const char *required_type,
1262 unsigned long *size,
1263 unsigned char *sha1_ret);
1265 extern struct object *peel_to_type(const char *name, int namelen,
1266 struct object *o, enum object_type);
1268 struct date_mode {
1269 enum date_mode_type {
1270 DATE_NORMAL = 0,
1271 DATE_RELATIVE,
1272 DATE_SHORT,
1273 DATE_ISO8601,
1274 DATE_ISO8601_STRICT,
1275 DATE_RFC2822,
1276 DATE_STRFTIME,
1277 DATE_RAW,
1278 DATE_UNIX
1279 } type;
1280 const char *strftime_fmt;
1281 int local;
1285 * Convenience helper for passing a constant type, like:
1287 * show_date(t, tz, DATE_MODE(NORMAL));
1289 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1290 struct date_mode *date_mode_from_type(enum date_mode_type type);
1292 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1293 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1294 struct strbuf *timebuf);
1295 int parse_date(const char *date, struct strbuf *out);
1296 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1297 int parse_expiry_date(const char *date, unsigned long *timestamp);
1298 void datestamp(struct strbuf *out);
1299 #define approxidate(s) approxidate_careful((s), NULL)
1300 unsigned long approxidate_careful(const char *, int *);
1301 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1302 void parse_date_format(const char *format, struct date_mode *mode);
1303 int date_overflows(unsigned long date);
1305 #define IDENT_STRICT 1
1306 #define IDENT_NO_DATE 2
1307 #define IDENT_NO_NAME 4
1308 extern const char *git_author_info(int);
1309 extern const char *git_committer_info(int);
1310 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1311 extern const char *fmt_name(const char *name, const char *email);
1312 extern const char *ident_default_name(void);
1313 extern const char *ident_default_email(void);
1314 extern const char *git_editor(void);
1315 extern const char *git_pager(int stdout_is_tty);
1316 extern int git_ident_config(const char *, const char *, void *);
1317 extern void reset_ident_date(void);
1319 struct ident_split {
1320 const char *name_begin;
1321 const char *name_end;
1322 const char *mail_begin;
1323 const char *mail_end;
1324 const char *date_begin;
1325 const char *date_end;
1326 const char *tz_begin;
1327 const char *tz_end;
1330 * Signals an success with 0, but time part of the result may be NULL
1331 * if the input lacks timestamp and zone
1333 extern int split_ident_line(struct ident_split *, const char *, int);
1336 * Like show_date, but pull the timestamp and tz parameters from
1337 * the ident_split. It will also sanity-check the values and produce
1338 * a well-known sentinel date if they appear bogus.
1340 const char *show_ident_date(const struct ident_split *id,
1341 const struct date_mode *mode);
1344 * Compare split idents for equality or strict ordering. Note that we
1345 * compare only the ident part of the line, ignoring any timestamp.
1347 * Because there are two fields, we must choose one as the primary key; we
1348 * currently arbitrarily pick the email.
1350 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1352 struct checkout {
1353 struct index_state *istate;
1354 const char *base_dir;
1355 int base_dir_len;
1356 unsigned force:1,
1357 quiet:1,
1358 not_new:1,
1359 refresh_cache:1;
1361 #define CHECKOUT_INIT { NULL, "" }
1363 #define TEMPORARY_FILENAME_LENGTH 25
1364 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1366 struct cache_def {
1367 struct strbuf path;
1368 int flags;
1369 int track_flags;
1370 int prefix_len_stat_func;
1372 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1373 static inline void cache_def_clear(struct cache_def *cache)
1375 strbuf_release(&cache->path);
1378 extern int has_symlink_leading_path(const char *name, int len);
1379 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1380 extern int check_leading_path(const char *name, int len);
1381 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1382 extern void schedule_dir_for_removal(const char *name, int len);
1383 extern void remove_scheduled_dirs(void);
1385 extern struct alternate_object_database {
1386 struct alternate_object_database *next;
1388 /* see alt_scratch_buf() */
1389 struct strbuf scratch;
1390 size_t base_len;
1392 char path[FLEX_ARRAY];
1393 } *alt_odb_list;
1394 extern void prepare_alt_odb(void);
1395 extern void read_info_alternates(const char * relative_base, int depth);
1396 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1397 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1398 extern int foreach_alt_odb(alt_odb_fn, void*);
1401 * Allocate a "struct alternate_object_database" but do _not_ actually
1402 * add it to the list of alternates.
1404 struct alternate_object_database *alloc_alt_odb(const char *dir);
1407 * Add the directory to the on-disk alternates file; the new entry will also
1408 * take effect in the current process.
1410 extern void add_to_alternates_file(const char *dir);
1413 * Add the directory to the in-memory list of alternates (along with any
1414 * recursive alternates it points to), but do not modify the on-disk alternates
1415 * file.
1417 extern void add_to_alternates_memory(const char *dir);
1420 * Returns a scratch strbuf pre-filled with the alternate object directory,
1421 * including a trailing slash, which can be used to access paths in the
1422 * alternate. Always use this over direct access to alt->scratch, as it
1423 * cleans up any previous use of the scratch buffer.
1425 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1427 struct pack_window {
1428 struct pack_window *next;
1429 unsigned char *base;
1430 off_t offset;
1431 size_t len;
1432 unsigned int last_used;
1433 unsigned int inuse_cnt;
1436 extern struct packed_git {
1437 struct packed_git *next;
1438 struct pack_window *windows;
1439 off_t pack_size;
1440 const void *index_data;
1441 size_t index_size;
1442 uint32_t num_objects;
1443 uint32_t num_bad_objects;
1444 unsigned char *bad_object_sha1;
1445 int index_version;
1446 time_t mtime;
1447 int pack_fd;
1448 unsigned pack_local:1,
1449 pack_keep:1,
1450 freshened:1,
1451 do_not_close:1;
1452 unsigned char sha1[20];
1453 struct revindex_entry *revindex;
1454 /* something like ".git/objects/pack/xxxxx.pack" */
1455 char pack_name[FLEX_ARRAY]; /* more */
1456 } *packed_git;
1459 * A most-recently-used ordered version of the packed_git list, which can
1460 * be iterated instead of packed_git (and marked via mru_mark).
1462 struct mru;
1463 extern struct mru *packed_git_mru;
1465 struct pack_entry {
1466 off_t offset;
1467 unsigned char sha1[20];
1468 struct packed_git *p;
1471 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1473 /* A hook to report invalid files in pack directory */
1474 #define PACKDIR_FILE_PACK 1
1475 #define PACKDIR_FILE_IDX 2
1476 #define PACKDIR_FILE_GARBAGE 4
1477 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1479 extern void prepare_packed_git(void);
1480 extern void reprepare_packed_git(void);
1481 extern void install_packed_git(struct packed_git *pack);
1483 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1484 struct packed_git *packs);
1486 extern void pack_report(void);
1489 * mmap the index file for the specified packfile (if it is not
1490 * already mmapped). Return 0 on success.
1492 extern int open_pack_index(struct packed_git *);
1495 * munmap the index file for the specified packfile (if it is
1496 * currently mmapped).
1498 extern void close_pack_index(struct packed_git *);
1500 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1501 extern void close_pack_windows(struct packed_git *);
1502 extern void close_all_packs(void);
1503 extern void unuse_pack(struct pack_window **);
1504 extern void clear_delta_base_cache(void);
1505 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1508 * Make sure that a pointer access into an mmap'd index file is within bounds,
1509 * and can provide at least 8 bytes of data.
1511 * Note that this is only necessary for variable-length segments of the file
1512 * (like the 64-bit extended offset table), as we compare the size to the
1513 * fixed-length parts when we open the file.
1515 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1518 * Return the SHA-1 of the nth object within the specified packfile.
1519 * Open the index if it is not already open. The return value points
1520 * at the SHA-1 within the mmapped index. Return NULL if there is an
1521 * error.
1523 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1526 * Return the offset of the nth object within the specified packfile.
1527 * The index must already be opened.
1529 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1532 * If the object named sha1 is present in the specified packfile,
1533 * return its offset within the packfile; otherwise, return 0.
1535 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1537 extern int is_pack_valid(struct packed_git *);
1538 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1539 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1540 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1541 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1544 * Iterate over the files in the loose-object parts of the object
1545 * directory "path", triggering the following callbacks:
1547 * - loose_object is called for each loose object we find.
1549 * - loose_cruft is called for any files that do not appear to be
1550 * loose objects. Note that we only look in the loose object
1551 * directories "objects/[0-9a-f]{2}/", so we will not report
1552 * "objects/foobar" as cruft.
1554 * - loose_subdir is called for each top-level hashed subdirectory
1555 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1556 * after the objects in the directory are processed.
1558 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1559 * will end the iteration.
1561 * In the "buf" variant, "path" is a strbuf which will also be used as a
1562 * scratch buffer, but restored to its original contents before
1563 * the function returns.
1565 typedef int each_loose_object_fn(const unsigned char *sha1,
1566 const char *path,
1567 void *data);
1568 typedef int each_loose_cruft_fn(const char *basename,
1569 const char *path,
1570 void *data);
1571 typedef int each_loose_subdir_fn(int nr,
1572 const char *path,
1573 void *data);
1574 int for_each_loose_file_in_objdir(const char *path,
1575 each_loose_object_fn obj_cb,
1576 each_loose_cruft_fn cruft_cb,
1577 each_loose_subdir_fn subdir_cb,
1578 void *data);
1579 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1580 each_loose_object_fn obj_cb,
1581 each_loose_cruft_fn cruft_cb,
1582 each_loose_subdir_fn subdir_cb,
1583 void *data);
1586 * Iterate over loose and packed objects in both the local
1587 * repository and any alternates repositories (unless the
1588 * LOCAL_ONLY flag is set).
1590 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1591 typedef int each_packed_object_fn(const unsigned char *sha1,
1592 struct packed_git *pack,
1593 uint32_t pos,
1594 void *data);
1595 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1596 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1598 struct object_info {
1599 /* Request */
1600 enum object_type *typep;
1601 unsigned long *sizep;
1602 off_t *disk_sizep;
1603 unsigned char *delta_base_sha1;
1604 struct strbuf *typename;
1606 /* Response */
1607 enum {
1608 OI_CACHED,
1609 OI_LOOSE,
1610 OI_PACKED,
1611 OI_DBCACHED
1612 } whence;
1613 union {
1615 * struct {
1616 * ... Nothing to expose in this case
1617 * } cached;
1618 * struct {
1619 * ... Nothing to expose in this case
1620 * } loose;
1622 struct {
1623 struct packed_git *pack;
1624 off_t offset;
1625 unsigned int is_delta;
1626 } packed;
1627 } u;
1629 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1631 /* Dumb servers support */
1632 extern int update_server_info(int);
1634 /* git_config_parse_key() returns these negated: */
1635 #define CONFIG_INVALID_KEY 1
1636 #define CONFIG_NO_SECTION_OR_NAME 2
1637 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1638 #define CONFIG_NO_LOCK -1
1639 #define CONFIG_INVALID_FILE 3
1640 #define CONFIG_NO_WRITE 4
1641 #define CONFIG_NOTHING_SET 5
1642 #define CONFIG_INVALID_PATTERN 6
1643 #define CONFIG_GENERIC_ERROR 7
1645 #define CONFIG_REGEX_NONE ((void *)1)
1647 struct git_config_source {
1648 unsigned int use_stdin:1;
1649 const char *file;
1650 const char *blob;
1653 enum config_origin_type {
1654 CONFIG_ORIGIN_BLOB,
1655 CONFIG_ORIGIN_FILE,
1656 CONFIG_ORIGIN_STDIN,
1657 CONFIG_ORIGIN_SUBMODULE_BLOB,
1658 CONFIG_ORIGIN_CMDLINE
1661 typedef int (*config_fn_t)(const char *, const char *, void *);
1662 extern int git_default_config(const char *, const char *, void *);
1663 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1664 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1665 const char *name, const char *buf, size_t len, void *data);
1666 extern void git_config_push_parameter(const char *text);
1667 extern int git_config_from_parameters(config_fn_t fn, void *data);
1668 extern void git_config(config_fn_t fn, void *);
1669 extern int git_config_with_options(config_fn_t fn, void *,
1670 struct git_config_source *config_source,
1671 int respect_includes);
1672 extern int git_parse_ulong(const char *, unsigned long *);
1673 extern int git_parse_maybe_bool(const char *);
1674 extern int git_config_int(const char *, const char *);
1675 extern int64_t git_config_int64(const char *, const char *);
1676 extern unsigned long git_config_ulong(const char *, const char *);
1677 extern int git_config_bool_or_int(const char *, const char *, int *);
1678 extern int git_config_bool(const char *, const char *);
1679 extern int git_config_maybe_bool(const char *, const char *);
1680 extern int git_config_string(const char **, const char *, const char *);
1681 extern int git_config_pathname(const char **, const char *, const char *);
1682 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1683 extern void git_config_set_in_file(const char *, const char *, const char *);
1684 extern int git_config_set_gently(const char *, const char *);
1685 extern void git_config_set(const char *, const char *);
1686 extern int git_config_parse_key(const char *, char **, int *);
1687 extern int git_config_key_is_valid(const char *key);
1688 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1689 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1690 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1691 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1692 extern int git_config_rename_section(const char *, const char *);
1693 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1694 extern const char *git_etc_gitconfig(void);
1695 extern int git_env_bool(const char *, int);
1696 extern unsigned long git_env_ulong(const char *, unsigned long);
1697 extern int git_config_system(void);
1698 extern int config_error_nonbool(const char *);
1699 #if defined(__GNUC__)
1700 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1701 #endif
1702 extern const char *get_log_output_encoding(void);
1703 extern const char *get_commit_output_encoding(void);
1705 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1707 enum config_scope {
1708 CONFIG_SCOPE_UNKNOWN = 0,
1709 CONFIG_SCOPE_SYSTEM,
1710 CONFIG_SCOPE_GLOBAL,
1711 CONFIG_SCOPE_REPO,
1712 CONFIG_SCOPE_CMDLINE,
1715 extern enum config_scope current_config_scope(void);
1716 extern const char *current_config_origin_type(void);
1717 extern const char *current_config_name(void);
1719 struct config_include_data {
1720 int depth;
1721 config_fn_t fn;
1722 void *data;
1724 #define CONFIG_INCLUDE_INIT { 0 }
1725 extern int git_config_include(const char *name, const char *value, void *data);
1728 * Match and parse a config key of the form:
1730 * section.(subsection.)?key
1732 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1733 * we return -1 if it does not match, 0 otherwise. The subsection and key
1734 * out-parameters are filled by the function (and subsection is NULL if it is
1735 * missing).
1737 extern int parse_config_key(const char *var,
1738 const char *section,
1739 const char **subsection, int *subsection_len,
1740 const char **key);
1742 struct config_set_element {
1743 struct hashmap_entry ent;
1744 char *key;
1745 struct string_list value_list;
1748 struct configset_list_item {
1749 struct config_set_element *e;
1750 int value_index;
1754 * the contents of the list are ordered according to their
1755 * position in the config files and order of parsing the files.
1756 * (i.e. key-value pair at the last position of .git/config will
1757 * be at the last item of the list)
1759 struct configset_list {
1760 struct configset_list_item *items;
1761 unsigned int nr, alloc;
1764 struct config_set {
1765 struct hashmap config_hash;
1766 int hash_initialized;
1767 struct configset_list list;
1770 extern void git_configset_init(struct config_set *cs);
1771 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1772 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1773 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1774 extern void git_configset_clear(struct config_set *cs);
1775 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1776 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1777 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1778 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1779 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1780 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1781 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1782 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1784 extern int git_config_get_value(const char *key, const char **value);
1785 extern const struct string_list *git_config_get_value_multi(const char *key);
1786 extern void git_config_clear(void);
1787 extern void git_config_iter(config_fn_t fn, void *data);
1788 extern int git_config_get_string_const(const char *key, const char **dest);
1789 extern int git_config_get_string(const char *key, char **dest);
1790 extern int git_config_get_int(const char *key, int *dest);
1791 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1792 extern int git_config_get_bool(const char *key, int *dest);
1793 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1794 extern int git_config_get_maybe_bool(const char *key, int *dest);
1795 extern int git_config_get_pathname(const char *key, const char **dest);
1796 extern int git_config_get_untracked_cache(void);
1799 * This is a hack for test programs like test-dump-untracked-cache to
1800 * ensure that they do not modify the untracked cache when reading it.
1801 * Do not use it otherwise!
1803 extern int ignore_untracked_cache_config;
1805 struct key_value_info {
1806 const char *filename;
1807 int linenr;
1808 enum config_origin_type origin_type;
1809 enum config_scope scope;
1812 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1813 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1815 extern int committer_ident_sufficiently_given(void);
1816 extern int author_ident_sufficiently_given(void);
1818 extern const char *git_commit_encoding;
1819 extern const char *git_log_output_encoding;
1820 extern const char *git_mailmap_file;
1821 extern const char *git_mailmap_blob;
1823 /* IO helper functions */
1824 extern void maybe_flush_or_die(FILE *, const char *);
1825 __attribute__((format (printf, 2, 3)))
1826 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1828 #define COPY_READ_ERROR (-2)
1829 #define COPY_WRITE_ERROR (-3)
1830 extern int copy_fd(int ifd, int ofd);
1831 extern int copy_file(const char *dst, const char *src, int mode);
1832 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1834 extern void write_or_die(int fd, const void *buf, size_t count);
1835 extern void fsync_or_die(int fd, const char *);
1837 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1838 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1839 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1841 static inline ssize_t write_str_in_full(int fd, const char *str)
1843 return write_in_full(fd, str, strlen(str));
1847 * Open (and truncate) the file at path, write the contents of buf to it,
1848 * and close it. Dies if any errors are encountered.
1850 extern void write_file_buf(const char *path, const char *buf, size_t len);
1853 * Like write_file_buf(), but format the contents into a buffer first.
1854 * Additionally, write_file() will append a newline if one is not already
1855 * present, making it convenient to write text files:
1857 * write_file(path, "counter: %d", ctr);
1859 __attribute__((format (printf, 2, 3)))
1860 extern void write_file(const char *path, const char *fmt, ...);
1862 /* pager.c */
1863 extern void setup_pager(void);
1864 extern int pager_in_use(void);
1865 extern int pager_use_color;
1866 extern int term_columns(void);
1867 extern int decimal_width(uintmax_t);
1868 extern int check_pager_config(const char *cmd);
1869 extern void prepare_pager_args(struct child_process *, const char *pager);
1871 extern const char *editor_program;
1872 extern const char *askpass_program;
1873 extern const char *excludes_file;
1875 /* base85 */
1876 int decode_85(char *dst, const char *line, int linelen);
1877 void encode_85(char *buf, const unsigned char *data, int bytes);
1879 /* alloc.c */
1880 extern void *alloc_blob_node(void);
1881 extern void *alloc_tree_node(void);
1882 extern void *alloc_commit_node(void);
1883 extern void *alloc_tag_node(void);
1884 extern void *alloc_object_node(void);
1885 extern void alloc_report(void);
1886 extern unsigned int alloc_commit_index(void);
1888 /* pkt-line.c */
1889 void packet_trace_identity(const char *prog);
1891 /* add */
1893 * return 0 if success, 1 - if addition of a file failed and
1894 * ADD_FILES_IGNORE_ERRORS was specified in flags
1896 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1898 /* diff.c */
1899 extern int diff_auto_refresh_index;
1901 /* match-trees.c */
1902 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1903 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1906 * whitespace rules.
1907 * used by both diff and apply
1908 * last two digits are tab width
1910 #define WS_BLANK_AT_EOL 0100
1911 #define WS_SPACE_BEFORE_TAB 0200
1912 #define WS_INDENT_WITH_NON_TAB 0400
1913 #define WS_CR_AT_EOL 01000
1914 #define WS_BLANK_AT_EOF 02000
1915 #define WS_TAB_IN_INDENT 04000
1916 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1917 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1918 #define WS_TAB_WIDTH_MASK 077
1919 extern unsigned whitespace_rule_cfg;
1920 extern unsigned whitespace_rule(const char *);
1921 extern unsigned parse_whitespace_rule(const char *);
1922 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1923 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1924 extern char *whitespace_error_string(unsigned ws);
1925 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1926 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1927 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1929 /* ls-files */
1930 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1932 char *alias_lookup(const char *alias);
1933 int split_cmdline(char *cmdline, const char ***argv);
1934 /* Takes a negative value returned by split_cmdline */
1935 const char *split_cmdline_strerror(int cmdline_errno);
1937 /* setup.c */
1938 struct startup_info {
1939 int have_repository;
1940 const char *prefix;
1942 extern struct startup_info *startup_info;
1944 /* merge.c */
1945 struct commit_list;
1946 int try_merge_command(const char *strategy, size_t xopts_nr,
1947 const char **xopts, struct commit_list *common,
1948 const char *head_arg, struct commit_list *remotes);
1949 int checkout_fast_forward(const unsigned char *from,
1950 const unsigned char *to,
1951 int overwrite_ignore);
1954 int sane_execvp(const char *file, char *const argv[]);
1957 * A struct to encapsulate the concept of whether a file has changed
1958 * since we last checked it. This uses criteria similar to those used
1959 * for the index.
1961 struct stat_validity {
1962 struct stat_data *sd;
1965 void stat_validity_clear(struct stat_validity *sv);
1968 * Returns 1 if the path is a regular file (or a symlink to a regular
1969 * file) and matches the saved stat_validity, 0 otherwise. A missing
1970 * or inaccessible file is considered a match if the struct was just
1971 * initialized, or if the previous update found an inaccessible file.
1973 int stat_validity_check(struct stat_validity *sv, const char *path);
1976 * Update the stat_validity from a file opened at descriptor fd. If
1977 * the file is missing, inaccessible, or not a regular file, then
1978 * future calls to stat_validity_check will match iff one of those
1979 * conditions continues to be true.
1981 void stat_validity_update(struct stat_validity *sv, int fd);
1983 int versioncmp(const char *s1, const char *s2);
1984 void sleep_millisec(int millisec);
1987 * Create a directory and (if share is nonzero) adjust its permissions
1988 * according to the shared_repository setting. Only use this for
1989 * directories under $GIT_DIR. Don't use it for working tree
1990 * directories.
1992 void safe_create_dir(const char *dir, int share);
1994 #endif /* CACHE_H */