stripspace: call U+0020 a "space" instead of a "blank"
[git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
10 #include "trace.h"
11 #include "string-list.h"
12
13 #include SHA1_HEADER
14 #ifndef platform_SHA_CTX
15 /*
16  * platform's underlying implementation of SHA-1; could be OpenSSL,
17  * blk_SHA, Apple CommonCrypto, etc...  Note that including
18  * SHA1_HEADER may have already defined platform_SHA_CTX for our
19  * own implementations like block-sha1 and ppc-sha1, so we list
20  * the default for OpenSSL compatible SHA-1 implementations here.
21  */
22 #define platform_SHA_CTX        SHA_CTX
23 #define platform_SHA1_Init      SHA1_Init
24 #define platform_SHA1_Update    SHA1_Update
25 #define platform_SHA1_Final     SHA1_Final
26 #endif
27
28 #define git_SHA_CTX             platform_SHA_CTX
29 #define git_SHA1_Init           platform_SHA1_Init
30 #define git_SHA1_Update         platform_SHA1_Update
31 #define git_SHA1_Final          platform_SHA1_Final
32
33 #ifdef SHA1_MAX_BLOCK_SIZE
34 #include "compat/sha1-chunked.h"
35 #undef git_SHA1_Update
36 #define git_SHA1_Update         git_SHA1_Update_Chunked
37 #endif
38
39 #include <zlib.h>
40 typedef struct git_zstream {
41         z_stream z;
42         unsigned long avail_in;
43         unsigned long avail_out;
44         unsigned long total_in;
45         unsigned long total_out;
46         unsigned char *next_in;
47         unsigned char *next_out;
48 } git_zstream;
49
50 void git_inflate_init(git_zstream *);
51 void git_inflate_init_gzip_only(git_zstream *);
52 void git_inflate_end(git_zstream *);
53 int git_inflate(git_zstream *, int flush);
54
55 void git_deflate_init(git_zstream *, int level);
56 void git_deflate_init_gzip(git_zstream *, int level);
57 void git_deflate_init_raw(git_zstream *, int level);
58 void git_deflate_end(git_zstream *);
59 int git_deflate_abort(git_zstream *);
60 int git_deflate_end_gently(git_zstream *);
61 int git_deflate(git_zstream *, int flush);
62 unsigned long git_deflate_bound(git_zstream *, unsigned long);
63
64 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
65 #define GIT_SHA1_RAWSZ 20
66 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
67
68 struct object_id {
69         unsigned char hash[GIT_SHA1_RAWSZ];
70 };
71
72 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
73 #define DTYPE(de)       ((de)->d_type)
74 #else
75 #undef DT_UNKNOWN
76 #undef DT_DIR
77 #undef DT_REG
78 #undef DT_LNK
79 #define DT_UNKNOWN      0
80 #define DT_DIR          1
81 #define DT_REG          2
82 #define DT_LNK          3
83 #define DTYPE(de)       DT_UNKNOWN
84 #endif
85
86 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
87 #define S_IFINVALID     0030000
88
89 /*
90  * A "directory link" is a link to another git directory.
91  *
92  * The value 0160000 is not normally a valid mode, and
93  * also just happens to be S_IFDIR + S_IFLNK
94  */
95 #define S_IFGITLINK     0160000
96 #define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
97
98 /*
99  * Some mode bits are also used internally for computations.
100  *
101  * They *must* not overlap with any valid modes, and they *must* not be emitted
102  * to outside world - i.e. appear on disk or network. In other words, it's just
103  * temporary fields, which we internally use, but they have to stay in-house.
104  *
105  * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
106  *   codebase mode is `unsigned int` which is assumed to be at least 32 bits )
107  */
108
109 /* used internally in tree-diff */
110 #define S_DIFFTREE_IFXMIN_NEQ   0x80000000
111
112
113 /*
114  * Intensive research over the course of many years has shown that
115  * port 9418 is totally unused by anything else. Or
116  *
117  *      Your search - "port 9418" - did not match any documents.
118  *
119  * as www.google.com puts it.
120  *
121  * This port has been properly assigned for git use by IANA:
122  * git (Assigned-9418) [I06-050728-0001].
123  *
124  *      git  9418/tcp   git pack transfer service
125  *      git  9418/udp   git pack transfer service
126  *
127  * with Linus Torvalds <torvalds@osdl.org> as the point of
128  * contact. September 2005.
129  *
130  * See http://www.iana.org/assignments/port-numbers
131  */
132 #define DEFAULT_GIT_PORT 9418
133
134 /*
135  * Basic data structures for the directory cache
136  */
137
138 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
139 struct cache_header {
140         uint32_t hdr_signature;
141         uint32_t hdr_version;
142         uint32_t hdr_entries;
143 };
144
145 #define INDEX_FORMAT_LB 2
146 #define INDEX_FORMAT_UB 4
147
148 /*
149  * The "cache_time" is just the low 32 bits of the
150  * time. It doesn't matter if it overflows - we only
151  * check it for equality in the 32 bits we save.
152  */
153 struct cache_time {
154         uint32_t sec;
155         uint32_t nsec;
156 };
157
158 struct stat_data {
159         struct cache_time sd_ctime;
160         struct cache_time sd_mtime;
161         unsigned int sd_dev;
162         unsigned int sd_ino;
163         unsigned int sd_uid;
164         unsigned int sd_gid;
165         unsigned int sd_size;
166 };
167
168 struct cache_entry {
169         struct hashmap_entry ent;
170         struct stat_data ce_stat_data;
171         unsigned int ce_mode;
172         unsigned int ce_flags;
173         unsigned int ce_namelen;
174         unsigned int index;     /* for link extension */
175         unsigned char sha1[20];
176         char name[FLEX_ARRAY]; /* more */
177 };
178
179 #define CE_STAGEMASK (0x3000)
180 #define CE_EXTENDED  (0x4000)
181 #define CE_VALID     (0x8000)
182 #define CE_STAGESHIFT 12
183
184 /*
185  * Range 0xFFFF0FFF in ce_flags is divided into
186  * two parts: in-memory flags and on-disk ones.
187  * Flags in CE_EXTENDED_FLAGS will get saved on-disk
188  * if you want to save a new flag, add it in
189  * CE_EXTENDED_FLAGS
190  *
191  * In-memory only flags
192  */
193 #define CE_UPDATE            (1 << 16)
194 #define CE_REMOVE            (1 << 17)
195 #define CE_UPTODATE          (1 << 18)
196 #define CE_ADDED             (1 << 19)
197
198 #define CE_HASHED            (1 << 20)
199 #define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
200 #define CE_CONFLICTED        (1 << 23)
201
202 #define CE_UNPACKED          (1 << 24)
203 #define CE_NEW_SKIP_WORKTREE (1 << 25)
204
205 /* used to temporarily mark paths matched by pathspecs */
206 #define CE_MATCHED           (1 << 26)
207
208 #define CE_UPDATE_IN_BASE    (1 << 27)
209 #define CE_STRIP_NAME        (1 << 28)
210
211 /*
212  * Extended on-disk flags
213  */
214 #define CE_INTENT_TO_ADD     (1 << 29)
215 #define CE_SKIP_WORKTREE     (1 << 30)
216 /* CE_EXTENDED2 is for future extension */
217 #define CE_EXTENDED2         (1 << 31)
218
219 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
220
221 /*
222  * Safeguard to avoid saving wrong flags:
223  *  - CE_EXTENDED2 won't get saved until its semantic is known
224  *  - Bits in 0x0000FFFF have been saved in ce_flags already
225  *  - Bits in 0x003F0000 are currently in-memory flags
226  */
227 #if CE_EXTENDED_FLAGS & 0x803FFFFF
228 #error "CE_EXTENDED_FLAGS out of range"
229 #endif
230
231 struct pathspec;
232
233 /*
234  * Copy the sha1 and stat state of a cache entry from one to
235  * another. But we never change the name, or the hash state!
236  */
237 static inline void copy_cache_entry(struct cache_entry *dst,
238                                     const struct cache_entry *src)
239 {
240         unsigned int state = dst->ce_flags & CE_HASHED;
241
242         /* Don't copy hash chain and name */
243         memcpy(&dst->ce_stat_data, &src->ce_stat_data,
244                         offsetof(struct cache_entry, name) -
245                         offsetof(struct cache_entry, ce_stat_data));
246
247         /* Restore the hash state */
248         dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
249 }
250
251 static inline unsigned create_ce_flags(unsigned stage)
252 {
253         return (stage << CE_STAGESHIFT);
254 }
255
256 #define ce_namelen(ce) ((ce)->ce_namelen)
257 #define ce_size(ce) 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)
262
263 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
264 static inline unsigned int create_ce_mode(unsigned int mode)
265 {
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);
271 }
272 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
273                                              unsigned int mode)
274 {
275         extern int trust_executable_bit, has_symlinks;
276         if (!has_symlinks && S_ISREG(mode) &&
277             ce && S_ISLNK(ce->ce_mode))
278                 return ce->ce_mode;
279         if (!trust_executable_bit && S_ISREG(mode)) {
280                 if (ce && S_ISREG(ce->ce_mode))
281                         return ce->ce_mode;
282                 return create_ce_mode(0666);
283         }
284         return create_ce_mode(mode);
285 }
286 static inline int ce_to_dtype(const struct cache_entry *ce)
287 {
288         unsigned ce_mode = ntohl(ce->ce_mode);
289         if (S_ISREG(ce_mode))
290                 return DT_REG;
291         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
292                 return DT_DIR;
293         else if (S_ISLNK(ce_mode))
294                 return DT_LNK;
295         else
296                 return DT_UNKNOWN;
297 }
298 static inline unsigned int canon_mode(unsigned int mode)
299 {
300         if (S_ISREG(mode))
301                 return S_IFREG | ce_permissions(mode);
302         if (S_ISLNK(mode))
303                 return S_IFLNK;
304         if (S_ISDIR(mode))
305                 return S_IFDIR;
306         return S_IFGITLINK;
307 }
308
309 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
310
311 #define SOMETHING_CHANGED       (1 << 0) /* unclassified changes go here */
312 #define CE_ENTRY_CHANGED        (1 << 1)
313 #define CE_ENTRY_REMOVED        (1 << 2)
314 #define CE_ENTRY_ADDED          (1 << 3)
315 #define RESOLVE_UNDO_CHANGED    (1 << 4)
316 #define CACHE_TREE_CHANGED      (1 << 5)
317 #define SPLIT_INDEX_ORDERED     (1 << 6)
318 #define UNTRACKED_CHANGED       (1 << 7)
319
320 struct split_index;
321 struct untracked_cache;
322
323 struct index_state {
324         struct cache_entry **cache;
325         unsigned int version;
326         unsigned int cache_nr, cache_alloc, cache_changed;
327         struct string_list *resolve_undo;
328         struct cache_tree *cache_tree;
329         struct split_index *split_index;
330         struct cache_time timestamp;
331         unsigned name_hash_initialized : 1,
332                  initialized : 1;
333         struct hashmap name_hash;
334         struct hashmap dir_hash;
335         unsigned char sha1[20];
336         struct untracked_cache *untracked;
337 };
338
339 extern struct index_state the_index;
340
341 /* Name hashing */
342 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
343 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
344 extern void free_name_hash(struct index_state *istate);
345
346
347 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
348 #define active_cache (the_index.cache)
349 #define active_nr (the_index.cache_nr)
350 #define active_alloc (the_index.cache_alloc)
351 #define active_cache_changed (the_index.cache_changed)
352 #define active_cache_tree (the_index.cache_tree)
353
354 #define read_cache() read_index(&the_index)
355 #define read_cache_from(path) read_index_from(&the_index, (path))
356 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
357 #define is_cache_unborn() is_index_unborn(&the_index)
358 #define read_cache_unmerged() read_index_unmerged(&the_index)
359 #define discard_cache() discard_index(&the_index)
360 #define unmerged_cache() unmerged_index(&the_index)
361 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
362 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
363 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
364 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
365 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
366 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
367 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
368 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
369 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
370 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
371 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
372 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
373 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
374 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
375 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
376 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
377 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
378 #endif
379
380 enum object_type {
381         OBJ_BAD = -1,
382         OBJ_NONE = 0,
383         OBJ_COMMIT = 1,
384         OBJ_TREE = 2,
385         OBJ_BLOB = 3,
386         OBJ_TAG = 4,
387         /* 5 for future expansion */
388         OBJ_OFS_DELTA = 6,
389         OBJ_REF_DELTA = 7,
390         OBJ_ANY,
391         OBJ_MAX
392 };
393
394 static inline enum object_type object_type(unsigned int mode)
395 {
396         return S_ISDIR(mode) ? OBJ_TREE :
397                 S_ISGITLINK(mode) ? OBJ_COMMIT :
398                 OBJ_BLOB;
399 }
400
401 /* Double-check local_repo_env below if you add to this list. */
402 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
403 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
404 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
405 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
406 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
407 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
408 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
409 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
410 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
411 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
412 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
413 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
414 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
415 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
416 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
417 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
418 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
419 #define GITATTRIBUTES_FILE ".gitattributes"
420 #define INFOATTRIBUTES_FILE "info/attributes"
421 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
422 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
423 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
424 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
425 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
426 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
427 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
428 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
429 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
430 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
431
432 /*
433  * This environment variable is expected to contain a boolean indicating
434  * whether we should or should not treat:
435  *
436  *   GIT_DIR=foo.git git ...
437  *
438  * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
439  * of this, but we use it internally to communicate to sub-processes that we
440  * are in a bare repo. If not set, defaults to true.
441  */
442 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
443
444 /*
445  * Repository-local GIT_* environment variables; these will be cleared
446  * when git spawns a sub-process that runs inside another repository.
447  * The array is NULL-terminated, which makes it easy to pass in the "env"
448  * parameter of a run-command invocation, or to do a simple walk.
449  */
450 extern const char * const local_repo_env[];
451
452 extern int is_bare_repository_cfg;
453 extern int is_bare_repository(void);
454 extern int is_inside_git_dir(void);
455 extern char *git_work_tree_cfg;
456 extern int is_inside_work_tree(void);
457 extern const char *get_git_dir(void);
458 extern const char *get_git_common_dir(void);
459 extern int is_git_directory(const char *path);
460 extern char *get_object_directory(void);
461 extern char *get_index_file(void);
462 extern char *get_graft_file(void);
463 extern int set_git_dir(const char *path);
464 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
465 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
466 extern const char *get_git_namespace(void);
467 extern const char *strip_namespace(const char *namespaced_ref);
468 extern const char *get_git_work_tree(void);
469
470 #define READ_GITFILE_ERR_STAT_FAILED 1
471 #define READ_GITFILE_ERR_NOT_A_FILE 2
472 #define READ_GITFILE_ERR_OPEN_FAILED 3
473 #define READ_GITFILE_ERR_READ_FAILED 4
474 #define READ_GITFILE_ERR_INVALID_FORMAT 5
475 #define READ_GITFILE_ERR_NO_PATH 6
476 #define READ_GITFILE_ERR_NOT_A_REPO 7
477 #define READ_GITFILE_ERR_TOO_LARGE 8
478 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
479 #define read_gitfile(path) read_gitfile_gently((path), NULL)
480 extern const char *resolve_gitdir(const char *suspect);
481 extern void set_git_work_tree(const char *tree);
482
483 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
484
485 extern const char **get_pathspec(const char *prefix, const char **pathspec);
486 extern void setup_work_tree(void);
487 extern const char *setup_git_directory_gently(int *);
488 extern const char *setup_git_directory(void);
489 extern char *prefix_path(const char *prefix, int len, const char *path);
490 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
491 extern const char *prefix_filename(const char *prefix, int len, const char *path);
492 extern int check_filename(const char *prefix, const char *name);
493 extern void verify_filename(const char *prefix,
494                             const char *name,
495                             int diagnose_misspelt_rev);
496 extern void verify_non_filename(const char *prefix, const char *name);
497 extern int path_inside_repo(const char *prefix, const char *path);
498
499 #define INIT_DB_QUIET 0x0001
500
501 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
502 extern int init_db(const char *template_dir, unsigned int flags);
503
504 extern void sanitize_stdfds(void);
505 extern int daemonize(void);
506
507 #define alloc_nr(x) (((x)+16)*3/2)
508
509 /*
510  * Realloc the buffer pointed at by variable 'x' so that it can hold
511  * at least 'nr' entries; the number of entries currently allocated
512  * is 'alloc', using the standard growing factor alloc_nr() macro.
513  *
514  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
515  */
516 #define ALLOC_GROW(x, nr, alloc) \
517         do { \
518                 if ((nr) > alloc) { \
519                         if (alloc_nr(alloc) < (nr)) \
520                                 alloc = (nr); \
521                         else \
522                                 alloc = alloc_nr(alloc); \
523                         REALLOC_ARRAY(x, alloc); \
524                 } \
525         } while (0)
526
527 /* Initialize and use the cache information */
528 struct lock_file;
529 extern int read_index(struct index_state *);
530 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
531 extern int do_read_index(struct index_state *istate, const char *path,
532                          int must_exist); /* for testting only! */
533 extern int read_index_from(struct index_state *, const char *path);
534 extern int is_index_unborn(struct index_state *);
535 extern int read_index_unmerged(struct index_state *);
536 #define COMMIT_LOCK             (1 << 0)
537 #define CLOSE_LOCK              (1 << 1)
538 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
539 extern int discard_index(struct index_state *);
540 extern int unmerged_index(const struct index_state *);
541 extern int verify_path(const char *path);
542 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
543 extern void adjust_dirname_case(struct index_state *istate, char *name);
544 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
545 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
546 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
547 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
548 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
549 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
550 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
551 #define ADD_CACHE_KEEP_CACHE_TREE 32    /* Do not invalidate cache-tree */
552 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
553 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
554 extern int remove_index_entry_at(struct index_state *, int pos);
555 extern void remove_marked_cache_entries(struct index_state *istate);
556 extern int remove_file_from_index(struct index_state *, const char *path);
557 #define ADD_CACHE_VERBOSE 1
558 #define ADD_CACHE_PRETEND 2
559 #define ADD_CACHE_IGNORE_ERRORS 4
560 #define ADD_CACHE_IGNORE_REMOVAL 8
561 #define ADD_CACHE_INTENT 16
562 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
563 extern int add_file_to_index(struct index_state *, const char *path, int flags);
564 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
565 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
566 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
567 extern int index_name_is_other(const struct index_state *, const char *, int);
568 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
569
570 /* do stat comparison even if CE_VALID is true */
571 #define CE_MATCH_IGNORE_VALID           01
572 /* do not check the contents but report dirty on racily-clean entries */
573 #define CE_MATCH_RACY_IS_DIRTY          02
574 /* do stat comparison even if CE_SKIP_WORKTREE is true */
575 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
576 /* ignore non-existent files during stat update  */
577 #define CE_MATCH_IGNORE_MISSING         0x08
578 /* enable stat refresh */
579 #define CE_MATCH_REFRESH                0x10
580 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
581 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
582
583 #define HASH_WRITE_OBJECT 1
584 #define HASH_FORMAT_CHECK 2
585 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
586 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
587
588 /*
589  * Record to sd the data from st that we use to check whether a file
590  * might have changed.
591  */
592 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
593
594 /*
595  * Return 0 if st is consistent with a file not having been changed
596  * since sd was filled.  If there are differences, return a
597  * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
598  * INODE_CHANGED, and DATA_CHANGED.
599  */
600 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
601 extern int match_stat_data_racy(const struct index_state *istate,
602                                 const struct stat_data *sd, struct stat *st);
603
604 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
605
606 #define REFRESH_REALLY          0x0001  /* ignore_valid */
607 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
608 #define REFRESH_QUIET           0x0004  /* be quiet about it */
609 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
610 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
611 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
612 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
613
614 extern void update_index_if_able(struct index_state *, struct lock_file *);
615
616 extern int hold_locked_index(struct lock_file *, int);
617 extern void set_alternate_index_output(const char *);
618
619 /* Environment bits from configuration mechanism */
620 extern int trust_executable_bit;
621 extern int trust_ctime;
622 extern int check_stat;
623 extern int quote_path_fully;
624 extern int has_symlinks;
625 extern int minimum_abbrev, default_abbrev;
626 extern int ignore_case;
627 extern int assume_unchanged;
628 extern int prefer_symlink_refs;
629 extern int log_all_ref_updates;
630 extern int warn_ambiguous_refs;
631 extern int warn_on_object_refname_ambiguity;
632 extern int shared_repository;
633 extern const char *apply_default_whitespace;
634 extern const char *apply_default_ignorewhitespace;
635 extern const char *git_attributes_file;
636 extern int zlib_compression_level;
637 extern int core_compression_level;
638 extern int core_compression_seen;
639 extern size_t packed_git_window_size;
640 extern size_t packed_git_limit;
641 extern size_t delta_base_cache_limit;
642 extern unsigned long big_file_threshold;
643 extern unsigned long pack_size_limit_cfg;
644
645 /*
646  * Do replace refs need to be checked this run?  This variable is
647  * initialized to true unless --no-replace-object is used or
648  * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
649  * commands that do not want replace references to be active.  As an
650  * optimization it is also set to false if replace references have
651  * been sought but there were none.
652  */
653 extern int check_replace_refs;
654 extern char *git_replace_ref_base;
655
656 extern int fsync_object_files;
657 extern int core_preload_index;
658 extern int core_apply_sparse_checkout;
659 extern int precomposed_unicode;
660 extern int protect_hfs;
661 extern int protect_ntfs;
662 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
663
664 /*
665  * Include broken refs in all ref iterations, which will
666  * generally choke dangerous operations rather than letting
667  * them silently proceed without taking the broken ref into
668  * account.
669  */
670 extern int ref_paranoia;
671
672 /*
673  * The character that begins a commented line in user-editable file
674  * that is subject to stripspace.
675  */
676 extern char comment_line_char;
677 extern int auto_comment_line_char;
678
679 enum branch_track {
680         BRANCH_TRACK_UNSPECIFIED = -1,
681         BRANCH_TRACK_NEVER = 0,
682         BRANCH_TRACK_REMOTE,
683         BRANCH_TRACK_ALWAYS,
684         BRANCH_TRACK_EXPLICIT,
685         BRANCH_TRACK_OVERRIDE
686 };
687
688 enum rebase_setup_type {
689         AUTOREBASE_NEVER = 0,
690         AUTOREBASE_LOCAL,
691         AUTOREBASE_REMOTE,
692         AUTOREBASE_ALWAYS
693 };
694
695 enum push_default_type {
696         PUSH_DEFAULT_NOTHING = 0,
697         PUSH_DEFAULT_MATCHING,
698         PUSH_DEFAULT_SIMPLE,
699         PUSH_DEFAULT_UPSTREAM,
700         PUSH_DEFAULT_CURRENT,
701         PUSH_DEFAULT_UNSPECIFIED
702 };
703
704 extern enum branch_track git_branch_track;
705 extern enum rebase_setup_type autorebase;
706 extern enum push_default_type push_default;
707
708 enum object_creation_mode {
709         OBJECT_CREATION_USES_HARDLINKS = 0,
710         OBJECT_CREATION_USES_RENAMES = 1
711 };
712
713 extern enum object_creation_mode object_creation_mode;
714
715 extern char *notes_ref_name;
716
717 extern int grafts_replace_parents;
718
719 /*
720  * GIT_REPO_VERSION is the version we write by default. The
721  * _READ variant is the highest number we know how to
722  * handle.
723  */
724 #define GIT_REPO_VERSION 0
725 #define GIT_REPO_VERSION_READ 1
726 extern int repository_format_version;
727 extern int repository_format_precious_objects;
728 extern int check_repository_format(void);
729
730 #define MTIME_CHANGED   0x0001
731 #define CTIME_CHANGED   0x0002
732 #define OWNER_CHANGED   0x0004
733 #define MODE_CHANGED    0x0008
734 #define INODE_CHANGED   0x0010
735 #define DATA_CHANGED    0x0020
736 #define TYPE_CHANGED    0x0040
737
738 /*
739  * Return a statically allocated filename, either generically (mkpath), in
740  * the repository directory (git_path), or in a submodule's repository
741  * directory (git_path_submodule). In all cases, note that the result
742  * may be overwritten by another call to _any_ of the functions. Consider
743  * using the safer "dup" or "strbuf" formats below (in some cases, the
744  * unsafe versions have already been removed).
745  */
746 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
747 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
748
749 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
750         __attribute__((format (printf, 3, 4)));
751 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
752         __attribute__((format (printf, 2, 3)));
753 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
754         __attribute__((format (printf, 2, 3)));
755 extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
756                                       const char *fmt, ...)
757         __attribute__((format (printf, 3, 4)));
758 extern char *git_pathdup(const char *fmt, ...)
759         __attribute__((format (printf, 1, 2)));
760 extern char *mkpathdup(const char *fmt, ...)
761         __attribute__((format (printf, 1, 2)));
762 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
763         __attribute__((format (printf, 2, 3)));
764
765 extern void report_linked_checkout_garbage(void);
766
767 /*
768  * You can define a static memoized git path like:
769  *
770  *    static GIT_PATH_FUNC(git_path_foo, "FOO");
771  *
772  * or use one of the global ones below.
773  */
774 #define GIT_PATH_FUNC(func, filename) \
775         const char *func(void) \
776         { \
777                 static char *ret; \
778                 if (!ret) \
779                         ret = git_pathdup(filename); \
780                 return ret; \
781         }
782
783 const char *git_path_cherry_pick_head(void);
784 const char *git_path_revert_head(void);
785 const char *git_path_squash_msg(void);
786 const char *git_path_merge_msg(void);
787 const char *git_path_merge_rr(void);
788 const char *git_path_merge_mode(void);
789 const char *git_path_merge_head(void);
790 const char *git_path_fetch_head(void);
791 const char *git_path_shallow(void);
792
793 /*
794  * Return the name of the file in the local object database that would
795  * be used to store a loose object with the specified sha1.  The
796  * return value is a pointer to a statically allocated buffer that is
797  * overwritten each time the function is called.
798  */
799 extern const char *sha1_file_name(const unsigned char *sha1);
800
801 /*
802  * Return the name of the (local) packfile with the specified sha1 in
803  * its name.  The return value is a pointer to memory that is
804  * overwritten each time this function is called.
805  */
806 extern char *sha1_pack_name(const unsigned char *sha1);
807
808 /*
809  * Return the name of the (local) pack index file with the specified
810  * sha1 in its name.  The return value is a pointer to memory that is
811  * overwritten each time this function is called.
812  */
813 extern char *sha1_pack_index_name(const unsigned char *sha1);
814
815 /*
816  * Return an abbreviated sha1 unique within this repository's object database.
817  * The result will be at least `len` characters long, and will be NUL
818  * terminated.
819  *
820  * The non-`_r` version returns a static buffer which will be overwritten by
821  * subsequent calls.
822  *
823  * The `_r` variant writes to a buffer supplied by the caller, which must be at
824  * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
825  * written (excluding the NUL terminator).
826  *
827  * Note that while this version avoids the static buffer, it is not fully
828  * reentrant, as it calls into other non-reentrant git code.
829  */
830 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
831 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
832
833 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
834 extern const struct object_id null_oid;
835
836 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
837 {
838         int i;
839
840         for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
841                 if (*sha1 != *sha2)
842                         return *sha1 - *sha2;
843         }
844
845         return 0;
846 }
847
848 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
849 {
850         return hashcmp(oid1->hash, oid2->hash);
851 }
852
853 static inline int is_null_sha1(const unsigned char *sha1)
854 {
855         return !hashcmp(sha1, null_sha1);
856 }
857
858 static inline int is_null_oid(const struct object_id *oid)
859 {
860         return !hashcmp(oid->hash, null_sha1);
861 }
862
863 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
864 {
865         memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
866 }
867
868 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
869 {
870         hashcpy(dst->hash, src->hash);
871 }
872
873 static inline void hashclr(unsigned char *hash)
874 {
875         memset(hash, 0, GIT_SHA1_RAWSZ);
876 }
877
878 static inline void oidclr(struct object_id *oid)
879 {
880         hashclr(oid->hash);
881 }
882
883
884 #define EMPTY_TREE_SHA1_HEX \
885         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
886 #define EMPTY_TREE_SHA1_BIN_LITERAL \
887          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
888          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
889 #define EMPTY_TREE_SHA1_BIN \
890          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
891
892 #define EMPTY_BLOB_SHA1_HEX \
893         "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
894 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
895         "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
896         "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
897 #define EMPTY_BLOB_SHA1_BIN \
898         ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
899
900 static inline int is_empty_blob_sha1(const unsigned char *sha1)
901 {
902         return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
903 }
904
905 int git_mkstemp(char *path, size_t n, const char *template);
906
907 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
908
909 /* set default permissions by passing mode arguments to open(2) */
910 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
911 int git_mkstemp_mode(char *pattern, int mode);
912
913 /*
914  * NOTE NOTE NOTE!!
915  *
916  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
917  * not be changed. Old repositories have core.sharedrepository written in
918  * numeric format, and therefore these values are preserved for compatibility
919  * reasons.
920  */
921 enum sharedrepo {
922         PERM_UMASK          = 0,
923         OLD_PERM_GROUP      = 1,
924         OLD_PERM_EVERYBODY  = 2,
925         PERM_GROUP          = 0660,
926         PERM_EVERYBODY      = 0664
927 };
928 int git_config_perm(const char *var, const char *value);
929 int adjust_shared_perm(const char *path);
930
931 /*
932  * Create the directory containing the named path, using care to be
933  * somewhat safe against races.  Return one of the scld_error values
934  * to indicate success/failure.
935  *
936  * SCLD_VANISHED indicates that one of the ancestor directories of the
937  * path existed at one point during the function call and then
938  * suddenly vanished, probably because another process pruned the
939  * directory while we were working.  To be robust against this kind of
940  * race, callers might want to try invoking the function again when it
941  * returns SCLD_VANISHED.
942  */
943 enum scld_error {
944         SCLD_OK = 0,
945         SCLD_FAILED = -1,
946         SCLD_PERMS = -2,
947         SCLD_EXISTS = -3,
948         SCLD_VANISHED = -4
949 };
950 enum scld_error safe_create_leading_directories(char *path);
951 enum scld_error safe_create_leading_directories_const(const char *path);
952
953 int mkdir_in_gitdir(const char *path);
954 extern char *expand_user_path(const char *path);
955 const char *enter_repo(const char *path, int strict);
956 static inline int is_absolute_path(const char *path)
957 {
958         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
959 }
960 int is_directory(const char *);
961 const char *real_path(const char *path);
962 const char *real_path_if_valid(const char *path);
963 const char *absolute_path(const char *path);
964 const char *remove_leading_path(const char *in, const char *prefix);
965 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
966 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
967 int normalize_path_copy(char *dst, const char *src);
968 int longest_ancestor_length(const char *path, struct string_list *prefixes);
969 char *strip_path_suffix(const char *path, const char *suffix);
970 int daemon_avoid_alias(const char *path);
971 extern int is_ntfs_dotgit(const char *name);
972
973 /**
974  * Return a newly allocated string with the evaluation of
975  * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
976  * "$HOME/.config/git/$filename". Return NULL upon error.
977  */
978 extern char *xdg_config_home(const char *filename);
979
980 /* object replacement */
981 #define LOOKUP_REPLACE_OBJECT 1
982 #define LOOKUP_UNKNOWN_OBJECT 2
983 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
984 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
985 {
986         return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
987 }
988
989 /*
990  * This internal function is only declared here for the benefit of
991  * lookup_replace_object().  Please do not call it directly.
992  */
993 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
994
995 /*
996  * If object sha1 should be replaced, return the replacement object's
997  * name (replaced recursively, if necessary).  The return value is
998  * either sha1 or a pointer to a permanently-allocated value.  When
999  * object replacement is suppressed, always return sha1.
1000  */
1001 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1002 {
1003         if (!check_replace_refs)
1004                 return sha1;
1005         return do_lookup_replace_object(sha1);
1006 }
1007
1008 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1009 {
1010         if (!(flag & LOOKUP_REPLACE_OBJECT))
1011                 return sha1;
1012         return lookup_replace_object(sha1);
1013 }
1014
1015 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1016 extern int sha1_object_info(const unsigned char *, unsigned long *);
1017 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1018 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1019 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1020 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1021 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1022 extern int git_open_noatime(const char *name);
1023 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1024 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1025 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1026
1027 /* global flag to enable extra checks when accessing packed objects */
1028 extern int do_check_packed_object_crc;
1029
1030 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1031
1032 extern int finalize_object_file(const char *tmpfile, const char *filename);
1033
1034 extern int has_sha1_pack(const unsigned char *sha1);
1035
1036 /*
1037  * Return true iff we have an object named sha1, whether local or in
1038  * an alternate object database, and whether packed or loose.  This
1039  * function does not respect replace references.
1040  *
1041  * If the QUICK flag is set, do not re-check the pack directory
1042  * when we cannot find the object (this means we may give a false
1043  * negative answer if another process is simultaneously repacking).
1044  */
1045 #define HAS_SHA1_QUICK 0x1
1046 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1047 static inline int has_sha1_file(const unsigned char *sha1)
1048 {
1049         return has_sha1_file_with_flags(sha1, 0);
1050 }
1051
1052 /* Same as the above, except for struct object_id. */
1053 extern int has_object_file(const struct object_id *oid);
1054
1055 /*
1056  * Return true iff an alternate object database has a loose object
1057  * with the specified name.  This function does not respect replace
1058  * references.
1059  */
1060 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1061
1062 extern int has_pack_index(const unsigned char *sha1);
1063
1064 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1065
1066 extern const signed char hexval_table[256];
1067 static inline unsigned int hexval(unsigned char c)
1068 {
1069         return hexval_table[c];
1070 }
1071
1072 /* Convert to/from hex/sha1 representation */
1073 #define MINIMUM_ABBREV minimum_abbrev
1074 #define DEFAULT_ABBREV default_abbrev
1075
1076 struct object_context {
1077         unsigned char tree[20];
1078         char path[PATH_MAX];
1079         unsigned mode;
1080         /*
1081          * symlink_path is only used by get_tree_entry_follow_symlinks,
1082          * and only for symlinks that point outside the repository.
1083          */
1084         struct strbuf symlink_path;
1085 };
1086
1087 #define GET_SHA1_QUIETLY           01
1088 #define GET_SHA1_COMMIT            02
1089 #define GET_SHA1_COMMITTISH        04
1090 #define GET_SHA1_TREE             010
1091 #define GET_SHA1_TREEISH          020
1092 #define GET_SHA1_BLOB             040
1093 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1094 #define GET_SHA1_ONLY_TO_DIE    04000
1095
1096 extern int get_sha1(const char *str, unsigned char *sha1);
1097 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1098 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1099 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1100 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1101 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1102 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1103 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1104
1105 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1106 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1107
1108 /*
1109  * Try to read a SHA1 in hexadecimal format from the 40 characters
1110  * starting at hex.  Write the 20-byte result to sha1 in binary form.
1111  * Return 0 on success.  Reading stops if a NUL is encountered in the
1112  * input, so it is safe to pass this function an arbitrary
1113  * null-terminated string.
1114  */
1115 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1116 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1117
1118 /*
1119  * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1120  * and writes the NUL-terminated output to the buffer `out`, which must be at
1121  * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1122  * convenience.
1123  *
1124  * The non-`_r` variant returns a static buffer, but uses a ring of 4
1125  * buffers, making it safe to make multiple calls for a single statement, like:
1126  *
1127  *   printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1128  */
1129 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1130 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
1131 extern char *oid_to_hex(const struct object_id *oid);   /* same static buffer as sha1_to_hex */
1132
1133 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1134 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1135
1136 extern int validate_headref(const char *ref);
1137
1138 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1139 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1140 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1141 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1142
1143 extern void *read_object_with_reference(const unsigned char *sha1,
1144                                         const char *required_type,
1145                                         unsigned long *size,
1146                                         unsigned char *sha1_ret);
1147
1148 extern struct object *peel_to_type(const char *name, int namelen,
1149                                    struct object *o, enum object_type);
1150
1151 struct date_mode {
1152         enum date_mode_type {
1153                 DATE_NORMAL = 0,
1154                 DATE_RELATIVE,
1155                 DATE_SHORT,
1156                 DATE_ISO8601,
1157                 DATE_ISO8601_STRICT,
1158                 DATE_RFC2822,
1159                 DATE_STRFTIME,
1160                 DATE_RAW
1161         } type;
1162         const char *strftime_fmt;
1163         int local;
1164 };
1165
1166 /*
1167  * Convenience helper for passing a constant type, like:
1168  *
1169  *   show_date(t, tz, DATE_MODE(NORMAL));
1170  */
1171 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1172 struct date_mode *date_mode_from_type(enum date_mode_type type);
1173
1174 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1175 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1176                         struct strbuf *timebuf);
1177 int parse_date(const char *date, struct strbuf *out);
1178 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1179 int parse_expiry_date(const char *date, unsigned long *timestamp);
1180 void datestamp(struct strbuf *out);
1181 #define approxidate(s) approxidate_careful((s), NULL)
1182 unsigned long approxidate_careful(const char *, int *);
1183 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1184 void parse_date_format(const char *format, struct date_mode *mode);
1185 int date_overflows(unsigned long date);
1186
1187 #define IDENT_STRICT           1
1188 #define IDENT_NO_DATE          2
1189 #define IDENT_NO_NAME          4
1190 extern const char *git_author_info(int);
1191 extern const char *git_committer_info(int);
1192 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1193 extern const char *fmt_name(const char *name, const char *email);
1194 extern const char *ident_default_name(void);
1195 extern const char *ident_default_email(void);
1196 extern const char *git_editor(void);
1197 extern const char *git_pager(int stdout_is_tty);
1198 extern int git_ident_config(const char *, const char *, void *);
1199
1200 struct ident_split {
1201         const char *name_begin;
1202         const char *name_end;
1203         const char *mail_begin;
1204         const char *mail_end;
1205         const char *date_begin;
1206         const char *date_end;
1207         const char *tz_begin;
1208         const char *tz_end;
1209 };
1210 /*
1211  * Signals an success with 0, but time part of the result may be NULL
1212  * if the input lacks timestamp and zone
1213  */
1214 extern int split_ident_line(struct ident_split *, const char *, int);
1215
1216 /*
1217  * Like show_date, but pull the timestamp and tz parameters from
1218  * the ident_split. It will also sanity-check the values and produce
1219  * a well-known sentinel date if they appear bogus.
1220  */
1221 const char *show_ident_date(const struct ident_split *id,
1222                             const struct date_mode *mode);
1223
1224 /*
1225  * Compare split idents for equality or strict ordering. Note that we
1226  * compare only the ident part of the line, ignoring any timestamp.
1227  *
1228  * Because there are two fields, we must choose one as the primary key; we
1229  * currently arbitrarily pick the email.
1230  */
1231 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1232
1233 struct checkout {
1234         struct index_state *istate;
1235         const char *base_dir;
1236         int base_dir_len;
1237         unsigned force:1,
1238                  quiet:1,
1239                  not_new:1,
1240                  refresh_cache:1;
1241 };
1242
1243 #define TEMPORARY_FILENAME_LENGTH 25
1244 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1245
1246 struct cache_def {
1247         struct strbuf path;
1248         int flags;
1249         int track_flags;
1250         int prefix_len_stat_func;
1251 };
1252 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1253 static inline void cache_def_clear(struct cache_def *cache)
1254 {
1255         strbuf_release(&cache->path);
1256 }
1257
1258 extern int has_symlink_leading_path(const char *name, int len);
1259 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1260 extern int check_leading_path(const char *name, int len);
1261 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1262 extern void schedule_dir_for_removal(const char *name, int len);
1263 extern void remove_scheduled_dirs(void);
1264
1265 extern struct alternate_object_database {
1266         struct alternate_object_database *next;
1267         char *name;
1268         char base[FLEX_ARRAY]; /* more */
1269 } *alt_odb_list;
1270 extern void prepare_alt_odb(void);
1271 extern void read_info_alternates(const char * relative_base, int depth);
1272 extern void add_to_alternates_file(const char *reference);
1273 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1274 extern int foreach_alt_odb(alt_odb_fn, void*);
1275
1276 struct pack_window {
1277         struct pack_window *next;
1278         unsigned char *base;
1279         off_t offset;
1280         size_t len;
1281         unsigned int last_used;
1282         unsigned int inuse_cnt;
1283 };
1284
1285 extern struct packed_git {
1286         struct packed_git *next;
1287         struct pack_window *windows;
1288         off_t pack_size;
1289         const void *index_data;
1290         size_t index_size;
1291         uint32_t num_objects;
1292         uint32_t num_bad_objects;
1293         unsigned char *bad_object_sha1;
1294         int index_version;
1295         time_t mtime;
1296         int pack_fd;
1297         unsigned pack_local:1,
1298                  pack_keep:1,
1299                  freshened:1,
1300                  do_not_close:1;
1301         unsigned char sha1[20];
1302         /* something like ".git/objects/pack/xxxxx.pack" */
1303         char pack_name[FLEX_ARRAY]; /* more */
1304 } *packed_git;
1305
1306 struct pack_entry {
1307         off_t offset;
1308         unsigned char sha1[20];
1309         struct packed_git *p;
1310 };
1311
1312 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1313
1314 /* A hook to report invalid files in pack directory */
1315 #define PACKDIR_FILE_PACK 1
1316 #define PACKDIR_FILE_IDX 2
1317 #define PACKDIR_FILE_GARBAGE 4
1318 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1319
1320 extern void prepare_packed_git(void);
1321 extern void reprepare_packed_git(void);
1322 extern void install_packed_git(struct packed_git *pack);
1323
1324 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1325                                          struct packed_git *packs);
1326
1327 extern void pack_report(void);
1328
1329 /*
1330  * mmap the index file for the specified packfile (if it is not
1331  * already mmapped).  Return 0 on success.
1332  */
1333 extern int open_pack_index(struct packed_git *);
1334
1335 /*
1336  * munmap the index file for the specified packfile (if it is
1337  * currently mmapped).
1338  */
1339 extern void close_pack_index(struct packed_git *);
1340
1341 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1342 extern void close_pack_windows(struct packed_git *);
1343 extern void close_all_packs(void);
1344 extern void unuse_pack(struct pack_window **);
1345 extern void free_pack_by_name(const char *);
1346 extern void clear_delta_base_cache(void);
1347 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1348
1349 /*
1350  * Return the SHA-1 of the nth object within the specified packfile.
1351  * Open the index if it is not already open.  The return value points
1352  * at the SHA-1 within the mmapped index.  Return NULL if there is an
1353  * error.
1354  */
1355 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1356
1357 /*
1358  * Return the offset of the nth object within the specified packfile.
1359  * The index must already be opened.
1360  */
1361 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1362
1363 /*
1364  * If the object named sha1 is present in the specified packfile,
1365  * return its offset within the packfile; otherwise, return 0.
1366  */
1367 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1368
1369 extern int is_pack_valid(struct packed_git *);
1370 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1371 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1372 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1373 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1374
1375 /*
1376  * Iterate over the files in the loose-object parts of the object
1377  * directory "path", triggering the following callbacks:
1378  *
1379  *  - loose_object is called for each loose object we find.
1380  *
1381  *  - loose_cruft is called for any files that do not appear to be
1382  *    loose objects. Note that we only look in the loose object
1383  *    directories "objects/[0-9a-f]{2}/", so we will not report
1384  *    "objects/foobar" as cruft.
1385  *
1386  *  - loose_subdir is called for each top-level hashed subdirectory
1387  *    of the object directory (e.g., "$OBJDIR/f0"). It is called
1388  *    after the objects in the directory are processed.
1389  *
1390  * Any callback that is NULL will be ignored. Callbacks returning non-zero
1391  * will end the iteration.
1392  *
1393  * In the "buf" variant, "path" is a strbuf which will also be used as a
1394  * scratch buffer, but restored to its original contents before
1395  * the function returns.
1396  */
1397 typedef int each_loose_object_fn(const unsigned char *sha1,
1398                                  const char *path,
1399                                  void *data);
1400 typedef int each_loose_cruft_fn(const char *basename,
1401                                 const char *path,
1402                                 void *data);
1403 typedef int each_loose_subdir_fn(int nr,
1404                                  const char *path,
1405                                  void *data);
1406 int for_each_loose_file_in_objdir(const char *path,
1407                                   each_loose_object_fn obj_cb,
1408                                   each_loose_cruft_fn cruft_cb,
1409                                   each_loose_subdir_fn subdir_cb,
1410                                   void *data);
1411 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1412                                       each_loose_object_fn obj_cb,
1413                                       each_loose_cruft_fn cruft_cb,
1414                                       each_loose_subdir_fn subdir_cb,
1415                                       void *data);
1416
1417 /*
1418  * Iterate over loose and packed objects in both the local
1419  * repository and any alternates repositories (unless the
1420  * LOCAL_ONLY flag is set).
1421  */
1422 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1423 typedef int each_packed_object_fn(const unsigned char *sha1,
1424                                   struct packed_git *pack,
1425                                   uint32_t pos,
1426                                   void *data);
1427 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1428 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1429
1430 struct object_info {
1431         /* Request */
1432         enum object_type *typep;
1433         unsigned long *sizep;
1434         unsigned long *disk_sizep;
1435         unsigned char *delta_base_sha1;
1436         struct strbuf *typename;
1437
1438         /* Response */
1439         enum {
1440                 OI_CACHED,
1441                 OI_LOOSE,
1442                 OI_PACKED,
1443                 OI_DBCACHED
1444         } whence;
1445         union {
1446                 /*
1447                  * struct {
1448                  *      ... Nothing to expose in this case
1449                  * } cached;
1450                  * struct {
1451                  *      ... Nothing to expose in this case
1452                  * } loose;
1453                  */
1454                 struct {
1455                         struct packed_git *pack;
1456                         off_t offset;
1457                         unsigned int is_delta;
1458                 } packed;
1459         } u;
1460 };
1461 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1462
1463 /* Dumb servers support */
1464 extern int update_server_info(int);
1465
1466 /* git_config_parse_key() returns these negated: */
1467 #define CONFIG_INVALID_KEY 1
1468 #define CONFIG_NO_SECTION_OR_NAME 2
1469 /* git_config_set(), git_config_set_multivar() return the above or these: */
1470 #define CONFIG_NO_LOCK -1
1471 #define CONFIG_INVALID_FILE 3
1472 #define CONFIG_NO_WRITE 4
1473 #define CONFIG_NOTHING_SET 5
1474 #define CONFIG_INVALID_PATTERN 6
1475 #define CONFIG_GENERIC_ERROR 7
1476
1477 #define CONFIG_REGEX_NONE ((void *)1)
1478
1479 struct git_config_source {
1480         unsigned int use_stdin:1;
1481         const char *file;
1482         const char *blob;
1483 };
1484
1485 typedef int (*config_fn_t)(const char *, const char *, void *);
1486 extern int git_default_config(const char *, const char *, void *);
1487 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1488 extern int git_config_from_buf(config_fn_t fn, const char *name,
1489                                const char *buf, size_t len, void *data);
1490 extern void git_config_push_parameter(const char *text);
1491 extern int git_config_from_parameters(config_fn_t fn, void *data);
1492 extern void git_config(config_fn_t fn, void *);
1493 extern int git_config_with_options(config_fn_t fn, void *,
1494                                    struct git_config_source *config_source,
1495                                    int respect_includes);
1496 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1497 extern int git_parse_ulong(const char *, unsigned long *);
1498 extern int git_parse_maybe_bool(const char *);
1499 extern int git_config_int(const char *, const char *);
1500 extern int64_t git_config_int64(const char *, const char *);
1501 extern unsigned long git_config_ulong(const char *, const char *);
1502 extern int git_config_bool_or_int(const char *, const char *, int *);
1503 extern int git_config_bool(const char *, const char *);
1504 extern int git_config_maybe_bool(const char *, const char *);
1505 extern int git_config_string(const char **, const char *, const char *);
1506 extern int git_config_pathname(const char **, const char *, const char *);
1507 extern int git_config_set_in_file(const char *, const char *, const char *);
1508 extern int git_config_set(const char *, const char *);
1509 extern int git_config_parse_key(const char *, char **, int *);
1510 extern int git_config_key_is_valid(const char *key);
1511 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1512 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1513 extern int git_config_rename_section(const char *, const char *);
1514 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1515 extern const char *git_etc_gitconfig(void);
1516 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1517 extern int git_env_bool(const char *, int);
1518 extern unsigned long git_env_ulong(const char *, unsigned long);
1519 extern int git_config_system(void);
1520 extern int config_error_nonbool(const char *);
1521 #if defined(__GNUC__)
1522 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1523 #endif
1524 extern const char *get_log_output_encoding(void);
1525 extern const char *get_commit_output_encoding(void);
1526
1527 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1528
1529 struct config_include_data {
1530         int depth;
1531         config_fn_t fn;
1532         void *data;
1533 };
1534 #define CONFIG_INCLUDE_INIT { 0 }
1535 extern int git_config_include(const char *name, const char *value, void *data);
1536
1537 /*
1538  * Match and parse a config key of the form:
1539  *
1540  *   section.(subsection.)?key
1541  *
1542  * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1543  * we return -1 if it does not match, 0 otherwise. The subsection and key
1544  * out-parameters are filled by the function (and subsection is NULL if it is
1545  * missing).
1546  */
1547 extern int parse_config_key(const char *var,
1548                             const char *section,
1549                             const char **subsection, int *subsection_len,
1550                             const char **key);
1551
1552 struct config_set_element {
1553         struct hashmap_entry ent;
1554         char *key;
1555         struct string_list value_list;
1556 };
1557
1558 struct configset_list_item {
1559         struct config_set_element *e;
1560         int value_index;
1561 };
1562
1563 /*
1564  * the contents of the list are ordered according to their
1565  * position in the config files and order of parsing the files.
1566  * (i.e. key-value pair at the last position of .git/config will
1567  * be at the last item of the list)
1568  */
1569 struct configset_list {
1570         struct configset_list_item *items;
1571         unsigned int nr, alloc;
1572 };
1573
1574 struct config_set {
1575         struct hashmap config_hash;
1576         int hash_initialized;
1577         struct configset_list list;
1578 };
1579
1580 extern void git_configset_init(struct config_set *cs);
1581 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1582 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1583 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1584 extern void git_configset_clear(struct config_set *cs);
1585 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1586 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1587 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1588 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1589 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1590 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1591 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1592 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1593
1594 extern int git_config_get_value(const char *key, const char **value);
1595 extern const struct string_list *git_config_get_value_multi(const char *key);
1596 extern void git_config_clear(void);
1597 extern void git_config_iter(config_fn_t fn, void *data);
1598 extern int git_config_get_string_const(const char *key, const char **dest);
1599 extern int git_config_get_string(const char *key, char **dest);
1600 extern int git_config_get_int(const char *key, int *dest);
1601 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1602 extern int git_config_get_bool(const char *key, int *dest);
1603 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1604 extern int git_config_get_maybe_bool(const char *key, int *dest);
1605 extern int git_config_get_pathname(const char *key, const char **dest);
1606
1607 struct key_value_info {
1608         const char *filename;
1609         int linenr;
1610 };
1611
1612 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1613 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1614
1615 extern int committer_ident_sufficiently_given(void);
1616 extern int author_ident_sufficiently_given(void);
1617
1618 extern const char *git_commit_encoding;
1619 extern const char *git_log_output_encoding;
1620 extern const char *git_mailmap_file;
1621 extern const char *git_mailmap_blob;
1622
1623 /* IO helper functions */
1624 extern void maybe_flush_or_die(FILE *, const char *);
1625 __attribute__((format (printf, 2, 3)))
1626 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1627
1628 #define COPY_READ_ERROR (-2)
1629 #define COPY_WRITE_ERROR (-3)
1630 extern int copy_fd(int ifd, int ofd);
1631 extern int copy_file(const char *dst, const char *src, int mode);
1632 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1633
1634 extern void write_or_die(int fd, const void *buf, size_t count);
1635 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1636 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1637 extern void fsync_or_die(int fd, const char *);
1638
1639 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1640 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1641 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1642
1643 static inline ssize_t write_str_in_full(int fd, const char *str)
1644 {
1645         return write_in_full(fd, str, strlen(str));
1646 }
1647
1648 extern int write_file(const char *path, const char *fmt, ...);
1649 extern int write_file_gently(const char *path, const char *fmt, ...);
1650
1651 /* pager.c */
1652 extern void setup_pager(void);
1653 extern const char *pager_program;
1654 extern int pager_in_use(void);
1655 extern int pager_use_color;
1656 extern int term_columns(void);
1657 extern int decimal_width(uintmax_t);
1658 extern int check_pager_config(const char *cmd);
1659
1660 extern const char *editor_program;
1661 extern const char *askpass_program;
1662 extern const char *excludes_file;
1663
1664 /* base85 */
1665 int decode_85(char *dst, const char *line, int linelen);
1666 void encode_85(char *buf, const unsigned char *data, int bytes);
1667
1668 /* alloc.c */
1669 extern void *alloc_blob_node(void);
1670 extern void *alloc_tree_node(void);
1671 extern void *alloc_commit_node(void);
1672 extern void *alloc_tag_node(void);
1673 extern void *alloc_object_node(void);
1674 extern void alloc_report(void);
1675 extern unsigned int alloc_commit_index(void);
1676
1677 /* pkt-line.c */
1678 void packet_trace_identity(const char *prog);
1679
1680 /* add */
1681 /*
1682  * return 0 if success, 1 - if addition of a file failed and
1683  * ADD_FILES_IGNORE_ERRORS was specified in flags
1684  */
1685 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1686
1687 /* diff.c */
1688 extern int diff_auto_refresh_index;
1689
1690 /* match-trees.c */
1691 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1692 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1693
1694 /*
1695  * whitespace rules.
1696  * used by both diff and apply
1697  * last two digits are tab width
1698  */
1699 #define WS_BLANK_AT_EOL         0100
1700 #define WS_SPACE_BEFORE_TAB     0200
1701 #define WS_INDENT_WITH_NON_TAB  0400
1702 #define WS_CR_AT_EOL           01000
1703 #define WS_BLANK_AT_EOF        02000
1704 #define WS_TAB_IN_INDENT       04000
1705 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1706 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1707 #define WS_TAB_WIDTH_MASK        077
1708 extern unsigned whitespace_rule_cfg;
1709 extern unsigned whitespace_rule(const char *);
1710 extern unsigned parse_whitespace_rule(const char *);
1711 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1712 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1713 extern char *whitespace_error_string(unsigned ws);
1714 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1715 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1716 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1717
1718 /* ls-files */
1719 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1720
1721 char *alias_lookup(const char *alias);
1722 int split_cmdline(char *cmdline, const char ***argv);
1723 /* Takes a negative value returned by split_cmdline */
1724 const char *split_cmdline_strerror(int cmdline_errno);
1725
1726 /* git.c */
1727 struct startup_info {
1728         int have_repository;
1729         const char *prefix;
1730 };
1731 extern struct startup_info *startup_info;
1732
1733 /* merge.c */
1734 struct commit_list;
1735 int try_merge_command(const char *strategy, size_t xopts_nr,
1736                 const char **xopts, struct commit_list *common,
1737                 const char *head_arg, struct commit_list *remotes);
1738 int checkout_fast_forward(const unsigned char *from,
1739                           const unsigned char *to,
1740                           int overwrite_ignore);
1741
1742
1743 int sane_execvp(const char *file, char *const argv[]);
1744
1745 /*
1746  * A struct to encapsulate the concept of whether a file has changed
1747  * since we last checked it. This uses criteria similar to those used
1748  * for the index.
1749  */
1750 struct stat_validity {
1751         struct stat_data *sd;
1752 };
1753
1754 void stat_validity_clear(struct stat_validity *sv);
1755
1756 /*
1757  * Returns 1 if the path is a regular file (or a symlink to a regular
1758  * file) and matches the saved stat_validity, 0 otherwise.  A missing
1759  * or inaccessible file is considered a match if the struct was just
1760  * initialized, or if the previous update found an inaccessible file.
1761  */
1762 int stat_validity_check(struct stat_validity *sv, const char *path);
1763
1764 /*
1765  * Update the stat_validity from a file opened at descriptor fd. If
1766  * the file is missing, inaccessible, or not a regular file, then
1767  * future calls to stat_validity_check will match iff one of those
1768  * conditions continues to be true.
1769  */
1770 void stat_validity_update(struct stat_validity *sv, int fd);
1771
1772 int versioncmp(const char *s1, const char *s2);
1773 void sleep_millisec(int millisec);
1774
1775 /*
1776  * Create a directory and (if share is nonzero) adjust its permissions
1777  * according to the shared_repository setting. Only use this for
1778  * directories under $GIT_DIR.  Don't use it for working tree
1779  * directories.
1780  */
1781 void safe_create_dir(const char *dir, int share);
1782
1783 #endif /* CACHE_H */