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