Merge branch 'nd/branch-show-rebase-bisect-state'
[git/jnareb-git.git] / cache.h
blobec2fd7a30431acb23f00f05e930ab441a244e18b
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hash.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
11 #include SHA1_HEADER
12 #ifndef git_SHA_CTX
13 #define git_SHA_CTX SHA_CTX
14 #define git_SHA1_Init SHA1_Init
15 #define git_SHA1_Update SHA1_Update
16 #define git_SHA1_Final SHA1_Final
17 #endif
19 #include <zlib.h>
20 typedef struct git_zstream {
21 z_stream z;
22 unsigned long avail_in;
23 unsigned long avail_out;
24 unsigned long total_in;
25 unsigned long total_out;
26 unsigned char *next_in;
27 unsigned char *next_out;
28 } git_zstream;
30 void git_inflate_init(git_zstream *);
31 void git_inflate_init_gzip_only(git_zstream *);
32 void git_inflate_end(git_zstream *);
33 int git_inflate(git_zstream *, int flush);
35 void git_deflate_init(git_zstream *, int level);
36 void git_deflate_init_gzip(git_zstream *, int level);
37 void git_deflate_init_raw(git_zstream *, int level);
38 void git_deflate_end(git_zstream *);
39 int git_deflate_abort(git_zstream *);
40 int git_deflate_end_gently(git_zstream *);
41 int git_deflate(git_zstream *, int flush);
42 unsigned long git_deflate_bound(git_zstream *, unsigned long);
44 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
45 #define DTYPE(de) ((de)->d_type)
46 #else
47 #undef DT_UNKNOWN
48 #undef DT_DIR
49 #undef DT_REG
50 #undef DT_LNK
51 #define DT_UNKNOWN 0
52 #define DT_DIR 1
53 #define DT_REG 2
54 #define DT_LNK 3
55 #define DTYPE(de) DT_UNKNOWN
56 #endif
58 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
59 #define S_IFINVALID 0030000
62 * A "directory link" is a link to another git directory.
64 * The value 0160000 is not normally a valid mode, and
65 * also just happens to be S_IFDIR + S_IFLNK
67 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
68 * always having the same values everywhere. We should use
69 * our internal git values for these things, and then we can
70 * translate that to the OS-specific value. It just so
71 * happens that everybody shares the same bit representation
72 * in the UNIX world (and apparently wider too..)
74 #define S_IFGITLINK 0160000
75 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
78 * Intensive research over the course of many years has shown that
79 * port 9418 is totally unused by anything else. Or
81 * Your search - "port 9418" - did not match any documents.
83 * as www.google.com puts it.
85 * This port has been properly assigned for git use by IANA:
86 * git (Assigned-9418) [I06-050728-0001].
88 * git 9418/tcp git pack transfer service
89 * git 9418/udp git pack transfer service
91 * with Linus Torvalds <torvalds@osdl.org> as the point of
92 * contact. September 2005.
94 * See http://www.iana.org/assignments/port-numbers
96 #define DEFAULT_GIT_PORT 9418
99 * Basic data structures for the directory cache
102 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
103 struct cache_header {
104 unsigned int hdr_signature;
105 unsigned int hdr_version;
106 unsigned int hdr_entries;
109 #define INDEX_FORMAT_LB 2
110 #define INDEX_FORMAT_UB 4
113 * The "cache_time" is just the low 32 bits of the
114 * time. It doesn't matter if it overflows - we only
115 * check it for equality in the 32 bits we save.
117 struct cache_time {
118 unsigned int sec;
119 unsigned int nsec;
122 struct cache_entry {
123 struct cache_time ce_ctime;
124 struct cache_time ce_mtime;
125 unsigned int ce_dev;
126 unsigned int ce_ino;
127 unsigned int ce_mode;
128 unsigned int ce_uid;
129 unsigned int ce_gid;
130 unsigned int ce_size;
131 unsigned int ce_flags;
132 unsigned int ce_namelen;
133 unsigned char sha1[20];
134 struct cache_entry *next;
135 char name[FLEX_ARRAY]; /* more */
138 #define CE_STAGEMASK (0x3000)
139 #define CE_EXTENDED (0x4000)
140 #define CE_VALID (0x8000)
141 #define CE_STAGESHIFT 12
144 * Range 0xFFFF0000 in ce_flags is divided into
145 * two parts: in-memory flags and on-disk ones.
146 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
147 * if you want to save a new flag, add it in
148 * CE_EXTENDED_FLAGS
150 * In-memory only flags
152 #define CE_UPDATE (1 << 16)
153 #define CE_REMOVE (1 << 17)
154 #define CE_UPTODATE (1 << 18)
155 #define CE_ADDED (1 << 19)
157 #define CE_HASHED (1 << 20)
158 #define CE_UNHASHED (1 << 21)
159 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
160 #define CE_CONFLICTED (1 << 23)
162 #define CE_UNPACKED (1 << 24)
163 #define CE_NEW_SKIP_WORKTREE (1 << 25)
166 * Extended on-disk flags
168 #define CE_INTENT_TO_ADD (1 << 29)
169 #define CE_SKIP_WORKTREE (1 << 30)
170 /* CE_EXTENDED2 is for future extension */
171 #define CE_EXTENDED2 (1 << 31)
173 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
176 * Safeguard to avoid saving wrong flags:
177 * - CE_EXTENDED2 won't get saved until its semantic is known
178 * - Bits in 0x0000FFFF have been saved in ce_flags already
179 * - Bits in 0x003F0000 are currently in-memory flags
181 #if CE_EXTENDED_FLAGS & 0x803FFFFF
182 #error "CE_EXTENDED_FLAGS out of range"
183 #endif
186 * Copy the sha1 and stat state of a cache entry from one to
187 * another. But we never change the name, or the hash state!
189 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
190 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
192 unsigned int state = dst->ce_flags & CE_STATE_MASK;
194 /* Don't copy hash chain and name */
195 memcpy(dst, src, offsetof(struct cache_entry, next));
197 /* Restore the hash state */
198 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
201 static inline unsigned create_ce_flags(unsigned stage)
203 return (stage << CE_STAGESHIFT);
206 #define ce_namelen(ce) ((ce)->ce_namelen)
207 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
208 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
209 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
210 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
211 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
213 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
214 static inline unsigned int create_ce_mode(unsigned int mode)
216 if (S_ISLNK(mode))
217 return S_IFLNK;
218 if (S_ISDIR(mode) || S_ISGITLINK(mode))
219 return S_IFGITLINK;
220 return S_IFREG | ce_permissions(mode);
222 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
224 extern int trust_executable_bit, has_symlinks;
225 if (!has_symlinks && S_ISREG(mode) &&
226 ce && S_ISLNK(ce->ce_mode))
227 return ce->ce_mode;
228 if (!trust_executable_bit && S_ISREG(mode)) {
229 if (ce && S_ISREG(ce->ce_mode))
230 return ce->ce_mode;
231 return create_ce_mode(0666);
233 return create_ce_mode(mode);
235 static inline int ce_to_dtype(const struct cache_entry *ce)
237 unsigned ce_mode = ntohl(ce->ce_mode);
238 if (S_ISREG(ce_mode))
239 return DT_REG;
240 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
241 return DT_DIR;
242 else if (S_ISLNK(ce_mode))
243 return DT_LNK;
244 else
245 return DT_UNKNOWN;
247 static inline unsigned int canon_mode(unsigned int mode)
249 if (S_ISREG(mode))
250 return S_IFREG | ce_permissions(mode);
251 if (S_ISLNK(mode))
252 return S_IFLNK;
253 if (S_ISDIR(mode))
254 return S_IFDIR;
255 return S_IFGITLINK;
258 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
260 struct index_state {
261 struct cache_entry **cache;
262 unsigned int version;
263 unsigned int cache_nr, cache_alloc, cache_changed;
264 struct string_list *resolve_undo;
265 struct cache_tree *cache_tree;
266 struct cache_time timestamp;
267 unsigned name_hash_initialized : 1,
268 initialized : 1;
269 struct hash_table name_hash;
270 struct hash_table dir_hash;
273 extern struct index_state the_index;
275 /* Name hashing */
276 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
277 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
278 extern void free_name_hash(struct index_state *istate);
281 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
282 #define active_cache (the_index.cache)
283 #define active_nr (the_index.cache_nr)
284 #define active_alloc (the_index.cache_alloc)
285 #define active_cache_changed (the_index.cache_changed)
286 #define active_cache_tree (the_index.cache_tree)
288 #define read_cache() read_index(&the_index)
289 #define read_cache_from(path) read_index_from(&the_index, (path))
290 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
291 #define is_cache_unborn() is_index_unborn(&the_index)
292 #define read_cache_unmerged() read_index_unmerged(&the_index)
293 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
294 #define discard_cache() discard_index(&the_index)
295 #define unmerged_cache() unmerged_index(&the_index)
296 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
297 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
298 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
299 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
300 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
301 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
302 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
303 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
304 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
305 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
306 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
307 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
308 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
309 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
310 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
311 #endif
313 enum object_type {
314 OBJ_BAD = -1,
315 OBJ_NONE = 0,
316 OBJ_COMMIT = 1,
317 OBJ_TREE = 2,
318 OBJ_BLOB = 3,
319 OBJ_TAG = 4,
320 /* 5 for future expansion */
321 OBJ_OFS_DELTA = 6,
322 OBJ_REF_DELTA = 7,
323 OBJ_ANY,
324 OBJ_MAX
327 static inline enum object_type object_type(unsigned int mode)
329 return S_ISDIR(mode) ? OBJ_TREE :
330 S_ISGITLINK(mode) ? OBJ_COMMIT :
331 OBJ_BLOB;
334 /* Double-check local_repo_env below if you add to this list. */
335 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
336 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
337 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
338 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
339 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
340 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
341 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
342 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
343 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
344 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
345 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
346 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
347 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
348 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
349 #define GITATTRIBUTES_FILE ".gitattributes"
350 #define INFOATTRIBUTES_FILE "info/attributes"
351 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
352 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
353 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
354 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
355 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
356 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
357 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
360 * This environment variable is expected to contain a boolean indicating
361 * whether we should or should not treat:
363 * GIT_DIR=foo.git git ...
365 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
366 * of this, but we use it internally to communicate to sub-processes that we
367 * are in a bare repo. If not set, defaults to true.
369 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
372 * Repository-local GIT_* environment variables; these will be cleared
373 * when git spawns a sub-process that runs inside another repository.
374 * The array is NULL-terminated, which makes it easy to pass in the "env"
375 * parameter of a run-command invocation, or to do a simple walk.
377 extern const char * const local_repo_env[];
379 extern int is_bare_repository_cfg;
380 extern int is_bare_repository(void);
381 extern int is_inside_git_dir(void);
382 extern char *git_work_tree_cfg;
383 extern int is_inside_work_tree(void);
384 extern int have_git_dir(void);
385 extern const char *get_git_dir(void);
386 extern int is_git_directory(const char *path);
387 extern char *get_object_directory(void);
388 extern char *get_index_file(void);
389 extern char *get_graft_file(void);
390 extern int set_git_dir(const char *path);
391 extern const char *get_git_namespace(void);
392 extern const char *strip_namespace(const char *namespaced_ref);
393 extern const char *get_git_work_tree(void);
394 extern const char *read_gitfile(const char *path);
395 extern const char *resolve_gitdir(const char *suspect);
396 extern void set_git_work_tree(const char *tree);
398 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
400 extern const char **get_pathspec(const char *prefix, const char **pathspec);
401 extern void setup_work_tree(void);
402 extern const char *setup_git_directory_gently(int *);
403 extern const char *setup_git_directory(void);
404 extern char *prefix_path(const char *prefix, int len, const char *path);
405 extern const char *prefix_filename(const char *prefix, int len, const char *path);
406 extern int check_filename(const char *prefix, const char *name);
407 extern void verify_filename(const char *prefix,
408 const char *name,
409 int diagnose_misspelt_rev);
410 extern void verify_non_filename(const char *prefix, const char *name);
411 extern int path_inside_repo(const char *prefix, const char *path);
413 #define INIT_DB_QUIET 0x0001
415 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
416 extern int init_db(const char *template_dir, unsigned int flags);
418 #define alloc_nr(x) (((x)+16)*3/2)
421 * Realloc the buffer pointed at by variable 'x' so that it can hold
422 * at least 'nr' entries; the number of entries currently allocated
423 * is 'alloc', using the standard growing factor alloc_nr() macro.
425 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
427 #define ALLOC_GROW(x, nr, alloc) \
428 do { \
429 if ((nr) > alloc) { \
430 if (alloc_nr(alloc) < (nr)) \
431 alloc = (nr); \
432 else \
433 alloc = alloc_nr(alloc); \
434 x = xrealloc((x), alloc * sizeof(*(x))); \
436 } while (0)
438 /* Initialize and use the cache information */
439 extern int read_index(struct index_state *);
440 extern int read_index_preload(struct index_state *, const char **pathspec);
441 extern int read_index_from(struct index_state *, const char *path);
442 extern int is_index_unborn(struct index_state *);
443 extern int read_index_unmerged(struct index_state *);
444 extern int write_index(struct index_state *, int newfd);
445 extern int discard_index(struct index_state *);
446 extern int unmerged_index(const struct index_state *);
447 extern int verify_path(const char *path);
448 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
449 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
450 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
451 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
452 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
453 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
454 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
455 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
456 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
457 extern int remove_index_entry_at(struct index_state *, int pos);
458 extern void remove_marked_cache_entries(struct index_state *istate);
459 extern int remove_file_from_index(struct index_state *, const char *path);
460 #define ADD_CACHE_VERBOSE 1
461 #define ADD_CACHE_PRETEND 2
462 #define ADD_CACHE_IGNORE_ERRORS 4
463 #define ADD_CACHE_IGNORE_REMOVAL 8
464 #define ADD_CACHE_INTENT 16
465 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
466 extern int add_file_to_index(struct index_state *, const char *path, int flags);
467 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
468 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
469 extern int index_name_is_other(const struct index_state *, const char *, int);
471 /* do stat comparison even if CE_VALID is true */
472 #define CE_MATCH_IGNORE_VALID 01
473 /* do not check the contents but report dirty on racily-clean entries */
474 #define CE_MATCH_RACY_IS_DIRTY 02
475 /* do stat comparison even if CE_SKIP_WORKTREE is true */
476 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
477 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
478 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
480 #define PATHSPEC_ONESTAR 1 /* the pathspec pattern sastisfies GFNM_ONESTAR */
482 struct pathspec {
483 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
484 int nr;
485 unsigned int has_wildcard:1;
486 unsigned int recursive:1;
487 int max_depth;
488 struct pathspec_item {
489 const char *match;
490 int len;
491 int nowildcard_len;
492 int flags;
493 } *items;
496 extern int init_pathspec(struct pathspec *, const char **);
497 extern void free_pathspec(struct pathspec *);
498 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
500 extern int limit_pathspec_to_literal(void);
502 #define HASH_WRITE_OBJECT 1
503 #define HASH_FORMAT_CHECK 2
504 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
505 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
506 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
508 #define REFRESH_REALLY 0x0001 /* ignore_valid */
509 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
510 #define REFRESH_QUIET 0x0004 /* be quiet about it */
511 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
512 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
513 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
514 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
516 struct lock_file {
517 struct lock_file *next;
518 int fd;
519 pid_t owner;
520 char on_list;
521 char filename[PATH_MAX];
523 #define LOCK_DIE_ON_ERROR 1
524 #define LOCK_NODEREF 2
525 extern int unable_to_lock_error(const char *path, int err);
526 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
527 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
528 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
529 extern int commit_lock_file(struct lock_file *);
530 extern void update_index_if_able(struct index_state *, struct lock_file *);
532 extern int hold_locked_index(struct lock_file *, int);
533 extern int commit_locked_index(struct lock_file *);
534 extern void set_alternate_index_output(const char *);
535 extern int close_lock_file(struct lock_file *);
536 extern void rollback_lock_file(struct lock_file *);
537 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
539 /* Environment bits from configuration mechanism */
540 extern int trust_executable_bit;
541 extern int trust_ctime;
542 extern int check_stat;
543 extern int quote_path_fully;
544 extern int has_symlinks;
545 extern int minimum_abbrev, default_abbrev;
546 extern int ignore_case;
547 extern int assume_unchanged;
548 extern int prefer_symlink_refs;
549 extern int log_all_ref_updates;
550 extern int warn_ambiguous_refs;
551 extern int shared_repository;
552 extern const char *apply_default_whitespace;
553 extern const char *apply_default_ignorewhitespace;
554 extern const char *git_attributes_file;
555 extern int zlib_compression_level;
556 extern int core_compression_level;
557 extern int core_compression_seen;
558 extern size_t packed_git_window_size;
559 extern size_t packed_git_limit;
560 extern size_t delta_base_cache_limit;
561 extern unsigned long big_file_threshold;
562 extern unsigned long pack_size_limit_cfg;
563 extern int read_replace_refs;
564 extern int fsync_object_files;
565 extern int core_preload_index;
566 extern int core_apply_sparse_checkout;
567 extern int precomposed_unicode;
570 * The character that begins a commented line in user-editable file
571 * that is subject to stripspace.
573 extern char comment_line_char;
575 enum branch_track {
576 BRANCH_TRACK_UNSPECIFIED = -1,
577 BRANCH_TRACK_NEVER = 0,
578 BRANCH_TRACK_REMOTE,
579 BRANCH_TRACK_ALWAYS,
580 BRANCH_TRACK_EXPLICIT,
581 BRANCH_TRACK_OVERRIDE
584 enum rebase_setup_type {
585 AUTOREBASE_NEVER = 0,
586 AUTOREBASE_LOCAL,
587 AUTOREBASE_REMOTE,
588 AUTOREBASE_ALWAYS
591 enum push_default_type {
592 PUSH_DEFAULT_NOTHING = 0,
593 PUSH_DEFAULT_MATCHING,
594 PUSH_DEFAULT_SIMPLE,
595 PUSH_DEFAULT_UPSTREAM,
596 PUSH_DEFAULT_CURRENT,
597 PUSH_DEFAULT_UNSPECIFIED
600 extern enum branch_track git_branch_track;
601 extern enum rebase_setup_type autorebase;
602 extern enum push_default_type push_default;
604 enum object_creation_mode {
605 OBJECT_CREATION_USES_HARDLINKS = 0,
606 OBJECT_CREATION_USES_RENAMES = 1
609 extern enum object_creation_mode object_creation_mode;
611 extern char *notes_ref_name;
613 extern int grafts_replace_parents;
615 #define GIT_REPO_VERSION 0
616 extern int repository_format_version;
617 extern int check_repository_format(void);
619 #define MTIME_CHANGED 0x0001
620 #define CTIME_CHANGED 0x0002
621 #define OWNER_CHANGED 0x0004
622 #define MODE_CHANGED 0x0008
623 #define INODE_CHANGED 0x0010
624 #define DATA_CHANGED 0x0020
625 #define TYPE_CHANGED 0x0040
627 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
628 __attribute__((format (printf, 3, 4)));
629 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
630 __attribute__((format (printf, 3, 4)));
631 extern char *git_pathdup(const char *fmt, ...)
632 __attribute__((format (printf, 1, 2)));
633 extern char *mkpathdup(const char *fmt, ...)
634 __attribute__((format (printf, 1, 2)));
636 /* Return a statically allocated filename matching the sha1 signature */
637 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
638 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
639 extern char *git_path_submodule(const char *path, const char *fmt, ...)
640 __attribute__((format (printf, 2, 3)));
642 extern char *sha1_file_name(const unsigned char *sha1);
643 extern char *sha1_pack_name(const unsigned char *sha1);
644 extern char *sha1_pack_index_name(const unsigned char *sha1);
645 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
646 extern const unsigned char null_sha1[20];
648 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
650 int i;
652 for (i = 0; i < 20; i++, sha1++, sha2++) {
653 if (*sha1 != *sha2)
654 return *sha1 - *sha2;
657 return 0;
660 static inline int is_null_sha1(const unsigned char *sha1)
662 return !hashcmp(sha1, null_sha1);
665 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
667 memcpy(sha_dst, sha_src, 20);
669 static inline void hashclr(unsigned char *hash)
671 memset(hash, 0, 20);
674 #define EMPTY_TREE_SHA1_HEX \
675 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
676 #define EMPTY_TREE_SHA1_BIN_LITERAL \
677 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
678 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
679 #define EMPTY_TREE_SHA1_BIN \
680 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
682 #define EMPTY_BLOB_SHA1_HEX \
683 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
684 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
685 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
686 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
687 #define EMPTY_BLOB_SHA1_BIN \
688 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
690 static inline int is_empty_blob_sha1(const unsigned char *sha1)
692 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
695 int git_mkstemp(char *path, size_t n, const char *template);
697 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
699 /* set default permissions by passing mode arguments to open(2) */
700 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
701 int git_mkstemp_mode(char *pattern, int mode);
704 * NOTE NOTE NOTE!!
706 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
707 * not be changed. Old repositories have core.sharedrepository written in
708 * numeric format, and therefore these values are preserved for compatibility
709 * reasons.
711 enum sharedrepo {
712 PERM_UMASK = 0,
713 OLD_PERM_GROUP = 1,
714 OLD_PERM_EVERYBODY = 2,
715 PERM_GROUP = 0660,
716 PERM_EVERYBODY = 0664
718 int git_config_perm(const char *var, const char *value);
719 int set_shared_perm(const char *path, int mode);
720 #define adjust_shared_perm(path) set_shared_perm((path), 0)
721 int safe_create_leading_directories(char *path);
722 int safe_create_leading_directories_const(const char *path);
723 int mkdir_in_gitdir(const char *path);
724 extern void home_config_paths(char **global, char **xdg, char *file);
725 extern char *expand_user_path(const char *path);
726 const char *enter_repo(const char *path, int strict);
727 static inline int is_absolute_path(const char *path)
729 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
731 int is_directory(const char *);
732 const char *real_path(const char *path);
733 const char *real_path_if_valid(const char *path);
734 const char *absolute_path(const char *path);
735 const char *relative_path(const char *abs, const char *base);
736 int normalize_path_copy(char *dst, const char *src);
737 int longest_ancestor_length(const char *path, struct string_list *prefixes);
738 char *strip_path_suffix(const char *path, const char *suffix);
739 int daemon_avoid_alias(const char *path);
740 int offset_1st_component(const char *path);
742 /* object replacement */
743 #define READ_SHA1_FILE_REPLACE 1
744 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
745 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
747 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
749 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
750 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
752 if (!read_replace_refs)
753 return sha1;
754 return do_lookup_replace_object(sha1);
757 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
758 extern int sha1_object_info(const unsigned char *, unsigned long *);
759 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
760 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
761 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
762 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
763 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
764 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
765 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
767 /* global flag to enable extra checks when accessing packed objects */
768 extern int do_check_packed_object_crc;
770 /* for development: log offset of pack access */
771 extern const char *log_pack_access;
773 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
775 extern int move_temp_to_file(const char *tmpfile, const char *filename);
777 extern int has_sha1_pack(const unsigned char *sha1);
778 extern int has_sha1_file(const unsigned char *sha1);
779 extern int has_loose_object_nonlocal(const unsigned char *sha1);
781 extern int has_pack_index(const unsigned char *sha1);
783 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
785 extern const signed char hexval_table[256];
786 static inline unsigned int hexval(unsigned char c)
788 return hexval_table[c];
791 /* Convert to/from hex/sha1 representation */
792 #define MINIMUM_ABBREV minimum_abbrev
793 #define DEFAULT_ABBREV default_abbrev
795 struct object_context {
796 unsigned char tree[20];
797 char path[PATH_MAX];
798 unsigned mode;
801 #define GET_SHA1_QUIETLY 01
802 #define GET_SHA1_COMMIT 02
803 #define GET_SHA1_COMMITTISH 04
804 #define GET_SHA1_TREE 010
805 #define GET_SHA1_TREEISH 020
806 #define GET_SHA1_BLOB 040
807 #define GET_SHA1_ONLY_TO_DIE 04000
809 extern int get_sha1(const char *str, unsigned char *sha1);
810 extern int get_sha1_commit(const char *str, unsigned char *sha1);
811 extern int get_sha1_committish(const char *str, unsigned char *sha1);
812 extern int get_sha1_tree(const char *str, unsigned char *sha1);
813 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
814 extern int get_sha1_blob(const char *str, unsigned char *sha1);
815 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
816 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
818 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
819 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
822 * Try to read a SHA1 in hexadecimal format from the 40 characters
823 * starting at hex. Write the 20-byte result to sha1 in binary form.
824 * Return 0 on success. Reading stops if a NUL is encountered in the
825 * input, so it is safe to pass this function an arbitrary
826 * null-terminated string.
828 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
830 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
831 extern int read_ref_full(const char *refname, unsigned char *sha1,
832 int reading, int *flags);
833 extern int read_ref(const char *refname, unsigned char *sha1);
836 * Resolve a reference, recursively following symbolic refererences.
838 * Store the referred-to object's name in sha1 and return the name of
839 * the non-symbolic reference that ultimately pointed at it. The
840 * return value, if not NULL, is a pointer into either a static buffer
841 * or the input ref.
843 * If the reference cannot be resolved to an object, the behavior
844 * depends on the "reading" argument:
846 * - If reading is set, return NULL.
848 * - If reading is not set, clear sha1 and return the name of the last
849 * reference name in the chain, which will either be a non-symbolic
850 * reference or an undefined reference. If this is a prelude to
851 * "writing" to the ref, the return value is the name of the ref
852 * that will actually be created or changed.
854 * If flag is non-NULL, set the value that it points to the
855 * combination of REF_ISPACKED (if the reference was found among the
856 * packed references) and REF_ISSYMREF (if the initial reference was a
857 * symbolic reference).
859 * If ref is not a properly-formatted, normalized reference, return
860 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
861 * give up and return NULL.
863 * errno is sometimes set on errors, but not always.
865 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
866 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
868 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
869 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
870 extern int interpret_branch_name(const char *str, struct strbuf *);
871 extern int get_sha1_mb(const char *str, unsigned char *sha1);
873 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
874 extern const char *ref_rev_parse_rules[];
875 #define ref_fetch_rules ref_rev_parse_rules
877 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
878 extern int validate_headref(const char *ref);
880 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
881 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
882 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
883 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
885 extern void *read_object_with_reference(const unsigned char *sha1,
886 const char *required_type,
887 unsigned long *size,
888 unsigned char *sha1_ret);
890 extern struct object *peel_to_type(const char *name, int namelen,
891 struct object *o, enum object_type);
893 enum date_mode {
894 DATE_NORMAL = 0,
895 DATE_RELATIVE,
896 DATE_SHORT,
897 DATE_LOCAL,
898 DATE_ISO8601,
899 DATE_RFC2822,
900 DATE_RAW
903 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
904 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
905 struct strbuf *timebuf);
906 int parse_date(const char *date, char *buf, int bufsize);
907 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
908 void datestamp(char *buf, int bufsize);
909 #define approxidate(s) approxidate_careful((s), NULL)
910 unsigned long approxidate_careful(const char *, int *);
911 unsigned long approxidate_relative(const char *date, const struct timeval *now);
912 enum date_mode parse_date_format(const char *format);
914 #define IDENT_STRICT 1
915 #define IDENT_NO_DATE 2
916 #define IDENT_NO_NAME 4
917 extern const char *git_author_info(int);
918 extern const char *git_committer_info(int);
919 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
920 extern const char *fmt_name(const char *name, const char *email);
921 extern const char *ident_default_email(void);
922 extern const char *git_editor(void);
923 extern const char *git_pager(int stdout_is_tty);
924 extern int git_ident_config(const char *, const char *, void *);
926 struct ident_split {
927 const char *name_begin;
928 const char *name_end;
929 const char *mail_begin;
930 const char *mail_end;
931 const char *date_begin;
932 const char *date_end;
933 const char *tz_begin;
934 const char *tz_end;
937 * Signals an success with 0, but time part of the result may be NULL
938 * if the input lacks timestamp and zone
940 extern int split_ident_line(struct ident_split *, const char *, int);
942 struct checkout {
943 const char *base_dir;
944 int base_dir_len;
945 unsigned force:1,
946 quiet:1,
947 not_new:1,
948 refresh_cache:1;
951 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
953 struct cache_def {
954 char path[PATH_MAX + 1];
955 int len;
956 int flags;
957 int track_flags;
958 int prefix_len_stat_func;
961 extern int has_symlink_leading_path(const char *name, int len);
962 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
963 extern int check_leading_path(const char *name, int len);
964 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
965 extern void schedule_dir_for_removal(const char *name, int len);
966 extern void remove_scheduled_dirs(void);
968 extern struct alternate_object_database {
969 struct alternate_object_database *next;
970 char *name;
971 char base[FLEX_ARRAY]; /* more */
972 } *alt_odb_list;
973 extern void prepare_alt_odb(void);
974 extern void read_info_alternates(const char * relative_base, int depth);
975 extern void add_to_alternates_file(const char *reference);
976 typedef int alt_odb_fn(struct alternate_object_database *, void *);
977 extern void foreach_alt_odb(alt_odb_fn, void*);
979 struct pack_window {
980 struct pack_window *next;
981 unsigned char *base;
982 off_t offset;
983 size_t len;
984 unsigned int last_used;
985 unsigned int inuse_cnt;
988 extern struct packed_git {
989 struct packed_git *next;
990 struct pack_window *windows;
991 off_t pack_size;
992 const void *index_data;
993 size_t index_size;
994 uint32_t num_objects;
995 uint32_t num_bad_objects;
996 unsigned char *bad_object_sha1;
997 int index_version;
998 time_t mtime;
999 int pack_fd;
1000 unsigned pack_local:1,
1001 pack_keep:1,
1002 do_not_close:1;
1003 unsigned char sha1[20];
1004 /* something like ".git/objects/pack/xxxxx.pack" */
1005 char pack_name[FLEX_ARRAY]; /* more */
1006 } *packed_git;
1008 struct pack_entry {
1009 off_t offset;
1010 unsigned char sha1[20];
1011 struct packed_git *p;
1014 struct ref {
1015 struct ref *next;
1016 unsigned char old_sha1[20];
1017 unsigned char new_sha1[20];
1018 char *symref;
1019 unsigned int
1020 force:1,
1021 forced_update:1,
1022 merge:1,
1023 deletion:1,
1024 matched:1;
1025 enum {
1026 REF_STATUS_NONE = 0,
1027 REF_STATUS_OK,
1028 REF_STATUS_REJECT_NONFASTFORWARD,
1029 REF_STATUS_REJECT_ALREADY_EXISTS,
1030 REF_STATUS_REJECT_NODELETE,
1031 REF_STATUS_REJECT_FETCH_FIRST,
1032 REF_STATUS_REJECT_NEEDS_FORCE,
1033 REF_STATUS_UPTODATE,
1034 REF_STATUS_REMOTE_REJECT,
1035 REF_STATUS_EXPECTING_REPORT
1036 } status;
1037 char *remote_status;
1038 struct ref *peer_ref; /* when renaming */
1039 char name[FLEX_ARRAY]; /* more */
1042 #define REF_NORMAL (1u << 0)
1043 #define REF_HEADS (1u << 1)
1044 #define REF_TAGS (1u << 2)
1046 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1048 #define CONNECT_VERBOSE (1u << 0)
1049 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1050 extern int finish_connect(struct child_process *conn);
1051 extern int git_connection_is_socket(struct child_process *conn);
1052 struct extra_have_objects {
1053 int nr, alloc;
1054 unsigned char (*array)[20];
1056 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
1057 struct ref **list, unsigned int flags,
1058 struct extra_have_objects *);
1059 extern int server_supports(const char *feature);
1060 extern int parse_feature_request(const char *features, const char *feature);
1061 extern const char *server_feature_value(const char *feature, int *len_ret);
1062 extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1064 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1066 /* A hook for count-objects to report invalid files in pack directory */
1067 extern void (*report_garbage)(const char *desc, const char *path);
1069 extern void prepare_packed_git(void);
1070 extern void reprepare_packed_git(void);
1071 extern void install_packed_git(struct packed_git *pack);
1073 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1074 struct packed_git *packs);
1076 extern void pack_report(void);
1077 extern int open_pack_index(struct packed_git *);
1078 extern void close_pack_index(struct packed_git *);
1079 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1080 extern void close_pack_windows(struct packed_git *);
1081 extern void unuse_pack(struct pack_window **);
1082 extern void free_pack_by_name(const char *);
1083 extern void clear_delta_base_cache(void);
1084 extern struct packed_git *add_packed_git(const char *, int, int);
1085 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1086 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1087 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1088 extern int is_pack_valid(struct packed_git *);
1089 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1090 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1091 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1092 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1094 struct object_info {
1095 /* Request */
1096 unsigned long *sizep;
1098 /* Response */
1099 enum {
1100 OI_CACHED,
1101 OI_LOOSE,
1102 OI_PACKED,
1103 OI_DBCACHED
1104 } whence;
1105 union {
1107 * struct {
1108 * ... Nothing to expose in this case
1109 * } cached;
1110 * struct {
1111 * ... Nothing to expose in this case
1112 * } loose;
1114 struct {
1115 struct packed_git *pack;
1116 off_t offset;
1117 unsigned int is_delta;
1118 } packed;
1119 } u;
1121 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1123 /* Dumb servers support */
1124 extern int update_server_info(int);
1126 /* git_config_parse_key() returns these negated: */
1127 #define CONFIG_INVALID_KEY 1
1128 #define CONFIG_NO_SECTION_OR_NAME 2
1129 /* git_config_set(), git_config_set_multivar() return the above or these: */
1130 #define CONFIG_NO_LOCK -1
1131 #define CONFIG_INVALID_FILE 3
1132 #define CONFIG_NO_WRITE 4
1133 #define CONFIG_NOTHING_SET 5
1134 #define CONFIG_INVALID_PATTERN 6
1135 #define CONFIG_GENERIC_ERROR 7
1137 typedef int (*config_fn_t)(const char *, const char *, void *);
1138 extern int git_default_config(const char *, const char *, void *);
1139 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1140 extern void git_config_push_parameter(const char *text);
1141 extern int git_config_from_parameters(config_fn_t fn, void *data);
1142 extern int git_config(config_fn_t fn, void *);
1143 extern int git_config_with_options(config_fn_t fn, void *,
1144 const char *filename, int respect_includes);
1145 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1146 extern int git_parse_ulong(const char *, unsigned long *);
1147 extern int git_config_int(const char *, const char *);
1148 extern unsigned long git_config_ulong(const char *, const char *);
1149 extern int git_config_bool_or_int(const char *, const char *, int *);
1150 extern int git_config_bool(const char *, const char *);
1151 extern int git_config_maybe_bool(const char *, const char *);
1152 extern int git_config_string(const char **, const char *, const char *);
1153 extern int git_config_pathname(const char **, const char *, const char *);
1154 extern int git_config_set_in_file(const char *, const char *, const char *);
1155 extern int git_config_set(const char *, const char *);
1156 extern int git_config_parse_key(const char *, char **, int *);
1157 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1158 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1159 extern int git_config_rename_section(const char *, const char *);
1160 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1161 extern const char *git_etc_gitconfig(void);
1162 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1163 extern int git_env_bool(const char *, int);
1164 extern int git_config_system(void);
1165 extern int config_error_nonbool(const char *);
1166 #if defined(__GNUC__) && ! defined(__clang__)
1167 #define config_error_nonbool(s) (config_error_nonbool(s), -1)
1168 #endif
1169 extern const char *get_log_output_encoding(void);
1170 extern const char *get_commit_output_encoding(void);
1172 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1174 struct config_include_data {
1175 int depth;
1176 config_fn_t fn;
1177 void *data;
1179 #define CONFIG_INCLUDE_INIT { 0 }
1180 extern int git_config_include(const char *name, const char *value, void *data);
1183 * Match and parse a config key of the form:
1185 * section.(subsection.)?key
1187 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1188 * we return -1 if it does not match, 0 otherwise. The subsection and key
1189 * out-parameters are filled by the function (and subsection is NULL if it is
1190 * missing).
1192 extern int parse_config_key(const char *var,
1193 const char *section,
1194 const char **subsection, int *subsection_len,
1195 const char **key);
1197 extern int committer_ident_sufficiently_given(void);
1198 extern int author_ident_sufficiently_given(void);
1200 extern const char *git_commit_encoding;
1201 extern const char *git_log_output_encoding;
1202 extern const char *git_mailmap_file;
1203 extern const char *git_mailmap_blob;
1205 /* IO helper functions */
1206 extern void maybe_flush_or_die(FILE *, const char *);
1207 extern int copy_fd(int ifd, int ofd);
1208 extern int copy_file(const char *dst, const char *src, int mode);
1209 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1210 extern void write_or_die(int fd, const void *buf, size_t count);
1211 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1212 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1213 extern void fsync_or_die(int fd, const char *);
1215 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1216 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1217 static inline ssize_t write_str_in_full(int fd, const char *str)
1219 return write_in_full(fd, str, strlen(str));
1222 /* pager.c */
1223 extern void setup_pager(void);
1224 extern const char *pager_program;
1225 extern int pager_in_use(void);
1226 extern int pager_use_color;
1227 extern int term_columns(void);
1228 extern int decimal_width(int);
1229 extern int check_pager_config(const char *cmd);
1231 extern const char *editor_program;
1232 extern const char *askpass_program;
1233 extern const char *excludes_file;
1235 /* base85 */
1236 int decode_85(char *dst, const char *line, int linelen);
1237 void encode_85(char *buf, const unsigned char *data, int bytes);
1239 /* alloc.c */
1240 extern void *alloc_blob_node(void);
1241 extern void *alloc_tree_node(void);
1242 extern void *alloc_commit_node(void);
1243 extern void *alloc_tag_node(void);
1244 extern void *alloc_object_node(void);
1245 extern void alloc_report(void);
1247 /* trace.c */
1248 __attribute__((format (printf, 1, 2)))
1249 extern void trace_printf(const char *format, ...);
1250 __attribute__((format (printf, 2, 3)))
1251 extern void trace_argv_printf(const char **argv, const char *format, ...);
1252 extern void trace_repo_setup(const char *prefix);
1253 extern int trace_want(const char *key);
1254 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1256 void packet_trace_identity(const char *prog);
1258 /* add */
1260 * return 0 if success, 1 - if addition of a file failed and
1261 * ADD_FILES_IGNORE_ERRORS was specified in flags
1263 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1265 /* diff.c */
1266 extern int diff_auto_refresh_index;
1268 /* match-trees.c */
1269 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1270 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1273 * whitespace rules.
1274 * used by both diff and apply
1275 * last two digits are tab width
1277 #define WS_BLANK_AT_EOL 0100
1278 #define WS_SPACE_BEFORE_TAB 0200
1279 #define WS_INDENT_WITH_NON_TAB 0400
1280 #define WS_CR_AT_EOL 01000
1281 #define WS_BLANK_AT_EOF 02000
1282 #define WS_TAB_IN_INDENT 04000
1283 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1284 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1285 #define WS_TAB_WIDTH_MASK 077
1286 extern unsigned whitespace_rule_cfg;
1287 extern unsigned whitespace_rule(const char *);
1288 extern unsigned parse_whitespace_rule(const char *);
1289 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1290 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1291 extern char *whitespace_error_string(unsigned ws);
1292 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1293 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1294 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1296 /* ls-files */
1297 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1298 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1300 char *alias_lookup(const char *alias);
1301 int split_cmdline(char *cmdline, const char ***argv);
1302 /* Takes a negative value returned by split_cmdline */
1303 const char *split_cmdline_strerror(int cmdline_errno);
1305 /* git.c */
1306 struct startup_info {
1307 int have_repository;
1308 const char *prefix;
1310 extern struct startup_info *startup_info;
1312 /* merge.c */
1313 struct commit_list;
1314 int try_merge_command(const char *strategy, size_t xopts_nr,
1315 const char **xopts, struct commit_list *common,
1316 const char *head_arg, struct commit_list *remotes);
1317 int checkout_fast_forward(const unsigned char *from,
1318 const unsigned char *to,
1319 int overwrite_ignore);
1322 int sane_execvp(const char *file, char *const argv[]);
1324 #endif /* CACHE_H */