docs: put listed example commands in backticks
[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_end_gently(git_zstream *);
39 int git_deflate(git_zstream *, int flush);
40 unsigned long git_deflate_bound(git_zstream *, unsigned long);
41
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
55
56 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
57 #define S_IFINVALID     0030000
58
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)
74
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
95
96 /*
97  * Basic data structures for the directory cache
98  */
99
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 };
106
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 };
116
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 };
138
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 };
158
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         char name[FLEX_ARRAY]; /* more */
172 };
173
174 #define CE_NAMEMASK  (0x0fff)
175 #define CE_STAGEMASK (0x3000)
176 #define CE_EXTENDED  (0x4000)
177 #define CE_VALID     (0x8000)
178 #define CE_STAGESHIFT 12
179
180 /*
181  * Range 0xFFFF0000 in ce_flags is divided into
182  * two parts: in-memory flags and on-disk ones.
183  * Flags in CE_EXTENDED_FLAGS will get saved on-disk
184  * if you want to save a new flag, add it in
185  * CE_EXTENDED_FLAGS
186  *
187  * In-memory only flags
188  */
189 #define CE_UPDATE            (1 << 16)
190 #define CE_REMOVE            (1 << 17)
191 #define CE_UPTODATE          (1 << 18)
192 #define CE_ADDED             (1 << 19)
193
194 #define CE_HASHED            (1 << 20)
195 #define CE_UNHASHED          (1 << 21)
196 #define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
197 #define CE_CONFLICTED        (1 << 23)
198
199 #define CE_UNPACKED          (1 << 24)
200 #define CE_NEW_SKIP_WORKTREE (1 << 25)
201
202 /*
203  * Extended on-disk flags
204  */
205 #define CE_INTENT_TO_ADD     (1 << 29)
206 #define CE_SKIP_WORKTREE     (1 << 30)
207 /* CE_EXTENDED2 is for future extension */
208 #define CE_EXTENDED2         (1 << 31)
209
210 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
211
212 /*
213  * Safeguard to avoid saving wrong flags:
214  *  - CE_EXTENDED2 won't get saved until its semantic is known
215  *  - Bits in 0x0000FFFF have been saved in ce_flags already
216  *  - Bits in 0x003F0000 are currently in-memory flags
217  */
218 #if CE_EXTENDED_FLAGS & 0x803FFFFF
219 #error "CE_EXTENDED_FLAGS out of range"
220 #endif
221
222 /*
223  * Copy the sha1 and stat state of a cache entry from one to
224  * another. But we never change the name, or the hash state!
225  */
226 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
227 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
228 {
229         unsigned int state = dst->ce_flags & CE_STATE_MASK;
230
231         /* Don't copy hash chain and name */
232         memcpy(dst, src, offsetof(struct cache_entry, next));
233
234         /* Restore the hash state */
235         dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
236 }
237
238 static inline unsigned create_ce_flags(size_t len, unsigned stage)
239 {
240         if (len >= CE_NAMEMASK)
241                 len = CE_NAMEMASK;
242         return (len | (stage << CE_STAGESHIFT));
243 }
244
245 static inline size_t ce_namelen(const struct cache_entry *ce)
246 {
247         size_t len = ce->ce_flags & CE_NAMEMASK;
248         if (len < CE_NAMEMASK)
249                 return len;
250         return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
251 }
252
253 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
254 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
255                             ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
256                             ondisk_cache_entry_size(ce_namelen(ce)))
257 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
258 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
259 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
260 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
261
262 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
263 static inline unsigned int create_ce_mode(unsigned int mode)
264 {
265         if (S_ISLNK(mode))
266                 return S_IFLNK;
267         if (S_ISDIR(mode) || S_ISGITLINK(mode))
268                 return S_IFGITLINK;
269         return S_IFREG | ce_permissions(mode);
270 }
271 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
272 {
273         extern int trust_executable_bit, has_symlinks;
274         if (!has_symlinks && S_ISREG(mode) &&
275             ce && S_ISLNK(ce->ce_mode))
276                 return ce->ce_mode;
277         if (!trust_executable_bit && S_ISREG(mode)) {
278                 if (ce && S_ISREG(ce->ce_mode))
279                         return ce->ce_mode;
280                 return create_ce_mode(0666);
281         }
282         return create_ce_mode(mode);
283 }
284 static inline int ce_to_dtype(const struct cache_entry *ce)
285 {
286         unsigned ce_mode = ntohl(ce->ce_mode);
287         if (S_ISREG(ce_mode))
288                 return DT_REG;
289         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
290                 return DT_DIR;
291         else if (S_ISLNK(ce_mode))
292                 return DT_LNK;
293         else
294                 return DT_UNKNOWN;
295 }
296 static inline unsigned int canon_mode(unsigned int mode)
297 {
298         if (S_ISREG(mode))
299                 return S_IFREG | ce_permissions(mode);
300         if (S_ISLNK(mode))
301                 return S_IFLNK;
302         if (S_ISDIR(mode))
303                 return S_IFDIR;
304         return S_IFGITLINK;
305 }
306
307 #define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
308 #define cache_entry_size(len) flexible_size(cache_entry,len)
309 #define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
310 #define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
311
312 struct index_state {
313         struct cache_entry **cache;
314         unsigned int cache_nr, cache_alloc, cache_changed;
315         struct string_list *resolve_undo;
316         struct cache_tree *cache_tree;
317         struct cache_time timestamp;
318         void *alloc;
319         unsigned name_hash_initialized : 1,
320                  initialized : 1;
321         struct hash_table name_hash;
322 };
323
324 extern struct index_state the_index;
325
326 /* Name hashing */
327 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
328 /*
329  * We don't actually *remove* it, we can just mark it invalid so that
330  * we won't find it in lookups.
331  *
332  * Not only would we have to search the lists (simple enough), but
333  * we'd also have to rehash other hash buckets in case this makes the
334  * hash bucket empty (common). So it's much better to just mark
335  * it.
336  */
337 static inline void remove_name_hash(struct cache_entry *ce)
338 {
339         ce->ce_flags |= CE_UNHASHED;
340 }
341
342
343 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
344 #define active_cache (the_index.cache)
345 #define active_nr (the_index.cache_nr)
346 #define active_alloc (the_index.cache_alloc)
347 #define active_cache_changed (the_index.cache_changed)
348 #define active_cache_tree (the_index.cache_tree)
349
350 #define read_cache() read_index(&the_index)
351 #define read_cache_from(path) read_index_from(&the_index, (path))
352 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
353 #define is_cache_unborn() is_index_unborn(&the_index)
354 #define read_cache_unmerged() read_index_unmerged(&the_index)
355 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
356 #define discard_cache() discard_index(&the_index)
357 #define unmerged_cache() unmerged_index(&the_index)
358 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
359 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
360 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
361 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
362 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
363 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
364 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
365 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
366 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
367 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
368 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
369 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
370 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
371 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
372 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
373 #endif
374
375 enum object_type {
376         OBJ_BAD = -1,
377         OBJ_NONE = 0,
378         OBJ_COMMIT = 1,
379         OBJ_TREE = 2,
380         OBJ_BLOB = 3,
381         OBJ_TAG = 4,
382         /* 5 for future expansion */
383         OBJ_OFS_DELTA = 6,
384         OBJ_REF_DELTA = 7,
385         OBJ_ANY,
386         OBJ_MAX
387 };
388
389 static inline enum object_type object_type(unsigned int mode)
390 {
391         return S_ISDIR(mode) ? OBJ_TREE :
392                 S_ISGITLINK(mode) ? OBJ_COMMIT :
393                 OBJ_BLOB;
394 }
395
396 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
397 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
398 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
399 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
400 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
401 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
402 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
403 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
404 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
405 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
406 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
407 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
408 #define GITATTRIBUTES_FILE ".gitattributes"
409 #define INFOATTRIBUTES_FILE "info/attributes"
410 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
411 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
412 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
413 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
414 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
415 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
416
417 /*
418  * Repository-local GIT_* environment variables
419  * The array is NULL-terminated to simplify its usage in contexts such
420  * environment creation or simple walk of the list.
421  * The number of non-NULL entries is available as a macro.
422  */
423 #define LOCAL_REPO_ENV_SIZE 9
424 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
425
426 extern int is_bare_repository_cfg;
427 extern int is_bare_repository(void);
428 extern int is_inside_git_dir(void);
429 extern char *git_work_tree_cfg;
430 extern int is_inside_work_tree(void);
431 extern int have_git_dir(void);
432 extern const char *get_git_dir(void);
433 extern char *get_object_directory(void);
434 extern char *get_index_file(void);
435 extern char *get_graft_file(void);
436 extern int set_git_dir(const char *path);
437 extern const char *get_git_work_tree(void);
438 extern const char *read_gitfile_gently(const char *path);
439 extern void set_git_work_tree(const char *tree);
440
441 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
442
443 extern const char **get_pathspec(const char *prefix, const char **pathspec);
444 extern void setup_work_tree(void);
445 extern const char *setup_git_directory_gently(int *);
446 extern const char *setup_git_directory(void);
447 extern char *prefix_path(const char *prefix, int len, const char *path);
448 extern const char *prefix_filename(const char *prefix, int len, const char *path);
449 extern int check_filename(const char *prefix, const char *name);
450 extern void verify_filename(const char *prefix, const char *name);
451 extern void verify_non_filename(const char *prefix, const char *name);
452
453 #define INIT_DB_QUIET 0x0001
454
455 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
456 extern int init_db(const char *template_dir, unsigned int flags);
457
458 #define alloc_nr(x) (((x)+16)*3/2)
459
460 /*
461  * Realloc the buffer pointed at by variable 'x' so that it can hold
462  * at least 'nr' entries; the number of entries currently allocated
463  * is 'alloc', using the standard growing factor alloc_nr() macro.
464  *
465  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
466  */
467 #define ALLOC_GROW(x, nr, alloc) \
468         do { \
469                 if ((nr) > alloc) { \
470                         if (alloc_nr(alloc) < (nr)) \
471                                 alloc = (nr); \
472                         else \
473                                 alloc = alloc_nr(alloc); \
474                         x = xrealloc((x), alloc * sizeof(*(x))); \
475                 } \
476         } while (0)
477
478 /* Initialize and use the cache information */
479 extern int read_index(struct index_state *);
480 extern int read_index_preload(struct index_state *, const char **pathspec);
481 extern int read_index_from(struct index_state *, const char *path);
482 extern int is_index_unborn(struct index_state *);
483 extern int read_index_unmerged(struct index_state *);
484 extern int write_index(struct index_state *, int newfd);
485 extern int discard_index(struct index_state *);
486 extern int unmerged_index(const struct index_state *);
487 extern int verify_path(const char *path);
488 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
489 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
490 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
491 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
492 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
493 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
494 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
495 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
496 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
497 extern int remove_index_entry_at(struct index_state *, int pos);
498 extern void remove_marked_cache_entries(struct index_state *istate);
499 extern int remove_file_from_index(struct index_state *, const char *path);
500 #define ADD_CACHE_VERBOSE 1
501 #define ADD_CACHE_PRETEND 2
502 #define ADD_CACHE_IGNORE_ERRORS 4
503 #define ADD_CACHE_IGNORE_REMOVAL 8
504 #define ADD_CACHE_INTENT 16
505 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
506 extern int add_file_to_index(struct index_state *, const char *path, int flags);
507 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
508 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
509 extern int index_name_is_other(const struct index_state *, const char *, int);
510
511 /* do stat comparison even if CE_VALID is true */
512 #define CE_MATCH_IGNORE_VALID           01
513 /* do not check the contents but report dirty on racily-clean entries */
514 #define CE_MATCH_RACY_IS_DIRTY          02
515 /* do stat comparison even if CE_SKIP_WORKTREE is true */
516 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
517 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
518 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
519
520 struct pathspec {
521         const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
522         int nr;
523         unsigned int has_wildcard:1;
524         unsigned int recursive:1;
525         int max_depth;
526         struct pathspec_item {
527                 const char *match;
528                 int len;
529                 unsigned int use_wildcard:1;
530         } *items;
531 };
532
533 extern int init_pathspec(struct pathspec *, const char **);
534 extern void free_pathspec(struct pathspec *);
535 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
536
537 #define HASH_WRITE_OBJECT 1
538 #define HASH_FORMAT_CHECK 2
539 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
540 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
541 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
542
543 #define REFRESH_REALLY          0x0001  /* ignore_valid */
544 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
545 #define REFRESH_QUIET           0x0004  /* be quiet about it */
546 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
547 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
548 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
549 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
550
551 struct lock_file {
552         struct lock_file *next;
553         int fd;
554         pid_t owner;
555         char on_list;
556         char filename[PATH_MAX];
557 };
558 #define LOCK_DIE_ON_ERROR 1
559 #define LOCK_NODEREF 2
560 extern int unable_to_lock_error(const char *path, int err);
561 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
562 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
563 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
564 extern int commit_lock_file(struct lock_file *);
565 extern void update_index_if_able(struct index_state *, struct lock_file *);
566
567 extern int hold_locked_index(struct lock_file *, int);
568 extern int commit_locked_index(struct lock_file *);
569 extern void set_alternate_index_output(const char *);
570 extern int close_lock_file(struct lock_file *);
571 extern void rollback_lock_file(struct lock_file *);
572 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
573
574 /* Environment bits from configuration mechanism */
575 extern int trust_executable_bit;
576 extern int trust_ctime;
577 extern int quote_path_fully;
578 extern int has_symlinks;
579 extern int minimum_abbrev, default_abbrev;
580 extern int ignore_case;
581 extern int assume_unchanged;
582 extern int prefer_symlink_refs;
583 extern int log_all_ref_updates;
584 extern int warn_ambiguous_refs;
585 extern int shared_repository;
586 extern const char *apply_default_whitespace;
587 extern const char *apply_default_ignorewhitespace;
588 extern int zlib_compression_level;
589 extern int core_compression_level;
590 extern int core_compression_seen;
591 extern size_t packed_git_window_size;
592 extern size_t packed_git_limit;
593 extern size_t delta_base_cache_limit;
594 extern unsigned long big_file_threshold;
595 extern int read_replace_refs;
596 extern int fsync_object_files;
597 extern int core_preload_index;
598 extern int core_apply_sparse_checkout;
599
600 enum branch_track {
601         BRANCH_TRACK_UNSPECIFIED = -1,
602         BRANCH_TRACK_NEVER = 0,
603         BRANCH_TRACK_REMOTE,
604         BRANCH_TRACK_ALWAYS,
605         BRANCH_TRACK_EXPLICIT,
606         BRANCH_TRACK_OVERRIDE
607 };
608
609 enum rebase_setup_type {
610         AUTOREBASE_NEVER = 0,
611         AUTOREBASE_LOCAL,
612         AUTOREBASE_REMOTE,
613         AUTOREBASE_ALWAYS
614 };
615
616 enum push_default_type {
617         PUSH_DEFAULT_NOTHING = 0,
618         PUSH_DEFAULT_MATCHING,
619         PUSH_DEFAULT_UPSTREAM,
620         PUSH_DEFAULT_CURRENT
621 };
622
623 extern enum branch_track git_branch_track;
624 extern enum rebase_setup_type autorebase;
625 extern enum push_default_type push_default;
626
627 enum object_creation_mode {
628         OBJECT_CREATION_USES_HARDLINKS = 0,
629         OBJECT_CREATION_USES_RENAMES = 1
630 };
631
632 extern enum object_creation_mode object_creation_mode;
633
634 extern char *notes_ref_name;
635
636 extern int grafts_replace_parents;
637
638 #define GIT_REPO_VERSION 0
639 extern int repository_format_version;
640 extern int check_repository_format(void);
641
642 #define MTIME_CHANGED   0x0001
643 #define CTIME_CHANGED   0x0002
644 #define OWNER_CHANGED   0x0004
645 #define MODE_CHANGED    0x0008
646 #define INODE_CHANGED   0x0010
647 #define DATA_CHANGED    0x0020
648 #define TYPE_CHANGED    0x0040
649
650 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
651         __attribute__((format (printf, 3, 4)));
652 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
653         __attribute__((format (printf, 3, 4)));
654 extern char *git_pathdup(const char *fmt, ...)
655         __attribute__((format (printf, 1, 2)));
656
657 /* Return a statically allocated filename matching the sha1 signature */
658 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
659 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
660 extern char *git_path_submodule(const char *path, const char *fmt, ...)
661         __attribute__((format (printf, 2, 3)));
662
663 extern char *sha1_file_name(const unsigned char *sha1);
664 extern char *sha1_pack_name(const unsigned char *sha1);
665 extern char *sha1_pack_index_name(const unsigned char *sha1);
666 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
667 extern const unsigned char null_sha1[20];
668
669 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
670 {
671         int i;
672
673         for (i = 0; i < 20; i++, sha1++, sha2++) {
674                 if (*sha1 != *sha2)
675                         return *sha1 - *sha2;
676         }
677
678         return 0;
679 }
680
681 static inline int is_null_sha1(const unsigned char *sha1)
682 {
683         return !hashcmp(sha1, null_sha1);
684 }
685
686 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
687 {
688         memcpy(sha_dst, sha_src, 20);
689 }
690 static inline void hashclr(unsigned char *hash)
691 {
692         memset(hash, 0, 20);
693 }
694
695 #define EMPTY_TREE_SHA1_HEX \
696         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
697 #define EMPTY_TREE_SHA1_BIN_LITERAL \
698          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
699          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
700 #define EMPTY_TREE_SHA1_BIN \
701          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
702
703 int git_mkstemp(char *path, size_t n, const char *template);
704
705 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
706
707 /* set default permissions by passing mode arguments to open(2) */
708 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
709 int git_mkstemp_mode(char *pattern, int mode);
710
711 /*
712  * NOTE NOTE NOTE!!
713  *
714  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
715  * not be changed. Old repositories have core.sharedrepository written in
716  * numeric format, and therefore these values are preserved for compatibility
717  * reasons.
718  */
719 enum sharedrepo {
720         PERM_UMASK          = 0,
721         OLD_PERM_GROUP      = 1,
722         OLD_PERM_EVERYBODY  = 2,
723         PERM_GROUP          = 0660,
724         PERM_EVERYBODY      = 0664
725 };
726 int git_config_perm(const char *var, const char *value);
727 int set_shared_perm(const char *path, int mode);
728 #define adjust_shared_perm(path) set_shared_perm((path), 0)
729 int safe_create_leading_directories(char *path);
730 int safe_create_leading_directories_const(const char *path);
731 int mkdir_in_gitdir(const char *path);
732 extern char *expand_user_path(const char *path);
733 char *enter_repo(char *path, int strict);
734 static inline int is_absolute_path(const char *path)
735 {
736         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
737 }
738 int is_directory(const char *);
739 const char *real_path(const char *path);
740 const char *absolute_path(const char *path);
741 const char *relative_path(const char *abs, const char *base);
742 int normalize_path_copy(char *dst, const char *src);
743 int longest_ancestor_length(const char *path, const char *prefix_list);
744 char *strip_path_suffix(const char *path, const char *suffix);
745 int daemon_avoid_alias(const char *path);
746 int offset_1st_component(const char *path);
747
748 /* object replacement */
749 #define READ_SHA1_FILE_REPLACE 1
750 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
751 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
752 {
753         return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
754 }
755 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
756 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
757 {
758         if (!read_replace_refs)
759                 return sha1;
760         return do_lookup_replace_object(sha1);
761 }
762
763 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
764 extern int sha1_object_info(const unsigned char *, unsigned long *);
765 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
766 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
767 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
768 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
769 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
770 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
771 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
772
773 /* global flag to enable extra checks when accessing packed objects */
774 extern int do_check_packed_object_crc;
775
776 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
777
778 extern int move_temp_to_file(const char *tmpfile, const char *filename);
779
780 extern int has_sha1_pack(const unsigned char *sha1);
781 extern int has_sha1_file(const unsigned char *sha1);
782 extern int has_loose_object_nonlocal(const unsigned char *sha1);
783
784 extern int has_pack_index(const unsigned char *sha1);
785
786 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
787
788 extern const signed char hexval_table[256];
789 static inline unsigned int hexval(unsigned char c)
790 {
791         return hexval_table[c];
792 }
793
794 /* Convert to/from hex/sha1 representation */
795 #define MINIMUM_ABBREV minimum_abbrev
796 #define DEFAULT_ABBREV default_abbrev
797
798 struct object_context {
799         unsigned char tree[20];
800         char path[PATH_MAX];
801         unsigned mode;
802 };
803
804 extern int get_sha1(const char *str, unsigned char *sha1);
805 extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int only_to_die, const char *prefix);
806 static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
807 {
808         return get_sha1_with_mode_1(str, sha1, mode, 0, NULL);
809 }
810 extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int only_to_die, const char *prefix);
811 static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
812 {
813         return get_sha1_with_context_1(str, sha1, orc, 0, NULL);
814 }
815 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
816 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
817 extern int read_ref(const char *filename, unsigned char *sha1);
818 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
819 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
820 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
821 extern int interpret_branch_name(const char *str, struct strbuf *);
822 extern int get_sha1_mb(const char *str, unsigned char *sha1);
823
824 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
825 extern const char *ref_rev_parse_rules[];
826 extern const char *ref_fetch_rules[];
827
828 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
829 extern int validate_headref(const char *ref);
830
831 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
832 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
833 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
834
835 extern void *read_object_with_reference(const unsigned char *sha1,
836                                         const char *required_type,
837                                         unsigned long *size,
838                                         unsigned char *sha1_ret);
839
840 extern struct object *peel_to_type(const char *name, int namelen,
841                                    struct object *o, enum object_type);
842
843 enum date_mode {
844         DATE_NORMAL = 0,
845         DATE_RELATIVE,
846         DATE_SHORT,
847         DATE_LOCAL,
848         DATE_ISO8601,
849         DATE_RFC2822,
850         DATE_RAW
851 };
852
853 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
854 const char *show_date_relative(unsigned long time, int tz,
855                                const struct timeval *now,
856                                char *timebuf,
857                                size_t timebuf_size);
858 int parse_date(const char *date, char *buf, int bufsize);
859 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
860 void datestamp(char *buf, int bufsize);
861 #define approxidate(s) approxidate_careful((s), NULL)
862 unsigned long approxidate_careful(const char *, int *);
863 unsigned long approxidate_relative(const char *date, const struct timeval *now);
864 enum date_mode parse_date_format(const char *format);
865
866 #define IDENT_WARN_ON_NO_NAME  1
867 #define IDENT_ERROR_ON_NO_NAME 2
868 #define IDENT_NO_DATE          4
869 extern const char *git_author_info(int);
870 extern const char *git_committer_info(int);
871 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
872 extern const char *fmt_name(const char *name, const char *email);
873 extern const char *git_editor(void);
874 extern const char *git_pager(int stdout_is_tty);
875
876 struct checkout {
877         const char *base_dir;
878         int base_dir_len;
879         unsigned force:1,
880                  quiet:1,
881                  not_new:1,
882                  refresh_cache:1;
883 };
884
885 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
886
887 struct cache_def {
888         char path[PATH_MAX + 1];
889         int len;
890         int flags;
891         int track_flags;
892         int prefix_len_stat_func;
893 };
894
895 extern int has_symlink_leading_path(const char *name, int len);
896 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
897 extern int check_leading_path(const char *name, int len);
898 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
899 extern void schedule_dir_for_removal(const char *name, int len);
900 extern void remove_scheduled_dirs(void);
901
902 extern struct alternate_object_database {
903         struct alternate_object_database *next;
904         char *name;
905         char base[FLEX_ARRAY]; /* more */
906 } *alt_odb_list;
907 extern void prepare_alt_odb(void);
908 extern void add_to_alternates_file(const char *reference);
909 typedef int alt_odb_fn(struct alternate_object_database *, void *);
910 extern void foreach_alt_odb(alt_odb_fn, void*);
911
912 struct pack_window {
913         struct pack_window *next;
914         unsigned char *base;
915         off_t offset;
916         size_t len;
917         unsigned int last_used;
918         unsigned int inuse_cnt;
919 };
920
921 extern struct packed_git {
922         struct packed_git *next;
923         struct pack_window *windows;
924         off_t pack_size;
925         const void *index_data;
926         size_t index_size;
927         uint32_t num_objects;
928         uint32_t num_bad_objects;
929         unsigned char *bad_object_sha1;
930         int index_version;
931         time_t mtime;
932         int pack_fd;
933         unsigned pack_local:1,
934                  pack_keep:1,
935                  do_not_close:1;
936         unsigned char sha1[20];
937         /* something like ".git/objects/pack/xxxxx.pack" */
938         char pack_name[FLEX_ARRAY]; /* more */
939 } *packed_git;
940
941 struct pack_entry {
942         off_t offset;
943         unsigned char sha1[20];
944         struct packed_git *p;
945 };
946
947 struct ref {
948         struct ref *next;
949         unsigned char old_sha1[20];
950         unsigned char new_sha1[20];
951         char *symref;
952         unsigned int force:1,
953                 merge:1,
954                 nonfastforward:1,
955                 deletion:1;
956         enum {
957                 REF_STATUS_NONE = 0,
958                 REF_STATUS_OK,
959                 REF_STATUS_REJECT_NONFASTFORWARD,
960                 REF_STATUS_REJECT_NODELETE,
961                 REF_STATUS_UPTODATE,
962                 REF_STATUS_REMOTE_REJECT,
963                 REF_STATUS_EXPECTING_REPORT
964         } status;
965         char *remote_status;
966         struct ref *peer_ref; /* when renaming */
967         char name[FLEX_ARRAY]; /* more */
968 };
969
970 #define REF_NORMAL      (1u << 0)
971 #define REF_HEADS       (1u << 1)
972 #define REF_TAGS        (1u << 2)
973
974 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
975
976 #define CONNECT_VERBOSE       (1u << 0)
977 extern char *git_getpass(const char *prompt);
978 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
979 extern int finish_connect(struct child_process *conn);
980 extern int git_connection_is_socket(struct child_process *conn);
981 extern int path_match(const char *path, int nr, char **match);
982 struct extra_have_objects {
983         int nr, alloc;
984         unsigned char (*array)[20];
985 };
986 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
987 extern int server_supports(const char *feature);
988
989 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
990
991 extern void prepare_packed_git(void);
992 extern void reprepare_packed_git(void);
993 extern void install_packed_git(struct packed_git *pack);
994
995 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
996                                          struct packed_git *packs);
997
998 extern void pack_report(void);
999 extern int open_pack_index(struct packed_git *);
1000 extern void close_pack_index(struct packed_git *);
1001 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1002 extern void close_pack_windows(struct packed_git *);
1003 extern void unuse_pack(struct pack_window **);
1004 extern void free_pack_by_name(const char *);
1005 extern void clear_delta_base_cache(void);
1006 extern struct packed_git *add_packed_git(const char *, int, int);
1007 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1008 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1009 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1010 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1011 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1012 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1013 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1014
1015 struct object_info {
1016         /* Request */
1017         unsigned long *sizep;
1018
1019         /* Response */
1020         enum {
1021                 OI_CACHED,
1022                 OI_LOOSE,
1023                 OI_PACKED,
1024                 OI_DBCACHED
1025         } whence;
1026         union {
1027                 /*
1028                  * struct {
1029                  *      ... Nothing to expose in this case
1030                  * } cached;
1031                  * struct {
1032                  *      ... Nothing to expose in this case
1033                  * } loose;
1034                  */
1035                 struct {
1036                         struct packed_git *pack;
1037                         off_t offset;
1038                         unsigned int is_delta;
1039                 } packed;
1040         } u;
1041 };
1042 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1043
1044 /* Dumb servers support */
1045 extern int update_server_info(int);
1046
1047 /* git_config_parse_key() returns these negated: */
1048 #define CONFIG_INVALID_KEY 1
1049 #define CONFIG_NO_SECTION_OR_NAME 2
1050 /* git_config_set(), git_config_set_multivar() return the above or these: */
1051 #define CONFIG_NO_LOCK -1
1052 #define CONFIG_INVALID_FILE 3
1053 #define CONFIG_NO_WRITE 4
1054 #define CONFIG_NOTHING_SET 5
1055 #define CONFIG_INVALID_PATTERN 6
1056
1057 typedef int (*config_fn_t)(const char *, const char *, void *);
1058 extern int git_default_config(const char *, const char *, void *);
1059 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1060 extern void git_config_push_parameter(const char *text);
1061 extern int git_config_from_parameters(config_fn_t fn, void *data);
1062 extern int git_config(config_fn_t fn, void *);
1063 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1064 extern int git_parse_ulong(const char *, unsigned long *);
1065 extern int git_config_int(const char *, const char *);
1066 extern unsigned long git_config_ulong(const char *, const char *);
1067 extern int git_config_bool_or_int(const char *, const char *, int *);
1068 extern int git_config_bool(const char *, const char *);
1069 extern int git_config_maybe_bool(const char *, const char *);
1070 extern int git_config_string(const char **, const char *, const char *);
1071 extern int git_config_pathname(const char **, const char *, const char *);
1072 extern int git_config_set(const char *, const char *);
1073 extern int git_config_parse_key(const char *, char **, int *);
1074 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1075 extern int git_config_rename_section(const char *, const char *);
1076 extern const char *git_etc_gitconfig(void);
1077 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1078 extern int git_env_bool(const char *, int);
1079 extern int git_config_system(void);
1080 extern int config_error_nonbool(const char *);
1081 extern const char *get_log_output_encoding(void);
1082 extern const char *get_commit_output_encoding(void);
1083
1084 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1085
1086 extern const char *config_exclusive_filename;
1087
1088 #define MAX_GITNAME (1000)
1089 extern char git_default_email[MAX_GITNAME];
1090 extern char git_default_name[MAX_GITNAME];
1091 #define IDENT_NAME_GIVEN 01
1092 #define IDENT_MAIL_GIVEN 02
1093 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1094 extern int user_ident_explicitly_given;
1095 extern int user_ident_sufficiently_given(void);
1096
1097 extern const char *git_commit_encoding;
1098 extern const char *git_log_output_encoding;
1099 extern const char *git_mailmap_file;
1100
1101 /* IO helper functions */
1102 extern void maybe_flush_or_die(FILE *, const char *);
1103 extern int copy_fd(int ifd, int ofd);
1104 extern int copy_file(const char *dst, const char *src, int mode);
1105 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1106 extern void write_or_die(int fd, const void *buf, size_t count);
1107 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1108 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1109 extern void fsync_or_die(int fd, const char *);
1110
1111 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1112 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1113 static inline ssize_t write_str_in_full(int fd, const char *str)
1114 {
1115         return write_in_full(fd, str, strlen(str));
1116 }
1117
1118 /* pager.c */
1119 extern void setup_pager(void);
1120 extern const char *pager_program;
1121 extern int pager_in_use(void);
1122 extern int pager_use_color;
1123
1124 extern const char *editor_program;
1125 extern const char *askpass_program;
1126 extern const char *excludes_file;
1127
1128 /* base85 */
1129 int decode_85(char *dst, const char *line, int linelen);
1130 void encode_85(char *buf, const unsigned char *data, int bytes);
1131
1132 /* alloc.c */
1133 extern void *alloc_blob_node(void);
1134 extern void *alloc_tree_node(void);
1135 extern void *alloc_commit_node(void);
1136 extern void *alloc_tag_node(void);
1137 extern void *alloc_object_node(void);
1138 extern void alloc_report(void);
1139
1140 /* trace.c */
1141 __attribute__((format (printf, 1, 2)))
1142 extern void trace_printf(const char *format, ...);
1143 extern void trace_vprintf(const char *key, const char *format, va_list ap);
1144 __attribute__((format (printf, 2, 3)))
1145 extern void trace_argv_printf(const char **argv, const char *format, ...);
1146 extern void trace_repo_setup(const char *prefix);
1147 extern int trace_want(const char *key);
1148 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1149
1150 void packet_trace_identity(const char *prog);
1151
1152 /* add */
1153 /*
1154  * return 0 if success, 1 - if addition of a file failed and
1155  * ADD_FILES_IGNORE_ERRORS was specified in flags
1156  */
1157 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1158
1159 /* diff.c */
1160 extern int diff_auto_refresh_index;
1161
1162 /* match-trees.c */
1163 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1164 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1165
1166 /*
1167  * whitespace rules.
1168  * used by both diff and apply
1169  * last two digits are tab width
1170  */
1171 #define WS_BLANK_AT_EOL         0100
1172 #define WS_SPACE_BEFORE_TAB     0200
1173 #define WS_INDENT_WITH_NON_TAB  0400
1174 #define WS_CR_AT_EOL           01000
1175 #define WS_BLANK_AT_EOF        02000
1176 #define WS_TAB_IN_INDENT       04000
1177 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1178 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1179 #define WS_TAB_WIDTH_MASK        077
1180 extern unsigned whitespace_rule_cfg;
1181 extern unsigned whitespace_rule(const char *);
1182 extern unsigned parse_whitespace_rule(const char *);
1183 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1184 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1185 extern char *whitespace_error_string(unsigned ws);
1186 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1187 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1188 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1189
1190 /* ls-files */
1191 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
1192 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1193
1194 char *alias_lookup(const char *alias);
1195 int split_cmdline(char *cmdline, const char ***argv);
1196 /* Takes a negative value returned by split_cmdline */
1197 const char *split_cmdline_strerror(int cmdline_errno);
1198
1199 /* git.c */
1200 struct startup_info {
1201         int have_repository;
1202         const char *prefix;
1203 };
1204 extern struct startup_info *startup_info;
1205
1206 /* builtin/merge.c */
1207 int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1208
1209 #endif /* CACHE_H */