Merge branch 'maint'
[git/mjg.git] / cache.h
blob08a902210c6374c65f94a1238d895a65c7cde43a
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hash.h"
7 #include "advice.h"
9 #include SHA1_HEADER
10 #ifndef git_SHA_CTX
11 #define git_SHA_CTX SHA_CTX
12 #define git_SHA1_Init SHA1_Init
13 #define git_SHA1_Update SHA1_Update
14 #define git_SHA1_Final SHA1_Final
15 #endif
17 #include <zlib.h>
18 #if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
19 #define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
20 #endif
22 void git_inflate_init(z_streamp strm);
23 void git_inflate_end(z_streamp strm);
24 int git_inflate(z_streamp strm, int flush);
26 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
27 #define DTYPE(de) ((de)->d_type)
28 #else
29 #undef DT_UNKNOWN
30 #undef DT_DIR
31 #undef DT_REG
32 #undef DT_LNK
33 #define DT_UNKNOWN 0
34 #define DT_DIR 1
35 #define DT_REG 2
36 #define DT_LNK 3
37 #define DTYPE(de) DT_UNKNOWN
38 #endif
40 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
41 #define S_IFINVALID 0030000
44 * A "directory link" is a link to another git directory.
46 * The value 0160000 is not normally a valid mode, and
47 * also just happens to be S_IFDIR + S_IFLNK
49 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
50 * always having the same values everywhere. We should use
51 * our internal git values for these things, and then we can
52 * translate that to the OS-specific value. It just so
53 * happens that everybody shares the same bit representation
54 * in the UNIX world (and apparently wider too..)
56 #define S_IFGITLINK 0160000
57 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
60 * Intensive research over the course of many years has shown that
61 * port 9418 is totally unused by anything else. Or
63 * Your search - "port 9418" - did not match any documents.
65 * as www.google.com puts it.
67 * This port has been properly assigned for git use by IANA:
68 * git (Assigned-9418) [I06-050728-0001].
70 * git 9418/tcp git pack transfer service
71 * git 9418/udp git pack transfer service
73 * with Linus Torvalds <torvalds@osdl.org> as the point of
74 * contact. September 2005.
76 * See http://www.iana.org/assignments/port-numbers
78 #define DEFAULT_GIT_PORT 9418
81 * Basic data structures for the directory cache
84 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
85 struct cache_header {
86 unsigned int hdr_signature;
87 unsigned int hdr_version;
88 unsigned int hdr_entries;
92 * The "cache_time" is just the low 32 bits of the
93 * time. It doesn't matter if it overflows - we only
94 * check it for equality in the 32 bits we save.
96 struct cache_time {
97 unsigned int sec;
98 unsigned int nsec;
102 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
103 * Again - this is just a (very strong in practice) heuristic that
104 * the inode hasn't changed.
106 * We save the fields in big-endian order to allow using the
107 * index file over NFS transparently.
109 struct ondisk_cache_entry {
110 struct cache_time ctime;
111 struct cache_time mtime;
112 unsigned int dev;
113 unsigned int ino;
114 unsigned int mode;
115 unsigned int uid;
116 unsigned int gid;
117 unsigned int size;
118 unsigned char sha1[20];
119 unsigned short flags;
120 char name[FLEX_ARRAY]; /* more */
124 * This struct is used when CE_EXTENDED bit is 1
125 * The struct must match ondisk_cache_entry exactly from
126 * ctime till flags
128 struct ondisk_cache_entry_extended {
129 struct cache_time ctime;
130 struct cache_time mtime;
131 unsigned int dev;
132 unsigned int ino;
133 unsigned int mode;
134 unsigned int uid;
135 unsigned int gid;
136 unsigned int size;
137 unsigned char sha1[20];
138 unsigned short flags;
139 unsigned short flags2;
140 char name[FLEX_ARRAY]; /* more */
143 struct cache_entry {
144 struct cache_time ce_ctime;
145 struct cache_time ce_mtime;
146 unsigned int ce_dev;
147 unsigned int ce_ino;
148 unsigned int ce_mode;
149 unsigned int ce_uid;
150 unsigned int ce_gid;
151 unsigned int ce_size;
152 unsigned int ce_flags;
153 unsigned char sha1[20];
154 struct cache_entry *next;
155 char name[FLEX_ARRAY]; /* more */
158 #define CE_NAMEMASK (0x0fff)
159 #define CE_STAGEMASK (0x3000)
160 #define CE_EXTENDED (0x4000)
161 #define CE_VALID (0x8000)
162 #define CE_STAGESHIFT 12
165 * Range 0xFFFF0000 in ce_flags is divided into
166 * two parts: in-memory flags and on-disk ones.
167 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
168 * if you want to save a new flag, add it in
169 * CE_EXTENDED_FLAGS
171 * In-memory only flags
173 #define CE_UPDATE (1 << 16)
174 #define CE_REMOVE (1 << 17)
175 #define CE_UPTODATE (1 << 18)
176 #define CE_ADDED (1 << 19)
178 #define CE_HASHED (1 << 20)
179 #define CE_UNHASHED (1 << 21)
180 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
181 #define CE_CONFLICTED (1 << 23)
183 #define CE_UNPACKED (1 << 24)
184 #define CE_NEW_SKIP_WORKTREE (1 << 25)
187 * Extended on-disk flags
189 #define CE_INTENT_TO_ADD (1 << 29)
190 #define CE_SKIP_WORKTREE (1 << 30)
191 /* CE_EXTENDED2 is for future extension */
192 #define CE_EXTENDED2 (1 << 31)
194 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
197 * Safeguard to avoid saving wrong flags:
198 * - CE_EXTENDED2 won't get saved until its semantic is known
199 * - Bits in 0x0000FFFF have been saved in ce_flags already
200 * - Bits in 0x003F0000 are currently in-memory flags
202 #if CE_EXTENDED_FLAGS & 0x803FFFFF
203 #error "CE_EXTENDED_FLAGS out of range"
204 #endif
207 * Copy the sha1 and stat state of a cache entry from one to
208 * another. But we never change the name, or the hash state!
210 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
211 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
213 unsigned int state = dst->ce_flags & CE_STATE_MASK;
215 /* Don't copy hash chain and name */
216 memcpy(dst, src, offsetof(struct cache_entry, next));
218 /* Restore the hash state */
219 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
222 static inline unsigned create_ce_flags(size_t len, unsigned stage)
224 if (len >= CE_NAMEMASK)
225 len = CE_NAMEMASK;
226 return (len | (stage << CE_STAGESHIFT));
229 static inline size_t ce_namelen(const struct cache_entry *ce)
231 size_t len = ce->ce_flags & CE_NAMEMASK;
232 if (len < CE_NAMEMASK)
233 return len;
234 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
237 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
238 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
239 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
240 ondisk_cache_entry_size(ce_namelen(ce)))
241 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
242 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
243 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
244 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
246 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
247 static inline unsigned int create_ce_mode(unsigned int mode)
249 if (S_ISLNK(mode))
250 return S_IFLNK;
251 if (S_ISDIR(mode) || S_ISGITLINK(mode))
252 return S_IFGITLINK;
253 return S_IFREG | ce_permissions(mode);
255 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
257 extern int trust_executable_bit, has_symlinks;
258 if (!has_symlinks && S_ISREG(mode) &&
259 ce && S_ISLNK(ce->ce_mode))
260 return ce->ce_mode;
261 if (!trust_executable_bit && S_ISREG(mode)) {
262 if (ce && S_ISREG(ce->ce_mode))
263 return ce->ce_mode;
264 return create_ce_mode(0666);
266 return create_ce_mode(mode);
268 static inline int ce_to_dtype(const struct cache_entry *ce)
270 unsigned ce_mode = ntohl(ce->ce_mode);
271 if (S_ISREG(ce_mode))
272 return DT_REG;
273 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
274 return DT_DIR;
275 else if (S_ISLNK(ce_mode))
276 return DT_LNK;
277 else
278 return DT_UNKNOWN;
280 static inline unsigned int canon_mode(unsigned int mode)
282 if (S_ISREG(mode))
283 return S_IFREG | ce_permissions(mode);
284 if (S_ISLNK(mode))
285 return S_IFLNK;
286 if (S_ISDIR(mode))
287 return S_IFDIR;
288 return S_IFGITLINK;
291 #define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
292 #define cache_entry_size(len) flexible_size(cache_entry,len)
293 #define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
294 #define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
296 struct index_state {
297 struct cache_entry **cache;
298 unsigned int cache_nr, cache_alloc, cache_changed;
299 struct string_list *resolve_undo;
300 struct cache_tree *cache_tree;
301 struct cache_time timestamp;
302 void *alloc;
303 unsigned name_hash_initialized : 1,
304 initialized : 1;
305 struct hash_table name_hash;
308 extern struct index_state the_index;
310 /* Name hashing */
311 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
313 * We don't actually *remove* it, we can just mark it invalid so that
314 * we won't find it in lookups.
316 * Not only would we have to search the lists (simple enough), but
317 * we'd also have to rehash other hash buckets in case this makes the
318 * hash bucket empty (common). So it's much better to just mark
319 * it.
321 static inline void remove_name_hash(struct cache_entry *ce)
323 ce->ce_flags |= CE_UNHASHED;
327 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
328 #define active_cache (the_index.cache)
329 #define active_nr (the_index.cache_nr)
330 #define active_alloc (the_index.cache_alloc)
331 #define active_cache_changed (the_index.cache_changed)
332 #define active_cache_tree (the_index.cache_tree)
334 #define read_cache() read_index(&the_index)
335 #define read_cache_from(path) read_index_from(&the_index, (path))
336 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
337 #define is_cache_unborn() is_index_unborn(&the_index)
338 #define read_cache_unmerged() read_index_unmerged(&the_index)
339 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
340 #define discard_cache() discard_index(&the_index)
341 #define unmerged_cache() unmerged_index(&the_index)
342 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
343 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
344 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
345 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
346 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
347 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
348 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
349 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
350 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
351 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
352 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
353 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
354 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
355 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
356 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
357 #endif
359 enum object_type {
360 OBJ_BAD = -1,
361 OBJ_NONE = 0,
362 OBJ_COMMIT = 1,
363 OBJ_TREE = 2,
364 OBJ_BLOB = 3,
365 OBJ_TAG = 4,
366 /* 5 for future expansion */
367 OBJ_OFS_DELTA = 6,
368 OBJ_REF_DELTA = 7,
369 OBJ_ANY,
370 OBJ_MAX
373 static inline enum object_type object_type(unsigned int mode)
375 return S_ISDIR(mode) ? OBJ_TREE :
376 S_ISGITLINK(mode) ? OBJ_COMMIT :
377 OBJ_BLOB;
380 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
381 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
382 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
383 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
384 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
385 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
386 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
387 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
388 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
389 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
390 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
391 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
392 #define GITATTRIBUTES_FILE ".gitattributes"
393 #define INFOATTRIBUTES_FILE "info/attributes"
394 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
395 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
396 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
397 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
398 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
399 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
402 * Repository-local GIT_* environment variables
403 * The array is NULL-terminated to simplify its usage in contexts such
404 * environment creation or simple walk of the list.
405 * The number of non-NULL entries is available as a macro.
407 #define LOCAL_REPO_ENV_SIZE 9
408 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
410 extern int is_bare_repository_cfg;
411 extern int is_bare_repository(void);
412 extern int is_inside_git_dir(void);
413 extern char *git_work_tree_cfg;
414 extern int is_inside_work_tree(void);
415 extern int have_git_dir(void);
416 extern const char *get_git_dir(void);
417 extern char *get_object_directory(void);
418 extern char *get_index_file(void);
419 extern char *get_graft_file(void);
420 extern int set_git_dir(const char *path);
421 extern const char *get_git_work_tree(void);
422 extern const char *read_gitfile_gently(const char *path);
423 extern void set_git_work_tree(const char *tree);
425 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
427 extern const char **get_pathspec(const char *prefix, const char **pathspec);
428 extern void setup_work_tree(void);
429 extern const char *setup_git_directory_gently(int *);
430 extern const char *setup_git_directory(void);
431 extern char *prefix_path(const char *prefix, int len, const char *path);
432 extern const char *prefix_filename(const char *prefix, int len, const char *path);
433 extern int check_filename(const char *prefix, const char *name);
434 extern void verify_filename(const char *prefix, const char *name);
435 extern void verify_non_filename(const char *prefix, const char *name);
437 #define INIT_DB_QUIET 0x0001
439 extern int init_db(const char *template_dir, unsigned int flags);
441 #define alloc_nr(x) (((x)+16)*3/2)
444 * Realloc the buffer pointed at by variable 'x' so that it can hold
445 * at least 'nr' entries; the number of entries currently allocated
446 * is 'alloc', using the standard growing factor alloc_nr() macro.
448 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
450 #define ALLOC_GROW(x, nr, alloc) \
451 do { \
452 if ((nr) > alloc) { \
453 if (alloc_nr(alloc) < (nr)) \
454 alloc = (nr); \
455 else \
456 alloc = alloc_nr(alloc); \
457 x = xrealloc((x), alloc * sizeof(*(x))); \
459 } while (0)
461 /* Initialize and use the cache information */
462 extern int read_index(struct index_state *);
463 extern int read_index_preload(struct index_state *, const char **pathspec);
464 extern int read_index_from(struct index_state *, const char *path);
465 extern int is_index_unborn(struct index_state *);
466 extern int read_index_unmerged(struct index_state *);
467 extern int write_index(struct index_state *, int newfd);
468 extern int discard_index(struct index_state *);
469 extern int unmerged_index(const struct index_state *);
470 extern int verify_path(const char *path);
471 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
472 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
473 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
474 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
475 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
476 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
477 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
478 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
479 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
480 extern int remove_index_entry_at(struct index_state *, int pos);
481 extern void remove_marked_cache_entries(struct index_state *istate);
482 extern int remove_file_from_index(struct index_state *, const char *path);
483 #define ADD_CACHE_VERBOSE 1
484 #define ADD_CACHE_PRETEND 2
485 #define ADD_CACHE_IGNORE_ERRORS 4
486 #define ADD_CACHE_IGNORE_REMOVAL 8
487 #define ADD_CACHE_INTENT 16
488 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
489 extern int add_file_to_index(struct index_state *, const char *path, int flags);
490 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
491 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
492 extern int index_name_is_other(const struct index_state *, const char *, int);
494 /* do stat comparison even if CE_VALID is true */
495 #define CE_MATCH_IGNORE_VALID 01
496 /* do not check the contents but report dirty on racily-clean entries */
497 #define CE_MATCH_RACY_IS_DIRTY 02
498 /* do stat comparison even if CE_SKIP_WORKTREE is true */
499 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
500 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
501 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
503 struct pathspec {
504 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
505 int nr;
506 int has_wildcard:1;
507 int recursive:1;
508 int max_depth;
509 struct pathspec_item {
510 const char *match;
511 int len;
512 int has_wildcard:1;
513 } *items;
516 extern int init_pathspec(struct pathspec *, const char **);
517 extern void free_pathspec(struct pathspec *);
518 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
519 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path, int format_check);
520 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
521 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
523 #define REFRESH_REALLY 0x0001 /* ignore_valid */
524 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
525 #define REFRESH_QUIET 0x0004 /* be quiet about it */
526 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
527 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
528 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
529 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
531 struct lock_file {
532 struct lock_file *next;
533 int fd;
534 pid_t owner;
535 char on_list;
536 char filename[PATH_MAX];
538 #define LOCK_DIE_ON_ERROR 1
539 #define LOCK_NODEREF 2
540 extern int unable_to_lock_error(const char *path, int err);
541 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
542 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
543 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
544 extern int commit_lock_file(struct lock_file *);
546 extern int hold_locked_index(struct lock_file *, int);
547 extern int commit_locked_index(struct lock_file *);
548 extern void set_alternate_index_output(const char *);
549 extern int close_lock_file(struct lock_file *);
550 extern void rollback_lock_file(struct lock_file *);
551 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
553 /* Environment bits from configuration mechanism */
554 extern int trust_executable_bit;
555 extern int trust_ctime;
556 extern int quote_path_fully;
557 extern int has_symlinks;
558 extern int ignore_case;
559 extern int assume_unchanged;
560 extern int prefer_symlink_refs;
561 extern int log_all_ref_updates;
562 extern int warn_ambiguous_refs;
563 extern int unique_abbrev_extra_length;
564 extern int shared_repository;
565 extern const char *apply_default_whitespace;
566 extern const char *apply_default_ignorewhitespace;
567 extern int zlib_compression_level;
568 extern int core_compression_level;
569 extern int core_compression_seen;
570 extern size_t packed_git_window_size;
571 extern size_t packed_git_limit;
572 extern size_t delta_base_cache_limit;
573 extern int read_replace_refs;
574 extern int fsync_object_files;
575 extern int core_preload_index;
576 extern int core_apply_sparse_checkout;
578 enum safe_crlf {
579 SAFE_CRLF_FALSE = 0,
580 SAFE_CRLF_FAIL = 1,
581 SAFE_CRLF_WARN = 2
584 extern enum safe_crlf safe_crlf;
586 enum auto_crlf {
587 AUTO_CRLF_FALSE = 0,
588 AUTO_CRLF_TRUE = 1,
589 AUTO_CRLF_INPUT = -1,
592 extern enum auto_crlf auto_crlf;
594 enum eol {
595 EOL_UNSET,
596 EOL_CRLF,
597 EOL_LF,
598 #ifdef NATIVE_CRLF
599 EOL_NATIVE = EOL_CRLF
600 #else
601 EOL_NATIVE = EOL_LF
602 #endif
605 extern enum eol eol;
607 enum branch_track {
608 BRANCH_TRACK_UNSPECIFIED = -1,
609 BRANCH_TRACK_NEVER = 0,
610 BRANCH_TRACK_REMOTE,
611 BRANCH_TRACK_ALWAYS,
612 BRANCH_TRACK_EXPLICIT,
613 BRANCH_TRACK_OVERRIDE
616 enum rebase_setup_type {
617 AUTOREBASE_NEVER = 0,
618 AUTOREBASE_LOCAL,
619 AUTOREBASE_REMOTE,
620 AUTOREBASE_ALWAYS
623 enum push_default_type {
624 PUSH_DEFAULT_NOTHING = 0,
625 PUSH_DEFAULT_MATCHING,
626 PUSH_DEFAULT_UPSTREAM,
627 PUSH_DEFAULT_CURRENT
630 extern enum branch_track git_branch_track;
631 extern enum rebase_setup_type autorebase;
632 extern enum push_default_type push_default;
634 enum object_creation_mode {
635 OBJECT_CREATION_USES_HARDLINKS = 0,
636 OBJECT_CREATION_USES_RENAMES = 1
639 extern enum object_creation_mode object_creation_mode;
641 extern char *notes_ref_name;
643 extern int grafts_replace_parents;
645 #define GIT_REPO_VERSION 0
646 extern int repository_format_version;
647 extern int check_repository_format(void);
649 #define MTIME_CHANGED 0x0001
650 #define CTIME_CHANGED 0x0002
651 #define OWNER_CHANGED 0x0004
652 #define MODE_CHANGED 0x0008
653 #define INODE_CHANGED 0x0010
654 #define DATA_CHANGED 0x0020
655 #define TYPE_CHANGED 0x0040
657 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
658 __attribute__((format (printf, 3, 4)));
659 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
660 __attribute__((format (printf, 3, 4)));
661 extern char *git_pathdup(const char *fmt, ...)
662 __attribute__((format (printf, 1, 2)));
664 /* Return a statically allocated filename matching the sha1 signature */
665 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
666 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
667 extern char *git_path_submodule(const char *path, const char *fmt, ...)
668 __attribute__((format (printf, 2, 3)));
670 extern char *sha1_file_name(const unsigned char *sha1);
671 extern char *sha1_pack_name(const unsigned char *sha1);
672 extern char *sha1_pack_index_name(const unsigned char *sha1);
673 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
674 extern const unsigned char null_sha1[20];
675 static inline int is_null_sha1(const unsigned char *sha1)
677 return !memcmp(sha1, null_sha1, 20);
679 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
681 return memcmp(sha1, sha2, 20);
683 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
685 memcpy(sha_dst, sha_src, 20);
687 static inline void hashclr(unsigned char *hash)
689 memset(hash, 0, 20);
692 #define EMPTY_TREE_SHA1_HEX \
693 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
694 #define EMPTY_TREE_SHA1_BIN_LITERAL \
695 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
696 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
697 #define EMPTY_TREE_SHA1_BIN \
698 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
700 int git_mkstemp(char *path, size_t n, const char *template);
702 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
704 /* set default permissions by passing mode arguments to open(2) */
705 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
706 int git_mkstemp_mode(char *pattern, int mode);
709 * NOTE NOTE NOTE!!
711 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
712 * not be changed. Old repositories have core.sharedrepository written in
713 * numeric format, and therefore these values are preserved for compatibility
714 * reasons.
716 enum sharedrepo {
717 PERM_UMASK = 0,
718 OLD_PERM_GROUP = 1,
719 OLD_PERM_EVERYBODY = 2,
720 PERM_GROUP = 0660,
721 PERM_EVERYBODY = 0664
723 int git_config_perm(const char *var, const char *value);
724 int set_shared_perm(const char *path, int mode);
725 #define adjust_shared_perm(path) set_shared_perm((path), 0)
726 int safe_create_leading_directories(char *path);
727 int safe_create_leading_directories_const(const char *path);
728 extern char *expand_user_path(const char *path);
729 char *enter_repo(char *path, int strict);
730 static inline int is_absolute_path(const char *path)
732 return path[0] == '/' || has_dos_drive_prefix(path);
734 int is_directory(const char *);
735 const char *make_absolute_path(const char *path);
736 const char *make_nonrelative_path(const char *path);
737 const char *make_relative_path(const char *abs, const char *base);
738 int normalize_path_copy(char *dst, const char *src);
739 int longest_ancestor_length(const char *path, const char *prefix_list);
740 char *strip_path_suffix(const char *path, const char *suffix);
741 int daemon_avoid_alias(const char *path);
742 int offset_1st_component(const char *path);
744 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
745 extern int sha1_object_info(const unsigned char *, unsigned long *);
746 extern void *read_sha1_file_repl(const unsigned char *sha1, enum object_type *type, unsigned long *size, const unsigned char **replacement);
747 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
749 return read_sha1_file_repl(sha1, type, size, NULL);
751 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
752 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
753 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
754 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
756 /* global flag to enable extra checks when accessing packed objects */
757 extern int do_check_packed_object_crc;
759 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
761 extern int move_temp_to_file(const char *tmpfile, const char *filename);
763 extern int has_sha1_pack(const unsigned char *sha1);
764 extern int has_sha1_file(const unsigned char *sha1);
765 extern int has_loose_object_nonlocal(const unsigned char *sha1);
767 extern int has_pack_index(const unsigned char *sha1);
769 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
771 extern const signed char hexval_table[256];
772 static inline unsigned int hexval(unsigned char c)
774 return hexval_table[c];
777 /* Convert to/from hex/sha1 representation */
778 #define MINIMUM_ABBREV 4
779 #define DEFAULT_ABBREV 7
781 struct object_context {
782 unsigned char tree[20];
783 char path[PATH_MAX];
784 unsigned mode;
787 extern int get_sha1(const char *str, unsigned char *sha1);
788 extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int gently, const char *prefix);
789 static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
791 return get_sha1_with_mode_1(str, sha1, mode, 1, NULL);
793 extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int gently, const char *prefix);
794 static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
796 return get_sha1_with_context_1(str, sha1, orc, 1, NULL);
798 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
799 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
800 extern int read_ref(const char *filename, unsigned char *sha1);
801 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
802 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
803 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
804 extern int interpret_branch_name(const char *str, struct strbuf *);
805 extern int get_sha1_mb(const char *str, unsigned char *sha1);
807 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
808 extern const char *ref_rev_parse_rules[];
809 extern const char *ref_fetch_rules[];
811 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
812 extern int validate_headref(const char *ref);
814 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
815 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
816 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
818 extern void *read_object_with_reference(const unsigned char *sha1,
819 const char *required_type,
820 unsigned long *size,
821 unsigned char *sha1_ret);
823 extern struct object *peel_to_type(const char *name, int namelen,
824 struct object *o, enum object_type);
826 enum date_mode {
827 DATE_NORMAL = 0,
828 DATE_RELATIVE,
829 DATE_SHORT,
830 DATE_LOCAL,
831 DATE_ISO8601,
832 DATE_RFC2822,
833 DATE_RAW
836 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
837 const char *show_date_relative(unsigned long time, int tz,
838 const struct timeval *now,
839 char *timebuf,
840 size_t timebuf_size);
841 int parse_date(const char *date, char *buf, int bufsize);
842 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
843 void datestamp(char *buf, int bufsize);
844 #define approxidate(s) approxidate_careful((s), NULL)
845 unsigned long approxidate_careful(const char *, int *);
846 unsigned long approxidate_relative(const char *date, const struct timeval *now);
847 enum date_mode parse_date_format(const char *format);
849 #define IDENT_WARN_ON_NO_NAME 1
850 #define IDENT_ERROR_ON_NO_NAME 2
851 #define IDENT_NO_DATE 4
852 extern const char *git_author_info(int);
853 extern const char *git_committer_info(int);
854 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
855 extern const char *fmt_name(const char *name, const char *email);
856 extern const char *git_editor(void);
857 extern const char *git_pager(int stdout_is_tty);
859 struct checkout {
860 const char *base_dir;
861 int base_dir_len;
862 unsigned force:1,
863 quiet:1,
864 not_new:1,
865 refresh_cache:1;
868 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
870 struct cache_def {
871 char path[PATH_MAX + 1];
872 int len;
873 int flags;
874 int track_flags;
875 int prefix_len_stat_func;
878 extern int has_symlink_leading_path(const char *name, int len);
879 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
880 extern int check_leading_path(const char *name, int len);
881 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
882 extern void schedule_dir_for_removal(const char *name, int len);
883 extern void remove_scheduled_dirs(void);
885 extern struct alternate_object_database {
886 struct alternate_object_database *next;
887 char *name;
888 char base[FLEX_ARRAY]; /* more */
889 } *alt_odb_list;
890 extern void prepare_alt_odb(void);
891 extern void add_to_alternates_file(const char *reference);
892 typedef int alt_odb_fn(struct alternate_object_database *, void *);
893 extern void foreach_alt_odb(alt_odb_fn, void*);
895 struct pack_window {
896 struct pack_window *next;
897 unsigned char *base;
898 off_t offset;
899 size_t len;
900 unsigned int last_used;
901 unsigned int inuse_cnt;
904 extern struct packed_git {
905 struct packed_git *next;
906 struct pack_window *windows;
907 off_t pack_size;
908 const void *index_data;
909 size_t index_size;
910 uint32_t num_objects;
911 uint32_t num_bad_objects;
912 unsigned char *bad_object_sha1;
913 int index_version;
914 time_t mtime;
915 int pack_fd;
916 unsigned pack_local:1,
917 pack_keep:1;
918 unsigned char sha1[20];
919 /* something like ".git/objects/pack/xxxxx.pack" */
920 char pack_name[FLEX_ARRAY]; /* more */
921 } *packed_git;
923 struct pack_entry {
924 off_t offset;
925 unsigned char sha1[20];
926 struct packed_git *p;
929 struct ref {
930 struct ref *next;
931 unsigned char old_sha1[20];
932 unsigned char new_sha1[20];
933 char *symref;
934 unsigned int force:1,
935 merge:1,
936 nonfastforward:1,
937 deletion:1;
938 enum {
939 REF_STATUS_NONE = 0,
940 REF_STATUS_OK,
941 REF_STATUS_REJECT_NONFASTFORWARD,
942 REF_STATUS_REJECT_NODELETE,
943 REF_STATUS_UPTODATE,
944 REF_STATUS_REMOTE_REJECT,
945 REF_STATUS_EXPECTING_REPORT
946 } status;
947 char *remote_status;
948 struct ref *peer_ref; /* when renaming */
949 char name[FLEX_ARRAY]; /* more */
952 #define REF_NORMAL (1u << 0)
953 #define REF_HEADS (1u << 1)
954 #define REF_TAGS (1u << 2)
956 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
958 #define CONNECT_VERBOSE (1u << 0)
959 extern char *git_getpass(const char *prompt);
960 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
961 extern int finish_connect(struct child_process *conn);
962 extern int path_match(const char *path, int nr, char **match);
963 struct extra_have_objects {
964 int nr, alloc;
965 unsigned char (*array)[20];
967 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
968 extern int server_supports(const char *feature);
970 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
972 extern void prepare_packed_git(void);
973 extern void reprepare_packed_git(void);
974 extern void install_packed_git(struct packed_git *pack);
976 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
977 struct packed_git *packs);
979 extern void pack_report(void);
980 extern int open_pack_index(struct packed_git *);
981 extern void close_pack_index(struct packed_git *);
982 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
983 extern void close_pack_windows(struct packed_git *);
984 extern void unuse_pack(struct pack_window **);
985 extern void free_pack_by_name(const char *);
986 extern void clear_delta_base_cache(void);
987 extern struct packed_git *add_packed_git(const char *, int, int);
988 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
989 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
990 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
991 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
992 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
993 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
994 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
996 /* Dumb servers support */
997 extern int update_server_info(int);
999 typedef int (*config_fn_t)(const char *, const char *, void *);
1000 extern int git_default_config(const char *, const char *, void *);
1001 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1002 extern void git_config_push_parameter(const char *text);
1003 extern int git_config_parse_parameter(const char *text);
1004 extern int git_config_parse_environment(void);
1005 extern int git_config_from_parameters(config_fn_t fn, void *data);
1006 extern int git_config(config_fn_t fn, void *);
1007 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1008 extern int git_parse_ulong(const char *, unsigned long *);
1009 extern int git_config_int(const char *, const char *);
1010 extern unsigned long git_config_ulong(const char *, const char *);
1011 extern int git_config_bool_or_int(const char *, const char *, int *);
1012 extern int git_config_bool(const char *, const char *);
1013 extern int git_config_maybe_bool(const char *, const char *);
1014 extern int git_config_string(const char **, const char *, const char *);
1015 extern int git_config_pathname(const char **, const char *, const char *);
1016 extern int git_config_set(const char *, const char *);
1017 extern int git_config_parse_key(const char *, char **, int *);
1018 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1019 extern int git_config_rename_section(const char *, const char *);
1020 extern const char *git_etc_gitconfig(void);
1021 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1022 extern int git_env_bool(const char *, int);
1023 extern int git_config_system(void);
1024 extern int git_config_global(void);
1025 extern int config_error_nonbool(const char *);
1026 extern const char *get_log_output_encoding(void);
1027 extern const char *get_commit_output_encoding(void);
1029 extern const char *config_exclusive_filename;
1031 #define MAX_GITNAME (1000)
1032 extern char git_default_email[MAX_GITNAME];
1033 extern char git_default_name[MAX_GITNAME];
1034 #define IDENT_NAME_GIVEN 01
1035 #define IDENT_MAIL_GIVEN 02
1036 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1037 extern int user_ident_explicitly_given;
1038 extern int user_ident_sufficiently_given(void);
1040 extern const char *git_commit_encoding;
1041 extern const char *git_log_output_encoding;
1042 extern const char *git_mailmap_file;
1044 /* IO helper functions */
1045 extern void maybe_flush_or_die(FILE *, const char *);
1046 extern int copy_fd(int ifd, int ofd);
1047 extern int copy_file(const char *dst, const char *src, int mode);
1048 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1049 extern void write_or_die(int fd, const void *buf, size_t count);
1050 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1051 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1052 extern void fsync_or_die(int fd, const char *);
1054 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1055 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1056 static inline ssize_t write_str_in_full(int fd, const char *str)
1058 return write_in_full(fd, str, strlen(str));
1061 /* pager.c */
1062 extern void setup_pager(void);
1063 extern const char *pager_program;
1064 extern int pager_in_use(void);
1065 extern int pager_use_color;
1067 extern const char *editor_program;
1068 extern const char *askpass_program;
1069 extern const char *excludes_file;
1071 /* base85 */
1072 int decode_85(char *dst, const char *line, int linelen);
1073 void encode_85(char *buf, const unsigned char *data, int bytes);
1075 /* alloc.c */
1076 extern void *alloc_blob_node(void);
1077 extern void *alloc_tree_node(void);
1078 extern void *alloc_commit_node(void);
1079 extern void *alloc_tag_node(void);
1080 extern void *alloc_object_node(void);
1081 extern void alloc_report(void);
1083 /* trace.c */
1084 __attribute__((format (printf, 1, 2)))
1085 extern void trace_printf(const char *format, ...);
1086 __attribute__((format (printf, 2, 3)))
1087 extern void trace_argv_printf(const char **argv, const char *format, ...);
1088 extern void trace_repo_setup(const char *prefix);
1090 /* convert.c */
1091 /* returns 1 if *dst was used */
1092 extern int convert_to_git(const char *path, const char *src, size_t len,
1093 struct strbuf *dst, enum safe_crlf checksafe);
1094 extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
1095 extern int renormalize_buffer(const char *path, const char *src, size_t len, struct strbuf *dst);
1097 /* add */
1099 * return 0 if success, 1 - if addition of a file failed and
1100 * ADD_FILES_IGNORE_ERRORS was specified in flags
1102 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1104 /* diff.c */
1105 extern int diff_auto_refresh_index;
1107 /* match-trees.c */
1108 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1109 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1112 * whitespace rules.
1113 * used by both diff and apply
1114 * last two digits are tab width
1116 #define WS_BLANK_AT_EOL 0100
1117 #define WS_SPACE_BEFORE_TAB 0200
1118 #define WS_INDENT_WITH_NON_TAB 0400
1119 #define WS_CR_AT_EOL 01000
1120 #define WS_BLANK_AT_EOF 02000
1121 #define WS_TAB_IN_INDENT 04000
1122 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1123 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1124 #define WS_TAB_WIDTH_MASK 077
1125 extern unsigned whitespace_rule_cfg;
1126 extern unsigned whitespace_rule(const char *);
1127 extern unsigned parse_whitespace_rule(const char *);
1128 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1129 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1130 extern char *whitespace_error_string(unsigned ws);
1131 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1132 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1133 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1135 /* ls-files */
1136 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
1137 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1139 char *alias_lookup(const char *alias);
1140 int split_cmdline(char *cmdline, const char ***argv);
1141 /* Takes a negative value returned by split_cmdline */
1142 const char *split_cmdline_strerror(int cmdline_errno);
1144 /* git.c */
1145 struct startup_info {
1146 int have_repository;
1147 const char *prefix;
1149 extern struct startup_info *startup_info;
1151 /* builtin/merge.c */
1152 int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1154 #endif /* CACHE_H */