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 unsigned char sha1
[20];
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 refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
373 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
374 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
375 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
376 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
377 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
378 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
379 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
380 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
381 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
391 /* 5 for future expansion */
398 static inline enum object_type
object_type(unsigned int mode
)
400 return S_ISDIR(mode
) ? OBJ_TREE
:
401 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
405 /* Double-check local_repo_env below if you add to this list. */
406 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
407 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
408 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
409 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
410 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
411 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
412 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
413 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
414 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
415 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
416 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
417 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
418 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
419 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
420 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
421 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
422 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
423 #define GITATTRIBUTES_FILE ".gitattributes"
424 #define INFOATTRIBUTES_FILE "info/attributes"
425 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
426 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
427 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
428 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
429 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
430 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
431 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
432 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
433 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
434 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
437 * This environment variable is expected to contain a boolean indicating
438 * whether we should or should not treat:
440 * GIT_DIR=foo.git git ...
442 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
443 * of this, but we use it internally to communicate to sub-processes that we
444 * are in a bare repo. If not set, defaults to true.
446 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
449 * Repository-local GIT_* environment variables; these will be cleared
450 * when git spawns a sub-process that runs inside another repository.
451 * The array is NULL-terminated, which makes it easy to pass in the "env"
452 * parameter of a run-command invocation, or to do a simple walk.
454 extern const char * const local_repo_env
[];
456 extern int is_bare_repository_cfg
;
457 extern int is_bare_repository(void);
458 extern int is_inside_git_dir(void);
459 extern char *git_work_tree_cfg
;
460 extern int is_inside_work_tree(void);
461 extern const char *get_git_dir(void);
462 extern const char *get_git_common_dir(void);
463 extern char *get_object_directory(void);
464 extern char *get_index_file(void);
465 extern char *get_graft_file(void);
466 extern int set_git_dir(const char *path
);
467 extern int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
);
468 extern int get_common_dir(struct strbuf
*sb
, const char *gitdir
);
469 extern const char *get_git_namespace(void);
470 extern const char *strip_namespace(const char *namespaced_ref
);
471 extern const char *get_git_work_tree(void);
474 * Return true if the given path is a git directory; note that this _just_
475 * looks at the directory itself. If you want to know whether "foo/.git"
476 * is a repository, you must feed that path, not just "foo".
478 extern int is_git_directory(const char *path
);
481 * Return 1 if the given path is the root of a git repository or
482 * submodule, else 0. Will not return 1 for bare repositories with the
483 * exception of creating a bare repository in "foo/.git" and calling
484 * is_git_repository("foo").
486 * If we run into read errors, we err on the side of saying "yes, it is",
487 * as we usually consider sub-repos precious, and would prefer to err on the
488 * side of not disrupting or deleting them.
490 extern int is_nonbare_repository_dir(struct strbuf
*path
);
492 #define READ_GITFILE_ERR_STAT_FAILED 1
493 #define READ_GITFILE_ERR_NOT_A_FILE 2
494 #define READ_GITFILE_ERR_OPEN_FAILED 3
495 #define READ_GITFILE_ERR_READ_FAILED 4
496 #define READ_GITFILE_ERR_INVALID_FORMAT 5
497 #define READ_GITFILE_ERR_NO_PATH 6
498 #define READ_GITFILE_ERR_NOT_A_REPO 7
499 #define READ_GITFILE_ERR_TOO_LARGE 8
500 extern const char *read_gitfile_gently(const char *path
, int *return_error_code
);
501 #define read_gitfile(path) read_gitfile_gently((path), NULL)
502 extern const char *resolve_gitdir(const char *suspect
);
503 extern void set_git_work_tree(const char *tree
);
505 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
507 extern const char **get_pathspec(const char *prefix
, const char **pathspec
);
508 extern void setup_work_tree(void);
509 extern const char *setup_git_directory_gently(int *);
510 extern const char *setup_git_directory(void);
511 extern char *prefix_path(const char *prefix
, int len
, const char *path
);
512 extern char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
513 extern const char *prefix_filename(const char *prefix
, int len
, const char *path
);
514 extern int check_filename(const char *prefix
, const char *name
);
515 extern void verify_filename(const char *prefix
,
517 int diagnose_misspelt_rev
);
518 extern void verify_non_filename(const char *prefix
, const char *name
);
519 extern int path_inside_repo(const char *prefix
, const char *path
);
521 #define INIT_DB_QUIET 0x0001
523 extern int set_git_dir_init(const char *git_dir
, const char *real_git_dir
, int);
524 extern int init_db(const char *template_dir
, unsigned int flags
);
526 extern void sanitize_stdfds(void);
527 extern int daemonize(void);
529 #define alloc_nr(x) (((x)+16)*3/2)
532 * Realloc the buffer pointed at by variable 'x' so that it can hold
533 * at least 'nr' entries; the number of entries currently allocated
534 * is 'alloc', using the standard growing factor alloc_nr() macro.
536 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
538 #define ALLOC_GROW(x, nr, alloc) \
540 if ((nr) > alloc) { \
541 if (alloc_nr(alloc) < (nr)) \
544 alloc = alloc_nr(alloc); \
545 REALLOC_ARRAY(x, alloc); \
549 /* Initialize and use the cache information */
551 extern int read_index(struct index_state
*);
552 extern int read_index_preload(struct index_state
*, const struct pathspec
*pathspec
);
553 extern int do_read_index(struct index_state
*istate
, const char *path
,
554 int must_exist
); /* for testting only! */
555 extern int read_index_from(struct index_state
*, const char *path
);
556 extern int is_index_unborn(struct index_state
*);
557 extern int read_index_unmerged(struct index_state
*);
558 #define COMMIT_LOCK (1 << 0)
559 #define CLOSE_LOCK (1 << 1)
560 extern int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
561 extern int discard_index(struct index_state
*);
562 extern int unmerged_index(const struct index_state
*);
563 extern int verify_path(const char *path
);
564 extern int index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
565 extern void adjust_dirname_case(struct index_state
*istate
, char *name
);
566 extern struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
567 extern int index_name_pos(const struct index_state
*, const char *name
, int namelen
);
568 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
569 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
570 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
571 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
572 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
573 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
574 extern int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
575 extern void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
576 extern int remove_index_entry_at(struct index_state
*, int pos
);
577 extern void remove_marked_cache_entries(struct index_state
*istate
);
578 extern int remove_file_from_index(struct index_state
*, const char *path
);
579 #define ADD_CACHE_VERBOSE 1
580 #define ADD_CACHE_PRETEND 2
581 #define ADD_CACHE_IGNORE_ERRORS 4
582 #define ADD_CACHE_IGNORE_REMOVAL 8
583 #define ADD_CACHE_INTENT 16
584 extern int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
585 extern int add_file_to_index(struct index_state
*, const char *path
, int flags
);
586 extern struct cache_entry
*make_cache_entry(unsigned int mode
, const unsigned char *sha1
, const char *path
, int stage
, unsigned int refresh_options
);
587 extern int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
588 extern void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
589 extern int index_name_is_other(const struct index_state
*, const char *, int);
590 extern void *read_blob_data_from_index(struct index_state
*, const char *, unsigned long *);
592 /* do stat comparison even if CE_VALID is true */
593 #define CE_MATCH_IGNORE_VALID 01
594 /* do not check the contents but report dirty on racily-clean entries */
595 #define CE_MATCH_RACY_IS_DIRTY 02
596 /* do stat comparison even if CE_SKIP_WORKTREE is true */
597 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
598 /* ignore non-existent files during stat update */
599 #define CE_MATCH_IGNORE_MISSING 0x08
600 /* enable stat refresh */
601 #define CE_MATCH_REFRESH 0x10
602 extern int ie_match_stat(const struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
603 extern int ie_modified(const struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
605 #define HASH_WRITE_OBJECT 1
606 #define HASH_FORMAT_CHECK 2
607 extern int index_fd(unsigned char *sha1
, int fd
, struct stat
*st
, enum object_type type
, const char *path
, unsigned flags
);
608 extern int index_path(unsigned char *sha1
, const char *path
, struct stat
*st
, unsigned flags
);
611 * Record to sd the data from st that we use to check whether a file
612 * might have changed.
614 extern void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
617 * Return 0 if st is consistent with a file not having been changed
618 * since sd was filled. If there are differences, return a
619 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
620 * INODE_CHANGED, and DATA_CHANGED.
622 extern int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
623 extern int match_stat_data_racy(const struct index_state
*istate
,
624 const struct stat_data
*sd
, struct stat
*st
);
626 extern void fill_stat_cache_info(struct cache_entry
*ce
, struct stat
*st
);
628 #define REFRESH_REALLY 0x0001 /* ignore_valid */
629 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
630 #define REFRESH_QUIET 0x0004 /* be quiet about it */
631 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
632 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
633 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
634 extern int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
636 extern void update_index_if_able(struct index_state
*, struct lock_file
*);
638 extern int hold_locked_index(struct lock_file
*, int);
639 extern void set_alternate_index_output(const char *);
641 /* Environment bits from configuration mechanism */
642 extern int trust_executable_bit
;
643 extern int trust_ctime
;
644 extern int check_stat
;
645 extern int quote_path_fully
;
646 extern int has_symlinks
;
647 extern int minimum_abbrev
, default_abbrev
;
648 extern int ignore_case
;
649 extern int assume_unchanged
;
650 extern int prefer_symlink_refs
;
651 extern int log_all_ref_updates
;
652 extern int warn_ambiguous_refs
;
653 extern int warn_on_object_refname_ambiguity
;
654 extern const char *apply_default_whitespace
;
655 extern const char *apply_default_ignorewhitespace
;
656 extern const char *git_attributes_file
;
657 extern int zlib_compression_level
;
658 extern int core_compression_level
;
659 extern int core_compression_seen
;
660 extern size_t packed_git_window_size
;
661 extern size_t packed_git_limit
;
662 extern size_t delta_base_cache_limit
;
663 extern unsigned long big_file_threshold
;
664 extern unsigned long pack_size_limit_cfg
;
666 void set_shared_repository(int value
);
667 int get_shared_repository(void);
670 * Do replace refs need to be checked this run? This variable is
671 * initialized to true unless --no-replace-object is used or
672 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
673 * commands that do not want replace references to be active. As an
674 * optimization it is also set to false if replace references have
675 * been sought but there were none.
677 extern int check_replace_refs
;
678 extern char *git_replace_ref_base
;
680 extern int fsync_object_files
;
681 extern int core_preload_index
;
682 extern int core_apply_sparse_checkout
;
683 extern int precomposed_unicode
;
684 extern int protect_hfs
;
685 extern int protect_ntfs
;
686 extern int git_db_env
, git_index_env
, git_graft_env
, git_common_dir_env
;
689 * Include broken refs in all ref iterations, which will
690 * generally choke dangerous operations rather than letting
691 * them silently proceed without taking the broken ref into
694 extern int ref_paranoia
;
697 * The character that begins a commented line in user-editable file
698 * that is subject to stripspace.
700 extern char comment_line_char
;
701 extern int auto_comment_line_char
;
704 BRANCH_TRACK_UNSPECIFIED
= -1,
705 BRANCH_TRACK_NEVER
= 0,
708 BRANCH_TRACK_EXPLICIT
,
709 BRANCH_TRACK_OVERRIDE
712 enum rebase_setup_type
{
713 AUTOREBASE_NEVER
= 0,
719 enum push_default_type
{
720 PUSH_DEFAULT_NOTHING
= 0,
721 PUSH_DEFAULT_MATCHING
,
723 PUSH_DEFAULT_UPSTREAM
,
724 PUSH_DEFAULT_CURRENT
,
725 PUSH_DEFAULT_UNSPECIFIED
728 extern enum branch_track git_branch_track
;
729 extern enum rebase_setup_type autorebase
;
730 extern enum push_default_type push_default
;
732 enum object_creation_mode
{
733 OBJECT_CREATION_USES_HARDLINKS
= 0,
734 OBJECT_CREATION_USES_RENAMES
= 1
737 extern enum object_creation_mode object_creation_mode
;
739 extern char *notes_ref_name
;
741 extern int grafts_replace_parents
;
744 * GIT_REPO_VERSION is the version we write by default. The
745 * _READ variant is the highest number we know how to
748 #define GIT_REPO_VERSION 0
749 #define GIT_REPO_VERSION_READ 1
750 extern int repository_format_version
;
751 extern int repository_format_precious_objects
;
754 * Check the repository format version in the path found in get_git_dir(),
755 * and die if it is a version we don't understand. Generally one would
756 * set_git_dir() before calling this, and use it only for "are we in a valid
759 extern void check_repository_format(void);
761 #define MTIME_CHANGED 0x0001
762 #define CTIME_CHANGED 0x0002
763 #define OWNER_CHANGED 0x0004
764 #define MODE_CHANGED 0x0008
765 #define INODE_CHANGED 0x0010
766 #define DATA_CHANGED 0x0020
767 #define TYPE_CHANGED 0x0040
770 * Return a statically allocated filename, either generically (mkpath), in
771 * the repository directory (git_path), or in a submodule's repository
772 * directory (git_path_submodule). In all cases, note that the result
773 * may be overwritten by another call to _any_ of the functions. Consider
774 * using the safer "dup" or "strbuf" formats below (in some cases, the
775 * unsafe versions have already been removed).
777 extern const char *mkpath(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
778 extern const char *git_path(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
780 extern char *mksnpath(char *buf
, size_t n
, const char *fmt
, ...)
781 __attribute__((format (printf
, 3, 4)));
782 extern void strbuf_git_path(struct strbuf
*sb
, const char *fmt
, ...)
783 __attribute__((format (printf
, 2, 3)));
784 extern char *git_path_buf(struct strbuf
*buf
, const char *fmt
, ...)
785 __attribute__((format (printf
, 2, 3)));
786 extern void strbuf_git_path_submodule(struct strbuf
*sb
, const char *path
,
787 const char *fmt
, ...)
788 __attribute__((format (printf
, 3, 4)));
789 extern char *git_pathdup(const char *fmt
, ...)
790 __attribute__((format (printf
, 1, 2)));
791 extern char *mkpathdup(const char *fmt
, ...)
792 __attribute__((format (printf
, 1, 2)));
793 extern char *git_pathdup_submodule(const char *path
, const char *fmt
, ...)
794 __attribute__((format (printf
, 2, 3)));
796 extern void report_linked_checkout_garbage(void);
799 * You can define a static memoized git path like:
801 * static GIT_PATH_FUNC(git_path_foo, "FOO");
803 * or use one of the global ones below.
805 #define GIT_PATH_FUNC(func, filename) \
806 const char *func(void) \
810 ret = git_pathdup(filename); \
814 const char *git_path_cherry_pick_head(void);
815 const char *git_path_revert_head(void);
816 const char *git_path_squash_msg(void);
817 const char *git_path_merge_msg(void);
818 const char *git_path_merge_rr(void);
819 const char *git_path_merge_mode(void);
820 const char *git_path_merge_head(void);
821 const char *git_path_fetch_head(void);
822 const char *git_path_shallow(void);
825 * Return the name of the file in the local object database that would
826 * be used to store a loose object with the specified sha1. The
827 * return value is a pointer to a statically allocated buffer that is
828 * overwritten each time the function is called.
830 extern const char *sha1_file_name(const unsigned char *sha1
);
833 * Return the name of the (local) packfile with the specified sha1 in
834 * its name. The return value is a pointer to memory that is
835 * overwritten each time this function is called.
837 extern char *sha1_pack_name(const unsigned char *sha1
);
840 * Return the name of the (local) pack index file with the specified
841 * sha1 in its name. The return value is a pointer to memory that is
842 * overwritten each time this function is called.
844 extern char *sha1_pack_index_name(const unsigned char *sha1
);
847 * Return an abbreviated sha1 unique within this repository's object database.
848 * The result will be at least `len` characters long, and will be NUL
851 * The non-`_r` version returns a static buffer which will be overwritten by
854 * The `_r` variant writes to a buffer supplied by the caller, which must be at
855 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
856 * written (excluding the NUL terminator).
858 * Note that while this version avoids the static buffer, it is not fully
859 * reentrant, as it calls into other non-reentrant git code.
861 extern const char *find_unique_abbrev(const unsigned char *sha1
, int len
);
862 extern int find_unique_abbrev_r(char *hex
, const unsigned char *sha1
, int len
);
864 extern const unsigned char null_sha1
[GIT_SHA1_RAWSZ
];
865 extern const struct object_id null_oid
;
867 static inline int hashcmp(const unsigned char *sha1
, const unsigned char *sha2
)
871 for (i
= 0; i
< GIT_SHA1_RAWSZ
; i
++, sha1
++, sha2
++) {
873 return *sha1
- *sha2
;
879 static inline int oidcmp(const struct object_id
*oid1
, const struct object_id
*oid2
)
881 return hashcmp(oid1
->hash
, oid2
->hash
);
884 static inline int is_null_sha1(const unsigned char *sha1
)
886 return !hashcmp(sha1
, null_sha1
);
889 static inline int is_null_oid(const struct object_id
*oid
)
891 return !hashcmp(oid
->hash
, null_sha1
);
894 static inline void hashcpy(unsigned char *sha_dst
, const unsigned char *sha_src
)
896 memcpy(sha_dst
, sha_src
, GIT_SHA1_RAWSZ
);
899 static inline void oidcpy(struct object_id
*dst
, const struct object_id
*src
)
901 hashcpy(dst
->hash
, src
->hash
);
904 static inline void hashclr(unsigned char *hash
)
906 memset(hash
, 0, GIT_SHA1_RAWSZ
);
909 static inline void oidclr(struct object_id
*oid
)
915 #define EMPTY_TREE_SHA1_HEX \
916 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
917 #define EMPTY_TREE_SHA1_BIN_LITERAL \
918 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
919 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
920 #define EMPTY_TREE_SHA1_BIN \
921 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
923 #define EMPTY_BLOB_SHA1_HEX \
924 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
925 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
926 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
927 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
928 #define EMPTY_BLOB_SHA1_BIN \
929 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
931 static inline int is_empty_blob_sha1(const unsigned char *sha1
)
933 return !hashcmp(sha1
, EMPTY_BLOB_SHA1_BIN
);
936 int git_mkstemp(char *path
, size_t n
, const char *template);
938 int git_mkstemps(char *path
, size_t n
, const char *template, int suffix_len
);
940 /* set default permissions by passing mode arguments to open(2) */
941 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
942 int git_mkstemp_mode(char *pattern
, int mode
);
947 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
948 * not be changed. Old repositories have core.sharedrepository written in
949 * numeric format, and therefore these values are preserved for compatibility
955 OLD_PERM_EVERYBODY
= 2,
957 PERM_EVERYBODY
= 0664
959 int git_config_perm(const char *var
, const char *value
);
960 int adjust_shared_perm(const char *path
);
963 * Create the directory containing the named path, using care to be
964 * somewhat safe against races. Return one of the scld_error values
965 * to indicate success/failure.
967 * SCLD_VANISHED indicates that one of the ancestor directories of the
968 * path existed at one point during the function call and then
969 * suddenly vanished, probably because another process pruned the
970 * directory while we were working. To be robust against this kind of
971 * race, callers might want to try invoking the function again when it
972 * returns SCLD_VANISHED.
981 enum scld_error
safe_create_leading_directories(char *path
);
982 enum scld_error
safe_create_leading_directories_const(const char *path
);
984 int mkdir_in_gitdir(const char *path
);
985 extern char *expand_user_path(const char *path
);
986 const char *enter_repo(const char *path
, int strict
);
987 static inline int is_absolute_path(const char *path
)
989 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
991 int is_directory(const char *);
992 const char *real_path(const char *path
);
993 const char *real_path_if_valid(const char *path
);
994 const char *absolute_path(const char *path
);
995 const char *remove_leading_path(const char *in
, const char *prefix
);
996 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
997 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
998 int normalize_path_copy(char *dst
, const char *src
);
999 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
1000 char *strip_path_suffix(const char *path
, const char *suffix
);
1001 int daemon_avoid_alias(const char *path
);
1002 extern int is_ntfs_dotgit(const char *name
);
1005 * Return a newly allocated string with the evaluation of
1006 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1007 * "$HOME/.config/git/$filename". Return NULL upon error.
1009 extern char *xdg_config_home(const char *filename
);
1011 /* object replacement */
1012 #define LOOKUP_REPLACE_OBJECT 1
1013 #define LOOKUP_UNKNOWN_OBJECT 2
1014 extern void *read_sha1_file_extended(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
, unsigned flag
);
1015 static inline void *read_sha1_file(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
)
1017 return read_sha1_file_extended(sha1
, type
, size
, LOOKUP_REPLACE_OBJECT
);
1021 * This internal function is only declared here for the benefit of
1022 * lookup_replace_object(). Please do not call it directly.
1024 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1
);
1027 * If object sha1 should be replaced, return the replacement object's
1028 * name (replaced recursively, if necessary). The return value is
1029 * either sha1 or a pointer to a permanently-allocated value. When
1030 * object replacement is suppressed, always return sha1.
1032 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1
)
1034 if (!check_replace_refs
)
1036 return do_lookup_replace_object(sha1
);
1039 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1
, unsigned flag
)
1041 if (!(flag
& LOOKUP_REPLACE_OBJECT
))
1043 return lookup_replace_object(sha1
);
1046 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1047 extern int sha1_object_info(const unsigned char *, unsigned long *);
1048 extern int hash_sha1_file(const void *buf
, unsigned long len
, const char *type
, unsigned char *sha1
);
1049 extern int write_sha1_file(const void *buf
, unsigned long len
, const char *type
, unsigned char *return_sha1
);
1050 extern int hash_sha1_file_literally(const void *buf
, unsigned long len
, const char *type
, unsigned char *sha1
, unsigned flags
);
1051 extern int pretend_sha1_file(void *, unsigned long, enum object_type
, unsigned char *);
1052 extern int force_object_loose(const unsigned char *sha1
, time_t mtime
);
1053 extern int git_open_noatime(const char *name
);
1054 extern void *map_sha1_file(const unsigned char *sha1
, unsigned long *size
);
1055 extern int unpack_sha1_header(git_zstream
*stream
, unsigned char *map
, unsigned long mapsize
, void *buffer
, unsigned long bufsiz
);
1056 extern int parse_sha1_header(const char *hdr
, unsigned long *sizep
);
1058 /* global flag to enable extra checks when accessing packed objects */
1059 extern int do_check_packed_object_crc
;
1061 extern int check_sha1_signature(const unsigned char *sha1
, void *buf
, unsigned long size
, const char *type
);
1063 extern int finalize_object_file(const char *tmpfile
, const char *filename
);
1065 extern int has_sha1_pack(const unsigned char *sha1
);
1068 * Return true iff we have an object named sha1, whether local or in
1069 * an alternate object database, and whether packed or loose. This
1070 * function does not respect replace references.
1072 * If the QUICK flag is set, do not re-check the pack directory
1073 * when we cannot find the object (this means we may give a false
1074 * negative answer if another process is simultaneously repacking).
1076 #define HAS_SHA1_QUICK 0x1
1077 extern int has_sha1_file_with_flags(const unsigned char *sha1
, int flags
);
1078 static inline int has_sha1_file(const unsigned char *sha1
)
1080 return has_sha1_file_with_flags(sha1
, 0);
1083 /* Same as the above, except for struct object_id. */
1084 extern int has_object_file(const struct object_id
*oid
);
1087 * Return true iff an alternate object database has a loose object
1088 * with the specified name. This function does not respect replace
1091 extern int has_loose_object_nonlocal(const unsigned char *sha1
);
1093 extern int has_pack_index(const unsigned char *sha1
);
1095 extern void assert_sha1_type(const unsigned char *sha1
, enum object_type expect
);
1097 extern const signed char hexval_table
[256];
1098 static inline unsigned int hexval(unsigned char c
)
1100 return hexval_table
[c
];
1103 /* Convert to/from hex/sha1 representation */
1104 #define MINIMUM_ABBREV minimum_abbrev
1105 #define DEFAULT_ABBREV default_abbrev
1107 struct object_context
{
1108 unsigned char tree
[20];
1109 char path
[PATH_MAX
];
1112 * symlink_path is only used by get_tree_entry_follow_symlinks,
1113 * and only for symlinks that point outside the repository.
1115 struct strbuf symlink_path
;
1118 #define GET_SHA1_QUIETLY 01
1119 #define GET_SHA1_COMMIT 02
1120 #define GET_SHA1_COMMITTISH 04
1121 #define GET_SHA1_TREE 010
1122 #define GET_SHA1_TREEISH 020
1123 #define GET_SHA1_BLOB 040
1124 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1125 #define GET_SHA1_ONLY_TO_DIE 04000
1127 extern int get_sha1(const char *str
, unsigned char *sha1
);
1128 extern int get_sha1_commit(const char *str
, unsigned char *sha1
);
1129 extern int get_sha1_committish(const char *str
, unsigned char *sha1
);
1130 extern int get_sha1_tree(const char *str
, unsigned char *sha1
);
1131 extern int get_sha1_treeish(const char *str
, unsigned char *sha1
);
1132 extern int get_sha1_blob(const char *str
, unsigned char *sha1
);
1133 extern void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
);
1134 extern int get_sha1_with_context(const char *str
, unsigned flags
, unsigned char *sha1
, struct object_context
*orc
);
1136 typedef int each_abbrev_fn(const unsigned char *sha1
, void *);
1137 extern int for_each_abbrev(const char *prefix
, each_abbrev_fn
, void *);
1140 * Try to read a SHA1 in hexadecimal format from the 40 characters
1141 * starting at hex. Write the 20-byte result to sha1 in binary form.
1142 * Return 0 on success. Reading stops if a NUL is encountered in the
1143 * input, so it is safe to pass this function an arbitrary
1144 * null-terminated string.
1146 extern int get_sha1_hex(const char *hex
, unsigned char *sha1
);
1147 extern int get_oid_hex(const char *hex
, struct object_id
*sha1
);
1150 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1151 * and writes the NUL-terminated output to the buffer `out`, which must be at
1152 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1155 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1156 * buffers, making it safe to make multiple calls for a single statement, like:
1158 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1160 extern char *sha1_to_hex_r(char *out
, const unsigned char *sha1
);
1161 extern char *sha1_to_hex(const unsigned char *sha1
); /* static buffer result! */
1162 extern char *oid_to_hex(const struct object_id
*oid
); /* same static buffer as sha1_to_hex */
1164 extern int interpret_branch_name(const char *str
, int len
, struct strbuf
*);
1165 extern int get_sha1_mb(const char *str
, unsigned char *sha1
);
1167 extern int validate_headref(const char *ref
);
1169 extern int base_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1170 extern int df_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1171 extern int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1172 extern int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1174 extern void *read_object_with_reference(const unsigned char *sha1
,
1175 const char *required_type
,
1176 unsigned long *size
,
1177 unsigned char *sha1_ret
);
1179 extern struct object
*peel_to_type(const char *name
, int namelen
,
1180 struct object
*o
, enum object_type
);
1183 enum date_mode_type
{
1188 DATE_ISO8601_STRICT
,
1193 const char *strftime_fmt
;
1198 * Convenience helper for passing a constant type, like:
1200 * show_date(t, tz, DATE_MODE(NORMAL));
1202 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1203 struct date_mode
*date_mode_from_type(enum date_mode_type type
);
1205 const char *show_date(unsigned long time
, int timezone
, const struct date_mode
*mode
);
1206 void show_date_relative(unsigned long time
, int tz
, const struct timeval
*now
,
1207 struct strbuf
*timebuf
);
1208 int parse_date(const char *date
, struct strbuf
*out
);
1209 int parse_date_basic(const char *date
, unsigned long *timestamp
, int *offset
);
1210 int parse_expiry_date(const char *date
, unsigned long *timestamp
);
1211 void datestamp(struct strbuf
*out
);
1212 #define approxidate(s) approxidate_careful((s), NULL)
1213 unsigned long approxidate_careful(const char *, int *);
1214 unsigned long approxidate_relative(const char *date
, const struct timeval
*now
);
1215 void parse_date_format(const char *format
, struct date_mode
*mode
);
1216 int date_overflows(unsigned long date
);
1218 #define IDENT_STRICT 1
1219 #define IDENT_NO_DATE 2
1220 #define IDENT_NO_NAME 4
1221 extern const char *git_author_info(int);
1222 extern const char *git_committer_info(int);
1223 extern const char *fmt_ident(const char *name
, const char *email
, const char *date_str
, int);
1224 extern const char *fmt_name(const char *name
, const char *email
);
1225 extern const char *ident_default_name(void);
1226 extern const char *ident_default_email(void);
1227 extern const char *git_editor(void);
1228 extern const char *git_pager(int stdout_is_tty
);
1229 extern int git_ident_config(const char *, const char *, void *);
1231 struct ident_split
{
1232 const char *name_begin
;
1233 const char *name_end
;
1234 const char *mail_begin
;
1235 const char *mail_end
;
1236 const char *date_begin
;
1237 const char *date_end
;
1238 const char *tz_begin
;
1242 * Signals an success with 0, but time part of the result may be NULL
1243 * if the input lacks timestamp and zone
1245 extern int split_ident_line(struct ident_split
*, const char *, int);
1248 * Like show_date, but pull the timestamp and tz parameters from
1249 * the ident_split. It will also sanity-check the values and produce
1250 * a well-known sentinel date if they appear bogus.
1252 const char *show_ident_date(const struct ident_split
*id
,
1253 const struct date_mode
*mode
);
1256 * Compare split idents for equality or strict ordering. Note that we
1257 * compare only the ident part of the line, ignoring any timestamp.
1259 * Because there are two fields, we must choose one as the primary key; we
1260 * currently arbitrarily pick the email.
1262 extern int ident_cmp(const struct ident_split
*, const struct ident_split
*);
1265 struct index_state
*istate
;
1266 const char *base_dir
;
1274 #define TEMPORARY_FILENAME_LENGTH 25
1275 extern int checkout_entry(struct cache_entry
*ce
, const struct checkout
*state
, char *topath
);
1281 int prefix_len_stat_func
;
1283 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1284 static inline void cache_def_clear(struct cache_def
*cache
)
1286 strbuf_release(&cache
->path
);
1289 extern int has_symlink_leading_path(const char *name
, int len
);
1290 extern int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1291 extern int check_leading_path(const char *name
, int len
);
1292 extern int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1293 extern void schedule_dir_for_removal(const char *name
, int len
);
1294 extern void remove_scheduled_dirs(void);
1296 extern struct alternate_object_database
{
1297 struct alternate_object_database
*next
;
1299 char base
[FLEX_ARRAY
]; /* more */
1301 extern void prepare_alt_odb(void);
1302 extern void read_info_alternates(const char * relative_base
, int depth
);
1303 extern void add_to_alternates_file(const char *reference
);
1304 typedef int alt_odb_fn(struct alternate_object_database
*, void *);
1305 extern int foreach_alt_odb(alt_odb_fn
, void*);
1307 struct pack_window
{
1308 struct pack_window
*next
;
1309 unsigned char *base
;
1312 unsigned int last_used
;
1313 unsigned int inuse_cnt
;
1316 extern struct packed_git
{
1317 struct packed_git
*next
;
1318 struct pack_window
*windows
;
1320 const void *index_data
;
1322 uint32_t num_objects
;
1323 uint32_t num_bad_objects
;
1324 unsigned char *bad_object_sha1
;
1328 unsigned pack_local
:1,
1332 unsigned char sha1
[20];
1333 struct revindex_entry
*revindex
;
1334 /* something like ".git/objects/pack/xxxxx.pack" */
1335 char pack_name
[FLEX_ARRAY
]; /* more */
1340 unsigned char sha1
[20];
1341 struct packed_git
*p
;
1344 extern struct packed_git
*parse_pack_index(unsigned char *sha1
, const char *idx_path
);
1346 /* A hook to report invalid files in pack directory */
1347 #define PACKDIR_FILE_PACK 1
1348 #define PACKDIR_FILE_IDX 2
1349 #define PACKDIR_FILE_GARBAGE 4
1350 extern void (*report_garbage
)(unsigned seen_bits
, const char *path
);
1352 extern void prepare_packed_git(void);
1353 extern void reprepare_packed_git(void);
1354 extern void install_packed_git(struct packed_git
*pack
);
1356 extern struct packed_git
*find_sha1_pack(const unsigned char *sha1
,
1357 struct packed_git
*packs
);
1359 extern void pack_report(void);
1362 * mmap the index file for the specified packfile (if it is not
1363 * already mmapped). Return 0 on success.
1365 extern int open_pack_index(struct packed_git
*);
1368 * munmap the index file for the specified packfile (if it is
1369 * currently mmapped).
1371 extern void close_pack_index(struct packed_git
*);
1373 extern unsigned char *use_pack(struct packed_git
*, struct pack_window
**, off_t
, unsigned long *);
1374 extern void close_pack_windows(struct packed_git
*);
1375 extern void close_all_packs(void);
1376 extern void unuse_pack(struct pack_window
**);
1377 extern void free_pack_by_name(const char *);
1378 extern void clear_delta_base_cache(void);
1379 extern struct packed_git
*add_packed_git(const char *path
, size_t path_len
, int local
);
1382 * Make sure that a pointer access into an mmap'd index file is within bounds,
1383 * and can provide at least 8 bytes of data.
1385 * Note that this is only necessary for variable-length segments of the file
1386 * (like the 64-bit extended offset table), as we compare the size to the
1387 * fixed-length parts when we open the file.
1389 extern void check_pack_index_ptr(const struct packed_git
*p
, const void *ptr
);
1392 * Return the SHA-1 of the nth object within the specified packfile.
1393 * Open the index if it is not already open. The return value points
1394 * at the SHA-1 within the mmapped index. Return NULL if there is an
1397 extern const unsigned char *nth_packed_object_sha1(struct packed_git
*, uint32_t n
);
1400 * Return the offset of the nth object within the specified packfile.
1401 * The index must already be opened.
1403 extern off_t
nth_packed_object_offset(const struct packed_git
*, uint32_t n
);
1406 * If the object named sha1 is present in the specified packfile,
1407 * return its offset within the packfile; otherwise, return 0.
1409 extern off_t
find_pack_entry_one(const unsigned char *sha1
, struct packed_git
*);
1411 extern int is_pack_valid(struct packed_git
*);
1412 extern void *unpack_entry(struct packed_git
*, off_t
, enum object_type
*, unsigned long *);
1413 extern unsigned long unpack_object_header_buffer(const unsigned char *buf
, unsigned long len
, enum object_type
*type
, unsigned long *sizep
);
1414 extern unsigned long get_size_from_delta(struct packed_git
*, struct pack_window
**, off_t
);
1415 extern int unpack_object_header(struct packed_git
*, struct pack_window
**, off_t
*, unsigned long *);
1418 * Iterate over the files in the loose-object parts of the object
1419 * directory "path", triggering the following callbacks:
1421 * - loose_object is called for each loose object we find.
1423 * - loose_cruft is called for any files that do not appear to be
1424 * loose objects. Note that we only look in the loose object
1425 * directories "objects/[0-9a-f]{2}/", so we will not report
1426 * "objects/foobar" as cruft.
1428 * - loose_subdir is called for each top-level hashed subdirectory
1429 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1430 * after the objects in the directory are processed.
1432 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1433 * will end the iteration.
1435 * In the "buf" variant, "path" is a strbuf which will also be used as a
1436 * scratch buffer, but restored to its original contents before
1437 * the function returns.
1439 typedef int each_loose_object_fn(const unsigned char *sha1
,
1442 typedef int each_loose_cruft_fn(const char *basename
,
1445 typedef int each_loose_subdir_fn(int nr
,
1448 int for_each_loose_file_in_objdir(const char *path
,
1449 each_loose_object_fn obj_cb
,
1450 each_loose_cruft_fn cruft_cb
,
1451 each_loose_subdir_fn subdir_cb
,
1453 int for_each_loose_file_in_objdir_buf(struct strbuf
*path
,
1454 each_loose_object_fn obj_cb
,
1455 each_loose_cruft_fn cruft_cb
,
1456 each_loose_subdir_fn subdir_cb
,
1460 * Iterate over loose and packed objects in both the local
1461 * repository and any alternates repositories (unless the
1462 * LOCAL_ONLY flag is set).
1464 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1465 typedef int each_packed_object_fn(const unsigned char *sha1
,
1466 struct packed_git
*pack
,
1469 extern int for_each_loose_object(each_loose_object_fn
, void *, unsigned flags
);
1470 extern int for_each_packed_object(each_packed_object_fn
, void *, unsigned flags
);
1472 struct object_info
{
1474 enum object_type
*typep
;
1475 unsigned long *sizep
;
1476 unsigned long *disk_sizep
;
1477 unsigned char *delta_base_sha1
;
1478 struct strbuf
*typename
;
1490 * ... Nothing to expose in this case
1493 * ... Nothing to expose in this case
1497 struct packed_git
*pack
;
1499 unsigned int is_delta
;
1503 extern int sha1_object_info_extended(const unsigned char *, struct object_info
*, unsigned flags
);
1505 /* Dumb servers support */
1506 extern int update_server_info(int);
1508 /* git_config_parse_key() returns these negated: */
1509 #define CONFIG_INVALID_KEY 1
1510 #define CONFIG_NO_SECTION_OR_NAME 2
1511 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1512 #define CONFIG_NO_LOCK -1
1513 #define CONFIG_INVALID_FILE 3
1514 #define CONFIG_NO_WRITE 4
1515 #define CONFIG_NOTHING_SET 5
1516 #define CONFIG_INVALID_PATTERN 6
1517 #define CONFIG_GENERIC_ERROR 7
1519 #define CONFIG_REGEX_NONE ((void *)1)
1521 struct git_config_source
{
1522 unsigned int use_stdin
:1;
1527 typedef int (*config_fn_t
)(const char *, const char *, void *);
1528 extern int git_default_config(const char *, const char *, void *);
1529 extern int git_config_from_file(config_fn_t fn
, const char *, void *);
1530 extern int git_config_from_mem(config_fn_t fn
, const char *origin_type
,
1531 const char *name
, const char *buf
, size_t len
, void *data
);
1532 extern void git_config_push_parameter(const char *text
);
1533 extern int git_config_from_parameters(config_fn_t fn
, void *data
);
1534 extern void git_config(config_fn_t fn
, void *);
1535 extern int git_config_with_options(config_fn_t fn
, void *,
1536 struct git_config_source
*config_source
,
1537 int respect_includes
);
1538 extern int git_parse_ulong(const char *, unsigned long *);
1539 extern int git_parse_maybe_bool(const char *);
1540 extern int git_config_int(const char *, const char *);
1541 extern int64_t git_config_int64(const char *, const char *);
1542 extern unsigned long git_config_ulong(const char *, const char *);
1543 extern int git_config_bool_or_int(const char *, const char *, int *);
1544 extern int git_config_bool(const char *, const char *);
1545 extern int git_config_maybe_bool(const char *, const char *);
1546 extern int git_config_string(const char **, const char *, const char *);
1547 extern int git_config_pathname(const char **, const char *, const char *);
1548 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1549 extern void git_config_set_in_file(const char *, const char *, const char *);
1550 extern int git_config_set_gently(const char *, const char *);
1551 extern void git_config_set(const char *, const char *);
1552 extern int git_config_parse_key(const char *, char **, int *);
1553 extern int git_config_key_is_valid(const char *key
);
1554 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1555 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1556 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1557 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1558 extern int git_config_rename_section(const char *, const char *);
1559 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1560 extern const char *git_etc_gitconfig(void);
1561 extern int check_repository_format_version(const char *var
, const char *value
, void *cb
);
1562 extern int git_env_bool(const char *, int);
1563 extern unsigned long git_env_ulong(const char *, unsigned long);
1564 extern int git_config_system(void);
1565 extern int config_error_nonbool(const char *);
1566 #if defined(__GNUC__)
1567 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1569 extern const char *get_log_output_encoding(void);
1570 extern const char *get_commit_output_encoding(void);
1572 extern int git_config_parse_parameter(const char *, config_fn_t fn
, void *data
);
1573 extern const char *current_config_origin_type(void);
1574 extern const char *current_config_name(void);
1576 struct config_include_data
{
1581 #define CONFIG_INCLUDE_INIT { 0 }
1582 extern int git_config_include(const char *name
, const char *value
, void *data
);
1585 * Match and parse a config key of the form:
1587 * section.(subsection.)?key
1589 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1590 * we return -1 if it does not match, 0 otherwise. The subsection and key
1591 * out-parameters are filled by the function (and subsection is NULL if it is
1594 extern int parse_config_key(const char *var
,
1595 const char *section
,
1596 const char **subsection
, int *subsection_len
,
1599 struct config_set_element
{
1600 struct hashmap_entry ent
;
1602 struct string_list value_list
;
1605 struct configset_list_item
{
1606 struct config_set_element
*e
;
1611 * the contents of the list are ordered according to their
1612 * position in the config files and order of parsing the files.
1613 * (i.e. key-value pair at the last position of .git/config will
1614 * be at the last item of the list)
1616 struct configset_list
{
1617 struct configset_list_item
*items
;
1618 unsigned int nr
, alloc
;
1622 struct hashmap config_hash
;
1623 int hash_initialized
;
1624 struct configset_list list
;
1627 extern void git_configset_init(struct config_set
*cs
);
1628 extern int git_configset_add_file(struct config_set
*cs
, const char *filename
);
1629 extern int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
);
1630 extern const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
);
1631 extern void git_configset_clear(struct config_set
*cs
);
1632 extern int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
);
1633 extern int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
);
1634 extern int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
);
1635 extern int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
);
1636 extern int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
);
1637 extern int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
, int *is_bool
, int *dest
);
1638 extern int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
);
1639 extern int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
);
1641 extern int git_config_get_value(const char *key
, const char **value
);
1642 extern const struct string_list
*git_config_get_value_multi(const char *key
);
1643 extern void git_config_clear(void);
1644 extern void git_config_iter(config_fn_t fn
, void *data
);
1645 extern int git_config_get_string_const(const char *key
, const char **dest
);
1646 extern int git_config_get_string(const char *key
, char **dest
);
1647 extern int git_config_get_int(const char *key
, int *dest
);
1648 extern int git_config_get_ulong(const char *key
, unsigned long *dest
);
1649 extern int git_config_get_bool(const char *key
, int *dest
);
1650 extern int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
);
1651 extern int git_config_get_maybe_bool(const char *key
, int *dest
);
1652 extern int git_config_get_pathname(const char *key
, const char **dest
);
1653 extern int git_config_get_untracked_cache(void);
1656 * This is a hack for test programs like test-dump-untracked-cache to
1657 * ensure that they do not modify the untracked cache when reading it.
1658 * Do not use it otherwise!
1660 extern int ignore_untracked_cache_config
;
1662 struct key_value_info
{
1663 const char *filename
;
1667 extern NORETURN
void git_die_config(const char *key
, const char *err
, ...) __attribute__((format(printf
, 2, 3)));
1668 extern NORETURN
void git_die_config_linenr(const char *key
, const char *filename
, int linenr
);
1670 extern int committer_ident_sufficiently_given(void);
1671 extern int author_ident_sufficiently_given(void);
1673 extern const char *git_commit_encoding
;
1674 extern const char *git_log_output_encoding
;
1675 extern const char *git_mailmap_file
;
1676 extern const char *git_mailmap_blob
;
1678 /* IO helper functions */
1679 extern void maybe_flush_or_die(FILE *, const char *);
1680 __attribute__((format (printf
, 2, 3)))
1681 extern void fprintf_or_die(FILE *, const char *fmt
, ...);
1683 #define COPY_READ_ERROR (-2)
1684 #define COPY_WRITE_ERROR (-3)
1685 extern int copy_fd(int ifd
, int ofd
);
1686 extern int copy_file(const char *dst
, const char *src
, int mode
);
1687 extern int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1689 extern void write_or_die(int fd
, const void *buf
, size_t count
);
1690 extern int write_or_whine(int fd
, const void *buf
, size_t count
, const char *msg
);
1691 extern int write_or_whine_pipe(int fd
, const void *buf
, size_t count
, const char *msg
);
1692 extern void fsync_or_die(int fd
, const char *);
1694 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1695 extern ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1696 extern ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1698 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1700 return write_in_full(fd
, str
, strlen(str
));
1703 extern int write_file(const char *path
, const char *fmt
, ...);
1704 extern int write_file_gently(const char *path
, const char *fmt
, ...);
1707 extern void setup_pager(void);
1708 extern const char *pager_program
;
1709 extern int pager_in_use(void);
1710 extern int pager_use_color
;
1711 extern int term_columns(void);
1712 extern int decimal_width(uintmax_t);
1713 extern int check_pager_config(const char *cmd
);
1714 extern void prepare_pager_args(struct child_process
*, const char *pager
);
1716 extern const char *editor_program
;
1717 extern const char *askpass_program
;
1718 extern const char *excludes_file
;
1721 int decode_85(char *dst
, const char *line
, int linelen
);
1722 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1725 extern void *alloc_blob_node(void);
1726 extern void *alloc_tree_node(void);
1727 extern void *alloc_commit_node(void);
1728 extern void *alloc_tag_node(void);
1729 extern void *alloc_object_node(void);
1730 extern void alloc_report(void);
1731 extern unsigned int alloc_commit_index(void);
1734 void packet_trace_identity(const char *prog
);
1738 * return 0 if success, 1 - if addition of a file failed and
1739 * ADD_FILES_IGNORE_ERRORS was specified in flags
1741 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1744 extern int diff_auto_refresh_index
;
1747 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1748 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1752 * used by both diff and apply
1753 * last two digits are tab width
1755 #define WS_BLANK_AT_EOL 0100
1756 #define WS_SPACE_BEFORE_TAB 0200
1757 #define WS_INDENT_WITH_NON_TAB 0400
1758 #define WS_CR_AT_EOL 01000
1759 #define WS_BLANK_AT_EOF 02000
1760 #define WS_TAB_IN_INDENT 04000
1761 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1762 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1763 #define WS_TAB_WIDTH_MASK 077
1764 extern unsigned whitespace_rule_cfg
;
1765 extern unsigned whitespace_rule(const char *);
1766 extern unsigned parse_whitespace_rule(const char *);
1767 extern unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1768 extern void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1769 extern char *whitespace_error_string(unsigned ws
);
1770 extern void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1771 extern int ws_blank_line(const char *line
, int len
, unsigned ws_rule
);
1772 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1775 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
);
1777 char *alias_lookup(const char *alias
);
1778 int split_cmdline(char *cmdline
, const char ***argv
);
1779 /* Takes a negative value returned by split_cmdline */
1780 const char *split_cmdline_strerror(int cmdline_errno
);
1783 struct startup_info
{
1784 int have_repository
;
1787 extern struct startup_info
*startup_info
;
1791 int try_merge_command(const char *strategy
, size_t xopts_nr
,
1792 const char **xopts
, struct commit_list
*common
,
1793 const char *head_arg
, struct commit_list
*remotes
);
1794 int checkout_fast_forward(const unsigned char *from
,
1795 const unsigned char *to
,
1796 int overwrite_ignore
);
1799 int sane_execvp(const char *file
, char *const argv
[]);
1802 * A struct to encapsulate the concept of whether a file has changed
1803 * since we last checked it. This uses criteria similar to those used
1806 struct stat_validity
{
1807 struct stat_data
*sd
;
1810 void stat_validity_clear(struct stat_validity
*sv
);
1813 * Returns 1 if the path is a regular file (or a symlink to a regular
1814 * file) and matches the saved stat_validity, 0 otherwise. A missing
1815 * or inaccessible file is considered a match if the struct was just
1816 * initialized, or if the previous update found an inaccessible file.
1818 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
1821 * Update the stat_validity from a file opened at descriptor fd. If
1822 * the file is missing, inaccessible, or not a regular file, then
1823 * future calls to stat_validity_check will match iff one of those
1824 * conditions continues to be true.
1826 void stat_validity_update(struct stat_validity
*sv
, int fd
);
1828 int versioncmp(const char *s1
, const char *s2
);
1829 void sleep_millisec(int millisec
);
1832 * Create a directory and (if share is nonzero) adjust its permissions
1833 * according to the shared_repository setting. Only use this for
1834 * directories under $GIT_DIR. Don't use it for working tree
1837 void safe_create_dir(const char *dir
, int share
);
1839 #endif /* CACHE_H */