Merge branch 'sb/wt-status-cleanup' into maint
[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 void read_gitfile_error_die(int error_code, const char *path, const char *dir);
511 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
512 #define read_gitfile(path) read_gitfile_gently((path), NULL)
513 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
514 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
515
516 extern void set_git_work_tree(const char *tree);
517
518 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
519
520 extern void setup_work_tree(void);
521 extern const char *setup_git_directory_gently(int *);
522 extern const char *setup_git_directory(void);
523 extern char *prefix_path(const char *prefix, int len, const char *path);
524 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
525 extern const char *prefix_filename(const char *prefix, int len, const char *path);
526 extern int check_filename(const char *prefix, const char *name);
527 extern void verify_filename(const char *prefix,
528 const char *name,
529 int diagnose_misspelt_rev);
530 extern void verify_non_filename(const char *prefix, const char *name);
531 extern int path_inside_repo(const char *prefix, const char *path);
532
533 #define INIT_DB_QUIET 0x0001
534 #define INIT_DB_EXIST_OK 0x0002
535
536 extern int init_db(const char *git_dir, const char *real_git_dir,
537 const char *template_dir, unsigned int flags);
538
539 extern void sanitize_stdfds(void);
540 extern int daemonize(void);
541
542 #define alloc_nr(x) (((x)+16)*3/2)
543
544 /*
545 * Realloc the buffer pointed at by variable 'x' so that it can hold
546 * at least 'nr' entries; the number of entries currently allocated
547 * is 'alloc', using the standard growing factor alloc_nr() macro.
548 *
549 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
550 */
551 #define ALLOC_GROW(x, nr, alloc) \
552 do { \
553 if ((nr) > alloc) { \
554 if (alloc_nr(alloc) < (nr)) \
555 alloc = (nr); \
556 else \
557 alloc = alloc_nr(alloc); \
558 REALLOC_ARRAY(x, alloc); \
559 } \
560 } while (0)
561
562 /* Initialize and use the cache information */
563 struct lock_file;
564 extern int read_index(struct index_state *);
565 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
566 extern int do_read_index(struct index_state *istate, const char *path,
567 int must_exist); /* for testting only! */
568 extern int read_index_from(struct index_state *, const char *path);
569 extern int is_index_unborn(struct index_state *);
570 extern int read_index_unmerged(struct index_state *);
571 #define COMMIT_LOCK (1 << 0)
572 #define CLOSE_LOCK (1 << 1)
573 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
574 extern int discard_index(struct index_state *);
575 extern int unmerged_index(const struct index_state *);
576 extern int verify_path(const char *path);
577 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
578 extern void adjust_dirname_case(struct index_state *istate, char *name);
579 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
580
581 /*
582 * Searches for an entry defined by name and namelen in the given index.
583 * If the return value is positive (including 0) it is the position of an
584 * exact match. If the return value is negative, the negated value minus 1
585 * is the position where the entry would be inserted.
586 * Example: The current index consists of these files and its stages:
587 *
588 * b#0, d#0, f#1, f#3
589 *
590 * index_name_pos(&index, "a", 1) -> -1
591 * index_name_pos(&index, "b", 1) -> 0
592 * index_name_pos(&index, "c", 1) -> -2
593 * index_name_pos(&index, "d", 1) -> 1
594 * index_name_pos(&index, "e", 1) -> -3
595 * index_name_pos(&index, "f", 1) -> -3
596 * index_name_pos(&index, "g", 1) -> -5
597 */
598 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
599
600 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
601 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
602 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
603 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
604 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
605 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
606 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
607 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
608
609 /* Remove entry, return true if there are more entries to go. */
610 extern int remove_index_entry_at(struct index_state *, int pos);
611
612 extern void remove_marked_cache_entries(struct index_state *istate);
613 extern int remove_file_from_index(struct index_state *, const char *path);
614 #define ADD_CACHE_VERBOSE 1
615 #define ADD_CACHE_PRETEND 2
616 #define ADD_CACHE_IGNORE_ERRORS 4
617 #define ADD_CACHE_IGNORE_REMOVAL 8
618 #define ADD_CACHE_INTENT 16
619 /*
620 * These two are used to add the contents of the file at path
621 * to the index, marking the working tree up-to-date by storing
622 * the cached stat info in the resulting cache entry. A caller
623 * that has already run lstat(2) on the path can call
624 * add_to_index(), and all others can call add_file_to_index();
625 * the latter will do necessary lstat(2) internally before
626 * calling the former.
627 */
628 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
629 extern int add_file_to_index(struct index_state *, const char *path, int flags);
630
631 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
632 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
633 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
634 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
635 extern int index_name_is_other(const struct index_state *, const char *, int);
636 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
637
638 /* do stat comparison even if CE_VALID is true */
639 #define CE_MATCH_IGNORE_VALID 01
640 /* do not check the contents but report dirty on racily-clean entries */
641 #define CE_MATCH_RACY_IS_DIRTY 02
642 /* do stat comparison even if CE_SKIP_WORKTREE is true */
643 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
644 /* ignore non-existent files during stat update */
645 #define CE_MATCH_IGNORE_MISSING 0x08
646 /* enable stat refresh */
647 #define CE_MATCH_REFRESH 0x10
648 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
649 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
650
651 #define HASH_WRITE_OBJECT 1
652 #define HASH_FORMAT_CHECK 2
653 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
654 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
655
656 /*
657 * Record to sd the data from st that we use to check whether a file
658 * might have changed.
659 */
660 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
661
662 /*
663 * Return 0 if st is consistent with a file not having been changed
664 * since sd was filled. If there are differences, return a
665 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
666 * INODE_CHANGED, and DATA_CHANGED.
667 */
668 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
669 extern int match_stat_data_racy(const struct index_state *istate,
670 const struct stat_data *sd, struct stat *st);
671
672 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
673
674 #define REFRESH_REALLY 0x0001 /* ignore_valid */
675 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
676 #define REFRESH_QUIET 0x0004 /* be quiet about it */
677 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
678 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
679 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
680 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
681 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
682
683 extern void update_index_if_able(struct index_state *, struct lock_file *);
684
685 extern int hold_locked_index(struct lock_file *, int);
686 extern void set_alternate_index_output(const char *);
687
688 /* Environment bits from configuration mechanism */
689 extern int trust_executable_bit;
690 extern int trust_ctime;
691 extern int check_stat;
692 extern int quote_path_fully;
693 extern int has_symlinks;
694 extern int minimum_abbrev, default_abbrev;
695 extern int ignore_case;
696 extern int assume_unchanged;
697 extern int prefer_symlink_refs;
698 extern int warn_ambiguous_refs;
699 extern int warn_on_object_refname_ambiguity;
700 extern const char *apply_default_whitespace;
701 extern const char *apply_default_ignorewhitespace;
702 extern const char *git_attributes_file;
703 extern const char *git_hooks_path;
704 extern int zlib_compression_level;
705 extern int core_compression_level;
706 extern int pack_compression_level;
707 extern size_t packed_git_window_size;
708 extern size_t packed_git_limit;
709 extern size_t delta_base_cache_limit;
710 extern unsigned long big_file_threshold;
711 extern unsigned long pack_size_limit_cfg;
712
713 /*
714 * Accessors for the core.sharedrepository config which lazy-load the value
715 * from the config (if not already set). The "reset" function can be
716 * used to unset "set" or cached value, meaning that the value will be loaded
717 * fresh from the config file on the next call to get_shared_repository().
718 */
719 void set_shared_repository(int value);
720 int get_shared_repository(void);
721 void reset_shared_repository(void);
722
723 /*
724 * Do replace refs need to be checked this run? This variable is
725 * initialized to true unless --no-replace-object is used or
726 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
727 * commands that do not want replace references to be active. As an
728 * optimization it is also set to false if replace references have
729 * been sought but there were none.
730 */
731 extern int check_replace_refs;
732 extern char *git_replace_ref_base;
733
734 extern int fsync_object_files;
735 extern int core_preload_index;
736 extern int core_apply_sparse_checkout;
737 extern int precomposed_unicode;
738 extern int protect_hfs;
739 extern int protect_ntfs;
740 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
741
742 /*
743 * Include broken refs in all ref iterations, which will
744 * generally choke dangerous operations rather than letting
745 * them silently proceed without taking the broken ref into
746 * account.
747 */
748 extern int ref_paranoia;
749
750 /*
751 * The character that begins a commented line in user-editable file
752 * that is subject to stripspace.
753 */
754 extern char comment_line_char;
755 extern int auto_comment_line_char;
756
757 /* Windows only */
758 enum hide_dotfiles_type {
759 HIDE_DOTFILES_FALSE = 0,
760 HIDE_DOTFILES_TRUE,
761 HIDE_DOTFILES_DOTGITONLY
762 };
763 extern enum hide_dotfiles_type hide_dotfiles;
764
765 enum log_refs_config {
766 LOG_REFS_UNSET = -1,
767 LOG_REFS_NONE = 0,
768 LOG_REFS_NORMAL,
769 LOG_REFS_ALWAYS
770 };
771 extern enum log_refs_config log_all_ref_updates;
772
773 enum branch_track {
774 BRANCH_TRACK_UNSPECIFIED = -1,
775 BRANCH_TRACK_NEVER = 0,
776 BRANCH_TRACK_REMOTE,
777 BRANCH_TRACK_ALWAYS,
778 BRANCH_TRACK_EXPLICIT,
779 BRANCH_TRACK_OVERRIDE
780 };
781
782 enum rebase_setup_type {
783 AUTOREBASE_NEVER = 0,
784 AUTOREBASE_LOCAL,
785 AUTOREBASE_REMOTE,
786 AUTOREBASE_ALWAYS
787 };
788
789 enum push_default_type {
790 PUSH_DEFAULT_NOTHING = 0,
791 PUSH_DEFAULT_MATCHING,
792 PUSH_DEFAULT_SIMPLE,
793 PUSH_DEFAULT_UPSTREAM,
794 PUSH_DEFAULT_CURRENT,
795 PUSH_DEFAULT_UNSPECIFIED
796 };
797
798 extern enum branch_track git_branch_track;
799 extern enum rebase_setup_type autorebase;
800 extern enum push_default_type push_default;
801
802 enum object_creation_mode {
803 OBJECT_CREATION_USES_HARDLINKS = 0,
804 OBJECT_CREATION_USES_RENAMES = 1
805 };
806
807 extern enum object_creation_mode object_creation_mode;
808
809 extern char *notes_ref_name;
810
811 extern int grafts_replace_parents;
812
813 /*
814 * GIT_REPO_VERSION is the version we write by default. The
815 * _READ variant is the highest number we know how to
816 * handle.
817 */
818 #define GIT_REPO_VERSION 0
819 #define GIT_REPO_VERSION_READ 1
820 extern int repository_format_precious_objects;
821
822 struct repository_format {
823 int version;
824 int precious_objects;
825 int is_bare;
826 char *work_tree;
827 struct string_list unknown_extensions;
828 };
829
830 /*
831 * Read the repository format characteristics from the config file "path" into
832 * "format" struct. Returns the numeric version. On error, -1 is returned,
833 * format->version is set to -1, and all other fields in the struct are
834 * undefined.
835 */
836 int read_repository_format(struct repository_format *format, const char *path);
837
838 /*
839 * Verify that the repository described by repository_format is something we
840 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
841 * any errors encountered.
842 */
843 int verify_repository_format(const struct repository_format *format,
844 struct strbuf *err);
845
846 /*
847 * Check the repository format version in the path found in get_git_dir(),
848 * and die if it is a version we don't understand. Generally one would
849 * set_git_dir() before calling this, and use it only for "are we in a valid
850 * repo?".
851 */
852 extern void check_repository_format(void);
853
854 #define MTIME_CHANGED 0x0001
855 #define CTIME_CHANGED 0x0002
856 #define OWNER_CHANGED 0x0004
857 #define MODE_CHANGED 0x0008
858 #define INODE_CHANGED 0x0010
859 #define DATA_CHANGED 0x0020
860 #define TYPE_CHANGED 0x0040
861
862 /*
863 * Return a statically allocated filename, either generically (mkpath), in
864 * the repository directory (git_path), or in a submodule's repository
865 * directory (git_path_submodule). In all cases, note that the result
866 * may be overwritten by another call to _any_ of the functions. Consider
867 * using the safer "dup" or "strbuf" formats below (in some cases, the
868 * unsafe versions have already been removed).
869 */
870 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
871 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
872 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
873
874 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
875 __attribute__((format (printf, 3, 4)));
876 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
877 __attribute__((format (printf, 2, 3)));
878 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
879 __attribute__((format (printf, 2, 3)));
880 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
881 __attribute__((format (printf, 2, 3)));
882 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
883 const char *fmt, ...)
884 __attribute__((format (printf, 3, 4)));
885 extern char *git_pathdup(const char *fmt, ...)
886 __attribute__((format (printf, 1, 2)));
887 extern char *mkpathdup(const char *fmt, ...)
888 __attribute__((format (printf, 1, 2)));
889 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
890 __attribute__((format (printf, 2, 3)));
891
892 extern void report_linked_checkout_garbage(void);
893
894 /*
895 * You can define a static memoized git path like:
896 *
897 * static GIT_PATH_FUNC(git_path_foo, "FOO");
898 *
899 * or use one of the global ones below.
900 */
901 #define GIT_PATH_FUNC(func, filename) \
902 const char *func(void) \
903 { \
904 static char *ret; \
905 if (!ret) \
906 ret = git_pathdup(filename); \
907 return ret; \
908 }
909
910 const char *git_path_cherry_pick_head(void);
911 const char *git_path_revert_head(void);
912 const char *git_path_squash_msg(void);
913 const char *git_path_merge_msg(void);
914 const char *git_path_merge_rr(void);
915 const char *git_path_merge_mode(void);
916 const char *git_path_merge_head(void);
917 const char *git_path_fetch_head(void);
918 const char *git_path_shallow(void);
919
920 /*
921 * Return the name of the file in the local object database that would
922 * be used to store a loose object with the specified sha1. The
923 * return value is a pointer to a statically allocated buffer that is
924 * overwritten each time the function is called.
925 */
926 extern const char *sha1_file_name(const unsigned char *sha1);
927
928 /*
929 * Return the name of the (local) packfile with the specified sha1 in
930 * its name. The return value is a pointer to memory that is
931 * overwritten each time this function is called.
932 */
933 extern char *sha1_pack_name(const unsigned char *sha1);
934
935 /*
936 * Return the name of the (local) pack index file with the specified
937 * sha1 in its name. The return value is a pointer to memory that is
938 * overwritten each time this function is called.
939 */
940 extern char *sha1_pack_index_name(const unsigned char *sha1);
941
942 /*
943 * Return an abbreviated sha1 unique within this repository's object database.
944 * The result will be at least `len` characters long, and will be NUL
945 * terminated.
946 *
947 * The non-`_r` version returns a static buffer which remains valid until 4
948 * more calls to find_unique_abbrev are made.
949 *
950 * The `_r` variant writes to a buffer supplied by the caller, which must be at
951 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
952 * written (excluding the NUL terminator).
953 *
954 * Note that while this version avoids the static buffer, it is not fully
955 * reentrant, as it calls into other non-reentrant git code.
956 */
957 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
958 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
959
960 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
961 extern const struct object_id null_oid;
962
963 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
964 {
965 int i;
966
967 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
968 if (*sha1 != *sha2)
969 return *sha1 - *sha2;
970 }
971
972 return 0;
973 }
974
975 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
976 {
977 return hashcmp(oid1->hash, oid2->hash);
978 }
979
980 static inline int is_null_sha1(const unsigned char *sha1)
981 {
982 return !hashcmp(sha1, null_sha1);
983 }
984
985 static inline int is_null_oid(const struct object_id *oid)
986 {
987 return !hashcmp(oid->hash, null_sha1);
988 }
989
990 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
991 {
992 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
993 }
994
995 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
996 {
997 hashcpy(dst->hash, src->hash);
998 }
999
1000 static inline void hashclr(unsigned char *hash)
1001 {
1002 memset(hash, 0, GIT_SHA1_RAWSZ);
1003 }
1004
1005 static inline void oidclr(struct object_id *oid)
1006 {
1007 hashclr(oid->hash);
1008 }
1009
1010
1011 #define EMPTY_TREE_SHA1_HEX \
1012 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
1013 #define EMPTY_TREE_SHA1_BIN_LITERAL \
1014 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
1015 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
1016 extern const struct object_id empty_tree_oid;
1017 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
1018
1019 #define EMPTY_BLOB_SHA1_HEX \
1020 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1021 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
1022 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1023 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
1024 extern const struct object_id empty_blob_oid;
1025 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1026
1027
1028 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1029 {
1030 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
1031 }
1032
1033 static inline int is_empty_blob_oid(const struct object_id *oid)
1034 {
1035 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
1036 }
1037
1038 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1039 {
1040 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1041 }
1042
1043 static inline int is_empty_tree_oid(const struct object_id *oid)
1044 {
1045 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1046 }
1047
1048 /* set default permissions by passing mode arguments to open(2) */
1049 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1050 int git_mkstemp_mode(char *pattern, int mode);
1051
1052 /*
1053 * NOTE NOTE NOTE!!
1054 *
1055 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1056 * not be changed. Old repositories have core.sharedrepository written in
1057 * numeric format, and therefore these values are preserved for compatibility
1058 * reasons.
1059 */
1060 enum sharedrepo {
1061 PERM_UMASK = 0,
1062 OLD_PERM_GROUP = 1,
1063 OLD_PERM_EVERYBODY = 2,
1064 PERM_GROUP = 0660,
1065 PERM_EVERYBODY = 0664
1066 };
1067 int git_config_perm(const char *var, const char *value);
1068 int adjust_shared_perm(const char *path);
1069
1070 /*
1071 * Create the directory containing the named path, using care to be
1072 * somewhat safe against races. Return one of the scld_error values
1073 * to indicate success/failure.
1074 *
1075 * SCLD_VANISHED indicates that one of the ancestor directories of the
1076 * path existed at one point during the function call and then
1077 * suddenly vanished, probably because another process pruned the
1078 * directory while we were working. To be robust against this kind of
1079 * race, callers might want to try invoking the function again when it
1080 * returns SCLD_VANISHED.
1081 *
1082 * safe_create_leading_directories() temporarily changes path while it
1083 * is working but restores it before returning.
1084 * safe_create_leading_directories_const() doesn't modify path, even
1085 * temporarily.
1086 */
1087 enum scld_error {
1088 SCLD_OK = 0,
1089 SCLD_FAILED = -1,
1090 SCLD_PERMS = -2,
1091 SCLD_EXISTS = -3,
1092 SCLD_VANISHED = -4
1093 };
1094 enum scld_error safe_create_leading_directories(char *path);
1095 enum scld_error safe_create_leading_directories_const(const char *path);
1096
1097 int mkdir_in_gitdir(const char *path);
1098 extern char *expand_user_path(const char *path);
1099 const char *enter_repo(const char *path, int strict);
1100 static inline int is_absolute_path(const char *path)
1101 {
1102 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1103 }
1104 int is_directory(const char *);
1105 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1106 int die_on_error);
1107 const char *real_path(const char *path);
1108 const char *real_path_if_valid(const char *path);
1109 char *real_pathdup(const char *path, int die_on_error);
1110 const char *absolute_path(const char *path);
1111 char *absolute_pathdup(const char *path);
1112 const char *remove_leading_path(const char *in, const char *prefix);
1113 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1114 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1115 int normalize_path_copy(char *dst, const char *src);
1116 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1117 char *strip_path_suffix(const char *path, const char *suffix);
1118 int daemon_avoid_alias(const char *path);
1119 extern int is_ntfs_dotgit(const char *name);
1120
1121 /**
1122 * Return a newly allocated string with the evaluation of
1123 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1124 * "$HOME/.config/git/$filename". Return NULL upon error.
1125 */
1126 extern char *xdg_config_home(const char *filename);
1127
1128 /* object replacement */
1129 #define LOOKUP_REPLACE_OBJECT 1
1130 #define LOOKUP_UNKNOWN_OBJECT 2
1131 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1132 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1133 {
1134 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1135 }
1136
1137 /*
1138 * This internal function is only declared here for the benefit of
1139 * lookup_replace_object(). Please do not call it directly.
1140 */
1141 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1142
1143 /*
1144 * If object sha1 should be replaced, return the replacement object's
1145 * name (replaced recursively, if necessary). The return value is
1146 * either sha1 or a pointer to a permanently-allocated value. When
1147 * object replacement is suppressed, always return sha1.
1148 */
1149 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1150 {
1151 if (!check_replace_refs)
1152 return sha1;
1153 return do_lookup_replace_object(sha1);
1154 }
1155
1156 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1157 {
1158 if (!(flag & LOOKUP_REPLACE_OBJECT))
1159 return sha1;
1160 return lookup_replace_object(sha1);
1161 }
1162
1163 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1164 extern int sha1_object_info(const unsigned char *, unsigned long *);
1165 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1166 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1167 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1168 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1169 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1170 extern int git_open_cloexec(const char *name, int flags);
1171 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1172 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1173 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1174 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1175
1176 /* global flag to enable extra checks when accessing packed objects */
1177 extern int do_check_packed_object_crc;
1178
1179 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1180
1181 extern int finalize_object_file(const char *tmpfile, const char *filename);
1182
1183 extern int has_sha1_pack(const unsigned char *sha1);
1184
1185 /*
1186 * Open the loose object at path, check its sha1, and return the contents,
1187 * type, and size. If the object is a blob, then "contents" may return NULL,
1188 * to allow streaming of large blobs.
1189 *
1190 * Returns 0 on success, negative on error (details may be written to stderr).
1191 */
1192 int read_loose_object(const char *path,
1193 const unsigned char *expected_sha1,
1194 enum object_type *type,
1195 unsigned long *size,
1196 void **contents);
1197
1198 /*
1199 * Return true iff we have an object named sha1, whether local or in
1200 * an alternate object database, and whether packed or loose. This
1201 * function does not respect replace references.
1202 *
1203 * If the QUICK flag is set, do not re-check the pack directory
1204 * when we cannot find the object (this means we may give a false
1205 * negative answer if another process is simultaneously repacking).
1206 */
1207 #define HAS_SHA1_QUICK 0x1
1208 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1209 static inline int has_sha1_file(const unsigned char *sha1)
1210 {
1211 return has_sha1_file_with_flags(sha1, 0);
1212 }
1213
1214 /* Same as the above, except for struct object_id. */
1215 extern int has_object_file(const struct object_id *oid);
1216 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1217
1218 /*
1219 * Return true iff an alternate object database has a loose object
1220 * with the specified name. This function does not respect replace
1221 * references.
1222 */
1223 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1224
1225 extern int has_pack_index(const unsigned char *sha1);
1226
1227 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1228
1229 extern const signed char hexval_table[256];
1230 static inline unsigned int hexval(unsigned char c)
1231 {
1232 return hexval_table[c];
1233 }
1234
1235 /*
1236 * Convert two consecutive hexadecimal digits into a char. Return a
1237 * negative value on error. Don't run over the end of short strings.
1238 */
1239 static inline int hex2chr(const char *s)
1240 {
1241 int val = hexval(s[0]);
1242 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1243 }
1244
1245 /* Convert to/from hex/sha1 representation */
1246 #define MINIMUM_ABBREV minimum_abbrev
1247 #define DEFAULT_ABBREV default_abbrev
1248
1249 /* used when the code does not know or care what the default abbrev is */
1250 #define FALLBACK_DEFAULT_ABBREV 7
1251
1252 struct object_context {
1253 unsigned char tree[20];
1254 char path[PATH_MAX];
1255 unsigned mode;
1256 /*
1257 * symlink_path is only used by get_tree_entry_follow_symlinks,
1258 * and only for symlinks that point outside the repository.
1259 */
1260 struct strbuf symlink_path;
1261 };
1262
1263 #define GET_SHA1_QUIETLY 01
1264 #define GET_SHA1_COMMIT 02
1265 #define GET_SHA1_COMMITTISH 04
1266 #define GET_SHA1_TREE 010
1267 #define GET_SHA1_TREEISH 020
1268 #define GET_SHA1_BLOB 040
1269 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1270 #define GET_SHA1_ONLY_TO_DIE 04000
1271
1272 #define GET_SHA1_DISAMBIGUATORS \
1273 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1274 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1275 GET_SHA1_BLOB)
1276
1277 extern int get_sha1(const char *str, unsigned char *sha1);
1278 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1279 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1280 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1281 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1282 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1283 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1284 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1285
1286 extern int get_oid(const char *str, struct object_id *oid);
1287
1288 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1289 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1290
1291 extern int set_disambiguate_hint_config(const char *var, const char *value);
1292
1293 /*
1294 * Try to read a SHA1 in hexadecimal format from the 40 characters
1295 * starting at hex. Write the 20-byte result to sha1 in binary form.
1296 * Return 0 on success. Reading stops if a NUL is encountered in the
1297 * input, so it is safe to pass this function an arbitrary
1298 * null-terminated string.
1299 */
1300 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1301 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1302
1303 /*
1304 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1305 * and writes the NUL-terminated output to the buffer `out`, which must be at
1306 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1307 * convenience.
1308 *
1309 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1310 * buffers, making it safe to make multiple calls for a single statement, like:
1311 *
1312 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1313 */
1314 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1315 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1316 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1317 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1318
1319 /*
1320 * This reads short-hand syntax that not only evaluates to a commit
1321 * object name, but also can act as if the end user spelled the name
1322 * of the branch from the command line.
1323 *
1324 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1325 * places the name of the branch in the given buf and returns the
1326 * number of characters parsed if successful.
1327 *
1328 * - "<branch>@{upstream}" finds the name of the other ref that
1329 * <branch> is configured to merge with (missing <branch> defaults
1330 * to the current branch), and places the name of the branch in the
1331 * given buf and returns the number of characters parsed if
1332 * successful.
1333 *
1334 * If the input is not of the accepted format, it returns a negative
1335 * number to signal an error.
1336 *
1337 * If the input was ok but there are not N branch switches in the
1338 * reflog, it returns 0.
1339 *
1340 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1341 * expansions: local branches ("refs/heads/"), remote branches
1342 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1343 * allowed, even ones to refs outside of those namespaces.
1344 */
1345 #define INTERPRET_BRANCH_LOCAL (1<<0)
1346 #define INTERPRET_BRANCH_REMOTE (1<<1)
1347 #define INTERPRET_BRANCH_HEAD (1<<2)
1348 extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1349 unsigned allowed);
1350 extern int get_oid_mb(const char *str, struct object_id *oid);
1351
1352 extern int validate_headref(const char *ref);
1353
1354 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1355 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1356 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1357 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1358
1359 extern void *read_object_with_reference(const unsigned char *sha1,
1360 const char *required_type,
1361 unsigned long *size,
1362 unsigned char *sha1_ret);
1363
1364 extern struct object *peel_to_type(const char *name, int namelen,
1365 struct object *o, enum object_type);
1366
1367 struct date_mode {
1368 enum date_mode_type {
1369 DATE_NORMAL = 0,
1370 DATE_RELATIVE,
1371 DATE_SHORT,
1372 DATE_ISO8601,
1373 DATE_ISO8601_STRICT,
1374 DATE_RFC2822,
1375 DATE_STRFTIME,
1376 DATE_RAW,
1377 DATE_UNIX
1378 } type;
1379 const char *strftime_fmt;
1380 int local;
1381 };
1382
1383 /*
1384 * Convenience helper for passing a constant type, like:
1385 *
1386 * show_date(t, tz, DATE_MODE(NORMAL));
1387 */
1388 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1389 struct date_mode *date_mode_from_type(enum date_mode_type type);
1390
1391 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1392 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1393 struct strbuf *timebuf);
1394 int parse_date(const char *date, struct strbuf *out);
1395 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1396 int parse_expiry_date(const char *date, unsigned long *timestamp);
1397 void datestamp(struct strbuf *out);
1398 #define approxidate(s) approxidate_careful((s), NULL)
1399 unsigned long approxidate_careful(const char *, int *);
1400 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1401 void parse_date_format(const char *format, struct date_mode *mode);
1402 int date_overflows(unsigned long date);
1403
1404 #define IDENT_STRICT 1
1405 #define IDENT_NO_DATE 2
1406 #define IDENT_NO_NAME 4
1407 extern const char *git_author_info(int);
1408 extern const char *git_committer_info(int);
1409 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1410 extern const char *fmt_name(const char *name, const char *email);
1411 extern const char *ident_default_name(void);
1412 extern const char *ident_default_email(void);
1413 extern const char *git_editor(void);
1414 extern const char *git_pager(int stdout_is_tty);
1415 extern int git_ident_config(const char *, const char *, void *);
1416 extern void reset_ident_date(void);
1417
1418 struct ident_split {
1419 const char *name_begin;
1420 const char *name_end;
1421 const char *mail_begin;
1422 const char *mail_end;
1423 const char *date_begin;
1424 const char *date_end;
1425 const char *tz_begin;
1426 const char *tz_end;
1427 };
1428 /*
1429 * Signals an success with 0, but time part of the result may be NULL
1430 * if the input lacks timestamp and zone
1431 */
1432 extern int split_ident_line(struct ident_split *, const char *, int);
1433
1434 /*
1435 * Like show_date, but pull the timestamp and tz parameters from
1436 * the ident_split. It will also sanity-check the values and produce
1437 * a well-known sentinel date if they appear bogus.
1438 */
1439 const char *show_ident_date(const struct ident_split *id,
1440 const struct date_mode *mode);
1441
1442 /*
1443 * Compare split idents for equality or strict ordering. Note that we
1444 * compare only the ident part of the line, ignoring any timestamp.
1445 *
1446 * Because there are two fields, we must choose one as the primary key; we
1447 * currently arbitrarily pick the email.
1448 */
1449 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1450
1451 struct checkout {
1452 struct index_state *istate;
1453 const char *base_dir;
1454 int base_dir_len;
1455 unsigned force:1,
1456 quiet:1,
1457 not_new:1,
1458 refresh_cache:1;
1459 };
1460 #define CHECKOUT_INIT { NULL, "" }
1461
1462 #define TEMPORARY_FILENAME_LENGTH 25
1463 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1464
1465 struct cache_def {
1466 struct strbuf path;
1467 int flags;
1468 int track_flags;
1469 int prefix_len_stat_func;
1470 };
1471 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1472 static inline void cache_def_clear(struct cache_def *cache)
1473 {
1474 strbuf_release(&cache->path);
1475 }
1476
1477 extern int has_symlink_leading_path(const char *name, int len);
1478 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1479 extern int check_leading_path(const char *name, int len);
1480 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1481 extern void schedule_dir_for_removal(const char *name, int len);
1482 extern void remove_scheduled_dirs(void);
1483
1484 extern struct alternate_object_database {
1485 struct alternate_object_database *next;
1486
1487 /* see alt_scratch_buf() */
1488 struct strbuf scratch;
1489 size_t base_len;
1490
1491 char path[FLEX_ARRAY];
1492 } *alt_odb_list;
1493 extern void prepare_alt_odb(void);
1494 extern void read_info_alternates(const char * relative_base, int depth);
1495 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1496 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1497 extern int foreach_alt_odb(alt_odb_fn, void*);
1498
1499 /*
1500 * Allocate a "struct alternate_object_database" but do _not_ actually
1501 * add it to the list of alternates.
1502 */
1503 struct alternate_object_database *alloc_alt_odb(const char *dir);
1504
1505 /*
1506 * Add the directory to the on-disk alternates file; the new entry will also
1507 * take effect in the current process.
1508 */
1509 extern void add_to_alternates_file(const char *dir);
1510
1511 /*
1512 * Add the directory to the in-memory list of alternates (along with any
1513 * recursive alternates it points to), but do not modify the on-disk alternates
1514 * file.
1515 */
1516 extern void add_to_alternates_memory(const char *dir);
1517
1518 /*
1519 * Returns a scratch strbuf pre-filled with the alternate object directory,
1520 * including a trailing slash, which can be used to access paths in the
1521 * alternate. Always use this over direct access to alt->scratch, as it
1522 * cleans up any previous use of the scratch buffer.
1523 */
1524 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1525
1526 struct pack_window {
1527 struct pack_window *next;
1528 unsigned char *base;
1529 off_t offset;
1530 size_t len;
1531 unsigned int last_used;
1532 unsigned int inuse_cnt;
1533 };
1534
1535 extern struct packed_git {
1536 struct packed_git *next;
1537 struct pack_window *windows;
1538 off_t pack_size;
1539 const void *index_data;
1540 size_t index_size;
1541 uint32_t num_objects;
1542 uint32_t num_bad_objects;
1543 unsigned char *bad_object_sha1;
1544 int index_version;
1545 time_t mtime;
1546 int pack_fd;
1547 unsigned pack_local:1,
1548 pack_keep:1,
1549 freshened:1,
1550 do_not_close:1;
1551 unsigned char sha1[20];
1552 struct revindex_entry *revindex;
1553 /* something like ".git/objects/pack/xxxxx.pack" */
1554 char pack_name[FLEX_ARRAY]; /* more */
1555 } *packed_git;
1556
1557 /*
1558 * A most-recently-used ordered version of the packed_git list, which can
1559 * be iterated instead of packed_git (and marked via mru_mark).
1560 */
1561 struct mru;
1562 extern struct mru *packed_git_mru;
1563
1564 struct pack_entry {
1565 off_t offset;
1566 unsigned char sha1[20];
1567 struct packed_git *p;
1568 };
1569
1570 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1571
1572 /* A hook to report invalid files in pack directory */
1573 #define PACKDIR_FILE_PACK 1
1574 #define PACKDIR_FILE_IDX 2
1575 #define PACKDIR_FILE_GARBAGE 4
1576 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1577
1578 extern void prepare_packed_git(void);
1579 extern void reprepare_packed_git(void);
1580 extern void install_packed_git(struct packed_git *pack);
1581
1582 /*
1583 * Give a rough count of objects in the repository. This sacrifices accuracy
1584 * for speed.
1585 */
1586 unsigned long approximate_object_count(void);
1587
1588 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1589 struct packed_git *packs);
1590
1591 extern void pack_report(void);
1592
1593 /*
1594 * Create a temporary file rooted in the object database directory.
1595 */
1596 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
1597
1598 /*
1599 * Generate the filename to be used for a pack file with checksum "sha1" and
1600 * extension "ext". The result is written into the strbuf "buf", overwriting
1601 * any existing contents. A pointer to buf->buf is returned as a convenience.
1602 *
1603 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
1604 */
1605 extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
1606
1607 /*
1608 * Create a pack .keep file named "name" (which should generally be the output
1609 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1610 * error.
1611 */
1612 extern int odb_pack_keep(const char *name);
1613
1614 /*
1615 * mmap the index file for the specified packfile (if it is not
1616 * already mmapped). Return 0 on success.
1617 */
1618 extern int open_pack_index(struct packed_git *);
1619
1620 /*
1621 * munmap the index file for the specified packfile (if it is
1622 * currently mmapped).
1623 */
1624 extern void close_pack_index(struct packed_git *);
1625
1626 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1627 extern void close_pack_windows(struct packed_git *);
1628 extern void close_all_packs(void);
1629 extern void unuse_pack(struct pack_window **);
1630 extern void clear_delta_base_cache(void);
1631 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1632
1633 /*
1634 * Make sure that a pointer access into an mmap'd index file is within bounds,
1635 * and can provide at least 8 bytes of data.
1636 *
1637 * Note that this is only necessary for variable-length segments of the file
1638 * (like the 64-bit extended offset table), as we compare the size to the
1639 * fixed-length parts when we open the file.
1640 */
1641 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1642
1643 /*
1644 * Return the SHA-1 of the nth object within the specified packfile.
1645 * Open the index if it is not already open. The return value points
1646 * at the SHA-1 within the mmapped index. Return NULL if there is an
1647 * error.
1648 */
1649 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1650
1651 /*
1652 * Return the offset of the nth object within the specified packfile.
1653 * The index must already be opened.
1654 */
1655 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1656
1657 /*
1658 * If the object named sha1 is present in the specified packfile,
1659 * return its offset within the packfile; otherwise, return 0.
1660 */
1661 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1662
1663 extern int is_pack_valid(struct packed_git *);
1664 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1665 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1666 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1667 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1668
1669 /*
1670 * Iterate over the files in the loose-object parts of the object
1671 * directory "path", triggering the following callbacks:
1672 *
1673 * - loose_object is called for each loose object we find.
1674 *
1675 * - loose_cruft is called for any files that do not appear to be
1676 * loose objects. Note that we only look in the loose object
1677 * directories "objects/[0-9a-f]{2}/", so we will not report
1678 * "objects/foobar" as cruft.
1679 *
1680 * - loose_subdir is called for each top-level hashed subdirectory
1681 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1682 * after the objects in the directory are processed.
1683 *
1684 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1685 * will end the iteration.
1686 *
1687 * In the "buf" variant, "path" is a strbuf which will also be used as a
1688 * scratch buffer, but restored to its original contents before
1689 * the function returns.
1690 */
1691 typedef int each_loose_object_fn(const unsigned char *sha1,
1692 const char *path,
1693 void *data);
1694 typedef int each_loose_cruft_fn(const char *basename,
1695 const char *path,
1696 void *data);
1697 typedef int each_loose_subdir_fn(int nr,
1698 const char *path,
1699 void *data);
1700 int for_each_loose_file_in_objdir(const char *path,
1701 each_loose_object_fn obj_cb,
1702 each_loose_cruft_fn cruft_cb,
1703 each_loose_subdir_fn subdir_cb,
1704 void *data);
1705 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1706 each_loose_object_fn obj_cb,
1707 each_loose_cruft_fn cruft_cb,
1708 each_loose_subdir_fn subdir_cb,
1709 void *data);
1710
1711 /*
1712 * Iterate over loose and packed objects in both the local
1713 * repository and any alternates repositories (unless the
1714 * LOCAL_ONLY flag is set).
1715 */
1716 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1717 typedef int each_packed_object_fn(const unsigned char *sha1,
1718 struct packed_git *pack,
1719 uint32_t pos,
1720 void *data);
1721 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1722 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1723
1724 struct object_info {
1725 /* Request */
1726 enum object_type *typep;
1727 unsigned long *sizep;
1728 off_t *disk_sizep;
1729 unsigned char *delta_base_sha1;
1730 struct strbuf *typename;
1731
1732 /* Response */
1733 enum {
1734 OI_CACHED,
1735 OI_LOOSE,
1736 OI_PACKED,
1737 OI_DBCACHED
1738 } whence;
1739 union {
1740 /*
1741 * struct {
1742 * ... Nothing to expose in this case
1743 * } cached;
1744 * struct {
1745 * ... Nothing to expose in this case
1746 * } loose;
1747 */
1748 struct {
1749 struct packed_git *pack;
1750 off_t offset;
1751 unsigned int is_delta;
1752 } packed;
1753 } u;
1754 };
1755
1756 /*
1757 * Initializer for a "struct object_info" that wants no items. You may
1758 * also memset() the memory to all-zeroes.
1759 */
1760 #define OBJECT_INFO_INIT {NULL}
1761
1762 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1763 extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
1764
1765 /* Dumb servers support */
1766 extern int update_server_info(int);
1767
1768 /* git_config_parse_key() returns these negated: */
1769 #define CONFIG_INVALID_KEY 1
1770 #define CONFIG_NO_SECTION_OR_NAME 2
1771 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1772 #define CONFIG_NO_LOCK -1
1773 #define CONFIG_INVALID_FILE 3
1774 #define CONFIG_NO_WRITE 4
1775 #define CONFIG_NOTHING_SET 5
1776 #define CONFIG_INVALID_PATTERN 6
1777 #define CONFIG_GENERIC_ERROR 7
1778
1779 #define CONFIG_REGEX_NONE ((void *)1)
1780
1781 struct git_config_source {
1782 unsigned int use_stdin:1;
1783 const char *file;
1784 const char *blob;
1785 };
1786
1787 enum config_origin_type {
1788 CONFIG_ORIGIN_BLOB,
1789 CONFIG_ORIGIN_FILE,
1790 CONFIG_ORIGIN_STDIN,
1791 CONFIG_ORIGIN_SUBMODULE_BLOB,
1792 CONFIG_ORIGIN_CMDLINE
1793 };
1794
1795 typedef int (*config_fn_t)(const char *, const char *, void *);
1796 extern int git_default_config(const char *, const char *, void *);
1797 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1798 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1799 const char *name, const char *buf, size_t len, void *data);
1800 extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,
1801 const unsigned char *sha1, void *data);
1802 extern void git_config_push_parameter(const char *text);
1803 extern int git_config_from_parameters(config_fn_t fn, void *data);
1804 extern void git_config(config_fn_t fn, void *);
1805 extern int git_config_with_options(config_fn_t fn, void *,
1806 struct git_config_source *config_source,
1807 int respect_includes);
1808 extern int git_parse_ulong(const char *, unsigned long *);
1809 extern int git_parse_maybe_bool(const char *);
1810 extern int git_config_int(const char *, const char *);
1811 extern int64_t git_config_int64(const char *, const char *);
1812 extern unsigned long git_config_ulong(const char *, const char *);
1813 extern int git_config_bool_or_int(const char *, const char *, int *);
1814 extern int git_config_bool(const char *, const char *);
1815 extern int git_config_maybe_bool(const char *, const char *);
1816 extern int git_config_string(const char **, const char *, const char *);
1817 extern int git_config_pathname(const char **, const char *, const char *);
1818 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1819 extern void git_config_set_in_file(const char *, const char *, const char *);
1820 extern int git_config_set_gently(const char *, const char *);
1821 extern void git_config_set(const char *, const char *);
1822 extern int git_config_parse_key(const char *, char **, int *);
1823 extern int git_config_key_is_valid(const char *key);
1824 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1825 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1826 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1827 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1828 extern int git_config_rename_section(const char *, const char *);
1829 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1830 extern const char *git_etc_gitconfig(void);
1831 extern int git_env_bool(const char *, int);
1832 extern unsigned long git_env_ulong(const char *, unsigned long);
1833 extern int git_config_system(void);
1834 extern int config_error_nonbool(const char *);
1835 #if defined(__GNUC__)
1836 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1837 #endif
1838 extern const char *get_log_output_encoding(void);
1839 extern const char *get_commit_output_encoding(void);
1840
1841 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1842
1843 enum config_scope {
1844 CONFIG_SCOPE_UNKNOWN = 0,
1845 CONFIG_SCOPE_SYSTEM,
1846 CONFIG_SCOPE_GLOBAL,
1847 CONFIG_SCOPE_REPO,
1848 CONFIG_SCOPE_CMDLINE,
1849 };
1850
1851 extern enum config_scope current_config_scope(void);
1852 extern const char *current_config_origin_type(void);
1853 extern const char *current_config_name(void);
1854
1855 struct config_include_data {
1856 int depth;
1857 config_fn_t fn;
1858 void *data;
1859 };
1860 #define CONFIG_INCLUDE_INIT { 0 }
1861 extern int git_config_include(const char *name, const char *value, void *data);
1862
1863 /*
1864 * Match and parse a config key of the form:
1865 *
1866 * section.(subsection.)?key
1867 *
1868 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1869 * we return -1 if it does not match, 0 otherwise. The subsection and key
1870 * out-parameters are filled by the function (and *subsection is NULL if it is
1871 * missing).
1872 *
1873 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
1874 * there is no subsection at all.
1875 */
1876 extern int parse_config_key(const char *var,
1877 const char *section,
1878 const char **subsection, int *subsection_len,
1879 const char **key);
1880
1881 struct config_set_element {
1882 struct hashmap_entry ent;
1883 char *key;
1884 struct string_list value_list;
1885 };
1886
1887 struct configset_list_item {
1888 struct config_set_element *e;
1889 int value_index;
1890 };
1891
1892 /*
1893 * the contents of the list are ordered according to their
1894 * position in the config files and order of parsing the files.
1895 * (i.e. key-value pair at the last position of .git/config will
1896 * be at the last item of the list)
1897 */
1898 struct configset_list {
1899 struct configset_list_item *items;
1900 unsigned int nr, alloc;
1901 };
1902
1903 struct config_set {
1904 struct hashmap config_hash;
1905 int hash_initialized;
1906 struct configset_list list;
1907 };
1908
1909 extern void git_configset_init(struct config_set *cs);
1910 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1911 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1912 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1913 extern void git_configset_clear(struct config_set *cs);
1914 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1915 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1916 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1917 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1918 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1919 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1920 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1921 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1922
1923 extern int git_config_get_value(const char *key, const char **value);
1924 extern const struct string_list *git_config_get_value_multi(const char *key);
1925 extern void git_config_clear(void);
1926 extern void git_config_iter(config_fn_t fn, void *data);
1927 extern int git_config_get_string_const(const char *key, const char **dest);
1928 extern int git_config_get_string(const char *key, char **dest);
1929 extern int git_config_get_int(const char *key, int *dest);
1930 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1931 extern int git_config_get_bool(const char *key, int *dest);
1932 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1933 extern int git_config_get_maybe_bool(const char *key, int *dest);
1934 extern int git_config_get_pathname(const char *key, const char **dest);
1935 extern int git_config_get_untracked_cache(void);
1936
1937 /*
1938 * This is a hack for test programs like test-dump-untracked-cache to
1939 * ensure that they do not modify the untracked cache when reading it.
1940 * Do not use it otherwise!
1941 */
1942 extern int ignore_untracked_cache_config;
1943
1944 struct key_value_info {
1945 const char *filename;
1946 int linenr;
1947 enum config_origin_type origin_type;
1948 enum config_scope scope;
1949 };
1950
1951 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1952 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1953
1954 extern int committer_ident_sufficiently_given(void);
1955 extern int author_ident_sufficiently_given(void);
1956
1957 extern const char *git_commit_encoding;
1958 extern const char *git_log_output_encoding;
1959 extern const char *git_mailmap_file;
1960 extern const char *git_mailmap_blob;
1961
1962 /* IO helper functions */
1963 extern void maybe_flush_or_die(FILE *, const char *);
1964 __attribute__((format (printf, 2, 3)))
1965 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1966
1967 #define COPY_READ_ERROR (-2)
1968 #define COPY_WRITE_ERROR (-3)
1969 extern int copy_fd(int ifd, int ofd);
1970 extern int copy_file(const char *dst, const char *src, int mode);
1971 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1972
1973 extern void write_or_die(int fd, const void *buf, size_t count);
1974 extern void fsync_or_die(int fd, const char *);
1975
1976 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1977 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1978 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1979
1980 static inline ssize_t write_str_in_full(int fd, const char *str)
1981 {
1982 return write_in_full(fd, str, strlen(str));
1983 }
1984
1985 /**
1986 * Open (and truncate) the file at path, write the contents of buf to it,
1987 * and close it. Dies if any errors are encountered.
1988 */
1989 extern void write_file_buf(const char *path, const char *buf, size_t len);
1990
1991 /**
1992 * Like write_file_buf(), but format the contents into a buffer first.
1993 * Additionally, write_file() will append a newline if one is not already
1994 * present, making it convenient to write text files:
1995 *
1996 * write_file(path, "counter: %d", ctr);
1997 */
1998 __attribute__((format (printf, 2, 3)))
1999 extern void write_file(const char *path, const char *fmt, ...);
2000
2001 /* pager.c */
2002 extern void setup_pager(void);
2003 extern int pager_in_use(void);
2004 extern int pager_use_color;
2005 extern int term_columns(void);
2006 extern int decimal_width(uintmax_t);
2007 extern int check_pager_config(const char *cmd);
2008 extern void prepare_pager_args(struct child_process *, const char *pager);
2009
2010 extern const char *editor_program;
2011 extern const char *askpass_program;
2012 extern const char *excludes_file;
2013
2014 /* base85 */
2015 int decode_85(char *dst, const char *line, int linelen);
2016 void encode_85(char *buf, const unsigned char *data, int bytes);
2017
2018 /* alloc.c */
2019 extern void *alloc_blob_node(void);
2020 extern void *alloc_tree_node(void);
2021 extern void *alloc_commit_node(void);
2022 extern void *alloc_tag_node(void);
2023 extern void *alloc_object_node(void);
2024 extern void alloc_report(void);
2025 extern unsigned int alloc_commit_index(void);
2026
2027 /* pkt-line.c */
2028 void packet_trace_identity(const char *prog);
2029
2030 /* add */
2031 /*
2032 * return 0 if success, 1 - if addition of a file failed and
2033 * ADD_FILES_IGNORE_ERRORS was specified in flags
2034 */
2035 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
2036
2037 /* diff.c */
2038 extern int diff_auto_refresh_index;
2039
2040 /* match-trees.c */
2041 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
2042 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
2043
2044 /*
2045 * whitespace rules.
2046 * used by both diff and apply
2047 * last two digits are tab width
2048 */
2049 #define WS_BLANK_AT_EOL 0100
2050 #define WS_SPACE_BEFORE_TAB 0200
2051 #define WS_INDENT_WITH_NON_TAB 0400
2052 #define WS_CR_AT_EOL 01000
2053 #define WS_BLANK_AT_EOF 02000
2054 #define WS_TAB_IN_INDENT 04000
2055 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
2056 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
2057 #define WS_TAB_WIDTH_MASK 077
2058 extern unsigned whitespace_rule_cfg;
2059 extern unsigned whitespace_rule(const char *);
2060 extern unsigned parse_whitespace_rule(const char *);
2061 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
2062 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
2063 extern char *whitespace_error_string(unsigned ws);
2064 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
2065 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
2066 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
2067
2068 /* ls-files */
2069 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
2070
2071 char *alias_lookup(const char *alias);
2072 int split_cmdline(char *cmdline, const char ***argv);
2073 /* Takes a negative value returned by split_cmdline */
2074 const char *split_cmdline_strerror(int cmdline_errno);
2075
2076 /* setup.c */
2077 struct startup_info {
2078 int have_repository;
2079 const char *prefix;
2080 };
2081 extern struct startup_info *startup_info;
2082
2083 /* merge.c */
2084 struct commit_list;
2085 int try_merge_command(const char *strategy, size_t xopts_nr,
2086 const char **xopts, struct commit_list *common,
2087 const char *head_arg, struct commit_list *remotes);
2088 int checkout_fast_forward(const unsigned char *from,
2089 const unsigned char *to,
2090 int overwrite_ignore);
2091
2092
2093 int sane_execvp(const char *file, char *const argv[]);
2094
2095 /*
2096 * A struct to encapsulate the concept of whether a file has changed
2097 * since we last checked it. This uses criteria similar to those used
2098 * for the index.
2099 */
2100 struct stat_validity {
2101 struct stat_data *sd;
2102 };
2103
2104 void stat_validity_clear(struct stat_validity *sv);
2105
2106 /*
2107 * Returns 1 if the path is a regular file (or a symlink to a regular
2108 * file) and matches the saved stat_validity, 0 otherwise. A missing
2109 * or inaccessible file is considered a match if the struct was just
2110 * initialized, or if the previous update found an inaccessible file.
2111 */
2112 int stat_validity_check(struct stat_validity *sv, const char *path);
2113
2114 /*
2115 * Update the stat_validity from a file opened at descriptor fd. If
2116 * the file is missing, inaccessible, or not a regular file, then
2117 * future calls to stat_validity_check will match iff one of those
2118 * conditions continues to be true.
2119 */
2120 void stat_validity_update(struct stat_validity *sv, int fd);
2121
2122 int versioncmp(const char *s1, const char *s2);
2123 void sleep_millisec(int millisec);
2124
2125 /*
2126 * Create a directory and (if share is nonzero) adjust its permissions
2127 * according to the shared_repository setting. Only use this for
2128 * directories under $GIT_DIR. Don't use it for working tree
2129 * directories.
2130 */
2131 void safe_create_dir(const char *dir, int share);
2132
2133 #endif /* CACHE_H */