4 #include "git-compat-util.h"
13 #include "string-list.h"
14 #include "pack-revindex.h"
17 #include "sha1-array.h"
18 #include "repository.h"
22 typedef struct git_zstream
{
24 unsigned long avail_in
;
25 unsigned long avail_out
;
26 unsigned long total_in
;
27 unsigned long total_out
;
28 unsigned char *next_in
;
29 unsigned char *next_out
;
32 void git_inflate_init(git_zstream
*);
33 void git_inflate_init_gzip_only(git_zstream
*);
34 void git_inflate_end(git_zstream
*);
35 int git_inflate(git_zstream
*, int flush
);
37 void git_deflate_init(git_zstream
*, int level
);
38 void git_deflate_init_gzip(git_zstream
*, int level
);
39 void git_deflate_init_raw(git_zstream
*, int level
);
40 void git_deflate_end(git_zstream
*);
41 int git_deflate_abort(git_zstream
*);
42 int git_deflate_end_gently(git_zstream
*);
43 int git_deflate(git_zstream
*, int flush
);
44 unsigned long git_deflate_bound(git_zstream
*, unsigned long);
46 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
47 #define DTYPE(de) ((de)->d_type)
57 #define DTYPE(de) DT_UNKNOWN
60 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
61 #define S_IFINVALID 0030000
64 * A "directory link" is a link to another git directory.
66 * The value 0160000 is not normally a valid mode, and
67 * also just happens to be S_IFDIR + S_IFLNK
69 #define S_IFGITLINK 0160000
70 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
73 * Some mode bits are also used internally for computations.
75 * They *must* not overlap with any valid modes, and they *must* not be emitted
76 * to outside world - i.e. appear on disk or network. In other words, it's just
77 * temporary fields, which we internally use, but they have to stay in-house.
79 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
80 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
83 /* used internally in tree-diff */
84 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
88 * Intensive research over the course of many years has shown that
89 * port 9418 is totally unused by anything else. Or
91 * Your search - "port 9418" - did not match any documents.
93 * as www.google.com puts it.
95 * This port has been properly assigned for git use by IANA:
96 * git (Assigned-9418) [I06-050728-0001].
98 * git 9418/tcp git pack transfer service
99 * git 9418/udp git pack transfer service
101 * with Linus Torvalds <torvalds@osdl.org> as the point of
102 * contact. September 2005.
104 * See http://www.iana.org/assignments/port-numbers
106 #define DEFAULT_GIT_PORT 9418
109 * Basic data structures for the directory cache
112 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
113 struct cache_header
{
114 uint32_t hdr_signature
;
115 uint32_t hdr_version
;
116 uint32_t hdr_entries
;
119 #define INDEX_FORMAT_LB 2
120 #define INDEX_FORMAT_UB 4
123 * The "cache_time" is just the low 32 bits of the
124 * time. It doesn't matter if it overflows - we only
125 * check it for equality in the 32 bits we save.
133 struct cache_time sd_ctime
;
134 struct cache_time sd_mtime
;
139 unsigned int sd_size
;
143 struct hashmap_entry ent
;
144 struct stat_data ce_stat_data
;
145 unsigned int ce_mode
;
146 unsigned int ce_flags
;
147 unsigned int mem_pool_allocated
;
148 unsigned int ce_namelen
;
149 unsigned int index
; /* for link extension */
150 struct object_id oid
;
151 char name
[FLEX_ARRAY
]; /* more */
154 #define CE_STAGEMASK (0x3000)
155 #define CE_EXTENDED (0x4000)
156 #define CE_VALID (0x8000)
157 #define CE_STAGESHIFT 12
160 * Range 0xFFFF0FFF in ce_flags is divided into
161 * two parts: in-memory flags and on-disk ones.
162 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
163 * if you want to save a new flag, add it in
166 * In-memory only flags
168 #define CE_UPDATE (1 << 16)
169 #define CE_REMOVE (1 << 17)
170 #define CE_UPTODATE (1 << 18)
171 #define CE_ADDED (1 << 19)
173 #define CE_HASHED (1 << 20)
174 #define CE_FSMONITOR_VALID (1 << 21)
175 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
176 #define CE_CONFLICTED (1 << 23)
178 #define CE_UNPACKED (1 << 24)
179 #define CE_NEW_SKIP_WORKTREE (1 << 25)
181 /* used to temporarily mark paths matched by pathspecs */
182 #define CE_MATCHED (1 << 26)
184 #define CE_UPDATE_IN_BASE (1 << 27)
185 #define CE_STRIP_NAME (1 << 28)
188 * Extended on-disk flags
190 #define CE_INTENT_TO_ADD (1 << 29)
191 #define CE_SKIP_WORKTREE (1 << 30)
192 /* CE_EXTENDED2 is for future extension */
193 #define CE_EXTENDED2 (1U << 31)
195 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
198 * Safeguard to avoid saving wrong flags:
199 * - CE_EXTENDED2 won't get saved until its semantic is known
200 * - Bits in 0x0000FFFF have been saved in ce_flags already
201 * - Bits in 0x003F0000 are currently in-memory flags
203 #if CE_EXTENDED_FLAGS & 0x803FFFFF
204 #error "CE_EXTENDED_FLAGS out of range"
207 /* Forward structure decls */
209 struct child_process
;
213 * Copy the sha1 and stat state of a cache entry from one to
214 * another. But we never change the name, or the hash state!
216 static inline void copy_cache_entry(struct cache_entry
*dst
,
217 const struct cache_entry
*src
)
219 unsigned int state
= dst
->ce_flags
& CE_HASHED
;
220 int mem_pool_allocated
= dst
->mem_pool_allocated
;
222 /* Don't copy hash chain and name */
223 memcpy(&dst
->ce_stat_data
, &src
->ce_stat_data
,
224 offsetof(struct cache_entry
, name
) -
225 offsetof(struct cache_entry
, ce_stat_data
));
227 /* Restore the hash state */
228 dst
->ce_flags
= (dst
->ce_flags
& ~CE_HASHED
) | state
;
230 /* Restore the mem_pool_allocated flag */
231 dst
->mem_pool_allocated
= mem_pool_allocated
;
234 static inline unsigned create_ce_flags(unsigned stage
)
236 return (stage
<< CE_STAGESHIFT
);
239 #define ce_namelen(ce) ((ce)->ce_namelen)
240 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
241 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
242 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
243 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
244 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
245 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
247 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
248 static inline unsigned int create_ce_mode(unsigned int mode
)
252 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
254 return S_IFREG
| ce_permissions(mode
);
256 static inline unsigned int ce_mode_from_stat(const struct cache_entry
*ce
,
259 extern int trust_executable_bit
, has_symlinks
;
260 if (!has_symlinks
&& S_ISREG(mode
) &&
261 ce
&& S_ISLNK(ce
->ce_mode
))
263 if (!trust_executable_bit
&& S_ISREG(mode
)) {
264 if (ce
&& S_ISREG(ce
->ce_mode
))
266 return create_ce_mode(0666);
268 return create_ce_mode(mode
);
270 static inline int ce_to_dtype(const struct cache_entry
*ce
)
272 unsigned ce_mode
= ntohl(ce
->ce_mode
);
273 if (S_ISREG(ce_mode
))
275 else if (S_ISDIR(ce_mode
) || S_ISGITLINK(ce_mode
))
277 else if (S_ISLNK(ce_mode
))
282 static inline unsigned int canon_mode(unsigned int mode
)
285 return S_IFREG
| ce_permissions(mode
);
293 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
295 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
296 #define CE_ENTRY_CHANGED (1 << 1)
297 #define CE_ENTRY_REMOVED (1 << 2)
298 #define CE_ENTRY_ADDED (1 << 3)
299 #define RESOLVE_UNDO_CHANGED (1 << 4)
300 #define CACHE_TREE_CHANGED (1 << 5)
301 #define SPLIT_INDEX_ORDERED (1 << 6)
302 #define UNTRACKED_CHANGED (1 << 7)
303 #define FSMONITOR_CHANGED (1 << 8)
306 struct untracked_cache
;
309 struct cache_entry
**cache
;
310 unsigned int version
;
311 unsigned int cache_nr
, cache_alloc
, cache_changed
;
312 struct string_list
*resolve_undo
;
313 struct cache_tree
*cache_tree
;
314 struct split_index
*split_index
;
315 struct cache_time timestamp
;
316 unsigned name_hash_initialized
: 1,
320 updated_skipworktree
: 1,
321 fsmonitor_has_run_once
: 1;
322 struct hashmap name_hash
;
323 struct hashmap dir_hash
;
324 struct object_id oid
;
325 struct untracked_cache
*untracked
;
326 uint64_t fsmonitor_last_update
;
327 struct ewah_bitmap
*fsmonitor_dirty
;
328 struct mem_pool
*ce_mem_pool
;
332 int test_lazy_init_name_hash(struct index_state
*istate
, int try_threaded
);
333 void add_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
334 void remove_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
335 void free_name_hash(struct index_state
*istate
);
338 /* Cache entry creation and cleanup */
341 * Create cache_entry intended for use in the specified index. Caller
342 * is responsible for discarding the cache_entry with
343 * `discard_cache_entry`.
345 struct cache_entry
*make_cache_entry(struct index_state
*istate
,
347 const struct object_id
*oid
,
350 unsigned int refresh_options
);
352 struct cache_entry
*make_empty_cache_entry(struct index_state
*istate
,
356 * Create a cache_entry that is not intended to be added to an index.
357 * Caller is responsible for discarding the cache_entry
358 * with `discard_cache_entry`.
360 struct cache_entry
*make_transient_cache_entry(unsigned int mode
,
361 const struct object_id
*oid
,
365 struct cache_entry
*make_empty_transient_cache_entry(size_t name_len
);
368 * Discard cache entry.
370 void discard_cache_entry(struct cache_entry
*ce
);
373 * Check configuration if we should perform extra validation on cache
376 int should_validate_cache_entries(void);
379 * Duplicate a cache_entry. Allocate memory for the new entry from a
380 * memory_pool. Takes into account cache_entry fields that are meant
381 * for managing the underlying memory allocation of the cache_entry.
383 struct cache_entry
*dup_cache_entry(const struct cache_entry
*ce
, struct index_state
*istate
);
386 * Validate the cache entries in the index. This is an internal
387 * consistency check that the cache_entry structs are allocated from
388 * the expected memory pool.
390 void validate_cache_entries(const struct index_state
*istate
);
392 #ifdef USE_THE_INDEX_COMPATIBILITY_MACROS
393 extern struct index_state the_index
;
395 #define active_cache (the_index.cache)
396 #define active_nr (the_index.cache_nr)
397 #define active_alloc (the_index.cache_alloc)
398 #define active_cache_changed (the_index.cache_changed)
399 #define active_cache_tree (the_index.cache_tree)
401 #define read_cache() repo_read_index(the_repository)
402 #define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
403 #define read_cache_preload(pathspec) repo_read_index_preload(the_repository, (pathspec), 0)
404 #define is_cache_unborn() is_index_unborn(&the_index)
405 #define read_cache_unmerged() repo_read_index_unmerged(the_repository)
406 #define discard_cache() discard_index(&the_index)
407 #define unmerged_cache() unmerged_index(&the_index)
408 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
409 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
410 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
411 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
412 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
413 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
414 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
415 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
416 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
417 #define refresh_and_write_cache(refresh_flags, write_flags, gentle) repo_refresh_and_write_index(the_repository, (refresh_flags), (write_flags), (gentle), NULL, NULL, NULL)
418 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
419 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
420 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
421 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
422 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
423 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
424 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
425 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
426 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
427 #define hold_locked_index(lock_file, flags) repo_hold_locked_index(the_repository, (lock_file), (flags))
433 * Values in this enum (except those outside the 3 bit range) are part
434 * of pack file format. See Documentation/technical/pack-format.txt
435 * for more information.
444 /* 5 for future expansion */
451 static inline enum object_type
object_type(unsigned int mode
)
453 return S_ISDIR(mode
) ? OBJ_TREE
:
454 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
458 /* Double-check local_repo_env below if you add to this list. */
459 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
460 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
461 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
462 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
463 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
464 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
465 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
466 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
467 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
468 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
469 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
470 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
471 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
472 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
473 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
474 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
475 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
476 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
477 #define GITATTRIBUTES_FILE ".gitattributes"
478 #define INFOATTRIBUTES_FILE "info/attributes"
479 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
480 #define GITMODULES_FILE ".gitmodules"
481 #define GITMODULES_INDEX ":.gitmodules"
482 #define GITMODULES_HEAD "HEAD:.gitmodules"
483 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
484 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
485 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
486 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
487 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
488 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
489 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
490 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
491 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
492 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
493 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
494 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
497 * Environment variable used in handshaking the wire protocol.
498 * Contains a colon ':' separated list of keys with optional values
499 * 'key[=value]'. Presence of unknown keys and values must be
502 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
503 /* HTTP header used to handshake the wire protocol */
504 #define GIT_PROTOCOL_HEADER "Git-Protocol"
507 * This environment variable is expected to contain a boolean indicating
508 * whether we should or should not treat:
510 * GIT_DIR=foo.git git ...
512 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
513 * of this, but we use it internally to communicate to sub-processes that we
514 * are in a bare repo. If not set, defaults to true.
516 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
519 * Repository-local GIT_* environment variables; these will be cleared
520 * when git spawns a sub-process that runs inside another repository.
521 * The array is NULL-terminated, which makes it easy to pass in the "env"
522 * parameter of a run-command invocation, or to do a simple walk.
524 extern const char * const local_repo_env
[];
526 void setup_git_env(const char *git_dir
);
529 * Returns true iff we have a configured git repository (either via
530 * setup_git_directory, or in the environment via $GIT_DIR).
532 int have_git_dir(void);
534 extern int is_bare_repository_cfg
;
535 int is_bare_repository(void);
536 int is_inside_git_dir(void);
537 extern char *git_work_tree_cfg
;
538 int is_inside_work_tree(void);
539 const char *get_git_dir(void);
540 const char *get_git_common_dir(void);
541 char *get_object_directory(void);
542 char *get_index_file(void);
543 char *get_graft_file(struct repository
*r
);
544 void set_git_dir(const char *path
);
545 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
);
546 int get_common_dir(struct strbuf
*sb
, const char *gitdir
);
547 const char *get_git_namespace(void);
548 const char *strip_namespace(const char *namespaced_ref
);
549 const char *get_super_prefix(void);
550 const char *get_git_work_tree(void);
553 * Return true if the given path is a git directory; note that this _just_
554 * looks at the directory itself. If you want to know whether "foo/.git"
555 * is a repository, you must feed that path, not just "foo".
557 int is_git_directory(const char *path
);
560 * Return 1 if the given path is the root of a git repository or
561 * submodule, else 0. Will not return 1 for bare repositories with the
562 * exception of creating a bare repository in "foo/.git" and calling
563 * is_git_repository("foo").
565 * If we run into read errors, we err on the side of saying "yes, it is",
566 * as we usually consider sub-repos precious, and would prefer to err on the
567 * side of not disrupting or deleting them.
569 int is_nonbare_repository_dir(struct strbuf
*path
);
571 #define READ_GITFILE_ERR_STAT_FAILED 1
572 #define READ_GITFILE_ERR_NOT_A_FILE 2
573 #define READ_GITFILE_ERR_OPEN_FAILED 3
574 #define READ_GITFILE_ERR_READ_FAILED 4
575 #define READ_GITFILE_ERR_INVALID_FORMAT 5
576 #define READ_GITFILE_ERR_NO_PATH 6
577 #define READ_GITFILE_ERR_NOT_A_REPO 7
578 #define READ_GITFILE_ERR_TOO_LARGE 8
579 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
);
580 const char *read_gitfile_gently(const char *path
, int *return_error_code
);
581 #define read_gitfile(path) read_gitfile_gently((path), NULL)
582 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
);
583 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
585 void set_git_work_tree(const char *tree
);
587 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
589 void setup_work_tree(void);
591 * Find the commondir and gitdir of the repository that contains the current
592 * working directory, without changing the working directory or other global
593 * state. The result is appended to commondir and gitdir. If the discovered
594 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
595 * both have the same result appended to the buffer. The return value is
596 * either 0 upon success and non-zero if no repository was found.
598 int discover_git_directory(struct strbuf
*commondir
,
599 struct strbuf
*gitdir
);
600 const char *setup_git_directory_gently(int *);
601 const char *setup_git_directory(void);
602 char *prefix_path(const char *prefix
, int len
, const char *path
);
603 char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
606 * Concatenate "prefix" (if len is non-zero) and "path", with no
607 * connecting characters (so "prefix" should end with a "/").
608 * Unlike prefix_path, this should be used if the named file does
609 * not have to interact with index entry; i.e. name of a random file
612 * The return value is always a newly allocated string (even if the
615 char *prefix_filename(const char *prefix
, const char *path
);
617 int check_filename(const char *prefix
, const char *name
);
618 void verify_filename(const char *prefix
,
620 int diagnose_misspelt_rev
);
621 void verify_non_filename(const char *prefix
, const char *name
);
622 int path_inside_repo(const char *prefix
, const char *path
);
624 #define INIT_DB_QUIET 0x0001
625 #define INIT_DB_EXIST_OK 0x0002
627 int init_db(const char *git_dir
, const char *real_git_dir
,
628 const char *template_dir
, unsigned int flags
);
630 void sanitize_stdfds(void);
633 #define alloc_nr(x) (((x)+16)*3/2)
636 * Realloc the buffer pointed at by variable 'x' so that it can hold
637 * at least 'nr' entries; the number of entries currently allocated
638 * is 'alloc', using the standard growing factor alloc_nr() macro.
640 * Consider using ALLOC_GROW_BY instead of ALLOC_GROW as it has some
643 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
645 #define ALLOC_GROW(x, nr, alloc) \
647 if ((nr) > alloc) { \
648 if (alloc_nr(alloc) < (nr)) \
651 alloc = alloc_nr(alloc); \
652 REALLOC_ARRAY(x, alloc); \
657 * Similar to ALLOC_GROW but handles updating of the nr value and
658 * zeroing the bytes of the newly-grown array elements.
660 * DO NOT USE any expression with side-effect for any of the
663 #define ALLOC_GROW_BY(x, nr, increase, alloc) \
666 size_t new_nr = nr + (increase); \
668 BUG("negative growth in ALLOC_GROW_BY"); \
669 ALLOC_GROW(x, new_nr, alloc); \
670 memset((x) + nr, 0, sizeof(*(x)) * (increase)); \
675 /* Initialize and use the cache information */
677 void preload_index(struct index_state
*index
,
678 const struct pathspec
*pathspec
,
679 unsigned int refresh_flags
);
680 int do_read_index(struct index_state
*istate
, const char *path
,
681 int must_exist
); /* for testting only! */
682 int read_index_from(struct index_state
*, const char *path
,
684 int is_index_unborn(struct index_state
*);
686 /* For use with `write_locked_index()`. */
687 #define COMMIT_LOCK (1 << 0)
688 #define SKIP_IF_UNCHANGED (1 << 1)
691 * Write the index while holding an already-taken lock. Close the lock,
692 * and if `COMMIT_LOCK` is given, commit it.
694 * Unless a split index is in use, write the index into the lockfile.
696 * With a split index, write the shared index to a temporary file,
697 * adjust its permissions and rename it into place, then write the
698 * split index to the lockfile. If the temporary file for the shared
699 * index cannot be created, fall back to the behavior described in
700 * the previous paragraph.
702 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
703 * Without it, the lock is closed, but neither committed nor rolled
706 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
707 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
709 int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
711 int discard_index(struct index_state
*);
712 void move_index_extensions(struct index_state
*dst
, struct index_state
*src
);
713 int unmerged_index(const struct index_state
*);
716 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
717 * compares istate to HEAD. If tree is NULL and on an unborn branch,
718 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
719 * provided, the space-separated list of files that differ will be appended
722 int repo_index_has_changes(struct repository
*repo
,
726 int verify_path(const char *path
, unsigned mode
);
727 int strcmp_offset(const char *s1
, const char *s2
, size_t *first_change
);
728 int index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
729 void adjust_dirname_case(struct index_state
*istate
, char *name
);
730 struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
733 * Searches for an entry defined by name and namelen in the given index.
734 * If the return value is positive (including 0) it is the position of an
735 * exact match. If the return value is negative, the negated value minus 1
736 * is the position where the entry would be inserted.
737 * Example: The current index consists of these files and its stages:
741 * index_name_pos(&index, "a", 1) -> -1
742 * index_name_pos(&index, "b", 1) -> 0
743 * index_name_pos(&index, "c", 1) -> -2
744 * index_name_pos(&index, "d", 1) -> 1
745 * index_name_pos(&index, "e", 1) -> -3
746 * index_name_pos(&index, "f", 1) -> -3
747 * index_name_pos(&index, "g", 1) -> -5
749 int index_name_pos(const struct index_state
*, const char *name
, int namelen
);
751 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
752 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
753 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
754 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
755 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
756 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
757 #define ADD_CACHE_RENORMALIZE 64 /* Pass along HASH_RENORMALIZE */
758 int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
759 void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
761 /* Remove entry, return true if there are more entries to go. */
762 int remove_index_entry_at(struct index_state
*, int pos
);
764 void remove_marked_cache_entries(struct index_state
*istate
, int invalidate
);
765 int remove_file_from_index(struct index_state
*, const char *path
);
766 #define ADD_CACHE_VERBOSE 1
767 #define ADD_CACHE_PRETEND 2
768 #define ADD_CACHE_IGNORE_ERRORS 4
769 #define ADD_CACHE_IGNORE_REMOVAL 8
770 #define ADD_CACHE_INTENT 16
772 * These two are used to add the contents of the file at path
773 * to the index, marking the working tree up-to-date by storing
774 * the cached stat info in the resulting cache entry. A caller
775 * that has already run lstat(2) on the path can call
776 * add_to_index(), and all others can call add_file_to_index();
777 * the latter will do necessary lstat(2) internally before
778 * calling the former.
780 int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
781 int add_file_to_index(struct index_state
*, const char *path
, int flags
);
783 int chmod_index_entry(struct index_state
*, struct cache_entry
*ce
, char flip
);
784 int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
785 void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
786 int index_name_is_other(const struct index_state
*, const char *, int);
787 void *read_blob_data_from_index(const struct index_state
*, const char *, unsigned long *);
789 /* do stat comparison even if CE_VALID is true */
790 #define CE_MATCH_IGNORE_VALID 01
791 /* do not check the contents but report dirty on racily-clean entries */
792 #define CE_MATCH_RACY_IS_DIRTY 02
793 /* do stat comparison even if CE_SKIP_WORKTREE is true */
794 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
795 /* ignore non-existent files during stat update */
796 #define CE_MATCH_IGNORE_MISSING 0x08
797 /* enable stat refresh */
798 #define CE_MATCH_REFRESH 0x10
799 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
800 #define CE_MATCH_IGNORE_FSMONITOR 0X20
801 int is_racy_timestamp(const struct index_state
*istate
,
802 const struct cache_entry
*ce
);
803 int ie_match_stat(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
804 int ie_modified(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
806 #define HASH_WRITE_OBJECT 1
807 #define HASH_FORMAT_CHECK 2
808 #define HASH_RENORMALIZE 4
809 int index_fd(struct index_state
*istate
, struct object_id
*oid
, int fd
, struct stat
*st
, enum object_type type
, const char *path
, unsigned flags
);
810 int index_path(struct index_state
*istate
, struct object_id
*oid
, const char *path
, struct stat
*st
, unsigned flags
);
813 * Record to sd the data from st that we use to check whether a file
814 * might have changed.
816 void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
819 * Return 0 if st is consistent with a file not having been changed
820 * since sd was filled. If there are differences, return a
821 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
822 * INODE_CHANGED, and DATA_CHANGED.
824 int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
825 int match_stat_data_racy(const struct index_state
*istate
,
826 const struct stat_data
*sd
, struct stat
*st
);
828 void fill_stat_cache_info(struct index_state
*istate
, struct cache_entry
*ce
, struct stat
*st
);
830 #define REFRESH_REALLY 0x0001 /* ignore_valid */
831 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
832 #define REFRESH_QUIET 0x0004 /* be quiet about it */
833 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
834 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
835 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
836 #define REFRESH_PROGRESS 0x0040 /* show progress bar if stderr is tty */
837 int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
839 * Refresh the index and write it to disk.
841 * 'refresh_flags' is passed directly to 'refresh_index()', while
842 * 'COMMIT_LOCK | write_flags' is passed to 'write_locked_index()', so
843 * the lockfile is always either committed or rolled back.
845 * If 'gentle' is passed, errors locking the index are ignored.
847 * Return 1 if refreshing the index returns an error, -1 if writing
848 * the index to disk fails, 0 on success.
850 * Note that if refreshing the index returns an error, we still write
851 * out the index (unless locking fails).
853 int repo_refresh_and_write_index(struct repository
*, unsigned int refresh_flags
, unsigned int write_flags
, int gentle
, const struct pathspec
*, char *seen
, const char *header_msg
);
855 struct cache_entry
*refresh_cache_entry(struct index_state
*, struct cache_entry
*, unsigned int);
857 void set_alternate_index_output(const char *);
859 extern int verify_index_checksum
;
860 extern int verify_ce_order
;
862 /* Environment bits from configuration mechanism */
863 extern int trust_executable_bit
;
864 extern int trust_ctime
;
865 extern int check_stat
;
866 extern int quote_path_fully
;
867 extern int has_symlinks
;
868 extern int minimum_abbrev
, default_abbrev
;
869 extern int ignore_case
;
870 extern int assume_unchanged
;
871 extern int prefer_symlink_refs
;
872 extern int warn_ambiguous_refs
;
873 extern int warn_on_object_refname_ambiguity
;
874 extern const char *apply_default_whitespace
;
875 extern const char *apply_default_ignorewhitespace
;
876 extern const char *git_attributes_file
;
877 extern const char *git_hooks_path
;
878 extern int zlib_compression_level
;
879 extern int core_compression_level
;
880 extern int pack_compression_level
;
881 extern size_t packed_git_window_size
;
882 extern size_t packed_git_limit
;
883 extern size_t delta_base_cache_limit
;
884 extern unsigned long big_file_threshold
;
885 extern unsigned long pack_size_limit_cfg
;
888 * Accessors for the core.sharedrepository config which lazy-load the value
889 * from the config (if not already set). The "reset" function can be
890 * used to unset "set" or cached value, meaning that the value will be loaded
891 * fresh from the config file on the next call to get_shared_repository().
893 void set_shared_repository(int value
);
894 int get_shared_repository(void);
895 void reset_shared_repository(void);
898 * Do replace refs need to be checked this run? This variable is
899 * initialized to true unless --no-replace-object is used or
900 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
901 * commands that do not want replace references to be active.
903 extern int read_replace_refs
;
904 extern char *git_replace_ref_base
;
906 extern int fsync_object_files
;
907 extern int core_preload_index
;
908 extern int core_apply_sparse_checkout
;
909 extern int precomposed_unicode
;
910 extern int protect_hfs
;
911 extern int protect_ntfs
;
912 extern const char *core_fsmonitor
;
915 * Include broken refs in all ref iterations, which will
916 * generally choke dangerous operations rather than letting
917 * them silently proceed without taking the broken ref into
920 extern int ref_paranoia
;
923 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
925 int use_optional_locks(void);
928 * The character that begins a commented line in user-editable file
929 * that is subject to stripspace.
931 extern char comment_line_char
;
932 extern int auto_comment_line_char
;
934 enum log_refs_config
{
940 extern enum log_refs_config log_all_ref_updates
;
942 enum rebase_setup_type
{
943 AUTOREBASE_NEVER
= 0,
949 enum push_default_type
{
950 PUSH_DEFAULT_NOTHING
= 0,
951 PUSH_DEFAULT_MATCHING
,
953 PUSH_DEFAULT_UPSTREAM
,
954 PUSH_DEFAULT_CURRENT
,
955 PUSH_DEFAULT_UNSPECIFIED
958 extern enum rebase_setup_type autorebase
;
959 extern enum push_default_type push_default
;
961 enum object_creation_mode
{
962 OBJECT_CREATION_USES_HARDLINKS
= 0,
963 OBJECT_CREATION_USES_RENAMES
= 1
966 extern enum object_creation_mode object_creation_mode
;
968 extern char *notes_ref_name
;
970 extern int grafts_replace_parents
;
973 * GIT_REPO_VERSION is the version we write by default. The
974 * _READ variant is the highest number we know how to
977 #define GIT_REPO_VERSION 0
978 #define GIT_REPO_VERSION_READ 1
979 extern int repository_format_precious_objects
;
980 extern int repository_format_worktree_config
;
983 * You _have_ to initialize a `struct repository_format` using
984 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
986 struct repository_format
{
988 int precious_objects
;
989 char *partial_clone
; /* value of extensions.partialclone */
994 struct string_list unknown_extensions
;
998 * Always use this to initialize a `struct repository_format`
999 * to a well-defined, default state before calling
1000 * `read_repository()`.
1002 #define REPOSITORY_FORMAT_INIT \
1006 .hash_algo = GIT_HASH_SHA1, \
1007 .unknown_extensions = STRING_LIST_INIT_DUP, \
1011 * Read the repository format characteristics from the config file "path" into
1012 * "format" struct. Returns the numeric version. On error, or if no version is
1013 * found in the configuration, -1 is returned, format->version is set to -1,
1014 * and all other fields in the struct are set to the default configuration
1015 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
1016 * REPOSITORY_FORMAT_INIT before calling this function.
1018 int read_repository_format(struct repository_format
*format
, const char *path
);
1021 * Free the memory held onto by `format`, but not the struct itself.
1022 * (No need to use this after `read_repository_format()` fails.)
1024 void clear_repository_format(struct repository_format
*format
);
1027 * Verify that the repository described by repository_format is something we
1028 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
1029 * any errors encountered.
1031 int verify_repository_format(const struct repository_format
*format
,
1032 struct strbuf
*err
);
1035 * Check the repository format version in the path found in get_git_dir(),
1036 * and die if it is a version we don't understand. Generally one would
1037 * set_git_dir() before calling this, and use it only for "are we in a valid
1040 void check_repository_format(void);
1042 #define MTIME_CHANGED 0x0001
1043 #define CTIME_CHANGED 0x0002
1044 #define OWNER_CHANGED 0x0004
1045 #define MODE_CHANGED 0x0008
1046 #define INODE_CHANGED 0x0010
1047 #define DATA_CHANGED 0x0020
1048 #define TYPE_CHANGED 0x0040
1051 * Return an abbreviated sha1 unique within this repository's object database.
1052 * The result will be at least `len` characters long, and will be NUL
1055 * The non-`_r` version returns a static buffer which remains valid until 4
1056 * more calls to find_unique_abbrev are made.
1058 * The `_r` variant writes to a buffer supplied by the caller, which must be at
1059 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
1060 * written (excluding the NUL terminator).
1062 * Note that while this version avoids the static buffer, it is not fully
1063 * reentrant, as it calls into other non-reentrant git code.
1065 const char *repo_find_unique_abbrev(struct repository
*r
, const struct object_id
*oid
, int len
);
1066 #define find_unique_abbrev(oid, len) repo_find_unique_abbrev(the_repository, oid, len)
1067 int repo_find_unique_abbrev_r(struct repository
*r
, char *hex
, const struct object_id
*oid
, int len
);
1068 #define find_unique_abbrev_r(hex, oid, len) repo_find_unique_abbrev_r(the_repository, hex, oid, len)
1070 extern const unsigned char null_sha1
[GIT_MAX_RAWSZ
];
1071 extern const struct object_id null_oid
;
1073 static inline int hashcmp(const unsigned char *sha1
, const unsigned char *sha2
)
1076 * Teach the compiler that there are only two possibilities of hash size
1077 * here, so that it can optimize for this case as much as possible.
1079 if (the_hash_algo
->rawsz
== GIT_MAX_RAWSZ
)
1080 return memcmp(sha1
, sha2
, GIT_MAX_RAWSZ
);
1081 return memcmp(sha1
, sha2
, GIT_SHA1_RAWSZ
);
1084 static inline int oidcmp(const struct object_id
*oid1
, const struct object_id
*oid2
)
1086 return hashcmp(oid1
->hash
, oid2
->hash
);
1089 static inline int hasheq(const unsigned char *sha1
, const unsigned char *sha2
)
1092 * We write this here instead of deferring to hashcmp so that the
1093 * compiler can properly inline it and avoid calling memcmp.
1095 if (the_hash_algo
->rawsz
== GIT_MAX_RAWSZ
)
1096 return !memcmp(sha1
, sha2
, GIT_MAX_RAWSZ
);
1097 return !memcmp(sha1
, sha2
, GIT_SHA1_RAWSZ
);
1100 static inline int oideq(const struct object_id
*oid1
, const struct object_id
*oid2
)
1102 return hasheq(oid1
->hash
, oid2
->hash
);
1105 static inline int is_null_sha1(const unsigned char *sha1
)
1107 return hasheq(sha1
, null_sha1
);
1110 static inline int is_null_oid(const struct object_id
*oid
)
1112 return hasheq(oid
->hash
, null_sha1
);
1115 static inline void hashcpy(unsigned char *sha_dst
, const unsigned char *sha_src
)
1117 memcpy(sha_dst
, sha_src
, the_hash_algo
->rawsz
);
1120 static inline void oidcpy(struct object_id
*dst
, const struct object_id
*src
)
1122 memcpy(dst
->hash
, src
->hash
, GIT_MAX_RAWSZ
);
1125 static inline struct object_id
*oiddup(const struct object_id
*src
)
1127 struct object_id
*dst
= xmalloc(sizeof(struct object_id
));
1132 static inline void hashclr(unsigned char *hash
)
1134 memset(hash
, 0, the_hash_algo
->rawsz
);
1137 static inline void oidclr(struct object_id
*oid
)
1139 memset(oid
->hash
, 0, GIT_MAX_RAWSZ
);
1142 static inline void oidread(struct object_id
*oid
, const unsigned char *hash
)
1144 memcpy(oid
->hash
, hash
, the_hash_algo
->rawsz
);
1147 static inline int is_empty_blob_sha1(const unsigned char *sha1
)
1149 return hasheq(sha1
, the_hash_algo
->empty_blob
->hash
);
1152 static inline int is_empty_blob_oid(const struct object_id
*oid
)
1154 return oideq(oid
, the_hash_algo
->empty_blob
);
1157 static inline int is_empty_tree_sha1(const unsigned char *sha1
)
1159 return hasheq(sha1
, the_hash_algo
->empty_tree
->hash
);
1162 static inline int is_empty_tree_oid(const struct object_id
*oid
)
1164 return oideq(oid
, the_hash_algo
->empty_tree
);
1167 const char *empty_tree_oid_hex(void);
1168 const char *empty_blob_oid_hex(void);
1170 /* set default permissions by passing mode arguments to open(2) */
1171 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
1172 int git_mkstemp_mode(char *pattern
, int mode
);
1177 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1178 * not be changed. Old repositories have core.sharedrepository written in
1179 * numeric format, and therefore these values are preserved for compatibility
1185 OLD_PERM_EVERYBODY
= 2,
1187 PERM_EVERYBODY
= 0664
1189 int git_config_perm(const char *var
, const char *value
);
1190 int adjust_shared_perm(const char *path
);
1193 * Create the directory containing the named path, using care to be
1194 * somewhat safe against races. Return one of the scld_error values to
1195 * indicate success/failure. On error, set errno to describe the
1198 * SCLD_VANISHED indicates that one of the ancestor directories of the
1199 * path existed at one point during the function call and then
1200 * suddenly vanished, probably because another process pruned the
1201 * directory while we were working. To be robust against this kind of
1202 * race, callers might want to try invoking the function again when it
1203 * returns SCLD_VANISHED.
1205 * safe_create_leading_directories() temporarily changes path while it
1206 * is working but restores it before returning.
1207 * safe_create_leading_directories_const() doesn't modify path, even
1217 enum scld_error
safe_create_leading_directories(char *path
);
1218 enum scld_error
safe_create_leading_directories_const(const char *path
);
1221 * Callback function for raceproof_create_file(). This function is
1222 * expected to do something that makes dirname(path) permanent despite
1223 * the fact that other processes might be cleaning up empty
1224 * directories at the same time. Usually it will create a file named
1225 * path, but alternatively it could create another file in that
1226 * directory, or even chdir() into that directory. The function should
1227 * return 0 if the action was completed successfully. On error, it
1228 * should return a nonzero result and set errno.
1229 * raceproof_create_file() treats two errno values specially:
1231 * - ENOENT -- dirname(path) does not exist. In this case,
1232 * raceproof_create_file() tries creating dirname(path)
1233 * (and any parent directories, if necessary) and calls
1234 * the function again.
1236 * - EISDIR -- the file already exists and is a directory. In this
1237 * case, raceproof_create_file() removes the directory if
1238 * it is empty (and recursively any empty directories that
1239 * it contains) and calls the function again.
1241 * Any other errno causes raceproof_create_file() to fail with the
1242 * callback's return value and errno.
1244 * Obviously, this function should be OK with being called again if it
1245 * fails with ENOENT or EISDIR. In other scenarios it will not be
1248 typedef int create_file_fn(const char *path
, void *cb
);
1251 * Create a file in dirname(path) by calling fn, creating leading
1252 * directories if necessary. Retry a few times in case we are racing
1253 * with another process that is trying to clean up the directory that
1254 * contains path. See the documentation for create_file_fn for more
1257 * Return the value and set the errno that resulted from the most
1258 * recent call of fn. fn is always called at least once, and will be
1259 * called more than once if it returns ENOENT or EISDIR.
1261 int raceproof_create_file(const char *path
, create_file_fn fn
, void *cb
);
1263 int mkdir_in_gitdir(const char *path
);
1264 char *expand_user_path(const char *path
, int real_home
);
1265 const char *enter_repo(const char *path
, int strict
);
1266 static inline int is_absolute_path(const char *path
)
1268 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
1270 int is_directory(const char *);
1271 char *strbuf_realpath(struct strbuf
*resolved
, const char *path
,
1273 const char *real_path(const char *path
);
1274 const char *real_path_if_valid(const char *path
);
1275 char *real_pathdup(const char *path
, int die_on_error
);
1276 const char *absolute_path(const char *path
);
1277 char *absolute_pathdup(const char *path
);
1278 const char *remove_leading_path(const char *in
, const char *prefix
);
1279 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
1280 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
1281 int normalize_path_copy(char *dst
, const char *src
);
1282 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
1283 char *strip_path_suffix(const char *path
, const char *suffix
);
1284 int daemon_avoid_alias(const char *path
);
1287 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1290 int is_ntfs_dotgit(const char *name
);
1291 int is_ntfs_dotgitmodules(const char *name
);
1292 int is_ntfs_dotgitignore(const char *name
);
1293 int is_ntfs_dotgitattributes(const char *name
);
1296 * Returns true iff "str" could be confused as a command-line option when
1297 * passed to a sub-program like "ssh". Note that this has nothing to do with
1298 * shell-quoting, which should be handled separately; we're assuming here that
1299 * the string makes it verbatim to the sub-program.
1301 int looks_like_command_line_option(const char *str
);
1304 * Return a newly allocated string with the evaluation of
1305 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1306 * "$HOME/.config/git/$filename". Return NULL upon error.
1308 char *xdg_config_home(const char *filename
);
1311 * Return a newly allocated string with the evaluation of
1312 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1313 * "$HOME/.cache/git/$filename". Return NULL upon error.
1315 char *xdg_cache_home(const char *filename
);
1317 int git_open_cloexec(const char *name
, int flags
);
1318 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1319 int unpack_loose_header(git_zstream
*stream
, unsigned char *map
, unsigned long mapsize
, void *buffer
, unsigned long bufsiz
);
1320 int parse_loose_header(const char *hdr
, unsigned long *sizep
);
1322 int check_object_signature(const struct object_id
*oid
, void *buf
, unsigned long size
, const char *type
);
1324 int finalize_object_file(const char *tmpfile
, const char *filename
);
1326 /* Helper to check and "touch" a file */
1327 int check_and_freshen_file(const char *fn
, int freshen
);
1329 extern const signed char hexval_table
[256];
1330 static inline unsigned int hexval(unsigned char c
)
1332 return hexval_table
[c
];
1336 * Convert two consecutive hexadecimal digits into a char. Return a
1337 * negative value on error. Don't run over the end of short strings.
1339 static inline int hex2chr(const char *s
)
1341 unsigned int val
= hexval(s
[0]);
1342 return (val
& ~0xf) ? val
: (val
<< 4) | hexval(s
[1]);
1345 /* Convert to/from hex/sha1 representation */
1346 #define MINIMUM_ABBREV minimum_abbrev
1347 #define DEFAULT_ABBREV default_abbrev
1349 /* used when the code does not know or care what the default abbrev is */
1350 #define FALLBACK_DEFAULT_ABBREV 7
1352 struct object_context
{
1353 unsigned short mode
;
1355 * symlink_path is only used by get_tree_entry_follow_symlinks,
1356 * and only for symlinks that point outside the repository.
1358 struct strbuf symlink_path
;
1360 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1361 * found when resolving the name. The caller is responsible for
1362 * releasing the memory.
1367 #define GET_OID_QUIETLY 01
1368 #define GET_OID_COMMIT 02
1369 #define GET_OID_COMMITTISH 04
1370 #define GET_OID_TREE 010
1371 #define GET_OID_TREEISH 020
1372 #define GET_OID_BLOB 040
1373 #define GET_OID_FOLLOW_SYMLINKS 0100
1374 #define GET_OID_RECORD_PATH 0200
1375 #define GET_OID_ONLY_TO_DIE 04000
1377 #define GET_OID_DISAMBIGUATORS \
1378 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1379 GET_OID_TREE | GET_OID_TREEISH | \
1382 enum get_oid_result
{
1384 MISSING_OBJECT
= -1, /* The requested object is missing */
1385 SHORT_NAME_AMBIGUOUS
= -2,
1386 /* The following only apply when symlinks are followed */
1387 DANGLING_SYMLINK
= -4, /*
1388 * The initial symlink is there, but
1389 * (transitively) points to a missing
1394 * Somewhere along the symlink chain, a path is
1395 * requested which contains a file as a
1396 * non-final element.
1400 int repo_get_oid(struct repository
*r
, const char *str
, struct object_id
*oid
);
1401 int get_oidf(struct object_id
*oid
, const char *fmt
, ...);
1402 int repo_get_oid_commit(struct repository
*r
, const char *str
, struct object_id
*oid
);
1403 int repo_get_oid_committish(struct repository
*r
, const char *str
, struct object_id
*oid
);
1404 int repo_get_oid_tree(struct repository
*r
, const char *str
, struct object_id
*oid
);
1405 int repo_get_oid_treeish(struct repository
*r
, const char *str
, struct object_id
*oid
);
1406 int repo_get_oid_blob(struct repository
*r
, const char *str
, struct object_id
*oid
);
1407 int repo_get_oid_mb(struct repository
*r
, const char *str
, struct object_id
*oid
);
1408 void maybe_die_on_misspelt_object_name(struct repository
*repo
,
1410 const char *prefix
);
1411 enum get_oid_result
get_oid_with_context(struct repository
*repo
, const char *str
,
1412 unsigned flags
, struct object_id
*oid
,
1413 struct object_context
*oc
);
1415 #define get_oid(str, oid) repo_get_oid(the_repository, str, oid)
1416 #define get_oid_commit(str, oid) repo_get_oid_commit(the_repository, str, oid)
1417 #define get_oid_committish(str, oid) repo_get_oid_committish(the_repository, str, oid)
1418 #define get_oid_tree(str, oid) repo_get_oid_tree(the_repository, str, oid)
1419 #define get_oid_treeish(str, oid) repo_get_oid_treeish(the_repository, str, oid)
1420 #define get_oid_blob(str, oid) repo_get_oid_blob(the_repository, str, oid)
1421 #define get_oid_mb(str, oid) repo_get_oid_mb(the_repository, str, oid)
1423 typedef int each_abbrev_fn(const struct object_id
*oid
, void *);
1424 int repo_for_each_abbrev(struct repository
*r
, const char *prefix
, each_abbrev_fn
, void *);
1425 #define for_each_abbrev(prefix, fn, data) repo_for_each_abbrev(the_repository, prefix, fn, data)
1427 int set_disambiguate_hint_config(const char *var
, const char *value
);
1430 * Try to read a SHA1 in hexadecimal format from the 40 characters
1431 * starting at hex. Write the 20-byte result to sha1 in binary form.
1432 * Return 0 on success. Reading stops if a NUL is encountered in the
1433 * input, so it is safe to pass this function an arbitrary
1434 * null-terminated string.
1436 int get_sha1_hex(const char *hex
, unsigned char *sha1
);
1437 int get_oid_hex(const char *hex
, struct object_id
*sha1
);
1440 * Read `len` pairs of hexadecimal digits from `hex` and write the
1441 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1442 * the input does not consist of hex digits).
1444 int hex_to_bytes(unsigned char *binary
, const char *hex
, size_t len
);
1447 * Convert a binary hash to its hex equivalent. The `_r` variant is reentrant,
1448 * and writes the NUL-terminated output to the buffer `out`, which must be at
1449 * least `GIT_MAX_HEXSZ + 1` bytes, and returns a pointer to out for
1452 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1453 * buffers, making it safe to make multiple calls for a single statement, like:
1455 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1457 char *hash_to_hex_algop_r(char *buffer
, const unsigned char *hash
, const struct git_hash_algo
*);
1458 char *sha1_to_hex_r(char *out
, const unsigned char *sha1
);
1459 char *oid_to_hex_r(char *out
, const struct object_id
*oid
);
1460 char *hash_to_hex_algop(const unsigned char *hash
, const struct git_hash_algo
*); /* static buffer result! */
1461 char *sha1_to_hex(const unsigned char *sha1
); /* same static buffer */
1462 char *hash_to_hex(const unsigned char *hash
); /* same static buffer */
1463 char *oid_to_hex(const struct object_id
*oid
); /* same static buffer */
1466 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1467 * pointer specified by end when parsing stops. The resulting object ID is
1468 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1469 * other invalid character. end is only updated on success; otherwise, it is
1472 int parse_oid_hex(const char *hex
, struct object_id
*oid
, const char **end
);
1475 * This reads short-hand syntax that not only evaluates to a commit
1476 * object name, but also can act as if the end user spelled the name
1477 * of the branch from the command line.
1479 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1480 * places the name of the branch in the given buf and returns the
1481 * number of characters parsed if successful.
1483 * - "<branch>@{upstream}" finds the name of the other ref that
1484 * <branch> is configured to merge with (missing <branch> defaults
1485 * to the current branch), and places the name of the branch in the
1486 * given buf and returns the number of characters parsed if
1489 * If the input is not of the accepted format, it returns a negative
1490 * number to signal an error.
1492 * If the input was ok but there are not N branch switches in the
1493 * reflog, it returns 0.
1495 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1496 * expansions: local branches ("refs/heads/"), remote branches
1497 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1498 * allowed, even ones to refs outside of those namespaces.
1500 #define INTERPRET_BRANCH_LOCAL (1<<0)
1501 #define INTERPRET_BRANCH_REMOTE (1<<1)
1502 #define INTERPRET_BRANCH_HEAD (1<<2)
1503 int repo_interpret_branch_name(struct repository
*r
,
1504 const char *str
, int len
,
1507 #define interpret_branch_name(str, len, buf, allowed) \
1508 repo_interpret_branch_name(the_repository, str, len, buf, allowed)
1510 int validate_headref(const char *ref
);
1512 int base_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1513 int df_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1514 int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1515 int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1517 void *read_object_with_reference(struct repository
*r
,
1518 const struct object_id
*oid
,
1519 const char *required_type
,
1520 unsigned long *size
,
1521 struct object_id
*oid_ret
);
1523 struct object
*repo_peel_to_type(struct repository
*r
,
1524 const char *name
, int namelen
,
1525 struct object
*o
, enum object_type
);
1526 #define peel_to_type(name, namelen, obj, type) \
1527 repo_peel_to_type(the_repository, name, namelen, obj, type)
1529 enum date_mode_type
{
1535 DATE_ISO8601_STRICT
,
1543 enum date_mode_type type
;
1544 const char *strftime_fmt
;
1549 * Convenience helper for passing a constant type, like:
1551 * show_date(t, tz, DATE_MODE(NORMAL));
1553 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1554 struct date_mode
*date_mode_from_type(enum date_mode_type type
);
1556 const char *show_date(timestamp_t time
, int timezone
, const struct date_mode
*mode
);
1557 void show_date_relative(timestamp_t time
, const struct timeval
*now
,
1558 struct strbuf
*timebuf
);
1559 void show_date_human(timestamp_t time
, int tz
, const struct timeval
*now
,
1560 struct strbuf
*timebuf
);
1561 int parse_date(const char *date
, struct strbuf
*out
);
1562 int parse_date_basic(const char *date
, timestamp_t
*timestamp
, int *offset
);
1563 int parse_expiry_date(const char *date
, timestamp_t
*timestamp
);
1564 void datestamp(struct strbuf
*out
);
1565 #define approxidate(s) approxidate_careful((s), NULL)
1566 timestamp_t
approxidate_careful(const char *, int *);
1567 timestamp_t
approxidate_relative(const char *date
, const struct timeval
*now
);
1568 void parse_date_format(const char *format
, struct date_mode
*mode
);
1569 int date_overflows(timestamp_t date
);
1571 #define IDENT_STRICT 1
1572 #define IDENT_NO_DATE 2
1573 #define IDENT_NO_NAME 4
1578 WANT_COMMITTER_IDENT
1581 const char *git_author_info(int);
1582 const char *git_committer_info(int);
1583 const char *fmt_ident(const char *name
, const char *email
,
1584 enum want_ident whose_ident
,
1585 const char *date_str
, int);
1586 const char *fmt_name(enum want_ident
);
1587 const char *ident_default_name(void);
1588 const char *ident_default_email(void);
1589 const char *git_editor(void);
1590 const char *git_sequence_editor(void);
1591 const char *git_pager(int stdout_is_tty
);
1592 int is_terminal_dumb(void);
1593 int git_ident_config(const char *, const char *, void *);
1595 * Prepare an ident to fall back on if the user didn't configure it.
1597 void prepare_fallback_ident(const char *name
, const char *email
);
1598 void reset_ident_date(void);
1600 struct ident_split
{
1601 const char *name_begin
;
1602 const char *name_end
;
1603 const char *mail_begin
;
1604 const char *mail_end
;
1605 const char *date_begin
;
1606 const char *date_end
;
1607 const char *tz_begin
;
1611 * Signals an success with 0, but time part of the result may be NULL
1612 * if the input lacks timestamp and zone
1614 int split_ident_line(struct ident_split
*, const char *, int);
1617 * Like show_date, but pull the timestamp and tz parameters from
1618 * the ident_split. It will also sanity-check the values and produce
1619 * a well-known sentinel date if they appear bogus.
1621 const char *show_ident_date(const struct ident_split
*id
,
1622 const struct date_mode
*mode
);
1625 * Compare split idents for equality or strict ordering. Note that we
1626 * compare only the ident part of the line, ignoring any timestamp.
1628 * Because there are two fields, we must choose one as the primary key; we
1629 * currently arbitrarily pick the email.
1631 int ident_cmp(const struct ident_split
*, const struct ident_split
*);
1634 struct index_state
*istate
;
1635 const char *base_dir
;
1637 struct delayed_checkout
*delayed_checkout
;
1644 #define CHECKOUT_INIT { NULL, "" }
1646 #define TEMPORARY_FILENAME_LENGTH 25
1647 int checkout_entry(struct cache_entry
*ce
, const struct checkout
*state
, char *topath
, int *nr_checkouts
);
1648 void enable_delayed_checkout(struct checkout
*state
);
1649 int finish_delayed_checkout(struct checkout
*state
, int *nr_checkouts
);
1651 * Unlink the last component and schedule the leading directories for
1652 * removal, such that empty directories get removed.
1654 void unlink_entry(const struct cache_entry
*ce
);
1660 int prefix_len_stat_func
;
1662 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1663 static inline void cache_def_clear(struct cache_def
*cache
)
1665 strbuf_release(&cache
->path
);
1668 int has_symlink_leading_path(const char *name
, int len
);
1669 int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1670 int check_leading_path(const char *name
, int len
);
1671 int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1672 void schedule_dir_for_removal(const char *name
, int len
);
1673 void remove_scheduled_dirs(void);
1675 struct pack_window
{
1676 struct pack_window
*next
;
1677 unsigned char *base
;
1680 unsigned int last_used
;
1681 unsigned int inuse_cnt
;
1686 struct packed_git
*p
;
1690 * Create a temporary file rooted in the object database directory, or
1691 * die on failure. The filename is taken from "pattern", which should have the
1692 * usual "XXXXXX" trailer, and the resulting filename is written into the
1693 * "template" buffer. Returns the open descriptor.
1695 int odb_mkstemp(struct strbuf
*temp_filename
, const char *pattern
);
1698 * Create a pack .keep file named "name" (which should generally be the output
1699 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1702 int odb_pack_keep(const char *name
);
1705 * Set this to 0 to prevent oid_object_info_extended() from fetching missing
1706 * blobs. This has a difference only if extensions.partialClone is set.
1708 * Its default value is 1.
1710 extern int fetch_if_missing
;
1712 /* Dumb servers support */
1713 int update_server_info(int);
1715 const char *get_log_output_encoding(void);
1716 const char *get_commit_output_encoding(void);
1719 * This is a hack for test programs like test-dump-untracked-cache to
1720 * ensure that they do not modify the untracked cache when reading it.
1721 * Do not use it otherwise!
1723 extern int ignore_untracked_cache_config
;
1725 int committer_ident_sufficiently_given(void);
1726 int author_ident_sufficiently_given(void);
1728 extern const char *git_commit_encoding
;
1729 extern const char *git_log_output_encoding
;
1730 extern const char *git_mailmap_file
;
1731 extern const char *git_mailmap_blob
;
1733 /* IO helper functions */
1734 void maybe_flush_or_die(FILE *, const char *);
1735 __attribute__((format (printf
, 2, 3)))
1736 void fprintf_or_die(FILE *, const char *fmt
, ...);
1738 #define COPY_READ_ERROR (-2)
1739 #define COPY_WRITE_ERROR (-3)
1740 int copy_fd(int ifd
, int ofd
);
1741 int copy_file(const char *dst
, const char *src
, int mode
);
1742 int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1744 void write_or_die(int fd
, const void *buf
, size_t count
);
1745 void fsync_or_die(int fd
, const char *);
1747 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1748 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1749 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1751 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1753 return write_in_full(fd
, str
, strlen(str
));
1757 * Open (and truncate) the file at path, write the contents of buf to it,
1758 * and close it. Dies if any errors are encountered.
1760 void write_file_buf(const char *path
, const char *buf
, size_t len
);
1763 * Like write_file_buf(), but format the contents into a buffer first.
1764 * Additionally, write_file() will append a newline if one is not already
1765 * present, making it convenient to write text files:
1767 * write_file(path, "counter: %d", ctr);
1769 __attribute__((format (printf
, 2, 3)))
1770 void write_file(const char *path
, const char *fmt
, ...);
1773 void setup_pager(void);
1774 int pager_in_use(void);
1775 extern int pager_use_color
;
1776 int term_columns(void);
1777 void term_clear_line(void);
1778 int decimal_width(uintmax_t);
1779 int check_pager_config(const char *cmd
);
1780 void prepare_pager_args(struct child_process
*, const char *pager
);
1782 extern const char *editor_program
;
1783 extern const char *askpass_program
;
1784 extern const char *excludes_file
;
1787 int decode_85(char *dst
, const char *line
, int linelen
);
1788 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1791 void packet_trace_identity(const char *prog
);
1795 * return 0 if success, 1 - if addition of a file failed and
1796 * ADD_FILES_IGNORE_ERRORS was specified in flags
1798 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1801 extern int diff_auto_refresh_index
;
1804 void shift_tree(struct repository
*, const struct object_id
*, const struct object_id
*, struct object_id
*, int);
1805 void shift_tree_by(struct repository
*, const struct object_id
*, const struct object_id
*, struct object_id
*, const char *);
1809 * used by both diff and apply
1810 * last two digits are tab width
1812 #define WS_BLANK_AT_EOL 0100
1813 #define WS_SPACE_BEFORE_TAB 0200
1814 #define WS_INDENT_WITH_NON_TAB 0400
1815 #define WS_CR_AT_EOL 01000
1816 #define WS_BLANK_AT_EOF 02000
1817 #define WS_TAB_IN_INDENT 04000
1818 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1819 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1820 #define WS_TAB_WIDTH_MASK 077
1821 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1822 #define WS_RULE_MASK 07777
1823 extern unsigned whitespace_rule_cfg
;
1824 unsigned whitespace_rule(struct index_state
*, const char *);
1825 unsigned parse_whitespace_rule(const char *);
1826 unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1827 void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1828 char *whitespace_error_string(unsigned ws
);
1829 void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1830 int ws_blank_line(const char *line
, int len
, unsigned ws_rule
);
1831 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1834 void overlay_tree_on_index(struct index_state
*istate
,
1835 const char *tree_name
, const char *prefix
);
1838 struct startup_info
{
1839 int have_repository
;
1842 extern struct startup_info
*startup_info
;
1846 int try_merge_command(struct repository
*r
,
1847 const char *strategy
, size_t xopts_nr
,
1848 const char **xopts
, struct commit_list
*common
,
1849 const char *head_arg
, struct commit_list
*remotes
);
1850 int checkout_fast_forward(struct repository
*r
,
1851 const struct object_id
*from
,
1852 const struct object_id
*to
,
1853 int overwrite_ignore
);
1856 int sane_execvp(const char *file
, char *const argv
[]);
1859 * A struct to encapsulate the concept of whether a file has changed
1860 * since we last checked it. This uses criteria similar to those used
1863 struct stat_validity
{
1864 struct stat_data
*sd
;
1867 void stat_validity_clear(struct stat_validity
*sv
);
1870 * Returns 1 if the path is a regular file (or a symlink to a regular
1871 * file) and matches the saved stat_validity, 0 otherwise. A missing
1872 * or inaccessible file is considered a match if the struct was just
1873 * initialized, or if the previous update found an inaccessible file.
1875 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
1878 * Update the stat_validity from a file opened at descriptor fd. If
1879 * the file is missing, inaccessible, or not a regular file, then
1880 * future calls to stat_validity_check will match iff one of those
1881 * conditions continues to be true.
1883 void stat_validity_update(struct stat_validity
*sv
, int fd
);
1885 int versioncmp(const char *s1
, const char *s2
);
1886 void sleep_millisec(int millisec
);
1889 * Create a directory and (if share is nonzero) adjust its permissions
1890 * according to the shared_repository setting. Only use this for
1891 * directories under $GIT_DIR. Don't use it for working tree
1894 void safe_create_dir(const char *dir
, int share
);
1897 * Should we print an ellipsis after an abbreviated SHA-1 value
1898 * when doing diff-raw output or indicating a detached HEAD?
1900 int print_sha1_ellipsis(void);
1902 /* Return 1 if the file is empty or does not exists, 0 otherwise. */
1903 int is_empty_or_missing_file(const char *filename
);
1905 #endif /* CACHE_H */