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