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