Code

commit-tree: teach -m/-F options to read logs from elsewhere
[git.git] / cache.h
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_end(git_zstream *);
38 int git_deflate_end_gently(git_zstream *);
39 int git_deflate(git_zstream *, int flush);
40 unsigned long git_deflate_bound(git_zstream *, unsigned long);
42 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
43 #define DTYPE(de)       ((de)->d_type)
44 #else
45 #undef DT_UNKNOWN
46 #undef DT_DIR
47 #undef DT_REG
48 #undef DT_LNK
49 #define DT_UNKNOWN      0
50 #define DT_DIR          1
51 #define DT_REG          2
52 #define DT_LNK          3
53 #define DTYPE(de)       DT_UNKNOWN
54 #endif
56 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
57 #define S_IFINVALID     0030000
59 /*
60  * A "directory link" is a link to another git directory.
61  *
62  * The value 0160000 is not normally a valid mode, and
63  * also just happens to be S_IFDIR + S_IFLNK
64  *
65  * NOTE! We *really* shouldn't depend on the S_IFxxx macros
66  * always having the same values everywhere. We should use
67  * our internal git values for these things, and then we can
68  * translate that to the OS-specific value. It just so
69  * happens that everybody shares the same bit representation
70  * in the UNIX world (and apparently wider too..)
71  */
72 #define S_IFGITLINK     0160000
73 #define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
75 /*
76  * Intensive research over the course of many years has shown that
77  * port 9418 is totally unused by anything else. Or
78  *
79  *      Your search - "port 9418" - did not match any documents.
80  *
81  * as www.google.com puts it.
82  *
83  * This port has been properly assigned for git use by IANA:
84  * git (Assigned-9418) [I06-050728-0001].
85  *
86  *      git  9418/tcp   git pack transfer service
87  *      git  9418/udp   git pack transfer service
88  *
89  * with Linus Torvalds <torvalds@osdl.org> as the point of
90  * contact. September 2005.
91  *
92  * See http://www.iana.org/assignments/port-numbers
93  */
94 #define DEFAULT_GIT_PORT 9418
96 /*
97  * Basic data structures for the directory cache
98  */
100 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
101 struct cache_header {
102         unsigned int hdr_signature;
103         unsigned int hdr_version;
104         unsigned int hdr_entries;
105 };
107 /*
108  * The "cache_time" is just the low 32 bits of the
109  * time. It doesn't matter if it overflows - we only
110  * check it for equality in the 32 bits we save.
111  */
112 struct cache_time {
113         unsigned int sec;
114         unsigned int nsec;
115 };
117 /*
118  * dev/ino/uid/gid/size are also just tracked to the low 32 bits
119  * Again - this is just a (very strong in practice) heuristic that
120  * the inode hasn't changed.
121  *
122  * We save the fields in big-endian order to allow using the
123  * index file over NFS transparently.
124  */
125 struct ondisk_cache_entry {
126         struct cache_time ctime;
127         struct cache_time mtime;
128         unsigned int dev;
129         unsigned int ino;
130         unsigned int mode;
131         unsigned int uid;
132         unsigned int gid;
133         unsigned int size;
134         unsigned char sha1[20];
135         unsigned short flags;
136         char name[FLEX_ARRAY]; /* more */
137 };
139 /*
140  * This struct is used when CE_EXTENDED bit is 1
141  * The struct must match ondisk_cache_entry exactly from
142  * ctime till flags
143  */
144 struct ondisk_cache_entry_extended {
145         struct cache_time ctime;
146         struct cache_time mtime;
147         unsigned int dev;
148         unsigned int ino;
149         unsigned int mode;
150         unsigned int uid;
151         unsigned int gid;
152         unsigned int size;
153         unsigned char sha1[20];
154         unsigned short flags;
155         unsigned short flags2;
156         char name[FLEX_ARRAY]; /* more */
157 };
159 struct cache_entry {
160         struct cache_time ce_ctime;
161         struct cache_time ce_mtime;
162         unsigned int ce_dev;
163         unsigned int ce_ino;
164         unsigned int ce_mode;
165         unsigned int ce_uid;
166         unsigned int ce_gid;
167         unsigned int ce_size;
168         unsigned int ce_flags;
169         unsigned char sha1[20];
170         struct cache_entry *next;
171         struct cache_entry *dir_next;
172         char name[FLEX_ARRAY]; /* more */
173 };
175 #define CE_NAMEMASK  (0x0fff)
176 #define CE_STAGEMASK (0x3000)
177 #define CE_EXTENDED  (0x4000)
178 #define CE_VALID     (0x8000)
179 #define CE_STAGESHIFT 12
181 /*
182  * Range 0xFFFF0000 in ce_flags is divided into
183  * two parts: in-memory flags and on-disk ones.
184  * Flags in CE_EXTENDED_FLAGS will get saved on-disk
185  * if you want to save a new flag, add it in
186  * CE_EXTENDED_FLAGS
187  *
188  * In-memory only flags
189  */
190 #define CE_UPDATE            (1 << 16)
191 #define CE_REMOVE            (1 << 17)
192 #define CE_UPTODATE          (1 << 18)
193 #define CE_ADDED             (1 << 19)
195 #define CE_HASHED            (1 << 20)
196 #define CE_UNHASHED          (1 << 21)
197 #define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
198 #define CE_CONFLICTED        (1 << 23)
200 #define CE_UNPACKED          (1 << 24)
201 #define CE_NEW_SKIP_WORKTREE (1 << 25)
203 /*
204  * Extended on-disk flags
205  */
206 #define CE_INTENT_TO_ADD     (1 << 29)
207 #define CE_SKIP_WORKTREE     (1 << 30)
208 /* CE_EXTENDED2 is for future extension */
209 #define CE_EXTENDED2         (1 << 31)
211 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
213 /*
214  * Safeguard to avoid saving wrong flags:
215  *  - CE_EXTENDED2 won't get saved until its semantic is known
216  *  - Bits in 0x0000FFFF have been saved in ce_flags already
217  *  - Bits in 0x003F0000 are currently in-memory flags
218  */
219 #if CE_EXTENDED_FLAGS & 0x803FFFFF
220 #error "CE_EXTENDED_FLAGS out of range"
221 #endif
223 /*
224  * Copy the sha1 and stat state of a cache entry from one to
225  * another. But we never change the name, or the hash state!
226  */
227 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
228 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
230         unsigned int state = dst->ce_flags & CE_STATE_MASK;
232         /* Don't copy hash chain and name */
233         memcpy(dst, src, offsetof(struct cache_entry, next));
235         /* Restore the hash state */
236         dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
239 static inline unsigned create_ce_flags(size_t len, unsigned stage)
241         if (len >= CE_NAMEMASK)
242                 len = CE_NAMEMASK;
243         return (len | (stage << CE_STAGESHIFT));
246 static inline size_t ce_namelen(const struct cache_entry *ce)
248         size_t len = ce->ce_flags & CE_NAMEMASK;
249         if (len < CE_NAMEMASK)
250                 return len;
251         return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
254 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
255 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
256                             ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
257                             ondisk_cache_entry_size(ce_namelen(ce)))
258 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
259 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
260 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
261 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
263 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
264 static inline unsigned int create_ce_mode(unsigned int mode)
266         if (S_ISLNK(mode))
267                 return S_IFLNK;
268         if (S_ISDIR(mode) || S_ISGITLINK(mode))
269                 return S_IFGITLINK;
270         return S_IFREG | ce_permissions(mode);
272 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
274         extern int trust_executable_bit, has_symlinks;
275         if (!has_symlinks && S_ISREG(mode) &&
276             ce && S_ISLNK(ce->ce_mode))
277                 return ce->ce_mode;
278         if (!trust_executable_bit && S_ISREG(mode)) {
279                 if (ce && S_ISREG(ce->ce_mode))
280                         return ce->ce_mode;
281                 return create_ce_mode(0666);
282         }
283         return create_ce_mode(mode);
285 static inline int ce_to_dtype(const struct cache_entry *ce)
287         unsigned ce_mode = ntohl(ce->ce_mode);
288         if (S_ISREG(ce_mode))
289                 return DT_REG;
290         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
291                 return DT_DIR;
292         else if (S_ISLNK(ce_mode))
293                 return DT_LNK;
294         else
295                 return DT_UNKNOWN;
297 static inline unsigned int canon_mode(unsigned int mode)
299         if (S_ISREG(mode))
300                 return S_IFREG | ce_permissions(mode);
301         if (S_ISLNK(mode))
302                 return S_IFLNK;
303         if (S_ISDIR(mode))
304                 return S_IFDIR;
305         return S_IFGITLINK;
308 #define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
309 #define cache_entry_size(len) flexible_size(cache_entry,len)
310 #define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
311 #define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
313 struct index_state {
314         struct cache_entry **cache;
315         unsigned int cache_nr, cache_alloc, cache_changed;
316         struct string_list *resolve_undo;
317         struct cache_tree *cache_tree;
318         struct cache_time timestamp;
319         void *alloc;
320         unsigned name_hash_initialized : 1,
321                  initialized : 1;
322         struct hash_table name_hash;
323 };
325 extern struct index_state the_index;
327 /* Name hashing */
328 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
329 /*
330  * We don't actually *remove* it, we can just mark it invalid so that
331  * we won't find it in lookups.
332  *
333  * Not only would we have to search the lists (simple enough), but
334  * we'd also have to rehash other hash buckets in case this makes the
335  * hash bucket empty (common). So it's much better to just mark
336  * it.
337  */
338 static inline void remove_name_hash(struct cache_entry *ce)
340         ce->ce_flags |= CE_UNHASHED;
344 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
345 #define active_cache (the_index.cache)
346 #define active_nr (the_index.cache_nr)
347 #define active_alloc (the_index.cache_alloc)
348 #define active_cache_changed (the_index.cache_changed)
349 #define active_cache_tree (the_index.cache_tree)
351 #define read_cache() read_index(&the_index)
352 #define read_cache_from(path) read_index_from(&the_index, (path))
353 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
354 #define is_cache_unborn() is_index_unborn(&the_index)
355 #define read_cache_unmerged() read_index_unmerged(&the_index)
356 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
357 #define discard_cache() discard_index(&the_index)
358 #define unmerged_cache() unmerged_index(&the_index)
359 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
360 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
361 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
362 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
363 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
364 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
365 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
366 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
367 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
368 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
369 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
370 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
371 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
372 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
373 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
374 #endif
376 enum object_type {
377         OBJ_BAD = -1,
378         OBJ_NONE = 0,
379         OBJ_COMMIT = 1,
380         OBJ_TREE = 2,
381         OBJ_BLOB = 3,
382         OBJ_TAG = 4,
383         /* 5 for future expansion */
384         OBJ_OFS_DELTA = 6,
385         OBJ_REF_DELTA = 7,
386         OBJ_ANY,
387         OBJ_MAX
388 };
390 static inline enum object_type object_type(unsigned int mode)
392         return S_ISDIR(mode) ? OBJ_TREE :
393                 S_ISGITLINK(mode) ? OBJ_COMMIT :
394                 OBJ_BLOB;
397 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
398 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
399 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
400 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
401 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
402 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
403 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
404 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
405 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
406 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
407 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
408 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
409 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
410 #define GITATTRIBUTES_FILE ".gitattributes"
411 #define INFOATTRIBUTES_FILE "info/attributes"
412 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
413 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
414 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
415 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
416 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
417 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
419 /*
420  * Repository-local GIT_* environment variables
421  * The array is NULL-terminated to simplify its usage in contexts such
422  * environment creation or simple walk of the list.
423  * The number of non-NULL entries is available as a macro.
424  */
425 #define LOCAL_REPO_ENV_SIZE 9
426 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
428 extern int is_bare_repository_cfg;
429 extern int is_bare_repository(void);
430 extern int is_inside_git_dir(void);
431 extern char *git_work_tree_cfg;
432 extern int is_inside_work_tree(void);
433 extern int have_git_dir(void);
434 extern const char *get_git_dir(void);
435 extern char *get_object_directory(void);
436 extern char *get_index_file(void);
437 extern char *get_graft_file(void);
438 extern int set_git_dir(const char *path);
439 extern const char *get_git_namespace(void);
440 extern const char *strip_namespace(const char *namespaced_ref);
441 extern const char *get_git_work_tree(void);
442 extern const char *read_gitfile(const char *path);
443 extern const char *resolve_gitdir(const char *suspect);
444 extern void set_git_work_tree(const char *tree);
446 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
448 extern const char **get_pathspec(const char *prefix, const char **pathspec);
449 extern void setup_work_tree(void);
450 extern const char *setup_git_directory_gently(int *);
451 extern const char *setup_git_directory(void);
452 extern char *prefix_path(const char *prefix, int len, const char *path);
453 extern const char *prefix_filename(const char *prefix, int len, const char *path);
454 extern int check_filename(const char *prefix, const char *name);
455 extern void verify_filename(const char *prefix, const char *name);
456 extern void verify_non_filename(const char *prefix, const char *name);
458 #define INIT_DB_QUIET 0x0001
460 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
461 extern int init_db(const char *template_dir, unsigned int flags);
463 #define alloc_nr(x) (((x)+16)*3/2)
465 /*
466  * Realloc the buffer pointed at by variable 'x' so that it can hold
467  * at least 'nr' entries; the number of entries currently allocated
468  * is 'alloc', using the standard growing factor alloc_nr() macro.
469  *
470  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
471  */
472 #define ALLOC_GROW(x, nr, alloc) \
473         do { \
474                 if ((nr) > alloc) { \
475                         if (alloc_nr(alloc) < (nr)) \
476                                 alloc = (nr); \
477                         else \
478                                 alloc = alloc_nr(alloc); \
479                         x = xrealloc((x), alloc * sizeof(*(x))); \
480                 } \
481         } while (0)
483 /* Initialize and use the cache information */
484 extern int read_index(struct index_state *);
485 extern int read_index_preload(struct index_state *, const char **pathspec);
486 extern int read_index_from(struct index_state *, const char *path);
487 extern int is_index_unborn(struct index_state *);
488 extern int read_index_unmerged(struct index_state *);
489 extern int write_index(struct index_state *, int newfd);
490 extern int discard_index(struct index_state *);
491 extern int unmerged_index(const struct index_state *);
492 extern int verify_path(const char *path);
493 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
494 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
495 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
496 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
497 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
498 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
499 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
500 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
501 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
502 extern int remove_index_entry_at(struct index_state *, int pos);
503 extern void remove_marked_cache_entries(struct index_state *istate);
504 extern int remove_file_from_index(struct index_state *, const char *path);
505 #define ADD_CACHE_VERBOSE 1
506 #define ADD_CACHE_PRETEND 2
507 #define ADD_CACHE_IGNORE_ERRORS 4
508 #define ADD_CACHE_IGNORE_REMOVAL 8
509 #define ADD_CACHE_INTENT 16
510 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
511 extern int add_file_to_index(struct index_state *, const char *path, int flags);
512 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
513 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
514 extern int index_name_is_other(const struct index_state *, const char *, int);
516 /* do stat comparison even if CE_VALID is true */
517 #define CE_MATCH_IGNORE_VALID           01
518 /* do not check the contents but report dirty on racily-clean entries */
519 #define CE_MATCH_RACY_IS_DIRTY          02
520 /* do stat comparison even if CE_SKIP_WORKTREE is true */
521 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
522 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
523 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
525 struct pathspec {
526         const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
527         int nr;
528         unsigned int has_wildcard:1;
529         unsigned int recursive:1;
530         int max_depth;
531         struct pathspec_item {
532                 const char *match;
533                 int len;
534                 unsigned int use_wildcard:1;
535         } *items;
536 };
538 extern int init_pathspec(struct pathspec *, const char **);
539 extern void free_pathspec(struct pathspec *);
540 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
542 #define HASH_WRITE_OBJECT 1
543 #define HASH_FORMAT_CHECK 2
544 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
545 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
546 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
548 #define REFRESH_REALLY          0x0001  /* ignore_valid */
549 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
550 #define REFRESH_QUIET           0x0004  /* be quiet about it */
551 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
552 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
553 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
554 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
556 struct lock_file {
557         struct lock_file *next;
558         int fd;
559         pid_t owner;
560         char on_list;
561         char filename[PATH_MAX];
562 };
563 #define LOCK_DIE_ON_ERROR 1
564 #define LOCK_NODEREF 2
565 extern int unable_to_lock_error(const char *path, int err);
566 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
567 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
568 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
569 extern int commit_lock_file(struct lock_file *);
570 extern void update_index_if_able(struct index_state *, struct lock_file *);
572 extern int hold_locked_index(struct lock_file *, int);
573 extern int commit_locked_index(struct lock_file *);
574 extern void set_alternate_index_output(const char *);
575 extern int close_lock_file(struct lock_file *);
576 extern void rollback_lock_file(struct lock_file *);
577 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
579 /* Environment bits from configuration mechanism */
580 extern int trust_executable_bit;
581 extern int trust_ctime;
582 extern int quote_path_fully;
583 extern int has_symlinks;
584 extern int minimum_abbrev, default_abbrev;
585 extern int ignore_case;
586 extern int assume_unchanged;
587 extern int prefer_symlink_refs;
588 extern int log_all_ref_updates;
589 extern int warn_ambiguous_refs;
590 extern int shared_repository;
591 extern const char *apply_default_whitespace;
592 extern const char *apply_default_ignorewhitespace;
593 extern const char *git_attributes_file;
594 extern int zlib_compression_level;
595 extern int core_compression_level;
596 extern int core_compression_seen;
597 extern size_t packed_git_window_size;
598 extern size_t packed_git_limit;
599 extern size_t delta_base_cache_limit;
600 extern unsigned long big_file_threshold;
601 extern int read_replace_refs;
602 extern int fsync_object_files;
603 extern int core_preload_index;
604 extern int core_apply_sparse_checkout;
606 enum branch_track {
607         BRANCH_TRACK_UNSPECIFIED = -1,
608         BRANCH_TRACK_NEVER = 0,
609         BRANCH_TRACK_REMOTE,
610         BRANCH_TRACK_ALWAYS,
611         BRANCH_TRACK_EXPLICIT,
612         BRANCH_TRACK_OVERRIDE
613 };
615 enum rebase_setup_type {
616         AUTOREBASE_NEVER = 0,
617         AUTOREBASE_LOCAL,
618         AUTOREBASE_REMOTE,
619         AUTOREBASE_ALWAYS
620 };
622 enum push_default_type {
623         PUSH_DEFAULT_NOTHING = 0,
624         PUSH_DEFAULT_MATCHING,
625         PUSH_DEFAULT_UPSTREAM,
626         PUSH_DEFAULT_CURRENT
627 };
629 extern enum branch_track git_branch_track;
630 extern enum rebase_setup_type autorebase;
631 extern enum push_default_type push_default;
633 enum object_creation_mode {
634         OBJECT_CREATION_USES_HARDLINKS = 0,
635         OBJECT_CREATION_USES_RENAMES = 1
636 };
638 extern enum object_creation_mode object_creation_mode;
640 extern char *notes_ref_name;
642 extern int grafts_replace_parents;
644 #define GIT_REPO_VERSION 0
645 extern int repository_format_version;
646 extern int check_repository_format(void);
648 #define MTIME_CHANGED   0x0001
649 #define CTIME_CHANGED   0x0002
650 #define OWNER_CHANGED   0x0004
651 #define MODE_CHANGED    0x0008
652 #define INODE_CHANGED   0x0010
653 #define DATA_CHANGED    0x0020
654 #define TYPE_CHANGED    0x0040
656 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
657         __attribute__((format (printf, 3, 4)));
658 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
659         __attribute__((format (printf, 3, 4)));
660 extern char *git_pathdup(const char *fmt, ...)
661         __attribute__((format (printf, 1, 2)));
663 /* Return a statically allocated filename matching the sha1 signature */
664 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
665 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
666 extern char *git_path_submodule(const char *path, const char *fmt, ...)
667         __attribute__((format (printf, 2, 3)));
669 extern char *sha1_file_name(const unsigned char *sha1);
670 extern char *sha1_pack_name(const unsigned char *sha1);
671 extern char *sha1_pack_index_name(const unsigned char *sha1);
672 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
673 extern const unsigned char null_sha1[20];
675 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
677         int i;
679         for (i = 0; i < 20; i++, sha1++, sha2++) {
680                 if (*sha1 != *sha2)
681                         return *sha1 - *sha2;
682         }
684         return 0;
687 static inline int is_null_sha1(const unsigned char *sha1)
689         return !hashcmp(sha1, null_sha1);
692 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
694         memcpy(sha_dst, sha_src, 20);
696 static inline void hashclr(unsigned char *hash)
698         memset(hash, 0, 20);
701 #define EMPTY_TREE_SHA1_HEX \
702         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
703 #define EMPTY_TREE_SHA1_BIN_LITERAL \
704          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
705          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
706 #define EMPTY_TREE_SHA1_BIN \
707          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
709 int git_mkstemp(char *path, size_t n, const char *template);
711 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
713 /* set default permissions by passing mode arguments to open(2) */
714 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
715 int git_mkstemp_mode(char *pattern, int mode);
717 /*
718  * NOTE NOTE NOTE!!
719  *
720  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
721  * not be changed. Old repositories have core.sharedrepository written in
722  * numeric format, and therefore these values are preserved for compatibility
723  * reasons.
724  */
725 enum sharedrepo {
726         PERM_UMASK          = 0,
727         OLD_PERM_GROUP      = 1,
728         OLD_PERM_EVERYBODY  = 2,
729         PERM_GROUP          = 0660,
730         PERM_EVERYBODY      = 0664
731 };
732 int git_config_perm(const char *var, const char *value);
733 int set_shared_perm(const char *path, int mode);
734 #define adjust_shared_perm(path) set_shared_perm((path), 0)
735 int safe_create_leading_directories(char *path);
736 int safe_create_leading_directories_const(const char *path);
737 int mkdir_in_gitdir(const char *path);
738 extern char *expand_user_path(const char *path);
739 char *enter_repo(char *path, int strict);
740 static inline int is_absolute_path(const char *path)
742         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
744 int is_directory(const char *);
745 const char *real_path(const char *path);
746 const char *absolute_path(const char *path);
747 const char *relative_path(const char *abs, const char *base);
748 int normalize_path_copy(char *dst, const char *src);
749 int longest_ancestor_length(const char *path, const char *prefix_list);
750 char *strip_path_suffix(const char *path, const char *suffix);
751 int daemon_avoid_alias(const char *path);
752 int offset_1st_component(const char *path);
754 /* object replacement */
755 #define READ_SHA1_FILE_REPLACE 1
756 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
757 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
759         return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
761 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
762 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
764         if (!read_replace_refs)
765                 return sha1;
766         return do_lookup_replace_object(sha1);
769 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
770 extern int sha1_object_info(const unsigned char *, unsigned long *);
771 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
772 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
773 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
774 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
775 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
776 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
777 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
779 /* global flag to enable extra checks when accessing packed objects */
780 extern int do_check_packed_object_crc;
782 /* for development: log offset of pack access */
783 extern const char *log_pack_access;
785 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
787 extern int move_temp_to_file(const char *tmpfile, const char *filename);
789 extern int has_sha1_pack(const unsigned char *sha1);
790 extern int has_sha1_file(const unsigned char *sha1);
791 extern int has_loose_object_nonlocal(const unsigned char *sha1);
793 extern int has_pack_index(const unsigned char *sha1);
795 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
797 extern const signed char hexval_table[256];
798 static inline unsigned int hexval(unsigned char c)
800         return hexval_table[c];
803 /* Convert to/from hex/sha1 representation */
804 #define MINIMUM_ABBREV minimum_abbrev
805 #define DEFAULT_ABBREV default_abbrev
807 struct object_context {
808         unsigned char tree[20];
809         char path[PATH_MAX];
810         unsigned mode;
811 };
813 extern int get_sha1(const char *str, unsigned char *sha1);
814 extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int only_to_die, const char *prefix);
815 static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
817         return get_sha1_with_mode_1(str, sha1, mode, 0, NULL);
819 extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int only_to_die, const char *prefix);
820 static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
822         return get_sha1_with_context_1(str, sha1, orc, 0, NULL);
825 /*
826  * Try to read a SHA1 in hexadecimal format from the 40 characters
827  * starting at hex.  Write the 20-byte result to sha1 in binary form.
828  * Return 0 on success.  Reading stops if a NUL is encountered in the
829  * input, so it is safe to pass this function an arbitrary
830  * null-terminated string.
831  */
832 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
834 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
835 extern int read_ref(const char *filename, unsigned char *sha1);
837 /*
838  * Resolve a reference, recursively following symbolic refererences.
839  *
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.
844  *
845  * If the reference cannot be resolved to an object, the behavior
846  * depends on the "reading" argument:
847  *
848  * - If reading is set, return NULL.
849  *
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.
855  *
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).
860  *
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.
864  *
865  * errno is sometimes set on errors, but not always.
866  */
867 extern const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag);
869 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
870 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
871 extern int interpret_branch_name(const char *str, struct strbuf *);
872 extern int get_sha1_mb(const char *str, unsigned char *sha1);
874 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
875 extern const char *ref_rev_parse_rules[];
876 #define ref_fetch_rules ref_rev_parse_rules
878 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
879 extern int validate_headref(const char *ref);
881 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
882 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
883 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
885 extern void *read_object_with_reference(const unsigned char *sha1,
886                                         const char *required_type,
887                                         unsigned long *size,
888                                         unsigned char *sha1_ret);
890 extern struct object *peel_to_type(const char *name, int namelen,
891                                    struct object *o, enum object_type);
893 enum date_mode {
894         DATE_NORMAL = 0,
895         DATE_RELATIVE,
896         DATE_SHORT,
897         DATE_LOCAL,
898         DATE_ISO8601,
899         DATE_RFC2822,
900         DATE_RAW
901 };
903 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
904 const char *show_date_relative(unsigned long time, int tz,
905                                const struct timeval *now,
906                                char *timebuf,
907                                size_t timebuf_size);
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_WARN_ON_NO_NAME  1
917 #define IDENT_ERROR_ON_NO_NAME 2
918 #define IDENT_NO_DATE          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 *git_editor(void);
924 extern const char *git_pager(int stdout_is_tty);
926 struct checkout {
927         const char *base_dir;
928         int base_dir_len;
929         unsigned force:1,
930                  quiet:1,
931                  not_new:1,
932                  refresh_cache:1;
933 };
935 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
937 struct cache_def {
938         char path[PATH_MAX + 1];
939         int len;
940         int flags;
941         int track_flags;
942         int prefix_len_stat_func;
943 };
945 extern int has_symlink_leading_path(const char *name, int len);
946 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
947 extern int check_leading_path(const char *name, int len);
948 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
949 extern void schedule_dir_for_removal(const char *name, int len);
950 extern void remove_scheduled_dirs(void);
952 extern struct alternate_object_database {
953         struct alternate_object_database *next;
954         char *name;
955         char base[FLEX_ARRAY]; /* more */
956 } *alt_odb_list;
957 extern void prepare_alt_odb(void);
958 extern void add_to_alternates_file(const char *reference);
959 typedef int alt_odb_fn(struct alternate_object_database *, void *);
960 extern void foreach_alt_odb(alt_odb_fn, void*);
962 struct pack_window {
963         struct pack_window *next;
964         unsigned char *base;
965         off_t offset;
966         size_t len;
967         unsigned int last_used;
968         unsigned int inuse_cnt;
969 };
971 extern struct packed_git {
972         struct packed_git *next;
973         struct pack_window *windows;
974         off_t pack_size;
975         const void *index_data;
976         size_t index_size;
977         uint32_t num_objects;
978         uint32_t num_bad_objects;
979         unsigned char *bad_object_sha1;
980         int index_version;
981         time_t mtime;
982         int pack_fd;
983         unsigned pack_local:1,
984                  pack_keep:1,
985                  do_not_close:1;
986         unsigned char sha1[20];
987         /* something like ".git/objects/pack/xxxxx.pack" */
988         char pack_name[FLEX_ARRAY]; /* more */
989 } *packed_git;
991 struct pack_entry {
992         off_t offset;
993         unsigned char sha1[20];
994         struct packed_git *p;
995 };
997 struct ref {
998         struct ref *next;
999         unsigned char old_sha1[20];
1000         unsigned char new_sha1[20];
1001         char *symref;
1002         unsigned int force:1,
1003                 merge:1,
1004                 nonfastforward:1,
1005                 deletion:1;
1006         enum {
1007                 REF_STATUS_NONE = 0,
1008                 REF_STATUS_OK,
1009                 REF_STATUS_REJECT_NONFASTFORWARD,
1010                 REF_STATUS_REJECT_NODELETE,
1011                 REF_STATUS_UPTODATE,
1012                 REF_STATUS_REMOTE_REJECT,
1013                 REF_STATUS_EXPECTING_REPORT
1014         } status;
1015         char *remote_status;
1016         struct ref *peer_ref; /* when renaming */
1017         char name[FLEX_ARRAY]; /* more */
1018 };
1020 #define REF_NORMAL      (1u << 0)
1021 #define REF_HEADS       (1u << 1)
1022 #define REF_TAGS        (1u << 2)
1024 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1026 #define CONNECT_VERBOSE       (1u << 0)
1027 extern char *git_getpass(const char *prompt);
1028 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1029 extern int finish_connect(struct child_process *conn);
1030 extern int git_connection_is_socket(struct child_process *conn);
1031 extern int path_match(const char *path, int nr, char **match);
1032 struct extra_have_objects {
1033         int nr, alloc;
1034         unsigned char (*array)[20];
1035 };
1036 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
1037 extern int server_supports(const char *feature);
1039 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1041 extern void prepare_packed_git(void);
1042 extern void reprepare_packed_git(void);
1043 extern void install_packed_git(struct packed_git *pack);
1045 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1046                                          struct packed_git *packs);
1048 extern void pack_report(void);
1049 extern int open_pack_index(struct packed_git *);
1050 extern void close_pack_index(struct packed_git *);
1051 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1052 extern void close_pack_windows(struct packed_git *);
1053 extern void unuse_pack(struct pack_window **);
1054 extern void free_pack_by_name(const char *);
1055 extern void clear_delta_base_cache(void);
1056 extern struct packed_git *add_packed_git(const char *, int, int);
1057 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1058 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1059 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1060 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1061 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1062 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1063 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1065 struct object_info {
1066         /* Request */
1067         unsigned long *sizep;
1069         /* Response */
1070         enum {
1071                 OI_CACHED,
1072                 OI_LOOSE,
1073                 OI_PACKED,
1074                 OI_DBCACHED
1075         } whence;
1076         union {
1077                 /*
1078                  * struct {
1079                  *      ... Nothing to expose in this case
1080                  * } cached;
1081                  * struct {
1082                  *      ... Nothing to expose in this case
1083                  * } loose;
1084                  */
1085                 struct {
1086                         struct packed_git *pack;
1087                         off_t offset;
1088                         unsigned int is_delta;
1089                 } packed;
1090         } u;
1091 };
1092 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1094 /* Dumb servers support */
1095 extern int update_server_info(int);
1097 /* git_config_parse_key() returns these negated: */
1098 #define CONFIG_INVALID_KEY 1
1099 #define CONFIG_NO_SECTION_OR_NAME 2
1100 /* git_config_set(), git_config_set_multivar() return the above or these: */
1101 #define CONFIG_NO_LOCK -1
1102 #define CONFIG_INVALID_FILE 3
1103 #define CONFIG_NO_WRITE 4
1104 #define CONFIG_NOTHING_SET 5
1105 #define CONFIG_INVALID_PATTERN 6
1107 typedef int (*config_fn_t)(const char *, const char *, void *);
1108 extern int git_default_config(const char *, const char *, void *);
1109 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1110 extern void git_config_push_parameter(const char *text);
1111 extern int git_config_from_parameters(config_fn_t fn, void *data);
1112 extern int git_config(config_fn_t fn, void *);
1113 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1114 extern int git_parse_ulong(const char *, unsigned long *);
1115 extern int git_config_int(const char *, const char *);
1116 extern unsigned long git_config_ulong(const char *, const char *);
1117 extern int git_config_bool_or_int(const char *, const char *, int *);
1118 extern int git_config_bool(const char *, const char *);
1119 extern int git_config_maybe_bool(const char *, const char *);
1120 extern int git_config_string(const char **, const char *, const char *);
1121 extern int git_config_pathname(const char **, const char *, const char *);
1122 extern int git_config_set_in_file(const char *, const char *, const char *);
1123 extern int git_config_set(const char *, const char *);
1124 extern int git_config_parse_key(const char *, char **, int *);
1125 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1126 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1127 extern int git_config_rename_section(const char *, const char *);
1128 extern const char *git_etc_gitconfig(void);
1129 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1130 extern int git_env_bool(const char *, int);
1131 extern int git_config_system(void);
1132 extern int config_error_nonbool(const char *);
1133 extern const char *get_log_output_encoding(void);
1134 extern const char *get_commit_output_encoding(void);
1136 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1138 extern const char *config_exclusive_filename;
1140 #define MAX_GITNAME (1000)
1141 extern char git_default_email[MAX_GITNAME];
1142 extern char git_default_name[MAX_GITNAME];
1143 #define IDENT_NAME_GIVEN 01
1144 #define IDENT_MAIL_GIVEN 02
1145 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1146 extern int user_ident_explicitly_given;
1147 extern int user_ident_sufficiently_given(void);
1149 extern const char *git_commit_encoding;
1150 extern const char *git_log_output_encoding;
1151 extern const char *git_mailmap_file;
1153 /* IO helper functions */
1154 extern void maybe_flush_or_die(FILE *, const char *);
1155 extern int copy_fd(int ifd, int ofd);
1156 extern int copy_file(const char *dst, const char *src, int mode);
1157 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1158 extern void write_or_die(int fd, const void *buf, size_t count);
1159 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1160 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1161 extern void fsync_or_die(int fd, const char *);
1163 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1164 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1165 static inline ssize_t write_str_in_full(int fd, const char *str)
1167         return write_in_full(fd, str, strlen(str));
1170 /* pager.c */
1171 extern void setup_pager(void);
1172 extern const char *pager_program;
1173 extern int pager_in_use(void);
1174 extern int pager_use_color;
1176 extern const char *editor_program;
1177 extern const char *askpass_program;
1178 extern const char *excludes_file;
1180 /* base85 */
1181 int decode_85(char *dst, const char *line, int linelen);
1182 void encode_85(char *buf, const unsigned char *data, int bytes);
1184 /* alloc.c */
1185 extern void *alloc_blob_node(void);
1186 extern void *alloc_tree_node(void);
1187 extern void *alloc_commit_node(void);
1188 extern void *alloc_tag_node(void);
1189 extern void *alloc_object_node(void);
1190 extern void alloc_report(void);
1192 /* trace.c */
1193 __attribute__((format (printf, 1, 2)))
1194 extern void trace_printf(const char *format, ...);
1195 extern void trace_vprintf(const char *key, const char *format, va_list ap);
1196 __attribute__((format (printf, 2, 3)))
1197 extern void trace_argv_printf(const char **argv, const char *format, ...);
1198 extern void trace_repo_setup(const char *prefix);
1199 extern int trace_want(const char *key);
1200 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1202 void packet_trace_identity(const char *prog);
1204 /* add */
1205 /*
1206  * return 0 if success, 1 - if addition of a file failed and
1207  * ADD_FILES_IGNORE_ERRORS was specified in flags
1208  */
1209 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1211 /* diff.c */
1212 extern int diff_auto_refresh_index;
1214 /* match-trees.c */
1215 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1216 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1218 /*
1219  * whitespace rules.
1220  * used by both diff and apply
1221  * last two digits are tab width
1222  */
1223 #define WS_BLANK_AT_EOL         0100
1224 #define WS_SPACE_BEFORE_TAB     0200
1225 #define WS_INDENT_WITH_NON_TAB  0400
1226 #define WS_CR_AT_EOL           01000
1227 #define WS_BLANK_AT_EOF        02000
1228 #define WS_TAB_IN_INDENT       04000
1229 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1230 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1231 #define WS_TAB_WIDTH_MASK        077
1232 extern unsigned whitespace_rule_cfg;
1233 extern unsigned whitespace_rule(const char *);
1234 extern unsigned parse_whitespace_rule(const char *);
1235 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1236 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1237 extern char *whitespace_error_string(unsigned ws);
1238 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1239 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1240 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1242 /* ls-files */
1243 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1244 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1246 char *alias_lookup(const char *alias);
1247 int split_cmdline(char *cmdline, const char ***argv);
1248 /* Takes a negative value returned by split_cmdline */
1249 const char *split_cmdline_strerror(int cmdline_errno);
1251 /* git.c */
1252 struct startup_info {
1253         int have_repository;
1254         const char *prefix;
1255 };
1256 extern struct startup_info *startup_info;
1258 /* builtin/merge.c */
1259 int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1261 #endif /* CACHE_H */