4 #include "git-compat-util.h"
11 #include "string-list.h"
14 #ifndef platform_SHA_CTX
16 * platform's underlying implementation of SHA-1; could be OpenSSL,
17 * blk_SHA, Apple CommonCrypto, etc... Note that including
18 * SHA1_HEADER may have already defined platform_SHA_CTX for our
19 * own implementations like block-sha1 and ppc-sha1, so we list
20 * the default for OpenSSL compatible SHA-1 implementations here.
22 #define platform_SHA_CTX SHA_CTX
23 #define platform_SHA1_Init SHA1_Init
24 #define platform_SHA1_Update SHA1_Update
25 #define platform_SHA1_Final SHA1_Final
28 #define git_SHA_CTX platform_SHA_CTX
29 #define git_SHA1_Init platform_SHA1_Init
30 #define git_SHA1_Update platform_SHA1_Update
31 #define git_SHA1_Final platform_SHA1_Final
33 #ifdef SHA1_MAX_BLOCK_SIZE
34 #include "compat/sha1-chunked.h"
35 #undef git_SHA1_Update
36 #define git_SHA1_Update git_SHA1_Update_Chunked
40 typedef struct git_zstream
{
42 unsigned long avail_in
;
43 unsigned long avail_out
;
44 unsigned long total_in
;
45 unsigned long total_out
;
46 unsigned char *next_in
;
47 unsigned char *next_out
;
50 void git_inflate_init(git_zstream
*);
51 void git_inflate_init_gzip_only(git_zstream
*);
52 void git_inflate_end(git_zstream
*);
53 int git_inflate(git_zstream
*, int flush
);
55 void git_deflate_init(git_zstream
*, int level
);
56 void git_deflate_init_gzip(git_zstream
*, int level
);
57 void git_deflate_init_raw(git_zstream
*, int level
);
58 void git_deflate_end(git_zstream
*);
59 int git_deflate_abort(git_zstream
*);
60 int git_deflate_end_gently(git_zstream
*);
61 int git_deflate(git_zstream
*, int flush
);
62 unsigned long git_deflate_bound(git_zstream
*, unsigned long);
64 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
65 #define DTYPE(de) ((de)->d_type)
75 #define DTYPE(de) DT_UNKNOWN
78 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
79 #define S_IFINVALID 0030000
82 * A "directory link" is a link to another git directory.
84 * The value 0160000 is not normally a valid mode, and
85 * also just happens to be S_IFDIR + S_IFLNK
87 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
88 * always having the same values everywhere. We should use
89 * our internal git values for these things, and then we can
90 * translate that to the OS-specific value. It just so
91 * happens that everybody shares the same bit representation
92 * in the UNIX world (and apparently wider too..)
94 #define S_IFGITLINK 0160000
95 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
98 * Some mode bits are also used internally for computations.
100 * They *must* not overlap with any valid modes, and they *must* not be emitted
101 * to outside world - i.e. appear on disk or network. In other words, it's just
102 * temporary fields, which we internally use, but they have to stay in-house.
104 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
105 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
108 /* used internally in tree-diff */
109 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
113 * Intensive research over the course of many years has shown that
114 * port 9418 is totally unused by anything else. Or
116 * Your search - "port 9418" - did not match any documents.
118 * as www.google.com puts it.
120 * This port has been properly assigned for git use by IANA:
121 * git (Assigned-9418) [I06-050728-0001].
123 * git 9418/tcp git pack transfer service
124 * git 9418/udp git pack transfer service
126 * with Linus Torvalds <torvalds@osdl.org> as the point of
127 * contact. September 2005.
129 * See http://www.iana.org/assignments/port-numbers
131 #define DEFAULT_GIT_PORT 9418
134 * Basic data structures for the directory cache
137 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
138 struct cache_header
{
139 uint32_t hdr_signature
;
140 uint32_t hdr_version
;
141 uint32_t hdr_entries
;
144 #define INDEX_FORMAT_LB 2
145 #define INDEX_FORMAT_UB 4
148 * The "cache_time" is just the low 32 bits of the
149 * time. It doesn't matter if it overflows - we only
150 * check it for equality in the 32 bits we save.
158 struct cache_time sd_ctime
;
159 struct cache_time sd_mtime
;
164 unsigned int sd_size
;
168 struct hashmap_entry ent
;
169 struct stat_data ce_stat_data
;
170 unsigned int ce_mode
;
171 unsigned int ce_flags
;
172 unsigned int ce_namelen
;
173 unsigned int index
; /* for link extension */
174 unsigned char sha1
[20];
175 char name
[FLEX_ARRAY
]; /* more */
178 #define CE_STAGEMASK (0x3000)
179 #define CE_EXTENDED (0x4000)
180 #define CE_VALID (0x8000)
181 #define CE_STAGESHIFT 12
184 * Range 0xFFFF0FFF in ce_flags is divided into
185 * two parts: in-memory flags and on-disk ones.
186 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
187 * if you want to save a new flag, add it in
190 * In-memory only flags
192 #define CE_UPDATE (1 << 16)
193 #define CE_REMOVE (1 << 17)
194 #define CE_UPTODATE (1 << 18)
195 #define CE_ADDED (1 << 19)
197 #define CE_HASHED (1 << 20)
198 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
199 #define CE_CONFLICTED (1 << 23)
201 #define CE_UNPACKED (1 << 24)
202 #define CE_NEW_SKIP_WORKTREE (1 << 25)
204 /* used to temporarily mark paths matched by pathspecs */
205 #define CE_MATCHED (1 << 26)
207 #define CE_UPDATE_IN_BASE (1 << 27)
208 #define CE_STRIP_NAME (1 << 28)
211 * Extended on-disk flags
213 #define CE_INTENT_TO_ADD (1 << 29)
214 #define CE_SKIP_WORKTREE (1 << 30)
215 /* CE_EXTENDED2 is for future extension */
216 #define CE_EXTENDED2 (1 << 31)
218 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
221 * Safeguard to avoid saving wrong flags:
222 * - CE_EXTENDED2 won't get saved until its semantic is known
223 * - Bits in 0x0000FFFF have been saved in ce_flags already
224 * - Bits in 0x003F0000 are currently in-memory flags
226 #if CE_EXTENDED_FLAGS & 0x803FFFFF
227 #error "CE_EXTENDED_FLAGS out of range"
233 * Copy the sha1 and stat state of a cache entry from one to
234 * another. But we never change the name, or the hash state!
236 static inline void copy_cache_entry(struct cache_entry
*dst
,
237 const struct cache_entry
*src
)
239 unsigned int state
= dst
->ce_flags
& CE_HASHED
;
241 /* Don't copy hash chain and name */
242 memcpy(&dst
->ce_stat_data
, &src
->ce_stat_data
,
243 offsetof(struct cache_entry
, name
) -
244 offsetof(struct cache_entry
, ce_stat_data
));
246 /* Restore the hash state */
247 dst
->ce_flags
= (dst
->ce_flags
& ~CE_HASHED
) | state
;
250 static inline unsigned create_ce_flags(unsigned stage
)
252 return (stage
<< CE_STAGESHIFT
);
255 #define ce_namelen(ce) ((ce)->ce_namelen)
256 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
257 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
258 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
259 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
260 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
262 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
263 static inline unsigned int create_ce_mode(unsigned int mode
)
267 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
269 return S_IFREG
| ce_permissions(mode
);
271 static inline unsigned int ce_mode_from_stat(const struct cache_entry
*ce
,
274 extern int trust_executable_bit
, has_symlinks
;
275 if (!has_symlinks
&& S_ISREG(mode
) &&
276 ce
&& S_ISLNK(ce
->ce_mode
))
278 if (!trust_executable_bit
&& S_ISREG(mode
)) {
279 if (ce
&& S_ISREG(ce
->ce_mode
))
281 return create_ce_mode(0666);
283 return create_ce_mode(mode
);
285 static inline int ce_to_dtype(const struct cache_entry
*ce
)
287 unsigned ce_mode
= ntohl(ce
->ce_mode
);
288 if (S_ISREG(ce_mode
))
290 else if (S_ISDIR(ce_mode
) || S_ISGITLINK(ce_mode
))
292 else if (S_ISLNK(ce_mode
))
297 static inline unsigned int canon_mode(unsigned int mode
)
300 return S_IFREG
| ce_permissions(mode
);
308 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
310 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
311 #define CE_ENTRY_CHANGED (1 << 1)
312 #define CE_ENTRY_REMOVED (1 << 2)
313 #define CE_ENTRY_ADDED (1 << 3)
314 #define RESOLVE_UNDO_CHANGED (1 << 4)
315 #define CACHE_TREE_CHANGED (1 << 5)
316 #define SPLIT_INDEX_ORDERED (1 << 6)
320 struct cache_entry
**cache
;
321 unsigned int version
;
322 unsigned int cache_nr
, cache_alloc
, cache_changed
;
323 struct string_list
*resolve_undo
;
324 struct cache_tree
*cache_tree
;
325 struct split_index
*split_index
;
326 struct cache_time timestamp
;
327 unsigned name_hash_initialized
: 1,
329 struct hashmap name_hash
;
330 struct hashmap dir_hash
;
331 unsigned char sha1
[20];
334 extern struct index_state the_index
;
337 extern void add_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
338 extern void remove_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
339 extern void free_name_hash(struct index_state
*istate
);
342 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
343 #define active_cache (the_index.cache)
344 #define active_nr (the_index.cache_nr)
345 #define active_alloc (the_index.cache_alloc)
346 #define active_cache_changed (the_index.cache_changed)
347 #define active_cache_tree (the_index.cache_tree)
349 #define read_cache() read_index(&the_index)
350 #define read_cache_from(path) read_index_from(&the_index, (path))
351 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
352 #define is_cache_unborn() is_index_unborn(&the_index)
353 #define read_cache_unmerged() read_index_unmerged(&the_index)
354 #define discard_cache() discard_index(&the_index)
355 #define unmerged_cache() unmerged_index(&the_index)
356 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
357 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
358 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
359 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
360 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
361 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
362 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
363 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
364 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
365 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
366 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
367 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
368 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
369 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
370 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
371 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
372 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
382 /* 5 for future expansion */
389 static inline enum object_type
object_type(unsigned int mode
)
391 return S_ISDIR(mode
) ? OBJ_TREE
:
392 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
396 /* Double-check local_repo_env below if you add to this list. */
397 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
398 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
399 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
400 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
401 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
402 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
403 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
404 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
405 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
406 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
407 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
408 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
409 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
410 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
411 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
412 #define GITATTRIBUTES_FILE ".gitattributes"
413 #define INFOATTRIBUTES_FILE "info/attributes"
414 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
415 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
416 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
417 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
418 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
419 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
420 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
421 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
422 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
423 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
426 * This environment variable is expected to contain a boolean indicating
427 * whether we should or should not treat:
429 * GIT_DIR=foo.git git ...
431 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
432 * of this, but we use it internally to communicate to sub-processes that we
433 * are in a bare repo. If not set, defaults to true.
435 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
438 * Repository-local GIT_* environment variables; these will be cleared
439 * when git spawns a sub-process that runs inside another repository.
440 * The array is NULL-terminated, which makes it easy to pass in the "env"
441 * parameter of a run-command invocation, or to do a simple walk.
443 extern const char * const local_repo_env
[];
445 extern int is_bare_repository_cfg
;
446 extern int is_bare_repository(void);
447 extern int is_inside_git_dir(void);
448 extern char *git_work_tree_cfg
;
449 extern int is_inside_work_tree(void);
450 extern const char *get_git_dir(void);
451 extern int is_git_directory(const char *path
);
452 extern char *get_object_directory(void);
453 extern char *get_index_file(void);
454 extern char *get_graft_file(void);
455 extern int set_git_dir(const char *path
);
456 extern const char *get_git_namespace(void);
457 extern const char *strip_namespace(const char *namespaced_ref
);
458 extern const char *get_git_work_tree(void);
459 extern const char *read_gitfile(const char *path
);
460 extern const char *resolve_gitdir(const char *suspect
);
461 extern void set_git_work_tree(const char *tree
);
463 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
465 extern const char **get_pathspec(const char *prefix
, const char **pathspec
);
466 extern void setup_work_tree(void);
467 extern const char *setup_git_directory_gently(int *);
468 extern const char *setup_git_directory(void);
469 extern char *prefix_path(const char *prefix
, int len
, const char *path
);
470 extern char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
471 extern const char *prefix_filename(const char *prefix
, int len
, const char *path
);
472 extern int check_filename(const char *prefix
, const char *name
);
473 extern void verify_filename(const char *prefix
,
475 int diagnose_misspelt_rev
);
476 extern void verify_non_filename(const char *prefix
, const char *name
);
477 extern int path_inside_repo(const char *prefix
, const char *path
);
479 #define INIT_DB_QUIET 0x0001
481 extern int set_git_dir_init(const char *git_dir
, const char *real_git_dir
, int);
482 extern int init_db(const char *template_dir
, unsigned int flags
);
484 extern void sanitize_stdfds(void);
485 extern int daemonize(void);
487 #define alloc_nr(x) (((x)+16)*3/2)
490 * Realloc the buffer pointed at by variable 'x' so that it can hold
491 * at least 'nr' entries; the number of entries currently allocated
492 * is 'alloc', using the standard growing factor alloc_nr() macro.
494 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
496 #define ALLOC_GROW(x, nr, alloc) \
498 if ((nr) > alloc) { \
499 if (alloc_nr(alloc) < (nr)) \
502 alloc = alloc_nr(alloc); \
503 REALLOC_ARRAY(x, alloc); \
507 /* Initialize and use the cache information */
509 extern int read_index(struct index_state
*);
510 extern int read_index_preload(struct index_state
*, const struct pathspec
*pathspec
);
511 extern int do_read_index(struct index_state
*istate
, const char *path
,
512 int must_exist
); /* for testting only! */
513 extern int read_index_from(struct index_state
*, const char *path
);
514 extern int is_index_unborn(struct index_state
*);
515 extern int read_index_unmerged(struct index_state
*);
516 #define COMMIT_LOCK (1 << 0)
517 #define CLOSE_LOCK (1 << 1)
518 extern int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
519 extern int discard_index(struct index_state
*);
520 extern int unmerged_index(const struct index_state
*);
521 extern int verify_path(const char *path
);
522 extern struct cache_entry
*index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
523 extern struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
524 extern int index_name_pos(const struct index_state
*, const char *name
, int namelen
);
525 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
526 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
527 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
528 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
529 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
530 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
531 extern int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
532 extern void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
533 extern int remove_index_entry_at(struct index_state
*, int pos
);
534 extern void remove_marked_cache_entries(struct index_state
*istate
);
535 extern int remove_file_from_index(struct index_state
*, const char *path
);
536 #define ADD_CACHE_VERBOSE 1
537 #define ADD_CACHE_PRETEND 2
538 #define ADD_CACHE_IGNORE_ERRORS 4
539 #define ADD_CACHE_IGNORE_REMOVAL 8
540 #define ADD_CACHE_INTENT 16
541 extern int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
542 extern int add_file_to_index(struct index_state
*, const char *path
, int flags
);
543 extern struct cache_entry
*make_cache_entry(unsigned int mode
, const unsigned char *sha1
, const char *path
, int stage
, unsigned int refresh_options
);
544 extern int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
545 extern void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
546 extern int index_name_is_other(const struct index_state
*, const char *, int);
547 extern void *read_blob_data_from_index(struct index_state
*, const char *, unsigned long *);
549 /* do stat comparison even if CE_VALID is true */
550 #define CE_MATCH_IGNORE_VALID 01
551 /* do not check the contents but report dirty on racily-clean entries */
552 #define CE_MATCH_RACY_IS_DIRTY 02
553 /* do stat comparison even if CE_SKIP_WORKTREE is true */
554 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
555 /* ignore non-existent files during stat update */
556 #define CE_MATCH_IGNORE_MISSING 0x08
557 /* enable stat refresh */
558 #define CE_MATCH_REFRESH 0x10
559 extern int ie_match_stat(const struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
560 extern int ie_modified(const struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
562 #define HASH_WRITE_OBJECT 1
563 #define HASH_FORMAT_CHECK 2
564 extern int index_fd(unsigned char *sha1
, int fd
, struct stat
*st
, enum object_type type
, const char *path
, unsigned flags
);
565 extern int index_path(unsigned char *sha1
, const char *path
, struct stat
*st
, unsigned flags
);
568 * Record to sd the data from st that we use to check whether a file
569 * might have changed.
571 extern void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
574 * Return 0 if st is consistent with a file not having been changed
575 * since sd was filled. If there are differences, return a
576 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
577 * INODE_CHANGED, and DATA_CHANGED.
579 extern int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
581 extern void fill_stat_cache_info(struct cache_entry
*ce
, struct stat
*st
);
583 #define REFRESH_REALLY 0x0001 /* ignore_valid */
584 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
585 #define REFRESH_QUIET 0x0004 /* be quiet about it */
586 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
587 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
588 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
589 extern int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
591 extern void update_index_if_able(struct index_state
*, struct lock_file
*);
593 extern int hold_locked_index(struct lock_file
*, int);
594 extern void set_alternate_index_output(const char *);
596 extern int delete_ref(const char *, const unsigned char *sha1
, int delopt
);
598 /* Environment bits from configuration mechanism */
599 extern int trust_executable_bit
;
600 extern int trust_ctime
;
601 extern int check_stat
;
602 extern int quote_path_fully
;
603 extern int has_symlinks
;
604 extern int minimum_abbrev
, default_abbrev
;
605 extern int ignore_case
;
606 extern int assume_unchanged
;
607 extern int prefer_symlink_refs
;
608 extern int log_all_ref_updates
;
609 extern int warn_ambiguous_refs
;
610 extern int warn_on_object_refname_ambiguity
;
611 extern int shared_repository
;
612 extern const char *apply_default_whitespace
;
613 extern const char *apply_default_ignorewhitespace
;
614 extern const char *git_attributes_file
;
615 extern int zlib_compression_level
;
616 extern int core_compression_level
;
617 extern int core_compression_seen
;
618 extern size_t packed_git_window_size
;
619 extern size_t packed_git_limit
;
620 extern size_t delta_base_cache_limit
;
621 extern unsigned long big_file_threshold
;
622 extern unsigned long pack_size_limit_cfg
;
625 * Do replace refs need to be checked this run? This variable is
626 * initialized to true unless --no-replace-object is used or
627 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
628 * commands that do not want replace references to be active. As an
629 * optimization it is also set to false if replace references have
630 * been sought but there were none.
632 extern int check_replace_refs
;
634 extern int fsync_object_files
;
635 extern int core_preload_index
;
636 extern int core_apply_sparse_checkout
;
637 extern int precomposed_unicode
;
638 extern int protect_hfs
;
639 extern int protect_ntfs
;
642 * The character that begins a commented line in user-editable file
643 * that is subject to stripspace.
645 extern char comment_line_char
;
646 extern int auto_comment_line_char
;
649 BRANCH_TRACK_UNSPECIFIED
= -1,
650 BRANCH_TRACK_NEVER
= 0,
653 BRANCH_TRACK_EXPLICIT
,
654 BRANCH_TRACK_OVERRIDE
657 enum rebase_setup_type
{
658 AUTOREBASE_NEVER
= 0,
664 enum push_default_type
{
665 PUSH_DEFAULT_NOTHING
= 0,
666 PUSH_DEFAULT_MATCHING
,
668 PUSH_DEFAULT_UPSTREAM
,
669 PUSH_DEFAULT_CURRENT
,
670 PUSH_DEFAULT_UNSPECIFIED
673 extern enum branch_track git_branch_track
;
674 extern enum rebase_setup_type autorebase
;
675 extern enum push_default_type push_default
;
677 enum object_creation_mode
{
678 OBJECT_CREATION_USES_HARDLINKS
= 0,
679 OBJECT_CREATION_USES_RENAMES
= 1
682 extern enum object_creation_mode object_creation_mode
;
684 extern char *notes_ref_name
;
686 extern int grafts_replace_parents
;
688 #define GIT_REPO_VERSION 0
689 extern int repository_format_version
;
690 extern int check_repository_format(void);
692 #define MTIME_CHANGED 0x0001
693 #define CTIME_CHANGED 0x0002
694 #define OWNER_CHANGED 0x0004
695 #define MODE_CHANGED 0x0008
696 #define INODE_CHANGED 0x0010
697 #define DATA_CHANGED 0x0020
698 #define TYPE_CHANGED 0x0040
700 extern char *mksnpath(char *buf
, size_t n
, const char *fmt
, ...)
701 __attribute__((format (printf
, 3, 4)));
702 extern char *git_snpath(char *buf
, size_t n
, const char *fmt
, ...)
703 __attribute__((format (printf
, 3, 4)));
704 extern char *git_pathdup(const char *fmt
, ...)
705 __attribute__((format (printf
, 1, 2)));
706 extern char *mkpathdup(const char *fmt
, ...)
707 __attribute__((format (printf
, 1, 2)));
709 /* Return a statically allocated filename matching the sha1 signature */
710 extern char *mkpath(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
711 extern char *git_path(const char *fmt
, ...) __attribute__((format (printf
, 1, 2)));
712 extern char *git_path_submodule(const char *path
, const char *fmt
, ...)
713 __attribute__((format (printf
, 2, 3)));
716 * Return the name of the file in the local object database that would
717 * be used to store a loose object with the specified sha1. The
718 * return value is a pointer to a statically allocated buffer that is
719 * overwritten each time the function is called.
721 extern const char *sha1_file_name(const unsigned char *sha1
);
724 * Return the name of the (local) packfile with the specified sha1 in
725 * its name. The return value is a pointer to memory that is
726 * overwritten each time this function is called.
728 extern char *sha1_pack_name(const unsigned char *sha1
);
731 * Return the name of the (local) pack index file with the specified
732 * sha1 in its name. The return value is a pointer to memory that is
733 * overwritten each time this function is called.
735 extern char *sha1_pack_index_name(const unsigned char *sha1
);
737 extern const char *find_unique_abbrev(const unsigned char *sha1
, int);
738 extern const unsigned char null_sha1
[20];
740 static inline int hashcmp(const unsigned char *sha1
, const unsigned char *sha2
)
744 for (i
= 0; i
< 20; i
++, sha1
++, sha2
++) {
746 return *sha1
- *sha2
;
752 static inline int is_null_sha1(const unsigned char *sha1
)
754 return !hashcmp(sha1
, null_sha1
);
757 static inline void hashcpy(unsigned char *sha_dst
, const unsigned char *sha_src
)
759 memcpy(sha_dst
, sha_src
, 20);
761 static inline void hashclr(unsigned char *hash
)
766 #define EMPTY_TREE_SHA1_HEX \
767 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
768 #define EMPTY_TREE_SHA1_BIN_LITERAL \
769 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
770 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
771 #define EMPTY_TREE_SHA1_BIN \
772 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
774 #define EMPTY_BLOB_SHA1_HEX \
775 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
776 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
777 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
778 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
779 #define EMPTY_BLOB_SHA1_BIN \
780 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
782 static inline int is_empty_blob_sha1(const unsigned char *sha1
)
784 return !hashcmp(sha1
, EMPTY_BLOB_SHA1_BIN
);
787 int git_mkstemp(char *path
, size_t n
, const char *template);
789 int git_mkstemps(char *path
, size_t n
, const char *template, int suffix_len
);
791 /* set default permissions by passing mode arguments to open(2) */
792 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
793 int git_mkstemp_mode(char *pattern
, int mode
);
798 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
799 * not be changed. Old repositories have core.sharedrepository written in
800 * numeric format, and therefore these values are preserved for compatibility
806 OLD_PERM_EVERYBODY
= 2,
808 PERM_EVERYBODY
= 0664
810 int git_config_perm(const char *var
, const char *value
);
811 int adjust_shared_perm(const char *path
);
814 * Create the directory containing the named path, using care to be
815 * somewhat safe against races. Return one of the scld_error values
816 * to indicate success/failure.
818 * SCLD_VANISHED indicates that one of the ancestor directories of the
819 * path existed at one point during the function call and then
820 * suddenly vanished, probably because another process pruned the
821 * directory while we were working. To be robust against this kind of
822 * race, callers might want to try invoking the function again when it
823 * returns SCLD_VANISHED.
832 enum scld_error
safe_create_leading_directories(char *path
);
833 enum scld_error
safe_create_leading_directories_const(const char *path
);
835 int mkdir_in_gitdir(const char *path
);
836 extern void home_config_paths(char **global
, char **xdg
, char *file
);
837 extern char *expand_user_path(const char *path
);
838 const char *enter_repo(const char *path
, int strict
);
839 static inline int is_absolute_path(const char *path
)
841 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
843 int is_directory(const char *);
844 const char *real_path(const char *path
);
845 const char *real_path_if_valid(const char *path
);
846 const char *absolute_path(const char *path
);
847 const char *remove_leading_path(const char *in
, const char *prefix
);
848 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
849 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
850 int normalize_path_copy(char *dst
, const char *src
);
851 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
852 char *strip_path_suffix(const char *path
, const char *suffix
);
853 int daemon_avoid_alias(const char *path
);
854 extern int is_ntfs_dotgit(const char *name
);
856 /* object replacement */
857 #define LOOKUP_REPLACE_OBJECT 1
858 extern void *read_sha1_file_extended(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
, unsigned flag
);
859 static inline void *read_sha1_file(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
)
861 return read_sha1_file_extended(sha1
, type
, size
, LOOKUP_REPLACE_OBJECT
);
865 * This internal function is only declared here for the benefit of
866 * lookup_replace_object(). Please do not call it directly.
868 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1
);
871 * If object sha1 should be replaced, return the replacement object's
872 * name (replaced recursively, if necessary). The return value is
873 * either sha1 or a pointer to a permanently-allocated value. When
874 * object replacement is suppressed, always return sha1.
876 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1
)
878 if (!check_replace_refs
)
880 return do_lookup_replace_object(sha1
);
883 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1
, unsigned flag
)
885 if (!(flag
& LOOKUP_REPLACE_OBJECT
))
887 return lookup_replace_object(sha1
);
890 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
891 extern int sha1_object_info(const unsigned char *, unsigned long *);
892 extern int hash_sha1_file(const void *buf
, unsigned long len
, const char *type
, unsigned char *sha1
);
893 extern int write_sha1_file(const void *buf
, unsigned long len
, const char *type
, unsigned char *return_sha1
);
894 extern int pretend_sha1_file(void *, unsigned long, enum object_type
, unsigned char *);
895 extern int force_object_loose(const unsigned char *sha1
, time_t mtime
);
896 extern int git_open_noatime(const char *name
);
897 extern void *map_sha1_file(const unsigned char *sha1
, unsigned long *size
);
898 extern int unpack_sha1_header(git_zstream
*stream
, unsigned char *map
, unsigned long mapsize
, void *buffer
, unsigned long bufsiz
);
899 extern int parse_sha1_header(const char *hdr
, unsigned long *sizep
);
901 /* global flag to enable extra checks when accessing packed objects */
902 extern int do_check_packed_object_crc
;
904 extern int check_sha1_signature(const unsigned char *sha1
, void *buf
, unsigned long size
, const char *type
);
906 extern int move_temp_to_file(const char *tmpfile
, const char *filename
);
908 extern int has_sha1_pack(const unsigned char *sha1
);
911 * Return true iff we have an object named sha1, whether local or in
912 * an alternate object database, and whether packed or loose. This
913 * function does not respect replace references.
915 extern int has_sha1_file(const unsigned char *sha1
);
918 * Return true iff an alternate object database has a loose object
919 * with the specified name. This function does not respect replace
922 extern int has_loose_object_nonlocal(const unsigned char *sha1
);
924 extern int has_pack_index(const unsigned char *sha1
);
926 extern void assert_sha1_type(const unsigned char *sha1
, enum object_type expect
);
928 extern const signed char hexval_table
[256];
929 static inline unsigned int hexval(unsigned char c
)
931 return hexval_table
[c
];
934 /* Convert to/from hex/sha1 representation */
935 #define MINIMUM_ABBREV minimum_abbrev
936 #define DEFAULT_ABBREV default_abbrev
938 struct object_context
{
939 unsigned char tree
[20];
944 #define GET_SHA1_QUIETLY 01
945 #define GET_SHA1_COMMIT 02
946 #define GET_SHA1_COMMITTISH 04
947 #define GET_SHA1_TREE 010
948 #define GET_SHA1_TREEISH 020
949 #define GET_SHA1_BLOB 040
950 #define GET_SHA1_ONLY_TO_DIE 04000
952 extern int get_sha1(const char *str
, unsigned char *sha1
);
953 extern int get_sha1_commit(const char *str
, unsigned char *sha1
);
954 extern int get_sha1_committish(const char *str
, unsigned char *sha1
);
955 extern int get_sha1_tree(const char *str
, unsigned char *sha1
);
956 extern int get_sha1_treeish(const char *str
, unsigned char *sha1
);
957 extern int get_sha1_blob(const char *str
, unsigned char *sha1
);
958 extern void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
);
959 extern int get_sha1_with_context(const char *str
, unsigned flags
, unsigned char *sha1
, struct object_context
*orc
);
961 typedef int each_abbrev_fn(const unsigned char *sha1
, void *);
962 extern int for_each_abbrev(const char *prefix
, each_abbrev_fn
, void *);
965 * Try to read a SHA1 in hexadecimal format from the 40 characters
966 * starting at hex. Write the 20-byte result to sha1 in binary form.
967 * Return 0 on success. Reading stops if a NUL is encountered in the
968 * input, so it is safe to pass this function an arbitrary
969 * null-terminated string.
971 extern int get_sha1_hex(const char *hex
, unsigned char *sha1
);
973 extern char *sha1_to_hex(const unsigned char *sha1
); /* static buffer result! */
974 extern int read_ref_full(const char *refname
, int resolve_flags
,
975 unsigned char *sha1
, int *flags
);
976 extern int read_ref(const char *refname
, unsigned char *sha1
);
979 * Resolve a reference, recursively following symbolic refererences.
981 * Store the referred-to object's name in sha1 and return the name of
982 * the non-symbolic reference that ultimately pointed at it. The
983 * return value, if not NULL, is a pointer into either a static buffer
986 * If the reference cannot be resolved to an object, the behavior
987 * depends on the RESOLVE_REF_READING flag:
989 * - If RESOLVE_REF_READING is set, return NULL.
991 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
992 * the last reference name in the chain, which will either be a non-symbolic
993 * reference or an undefined reference. If this is a prelude to
994 * "writing" to the ref, the return value is the name of the ref
995 * that will actually be created or changed.
997 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
998 * level of symbolic reference. The value stored in sha1 for a symbolic
999 * reference will always be null_sha1 in this case, and the return
1000 * value is the reference that the symref refers to directly.
1002 * If flags is non-NULL, set the value that it points to the
1003 * combination of REF_ISPACKED (if the reference was found among the
1004 * packed references), REF_ISSYMREF (if the initial reference was a
1005 * symbolic reference), REF_BAD_NAME (if the reference name is ill
1006 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
1007 * (if the ref is malformed or has a bad name). See refs.h for more detail
1010 * If ref is not a properly-formatted, normalized reference, return
1011 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
1012 * give up and return NULL.
1014 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
1015 * name is invalid according to git-check-ref-format(1). If the name
1016 * is bad then the value stored in sha1 will be null_sha1 and the two
1017 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
1019 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
1020 * directory and do not consist of all caps and underscores cannot be
1021 * resolved. The function returns NULL for such ref names.
1022 * Caps and underscores refers to the special refs, such as HEAD,
1023 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
1025 #define RESOLVE_REF_READING 0x01
1026 #define RESOLVE_REF_NO_RECURSE 0x02
1027 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
1028 extern const char *resolve_ref_unsafe(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
);
1029 extern char *resolve_refdup(const char *ref
, int resolve_flags
, unsigned char *sha1
, int *flags
);
1031 extern int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
);
1032 extern int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **ref
);
1033 extern int interpret_branch_name(const char *str
, int len
, struct strbuf
*);
1034 extern int get_sha1_mb(const char *str
, unsigned char *sha1
);
1037 * Return true iff abbrev_name is a possible abbreviation for
1038 * full_name according to the rules defined by ref_rev_parse_rules in
1041 extern int refname_match(const char *abbrev_name
, const char *full_name
);
1043 extern int create_symref(const char *ref
, const char *refs_heads_master
, const char *logmsg
);
1044 extern int validate_headref(const char *ref
);
1046 extern int base_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1047 extern int df_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1048 extern int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1049 extern int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1051 extern void *read_object_with_reference(const unsigned char *sha1
,
1052 const char *required_type
,
1053 unsigned long *size
,
1054 unsigned char *sha1_ret
);
1056 extern struct object
*peel_to_type(const char *name
, int namelen
,
1057 struct object
*o
, enum object_type
);
1065 DATE_ISO8601_STRICT
,
1070 const char *show_date(unsigned long time
, int timezone
, enum date_mode mode
);
1071 void show_date_relative(unsigned long time
, int tz
, const struct timeval
*now
,
1072 struct strbuf
*timebuf
);
1073 int parse_date(const char *date
, struct strbuf
*out
);
1074 int parse_date_basic(const char *date
, unsigned long *timestamp
, int *offset
);
1075 int parse_expiry_date(const char *date
, unsigned long *timestamp
);
1076 void datestamp(struct strbuf
*out
);
1077 #define approxidate(s) approxidate_careful((s), NULL)
1078 unsigned long approxidate_careful(const char *, int *);
1079 unsigned long approxidate_relative(const char *date
, const struct timeval
*now
);
1080 enum date_mode
parse_date_format(const char *format
);
1081 int date_overflows(unsigned long date
);
1083 #define IDENT_STRICT 1
1084 #define IDENT_NO_DATE 2
1085 #define IDENT_NO_NAME 4
1086 extern const char *git_author_info(int);
1087 extern const char *git_committer_info(int);
1088 extern const char *fmt_ident(const char *name
, const char *email
, const char *date_str
, int);
1089 extern const char *fmt_name(const char *name
, const char *email
);
1090 extern const char *ident_default_name(void);
1091 extern const char *ident_default_email(void);
1092 extern const char *git_editor(void);
1093 extern const char *git_pager(int stdout_is_tty
);
1094 extern int git_ident_config(const char *, const char *, void *);
1096 struct ident_split
{
1097 const char *name_begin
;
1098 const char *name_end
;
1099 const char *mail_begin
;
1100 const char *mail_end
;
1101 const char *date_begin
;
1102 const char *date_end
;
1103 const char *tz_begin
;
1107 * Signals an success with 0, but time part of the result may be NULL
1108 * if the input lacks timestamp and zone
1110 extern int split_ident_line(struct ident_split
*, const char *, int);
1113 * Like show_date, but pull the timestamp and tz parameters from
1114 * the ident_split. It will also sanity-check the values and produce
1115 * a well-known sentinel date if they appear bogus.
1117 const char *show_ident_date(const struct ident_split
*id
, enum date_mode mode
);
1120 * Compare split idents for equality or strict ordering. Note that we
1121 * compare only the ident part of the line, ignoring any timestamp.
1123 * Because there are two fields, we must choose one as the primary key; we
1124 * currently arbitrarily pick the email.
1126 extern int ident_cmp(const struct ident_split
*, const struct ident_split
*);
1129 struct index_state
*istate
;
1130 const char *base_dir
;
1138 #define TEMPORARY_FILENAME_LENGTH 25
1139 extern int checkout_entry(struct cache_entry
*ce
, const struct checkout
*state
, char *topath
);
1145 int prefix_len_stat_func
;
1147 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1148 static inline void cache_def_clear(struct cache_def
*cache
)
1150 strbuf_release(&cache
->path
);
1153 extern int has_symlink_leading_path(const char *name
, int len
);
1154 extern int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1155 extern int check_leading_path(const char *name
, int len
);
1156 extern int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1157 extern void schedule_dir_for_removal(const char *name
, int len
);
1158 extern void remove_scheduled_dirs(void);
1160 extern struct alternate_object_database
{
1161 struct alternate_object_database
*next
;
1163 char base
[FLEX_ARRAY
]; /* more */
1165 extern void prepare_alt_odb(void);
1166 extern void read_info_alternates(const char * relative_base
, int depth
);
1167 extern void add_to_alternates_file(const char *reference
);
1168 typedef int alt_odb_fn(struct alternate_object_database
*, void *);
1169 extern int foreach_alt_odb(alt_odb_fn
, void*);
1171 struct pack_window
{
1172 struct pack_window
*next
;
1173 unsigned char *base
;
1176 unsigned int last_used
;
1177 unsigned int inuse_cnt
;
1180 extern struct packed_git
{
1181 struct packed_git
*next
;
1182 struct pack_window
*windows
;
1184 const void *index_data
;
1186 uint32_t num_objects
;
1187 uint32_t num_bad_objects
;
1188 unsigned char *bad_object_sha1
;
1192 unsigned pack_local
:1,
1195 unsigned char sha1
[20];
1196 /* something like ".git/objects/pack/xxxxx.pack" */
1197 char pack_name
[FLEX_ARRAY
]; /* more */
1202 unsigned char sha1
[20];
1203 struct packed_git
*p
;
1206 extern struct packed_git
*parse_pack_index(unsigned char *sha1
, const char *idx_path
);
1208 /* A hook for count-objects to report invalid files in pack directory */
1209 extern void (*report_garbage
)(const char *desc
, const char *path
);
1211 extern void prepare_packed_git(void);
1212 extern void reprepare_packed_git(void);
1213 extern void install_packed_git(struct packed_git
*pack
);
1215 extern struct packed_git
*find_sha1_pack(const unsigned char *sha1
,
1216 struct packed_git
*packs
);
1218 extern void pack_report(void);
1221 * mmap the index file for the specified packfile (if it is not
1222 * already mmapped). Return 0 on success.
1224 extern int open_pack_index(struct packed_git
*);
1227 * munmap the index file for the specified packfile (if it is
1228 * currently mmapped).
1230 extern void close_pack_index(struct packed_git
*);
1232 extern unsigned char *use_pack(struct packed_git
*, struct pack_window
**, off_t
, unsigned long *);
1233 extern void close_pack_windows(struct packed_git
*);
1234 extern void unuse_pack(struct pack_window
**);
1235 extern void free_pack_by_name(const char *);
1236 extern void clear_delta_base_cache(void);
1237 extern struct packed_git
*add_packed_git(const char *, int, int);
1240 * Return the SHA-1 of the nth object within the specified packfile.
1241 * Open the index if it is not already open. The return value points
1242 * at the SHA-1 within the mmapped index. Return NULL if there is an
1245 extern const unsigned char *nth_packed_object_sha1(struct packed_git
*, uint32_t n
);
1248 * Return the offset of the nth object within the specified packfile.
1249 * The index must already be opened.
1251 extern off_t
nth_packed_object_offset(const struct packed_git
*, uint32_t n
);
1254 * If the object named sha1 is present in the specified packfile,
1255 * return its offset within the packfile; otherwise, return 0.
1257 extern off_t
find_pack_entry_one(const unsigned char *sha1
, struct packed_git
*);
1259 extern int is_pack_valid(struct packed_git
*);
1260 extern void *unpack_entry(struct packed_git
*, off_t
, enum object_type
*, unsigned long *);
1261 extern unsigned long unpack_object_header_buffer(const unsigned char *buf
, unsigned long len
, enum object_type
*type
, unsigned long *sizep
);
1262 extern unsigned long get_size_from_delta(struct packed_git
*, struct pack_window
**, off_t
);
1263 extern int unpack_object_header(struct packed_git
*, struct pack_window
**, off_t
*, unsigned long *);
1266 * Iterate over the files in the loose-object parts of the object
1267 * directory "path", triggering the following callbacks:
1269 * - loose_object is called for each loose object we find.
1271 * - loose_cruft is called for any files that do not appear to be
1272 * loose objects. Note that we only look in the loose object
1273 * directories "objects/[0-9a-f]{2}/", so we will not report
1274 * "objects/foobar" as cruft.
1276 * - loose_subdir is called for each top-level hashed subdirectory
1277 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1278 * after the objects in the directory are processed.
1280 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1281 * will end the iteration.
1283 typedef int each_loose_object_fn(const unsigned char *sha1
,
1286 typedef int each_loose_cruft_fn(const char *basename
,
1289 typedef int each_loose_subdir_fn(int nr
,
1292 int for_each_loose_file_in_objdir(const char *path
,
1293 each_loose_object_fn obj_cb
,
1294 each_loose_cruft_fn cruft_cb
,
1295 each_loose_subdir_fn subdir_cb
,
1299 * Iterate over loose and packed objects in both the local
1300 * repository and any alternates repositories.
1302 typedef int each_packed_object_fn(const unsigned char *sha1
,
1303 struct packed_git
*pack
,
1306 extern int for_each_loose_object(each_loose_object_fn
, void *);
1307 extern int for_each_packed_object(each_packed_object_fn
, void *);
1309 struct object_info
{
1311 enum object_type
*typep
;
1312 unsigned long *sizep
;
1313 unsigned long *disk_sizep
;
1314 unsigned char *delta_base_sha1
;
1326 * ... Nothing to expose in this case
1329 * ... Nothing to expose in this case
1333 struct packed_git
*pack
;
1335 unsigned int is_delta
;
1339 extern int sha1_object_info_extended(const unsigned char *, struct object_info
*, unsigned flags
);
1341 /* Dumb servers support */
1342 extern int update_server_info(int);
1344 /* git_config_parse_key() returns these negated: */
1345 #define CONFIG_INVALID_KEY 1
1346 #define CONFIG_NO_SECTION_OR_NAME 2
1347 /* git_config_set(), git_config_set_multivar() return the above or these: */
1348 #define CONFIG_NO_LOCK -1
1349 #define CONFIG_INVALID_FILE 3
1350 #define CONFIG_NO_WRITE 4
1351 #define CONFIG_NOTHING_SET 5
1352 #define CONFIG_INVALID_PATTERN 6
1353 #define CONFIG_GENERIC_ERROR 7
1355 #define CONFIG_REGEX_NONE ((void *)1)
1357 struct git_config_source
{
1358 unsigned int use_stdin
:1;
1363 typedef int (*config_fn_t
)(const char *, const char *, void *);
1364 extern int git_default_config(const char *, const char *, void *);
1365 extern int git_config_from_file(config_fn_t fn
, const char *, void *);
1366 extern int git_config_from_buf(config_fn_t fn
, const char *name
,
1367 const char *buf
, size_t len
, void *data
);
1368 extern void git_config_push_parameter(const char *text
);
1369 extern int git_config_from_parameters(config_fn_t fn
, void *data
);
1370 extern void git_config(config_fn_t fn
, void *);
1371 extern int git_config_with_options(config_fn_t fn
, void *,
1372 struct git_config_source
*config_source
,
1373 int respect_includes
);
1374 extern int git_config_early(config_fn_t fn
, void *, const char *repo_config
);
1375 extern int git_parse_ulong(const char *, unsigned long *);
1376 extern int git_config_int(const char *, const char *);
1377 extern int64_t git_config_int64(const char *, const char *);
1378 extern unsigned long git_config_ulong(const char *, const char *);
1379 extern int git_config_bool_or_int(const char *, const char *, int *);
1380 extern int git_config_bool(const char *, const char *);
1381 extern int git_config_maybe_bool(const char *, const char *);
1382 extern int git_config_string(const char **, const char *, const char *);
1383 extern int git_config_pathname(const char **, const char *, const char *);
1384 extern int git_config_set_in_file(const char *, const char *, const char *);
1385 extern int git_config_set(const char *, const char *);
1386 extern int git_config_parse_key(const char *, char **, int *);
1387 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1388 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1389 extern int git_config_rename_section(const char *, const char *);
1390 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1391 extern const char *git_etc_gitconfig(void);
1392 extern int check_repository_format_version(const char *var
, const char *value
, void *cb
);
1393 extern int git_env_bool(const char *, int);
1394 extern unsigned long git_env_ulong(const char *, unsigned long);
1395 extern int git_config_system(void);
1396 extern int config_error_nonbool(const char *);
1397 #if defined(__GNUC__)
1398 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1400 extern const char *get_log_output_encoding(void);
1401 extern const char *get_commit_output_encoding(void);
1403 extern int git_config_parse_parameter(const char *, config_fn_t fn
, void *data
);
1405 struct config_include_data
{
1410 #define CONFIG_INCLUDE_INIT { 0 }
1411 extern int git_config_include(const char *name
, const char *value
, void *data
);
1414 * Match and parse a config key of the form:
1416 * section.(subsection.)?key
1418 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1419 * we return -1 if it does not match, 0 otherwise. The subsection and key
1420 * out-parameters are filled by the function (and subsection is NULL if it is
1423 extern int parse_config_key(const char *var
,
1424 const char *section
,
1425 const char **subsection
, int *subsection_len
,
1428 struct config_set_element
{
1429 struct hashmap_entry ent
;
1431 struct string_list value_list
;
1434 struct configset_list_item
{
1435 struct config_set_element
*e
;
1440 * the contents of the list are ordered according to their
1441 * position in the config files and order of parsing the files.
1442 * (i.e. key-value pair at the last position of .git/config will
1443 * be at the last item of the list)
1445 struct configset_list
{
1446 struct configset_list_item
*items
;
1447 unsigned int nr
, alloc
;
1451 struct hashmap config_hash
;
1452 int hash_initialized
;
1453 struct configset_list list
;
1456 extern void git_configset_init(struct config_set
*cs
);
1457 extern int git_configset_add_file(struct config_set
*cs
, const char *filename
);
1458 extern int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
);
1459 extern const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
);
1460 extern void git_configset_clear(struct config_set
*cs
);
1461 extern int git_configset_get_string_const(struct config_set
*cs
, const char *key
, const char **dest
);
1462 extern int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
);
1463 extern int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
);
1464 extern int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
);
1465 extern int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
);
1466 extern int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
, int *is_bool
, int *dest
);
1467 extern int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
);
1468 extern int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
);
1470 extern int git_config_get_value(const char *key
, const char **value
);
1471 extern const struct string_list
*git_config_get_value_multi(const char *key
);
1472 extern void git_config_clear(void);
1473 extern void git_config_iter(config_fn_t fn
, void *data
);
1474 extern int git_config_get_string_const(const char *key
, const char **dest
);
1475 extern int git_config_get_string(const char *key
, char **dest
);
1476 extern int git_config_get_int(const char *key
, int *dest
);
1477 extern int git_config_get_ulong(const char *key
, unsigned long *dest
);
1478 extern int git_config_get_bool(const char *key
, int *dest
);
1479 extern int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
);
1480 extern int git_config_get_maybe_bool(const char *key
, int *dest
);
1481 extern int git_config_get_pathname(const char *key
, const char **dest
);
1483 struct key_value_info
{
1484 const char *filename
;
1488 extern NORETURN
void git_die_config(const char *key
, const char *err
, ...) __attribute__((format(printf
, 2, 3)));
1489 extern NORETURN
void git_die_config_linenr(const char *key
, const char *filename
, int linenr
);
1491 extern int committer_ident_sufficiently_given(void);
1492 extern int author_ident_sufficiently_given(void);
1494 extern const char *git_commit_encoding
;
1495 extern const char *git_log_output_encoding
;
1496 extern const char *git_mailmap_file
;
1497 extern const char *git_mailmap_blob
;
1499 /* IO helper functions */
1500 extern void maybe_flush_or_die(FILE *, const char *);
1501 __attribute__((format (printf
, 2, 3)))
1502 extern void fprintf_or_die(FILE *, const char *fmt
, ...);
1503 extern int copy_fd(int ifd
, int ofd
);
1504 extern int copy_file(const char *dst
, const char *src
, int mode
);
1505 extern int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1506 extern void write_or_die(int fd
, const void *buf
, size_t count
);
1507 extern int write_or_whine(int fd
, const void *buf
, size_t count
, const char *msg
);
1508 extern int write_or_whine_pipe(int fd
, const void *buf
, size_t count
, const char *msg
);
1509 extern void fsync_or_die(int fd
, const char *);
1511 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1512 extern ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1513 extern ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1515 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1517 return write_in_full(fd
, str
, strlen(str
));
1521 extern void setup_pager(void);
1522 extern const char *pager_program
;
1523 extern int pager_in_use(void);
1524 extern int pager_use_color
;
1525 extern int term_columns(void);
1526 extern int decimal_width(int);
1527 extern int check_pager_config(const char *cmd
);
1529 extern const char *editor_program
;
1530 extern const char *askpass_program
;
1531 extern const char *excludes_file
;
1534 int decode_85(char *dst
, const char *line
, int linelen
);
1535 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1538 extern void *alloc_blob_node(void);
1539 extern void *alloc_tree_node(void);
1540 extern void *alloc_commit_node(void);
1541 extern void *alloc_tag_node(void);
1542 extern void *alloc_object_node(void);
1543 extern void alloc_report(void);
1544 extern unsigned int alloc_commit_index(void);
1547 void packet_trace_identity(const char *prog
);
1551 * return 0 if success, 1 - if addition of a file failed and
1552 * ADD_FILES_IGNORE_ERRORS was specified in flags
1554 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1557 extern int diff_auto_refresh_index
;
1560 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1561 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1565 * used by both diff and apply
1566 * last two digits are tab width
1568 #define WS_BLANK_AT_EOL 0100
1569 #define WS_SPACE_BEFORE_TAB 0200
1570 #define WS_INDENT_WITH_NON_TAB 0400
1571 #define WS_CR_AT_EOL 01000
1572 #define WS_BLANK_AT_EOF 02000
1573 #define WS_TAB_IN_INDENT 04000
1574 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1575 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1576 #define WS_TAB_WIDTH_MASK 077
1577 extern unsigned whitespace_rule_cfg
;
1578 extern unsigned whitespace_rule(const char *);
1579 extern unsigned parse_whitespace_rule(const char *);
1580 extern unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1581 extern void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1582 extern char *whitespace_error_string(unsigned ws
);
1583 extern void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1584 extern int ws_blank_line(const char *line
, int len
, unsigned ws_rule
);
1585 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1588 int report_path_error(const char *ps_matched
, const struct pathspec
*pathspec
, const char *prefix
);
1589 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
);
1591 char *alias_lookup(const char *alias
);
1592 int split_cmdline(char *cmdline
, const char ***argv
);
1593 /* Takes a negative value returned by split_cmdline */
1594 const char *split_cmdline_strerror(int cmdline_errno
);
1597 struct startup_info
{
1598 int have_repository
;
1601 extern struct startup_info
*startup_info
;
1605 int try_merge_command(const char *strategy
, size_t xopts_nr
,
1606 const char **xopts
, struct commit_list
*common
,
1607 const char *head_arg
, struct commit_list
*remotes
);
1608 int checkout_fast_forward(const unsigned char *from
,
1609 const unsigned char *to
,
1610 int overwrite_ignore
);
1613 int sane_execvp(const char *file
, char *const argv
[]);
1616 * A struct to encapsulate the concept of whether a file has changed
1617 * since we last checked it. This uses criteria similar to those used
1620 struct stat_validity
{
1621 struct stat_data
*sd
;
1624 void stat_validity_clear(struct stat_validity
*sv
);
1627 * Returns 1 if the path is a regular file (or a symlink to a regular
1628 * file) and matches the saved stat_validity, 0 otherwise. A missing
1629 * or inaccessible file is considered a match if the struct was just
1630 * initialized, or if the previous update found an inaccessible file.
1632 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
1635 * Update the stat_validity from a file opened at descriptor fd. If
1636 * the file is missing, inaccessible, or not a regular file, then
1637 * future calls to stat_validity_check will match iff one of those
1638 * conditions continues to be true.
1640 void stat_validity_update(struct stat_validity
*sv
, int fd
);
1642 int versioncmp(const char *s1
, const char *s2
);
1644 #endif /* CACHE_H */