4 #include "git-compat-util.h"
11 #include "string-list.h"
12 #include "pack-revindex.h"
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
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
41 typedef struct git_zstream
{
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
;
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)
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)
84 #define DTYPE(de) DT_UNKNOWN
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.
160 struct cache_time sd_ctime
;
161 struct cache_time sd_mtime
;
166 unsigned int sd_size
;
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
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"
232 /* Forward structure decls */
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
)
272 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
274 return S_IFREG
| ce_permissions(mode
);
276 static inline unsigned int ce_mode_from_stat(const struct cache_entry
*ce
,
279 extern int trust_executable_bit
, has_symlinks
;
280 if (!has_symlinks
&& S_ISREG(mode
) &&
281 ce
&& S_ISLNK(ce
->ce_mode
))
283 if (!trust_executable_bit
&& S_ISREG(mode
)) {
284 if (ce
&& S_ISREG(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
))
295 else if (S_ISDIR(ce_mode
) || S_ISGITLINK(ce_mode
))
297 else if (S_ISLNK(ce_mode
))
302 static inline unsigned int canon_mode(unsigned int mode
)
305 return S_IFREG
| ce_permissions(mode
);
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)
325 struct untracked_cache
;
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,
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
;
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))
392 /* 5 for future expansion */
399 static inline enum object_type
object_type(unsigned int mode
)
401 return S_ISDIR(mode
) ? OBJ_TREE
:
402 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
406 /* Double-check local_repo_env below if you add to this list. */
407 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
408 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
409 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
410 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
411 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
412 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
413 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
414 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
415 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
416 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
417 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
418 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
419 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
420 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
421 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
422 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
423 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
424 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
425 #define GITATTRIBUTES_FILE ".gitattributes"
426 #define INFOATTRIBUTES_FILE "info/attributes"
427 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
428 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
429 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
430 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
431 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
432 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
433 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
434 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
435 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
436 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
437 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
440 * This environment variable is expected to contain a boolean indicating
441 * whether we should or should not treat:
443 * GIT_DIR=foo.git git ...
445 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
446 * of this, but we use it internally to communicate to sub-processes that we
447 * are in a bare repo. If not set, defaults to true.
449 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
452 * Repository-local GIT_* environment variables; these will be cleared
453 * when git spawns a sub-process that runs inside another repository.
454 * The array is NULL-terminated, which makes it easy to pass in the "env"
455 * parameter of a run-command invocation, or to do a simple walk.
457 extern const char * const local_repo_env
[];
460 * Returns true iff we have a configured git repository (either via
461 * setup_git_directory, or in the environment via $GIT_DIR).
463 int have_git_dir(void);
465 extern int is_bare_repository_cfg
;
466 extern int is_bare_repository(void);
467 extern int is_inside_git_dir(void);
468 extern char *git_work_tree_cfg
;
469 extern int is_inside_work_tree(void);
470 extern const char *get_git_dir(void);
471 extern const char *get_git_common_dir(void);
472 extern char *get_object_directory(void);
473 extern char *get_index_file(void);
474 extern char *get_graft_file(void);
475 extern int set_git_dir(const char *path
);
476 extern int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
);
477 extern int get_common_dir(struct strbuf
*sb
, const char *gitdir
);
478 extern const char *get_git_namespace(void);
479 extern const char *strip_namespace(const char *namespaced_ref
);
480 extern const char *get_super_prefix(void);
481 extern const char *get_git_work_tree(void);
484 * Return true if the given path is a git directory; note that this _just_
485 * looks at the directory itself. If you want to know whether "foo/.git"
486 * is a repository, you must feed that path, not just "foo".
488 extern int is_git_directory(const char *path
);
491 * Return 1 if the given path is the root of a git repository or
492 * submodule, else 0. Will not return 1 for bare repositories with the
493 * exception of creating a bare repository in "foo/.git" and calling
494 * is_git_repository("foo").
496 * If we run into read errors, we err on the side of saying "yes, it is",
497 * as we usually consider sub-repos precious, and would prefer to err on the
498 * side of not disrupting or deleting them.
500 extern int is_nonbare_repository_dir(struct strbuf
*path
);
502 #define READ_GITFILE_ERR_STAT_FAILED 1
503 #define READ_GITFILE_ERR_NOT_A_FILE 2
504 #define READ_GITFILE_ERR_OPEN_FAILED 3
505 #define READ_GITFILE_ERR_READ_FAILED 4
506 #define READ_GITFILE_ERR_INVALID_FORMAT 5
507 #define READ_GITFILE_ERR_NO_PATH 6
508 #define READ_GITFILE_ERR_NOT_A_REPO 7
509 #define READ_GITFILE_ERR_TOO_LARGE 8
510 extern const char *read_gitfile_gently(const char *path
, int *return_error_code
);
511 #define read_gitfile(path) read_gitfile_gently((path), NULL)
512 extern const char *resolve_gitdir(const char *suspect
);
513 extern void set_git_work_tree(const char *tree
);
515 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
517 extern const char **get_pathspec(const char *prefix
, const char **pathspec
);
518 extern void setup_work_tree(void);
519 extern const char *setup_git_directory_gently(int *);
520 extern const char *setup_git_directory(void);
521 extern char *prefix_path(const char *prefix
, int len
, const char *path
);
522 extern char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
523 extern const char *prefix_filename(const char *prefix
, int len
, const char *path
);
524 extern int check_filename(const char *prefix
, const char *name
);
525 extern void verify_filename(const char *prefix
,
527 int diagnose_misspelt_rev
);
528 extern void verify_non_filename(const char *prefix
, const char *name
);
529 extern int path_inside_repo(const char *prefix
, const char *path
);
531 #define INIT_DB_QUIET 0x0001
532 #define INIT_DB_EXIST_OK 0x0002
534 extern int init_db(const char *git_dir
, const char *real_git_dir
,
535 const char *template_dir
, unsigned int flags
);
537 extern void sanitize_stdfds(void);
538 extern int daemonize(void);
540 #define alloc_nr(x) (((x)+16)*3/2)
543 * Realloc the buffer pointed at by variable 'x' so that it can hold
544 * at least 'nr' entries; the number of entries currently allocated
545 * is 'alloc', using the standard growing factor alloc_nr() macro.
547 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
549 #define ALLOC_GROW(x, nr, alloc) \
551 if ((nr) > alloc) { \
552 if (alloc_nr(alloc) < (nr)) \
555 alloc = alloc_nr(alloc); \
556 REALLOC_ARRAY(x, alloc); \
560 /* Initialize and use the cache information */
562 extern int read_index(struct index_state
*);
563 extern int read_index_preload(struct index_state
*, const struct pathspec
*pathspec
);
564 extern int do_read_index(struct index_state
*istate
, const char *path
,
565 int must_exist
); /* for testting only! */
566 extern int read_index_from(struct index_state
*, const char *path
);
567 extern int is_index_unborn(struct index_state
*);
568 extern int read_index_unmerged(struct index_state
*);
569 #define COMMIT_LOCK (1 << 0)
570 #define CLOSE_LOCK (1 << 1)
571 extern int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
572 extern int discard_index(struct index_state
*);
573 extern int unmerged_index(const struct index_state
*);
574 extern int verify_path(const char *path
);
575 extern int index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
576 extern void adjust_dirname_case(struct index_state
*istate
, char *name
);
577 extern struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
578 extern int index_name_pos(const struct index_state
*, const char *name
, int namelen
);
579 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
580 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
581 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
582 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
583 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
584 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
585 extern int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
586 extern void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
587 extern int remove_index_entry_at(struct index_state
*, int pos
);
588 extern void remove_marked_cache_entries(struct index_state
*istate
);
589 extern int remove_file_from_index(struct index_state
*, const char *path
);
590 #define ADD_CACHE_VERBOSE 1
591 #define ADD_CACHE_PRETEND 2
592 #define ADD_CACHE_IGNORE_ERRORS 4
593 #define ADD_CACHE_IGNORE_REMOVAL 8
594 #define ADD_CACHE_INTENT 16
595 extern int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
596 extern int add_file_to_index(struct index_state
*, const char *path
, int flags
);
597 extern struct cache_entry
*make_cache_entry(unsigned int mode
, const unsigned char *sha1
, const char *path
, int stage
, unsigned int refresh_options
);
598 extern int chmod_index_entry(struct index_state
*, struct cache_entry
*ce
, char flip
);
599 extern int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
600 extern void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
601 extern int index_name_is_other(const struct index_state
*, const char *, int);
602 extern void *read_blob_data_from_index(struct index_state
*, const char *, unsigned long *);
604 /* do stat comparison even if CE_VALID is true */
605 #define CE_MATCH_IGNORE_VALID 01
606 /* do not check the contents but report dirty on racily-clean entries */
607 #define CE_MATCH_RACY_IS_DIRTY 02
608 /* do stat comparison even if CE_SKIP_WORKTREE is true */
609 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
610 /* ignore non-existent files during stat update */
611 #define CE_MATCH_IGNORE_MISSING 0x08
612 /* enable stat refresh */
613 #define CE_MATCH_REFRESH 0x10
614 extern int ie_match_stat(const struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
615 extern int ie_modified(const struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
617 #define HASH_WRITE_OBJECT 1
618 #define HASH_FORMAT_CHECK 2
619 extern int index_fd(unsigned char *sha1
, int fd
, struct stat
*st
, enum object_type type
, const char *path
, unsigned flags
);
620 extern int index_path(unsigned char *sha1
, const char *path
, struct stat
*st
, unsigned flags
);
623 * Record to sd the data from st that we use to check whether a file
624 * might have changed.
626 extern void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
629 * Return 0 if st is consistent with a file not having been changed
630 * since sd was filled. If there are differences, return a
631 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
632 * INODE_CHANGED, and DATA_CHANGED.
634 extern int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
635 extern int match_stat_data_racy(const struct index_state
*istate
,
636 const struct stat_data
*sd
, struct stat
*st
);
638 extern void fill_stat_cache_info(struct cache_entry
*ce
, struct stat
*st
);
640 #define REFRESH_REALLY 0x0001 /* ignore_valid */
641 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
642 #define REFRESH_QUIET 0x0004 /* be quiet about it */
643 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
644 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
645 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
646 extern int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
647 extern struct cache_entry
*refresh_cache_entry(struct cache_entry
*, unsigned int);
649 extern void update_index_if_able(struct index_state
*, struct lock_file
*);
651 extern int hold_locked_index(struct lock_file
*, int);
652 extern void set_alternate_index_output(const char *);
654 /* Environment bits from configuration mechanism */
655 extern int trust_executable_bit
;
656 extern int trust_ctime
;
657 extern int check_stat
;
658 extern int quote_path_fully
;
659 extern int has_symlinks
;
660 extern int minimum_abbrev
, default_abbrev
;
661 extern int ignore_case
;
662 extern int assume_unchanged
;
663 extern int prefer_symlink_refs
;
664 extern int log_all_ref_updates
;
665 extern int warn_ambiguous_refs
;
666 extern int warn_on_object_refname_ambiguity
;
667 extern const char *apply_default_whitespace
;
668 extern const char *apply_default_ignorewhitespace
;
669 extern const char *git_attributes_file
;
670 extern const char *git_hooks_path
;
671 extern int zlib_compression_level
;
672 extern int core_compression_level
;
673 extern int core_compression_seen
;
674 extern size_t packed_git_window_size
;
675 extern size_t packed_git_limit
;
676 extern size_t delta_base_cache_limit
;
677 extern unsigned long big_file_threshold
;
678 extern unsigned long pack_size_limit_cfg
;
681 * Accessors for the core.sharedrepository config which lazy-load the value
682 * from the config (if not already set). The "reset" function can be
683 * used to unset "set" or cached value, meaning that the value will be loaded
684 * fresh from the config file on the next call to get_shared_repository().
686 void set_shared_repository(int value
);
687 int get_shared_repository(void);
688 void reset_shared_repository(void);
691 * Do replace refs need to be checked this run? This variable is
692 * initialized to true unless --no-replace-object is used or
693 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
694 * commands that do not want replace references to be active. As an
695 * optimization it is also set to false if replace references have
696 * been sought but there were none.
698 extern int check_replace_refs
;
699 extern char *git_replace_ref_base
;
701 extern int fsync_object_files
;
702 extern int core_preload_index
;
703 extern int core_apply_sparse_checkout
;
704 extern int precomposed_unicode
;
705 extern int protect_hfs
;
706 extern int protect_ntfs
;
707 extern int git_db_env
, git_index_env
, git_graft_env
, git_common_dir_env
;
710 * Include broken refs in all ref iterations, which will
711 * generally choke dangerous operations rather than letting
712 * them silently proceed without taking the broken ref into
715 extern int ref_paranoia
;
718 * The character that begins a commented line in user-editable file
719 * that is subject to stripspace.
721 extern char comment_line_char
;
722 extern int auto_comment_line_char
;
725 enum hide_dotfiles_type
{
726 HIDE_DOTFILES_FALSE
= 0,
728 HIDE_DOTFILES_DOTGITONLY
730 extern enum hide_dotfiles_type hide_dotfiles
;
733 BRANCH_TRACK_UNSPECIFIED
= -1,
734 BRANCH_TRACK_NEVER
= 0,
737 BRANCH_TRACK_EXPLICIT
,
738 BRANCH_TRACK_OVERRIDE
741 enum rebase_setup_type
{
742 AUTOREBASE_NEVER
= 0,
748 enum push_default_type
{
749 PUSH_DEFAULT_NOTHING
= 0,
750 PUSH_DEFAULT_MATCHING
,
752 PUSH_DEFAULT_UPSTREAM
,
753 PUSH_DEFAULT_CURRENT
,
754 PUSH_DEFAULT_UNSPECIFIED
757 extern enum branch_track git_branch_track
;
758 extern enum rebase_setup_type autorebase
;
759 extern enum push_default_type push_default
;
761 enum object_creation_mode
{
762 OBJECT_CREATION_USES_HARDLINKS
= 0,
763 OBJECT_CREATION_USES_RENAMES
= 1
766 extern enum object_creation_mode object_creation_mode
;
768 extern char *notes_ref_name
;
770 extern int grafts_replace_parents
;
773 * GIT_REPO_VERSION is the version we write by default. The
774 * _READ variant is the highest number we know how to
777 #define GIT_REPO_VERSION 0
778 #define GIT_REPO_VERSION_READ 1
779 extern int repository_format_precious_objects
;
781 struct repository_format
{
783 int precious_objects
;
786 struct string_list unknown_extensions
;
790 * Read the repository format characteristics from the config file "path" into
791 * "format" struct. Returns the numeric version. On error, -1 is returned,
792 * format->version is set to -1, and all other fields in the struct are
795 int read_repository_format(struct repository_format
*format
, const char *path
);
798 * Verify that the repository described by repository_format is something we
799 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
800 * any errors encountered.
802 int verify_repository_format(const struct repository_format
*format
,
806 * Check the repository format version in the path found in get_git_dir(),
807 * and die if it is a version we don't understand. Generally one would
808 * set_git_dir() before calling this, and use it only for "are we in a valid
811 extern void check_repository_format(void);
813 #define MTIME_CHANGED 0x0001
814 #define CTIME_CHANGED 0x0002
815 #define OWNER_CHANGED 0x0004
816 #define MODE_CHANGED 0x0008
817 #define INODE_CHANGED 0x0010
818 #define DATA_CHANGED 0x0020
819 #define TYPE_CHANGED 0x0040
822 * Return a statically allocated filename, either generically (mkpath), in
823 * the repository directory (git_path), or in a submodule's repository
824 * directory (git_path_submodule). In all cases, note that the result
825 * may be overwritten by another call to _any_ of the functions. Consider
826 * using the safer "dup" or "strbuf" formats below (in some cases, the
827 * unsafe versions have already been removed).
829 extern const char *mkpath(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
830 extern const char *git_path(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
831 extern const char *git_common_path(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
833 extern char *mksnpath(char *buf
, size_t n
, const char *fmt
, ...)
834 __attribute__((format (printf
, 3, 4)));
835 extern void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
836 __attribute__((format (printf
, 2, 3)));
837 extern void strbuf_git_common_path(struct strbuf
*sb
, const char *fmt
, ...)
838 __attribute__((format (printf
, 2, 3)));
839 extern char *git_path_buf(struct strbuf
*buf
, const char *fmt
, ...)
840 __attribute__((format (printf
, 2, 3)));
841 extern int strbuf_git_path_submodule(struct strbuf
*sb
, const char *path
,
842 const char *fmt
, ...)
843 __attribute__((format (printf
, 3, 4)));
844 extern char *git_pathdup(const char *fmt
, ...)
845 __attribute__((format (printf
, 1, 2)));
846 extern char *mkpathdup(const char *fmt
, ...)
847 __attribute__((format (printf
, 1, 2)));
848 extern char *git_pathdup_submodule(const char *path
, const char *fmt
, ...)
849 __attribute__((format (printf
, 2, 3)));
851 extern void report_linked_checkout_garbage(void);
854 * You can define a static memoized git path like:
856 * static GIT_PATH_FUNC(git_path_foo, "FOO");
858 * or use one of the global ones below.
860 #define GIT_PATH_FUNC(func, filename) \
861 const char *func(void) \
865 ret = git_pathdup(filename); \
869 const char *git_path_cherry_pick_head(void);
870 const char *git_path_revert_head(void);
871 const char *git_path_squash_msg(void);
872 const char *git_path_merge_msg(void);
873 const char *git_path_merge_rr(void);
874 const char *git_path_merge_mode(void);
875 const char *git_path_merge_head(void);
876 const char *git_path_fetch_head(void);
877 const char *git_path_shallow(void);
880 * Return the name of the file in the local object database that would
881 * be used to store a loose object with the specified sha1. The
882 * return value is a pointer to a statically allocated buffer that is
883 * overwritten each time the function is called.
885 extern const char *sha1_file_name(const unsigned char *sha1
);
888 * Return the name of the (local) packfile with the specified sha1 in
889 * its name. The return value is a pointer to memory that is
890 * overwritten each time this function is called.
892 extern char *sha1_pack_name(const unsigned char *sha1
);
895 * Return the name of the (local) pack index file with the specified
896 * sha1 in its name. The return value is a pointer to memory that is
897 * overwritten each time this function is called.
899 extern char *sha1_pack_index_name(const unsigned char *sha1
);
902 * Return an abbreviated sha1 unique within this repository's object database.
903 * The result will be at least `len` characters long, and will be NUL
906 * The non-`_r` version returns a static buffer which remains valid until 4
907 * more calls to find_unique_abbrev are made.
909 * The `_r` variant writes to a buffer supplied by the caller, which must be at
910 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
911 * written (excluding the NUL terminator).
913 * Note that while this version avoids the static buffer, it is not fully
914 * reentrant, as it calls into other non-reentrant git code.
916 extern const char *find_unique_abbrev(const unsigned char *sha1
, int len
);
917 extern int find_unique_abbrev_r(char *hex
, const unsigned char *sha1
, int len
);
919 extern const unsigned char null_sha1
[GIT_SHA1_RAWSZ
];
920 extern const struct object_id null_oid
;
922 static inline int hashcmp(const unsigned char *sha1
, const unsigned char *sha2
)
926 for (i
= 0; i
< GIT_SHA1_RAWSZ
; i
++, sha1
++, sha2
++) {
928 return *sha1
- *sha2
;
934 static inline int oidcmp(const struct object_id
*oid1
, const struct object_id
*oid2
)
936 return hashcmp(oid1
->hash
, oid2
->hash
);
939 static inline int is_null_sha1(const unsigned char *sha1
)
941 return !hashcmp(sha1
, null_sha1
);
944 static inline int is_null_oid(const struct object_id
*oid
)
946 return !hashcmp(oid
->hash
, null_sha1
);
949 static inline void hashcpy(unsigned char *sha_dst
, const unsigned char *sha_src
)
951 memcpy(sha_dst
, sha_src
, GIT_SHA1_RAWSZ
);
954 static inline void oidcpy(struct object_id
*dst
, const struct object_id
*src
)
956 hashcpy(dst
->hash
, src
->hash
);
959 static inline void hashclr(unsigned char *hash
)
961 memset(hash
, 0, GIT_SHA1_RAWSZ
);
964 static inline void oidclr(struct object_id
*oid
)
970 #define EMPTY_TREE_SHA1_HEX \
971 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
972 #define EMPTY_TREE_SHA1_BIN_LITERAL \
973 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
974 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
975 extern const struct object_id empty_tree_oid
;
976 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
978 #define EMPTY_BLOB_SHA1_HEX \
979 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
980 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
981 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
982 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
983 extern const struct object_id empty_blob_oid
;
984 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
987 static inline int is_empty_blob_sha1(const unsigned char *sha1
)
989 return !hashcmp(sha1
, EMPTY_BLOB_SHA1_BIN
);
992 static inline int is_empty_blob_oid(const struct object_id
*oid
)
994 return !hashcmp(oid
->hash
, EMPTY_BLOB_SHA1_BIN
);
997 static inline int is_empty_tree_sha1(const unsigned char *sha1
)
999 return !hashcmp(sha1
, EMPTY_TREE_SHA1_BIN
);
1002 static inline int is_empty_tree_oid(const struct object_id
*oid
)
1004 return !hashcmp(oid
->hash
, EMPTY_TREE_SHA1_BIN
);
1008 int git_mkstemp(char *path
, size_t n
, const char *template);
1010 /* set default permissions by passing mode arguments to open(2) */
1011 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
1012 int git_mkstemp_mode(char *pattern
, int mode
);
1017 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1018 * not be changed. Old repositories have core.sharedrepository written in
1019 * numeric format, and therefore these values are preserved for compatibility
1025 OLD_PERM_EVERYBODY
= 2,
1027 PERM_EVERYBODY
= 0664
1029 int git_config_perm(const char *var
, const char *value
);
1030 int adjust_shared_perm(const char *path
);
1033 * Create the directory containing the named path, using care to be
1034 * somewhat safe against races. Return one of the scld_error values to
1035 * indicate success/failure. On error, set errno to describe the
1038 * SCLD_VANISHED indicates that one of the ancestor directories of the
1039 * path existed at one point during the function call and then
1040 * suddenly vanished, probably because another process pruned the
1041 * directory while we were working. To be robust against this kind of
1042 * race, callers might want to try invoking the function again when it
1043 * returns SCLD_VANISHED.
1045 * safe_create_leading_directories() temporarily changes path while it
1046 * is working but restores it before returning.
1047 * safe_create_leading_directories_const() doesn't modify path, even
1057 enum scld_error
safe_create_leading_directories(char *path
);
1058 enum scld_error
safe_create_leading_directories_const(const char *path
);
1061 * Callback function for raceproof_create_file(). This function is
1062 * expected to do something that makes dirname(path) permanent despite
1063 * the fact that other processes might be cleaning up empty
1064 * directories at the same time. Usually it will create a file named
1065 * path, but alternatively it could create another file in that
1066 * directory, or even chdir() into that directory. The function should
1067 * return 0 if the action was completed successfully. On error, it
1068 * should return a nonzero result and set errno.
1069 * raceproof_create_file() treats two errno values specially:
1071 * - ENOENT -- dirname(path) does not exist. In this case,
1072 * raceproof_create_file() tries creating dirname(path)
1073 * (and any parent directories, if necessary) and calls
1074 * the function again.
1076 * - EISDIR -- the file already exists and is a directory. In this
1077 * case, raceproof_create_file() removes the directory if
1078 * it is empty (and recursively any empty directories that
1079 * it contains) and calls the function again.
1081 * Any other errno causes raceproof_create_file() to fail with the
1082 * callback's return value and errno.
1084 * Obviously, this function should be OK with being called again if it
1085 * fails with ENOENT or EISDIR. In other scenarios it will not be
1088 typedef int create_file_fn(const char *path
, void *cb
);
1091 * Create a file in dirname(path) by calling fn, creating leading
1092 * directories if necessary. Retry a few times in case we are racing
1093 * with another process that is trying to clean up the directory that
1094 * contains path. See the documentation for create_file_fn for more
1097 * Return the value and set the errno that resulted from the most
1098 * recent call of fn. fn is always called at least once, and will be
1099 * called more than once if it returns ENOENT or EISDIR.
1101 int raceproof_create_file(const char *path
, create_file_fn fn
, void *cb
);
1103 int mkdir_in_gitdir(const char *path
);
1104 extern char *expand_user_path(const char *path
);
1105 const char *enter_repo(const char *path
, int strict
);
1106 static inline int is_absolute_path(const char *path
)
1108 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
1110 int is_directory(const char *);
1111 const char *real_path(const char *path
);
1112 const char *real_path_if_valid(const char *path
);
1113 const char *absolute_path(const char *path
);
1114 const char *remove_leading_path(const char *in
, const char *prefix
);
1115 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
1116 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
1117 int normalize_path_copy(char *dst
, const char *src
);
1118 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
1119 char *strip_path_suffix(const char *path
, const char *suffix
);
1120 int daemon_avoid_alias(const char *path
);
1121 extern int is_ntfs_dotgit(const char *name
);
1124 * Return a newly allocated string with the evaluation of
1125 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1126 * "$HOME/.config/git/$filename". Return NULL upon error.
1128 extern char *xdg_config_home(const char *filename
);
1130 /* object replacement */
1131 #define LOOKUP_REPLACE_OBJECT 1
1132 #define LOOKUP_UNKNOWN_OBJECT 2
1133 extern void *read_sha1_file_extended(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
, unsigned flag
);
1134 static inline void *read_sha1_file(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
)
1136 return read_sha1_file_extended(sha1
, type
, size
, LOOKUP_REPLACE_OBJECT
);
1140 * This internal function is only declared here for the benefit of
1141 * lookup_replace_object(). Please do not call it directly.
1143 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1
);
1146 * If object sha1 should be replaced, return the replacement object's
1147 * name (replaced recursively, if necessary). The return value is
1148 * either sha1 or a pointer to a permanently-allocated value. When
1149 * object replacement is suppressed, always return sha1.
1151 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1
)
1153 if (!check_replace_refs
)
1155 return do_lookup_replace_object(sha1
);
1158 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1
, unsigned flag
)
1160 if (!(flag
& LOOKUP_REPLACE_OBJECT
))
1162 return lookup_replace_object(sha1
);
1165 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1166 extern int sha1_object_info(const unsigned char *, unsigned long *);
1167 extern int hash_sha1_file(const void *buf
, unsigned long len
, const char *type
, unsigned char *sha1
);
1168 extern int write_sha1_file(const void *buf
, unsigned long len
, const char *type
, unsigned char *return_sha1
);
1169 extern int hash_sha1_file_literally(const void *buf
, unsigned long len
, const char *type
, unsigned char *sha1
, unsigned flags
);
1170 extern int pretend_sha1_file(void *, unsigned long, enum object_type
, unsigned char *);
1171 extern int force_object_loose(const unsigned char *sha1
, time_t mtime
);
1172 extern int git_open(const char *name
);
1173 extern void *map_sha1_file(const unsigned char *sha1
, unsigned long *size
);
1174 extern int unpack_sha1_header(git_zstream
*stream
, unsigned char *map
, unsigned long mapsize
, void *buffer
, unsigned long bufsiz
);
1175 extern int parse_sha1_header(const char *hdr
, unsigned long *sizep
);
1177 /* global flag to enable extra checks when accessing packed objects */
1178 extern int do_check_packed_object_crc
;
1180 extern int check_sha1_signature(const unsigned char *sha1
, void *buf
, unsigned long size
, const char *type
);
1182 extern int finalize_object_file(const char *tmpfile
, const char *filename
);
1184 extern int has_sha1_pack(const unsigned char *sha1
);
1187 * Return true iff we have an object named sha1, whether local or in
1188 * an alternate object database, and whether packed or loose. This
1189 * function does not respect replace references.
1191 * If the QUICK flag is set, do not re-check the pack directory
1192 * when we cannot find the object (this means we may give a false
1193 * negative answer if another process is simultaneously repacking).
1195 #define HAS_SHA1_QUICK 0x1
1196 extern int has_sha1_file_with_flags(const unsigned char *sha1
, int flags
);
1197 static inline int has_sha1_file(const unsigned char *sha1
)
1199 return has_sha1_file_with_flags(sha1
, 0);
1202 /* Same as the above, except for struct object_id. */
1203 extern int has_object_file(const struct object_id
*oid
);
1204 extern int has_object_file_with_flags(const struct object_id
*oid
, int flags
);
1207 * Return true iff an alternate object database has a loose object
1208 * with the specified name. This function does not respect replace
1211 extern int has_loose_object_nonlocal(const unsigned char *sha1
);
1213 extern int has_pack_index(const unsigned char *sha1
);
1215 extern void assert_sha1_type(const unsigned char *sha1
, enum object_type expect
);
1217 extern const signed char hexval_table
[256];
1218 static inline unsigned int hexval(unsigned char c
)
1220 return hexval_table
[c
];
1224 * Convert two consecutive hexadecimal digits into a char. Return a
1225 * negative value on error. Don't run over the end of short strings.
1227 static inline int hex2chr(const char *s
)
1229 int val
= hexval(s
[0]);
1230 return (val
< 0) ? val
: (val
<< 4) | hexval(s
[1]);
1233 /* Convert to/from hex/sha1 representation */
1234 #define MINIMUM_ABBREV minimum_abbrev
1235 #define DEFAULT_ABBREV default_abbrev
1237 /* used when the code does not know or care what the default abbrev is */
1238 #define FALLBACK_DEFAULT_ABBREV 7
1240 struct object_context
{
1241 unsigned char tree
[20];
1242 char path
[PATH_MAX
];
1245 * symlink_path is only used by get_tree_entry_follow_symlinks,
1246 * and only for symlinks that point outside the repository.
1248 struct strbuf symlink_path
;
1251 #define GET_SHA1_QUIETLY 01
1252 #define GET_SHA1_COMMIT 02
1253 #define GET_SHA1_COMMITTISH 04
1254 #define GET_SHA1_TREE 010
1255 #define GET_SHA1_TREEISH 020
1256 #define GET_SHA1_BLOB 040
1257 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1258 #define GET_SHA1_ONLY_TO_DIE 04000
1260 #define GET_SHA1_DISAMBIGUATORS \
1261 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1262 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1265 extern int get_sha1(const char *str
, unsigned char *sha1
);
1266 extern int get_sha1_commit(const char *str
, unsigned char *sha1
);
1267 extern int get_sha1_committish(const char *str
, unsigned char *sha1
);
1268 extern int get_sha1_tree(const char *str
, unsigned char *sha1
);
1269 extern int get_sha1_treeish(const char *str
, unsigned char *sha1
);
1270 extern int get_sha1_blob(const char *str
, unsigned char *sha1
);
1271 extern void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
);
1272 extern int get_sha1_with_context(const char *str
, unsigned flags
, unsigned char *sha1
, struct object_context
*orc
);
1274 extern int get_oid(const char *str
, struct object_id
*oid
);
1276 typedef int each_abbrev_fn(const unsigned char *sha1
, void *);
1277 extern int for_each_abbrev(const char *prefix
, each_abbrev_fn
, void *);
1279 extern int set_disambiguate_hint_config(const char *var
, const char *value
);
1282 * Try to read a SHA1 in hexadecimal format from the 40 characters
1283 * starting at hex. Write the 20-byte result to sha1 in binary form.
1284 * Return 0 on success. Reading stops if a NUL is encountered in the
1285 * input, so it is safe to pass this function an arbitrary
1286 * null-terminated string.
1288 extern int get_sha1_hex(const char *hex
, unsigned char *sha1
);
1289 extern int get_oid_hex(const char *hex
, struct object_id
*sha1
);
1292 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1293 * and writes the NUL-terminated output to the buffer `out`, which must be at
1294 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1297 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1298 * buffers, making it safe to make multiple calls for a single statement, like:
1300 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1302 extern char *sha1_to_hex_r(char *out
, const unsigned char *sha1
);
1303 extern char *oid_to_hex_r(char *out
, const struct object_id
*oid
);
1304 extern char *sha1_to_hex(const unsigned char *sha1
); /* static buffer result! */
1305 extern char *oid_to_hex(const struct object_id
*oid
); /* same static buffer as sha1_to_hex */
1307 extern int interpret_branch_name(const char *str
, int len
, struct strbuf
*);
1308 extern int get_oid_mb(const char *str
, struct object_id
*oid
);
1310 extern int validate_headref(const char *ref
);
1312 extern int base_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1313 extern int df_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1314 extern int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1315 extern int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1317 extern void *read_object_with_reference(const unsigned char *sha1
,
1318 const char *required_type
,
1319 unsigned long *size
,
1320 unsigned char *sha1_ret
);
1322 extern struct object
*peel_to_type(const char *name
, int namelen
,
1323 struct object
*o
, enum object_type
);
1326 enum date_mode_type
{
1331 DATE_ISO8601_STRICT
,
1337 const char *strftime_fmt
;
1342 * Convenience helper for passing a constant type, like:
1344 * show_date(t, tz, DATE_MODE(NORMAL));
1346 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1347 struct date_mode
*date_mode_from_type(enum date_mode_type type
);
1349 const char *show_date(unsigned long time
, int timezone
, const struct date_mode
*mode
);
1350 void show_date_relative(unsigned long time
, int tz
, const struct timeval
*now
,
1351 struct strbuf
*timebuf
);
1352 int parse_date(const char *date
, struct strbuf
*out
);
1353 int parse_date_basic(const char *date
, unsigned long *timestamp
, int *offset
);
1354 int parse_expiry_date(const char *date
, unsigned long *timestamp
);
1355 void datestamp(struct strbuf
*out
);
1356 #define approxidate(s) approxidate_careful((s), NULL)
1357 unsigned long approxidate_careful(const char *, int *);
1358 unsigned long approxidate_relative(const char *date
, const struct timeval
*now
);
1359 void parse_date_format(const char *format
, struct date_mode
*mode
);
1360 int date_overflows(unsigned long date
);
1362 #define IDENT_STRICT 1
1363 #define IDENT_NO_DATE 2
1364 #define IDENT_NO_NAME 4
1365 extern const char *git_author_info(int);
1366 extern const char *git_committer_info(int);
1367 extern const char *fmt_ident(const char *name
, const char *email
, const char *date_str
, int);
1368 extern const char *fmt_name(const char *name
, const char *email
);
1369 extern const char *ident_default_name(void);
1370 extern const char *ident_default_email(void);
1371 extern const char *git_editor(void);
1372 extern const char *git_pager(int stdout_is_tty
);
1373 extern int git_ident_config(const char *, const char *, void *);
1374 extern void reset_ident_date(void);
1376 struct ident_split
{
1377 const char *name_begin
;
1378 const char *name_end
;
1379 const char *mail_begin
;
1380 const char *mail_end
;
1381 const char *date_begin
;
1382 const char *date_end
;
1383 const char *tz_begin
;
1387 * Signals an success with 0, but time part of the result may be NULL
1388 * if the input lacks timestamp and zone
1390 extern int split_ident_line(struct ident_split
*, const char *, int);
1393 * Like show_date, but pull the timestamp and tz parameters from
1394 * the ident_split. It will also sanity-check the values and produce
1395 * a well-known sentinel date if they appear bogus.
1397 const char *show_ident_date(const struct ident_split
*id
,
1398 const struct date_mode
*mode
);
1401 * Compare split idents for equality or strict ordering. Note that we
1402 * compare only the ident part of the line, ignoring any timestamp.
1404 * Because there are two fields, we must choose one as the primary key; we
1405 * currently arbitrarily pick the email.
1407 extern int ident_cmp(const struct ident_split
*, const struct ident_split
*);
1410 struct index_state
*istate
;
1411 const char *base_dir
;
1418 #define CHECKOUT_INIT { NULL, "" }
1420 #define TEMPORARY_FILENAME_LENGTH 25
1421 extern int checkout_entry(struct cache_entry
*ce
, const struct checkout
*state
, char *topath
);
1427 int prefix_len_stat_func
;
1429 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1430 static inline void cache_def_clear(struct cache_def
*cache
)
1432 strbuf_release(&cache
->path
);
1435 extern int has_symlink_leading_path(const char *name
, int len
);
1436 extern int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1437 extern int check_leading_path(const char *name
, int len
);
1438 extern int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1439 extern void schedule_dir_for_removal(const char *name
, int len
);
1440 extern void remove_scheduled_dirs(void);
1442 extern struct alternate_object_database
{
1443 struct alternate_object_database
*next
;
1445 /* see alt_scratch_buf() */
1446 struct strbuf scratch
;
1449 char path
[FLEX_ARRAY
];
1451 extern void prepare_alt_odb(void);
1452 extern void read_info_alternates(const char * relative_base
, int depth
);
1453 extern char *compute_alternate_path(const char *path
, struct strbuf
*err
);
1454 typedef int alt_odb_fn(struct alternate_object_database
*, void *);
1455 extern int foreach_alt_odb(alt_odb_fn
, void*);
1458 * Allocate a "struct alternate_object_database" but do _not_ actually
1459 * add it to the list of alternates.
1461 struct alternate_object_database
*alloc_alt_odb(const char *dir
);
1464 * Add the directory to the on-disk alternates file; the new entry will also
1465 * take effect in the current process.
1467 extern void add_to_alternates_file(const char *dir
);
1470 * Add the directory to the in-memory list of alternates (along with any
1471 * recursive alternates it points to), but do not modify the on-disk alternates
1474 extern void add_to_alternates_memory(const char *dir
);
1477 * Returns a scratch strbuf pre-filled with the alternate object directory,
1478 * including a trailing slash, which can be used to access paths in the
1479 * alternate. Always use this over direct access to alt->scratch, as it
1480 * cleans up any previous use of the scratch buffer.
1482 extern struct strbuf
*alt_scratch_buf(struct alternate_object_database
*alt
);
1484 struct pack_window
{
1485 struct pack_window
*next
;
1486 unsigned char *base
;
1489 unsigned int last_used
;
1490 unsigned int inuse_cnt
;
1493 extern struct packed_git
{
1494 struct packed_git
*next
;
1495 struct pack_window
*windows
;
1497 const void *index_data
;
1499 uint32_t num_objects
;
1500 uint32_t num_bad_objects
;
1501 unsigned char *bad_object_sha1
;
1505 unsigned pack_local
:1,
1509 unsigned char sha1
[20];
1510 struct revindex_entry
*revindex
;
1511 /* something like ".git/objects/pack/xxxxx.pack" */
1512 char pack_name
[FLEX_ARRAY
]; /* more */
1516 * A most-recently-used ordered version of the packed_git list, which can
1517 * be iterated instead of packed_git (and marked via mru_mark).
1520 extern struct mru
*packed_git_mru
;
1524 unsigned char sha1
[20];
1525 struct packed_git
*p
;
1528 extern struct packed_git
*parse_pack_index(unsigned char *sha1
, const char *idx_path
);
1530 /* A hook to report invalid files in pack directory */
1531 #define PACKDIR_FILE_PACK 1
1532 #define PACKDIR_FILE_IDX 2
1533 #define PACKDIR_FILE_GARBAGE 4
1534 extern void (*report_garbage
)(unsigned seen_bits
, const char *path
);
1536 extern void prepare_packed_git(void);
1537 extern void reprepare_packed_git(void);
1538 extern void install_packed_git(struct packed_git
*pack
);
1541 * Give a rough count of objects in the repository. This sacrifices accuracy
1544 unsigned long approximate_object_count(void);
1546 extern struct packed_git
*find_sha1_pack(const unsigned char *sha1
,
1547 struct packed_git
*packs
);
1549 extern void pack_report(void);
1552 * mmap the index file for the specified packfile (if it is not
1553 * already mmapped). Return 0 on success.
1555 extern int open_pack_index(struct packed_git
*);
1558 * munmap the index file for the specified packfile (if it is
1559 * currently mmapped).
1561 extern void close_pack_index(struct packed_git
*);
1563 extern unsigned char *use_pack(struct packed_git
*, struct pack_window
**, off_t
, unsigned long *);
1564 extern void close_pack_windows(struct packed_git
*);
1565 extern void close_all_packs(void);
1566 extern void unuse_pack(struct pack_window
**);
1567 extern void clear_delta_base_cache(void);
1568 extern struct packed_git
*add_packed_git(const char *path
, size_t path_len
, int local
);
1571 * Make sure that a pointer access into an mmap'd index file is within bounds,
1572 * and can provide at least 8 bytes of data.
1574 * Note that this is only necessary for variable-length segments of the file
1575 * (like the 64-bit extended offset table), as we compare the size to the
1576 * fixed-length parts when we open the file.
1578 extern void check_pack_index_ptr(const struct packed_git
*p
, const void *ptr
);
1581 * Return the SHA-1 of the nth object within the specified packfile.
1582 * Open the index if it is not already open. The return value points
1583 * at the SHA-1 within the mmapped index. Return NULL if there is an
1586 extern const unsigned char *nth_packed_object_sha1(struct packed_git
*, uint32_t n
);
1589 * Return the offset of the nth object within the specified packfile.
1590 * The index must already be opened.
1592 extern off_t
nth_packed_object_offset(const struct packed_git
*, uint32_t n
);
1595 * If the object named sha1 is present in the specified packfile,
1596 * return its offset within the packfile; otherwise, return 0.
1598 extern off_t
find_pack_entry_one(const unsigned char *sha1
, struct packed_git
*);
1600 extern int is_pack_valid(struct packed_git
*);
1601 extern void *unpack_entry(struct packed_git
*, off_t
, enum object_type
*, unsigned long *);
1602 extern unsigned long unpack_object_header_buffer(const unsigned char *buf
, unsigned long len
, enum object_type
*type
, unsigned long *sizep
);
1603 extern unsigned long get_size_from_delta(struct packed_git
*, struct pack_window
**, off_t
);
1604 extern int unpack_object_header(struct packed_git
*, struct pack_window
**, off_t
*, unsigned long *);
1607 * Iterate over the files in the loose-object parts of the object
1608 * directory "path", triggering the following callbacks:
1610 * - loose_object is called for each loose object we find.
1612 * - loose_cruft is called for any files that do not appear to be
1613 * loose objects. Note that we only look in the loose object
1614 * directories "objects/[0-9a-f]{2}/", so we will not report
1615 * "objects/foobar" as cruft.
1617 * - loose_subdir is called for each top-level hashed subdirectory
1618 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1619 * after the objects in the directory are processed.
1621 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1622 * will end the iteration.
1624 * In the "buf" variant, "path" is a strbuf which will also be used as a
1625 * scratch buffer, but restored to its original contents before
1626 * the function returns.
1628 typedef int each_loose_object_fn(const unsigned char *sha1
,
1631 typedef int each_loose_cruft_fn(const char *basename
,
1634 typedef int each_loose_subdir_fn(int nr
,
1637 int for_each_loose_file_in_objdir(const char *path
,
1638 each_loose_object_fn obj_cb
,
1639 each_loose_cruft_fn cruft_cb
,
1640 each_loose_subdir_fn subdir_cb
,
1642 int for_each_loose_file_in_objdir_buf(struct strbuf
*path
,
1643 each_loose_object_fn obj_cb
,
1644 each_loose_cruft_fn cruft_cb
,
1645 each_loose_subdir_fn subdir_cb
,
1649 * Iterate over loose and packed objects in both the local
1650 * repository and any alternates repositories (unless the
1651 * LOCAL_ONLY flag is set).
1653 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1654 typedef int each_packed_object_fn(const unsigned char *sha1
,
1655 struct packed_git
*pack
,
1658 extern int for_each_loose_object(each_loose_object_fn
, void *, unsigned flags
);
1659 extern int for_each_packed_object(each_packed_object_fn
, void *, unsigned flags
);
1661 struct object_info
{
1663 enum object_type
*typep
;
1664 unsigned long *sizep
;
1666 unsigned char *delta_base_sha1
;
1667 struct strbuf
*typename
;
1679 * ... Nothing to expose in this case
1682 * ... Nothing to expose in this case
1686 struct packed_git
*pack
;
1688 unsigned int is_delta
;
1694 * Initializer for a "struct object_info" that wants no items. You may
1695 * also memset() the memory to all-zeroes.
1697 #define OBJECT_INFO_INIT {NULL}
1699 extern int sha1_object_info_extended(const unsigned char *, struct object_info
*, unsigned flags
);
1700 extern int packed_object_info(struct packed_git
*pack
, off_t offset
, struct object_info
*);
1702 /* Dumb servers support */
1703 extern int update_server_info(int);
1705 /* git_config_parse_key() returns these negated: */
1706 #define CONFIG_INVALID_KEY 1
1707 #define CONFIG_NO_SECTION_OR_NAME 2
1708 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1709 #define CONFIG_NO_LOCK -1
1710 #define CONFIG_INVALID_FILE 3
1711 #define CONFIG_NO_WRITE 4
1712 #define CONFIG_NOTHING_SET 5
1713 #define CONFIG_INVALID_PATTERN 6
1714 #define CONFIG_GENERIC_ERROR 7
1716 #define CONFIG_REGEX_NONE ((void *)1)
1718 struct git_config_source
{
1719 unsigned int use_stdin
:1;
1724 enum config_origin_type
{
1727 CONFIG_ORIGIN_STDIN
,
1728 CONFIG_ORIGIN_SUBMODULE_BLOB
,
1729 CONFIG_ORIGIN_CMDLINE
1732 typedef int (*config_fn_t
)(const char *, const char *, void *);
1733 extern int git_default_config(const char *, const char *, void *);
1734 extern int git_config_from_file(config_fn_t fn
, const char *, void *);
1735 extern int git_config_from_mem(config_fn_t fn
, const enum config_origin_type
,
1736 const char *name
, const char *buf
, size_t len
, void *data
);
1737 extern void git_config_push_parameter(const char *text
);
1738 extern int git_config_from_parameters(config_fn_t fn
, void *data
);
1739 extern void git_config(config_fn_t fn
, void *);
1740 extern int git_config_with_options(config_fn_t fn
, void *,
1741 struct git_config_source
*config_source
,
1742 int respect_includes
);
1743 extern int git_parse_ulong(const char *, unsigned long *);
1744 extern int git_parse_maybe_bool(const char *);
1745 extern int git_config_int(const char *, const char *);
1746 extern int64_t git_config_int64(const char *, const char *);
1747 extern unsigned long git_config_ulong(const char *, const char *);
1748 extern int git_config_bool_or_int(const char *, const char *, int *);
1749 extern int git_config_bool(const char *, const char *);
1750 extern int git_config_maybe_bool(const char *, const char *);
1751 extern int git_config_string(const char **, const char *, const char *);
1752 extern int git_config_pathname(const char **, const char *, const char *);
1753 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1754 extern void git_config_set_in_file(const char *, const char *, const char *);
1755 extern int git_config_set_gently(const char *, const char *);
1756 extern void git_config_set(const char *, const char *);
1757 extern int git_config_parse_key(const char *, char **, int *);
1758 extern int git_config_key_is_valid(const char *key
);
1759 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1760 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1761 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1762 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1763 extern int git_config_rename_section(const char *, const char *);
1764 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1765 extern const char *git_etc_gitconfig(void);
1766 extern int git_env_bool(const char *, int);
1767 extern unsigned long git_env_ulong(const char *, unsigned long);
1768 extern int git_config_system(void);
1769 extern int config_error_nonbool(const char *);
1770 #if defined(__GNUC__)
1771 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1773 extern const char *get_log_output_encoding(void);
1774 extern const char *get_commit_output_encoding(void);
1776 extern int git_config_parse_parameter(const char *, config_fn_t fn
, void *data
);
1779 CONFIG_SCOPE_UNKNOWN
= 0,
1780 CONFIG_SCOPE_SYSTEM
,
1781 CONFIG_SCOPE_GLOBAL
,
1783 CONFIG_SCOPE_CMDLINE
,
1786 extern enum config_scope
current_config_scope(void);
1787 extern const char *current_config_origin_type(void);
1788 extern const char *current_config_name(void);
1790 struct config_include_data
{
1795 #define CONFIG_INCLUDE_INIT { 0 }
1796 extern int git_config_include(const char *name
, const char *value
, void *data
);
1799 * Match and parse a config key of the form:
1801 * section.(subsection.)?key
1803 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1804 * we return -1 if it does not match, 0 otherwise. The subsection and key
1805 * out-parameters are filled by the function (and subsection is NULL if it is
1808 extern int parse_config_key(const char *var
,
1809 const char *section
,
1810 const char **subsection
, int *subsection_len
,
1813 struct config_set_element
{
1814 struct hashmap_entry ent
;
1816 struct string_list value_list
;
1819 struct configset_list_item
{
1820 struct config_set_element
*e
;
1825 * the contents of the list are ordered according to their
1826 * position in the config files and order of parsing the files.
1827 * (i.e. key-value pair at the last position of .git/config will
1828 * be at the last item of the list)
1830 struct configset_list
{
1831 struct configset_list_item
*items
;
1832 unsigned int nr
, alloc
;
1836 struct hashmap config_hash
;
1837 int hash_initialized
;
1838 struct configset_list list
;
1841 extern void git_configset_init(struct config_set
*cs
);
1842 extern int git_configset_add_file(struct config_set
*cs
, const char *filename
);
1843 extern int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
);
1844 extern const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
);
1845 extern void git_configset_clear(struct config_set
*cs
);
1846 extern int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
);
1847 extern int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
);
1848 extern int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
);
1849 extern int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
);
1850 extern int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
);
1851 extern int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
, int *is_bool
, int *dest
);
1852 extern int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
);
1853 extern int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
);
1855 extern int git_config_get_value(const char *key
, const char **value
);
1856 extern const struct string_list
*git_config_get_value_multi(const char *key
);
1857 extern void git_config_clear(void);
1858 extern void git_config_iter(config_fn_t fn
, void *data
);
1859 extern int git_config_get_string_const(const char *key
, const char **dest
);
1860 extern int git_config_get_string(const char *key
, char **dest
);
1861 extern int git_config_get_int(const char *key
, int *dest
);
1862 extern int git_config_get_ulong(const char *key
, unsigned long *dest
);
1863 extern int git_config_get_bool(const char *key
, int *dest
);
1864 extern int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
);
1865 extern int git_config_get_maybe_bool(const char *key
, int *dest
);
1866 extern int git_config_get_pathname(const char *key
, const char **dest
);
1867 extern int git_config_get_untracked_cache(void);
1870 * This is a hack for test programs like test-dump-untracked-cache to
1871 * ensure that they do not modify the untracked cache when reading it.
1872 * Do not use it otherwise!
1874 extern int ignore_untracked_cache_config
;
1876 struct key_value_info
{
1877 const char *filename
;
1879 enum config_origin_type origin_type
;
1880 enum config_scope scope
;
1883 extern NORETURN
void git_die_config(const char *key
, const char *err
, ...) __attribute__((format(printf
, 2, 3)));
1884 extern NORETURN
void git_die_config_linenr(const char *key
, const char *filename
, int linenr
);
1886 extern int committer_ident_sufficiently_given(void);
1887 extern int author_ident_sufficiently_given(void);
1889 extern const char *git_commit_encoding
;
1890 extern const char *git_log_output_encoding
;
1891 extern const char *git_mailmap_file
;
1892 extern const char *git_mailmap_blob
;
1894 /* IO helper functions */
1895 extern void maybe_flush_or_die(FILE *, const char *);
1896 __attribute__((format (printf
, 2, 3)))
1897 extern void fprintf_or_die(FILE *, const char *fmt
, ...);
1899 #define COPY_READ_ERROR (-2)
1900 #define COPY_WRITE_ERROR (-3)
1901 extern int copy_fd(int ifd
, int ofd
);
1902 extern int copy_file(const char *dst
, const char *src
, int mode
);
1903 extern int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1905 extern void write_or_die(int fd
, const void *buf
, size_t count
);
1906 extern void fsync_or_die(int fd
, const char *);
1908 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1909 extern ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1910 extern ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1912 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1914 return write_in_full(fd
, str
, strlen(str
));
1918 * Open (and truncate) the file at path, write the contents of buf to it,
1919 * and close it. Dies if any errors are encountered.
1921 extern void write_file_buf(const char *path
, const char *buf
, size_t len
);
1924 * Like write_file_buf(), but format the contents into a buffer first.
1925 * Additionally, write_file() will append a newline if one is not already
1926 * present, making it convenient to write text files:
1928 * write_file(path, "counter: %d", ctr);
1930 __attribute__((format (printf
, 2, 3)))
1931 extern void write_file(const char *path
, const char *fmt
, ...);
1934 extern void setup_pager(void);
1935 extern int pager_in_use(void);
1936 extern int pager_use_color
;
1937 extern int term_columns(void);
1938 extern int decimal_width(uintmax_t);
1939 extern int check_pager_config(const char *cmd
);
1940 extern void prepare_pager_args(struct child_process
*, const char *pager
);
1942 extern const char *editor_program
;
1943 extern const char *askpass_program
;
1944 extern const char *excludes_file
;
1947 int decode_85(char *dst
, const char *line
, int linelen
);
1948 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1951 extern void *alloc_blob_node(void);
1952 extern void *alloc_tree_node(void);
1953 extern void *alloc_commit_node(void);
1954 extern void *alloc_tag_node(void);
1955 extern void *alloc_object_node(void);
1956 extern void alloc_report(void);
1957 extern unsigned int alloc_commit_index(void);
1960 void packet_trace_identity(const char *prog
);
1964 * return 0 if success, 1 - if addition of a file failed and
1965 * ADD_FILES_IGNORE_ERRORS was specified in flags
1967 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1970 extern int diff_auto_refresh_index
;
1973 void shift_tree(const struct object_id
*, const struct object_id
*, struct object_id
*, int);
1974 void shift_tree_by(const struct object_id
*, const struct object_id
*, struct object_id
*, const char *);
1978 * used by both diff and apply
1979 * last two digits are tab width
1981 #define WS_BLANK_AT_EOL 0100
1982 #define WS_SPACE_BEFORE_TAB 0200
1983 #define WS_INDENT_WITH_NON_TAB 0400
1984 #define WS_CR_AT_EOL 01000
1985 #define WS_BLANK_AT_EOF 02000
1986 #define WS_TAB_IN_INDENT 04000
1987 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1988 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1989 #define WS_TAB_WIDTH_MASK 077
1990 extern unsigned whitespace_rule_cfg
;
1991 extern unsigned whitespace_rule(const char *);
1992 extern unsigned parse_whitespace_rule(const char *);
1993 extern unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1994 extern void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1995 extern char *whitespace_error_string(unsigned ws
);
1996 extern void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1997 extern int ws_blank_line(const char *line
, int len
, unsigned ws_rule
);
1998 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
2001 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
);
2003 char *alias_lookup(const char *alias
);
2004 int split_cmdline(char *cmdline
, const char ***argv
);
2005 /* Takes a negative value returned by split_cmdline */
2006 const char *split_cmdline_strerror(int cmdline_errno
);
2009 struct startup_info
{
2010 int have_repository
;
2013 extern struct startup_info
*startup_info
;
2017 int try_merge_command(const char *strategy
, size_t xopts_nr
,
2018 const char **xopts
, struct commit_list
*common
,
2019 const char *head_arg
, struct commit_list
*remotes
);
2020 int checkout_fast_forward(const unsigned char *from
,
2021 const unsigned char *to
,
2022 int overwrite_ignore
);
2025 int sane_execvp(const char *file
, char *const argv
[]);
2028 * A struct to encapsulate the concept of whether a file has changed
2029 * since we last checked it. This uses criteria similar to those used
2032 struct stat_validity
{
2033 struct stat_data
*sd
;
2036 void stat_validity_clear(struct stat_validity
*sv
);
2039 * Returns 1 if the path is a regular file (or a symlink to a regular
2040 * file) and matches the saved stat_validity, 0 otherwise. A missing
2041 * or inaccessible file is considered a match if the struct was just
2042 * initialized, or if the previous update found an inaccessible file.
2044 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
2047 * Update the stat_validity from a file opened at descriptor fd. If
2048 * the file is missing, inaccessible, or not a regular file, then
2049 * future calls to stat_validity_check will match iff one of those
2050 * conditions continues to be true.
2052 void stat_validity_update(struct stat_validity
*sv
, int fd
);
2054 int versioncmp(const char *s1
, const char *s2
);
2055 void sleep_millisec(int millisec
);
2058 * Create a directory and (if share is nonzero) adjust its permissions
2059 * according to the shared_repository setting. Only use this for
2060 * directories under $GIT_DIR. Don't use it for working tree
2063 void safe_create_dir(const char *dir
, int share
);
2065 #endif /* CACHE_H */