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