Merge branch 'master' of git://git.kernel.org/pub/scm/git/git
[git/jnareb-git.git] / cache.h
blobe1e8ce80ed11efb9483fca3205f383a3f0825cd7
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)
165 /* used to temporarily mark paths matched by pathspecs */
166 #define CE_MATCHED (1 << 26)
169 * Extended on-disk flags
171 #define CE_INTENT_TO_ADD (1 << 29)
172 #define CE_SKIP_WORKTREE (1 << 30)
173 /* CE_EXTENDED2 is for future extension */
174 #define CE_EXTENDED2 (1 << 31)
176 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
179 * Safeguard to avoid saving wrong flags:
180 * - CE_EXTENDED2 won't get saved until its semantic is known
181 * - Bits in 0x0000FFFF have been saved in ce_flags already
182 * - Bits in 0x003F0000 are currently in-memory flags
184 #if CE_EXTENDED_FLAGS & 0x803FFFFF
185 #error "CE_EXTENDED_FLAGS out of range"
186 #endif
189 * Copy the sha1 and stat state of a cache entry from one to
190 * another. But we never change the name, or the hash state!
192 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
193 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
195 unsigned int state = dst->ce_flags & CE_STATE_MASK;
197 /* Don't copy hash chain and name */
198 memcpy(dst, src, offsetof(struct cache_entry, next));
200 /* Restore the hash state */
201 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
204 static inline unsigned create_ce_flags(unsigned stage)
206 return (stage << CE_STAGESHIFT);
209 #define ce_namelen(ce) ((ce)->ce_namelen)
210 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
211 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
212 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
213 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
214 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
216 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
217 static inline unsigned int create_ce_mode(unsigned int mode)
219 if (S_ISLNK(mode))
220 return S_IFLNK;
221 if (S_ISDIR(mode) || S_ISGITLINK(mode))
222 return S_IFGITLINK;
223 return S_IFREG | ce_permissions(mode);
225 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
227 extern int trust_executable_bit, has_symlinks;
228 if (!has_symlinks && S_ISREG(mode) &&
229 ce && S_ISLNK(ce->ce_mode))
230 return ce->ce_mode;
231 if (!trust_executable_bit && S_ISREG(mode)) {
232 if (ce && S_ISREG(ce->ce_mode))
233 return ce->ce_mode;
234 return create_ce_mode(0666);
236 return create_ce_mode(mode);
238 static inline int ce_to_dtype(const struct cache_entry *ce)
240 unsigned ce_mode = ntohl(ce->ce_mode);
241 if (S_ISREG(ce_mode))
242 return DT_REG;
243 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
244 return DT_DIR;
245 else if (S_ISLNK(ce_mode))
246 return DT_LNK;
247 else
248 return DT_UNKNOWN;
250 static inline unsigned int canon_mode(unsigned int mode)
252 if (S_ISREG(mode))
253 return S_IFREG | ce_permissions(mode);
254 if (S_ISLNK(mode))
255 return S_IFLNK;
256 if (S_ISDIR(mode))
257 return S_IFDIR;
258 return S_IFGITLINK;
261 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
263 struct index_state {
264 struct cache_entry **cache;
265 unsigned int version;
266 unsigned int cache_nr, cache_alloc, cache_changed;
267 struct string_list *resolve_undo;
268 struct cache_tree *cache_tree;
269 struct cache_time timestamp;
270 unsigned name_hash_initialized : 1,
271 initialized : 1;
272 struct hash_table name_hash;
273 struct hash_table dir_hash;
276 extern struct index_state the_index;
278 /* Name hashing */
279 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
280 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
281 extern void free_name_hash(struct index_state *istate);
284 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
285 #define active_cache (the_index.cache)
286 #define active_nr (the_index.cache_nr)
287 #define active_alloc (the_index.cache_alloc)
288 #define active_cache_changed (the_index.cache_changed)
289 #define active_cache_tree (the_index.cache_tree)
291 #define read_cache() read_index(&the_index)
292 #define read_cache_from(path) read_index_from(&the_index, (path))
293 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
294 #define is_cache_unborn() is_index_unborn(&the_index)
295 #define read_cache_unmerged() read_index_unmerged(&the_index)
296 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
297 #define discard_cache() discard_index(&the_index)
298 #define unmerged_cache() unmerged_index(&the_index)
299 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
300 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
301 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
302 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
303 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
304 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
305 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
306 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
307 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
308 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
309 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
310 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
311 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
312 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
313 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
314 #endif
316 enum object_type {
317 OBJ_BAD = -1,
318 OBJ_NONE = 0,
319 OBJ_COMMIT = 1,
320 OBJ_TREE = 2,
321 OBJ_BLOB = 3,
322 OBJ_TAG = 4,
323 /* 5 for future expansion */
324 OBJ_OFS_DELTA = 6,
325 OBJ_REF_DELTA = 7,
326 OBJ_ANY,
327 OBJ_MAX
330 static inline enum object_type object_type(unsigned int mode)
332 return S_ISDIR(mode) ? OBJ_TREE :
333 S_ISGITLINK(mode) ? OBJ_COMMIT :
334 OBJ_BLOB;
337 /* Double-check local_repo_env below if you add to this list. */
338 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
339 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
340 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
341 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
342 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
343 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
344 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
345 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
346 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
347 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
348 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
349 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
350 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
351 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
352 #define GITATTRIBUTES_FILE ".gitattributes"
353 #define INFOATTRIBUTES_FILE "info/attributes"
354 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
355 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
356 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
357 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
358 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
359 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
360 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
363 * This environment variable is expected to contain a boolean indicating
364 * whether we should or should not treat:
366 * GIT_DIR=foo.git git ...
368 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
369 * of this, but we use it internally to communicate to sub-processes that we
370 * are in a bare repo. If not set, defaults to true.
372 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
375 * Repository-local GIT_* environment variables; these will be cleared
376 * when git spawns a sub-process that runs inside another repository.
377 * The array is NULL-terminated, which makes it easy to pass in the "env"
378 * parameter of a run-command invocation, or to do a simple walk.
380 extern const char * const local_repo_env[];
382 extern int is_bare_repository_cfg;
383 extern int is_bare_repository(void);
384 extern int is_inside_git_dir(void);
385 extern char *git_work_tree_cfg;
386 extern int is_inside_work_tree(void);
387 extern int have_git_dir(void);
388 extern const char *get_git_dir(void);
389 extern int is_git_directory(const char *path);
390 extern char *get_object_directory(void);
391 extern char *get_index_file(void);
392 extern char *get_graft_file(void);
393 extern int set_git_dir(const char *path);
394 extern const char *get_git_namespace(void);
395 extern const char *strip_namespace(const char *namespaced_ref);
396 extern const char *get_git_work_tree(void);
397 extern const char *read_gitfile(const char *path);
398 extern const char *resolve_gitdir(const char *suspect);
399 extern void set_git_work_tree(const char *tree);
401 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
403 extern const char **get_pathspec(const char *prefix, const char **pathspec);
404 extern void setup_work_tree(void);
405 extern const char *setup_git_directory_gently(int *);
406 extern const char *setup_git_directory(void);
407 extern char *prefix_path(const char *prefix, int len, const char *path);
408 extern const char *prefix_filename(const char *prefix, int len, const char *path);
409 extern int check_filename(const char *prefix, const char *name);
410 extern void verify_filename(const char *prefix,
411 const char *name,
412 int diagnose_misspelt_rev);
413 extern void verify_non_filename(const char *prefix, const char *name);
414 extern int path_inside_repo(const char *prefix, const char *path);
416 #define INIT_DB_QUIET 0x0001
418 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
419 extern int init_db(const char *template_dir, unsigned int flags);
421 #define alloc_nr(x) (((x)+16)*3/2)
424 * Realloc the buffer pointed at by variable 'x' so that it can hold
425 * at least 'nr' entries; the number of entries currently allocated
426 * is 'alloc', using the standard growing factor alloc_nr() macro.
428 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
430 #define ALLOC_GROW(x, nr, alloc) \
431 do { \
432 if ((nr) > alloc) { \
433 if (alloc_nr(alloc) < (nr)) \
434 alloc = (nr); \
435 else \
436 alloc = alloc_nr(alloc); \
437 x = xrealloc((x), alloc * sizeof(*(x))); \
439 } while (0)
441 /* Initialize and use the cache information */
442 extern int read_index(struct index_state *);
443 extern int read_index_preload(struct index_state *, const char **pathspec);
444 extern int read_index_from(struct index_state *, const char *path);
445 extern int is_index_unborn(struct index_state *);
446 extern int read_index_unmerged(struct index_state *);
447 extern int write_index(struct index_state *, int newfd);
448 extern int discard_index(struct index_state *);
449 extern int unmerged_index(const struct index_state *);
450 extern int verify_path(const char *path);
451 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
452 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
453 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
454 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
455 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
456 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
457 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
458 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
459 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
460 extern int remove_index_entry_at(struct index_state *, int pos);
461 extern void remove_marked_cache_entries(struct index_state *istate);
462 extern int remove_file_from_index(struct index_state *, const char *path);
463 #define ADD_CACHE_VERBOSE 1
464 #define ADD_CACHE_PRETEND 2
465 #define ADD_CACHE_IGNORE_ERRORS 4
466 #define ADD_CACHE_IGNORE_REMOVAL 8
467 #define ADD_CACHE_INTENT 16
468 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
469 extern int add_file_to_index(struct index_state *, const char *path, int flags);
470 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
471 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
472 extern int index_name_is_other(const struct index_state *, const char *, int);
474 /* do stat comparison even if CE_VALID is true */
475 #define CE_MATCH_IGNORE_VALID 01
476 /* do not check the contents but report dirty on racily-clean entries */
477 #define CE_MATCH_RACY_IS_DIRTY 02
478 /* do stat comparison even if CE_SKIP_WORKTREE is true */
479 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
480 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
481 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
483 #define PATHSPEC_ONESTAR 1 /* the pathspec pattern sastisfies GFNM_ONESTAR */
485 struct pathspec {
486 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
487 int nr;
488 unsigned int has_wildcard:1;
489 unsigned int recursive:1;
490 int max_depth;
491 struct pathspec_item {
492 const char *match;
493 int len;
494 int nowildcard_len;
495 int flags;
496 } *items;
499 extern int init_pathspec(struct pathspec *, const char **);
500 extern void free_pathspec(struct pathspec *);
501 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
503 extern int limit_pathspec_to_literal(void);
505 #define HASH_WRITE_OBJECT 1
506 #define HASH_FORMAT_CHECK 2
507 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
508 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
509 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
511 #define REFRESH_REALLY 0x0001 /* ignore_valid */
512 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
513 #define REFRESH_QUIET 0x0004 /* be quiet about it */
514 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
515 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
516 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
517 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
519 struct lock_file {
520 struct lock_file *next;
521 int fd;
522 pid_t owner;
523 char on_list;
524 char filename[PATH_MAX];
526 #define LOCK_DIE_ON_ERROR 1
527 #define LOCK_NODEREF 2
528 extern int unable_to_lock_error(const char *path, int err);
529 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
530 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
531 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
532 extern int commit_lock_file(struct lock_file *);
533 extern void update_index_if_able(struct index_state *, struct lock_file *);
535 extern int hold_locked_index(struct lock_file *, int);
536 extern int commit_locked_index(struct lock_file *);
537 extern void set_alternate_index_output(const char *);
538 extern int close_lock_file(struct lock_file *);
539 extern void rollback_lock_file(struct lock_file *);
540 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
542 /* Environment bits from configuration mechanism */
543 extern int trust_executable_bit;
544 extern int trust_ctime;
545 extern int check_stat;
546 extern int quote_path_fully;
547 extern int has_symlinks;
548 extern int minimum_abbrev, default_abbrev;
549 extern int ignore_case;
550 extern int assume_unchanged;
551 extern int prefer_symlink_refs;
552 extern int log_all_ref_updates;
553 extern int warn_ambiguous_refs;
554 extern int shared_repository;
555 extern const char *apply_default_whitespace;
556 extern const char *apply_default_ignorewhitespace;
557 extern const char *git_attributes_file;
558 extern int zlib_compression_level;
559 extern int core_compression_level;
560 extern int core_compression_seen;
561 extern size_t packed_git_window_size;
562 extern size_t packed_git_limit;
563 extern size_t delta_base_cache_limit;
564 extern unsigned long big_file_threshold;
565 extern unsigned long pack_size_limit_cfg;
566 extern int read_replace_refs;
567 extern int fsync_object_files;
568 extern int core_preload_index;
569 extern int core_apply_sparse_checkout;
570 extern int precomposed_unicode;
573 * The character that begins a commented line in user-editable file
574 * that is subject to stripspace.
576 extern char comment_line_char;
578 enum branch_track {
579 BRANCH_TRACK_UNSPECIFIED = -1,
580 BRANCH_TRACK_NEVER = 0,
581 BRANCH_TRACK_REMOTE,
582 BRANCH_TRACK_ALWAYS,
583 BRANCH_TRACK_EXPLICIT,
584 BRANCH_TRACK_OVERRIDE
587 enum rebase_setup_type {
588 AUTOREBASE_NEVER = 0,
589 AUTOREBASE_LOCAL,
590 AUTOREBASE_REMOTE,
591 AUTOREBASE_ALWAYS
594 enum push_default_type {
595 PUSH_DEFAULT_NOTHING = 0,
596 PUSH_DEFAULT_MATCHING,
597 PUSH_DEFAULT_SIMPLE,
598 PUSH_DEFAULT_UPSTREAM,
599 PUSH_DEFAULT_CURRENT,
600 PUSH_DEFAULT_UNSPECIFIED
603 extern enum branch_track git_branch_track;
604 extern enum rebase_setup_type autorebase;
605 extern enum push_default_type push_default;
607 enum object_creation_mode {
608 OBJECT_CREATION_USES_HARDLINKS = 0,
609 OBJECT_CREATION_USES_RENAMES = 1
612 extern enum object_creation_mode object_creation_mode;
614 extern char *notes_ref_name;
616 extern int grafts_replace_parents;
618 #define GIT_REPO_VERSION 0
619 extern int repository_format_version;
620 extern int check_repository_format(void);
622 #define MTIME_CHANGED 0x0001
623 #define CTIME_CHANGED 0x0002
624 #define OWNER_CHANGED 0x0004
625 #define MODE_CHANGED 0x0008
626 #define INODE_CHANGED 0x0010
627 #define DATA_CHANGED 0x0020
628 #define TYPE_CHANGED 0x0040
630 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
631 __attribute__((format (printf, 3, 4)));
632 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
633 __attribute__((format (printf, 3, 4)));
634 extern char *git_pathdup(const char *fmt, ...)
635 __attribute__((format (printf, 1, 2)));
636 extern char *mkpathdup(const char *fmt, ...)
637 __attribute__((format (printf, 1, 2)));
639 /* Return a statically allocated filename matching the sha1 signature */
640 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
641 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
642 extern char *git_path_submodule(const char *path, const char *fmt, ...)
643 __attribute__((format (printf, 2, 3)));
645 extern char *sha1_file_name(const unsigned char *sha1);
646 extern char *sha1_pack_name(const unsigned char *sha1);
647 extern char *sha1_pack_index_name(const unsigned char *sha1);
648 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
649 extern const unsigned char null_sha1[20];
651 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
653 int i;
655 for (i = 0; i < 20; i++, sha1++, sha2++) {
656 if (*sha1 != *sha2)
657 return *sha1 - *sha2;
660 return 0;
663 static inline int is_null_sha1(const unsigned char *sha1)
665 return !hashcmp(sha1, null_sha1);
668 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
670 memcpy(sha_dst, sha_src, 20);
672 static inline void hashclr(unsigned char *hash)
674 memset(hash, 0, 20);
677 #define EMPTY_TREE_SHA1_HEX \
678 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
679 #define EMPTY_TREE_SHA1_BIN_LITERAL \
680 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
681 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
682 #define EMPTY_TREE_SHA1_BIN \
683 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
685 #define EMPTY_BLOB_SHA1_HEX \
686 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
687 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
688 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
689 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
690 #define EMPTY_BLOB_SHA1_BIN \
691 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
693 static inline int is_empty_blob_sha1(const unsigned char *sha1)
695 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
698 int git_mkstemp(char *path, size_t n, const char *template);
700 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
702 /* set default permissions by passing mode arguments to open(2) */
703 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
704 int git_mkstemp_mode(char *pattern, int mode);
707 * NOTE NOTE NOTE!!
709 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
710 * not be changed. Old repositories have core.sharedrepository written in
711 * numeric format, and therefore these values are preserved for compatibility
712 * reasons.
714 enum sharedrepo {
715 PERM_UMASK = 0,
716 OLD_PERM_GROUP = 1,
717 OLD_PERM_EVERYBODY = 2,
718 PERM_GROUP = 0660,
719 PERM_EVERYBODY = 0664
721 int git_config_perm(const char *var, const char *value);
722 int adjust_shared_perm(const char *path);
723 int safe_create_leading_directories(char *path);
724 int safe_create_leading_directories_const(const char *path);
725 int mkdir_in_gitdir(const char *path);
726 extern void home_config_paths(char **global, char **xdg, char *file);
727 extern char *expand_user_path(const char *path);
728 const char *enter_repo(const char *path, int strict);
729 static inline int is_absolute_path(const char *path)
731 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
733 int is_directory(const char *);
734 const char *real_path(const char *path);
735 const char *real_path_if_valid(const char *path);
736 const char *absolute_path(const char *path);
737 const char *relative_path(const char *abs, const char *base);
738 int normalize_path_copy(char *dst, const char *src);
739 int longest_ancestor_length(const char *path, struct string_list *prefixes);
740 char *strip_path_suffix(const char *path, const char *suffix);
741 int daemon_avoid_alias(const char *path);
742 int offset_1st_component(const char *path);
744 /* object replacement */
745 #define READ_SHA1_FILE_REPLACE 1
746 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
747 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
749 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
751 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
752 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
754 if (!read_replace_refs)
755 return sha1;
756 return do_lookup_replace_object(sha1);
759 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
760 extern int sha1_object_info(const unsigned char *, unsigned long *);
761 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
762 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
763 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
764 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
765 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
766 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
767 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
769 /* global flag to enable extra checks when accessing packed objects */
770 extern int do_check_packed_object_crc;
772 /* for development: log offset of pack access */
773 extern const char *log_pack_access;
775 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
777 extern int move_temp_to_file(const char *tmpfile, const char *filename);
779 extern int has_sha1_pack(const unsigned char *sha1);
780 extern int has_sha1_file(const unsigned char *sha1);
781 extern int has_loose_object_nonlocal(const unsigned char *sha1);
783 extern int has_pack_index(const unsigned char *sha1);
785 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
787 extern const signed char hexval_table[256];
788 static inline unsigned int hexval(unsigned char c)
790 return hexval_table[c];
793 /* Convert to/from hex/sha1 representation */
794 #define MINIMUM_ABBREV minimum_abbrev
795 #define DEFAULT_ABBREV default_abbrev
797 struct object_context {
798 unsigned char tree[20];
799 char path[PATH_MAX];
800 unsigned mode;
803 #define GET_SHA1_QUIETLY 01
804 #define GET_SHA1_COMMIT 02
805 #define GET_SHA1_COMMITTISH 04
806 #define GET_SHA1_TREE 010
807 #define GET_SHA1_TREEISH 020
808 #define GET_SHA1_BLOB 040
809 #define GET_SHA1_ONLY_TO_DIE 04000
811 extern int get_sha1(const char *str, unsigned char *sha1);
812 extern int get_sha1_commit(const char *str, unsigned char *sha1);
813 extern int get_sha1_committish(const char *str, unsigned char *sha1);
814 extern int get_sha1_tree(const char *str, unsigned char *sha1);
815 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
816 extern int get_sha1_blob(const char *str, unsigned char *sha1);
817 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
818 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
820 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
821 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
824 * Try to read a SHA1 in hexadecimal format from the 40 characters
825 * starting at hex. Write the 20-byte result to sha1 in binary form.
826 * Return 0 on success. Reading stops if a NUL is encountered in the
827 * input, so it is safe to pass this function an arbitrary
828 * null-terminated string.
830 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
832 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
833 extern int read_ref_full(const char *refname, unsigned char *sha1,
834 int reading, int *flags);
835 extern int read_ref(const char *refname, unsigned char *sha1);
838 * Resolve a reference, recursively following symbolic refererences.
840 * Store the referred-to object's name in sha1 and return the name of
841 * the non-symbolic reference that ultimately pointed at it. The
842 * return value, if not NULL, is a pointer into either a static buffer
843 * or the input ref.
845 * If the reference cannot be resolved to an object, the behavior
846 * depends on the "reading" argument:
848 * - If reading is set, return NULL.
850 * - If reading is not set, clear sha1 and return the name of the last
851 * reference name in the chain, which will either be a non-symbolic
852 * reference or an undefined reference. If this is a prelude to
853 * "writing" to the ref, the return value is the name of the ref
854 * that will actually be created or changed.
856 * If flag is non-NULL, set the value that it points to the
857 * combination of REF_ISPACKED (if the reference was found among the
858 * packed references) and REF_ISSYMREF (if the initial reference was a
859 * symbolic reference).
861 * If ref is not a properly-formatted, normalized reference, return
862 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
863 * give up and return NULL.
865 * errno is sometimes set on errors, but not always.
867 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
868 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
870 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
871 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
872 extern int interpret_branch_name(const char *str, struct strbuf *);
873 extern int get_sha1_mb(const char *str, unsigned char *sha1);
875 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
876 extern const char *ref_rev_parse_rules[];
877 #define ref_fetch_rules ref_rev_parse_rules
879 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
880 extern int validate_headref(const char *ref);
882 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
883 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
884 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
885 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
887 extern void *read_object_with_reference(const unsigned char *sha1,
888 const char *required_type,
889 unsigned long *size,
890 unsigned char *sha1_ret);
892 extern struct object *peel_to_type(const char *name, int namelen,
893 struct object *o, enum object_type);
895 enum date_mode {
896 DATE_NORMAL = 0,
897 DATE_RELATIVE,
898 DATE_SHORT,
899 DATE_LOCAL,
900 DATE_ISO8601,
901 DATE_RFC2822,
902 DATE_RAW
905 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
906 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
907 struct strbuf *timebuf);
908 int parse_date(const char *date, char *buf, int bufsize);
909 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
910 void datestamp(char *buf, int bufsize);
911 #define approxidate(s) approxidate_careful((s), NULL)
912 unsigned long approxidate_careful(const char *, int *);
913 unsigned long approxidate_relative(const char *date, const struct timeval *now);
914 enum date_mode parse_date_format(const char *format);
916 #define IDENT_STRICT 1
917 #define IDENT_NO_DATE 2
918 #define IDENT_NO_NAME 4
919 extern const char *git_author_info(int);
920 extern const char *git_committer_info(int);
921 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
922 extern const char *fmt_name(const char *name, const char *email);
923 extern const char *ident_default_email(void);
924 extern const char *git_editor(void);
925 extern const char *git_pager(int stdout_is_tty);
926 extern int git_ident_config(const char *, const char *, void *);
928 struct ident_split {
929 const char *name_begin;
930 const char *name_end;
931 const char *mail_begin;
932 const char *mail_end;
933 const char *date_begin;
934 const char *date_end;
935 const char *tz_begin;
936 const char *tz_end;
939 * Signals an success with 0, but time part of the result may be NULL
940 * if the input lacks timestamp and zone
942 extern int split_ident_line(struct ident_split *, const char *, int);
944 struct checkout {
945 const char *base_dir;
946 int base_dir_len;
947 unsigned force:1,
948 quiet:1,
949 not_new:1,
950 refresh_cache:1;
953 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
955 struct cache_def {
956 char path[PATH_MAX + 1];
957 int len;
958 int flags;
959 int track_flags;
960 int prefix_len_stat_func;
963 extern int has_symlink_leading_path(const char *name, int len);
964 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
965 extern int check_leading_path(const char *name, int len);
966 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
967 extern void schedule_dir_for_removal(const char *name, int len);
968 extern void remove_scheduled_dirs(void);
970 extern struct alternate_object_database {
971 struct alternate_object_database *next;
972 char *name;
973 char base[FLEX_ARRAY]; /* more */
974 } *alt_odb_list;
975 extern void prepare_alt_odb(void);
976 extern void read_info_alternates(const char * relative_base, int depth);
977 extern void add_to_alternates_file(const char *reference);
978 typedef int alt_odb_fn(struct alternate_object_database *, void *);
979 extern void foreach_alt_odb(alt_odb_fn, void*);
981 struct pack_window {
982 struct pack_window *next;
983 unsigned char *base;
984 off_t offset;
985 size_t len;
986 unsigned int last_used;
987 unsigned int inuse_cnt;
990 extern struct packed_git {
991 struct packed_git *next;
992 struct pack_window *windows;
993 off_t pack_size;
994 const void *index_data;
995 size_t index_size;
996 uint32_t num_objects;
997 uint32_t num_bad_objects;
998 unsigned char *bad_object_sha1;
999 int index_version;
1000 time_t mtime;
1001 int pack_fd;
1002 unsigned pack_local:1,
1003 pack_keep:1,
1004 do_not_close:1;
1005 unsigned char sha1[20];
1006 /* something like ".git/objects/pack/xxxxx.pack" */
1007 char pack_name[FLEX_ARRAY]; /* more */
1008 } *packed_git;
1010 struct pack_entry {
1011 off_t offset;
1012 unsigned char sha1[20];
1013 struct packed_git *p;
1016 struct ref {
1017 struct ref *next;
1018 unsigned char old_sha1[20];
1019 unsigned char new_sha1[20];
1020 char *symref;
1021 unsigned int
1022 force:1,
1023 forced_update:1,
1024 merge:1,
1025 deletion:1,
1026 matched:1;
1027 enum {
1028 REF_STATUS_NONE = 0,
1029 REF_STATUS_OK,
1030 REF_STATUS_REJECT_NONFASTFORWARD,
1031 REF_STATUS_REJECT_ALREADY_EXISTS,
1032 REF_STATUS_REJECT_NODELETE,
1033 REF_STATUS_REJECT_FETCH_FIRST,
1034 REF_STATUS_REJECT_NEEDS_FORCE,
1035 REF_STATUS_UPTODATE,
1036 REF_STATUS_REMOTE_REJECT,
1037 REF_STATUS_EXPECTING_REPORT
1038 } status;
1039 char *remote_status;
1040 struct ref *peer_ref; /* when renaming */
1041 char name[FLEX_ARRAY]; /* more */
1044 #define REF_NORMAL (1u << 0)
1045 #define REF_HEADS (1u << 1)
1046 #define REF_TAGS (1u << 2)
1048 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1050 #define CONNECT_VERBOSE (1u << 0)
1051 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1052 extern int finish_connect(struct child_process *conn);
1053 extern int git_connection_is_socket(struct child_process *conn);
1054 struct extra_have_objects {
1055 int nr, alloc;
1056 unsigned char (*array)[20];
1058 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
1059 struct ref **list, unsigned int flags,
1060 struct extra_have_objects *);
1061 extern int server_supports(const char *feature);
1062 extern int parse_feature_request(const char *features, const char *feature);
1063 extern const char *server_feature_value(const char *feature, int *len_ret);
1064 extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1066 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1068 /* A hook for count-objects to report invalid files in pack directory */
1069 extern void (*report_garbage)(const char *desc, const char *path);
1071 extern void prepare_packed_git(void);
1072 extern void reprepare_packed_git(void);
1073 extern void install_packed_git(struct packed_git *pack);
1075 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1076 struct packed_git *packs);
1078 extern void pack_report(void);
1079 extern int open_pack_index(struct packed_git *);
1080 extern void close_pack_index(struct packed_git *);
1081 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1082 extern void close_pack_windows(struct packed_git *);
1083 extern void unuse_pack(struct pack_window **);
1084 extern void free_pack_by_name(const char *);
1085 extern void clear_delta_base_cache(void);
1086 extern struct packed_git *add_packed_git(const char *, int, int);
1087 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1088 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1089 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1090 extern int is_pack_valid(struct packed_git *);
1091 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1092 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1093 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1094 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1096 struct object_info {
1097 /* Request */
1098 unsigned long *sizep;
1100 /* Response */
1101 enum {
1102 OI_CACHED,
1103 OI_LOOSE,
1104 OI_PACKED,
1105 OI_DBCACHED
1106 } whence;
1107 union {
1109 * struct {
1110 * ... Nothing to expose in this case
1111 * } cached;
1112 * struct {
1113 * ... Nothing to expose in this case
1114 * } loose;
1116 struct {
1117 struct packed_git *pack;
1118 off_t offset;
1119 unsigned int is_delta;
1120 } packed;
1121 } u;
1123 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1125 /* Dumb servers support */
1126 extern int update_server_info(int);
1128 /* git_config_parse_key() returns these negated: */
1129 #define CONFIG_INVALID_KEY 1
1130 #define CONFIG_NO_SECTION_OR_NAME 2
1131 /* git_config_set(), git_config_set_multivar() return the above or these: */
1132 #define CONFIG_NO_LOCK -1
1133 #define CONFIG_INVALID_FILE 3
1134 #define CONFIG_NO_WRITE 4
1135 #define CONFIG_NOTHING_SET 5
1136 #define CONFIG_INVALID_PATTERN 6
1137 #define CONFIG_GENERIC_ERROR 7
1139 typedef int (*config_fn_t)(const char *, const char *, void *);
1140 extern int git_default_config(const char *, const char *, void *);
1141 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1142 extern void git_config_push_parameter(const char *text);
1143 extern int git_config_from_parameters(config_fn_t fn, void *data);
1144 extern int git_config(config_fn_t fn, void *);
1145 extern int git_config_with_options(config_fn_t fn, void *,
1146 const char *filename, int respect_includes);
1147 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1148 extern int git_parse_ulong(const char *, unsigned long *);
1149 extern int git_config_int(const char *, const char *);
1150 extern unsigned long git_config_ulong(const char *, const char *);
1151 extern int git_config_bool_or_int(const char *, const char *, int *);
1152 extern int git_config_bool(const char *, const char *);
1153 extern int git_config_maybe_bool(const char *, const char *);
1154 extern int git_config_string(const char **, const char *, const char *);
1155 extern int git_config_pathname(const char **, const char *, const char *);
1156 extern int git_config_set_in_file(const char *, const char *, const char *);
1157 extern int git_config_set(const char *, const char *);
1158 extern int git_config_parse_key(const char *, char **, int *);
1159 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1160 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1161 extern int git_config_rename_section(const char *, const char *);
1162 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1163 extern const char *git_etc_gitconfig(void);
1164 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1165 extern int git_env_bool(const char *, int);
1166 extern int git_config_system(void);
1167 extern int config_error_nonbool(const char *);
1168 #if defined(__GNUC__) && ! defined(__clang__)
1169 #define config_error_nonbool(s) (config_error_nonbool(s), -1)
1170 #endif
1171 extern const char *get_log_output_encoding(void);
1172 extern const char *get_commit_output_encoding(void);
1174 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1176 struct config_include_data {
1177 int depth;
1178 config_fn_t fn;
1179 void *data;
1181 #define CONFIG_INCLUDE_INIT { 0 }
1182 extern int git_config_include(const char *name, const char *value, void *data);
1185 * Match and parse a config key of the form:
1187 * section.(subsection.)?key
1189 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1190 * we return -1 if it does not match, 0 otherwise. The subsection and key
1191 * out-parameters are filled by the function (and subsection is NULL if it is
1192 * missing).
1194 extern int parse_config_key(const char *var,
1195 const char *section,
1196 const char **subsection, int *subsection_len,
1197 const char **key);
1199 extern int committer_ident_sufficiently_given(void);
1200 extern int author_ident_sufficiently_given(void);
1202 extern const char *git_commit_encoding;
1203 extern const char *git_log_output_encoding;
1204 extern const char *git_mailmap_file;
1205 extern const char *git_mailmap_blob;
1207 /* IO helper functions */
1208 extern void maybe_flush_or_die(FILE *, const char *);
1209 extern int copy_fd(int ifd, int ofd);
1210 extern int copy_file(const char *dst, const char *src, int mode);
1211 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1212 extern void write_or_die(int fd, const void *buf, size_t count);
1213 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1214 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1215 extern void fsync_or_die(int fd, const char *);
1217 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1218 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1219 static inline ssize_t write_str_in_full(int fd, const char *str)
1221 return write_in_full(fd, str, strlen(str));
1224 /* pager.c */
1225 extern void setup_pager(void);
1226 extern const char *pager_program;
1227 extern int pager_in_use(void);
1228 extern int pager_use_color;
1229 extern int term_columns(void);
1230 extern int decimal_width(int);
1231 extern int check_pager_config(const char *cmd);
1233 extern const char *editor_program;
1234 extern const char *askpass_program;
1235 extern const char *excludes_file;
1237 /* base85 */
1238 int decode_85(char *dst, const char *line, int linelen);
1239 void encode_85(char *buf, const unsigned char *data, int bytes);
1241 /* alloc.c */
1242 extern void *alloc_blob_node(void);
1243 extern void *alloc_tree_node(void);
1244 extern void *alloc_commit_node(void);
1245 extern void *alloc_tag_node(void);
1246 extern void *alloc_object_node(void);
1247 extern void alloc_report(void);
1249 /* trace.c */
1250 __attribute__((format (printf, 1, 2)))
1251 extern void trace_printf(const char *format, ...);
1252 __attribute__((format (printf, 2, 3)))
1253 extern void trace_argv_printf(const char **argv, const char *format, ...);
1254 extern void trace_repo_setup(const char *prefix);
1255 extern int trace_want(const char *key);
1256 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1258 void packet_trace_identity(const char *prog);
1260 /* add */
1262 * return 0 if success, 1 - if addition of a file failed and
1263 * ADD_FILES_IGNORE_ERRORS was specified in flags
1265 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1267 /* diff.c */
1268 extern int diff_auto_refresh_index;
1270 /* match-trees.c */
1271 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1272 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1275 * whitespace rules.
1276 * used by both diff and apply
1277 * last two digits are tab width
1279 #define WS_BLANK_AT_EOL 0100
1280 #define WS_SPACE_BEFORE_TAB 0200
1281 #define WS_INDENT_WITH_NON_TAB 0400
1282 #define WS_CR_AT_EOL 01000
1283 #define WS_BLANK_AT_EOF 02000
1284 #define WS_TAB_IN_INDENT 04000
1285 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1286 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1287 #define WS_TAB_WIDTH_MASK 077
1288 extern unsigned whitespace_rule_cfg;
1289 extern unsigned whitespace_rule(const char *);
1290 extern unsigned parse_whitespace_rule(const char *);
1291 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1292 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1293 extern char *whitespace_error_string(unsigned ws);
1294 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1295 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1296 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1298 /* ls-files */
1299 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1300 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1302 char *alias_lookup(const char *alias);
1303 int split_cmdline(char *cmdline, const char ***argv);
1304 /* Takes a negative value returned by split_cmdline */
1305 const char *split_cmdline_strerror(int cmdline_errno);
1307 /* git.c */
1308 struct startup_info {
1309 int have_repository;
1310 const char *prefix;
1312 extern struct startup_info *startup_info;
1314 /* merge.c */
1315 struct commit_list;
1316 int try_merge_command(const char *strategy, size_t xopts_nr,
1317 const char **xopts, struct commit_list *common,
1318 const char *head_arg, struct commit_list *remotes);
1319 int checkout_fast_forward(const unsigned char *from,
1320 const unsigned char *to,
1321 int overwrite_ignore);
1324 int sane_execvp(const char *file, char *const argv[]);
1326 #endif /* CACHE_H */