Sync with 2.4.3
[git.git] / cache.h
blob571c98f5e2406afad1352fcaddd1efff1af65cc1
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
10 #include "trace.h"
11 #include "string-list.h"
13 #include SHA1_HEADER
14 #ifndef git_SHA_CTX
15 #define git_SHA_CTX SHA_CTX
16 #define git_SHA1_Init SHA1_Init
17 #define git_SHA1_Update SHA1_Update
18 #define git_SHA1_Final SHA1_Final
19 #endif
21 #include <zlib.h>
22 typedef struct git_zstream {
23 z_stream z;
24 unsigned long avail_in;
25 unsigned long avail_out;
26 unsigned long total_in;
27 unsigned long total_out;
28 unsigned char *next_in;
29 unsigned char *next_out;
30 } git_zstream;
32 void git_inflate_init(git_zstream *);
33 void git_inflate_init_gzip_only(git_zstream *);
34 void git_inflate_end(git_zstream *);
35 int git_inflate(git_zstream *, int flush);
37 void git_deflate_init(git_zstream *, int level);
38 void git_deflate_init_gzip(git_zstream *, int level);
39 void git_deflate_init_raw(git_zstream *, int level);
40 void git_deflate_end(git_zstream *);
41 int git_deflate_abort(git_zstream *);
42 int git_deflate_end_gently(git_zstream *);
43 int git_deflate(git_zstream *, int flush);
44 unsigned long git_deflate_bound(git_zstream *, unsigned long);
46 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
47 #define GIT_SHA1_RAWSZ 20
48 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
50 struct object_id {
51 unsigned char hash[GIT_SHA1_RAWSZ];
54 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
55 #define DTYPE(de) ((de)->d_type)
56 #else
57 #undef DT_UNKNOWN
58 #undef DT_DIR
59 #undef DT_REG
60 #undef DT_LNK
61 #define DT_UNKNOWN 0
62 #define DT_DIR 1
63 #define DT_REG 2
64 #define DT_LNK 3
65 #define DTYPE(de) DT_UNKNOWN
66 #endif
68 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
69 #define S_IFINVALID 0030000
72 * A "directory link" is a link to another git directory.
74 * The value 0160000 is not normally a valid mode, and
75 * also just happens to be S_IFDIR + S_IFLNK
77 #define S_IFGITLINK 0160000
78 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
81 * Some mode bits are also used internally for computations.
83 * They *must* not overlap with any valid modes, and they *must* not be emitted
84 * to outside world - i.e. appear on disk or network. In other words, it's just
85 * temporary fields, which we internally use, but they have to stay in-house.
87 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
88 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
91 /* used internally in tree-diff */
92 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
96 * Intensive research over the course of many years has shown that
97 * port 9418 is totally unused by anything else. Or
99 * Your search - "port 9418" - did not match any documents.
101 * as www.google.com puts it.
103 * This port has been properly assigned for git use by IANA:
104 * git (Assigned-9418) [I06-050728-0001].
106 * git 9418/tcp git pack transfer service
107 * git 9418/udp git pack transfer service
109 * with Linus Torvalds <torvalds@osdl.org> as the point of
110 * contact. September 2005.
112 * See http://www.iana.org/assignments/port-numbers
114 #define DEFAULT_GIT_PORT 9418
117 * Basic data structures for the directory cache
120 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
121 struct cache_header {
122 uint32_t hdr_signature;
123 uint32_t hdr_version;
124 uint32_t hdr_entries;
127 #define INDEX_FORMAT_LB 2
128 #define INDEX_FORMAT_UB 4
131 * The "cache_time" is just the low 32 bits of the
132 * time. It doesn't matter if it overflows - we only
133 * check it for equality in the 32 bits we save.
135 struct cache_time {
136 uint32_t sec;
137 uint32_t nsec;
140 struct stat_data {
141 struct cache_time sd_ctime;
142 struct cache_time sd_mtime;
143 unsigned int sd_dev;
144 unsigned int sd_ino;
145 unsigned int sd_uid;
146 unsigned int sd_gid;
147 unsigned int sd_size;
150 struct cache_entry {
151 struct hashmap_entry ent;
152 struct stat_data ce_stat_data;
153 unsigned int ce_mode;
154 unsigned int ce_flags;
155 unsigned int ce_namelen;
156 unsigned int index; /* for link extension */
157 unsigned char sha1[20];
158 char name[FLEX_ARRAY]; /* more */
161 #define CE_STAGEMASK (0x3000)
162 #define CE_EXTENDED (0x4000)
163 #define CE_VALID (0x8000)
164 #define CE_STAGESHIFT 12
167 * Range 0xFFFF0FFF in ce_flags is divided into
168 * two parts: in-memory flags and on-disk ones.
169 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
170 * if you want to save a new flag, add it in
171 * CE_EXTENDED_FLAGS
173 * In-memory only flags
175 #define CE_UPDATE (1 << 16)
176 #define CE_REMOVE (1 << 17)
177 #define CE_UPTODATE (1 << 18)
178 #define CE_ADDED (1 << 19)
180 #define CE_HASHED (1 << 20)
181 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
182 #define CE_CONFLICTED (1 << 23)
184 #define CE_UNPACKED (1 << 24)
185 #define CE_NEW_SKIP_WORKTREE (1 << 25)
187 /* used to temporarily mark paths matched by pathspecs */
188 #define CE_MATCHED (1 << 26)
190 #define CE_UPDATE_IN_BASE (1 << 27)
191 #define CE_STRIP_NAME (1 << 28)
194 * Extended on-disk flags
196 #define CE_INTENT_TO_ADD (1 << 29)
197 #define CE_SKIP_WORKTREE (1 << 30)
198 /* CE_EXTENDED2 is for future extension */
199 #define CE_EXTENDED2 (1 << 31)
201 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
204 * Safeguard to avoid saving wrong flags:
205 * - CE_EXTENDED2 won't get saved until its semantic is known
206 * - Bits in 0x0000FFFF have been saved in ce_flags already
207 * - Bits in 0x003F0000 are currently in-memory flags
209 #if CE_EXTENDED_FLAGS & 0x803FFFFF
210 #error "CE_EXTENDED_FLAGS out of range"
211 #endif
213 struct pathspec;
216 * Copy the sha1 and stat state of a cache entry from one to
217 * another. But we never change the name, or the hash state!
219 static inline void copy_cache_entry(struct cache_entry *dst,
220 const struct cache_entry *src)
222 unsigned int state = dst->ce_flags & CE_HASHED;
224 /* Don't copy hash chain and name */
225 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
226 offsetof(struct cache_entry, name) -
227 offsetof(struct cache_entry, ce_stat_data));
229 /* Restore the hash state */
230 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
233 static inline unsigned create_ce_flags(unsigned stage)
235 return (stage << CE_STAGESHIFT);
238 #define ce_namelen(ce) ((ce)->ce_namelen)
239 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
240 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
241 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
242 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
243 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
245 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
246 static inline unsigned int create_ce_mode(unsigned int mode)
248 if (S_ISLNK(mode))
249 return S_IFLNK;
250 if (S_ISDIR(mode) || S_ISGITLINK(mode))
251 return S_IFGITLINK;
252 return S_IFREG | ce_permissions(mode);
254 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
255 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 cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
293 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
294 #define CE_ENTRY_CHANGED (1 << 1)
295 #define CE_ENTRY_REMOVED (1 << 2)
296 #define CE_ENTRY_ADDED (1 << 3)
297 #define RESOLVE_UNDO_CHANGED (1 << 4)
298 #define CACHE_TREE_CHANGED (1 << 5)
299 #define SPLIT_INDEX_ORDERED (1 << 6)
300 #define UNTRACKED_CHANGED (1 << 7)
302 struct split_index;
303 struct untracked_cache;
305 struct index_state {
306 struct cache_entry **cache;
307 unsigned int version;
308 unsigned int cache_nr, cache_alloc, cache_changed;
309 struct string_list *resolve_undo;
310 struct cache_tree *cache_tree;
311 struct split_index *split_index;
312 struct cache_time timestamp;
313 unsigned name_hash_initialized : 1,
314 initialized : 1;
315 struct hashmap name_hash;
316 struct hashmap dir_hash;
317 unsigned char sha1[20];
318 struct untracked_cache *untracked;
321 extern struct index_state the_index;
323 /* Name hashing */
324 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
325 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
326 extern void free_name_hash(struct index_state *istate);
329 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
330 #define active_cache (the_index.cache)
331 #define active_nr (the_index.cache_nr)
332 #define active_alloc (the_index.cache_alloc)
333 #define active_cache_changed (the_index.cache_changed)
334 #define active_cache_tree (the_index.cache_tree)
336 #define read_cache() read_index(&the_index)
337 #define read_cache_from(path) read_index_from(&the_index, (path))
338 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
339 #define is_cache_unborn() is_index_unborn(&the_index)
340 #define read_cache_unmerged() read_index_unmerged(&the_index)
341 #define discard_cache() discard_index(&the_index)
342 #define unmerged_cache() unmerged_index(&the_index)
343 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
344 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
345 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
346 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
347 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
348 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
349 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
350 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
351 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
352 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
353 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
354 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
355 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
356 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
357 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
358 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
359 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
360 #endif
362 enum object_type {
363 OBJ_BAD = -1,
364 OBJ_NONE = 0,
365 OBJ_COMMIT = 1,
366 OBJ_TREE = 2,
367 OBJ_BLOB = 3,
368 OBJ_TAG = 4,
369 /* 5 for future expansion */
370 OBJ_OFS_DELTA = 6,
371 OBJ_REF_DELTA = 7,
372 OBJ_ANY,
373 OBJ_MAX
376 static inline enum object_type object_type(unsigned int mode)
378 return S_ISDIR(mode) ? OBJ_TREE :
379 S_ISGITLINK(mode) ? OBJ_COMMIT :
380 OBJ_BLOB;
383 /* Double-check local_repo_env below if you add to this list. */
384 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
385 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
386 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
387 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
388 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
389 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
390 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
391 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
392 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
393 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
394 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
395 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
396 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
397 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
398 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
399 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
400 #define GITATTRIBUTES_FILE ".gitattributes"
401 #define INFOATTRIBUTES_FILE "info/attributes"
402 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
403 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
404 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
405 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
406 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
407 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
408 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
409 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
410 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
411 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
414 * This environment variable is expected to contain a boolean indicating
415 * whether we should or should not treat:
417 * GIT_DIR=foo.git git ...
419 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
420 * of this, but we use it internally to communicate to sub-processes that we
421 * are in a bare repo. If not set, defaults to true.
423 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
426 * Repository-local GIT_* environment variables; these will be cleared
427 * when git spawns a sub-process that runs inside another repository.
428 * The array is NULL-terminated, which makes it easy to pass in the "env"
429 * parameter of a run-command invocation, or to do a simple walk.
431 extern const char * const local_repo_env[];
433 extern int is_bare_repository_cfg;
434 extern int is_bare_repository(void);
435 extern int is_inside_git_dir(void);
436 extern char *git_work_tree_cfg;
437 extern int is_inside_work_tree(void);
438 extern const char *get_git_dir(void);
439 extern const char *get_git_common_dir(void);
440 extern int is_git_directory(const char *path);
441 extern char *get_object_directory(void);
442 extern char *get_index_file(void);
443 extern char *get_graft_file(void);
444 extern int set_git_dir(const char *path);
445 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
446 extern const char *get_git_namespace(void);
447 extern const char *strip_namespace(const char *namespaced_ref);
448 extern const char *get_git_work_tree(void);
449 extern const char *read_gitfile(const char *path);
450 extern const char *resolve_gitdir(const char *suspect);
451 extern void set_git_work_tree(const char *tree);
453 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
455 extern const char **get_pathspec(const char *prefix, const char **pathspec);
456 extern void setup_work_tree(void);
457 extern const char *setup_git_directory_gently(int *);
458 extern const char *setup_git_directory(void);
459 extern char *prefix_path(const char *prefix, int len, const char *path);
460 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
461 extern const char *prefix_filename(const char *prefix, int len, const char *path);
462 extern int check_filename(const char *prefix, const char *name);
463 extern void verify_filename(const char *prefix,
464 const char *name,
465 int diagnose_misspelt_rev);
466 extern void verify_non_filename(const char *prefix, const char *name);
467 extern int path_inside_repo(const char *prefix, const char *path);
469 #define INIT_DB_QUIET 0x0001
471 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
472 extern int init_db(const char *template_dir, unsigned int flags);
474 extern void sanitize_stdfds(void);
475 extern int daemonize(void);
477 #define alloc_nr(x) (((x)+16)*3/2)
480 * Realloc the buffer pointed at by variable 'x' so that it can hold
481 * at least 'nr' entries; the number of entries currently allocated
482 * is 'alloc', using the standard growing factor alloc_nr() macro.
484 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
486 #define ALLOC_GROW(x, nr, alloc) \
487 do { \
488 if ((nr) > alloc) { \
489 if (alloc_nr(alloc) < (nr)) \
490 alloc = (nr); \
491 else \
492 alloc = alloc_nr(alloc); \
493 REALLOC_ARRAY(x, alloc); \
495 } while (0)
497 /* Initialize and use the cache information */
498 struct lock_file;
499 extern int read_index(struct index_state *);
500 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
501 extern int do_read_index(struct index_state *istate, const char *path,
502 int must_exist); /* for testting only! */
503 extern int read_index_from(struct index_state *, const char *path);
504 extern int is_index_unborn(struct index_state *);
505 extern int read_index_unmerged(struct index_state *);
506 #define COMMIT_LOCK (1 << 0)
507 #define CLOSE_LOCK (1 << 1)
508 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
509 extern int discard_index(struct index_state *);
510 extern int unmerged_index(const struct index_state *);
511 extern int verify_path(const char *path);
512 extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
513 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
514 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
515 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
516 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
517 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
518 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
519 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
520 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
521 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
522 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
523 extern int remove_index_entry_at(struct index_state *, int pos);
524 extern void remove_marked_cache_entries(struct index_state *istate);
525 extern int remove_file_from_index(struct index_state *, const char *path);
526 #define ADD_CACHE_VERBOSE 1
527 #define ADD_CACHE_PRETEND 2
528 #define ADD_CACHE_IGNORE_ERRORS 4
529 #define ADD_CACHE_IGNORE_REMOVAL 8
530 #define ADD_CACHE_INTENT 16
531 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
532 extern int add_file_to_index(struct index_state *, const char *path, int flags);
533 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
534 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
535 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
536 extern int index_name_is_other(const struct index_state *, const char *, int);
537 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
539 /* do stat comparison even if CE_VALID is true */
540 #define CE_MATCH_IGNORE_VALID 01
541 /* do not check the contents but report dirty on racily-clean entries */
542 #define CE_MATCH_RACY_IS_DIRTY 02
543 /* do stat comparison even if CE_SKIP_WORKTREE is true */
544 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
545 /* ignore non-existent files during stat update */
546 #define CE_MATCH_IGNORE_MISSING 0x08
547 /* enable stat refresh */
548 #define CE_MATCH_REFRESH 0x10
549 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
550 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
552 #define HASH_WRITE_OBJECT 1
553 #define HASH_FORMAT_CHECK 2
554 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
555 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
558 * Record to sd the data from st that we use to check whether a file
559 * might have changed.
561 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
564 * Return 0 if st is consistent with a file not having been changed
565 * since sd was filled. If there are differences, return a
566 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
567 * INODE_CHANGED, and DATA_CHANGED.
569 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
570 extern int match_stat_data_racy(const struct index_state *istate,
571 const struct stat_data *sd, struct stat *st);
573 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
575 #define REFRESH_REALLY 0x0001 /* ignore_valid */
576 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
577 #define REFRESH_QUIET 0x0004 /* be quiet about it */
578 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
579 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
580 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
581 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
583 extern void update_index_if_able(struct index_state *, struct lock_file *);
585 extern int hold_locked_index(struct lock_file *, int);
586 extern void set_alternate_index_output(const char *);
588 extern int delete_ref(const char *, const unsigned char *sha1, unsigned int flags);
590 /* Environment bits from configuration mechanism */
591 extern int trust_executable_bit;
592 extern int trust_ctime;
593 extern int check_stat;
594 extern int quote_path_fully;
595 extern int has_symlinks;
596 extern int minimum_abbrev, default_abbrev;
597 extern int ignore_case;
598 extern int assume_unchanged;
599 extern int prefer_symlink_refs;
600 extern int log_all_ref_updates;
601 extern int warn_ambiguous_refs;
602 extern int warn_on_object_refname_ambiguity;
603 extern int shared_repository;
604 extern const char *apply_default_whitespace;
605 extern const char *apply_default_ignorewhitespace;
606 extern const char *git_attributes_file;
607 extern int zlib_compression_level;
608 extern int core_compression_level;
609 extern int core_compression_seen;
610 extern size_t packed_git_window_size;
611 extern size_t packed_git_limit;
612 extern size_t delta_base_cache_limit;
613 extern unsigned long big_file_threshold;
614 extern unsigned long pack_size_limit_cfg;
617 * Do replace refs need to be checked this run? This variable is
618 * initialized to true unless --no-replace-object is used or
619 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
620 * commands that do not want replace references to be active. As an
621 * optimization it is also set to false if replace references have
622 * been sought but there were none.
624 extern int check_replace_refs;
626 extern int fsync_object_files;
627 extern int core_preload_index;
628 extern int core_apply_sparse_checkout;
629 extern int precomposed_unicode;
630 extern int protect_hfs;
631 extern int protect_ntfs;
632 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
635 * Include broken refs in all ref iterations, which will
636 * generally choke dangerous operations rather than letting
637 * them silently proceed without taking the broken ref into
638 * account.
640 extern int ref_paranoia;
643 * The character that begins a commented line in user-editable file
644 * that is subject to stripspace.
646 extern char comment_line_char;
647 extern int auto_comment_line_char;
649 enum branch_track {
650 BRANCH_TRACK_UNSPECIFIED = -1,
651 BRANCH_TRACK_NEVER = 0,
652 BRANCH_TRACK_REMOTE,
653 BRANCH_TRACK_ALWAYS,
654 BRANCH_TRACK_EXPLICIT,
655 BRANCH_TRACK_OVERRIDE
658 enum rebase_setup_type {
659 AUTOREBASE_NEVER = 0,
660 AUTOREBASE_LOCAL,
661 AUTOREBASE_REMOTE,
662 AUTOREBASE_ALWAYS
665 enum push_default_type {
666 PUSH_DEFAULT_NOTHING = 0,
667 PUSH_DEFAULT_MATCHING,
668 PUSH_DEFAULT_SIMPLE,
669 PUSH_DEFAULT_UPSTREAM,
670 PUSH_DEFAULT_CURRENT,
671 PUSH_DEFAULT_UNSPECIFIED
674 extern enum branch_track git_branch_track;
675 extern enum rebase_setup_type autorebase;
676 extern enum push_default_type push_default;
678 enum object_creation_mode {
679 OBJECT_CREATION_USES_HARDLINKS = 0,
680 OBJECT_CREATION_USES_RENAMES = 1
683 extern enum object_creation_mode object_creation_mode;
685 extern char *notes_ref_name;
687 extern int grafts_replace_parents;
689 #define GIT_REPO_VERSION 0
690 extern int repository_format_version;
691 extern int check_repository_format(void);
693 #define MTIME_CHANGED 0x0001
694 #define CTIME_CHANGED 0x0002
695 #define OWNER_CHANGED 0x0004
696 #define MODE_CHANGED 0x0008
697 #define INODE_CHANGED 0x0010
698 #define DATA_CHANGED 0x0020
699 #define TYPE_CHANGED 0x0040
701 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
702 __attribute__((format (printf, 3, 4)));
703 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
704 __attribute__((format (printf, 2, 3)));
705 extern char *git_pathdup(const char *fmt, ...)
706 __attribute__((format (printf, 1, 2)));
707 extern char *mkpathdup(const char *fmt, ...)
708 __attribute__((format (printf, 1, 2)));
710 /* Return a statically allocated filename matching the sha1 signature */
711 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
712 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
713 extern const char *git_path_submodule(const char *path, const char *fmt, ...)
714 __attribute__((format (printf, 2, 3)));
715 extern void report_linked_checkout_garbage(void);
718 * Return the name of the file in the local object database that would
719 * be used to store a loose object with the specified sha1. The
720 * return value is a pointer to a statically allocated buffer that is
721 * overwritten each time the function is called.
723 extern const char *sha1_file_name(const unsigned char *sha1);
726 * Return the name of the (local) packfile with the specified sha1 in
727 * its name. The return value is a pointer to memory that is
728 * overwritten each time this function is called.
730 extern char *sha1_pack_name(const unsigned char *sha1);
733 * Return the name of the (local) pack index file with the specified
734 * sha1 in its name. The return value is a pointer to memory that is
735 * overwritten each time this function is called.
737 extern char *sha1_pack_index_name(const unsigned char *sha1);
739 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
740 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
742 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
744 int i;
746 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
747 if (*sha1 != *sha2)
748 return *sha1 - *sha2;
751 return 0;
754 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
756 return hashcmp(oid1->hash, oid2->hash);
759 static inline int is_null_sha1(const unsigned char *sha1)
761 return !hashcmp(sha1, null_sha1);
764 static inline int is_null_oid(const struct object_id *oid)
766 return !hashcmp(oid->hash, null_sha1);
769 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
771 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
774 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
776 hashcpy(dst->hash, src->hash);
779 static inline void hashclr(unsigned char *hash)
781 memset(hash, 0, GIT_SHA1_RAWSZ);
784 static inline void oidclr(struct object_id *oid)
786 hashclr(oid->hash);
790 #define EMPTY_TREE_SHA1_HEX \
791 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
792 #define EMPTY_TREE_SHA1_BIN_LITERAL \
793 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
794 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
795 #define EMPTY_TREE_SHA1_BIN \
796 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
798 #define EMPTY_BLOB_SHA1_HEX \
799 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
800 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
801 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
802 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
803 #define EMPTY_BLOB_SHA1_BIN \
804 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
806 static inline int is_empty_blob_sha1(const unsigned char *sha1)
808 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
811 int git_mkstemp(char *path, size_t n, const char *template);
813 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
815 /* set default permissions by passing mode arguments to open(2) */
816 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
817 int git_mkstemp_mode(char *pattern, int mode);
820 * NOTE NOTE NOTE!!
822 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
823 * not be changed. Old repositories have core.sharedrepository written in
824 * numeric format, and therefore these values are preserved for compatibility
825 * reasons.
827 enum sharedrepo {
828 PERM_UMASK = 0,
829 OLD_PERM_GROUP = 1,
830 OLD_PERM_EVERYBODY = 2,
831 PERM_GROUP = 0660,
832 PERM_EVERYBODY = 0664
834 int git_config_perm(const char *var, const char *value);
835 int adjust_shared_perm(const char *path);
838 * Create the directory containing the named path, using care to be
839 * somewhat safe against races. Return one of the scld_error values
840 * to indicate success/failure.
842 * SCLD_VANISHED indicates that one of the ancestor directories of the
843 * path existed at one point during the function call and then
844 * suddenly vanished, probably because another process pruned the
845 * directory while we were working. To be robust against this kind of
846 * race, callers might want to try invoking the function again when it
847 * returns SCLD_VANISHED.
849 enum scld_error {
850 SCLD_OK = 0,
851 SCLD_FAILED = -1,
852 SCLD_PERMS = -2,
853 SCLD_EXISTS = -3,
854 SCLD_VANISHED = -4
856 enum scld_error safe_create_leading_directories(char *path);
857 enum scld_error safe_create_leading_directories_const(const char *path);
859 int mkdir_in_gitdir(const char *path);
860 extern char *expand_user_path(const char *path);
861 const char *enter_repo(const char *path, int strict);
862 static inline int is_absolute_path(const char *path)
864 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
866 int is_directory(const char *);
867 const char *real_path(const char *path);
868 const char *real_path_if_valid(const char *path);
869 const char *absolute_path(const char *path);
870 const char *remove_leading_path(const char *in, const char *prefix);
871 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
872 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
873 int normalize_path_copy(char *dst, const char *src);
874 int longest_ancestor_length(const char *path, struct string_list *prefixes);
875 char *strip_path_suffix(const char *path, const char *suffix);
876 int daemon_avoid_alias(const char *path);
877 extern int is_ntfs_dotgit(const char *name);
880 * Return a newly allocated string with the evaluation of
881 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
882 * "$HOME/.config/git/$filename". Return NULL upon error.
884 extern char *xdg_config_home(const char *filename);
886 /* object replacement */
887 #define LOOKUP_REPLACE_OBJECT 1
888 #define LOOKUP_UNKNOWN_OBJECT 2
889 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
890 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
892 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
896 * This internal function is only declared here for the benefit of
897 * lookup_replace_object(). Please do not call it directly.
899 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
902 * If object sha1 should be replaced, return the replacement object's
903 * name (replaced recursively, if necessary). The return value is
904 * either sha1 or a pointer to a permanently-allocated value. When
905 * object replacement is suppressed, always return sha1.
907 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
909 if (!check_replace_refs)
910 return sha1;
911 return do_lookup_replace_object(sha1);
914 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
916 if (!(flag & LOOKUP_REPLACE_OBJECT))
917 return sha1;
918 return lookup_replace_object(sha1);
921 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
922 extern int sha1_object_info(const unsigned char *, unsigned long *);
923 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
924 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
925 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
926 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
927 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
928 extern int git_open_noatime(const char *name);
929 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
930 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
931 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
933 /* global flag to enable extra checks when accessing packed objects */
934 extern int do_check_packed_object_crc;
936 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
938 extern int move_temp_to_file(const char *tmpfile, const char *filename);
940 extern int has_sha1_pack(const unsigned char *sha1);
943 * Return true iff we have an object named sha1, whether local or in
944 * an alternate object database, and whether packed or loose. This
945 * function does not respect replace references.
947 extern int has_sha1_file(const unsigned char *sha1);
950 * Return true iff an alternate object database has a loose object
951 * with the specified name. This function does not respect replace
952 * references.
954 extern int has_loose_object_nonlocal(const unsigned char *sha1);
956 extern int has_pack_index(const unsigned char *sha1);
958 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
960 extern const signed char hexval_table[256];
961 static inline unsigned int hexval(unsigned char c)
963 return hexval_table[c];
966 /* Convert to/from hex/sha1 representation */
967 #define MINIMUM_ABBREV minimum_abbrev
968 #define DEFAULT_ABBREV default_abbrev
970 struct object_context {
971 unsigned char tree[20];
972 char path[PATH_MAX];
973 unsigned mode;
975 * symlink_path is only used by get_tree_entry_follow_symlinks,
976 * and only for symlinks that point outside the repository.
978 struct strbuf symlink_path;
981 #define GET_SHA1_QUIETLY 01
982 #define GET_SHA1_COMMIT 02
983 #define GET_SHA1_COMMITTISH 04
984 #define GET_SHA1_TREE 010
985 #define GET_SHA1_TREEISH 020
986 #define GET_SHA1_BLOB 040
987 #define GET_SHA1_FOLLOW_SYMLINKS 0100
988 #define GET_SHA1_ONLY_TO_DIE 04000
990 extern int get_sha1(const char *str, unsigned char *sha1);
991 extern int get_sha1_commit(const char *str, unsigned char *sha1);
992 extern int get_sha1_committish(const char *str, unsigned char *sha1);
993 extern int get_sha1_tree(const char *str, unsigned char *sha1);
994 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
995 extern int get_sha1_blob(const char *str, unsigned char *sha1);
996 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
997 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
999 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1000 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1003 * Try to read a SHA1 in hexadecimal format from the 40 characters
1004 * starting at hex. Write the 20-byte result to sha1 in binary form.
1005 * Return 0 on success. Reading stops if a NUL is encountered in the
1006 * input, so it is safe to pass this function an arbitrary
1007 * null-terminated string.
1009 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1010 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1012 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1013 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1014 extern int read_ref_full(const char *refname, int resolve_flags,
1015 unsigned char *sha1, int *flags);
1016 extern int read_ref(const char *refname, unsigned char *sha1);
1019 * Resolve a reference, recursively following symbolic refererences.
1021 * Store the referred-to object's name in sha1 and return the name of
1022 * the non-symbolic reference that ultimately pointed at it. The
1023 * return value, if not NULL, is a pointer into either a static buffer
1024 * or the input ref.
1026 * If the reference cannot be resolved to an object, the behavior
1027 * depends on the RESOLVE_REF_READING flag:
1029 * - If RESOLVE_REF_READING is set, return NULL.
1031 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
1032 * the last reference name in the chain, which will either be a non-symbolic
1033 * reference or an undefined reference. If this is a prelude to
1034 * "writing" to the ref, the return value is the name of the ref
1035 * that will actually be created or changed.
1037 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
1038 * level of symbolic reference. The value stored in sha1 for a symbolic
1039 * reference will always be null_sha1 in this case, and the return
1040 * value is the reference that the symref refers to directly.
1042 * If flags is non-NULL, set the value that it points to the
1043 * combination of REF_ISPACKED (if the reference was found among the
1044 * packed references), REF_ISSYMREF (if the initial reference was a
1045 * symbolic reference), REF_BAD_NAME (if the reference name is ill
1046 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
1047 * (if the ref is malformed or has a bad name). See refs.h for more detail
1048 * on each flag.
1050 * If ref is not a properly-formatted, normalized reference, return
1051 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
1052 * give up and return NULL.
1054 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
1055 * name is invalid according to git-check-ref-format(1). If the name
1056 * is bad then the value stored in sha1 will be null_sha1 and the two
1057 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
1059 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
1060 * directory and do not consist of all caps and underscores cannot be
1061 * resolved. The function returns NULL for such ref names.
1062 * Caps and underscores refers to the special refs, such as HEAD,
1063 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
1065 #define RESOLVE_REF_READING 0x01
1066 #define RESOLVE_REF_NO_RECURSE 0x02
1067 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
1068 extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1069 extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1071 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
1072 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
1073 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1074 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1077 * Return true iff abbrev_name is a possible abbreviation for
1078 * full_name according to the rules defined by ref_rev_parse_rules in
1079 * refs.c.
1081 extern int refname_match(const char *abbrev_name, const char *full_name);
1083 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
1084 extern int validate_headref(const char *ref);
1086 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1087 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1088 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1089 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1091 extern void *read_object_with_reference(const unsigned char *sha1,
1092 const char *required_type,
1093 unsigned long *size,
1094 unsigned char *sha1_ret);
1096 extern struct object *peel_to_type(const char *name, int namelen,
1097 struct object *o, enum object_type);
1099 enum date_mode {
1100 DATE_NORMAL = 0,
1101 DATE_RELATIVE,
1102 DATE_SHORT,
1103 DATE_LOCAL,
1104 DATE_ISO8601,
1105 DATE_ISO8601_STRICT,
1106 DATE_RFC2822,
1107 DATE_RAW
1110 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
1111 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1112 struct strbuf *timebuf);
1113 int parse_date(const char *date, struct strbuf *out);
1114 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1115 int parse_expiry_date(const char *date, unsigned long *timestamp);
1116 void datestamp(struct strbuf *out);
1117 #define approxidate(s) approxidate_careful((s), NULL)
1118 unsigned long approxidate_careful(const char *, int *);
1119 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1120 enum date_mode parse_date_format(const char *format);
1121 int date_overflows(unsigned long date);
1123 #define IDENT_STRICT 1
1124 #define IDENT_NO_DATE 2
1125 #define IDENT_NO_NAME 4
1126 extern const char *git_author_info(int);
1127 extern const char *git_committer_info(int);
1128 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1129 extern const char *fmt_name(const char *name, const char *email);
1130 extern const char *ident_default_name(void);
1131 extern const char *ident_default_email(void);
1132 extern const char *git_editor(void);
1133 extern const char *git_pager(int stdout_is_tty);
1134 extern int git_ident_config(const char *, const char *, void *);
1136 struct ident_split {
1137 const char *name_begin;
1138 const char *name_end;
1139 const char *mail_begin;
1140 const char *mail_end;
1141 const char *date_begin;
1142 const char *date_end;
1143 const char *tz_begin;
1144 const char *tz_end;
1147 * Signals an success with 0, but time part of the result may be NULL
1148 * if the input lacks timestamp and zone
1150 extern int split_ident_line(struct ident_split *, const char *, int);
1153 * Like show_date, but pull the timestamp and tz parameters from
1154 * the ident_split. It will also sanity-check the values and produce
1155 * a well-known sentinel date if they appear bogus.
1157 const char *show_ident_date(const struct ident_split *id, enum date_mode mode);
1160 * Compare split idents for equality or strict ordering. Note that we
1161 * compare only the ident part of the line, ignoring any timestamp.
1163 * Because there are two fields, we must choose one as the primary key; we
1164 * currently arbitrarily pick the email.
1166 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1168 struct checkout {
1169 struct index_state *istate;
1170 const char *base_dir;
1171 int base_dir_len;
1172 unsigned force:1,
1173 quiet:1,
1174 not_new:1,
1175 refresh_cache:1;
1178 #define TEMPORARY_FILENAME_LENGTH 25
1179 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1181 struct cache_def {
1182 struct strbuf path;
1183 int flags;
1184 int track_flags;
1185 int prefix_len_stat_func;
1187 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1188 static inline void cache_def_clear(struct cache_def *cache)
1190 strbuf_release(&cache->path);
1193 extern int has_symlink_leading_path(const char *name, int len);
1194 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1195 extern int check_leading_path(const char *name, int len);
1196 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1197 extern void schedule_dir_for_removal(const char *name, int len);
1198 extern void remove_scheduled_dirs(void);
1200 extern struct alternate_object_database {
1201 struct alternate_object_database *next;
1202 char *name;
1203 char base[FLEX_ARRAY]; /* more */
1204 } *alt_odb_list;
1205 extern void prepare_alt_odb(void);
1206 extern void read_info_alternates(const char * relative_base, int depth);
1207 extern void add_to_alternates_file(const char *reference);
1208 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1209 extern int foreach_alt_odb(alt_odb_fn, void*);
1211 struct pack_window {
1212 struct pack_window *next;
1213 unsigned char *base;
1214 off_t offset;
1215 size_t len;
1216 unsigned int last_used;
1217 unsigned int inuse_cnt;
1220 extern struct packed_git {
1221 struct packed_git *next;
1222 struct pack_window *windows;
1223 off_t pack_size;
1224 const void *index_data;
1225 size_t index_size;
1226 uint32_t num_objects;
1227 uint32_t num_bad_objects;
1228 unsigned char *bad_object_sha1;
1229 int index_version;
1230 time_t mtime;
1231 int pack_fd;
1232 unsigned pack_local:1,
1233 pack_keep:1,
1234 freshened:1,
1235 do_not_close:1;
1236 unsigned char sha1[20];
1237 /* something like ".git/objects/pack/xxxxx.pack" */
1238 char pack_name[FLEX_ARRAY]; /* more */
1239 } *packed_git;
1241 struct pack_entry {
1242 off_t offset;
1243 unsigned char sha1[20];
1244 struct packed_git *p;
1247 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1249 /* A hook for count-objects to report invalid files in pack directory */
1250 extern void (*report_garbage)(const char *desc, const char *path);
1252 extern void prepare_packed_git(void);
1253 extern void reprepare_packed_git(void);
1254 extern void install_packed_git(struct packed_git *pack);
1256 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1257 struct packed_git *packs);
1259 extern void pack_report(void);
1262 * mmap the index file for the specified packfile (if it is not
1263 * already mmapped). Return 0 on success.
1265 extern int open_pack_index(struct packed_git *);
1268 * munmap the index file for the specified packfile (if it is
1269 * currently mmapped).
1271 extern void close_pack_index(struct packed_git *);
1273 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1274 extern void close_pack_windows(struct packed_git *);
1275 extern void unuse_pack(struct pack_window **);
1276 extern void free_pack_by_name(const char *);
1277 extern void clear_delta_base_cache(void);
1278 extern struct packed_git *add_packed_git(const char *, int, int);
1281 * Return the SHA-1 of the nth object within the specified packfile.
1282 * Open the index if it is not already open. The return value points
1283 * at the SHA-1 within the mmapped index. Return NULL if there is an
1284 * error.
1286 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1289 * Return the offset of the nth object within the specified packfile.
1290 * The index must already be opened.
1292 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1295 * If the object named sha1 is present in the specified packfile,
1296 * return its offset within the packfile; otherwise, return 0.
1298 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1300 extern int is_pack_valid(struct packed_git *);
1301 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1302 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1303 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1304 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1307 * Iterate over the files in the loose-object parts of the object
1308 * directory "path", triggering the following callbacks:
1310 * - loose_object is called for each loose object we find.
1312 * - loose_cruft is called for any files that do not appear to be
1313 * loose objects. Note that we only look in the loose object
1314 * directories "objects/[0-9a-f]{2}/", so we will not report
1315 * "objects/foobar" as cruft.
1317 * - loose_subdir is called for each top-level hashed subdirectory
1318 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1319 * after the objects in the directory are processed.
1321 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1322 * will end the iteration.
1324 * In the "buf" variant, "path" is a strbuf which will also be used as a
1325 * scratch buffer, but restored to its original contents before
1326 * the function returns.
1328 typedef int each_loose_object_fn(const unsigned char *sha1,
1329 const char *path,
1330 void *data);
1331 typedef int each_loose_cruft_fn(const char *basename,
1332 const char *path,
1333 void *data);
1334 typedef int each_loose_subdir_fn(int nr,
1335 const char *path,
1336 void *data);
1337 int for_each_loose_file_in_objdir(const char *path,
1338 each_loose_object_fn obj_cb,
1339 each_loose_cruft_fn cruft_cb,
1340 each_loose_subdir_fn subdir_cb,
1341 void *data);
1342 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1343 each_loose_object_fn obj_cb,
1344 each_loose_cruft_fn cruft_cb,
1345 each_loose_subdir_fn subdir_cb,
1346 void *data);
1349 * Iterate over loose and packed objects in both the local
1350 * repository and any alternates repositories (unless the
1351 * LOCAL_ONLY flag is set).
1353 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1354 typedef int each_packed_object_fn(const unsigned char *sha1,
1355 struct packed_git *pack,
1356 uint32_t pos,
1357 void *data);
1358 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1359 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1361 struct object_info {
1362 /* Request */
1363 enum object_type *typep;
1364 unsigned long *sizep;
1365 unsigned long *disk_sizep;
1366 unsigned char *delta_base_sha1;
1367 struct strbuf *typename;
1369 /* Response */
1370 enum {
1371 OI_CACHED,
1372 OI_LOOSE,
1373 OI_PACKED,
1374 OI_DBCACHED
1375 } whence;
1376 union {
1378 * struct {
1379 * ... Nothing to expose in this case
1380 * } cached;
1381 * struct {
1382 * ... Nothing to expose in this case
1383 * } loose;
1385 struct {
1386 struct packed_git *pack;
1387 off_t offset;
1388 unsigned int is_delta;
1389 } packed;
1390 } u;
1392 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1394 /* Dumb servers support */
1395 extern int update_server_info(int);
1397 /* git_config_parse_key() returns these negated: */
1398 #define CONFIG_INVALID_KEY 1
1399 #define CONFIG_NO_SECTION_OR_NAME 2
1400 /* git_config_set(), git_config_set_multivar() return the above or these: */
1401 #define CONFIG_NO_LOCK -1
1402 #define CONFIG_INVALID_FILE 3
1403 #define CONFIG_NO_WRITE 4
1404 #define CONFIG_NOTHING_SET 5
1405 #define CONFIG_INVALID_PATTERN 6
1406 #define CONFIG_GENERIC_ERROR 7
1408 #define CONFIG_REGEX_NONE ((void *)1)
1410 struct git_config_source {
1411 unsigned int use_stdin:1;
1412 const char *file;
1413 const char *blob;
1416 typedef int (*config_fn_t)(const char *, const char *, void *);
1417 extern int git_default_config(const char *, const char *, void *);
1418 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1419 extern int git_config_from_buf(config_fn_t fn, const char *name,
1420 const char *buf, size_t len, void *data);
1421 extern void git_config_push_parameter(const char *text);
1422 extern int git_config_from_parameters(config_fn_t fn, void *data);
1423 extern void git_config(config_fn_t fn, void *);
1424 extern int git_config_with_options(config_fn_t fn, void *,
1425 struct git_config_source *config_source,
1426 int respect_includes);
1427 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1428 extern int git_parse_ulong(const char *, unsigned long *);
1429 extern int git_config_int(const char *, const char *);
1430 extern int64_t git_config_int64(const char *, const char *);
1431 extern unsigned long git_config_ulong(const char *, const char *);
1432 extern int git_config_bool_or_int(const char *, const char *, int *);
1433 extern int git_config_bool(const char *, const char *);
1434 extern int git_config_maybe_bool(const char *, const char *);
1435 extern int git_config_string(const char **, const char *, const char *);
1436 extern int git_config_pathname(const char **, const char *, const char *);
1437 extern int git_config_set_in_file(const char *, const char *, const char *);
1438 extern int git_config_set(const char *, const char *);
1439 extern int git_config_parse_key(const char *, char **, int *);
1440 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1441 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1442 extern int git_config_rename_section(const char *, const char *);
1443 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1444 extern const char *git_etc_gitconfig(void);
1445 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1446 extern int git_env_bool(const char *, int);
1447 extern unsigned long git_env_ulong(const char *, unsigned long);
1448 extern int git_config_system(void);
1449 extern int config_error_nonbool(const char *);
1450 #if defined(__GNUC__)
1451 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1452 #endif
1453 extern const char *get_log_output_encoding(void);
1454 extern const char *get_commit_output_encoding(void);
1456 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1458 struct config_include_data {
1459 int depth;
1460 config_fn_t fn;
1461 void *data;
1463 #define CONFIG_INCLUDE_INIT { 0 }
1464 extern int git_config_include(const char *name, const char *value, void *data);
1467 * Match and parse a config key of the form:
1469 * section.(subsection.)?key
1471 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1472 * we return -1 if it does not match, 0 otherwise. The subsection and key
1473 * out-parameters are filled by the function (and subsection is NULL if it is
1474 * missing).
1476 extern int parse_config_key(const char *var,
1477 const char *section,
1478 const char **subsection, int *subsection_len,
1479 const char **key);
1481 struct config_set_element {
1482 struct hashmap_entry ent;
1483 char *key;
1484 struct string_list value_list;
1487 struct configset_list_item {
1488 struct config_set_element *e;
1489 int value_index;
1493 * the contents of the list are ordered according to their
1494 * position in the config files and order of parsing the files.
1495 * (i.e. key-value pair at the last position of .git/config will
1496 * be at the last item of the list)
1498 struct configset_list {
1499 struct configset_list_item *items;
1500 unsigned int nr, alloc;
1503 struct config_set {
1504 struct hashmap config_hash;
1505 int hash_initialized;
1506 struct configset_list list;
1509 extern void git_configset_init(struct config_set *cs);
1510 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1511 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1512 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1513 extern void git_configset_clear(struct config_set *cs);
1514 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1515 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1516 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1517 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1518 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1519 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1520 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1521 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1523 extern int git_config_get_value(const char *key, const char **value);
1524 extern const struct string_list *git_config_get_value_multi(const char *key);
1525 extern void git_config_clear(void);
1526 extern void git_config_iter(config_fn_t fn, void *data);
1527 extern int git_config_get_string_const(const char *key, const char **dest);
1528 extern int git_config_get_string(const char *key, char **dest);
1529 extern int git_config_get_int(const char *key, int *dest);
1530 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1531 extern int git_config_get_bool(const char *key, int *dest);
1532 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1533 extern int git_config_get_maybe_bool(const char *key, int *dest);
1534 extern int git_config_get_pathname(const char *key, const char **dest);
1536 struct key_value_info {
1537 const char *filename;
1538 int linenr;
1541 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1542 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1544 extern int committer_ident_sufficiently_given(void);
1545 extern int author_ident_sufficiently_given(void);
1547 extern const char *git_commit_encoding;
1548 extern const char *git_log_output_encoding;
1549 extern const char *git_mailmap_file;
1550 extern const char *git_mailmap_blob;
1552 /* IO helper functions */
1553 extern void maybe_flush_or_die(FILE *, const char *);
1554 __attribute__((format (printf, 2, 3)))
1555 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1557 #define COPY_READ_ERROR (-2)
1558 #define COPY_WRITE_ERROR (-3)
1559 extern int copy_fd(int ifd, int ofd);
1560 extern int copy_file(const char *dst, const char *src, int mode);
1561 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1563 extern void write_or_die(int fd, const void *buf, size_t count);
1564 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1565 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1566 extern void fsync_or_die(int fd, const char *);
1568 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1569 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1570 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1572 static inline ssize_t write_str_in_full(int fd, const char *str)
1574 return write_in_full(fd, str, strlen(str));
1576 __attribute__((format (printf, 3, 4)))
1577 extern int write_file(const char *path, int fatal, const char *fmt, ...);
1579 /* pager.c */
1580 extern void setup_pager(void);
1581 extern const char *pager_program;
1582 extern int pager_in_use(void);
1583 extern int pager_use_color;
1584 extern int term_columns(void);
1585 extern int decimal_width(uintmax_t);
1586 extern int check_pager_config(const char *cmd);
1588 extern const char *editor_program;
1589 extern const char *askpass_program;
1590 extern const char *excludes_file;
1592 /* base85 */
1593 int decode_85(char *dst, const char *line, int linelen);
1594 void encode_85(char *buf, const unsigned char *data, int bytes);
1596 /* alloc.c */
1597 extern void *alloc_blob_node(void);
1598 extern void *alloc_tree_node(void);
1599 extern void *alloc_commit_node(void);
1600 extern void *alloc_tag_node(void);
1601 extern void *alloc_object_node(void);
1602 extern void alloc_report(void);
1603 extern unsigned int alloc_commit_index(void);
1605 /* pkt-line.c */
1606 void packet_trace_identity(const char *prog);
1608 /* add */
1610 * return 0 if success, 1 - if addition of a file failed and
1611 * ADD_FILES_IGNORE_ERRORS was specified in flags
1613 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1615 /* diff.c */
1616 extern int diff_auto_refresh_index;
1618 /* match-trees.c */
1619 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1620 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1623 * whitespace rules.
1624 * used by both diff and apply
1625 * last two digits are tab width
1627 #define WS_BLANK_AT_EOL 0100
1628 #define WS_SPACE_BEFORE_TAB 0200
1629 #define WS_INDENT_WITH_NON_TAB 0400
1630 #define WS_CR_AT_EOL 01000
1631 #define WS_BLANK_AT_EOF 02000
1632 #define WS_TAB_IN_INDENT 04000
1633 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1634 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1635 #define WS_TAB_WIDTH_MASK 077
1636 extern unsigned whitespace_rule_cfg;
1637 extern unsigned whitespace_rule(const char *);
1638 extern unsigned parse_whitespace_rule(const char *);
1639 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1640 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1641 extern char *whitespace_error_string(unsigned ws);
1642 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1643 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1644 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1646 /* ls-files */
1647 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1649 char *alias_lookup(const char *alias);
1650 int split_cmdline(char *cmdline, const char ***argv);
1651 /* Takes a negative value returned by split_cmdline */
1652 const char *split_cmdline_strerror(int cmdline_errno);
1654 /* git.c */
1655 struct startup_info {
1656 int have_repository;
1657 const char *prefix;
1659 extern struct startup_info *startup_info;
1661 /* merge.c */
1662 struct commit_list;
1663 int try_merge_command(const char *strategy, size_t xopts_nr,
1664 const char **xopts, struct commit_list *common,
1665 const char *head_arg, struct commit_list *remotes);
1666 int checkout_fast_forward(const unsigned char *from,
1667 const unsigned char *to,
1668 int overwrite_ignore);
1671 int sane_execvp(const char *file, char *const argv[]);
1674 * A struct to encapsulate the concept of whether a file has changed
1675 * since we last checked it. This uses criteria similar to those used
1676 * for the index.
1678 struct stat_validity {
1679 struct stat_data *sd;
1682 void stat_validity_clear(struct stat_validity *sv);
1685 * Returns 1 if the path is a regular file (or a symlink to a regular
1686 * file) and matches the saved stat_validity, 0 otherwise. A missing
1687 * or inaccessible file is considered a match if the struct was just
1688 * initialized, or if the previous update found an inaccessible file.
1690 int stat_validity_check(struct stat_validity *sv, const char *path);
1693 * Update the stat_validity from a file opened at descriptor fd. If
1694 * the file is missing, inaccessible, or not a regular file, then
1695 * future calls to stat_validity_check will match iff one of those
1696 * conditions continues to be true.
1698 void stat_validity_update(struct stat_validity *sv, int fd);
1700 int versioncmp(const char *s1, const char *s2);
1702 #endif /* CACHE_H */