convert trivial cases to ALLOC_ARRAY
[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         (1U << 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 char *get_object_directory(void);
460 extern char *get_index_file(void);
461 extern char *get_graft_file(void);
462 extern int set_git_dir(const char *path);
463 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
464 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
465 extern const char *get_git_namespace(void);
466 extern const char *strip_namespace(const char *namespaced_ref);
467 extern const char *get_git_work_tree(void);
468
469 /*
470  * Return true if the given path is a git directory; note that this _just_
471  * looks at the directory itself. If you want to know whether "foo/.git"
472  * is a repository, you must feed that path, not just "foo".
473  */
474 extern int is_git_directory(const char *path);
475
476 /*
477  * Return 1 if the given path is the root of a git repository or
478  * submodule, else 0. Will not return 1 for bare repositories with the
479  * exception of creating a bare repository in "foo/.git" and calling
480  * is_git_repository("foo").
481  *
482  * If we run into read errors, we err on the side of saying "yes, it is",
483  * as we usually consider sub-repos precious, and would prefer to err on the
484  * side of not disrupting or deleting them.
485  */
486 extern int is_nonbare_repository_dir(struct strbuf *path);
487
488 #define READ_GITFILE_ERR_STAT_FAILED 1
489 #define READ_GITFILE_ERR_NOT_A_FILE 2
490 #define READ_GITFILE_ERR_OPEN_FAILED 3
491 #define READ_GITFILE_ERR_READ_FAILED 4
492 #define READ_GITFILE_ERR_INVALID_FORMAT 5
493 #define READ_GITFILE_ERR_NO_PATH 6
494 #define READ_GITFILE_ERR_NOT_A_REPO 7
495 #define READ_GITFILE_ERR_TOO_LARGE 8
496 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
497 #define read_gitfile(path) read_gitfile_gently((path), NULL)
498 extern const char *resolve_gitdir(const char *suspect);
499 extern void set_git_work_tree(const char *tree);
500
501 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
502
503 extern const char **get_pathspec(const char *prefix, const char **pathspec);
504 extern void setup_work_tree(void);
505 extern const char *setup_git_directory_gently(int *);
506 extern const char *setup_git_directory(void);
507 extern char *prefix_path(const char *prefix, int len, const char *path);
508 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
509 extern const char *prefix_filename(const char *prefix, int len, const char *path);
510 extern int check_filename(const char *prefix, const char *name);
511 extern void verify_filename(const char *prefix,
512                             const char *name,
513                             int diagnose_misspelt_rev);
514 extern void verify_non_filename(const char *prefix, const char *name);
515 extern int path_inside_repo(const char *prefix, const char *path);
516
517 #define INIT_DB_QUIET 0x0001
518
519 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
520 extern int init_db(const char *template_dir, unsigned int flags);
521
522 extern void sanitize_stdfds(void);
523 extern int daemonize(void);
524
525 #define alloc_nr(x) (((x)+16)*3/2)
526
527 /*
528  * Realloc the buffer pointed at by variable 'x' so that it can hold
529  * at least 'nr' entries; the number of entries currently allocated
530  * is 'alloc', using the standard growing factor alloc_nr() macro.
531  *
532  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
533  */
534 #define ALLOC_GROW(x, nr, alloc) \
535         do { \
536                 if ((nr) > alloc) { \
537                         if (alloc_nr(alloc) < (nr)) \
538                                 alloc = (nr); \
539                         else \
540                                 alloc = alloc_nr(alloc); \
541                         REALLOC_ARRAY(x, alloc); \
542                 } \
543         } while (0)
544
545 /* Initialize and use the cache information */
546 struct lock_file;
547 extern int read_index(struct index_state *);
548 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
549 extern int do_read_index(struct index_state *istate, const char *path,
550                          int must_exist); /* for testting only! */
551 extern int read_index_from(struct index_state *, const char *path);
552 extern int is_index_unborn(struct index_state *);
553 extern int read_index_unmerged(struct index_state *);
554 #define COMMIT_LOCK             (1 << 0)
555 #define CLOSE_LOCK              (1 << 1)
556 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
557 extern int discard_index(struct index_state *);
558 extern int unmerged_index(const struct index_state *);
559 extern int verify_path(const char *path);
560 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
561 extern void adjust_dirname_case(struct index_state *istate, char *name);
562 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
563 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
564 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
565 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
566 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
567 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
568 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
569 #define ADD_CACHE_KEEP_CACHE_TREE 32    /* Do not invalidate cache-tree */
570 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
571 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
572 extern int remove_index_entry_at(struct index_state *, int pos);
573 extern void remove_marked_cache_entries(struct index_state *istate);
574 extern int remove_file_from_index(struct index_state *, const char *path);
575 #define ADD_CACHE_VERBOSE 1
576 #define ADD_CACHE_PRETEND 2
577 #define ADD_CACHE_IGNORE_ERRORS 4
578 #define ADD_CACHE_IGNORE_REMOVAL 8
579 #define ADD_CACHE_INTENT 16
580 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
581 extern int add_file_to_index(struct index_state *, const char *path, int flags);
582 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
583 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
584 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
585 extern int index_name_is_other(const struct index_state *, const char *, int);
586 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
587
588 /* do stat comparison even if CE_VALID is true */
589 #define CE_MATCH_IGNORE_VALID           01
590 /* do not check the contents but report dirty on racily-clean entries */
591 #define CE_MATCH_RACY_IS_DIRTY          02
592 /* do stat comparison even if CE_SKIP_WORKTREE is true */
593 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
594 /* ignore non-existent files during stat update  */
595 #define CE_MATCH_IGNORE_MISSING         0x08
596 /* enable stat refresh */
597 #define CE_MATCH_REFRESH                0x10
598 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
599 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
600
601 #define HASH_WRITE_OBJECT 1
602 #define HASH_FORMAT_CHECK 2
603 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
604 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
605
606 /*
607  * Record to sd the data from st that we use to check whether a file
608  * might have changed.
609  */
610 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
611
612 /*
613  * Return 0 if st is consistent with a file not having been changed
614  * since sd was filled.  If there are differences, return a
615  * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
616  * INODE_CHANGED, and DATA_CHANGED.
617  */
618 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
619 extern int match_stat_data_racy(const struct index_state *istate,
620                                 const struct stat_data *sd, struct stat *st);
621
622 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
623
624 #define REFRESH_REALLY          0x0001  /* ignore_valid */
625 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
626 #define REFRESH_QUIET           0x0004  /* be quiet about it */
627 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
628 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
629 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
630 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
631
632 extern void update_index_if_able(struct index_state *, struct lock_file *);
633
634 extern int hold_locked_index(struct lock_file *, int);
635 extern void set_alternate_index_output(const char *);
636
637 /* Environment bits from configuration mechanism */
638 extern int trust_executable_bit;
639 extern int trust_ctime;
640 extern int check_stat;
641 extern int quote_path_fully;
642 extern int has_symlinks;
643 extern int minimum_abbrev, default_abbrev;
644 extern int ignore_case;
645 extern int assume_unchanged;
646 extern int prefer_symlink_refs;
647 extern int log_all_ref_updates;
648 extern int warn_ambiguous_refs;
649 extern int warn_on_object_refname_ambiguity;
650 extern int shared_repository;
651 extern const char *apply_default_whitespace;
652 extern const char *apply_default_ignorewhitespace;
653 extern const char *git_attributes_file;
654 extern int zlib_compression_level;
655 extern int core_compression_level;
656 extern int core_compression_seen;
657 extern size_t packed_git_window_size;
658 extern size_t packed_git_limit;
659 extern size_t delta_base_cache_limit;
660 extern unsigned long big_file_threshold;
661 extern unsigned long pack_size_limit_cfg;
662
663 /*
664  * Do replace refs need to be checked this run?  This variable is
665  * initialized to true unless --no-replace-object is used or
666  * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
667  * commands that do not want replace references to be active.  As an
668  * optimization it is also set to false if replace references have
669  * been sought but there were none.
670  */
671 extern int check_replace_refs;
672 extern char *git_replace_ref_base;
673
674 extern int fsync_object_files;
675 extern int core_preload_index;
676 extern int core_apply_sparse_checkout;
677 extern int precomposed_unicode;
678 extern int protect_hfs;
679 extern int protect_ntfs;
680 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
681
682 /*
683  * Include broken refs in all ref iterations, which will
684  * generally choke dangerous operations rather than letting
685  * them silently proceed without taking the broken ref into
686  * account.
687  */
688 extern int ref_paranoia;
689
690 /*
691  * The character that begins a commented line in user-editable file
692  * that is subject to stripspace.
693  */
694 extern char comment_line_char;
695 extern int auto_comment_line_char;
696
697 enum branch_track {
698         BRANCH_TRACK_UNSPECIFIED = -1,
699         BRANCH_TRACK_NEVER = 0,
700         BRANCH_TRACK_REMOTE,
701         BRANCH_TRACK_ALWAYS,
702         BRANCH_TRACK_EXPLICIT,
703         BRANCH_TRACK_OVERRIDE
704 };
705
706 enum rebase_setup_type {
707         AUTOREBASE_NEVER = 0,
708         AUTOREBASE_LOCAL,
709         AUTOREBASE_REMOTE,
710         AUTOREBASE_ALWAYS
711 };
712
713 enum push_default_type {
714         PUSH_DEFAULT_NOTHING = 0,
715         PUSH_DEFAULT_MATCHING,
716         PUSH_DEFAULT_SIMPLE,
717         PUSH_DEFAULT_UPSTREAM,
718         PUSH_DEFAULT_CURRENT,
719         PUSH_DEFAULT_UNSPECIFIED
720 };
721
722 extern enum branch_track git_branch_track;
723 extern enum rebase_setup_type autorebase;
724 extern enum push_default_type push_default;
725
726 enum object_creation_mode {
727         OBJECT_CREATION_USES_HARDLINKS = 0,
728         OBJECT_CREATION_USES_RENAMES = 1
729 };
730
731 extern enum object_creation_mode object_creation_mode;
732
733 extern char *notes_ref_name;
734
735 extern int grafts_replace_parents;
736
737 /*
738  * GIT_REPO_VERSION is the version we write by default. The
739  * _READ variant is the highest number we know how to
740  * handle.
741  */
742 #define GIT_REPO_VERSION 0
743 #define GIT_REPO_VERSION_READ 1
744 extern int repository_format_version;
745 extern int repository_format_precious_objects;
746 extern int check_repository_format(void);
747
748 #define MTIME_CHANGED   0x0001
749 #define CTIME_CHANGED   0x0002
750 #define OWNER_CHANGED   0x0004
751 #define MODE_CHANGED    0x0008
752 #define INODE_CHANGED   0x0010
753 #define DATA_CHANGED    0x0020
754 #define TYPE_CHANGED    0x0040
755
756 /*
757  * Return a statically allocated filename, either generically (mkpath), in
758  * the repository directory (git_path), or in a submodule's repository
759  * directory (git_path_submodule). In all cases, note that the result
760  * may be overwritten by another call to _any_ of the functions. Consider
761  * using the safer "dup" or "strbuf" formats below (in some cases, the
762  * unsafe versions have already been removed).
763  */
764 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
765 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
766
767 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
768         __attribute__((format (printf, 3, 4)));
769 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
770         __attribute__((format (printf, 2, 3)));
771 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
772         __attribute__((format (printf, 2, 3)));
773 extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
774                                       const char *fmt, ...)
775         __attribute__((format (printf, 3, 4)));
776 extern char *git_pathdup(const char *fmt, ...)
777         __attribute__((format (printf, 1, 2)));
778 extern char *mkpathdup(const char *fmt, ...)
779         __attribute__((format (printf, 1, 2)));
780 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
781         __attribute__((format (printf, 2, 3)));
782
783 extern void report_linked_checkout_garbage(void);
784
785 /*
786  * You can define a static memoized git path like:
787  *
788  *    static GIT_PATH_FUNC(git_path_foo, "FOO");
789  *
790  * or use one of the global ones below.
791  */
792 #define GIT_PATH_FUNC(func, filename) \
793         const char *func(void) \
794         { \
795                 static char *ret; \
796                 if (!ret) \
797                         ret = git_pathdup(filename); \
798                 return ret; \
799         }
800
801 const char *git_path_cherry_pick_head(void);
802 const char *git_path_revert_head(void);
803 const char *git_path_squash_msg(void);
804 const char *git_path_merge_msg(void);
805 const char *git_path_merge_rr(void);
806 const char *git_path_merge_mode(void);
807 const char *git_path_merge_head(void);
808 const char *git_path_fetch_head(void);
809 const char *git_path_shallow(void);
810
811 /*
812  * Return the name of the file in the local object database that would
813  * be used to store a loose object with the specified sha1.  The
814  * return value is a pointer to a statically allocated buffer that is
815  * overwritten each time the function is called.
816  */
817 extern const char *sha1_file_name(const unsigned char *sha1);
818
819 /*
820  * Return the name of the (local) packfile with the specified sha1 in
821  * its name.  The return value is a pointer to memory that is
822  * overwritten each time this function is called.
823  */
824 extern char *sha1_pack_name(const unsigned char *sha1);
825
826 /*
827  * Return the name of the (local) pack index file with the specified
828  * sha1 in its name.  The return value is a pointer to memory that is
829  * overwritten each time this function is called.
830  */
831 extern char *sha1_pack_index_name(const unsigned char *sha1);
832
833 /*
834  * Return an abbreviated sha1 unique within this repository's object database.
835  * The result will be at least `len` characters long, and will be NUL
836  * terminated.
837  *
838  * The non-`_r` version returns a static buffer which will be overwritten by
839  * subsequent calls.
840  *
841  * The `_r` variant writes to a buffer supplied by the caller, which must be at
842  * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
843  * written (excluding the NUL terminator).
844  *
845  * Note that while this version avoids the static buffer, it is not fully
846  * reentrant, as it calls into other non-reentrant git code.
847  */
848 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
849 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
850
851 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
852 extern const struct object_id null_oid;
853
854 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
855 {
856         int i;
857
858         for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
859                 if (*sha1 != *sha2)
860                         return *sha1 - *sha2;
861         }
862
863         return 0;
864 }
865
866 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
867 {
868         return hashcmp(oid1->hash, oid2->hash);
869 }
870
871 static inline int is_null_sha1(const unsigned char *sha1)
872 {
873         return !hashcmp(sha1, null_sha1);
874 }
875
876 static inline int is_null_oid(const struct object_id *oid)
877 {
878         return !hashcmp(oid->hash, null_sha1);
879 }
880
881 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
882 {
883         memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
884 }
885
886 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
887 {
888         hashcpy(dst->hash, src->hash);
889 }
890
891 static inline void hashclr(unsigned char *hash)
892 {
893         memset(hash, 0, GIT_SHA1_RAWSZ);
894 }
895
896 static inline void oidclr(struct object_id *oid)
897 {
898         hashclr(oid->hash);
899 }
900
901
902 #define EMPTY_TREE_SHA1_HEX \
903         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
904 #define EMPTY_TREE_SHA1_BIN_LITERAL \
905          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
906          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
907 #define EMPTY_TREE_SHA1_BIN \
908          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
909
910 #define EMPTY_BLOB_SHA1_HEX \
911         "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
912 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
913         "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
914         "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
915 #define EMPTY_BLOB_SHA1_BIN \
916         ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
917
918 static inline int is_empty_blob_sha1(const unsigned char *sha1)
919 {
920         return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
921 }
922
923 int git_mkstemp(char *path, size_t n, const char *template);
924
925 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
926
927 /* set default permissions by passing mode arguments to open(2) */
928 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
929 int git_mkstemp_mode(char *pattern, int mode);
930
931 /*
932  * NOTE NOTE NOTE!!
933  *
934  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
935  * not be changed. Old repositories have core.sharedrepository written in
936  * numeric format, and therefore these values are preserved for compatibility
937  * reasons.
938  */
939 enum sharedrepo {
940         PERM_UMASK          = 0,
941         OLD_PERM_GROUP      = 1,
942         OLD_PERM_EVERYBODY  = 2,
943         PERM_GROUP          = 0660,
944         PERM_EVERYBODY      = 0664
945 };
946 int git_config_perm(const char *var, const char *value);
947 int adjust_shared_perm(const char *path);
948
949 /*
950  * Create the directory containing the named path, using care to be
951  * somewhat safe against races.  Return one of the scld_error values
952  * to indicate success/failure.
953  *
954  * SCLD_VANISHED indicates that one of the ancestor directories of the
955  * path existed at one point during the function call and then
956  * suddenly vanished, probably because another process pruned the
957  * directory while we were working.  To be robust against this kind of
958  * race, callers might want to try invoking the function again when it
959  * returns SCLD_VANISHED.
960  */
961 enum scld_error {
962         SCLD_OK = 0,
963         SCLD_FAILED = -1,
964         SCLD_PERMS = -2,
965         SCLD_EXISTS = -3,
966         SCLD_VANISHED = -4
967 };
968 enum scld_error safe_create_leading_directories(char *path);
969 enum scld_error safe_create_leading_directories_const(const char *path);
970
971 int mkdir_in_gitdir(const char *path);
972 extern char *expand_user_path(const char *path);
973 const char *enter_repo(const char *path, int strict);
974 static inline int is_absolute_path(const char *path)
975 {
976         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
977 }
978 int is_directory(const char *);
979 const char *real_path(const char *path);
980 const char *real_path_if_valid(const char *path);
981 const char *absolute_path(const char *path);
982 const char *remove_leading_path(const char *in, const char *prefix);
983 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
984 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
985 int normalize_path_copy(char *dst, const char *src);
986 int longest_ancestor_length(const char *path, struct string_list *prefixes);
987 char *strip_path_suffix(const char *path, const char *suffix);
988 int daemon_avoid_alias(const char *path);
989 extern int is_ntfs_dotgit(const char *name);
990
991 /**
992  * Return a newly allocated string with the evaluation of
993  * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
994  * "$HOME/.config/git/$filename". Return NULL upon error.
995  */
996 extern char *xdg_config_home(const char *filename);
997
998 /* object replacement */
999 #define LOOKUP_REPLACE_OBJECT 1
1000 #define LOOKUP_UNKNOWN_OBJECT 2
1001 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1002 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1003 {
1004         return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1005 }
1006
1007 /*
1008  * This internal function is only declared here for the benefit of
1009  * lookup_replace_object().  Please do not call it directly.
1010  */
1011 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1012
1013 /*
1014  * If object sha1 should be replaced, return the replacement object's
1015  * name (replaced recursively, if necessary).  The return value is
1016  * either sha1 or a pointer to a permanently-allocated value.  When
1017  * object replacement is suppressed, always return sha1.
1018  */
1019 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1020 {
1021         if (!check_replace_refs)
1022                 return sha1;
1023         return do_lookup_replace_object(sha1);
1024 }
1025
1026 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1027 {
1028         if (!(flag & LOOKUP_REPLACE_OBJECT))
1029                 return sha1;
1030         return lookup_replace_object(sha1);
1031 }
1032
1033 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1034 extern int sha1_object_info(const unsigned char *, unsigned long *);
1035 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1036 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1037 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1038 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1039 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1040 extern int git_open_noatime(const char *name);
1041 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1042 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1043 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1044
1045 /* global flag to enable extra checks when accessing packed objects */
1046 extern int do_check_packed_object_crc;
1047
1048 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1049
1050 extern int finalize_object_file(const char *tmpfile, const char *filename);
1051
1052 extern int has_sha1_pack(const unsigned char *sha1);
1053
1054 /*
1055  * Return true iff we have an object named sha1, whether local or in
1056  * an alternate object database, and whether packed or loose.  This
1057  * function does not respect replace references.
1058  *
1059  * If the QUICK flag is set, do not re-check the pack directory
1060  * when we cannot find the object (this means we may give a false
1061  * negative answer if another process is simultaneously repacking).
1062  */
1063 #define HAS_SHA1_QUICK 0x1
1064 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1065 static inline int has_sha1_file(const unsigned char *sha1)
1066 {
1067         return has_sha1_file_with_flags(sha1, 0);
1068 }
1069
1070 /* Same as the above, except for struct object_id. */
1071 extern int has_object_file(const struct object_id *oid);
1072
1073 /*
1074  * Return true iff an alternate object database has a loose object
1075  * with the specified name.  This function does not respect replace
1076  * references.
1077  */
1078 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1079
1080 extern int has_pack_index(const unsigned char *sha1);
1081
1082 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1083
1084 extern const signed char hexval_table[256];
1085 static inline unsigned int hexval(unsigned char c)
1086 {
1087         return hexval_table[c];
1088 }
1089
1090 /* Convert to/from hex/sha1 representation */
1091 #define MINIMUM_ABBREV minimum_abbrev
1092 #define DEFAULT_ABBREV default_abbrev
1093
1094 struct object_context {
1095         unsigned char tree[20];
1096         char path[PATH_MAX];
1097         unsigned mode;
1098         /*
1099          * symlink_path is only used by get_tree_entry_follow_symlinks,
1100          * and only for symlinks that point outside the repository.
1101          */
1102         struct strbuf symlink_path;
1103 };
1104
1105 #define GET_SHA1_QUIETLY           01
1106 #define GET_SHA1_COMMIT            02
1107 #define GET_SHA1_COMMITTISH        04
1108 #define GET_SHA1_TREE             010
1109 #define GET_SHA1_TREEISH          020
1110 #define GET_SHA1_BLOB             040
1111 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1112 #define GET_SHA1_ONLY_TO_DIE    04000
1113
1114 extern int get_sha1(const char *str, unsigned char *sha1);
1115 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1116 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1117 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1118 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1119 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1120 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1121 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1122
1123 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1124 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1125
1126 /*
1127  * Try to read a SHA1 in hexadecimal format from the 40 characters
1128  * starting at hex.  Write the 20-byte result to sha1 in binary form.
1129  * Return 0 on success.  Reading stops if a NUL is encountered in the
1130  * input, so it is safe to pass this function an arbitrary
1131  * null-terminated string.
1132  */
1133 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1134 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1135
1136 /*
1137  * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1138  * and writes the NUL-terminated output to the buffer `out`, which must be at
1139  * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1140  * convenience.
1141  *
1142  * The non-`_r` variant returns a static buffer, but uses a ring of 4
1143  * buffers, making it safe to make multiple calls for a single statement, like:
1144  *
1145  *   printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1146  */
1147 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1148 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
1149 extern char *oid_to_hex(const struct object_id *oid);   /* same static buffer as sha1_to_hex */
1150
1151 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1152 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1153
1154 extern int validate_headref(const char *ref);
1155
1156 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1157 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1158 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1159 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1160
1161 extern void *read_object_with_reference(const unsigned char *sha1,
1162                                         const char *required_type,
1163                                         unsigned long *size,
1164                                         unsigned char *sha1_ret);
1165
1166 extern struct object *peel_to_type(const char *name, int namelen,
1167                                    struct object *o, enum object_type);
1168
1169 struct date_mode {
1170         enum date_mode_type {
1171                 DATE_NORMAL = 0,
1172                 DATE_RELATIVE,
1173                 DATE_SHORT,
1174                 DATE_ISO8601,
1175                 DATE_ISO8601_STRICT,
1176                 DATE_RFC2822,
1177                 DATE_STRFTIME,
1178                 DATE_RAW
1179         } type;
1180         const char *strftime_fmt;
1181         int local;
1182 };
1183
1184 /*
1185  * Convenience helper for passing a constant type, like:
1186  *
1187  *   show_date(t, tz, DATE_MODE(NORMAL));
1188  */
1189 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1190 struct date_mode *date_mode_from_type(enum date_mode_type type);
1191
1192 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1193 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1194                         struct strbuf *timebuf);
1195 int parse_date(const char *date, struct strbuf *out);
1196 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1197 int parse_expiry_date(const char *date, unsigned long *timestamp);
1198 void datestamp(struct strbuf *out);
1199 #define approxidate(s) approxidate_careful((s), NULL)
1200 unsigned long approxidate_careful(const char *, int *);
1201 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1202 void parse_date_format(const char *format, struct date_mode *mode);
1203 int date_overflows(unsigned long date);
1204
1205 #define IDENT_STRICT           1
1206 #define IDENT_NO_DATE          2
1207 #define IDENT_NO_NAME          4
1208 extern const char *git_author_info(int);
1209 extern const char *git_committer_info(int);
1210 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1211 extern const char *fmt_name(const char *name, const char *email);
1212 extern const char *ident_default_name(void);
1213 extern const char *ident_default_email(void);
1214 extern const char *git_editor(void);
1215 extern const char *git_pager(int stdout_is_tty);
1216 extern int git_ident_config(const char *, const char *, void *);
1217
1218 struct ident_split {
1219         const char *name_begin;
1220         const char *name_end;
1221         const char *mail_begin;
1222         const char *mail_end;
1223         const char *date_begin;
1224         const char *date_end;
1225         const char *tz_begin;
1226         const char *tz_end;
1227 };
1228 /*
1229  * Signals an success with 0, but time part of the result may be NULL
1230  * if the input lacks timestamp and zone
1231  */
1232 extern int split_ident_line(struct ident_split *, const char *, int);
1233
1234 /*
1235  * Like show_date, but pull the timestamp and tz parameters from
1236  * the ident_split. It will also sanity-check the values and produce
1237  * a well-known sentinel date if they appear bogus.
1238  */
1239 const char *show_ident_date(const struct ident_split *id,
1240                             const struct date_mode *mode);
1241
1242 /*
1243  * Compare split idents for equality or strict ordering. Note that we
1244  * compare only the ident part of the line, ignoring any timestamp.
1245  *
1246  * Because there are two fields, we must choose one as the primary key; we
1247  * currently arbitrarily pick the email.
1248  */
1249 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1250
1251 struct checkout {
1252         struct index_state *istate;
1253         const char *base_dir;
1254         int base_dir_len;
1255         unsigned force:1,
1256                  quiet:1,
1257                  not_new:1,
1258                  refresh_cache:1;
1259 };
1260
1261 #define TEMPORARY_FILENAME_LENGTH 25
1262 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1263
1264 struct cache_def {
1265         struct strbuf path;
1266         int flags;
1267         int track_flags;
1268         int prefix_len_stat_func;
1269 };
1270 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1271 static inline void cache_def_clear(struct cache_def *cache)
1272 {
1273         strbuf_release(&cache->path);
1274 }
1275
1276 extern int has_symlink_leading_path(const char *name, int len);
1277 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1278 extern int check_leading_path(const char *name, int len);
1279 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1280 extern void schedule_dir_for_removal(const char *name, int len);
1281 extern void remove_scheduled_dirs(void);
1282
1283 extern struct alternate_object_database {
1284         struct alternate_object_database *next;
1285         char *name;
1286         char base[FLEX_ARRAY]; /* more */
1287 } *alt_odb_list;
1288 extern void prepare_alt_odb(void);
1289 extern void read_info_alternates(const char * relative_base, int depth);
1290 extern void add_to_alternates_file(const char *reference);
1291 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1292 extern int foreach_alt_odb(alt_odb_fn, void*);
1293
1294 struct pack_window {
1295         struct pack_window *next;
1296         unsigned char *base;
1297         off_t offset;
1298         size_t len;
1299         unsigned int last_used;
1300         unsigned int inuse_cnt;
1301 };
1302
1303 extern struct packed_git {
1304         struct packed_git *next;
1305         struct pack_window *windows;
1306         off_t pack_size;
1307         const void *index_data;
1308         size_t index_size;
1309         uint32_t num_objects;
1310         uint32_t num_bad_objects;
1311         unsigned char *bad_object_sha1;
1312         int index_version;
1313         time_t mtime;
1314         int pack_fd;
1315         unsigned pack_local:1,
1316                  pack_keep:1,
1317                  freshened:1,
1318                  do_not_close:1;
1319         unsigned char sha1[20];
1320         /* something like ".git/objects/pack/xxxxx.pack" */
1321         char pack_name[FLEX_ARRAY]; /* more */
1322 } *packed_git;
1323
1324 struct pack_entry {
1325         off_t offset;
1326         unsigned char sha1[20];
1327         struct packed_git *p;
1328 };
1329
1330 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1331
1332 /* A hook to report invalid files in pack directory */
1333 #define PACKDIR_FILE_PACK 1
1334 #define PACKDIR_FILE_IDX 2
1335 #define PACKDIR_FILE_GARBAGE 4
1336 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1337
1338 extern void prepare_packed_git(void);
1339 extern void reprepare_packed_git(void);
1340 extern void install_packed_git(struct packed_git *pack);
1341
1342 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1343                                          struct packed_git *packs);
1344
1345 extern void pack_report(void);
1346
1347 /*
1348  * mmap the index file for the specified packfile (if it is not
1349  * already mmapped).  Return 0 on success.
1350  */
1351 extern int open_pack_index(struct packed_git *);
1352
1353 /*
1354  * munmap the index file for the specified packfile (if it is
1355  * currently mmapped).
1356  */
1357 extern void close_pack_index(struct packed_git *);
1358
1359 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1360 extern void close_pack_windows(struct packed_git *);
1361 extern void close_all_packs(void);
1362 extern void unuse_pack(struct pack_window **);
1363 extern void free_pack_by_name(const char *);
1364 extern void clear_delta_base_cache(void);
1365 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1366
1367 /*
1368  * Return the SHA-1 of the nth object within the specified packfile.
1369  * Open the index if it is not already open.  The return value points
1370  * at the SHA-1 within the mmapped index.  Return NULL if there is an
1371  * error.
1372  */
1373 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1374
1375 /*
1376  * Return the offset of the nth object within the specified packfile.
1377  * The index must already be opened.
1378  */
1379 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1380
1381 /*
1382  * If the object named sha1 is present in the specified packfile,
1383  * return its offset within the packfile; otherwise, return 0.
1384  */
1385 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1386
1387 extern int is_pack_valid(struct packed_git *);
1388 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1389 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1390 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1391 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1392
1393 /*
1394  * Iterate over the files in the loose-object parts of the object
1395  * directory "path", triggering the following callbacks:
1396  *
1397  *  - loose_object is called for each loose object we find.
1398  *
1399  *  - loose_cruft is called for any files that do not appear to be
1400  *    loose objects. Note that we only look in the loose object
1401  *    directories "objects/[0-9a-f]{2}/", so we will not report
1402  *    "objects/foobar" as cruft.
1403  *
1404  *  - loose_subdir is called for each top-level hashed subdirectory
1405  *    of the object directory (e.g., "$OBJDIR/f0"). It is called
1406  *    after the objects in the directory are processed.
1407  *
1408  * Any callback that is NULL will be ignored. Callbacks returning non-zero
1409  * will end the iteration.
1410  *
1411  * In the "buf" variant, "path" is a strbuf which will also be used as a
1412  * scratch buffer, but restored to its original contents before
1413  * the function returns.
1414  */
1415 typedef int each_loose_object_fn(const unsigned char *sha1,
1416                                  const char *path,
1417                                  void *data);
1418 typedef int each_loose_cruft_fn(const char *basename,
1419                                 const char *path,
1420                                 void *data);
1421 typedef int each_loose_subdir_fn(int nr,
1422                                  const char *path,
1423                                  void *data);
1424 int for_each_loose_file_in_objdir(const char *path,
1425                                   each_loose_object_fn obj_cb,
1426                                   each_loose_cruft_fn cruft_cb,
1427                                   each_loose_subdir_fn subdir_cb,
1428                                   void *data);
1429 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1430                                       each_loose_object_fn obj_cb,
1431                                       each_loose_cruft_fn cruft_cb,
1432                                       each_loose_subdir_fn subdir_cb,
1433                                       void *data);
1434
1435 /*
1436  * Iterate over loose and packed objects in both the local
1437  * repository and any alternates repositories (unless the
1438  * LOCAL_ONLY flag is set).
1439  */
1440 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1441 typedef int each_packed_object_fn(const unsigned char *sha1,
1442                                   struct packed_git *pack,
1443                                   uint32_t pos,
1444                                   void *data);
1445 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1446 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1447
1448 struct object_info {
1449         /* Request */
1450         enum object_type *typep;
1451         unsigned long *sizep;
1452         unsigned long *disk_sizep;
1453         unsigned char *delta_base_sha1;
1454         struct strbuf *typename;
1455
1456         /* Response */
1457         enum {
1458                 OI_CACHED,
1459                 OI_LOOSE,
1460                 OI_PACKED,
1461                 OI_DBCACHED
1462         } whence;
1463         union {
1464                 /*
1465                  * struct {
1466                  *      ... Nothing to expose in this case
1467                  * } cached;
1468                  * struct {
1469                  *      ... Nothing to expose in this case
1470                  * } loose;
1471                  */
1472                 struct {
1473                         struct packed_git *pack;
1474                         off_t offset;
1475                         unsigned int is_delta;
1476                 } packed;
1477         } u;
1478 };
1479 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1480
1481 /* Dumb servers support */
1482 extern int update_server_info(int);
1483
1484 /* git_config_parse_key() returns these negated: */
1485 #define CONFIG_INVALID_KEY 1
1486 #define CONFIG_NO_SECTION_OR_NAME 2
1487 /* git_config_set(), git_config_set_multivar() return the above or these: */
1488 #define CONFIG_NO_LOCK -1
1489 #define CONFIG_INVALID_FILE 3
1490 #define CONFIG_NO_WRITE 4
1491 #define CONFIG_NOTHING_SET 5
1492 #define CONFIG_INVALID_PATTERN 6
1493 #define CONFIG_GENERIC_ERROR 7
1494
1495 #define CONFIG_REGEX_NONE ((void *)1)
1496
1497 struct git_config_source {
1498         unsigned int use_stdin:1;
1499         const char *file;
1500         const char *blob;
1501 };
1502
1503 typedef int (*config_fn_t)(const char *, const char *, void *);
1504 extern int git_default_config(const char *, const char *, void *);
1505 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1506 extern int git_config_from_buf(config_fn_t fn, const char *name,
1507                                const char *buf, size_t len, void *data);
1508 extern void git_config_push_parameter(const char *text);
1509 extern int git_config_from_parameters(config_fn_t fn, void *data);
1510 extern void git_config(config_fn_t fn, void *);
1511 extern int git_config_with_options(config_fn_t fn, void *,
1512                                    struct git_config_source *config_source,
1513                                    int respect_includes);
1514 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1515 extern int git_parse_ulong(const char *, unsigned long *);
1516 extern int git_parse_maybe_bool(const char *);
1517 extern int git_config_int(const char *, const char *);
1518 extern int64_t git_config_int64(const char *, const char *);
1519 extern unsigned long git_config_ulong(const char *, const char *);
1520 extern int git_config_bool_or_int(const char *, const char *, int *);
1521 extern int git_config_bool(const char *, const char *);
1522 extern int git_config_maybe_bool(const char *, const char *);
1523 extern int git_config_string(const char **, const char *, const char *);
1524 extern int git_config_pathname(const char **, const char *, const char *);
1525 extern int git_config_set_in_file(const char *, const char *, const char *);
1526 extern int git_config_set(const char *, const char *);
1527 extern int git_config_parse_key(const char *, char **, int *);
1528 extern int git_config_key_is_valid(const char *key);
1529 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1530 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1531 extern int git_config_rename_section(const char *, const char *);
1532 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1533 extern const char *git_etc_gitconfig(void);
1534 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1535 extern int git_env_bool(const char *, int);
1536 extern unsigned long git_env_ulong(const char *, unsigned long);
1537 extern int git_config_system(void);
1538 extern int config_error_nonbool(const char *);
1539 #if defined(__GNUC__)
1540 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1541 #endif
1542 extern const char *get_log_output_encoding(void);
1543 extern const char *get_commit_output_encoding(void);
1544
1545 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1546
1547 struct config_include_data {
1548         int depth;
1549         config_fn_t fn;
1550         void *data;
1551 };
1552 #define CONFIG_INCLUDE_INIT { 0 }
1553 extern int git_config_include(const char *name, const char *value, void *data);
1554
1555 /*
1556  * Match and parse a config key of the form:
1557  *
1558  *   section.(subsection.)?key
1559  *
1560  * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1561  * we return -1 if it does not match, 0 otherwise. The subsection and key
1562  * out-parameters are filled by the function (and subsection is NULL if it is
1563  * missing).
1564  */
1565 extern int parse_config_key(const char *var,
1566                             const char *section,
1567                             const char **subsection, int *subsection_len,
1568                             const char **key);
1569
1570 struct config_set_element {
1571         struct hashmap_entry ent;
1572         char *key;
1573         struct string_list value_list;
1574 };
1575
1576 struct configset_list_item {
1577         struct config_set_element *e;
1578         int value_index;
1579 };
1580
1581 /*
1582  * the contents of the list are ordered according to their
1583  * position in the config files and order of parsing the files.
1584  * (i.e. key-value pair at the last position of .git/config will
1585  * be at the last item of the list)
1586  */
1587 struct configset_list {
1588         struct configset_list_item *items;
1589         unsigned int nr, alloc;
1590 };
1591
1592 struct config_set {
1593         struct hashmap config_hash;
1594         int hash_initialized;
1595         struct configset_list list;
1596 };
1597
1598 extern void git_configset_init(struct config_set *cs);
1599 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1600 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1601 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1602 extern void git_configset_clear(struct config_set *cs);
1603 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1604 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1605 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1606 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1607 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1608 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1609 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1610 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1611
1612 extern int git_config_get_value(const char *key, const char **value);
1613 extern const struct string_list *git_config_get_value_multi(const char *key);
1614 extern void git_config_clear(void);
1615 extern void git_config_iter(config_fn_t fn, void *data);
1616 extern int git_config_get_string_const(const char *key, const char **dest);
1617 extern int git_config_get_string(const char *key, char **dest);
1618 extern int git_config_get_int(const char *key, int *dest);
1619 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1620 extern int git_config_get_bool(const char *key, int *dest);
1621 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1622 extern int git_config_get_maybe_bool(const char *key, int *dest);
1623 extern int git_config_get_pathname(const char *key, const char **dest);
1624
1625 struct key_value_info {
1626         const char *filename;
1627         int linenr;
1628 };
1629
1630 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1631 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1632
1633 extern int committer_ident_sufficiently_given(void);
1634 extern int author_ident_sufficiently_given(void);
1635
1636 extern const char *git_commit_encoding;
1637 extern const char *git_log_output_encoding;
1638 extern const char *git_mailmap_file;
1639 extern const char *git_mailmap_blob;
1640
1641 /* IO helper functions */
1642 extern void maybe_flush_or_die(FILE *, const char *);
1643 __attribute__((format (printf, 2, 3)))
1644 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1645
1646 #define COPY_READ_ERROR (-2)
1647 #define COPY_WRITE_ERROR (-3)
1648 extern int copy_fd(int ifd, int ofd);
1649 extern int copy_file(const char *dst, const char *src, int mode);
1650 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1651
1652 extern void write_or_die(int fd, const void *buf, size_t count);
1653 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1654 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1655 extern void fsync_or_die(int fd, const char *);
1656
1657 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1658 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1659 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1660
1661 static inline ssize_t write_str_in_full(int fd, const char *str)
1662 {
1663         return write_in_full(fd, str, strlen(str));
1664 }
1665
1666 extern int write_file(const char *path, const char *fmt, ...);
1667 extern int write_file_gently(const char *path, const char *fmt, ...);
1668
1669 /* pager.c */
1670 extern void setup_pager(void);
1671 extern const char *pager_program;
1672 extern int pager_in_use(void);
1673 extern int pager_use_color;
1674 extern int term_columns(void);
1675 extern int decimal_width(uintmax_t);
1676 extern int check_pager_config(const char *cmd);
1677
1678 extern const char *editor_program;
1679 extern const char *askpass_program;
1680 extern const char *excludes_file;
1681
1682 /* base85 */
1683 int decode_85(char *dst, const char *line, int linelen);
1684 void encode_85(char *buf, const unsigned char *data, int bytes);
1685
1686 /* alloc.c */
1687 extern void *alloc_blob_node(void);
1688 extern void *alloc_tree_node(void);
1689 extern void *alloc_commit_node(void);
1690 extern void *alloc_tag_node(void);
1691 extern void *alloc_object_node(void);
1692 extern void alloc_report(void);
1693 extern unsigned int alloc_commit_index(void);
1694
1695 /* pkt-line.c */
1696 void packet_trace_identity(const char *prog);
1697
1698 /* add */
1699 /*
1700  * return 0 if success, 1 - if addition of a file failed and
1701  * ADD_FILES_IGNORE_ERRORS was specified in flags
1702  */
1703 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1704
1705 /* diff.c */
1706 extern int diff_auto_refresh_index;
1707
1708 /* match-trees.c */
1709 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1710 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1711
1712 /*
1713  * whitespace rules.
1714  * used by both diff and apply
1715  * last two digits are tab width
1716  */
1717 #define WS_BLANK_AT_EOL         0100
1718 #define WS_SPACE_BEFORE_TAB     0200
1719 #define WS_INDENT_WITH_NON_TAB  0400
1720 #define WS_CR_AT_EOL           01000
1721 #define WS_BLANK_AT_EOF        02000
1722 #define WS_TAB_IN_INDENT       04000
1723 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1724 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1725 #define WS_TAB_WIDTH_MASK        077
1726 extern unsigned whitespace_rule_cfg;
1727 extern unsigned whitespace_rule(const char *);
1728 extern unsigned parse_whitespace_rule(const char *);
1729 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1730 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1731 extern char *whitespace_error_string(unsigned ws);
1732 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1733 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1734 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1735
1736 /* ls-files */
1737 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1738
1739 char *alias_lookup(const char *alias);
1740 int split_cmdline(char *cmdline, const char ***argv);
1741 /* Takes a negative value returned by split_cmdline */
1742 const char *split_cmdline_strerror(int cmdline_errno);
1743
1744 /* git.c */
1745 struct startup_info {
1746         int have_repository;
1747         const char *prefix;
1748 };
1749 extern struct startup_info *startup_info;
1750
1751 /* merge.c */
1752 struct commit_list;
1753 int try_merge_command(const char *strategy, size_t xopts_nr,
1754                 const char **xopts, struct commit_list *common,
1755                 const char *head_arg, struct commit_list *remotes);
1756 int checkout_fast_forward(const unsigned char *from,
1757                           const unsigned char *to,
1758                           int overwrite_ignore);
1759
1760
1761 int sane_execvp(const char *file, char *const argv[]);
1762
1763 /*
1764  * A struct to encapsulate the concept of whether a file has changed
1765  * since we last checked it. This uses criteria similar to those used
1766  * for the index.
1767  */
1768 struct stat_validity {
1769         struct stat_data *sd;
1770 };
1771
1772 void stat_validity_clear(struct stat_validity *sv);
1773
1774 /*
1775  * Returns 1 if the path is a regular file (or a symlink to a regular
1776  * file) and matches the saved stat_validity, 0 otherwise.  A missing
1777  * or inaccessible file is considered a match if the struct was just
1778  * initialized, or if the previous update found an inaccessible file.
1779  */
1780 int stat_validity_check(struct stat_validity *sv, const char *path);
1781
1782 /*
1783  * Update the stat_validity from a file opened at descriptor fd. If
1784  * the file is missing, inaccessible, or not a regular file, then
1785  * future calls to stat_validity_check will match iff one of those
1786  * conditions continues to be true.
1787  */
1788 void stat_validity_update(struct stat_validity *sv, int fd);
1789
1790 int versioncmp(const char *s1, const char *s2);
1791 void sleep_millisec(int millisec);
1792
1793 /*
1794  * Create a directory and (if share is nonzero) adjust its permissions
1795  * according to the shared_repository setting. Only use this for
1796  * directories under $GIT_DIR.  Don't use it for working tree
1797  * directories.
1798  */
1799 void safe_create_dir(const char *dir, int share);
1800
1801 #endif /* CACHE_H */