Sync with 2.6.4
[git/gitweb.git] / cache.h
blob2a9e90285e1b202bf6a429a7614fc6d517a2801d
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 platform_SHA_CTX
16 * platform's underlying implementation of SHA-1; could be OpenSSL,
17 * blk_SHA, Apple CommonCrypto, etc... Note that including
18 * SHA1_HEADER may have already defined platform_SHA_CTX for our
19 * own implementations like block-sha1 and ppc-sha1, so we list
20 * the default for OpenSSL compatible SHA-1 implementations here.
22 #define platform_SHA_CTX SHA_CTX
23 #define platform_SHA1_Init SHA1_Init
24 #define platform_SHA1_Update SHA1_Update
25 #define platform_SHA1_Final SHA1_Final
26 #endif
28 #define git_SHA_CTX platform_SHA_CTX
29 #define git_SHA1_Init platform_SHA1_Init
30 #define git_SHA1_Update platform_SHA1_Update
31 #define git_SHA1_Final platform_SHA1_Final
33 #ifdef SHA1_MAX_BLOCK_SIZE
34 #include "compat/sha1-chunked.h"
35 #undef git_SHA1_Update
36 #define git_SHA1_Update git_SHA1_Update_Chunked
37 #endif
39 #include <zlib.h>
40 typedef struct git_zstream {
41 z_stream z;
42 unsigned long avail_in;
43 unsigned long avail_out;
44 unsigned long total_in;
45 unsigned long total_out;
46 unsigned char *next_in;
47 unsigned char *next_out;
48 } git_zstream;
50 void git_inflate_init(git_zstream *);
51 void git_inflate_init_gzip_only(git_zstream *);
52 void git_inflate_end(git_zstream *);
53 int git_inflate(git_zstream *, int flush);
55 void git_deflate_init(git_zstream *, int level);
56 void git_deflate_init_gzip(git_zstream *, int level);
57 void git_deflate_init_raw(git_zstream *, int level);
58 void git_deflate_end(git_zstream *);
59 int git_deflate_abort(git_zstream *);
60 int git_deflate_end_gently(git_zstream *);
61 int git_deflate(git_zstream *, int flush);
62 unsigned long git_deflate_bound(git_zstream *, unsigned long);
64 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
65 #define GIT_SHA1_RAWSZ 20
66 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
68 struct object_id {
69 unsigned char hash[GIT_SHA1_RAWSZ];
72 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
73 #define DTYPE(de) ((de)->d_type)
74 #else
75 #undef DT_UNKNOWN
76 #undef DT_DIR
77 #undef DT_REG
78 #undef DT_LNK
79 #define DT_UNKNOWN 0
80 #define DT_DIR 1
81 #define DT_REG 2
82 #define DT_LNK 3
83 #define DTYPE(de) DT_UNKNOWN
84 #endif
86 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
87 #define S_IFINVALID 0030000
90 * A "directory link" is a link to another git directory.
92 * The value 0160000 is not normally a valid mode, and
93 * also just happens to be S_IFDIR + S_IFLNK
95 #define S_IFGITLINK 0160000
96 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
99 * Some mode bits are also used internally for computations.
101 * They *must* not overlap with any valid modes, and they *must* not be emitted
102 * to outside world - i.e. appear on disk or network. In other words, it's just
103 * temporary fields, which we internally use, but they have to stay in-house.
105 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
106 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
109 /* used internally in tree-diff */
110 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
114 * Intensive research over the course of many years has shown that
115 * port 9418 is totally unused by anything else. Or
117 * Your search - "port 9418" - did not match any documents.
119 * as www.google.com puts it.
121 * This port has been properly assigned for git use by IANA:
122 * git (Assigned-9418) [I06-050728-0001].
124 * git 9418/tcp git pack transfer service
125 * git 9418/udp git pack transfer service
127 * with Linus Torvalds <torvalds@osdl.org> as the point of
128 * contact. September 2005.
130 * See http://www.iana.org/assignments/port-numbers
132 #define DEFAULT_GIT_PORT 9418
135 * Basic data structures for the directory cache
138 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
139 struct cache_header {
140 uint32_t hdr_signature;
141 uint32_t hdr_version;
142 uint32_t hdr_entries;
145 #define INDEX_FORMAT_LB 2
146 #define INDEX_FORMAT_UB 4
149 * The "cache_time" is just the low 32 bits of the
150 * time. It doesn't matter if it overflows - we only
151 * check it for equality in the 32 bits we save.
153 struct cache_time {
154 uint32_t sec;
155 uint32_t nsec;
158 struct stat_data {
159 struct cache_time sd_ctime;
160 struct cache_time sd_mtime;
161 unsigned int sd_dev;
162 unsigned int sd_ino;
163 unsigned int sd_uid;
164 unsigned int sd_gid;
165 unsigned int sd_size;
168 struct cache_entry {
169 struct hashmap_entry ent;
170 struct stat_data ce_stat_data;
171 unsigned int ce_mode;
172 unsigned int ce_flags;
173 unsigned int ce_namelen;
174 unsigned int index; /* for link extension */
175 unsigned char sha1[20];
176 char name[FLEX_ARRAY]; /* more */
179 #define CE_STAGEMASK (0x3000)
180 #define CE_EXTENDED (0x4000)
181 #define CE_VALID (0x8000)
182 #define CE_STAGESHIFT 12
185 * Range 0xFFFF0FFF in ce_flags is divided into
186 * two parts: in-memory flags and on-disk ones.
187 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
188 * if you want to save a new flag, add it in
189 * CE_EXTENDED_FLAGS
191 * In-memory only flags
193 #define CE_UPDATE (1 << 16)
194 #define CE_REMOVE (1 << 17)
195 #define CE_UPTODATE (1 << 18)
196 #define CE_ADDED (1 << 19)
198 #define CE_HASHED (1 << 20)
199 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
200 #define CE_CONFLICTED (1 << 23)
202 #define CE_UNPACKED (1 << 24)
203 #define CE_NEW_SKIP_WORKTREE (1 << 25)
205 /* used to temporarily mark paths matched by pathspecs */
206 #define CE_MATCHED (1 << 26)
208 #define CE_UPDATE_IN_BASE (1 << 27)
209 #define CE_STRIP_NAME (1 << 28)
212 * Extended on-disk flags
214 #define CE_INTENT_TO_ADD (1 << 29)
215 #define CE_SKIP_WORKTREE (1 << 30)
216 /* CE_EXTENDED2 is for future extension */
217 #define CE_EXTENDED2 (1 << 31)
219 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
222 * Safeguard to avoid saving wrong flags:
223 * - CE_EXTENDED2 won't get saved until its semantic is known
224 * - Bits in 0x0000FFFF have been saved in ce_flags already
225 * - Bits in 0x003F0000 are currently in-memory flags
227 #if CE_EXTENDED_FLAGS & 0x803FFFFF
228 #error "CE_EXTENDED_FLAGS out of range"
229 #endif
231 struct pathspec;
234 * Copy the sha1 and stat state of a cache entry from one to
235 * another. But we never change the name, or the hash state!
237 static inline void copy_cache_entry(struct cache_entry *dst,
238 const struct cache_entry *src)
240 unsigned int state = dst->ce_flags & CE_HASHED;
242 /* Don't copy hash chain and name */
243 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
244 offsetof(struct cache_entry, name) -
245 offsetof(struct cache_entry, ce_stat_data));
247 /* Restore the hash state */
248 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
251 static inline unsigned create_ce_flags(unsigned stage)
253 return (stage << CE_STAGESHIFT);
256 #define ce_namelen(ce) ((ce)->ce_namelen)
257 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
258 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
259 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
260 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
261 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
263 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
264 static inline unsigned int create_ce_mode(unsigned int mode)
266 if (S_ISLNK(mode))
267 return S_IFLNK;
268 if (S_ISDIR(mode) || S_ISGITLINK(mode))
269 return S_IFGITLINK;
270 return S_IFREG | ce_permissions(mode);
272 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
273 unsigned int mode)
275 extern int trust_executable_bit, has_symlinks;
276 if (!has_symlinks && S_ISREG(mode) &&
277 ce && S_ISLNK(ce->ce_mode))
278 return ce->ce_mode;
279 if (!trust_executable_bit && S_ISREG(mode)) {
280 if (ce && S_ISREG(ce->ce_mode))
281 return ce->ce_mode;
282 return create_ce_mode(0666);
284 return create_ce_mode(mode);
286 static inline int ce_to_dtype(const struct cache_entry *ce)
288 unsigned ce_mode = ntohl(ce->ce_mode);
289 if (S_ISREG(ce_mode))
290 return DT_REG;
291 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
292 return DT_DIR;
293 else if (S_ISLNK(ce_mode))
294 return DT_LNK;
295 else
296 return DT_UNKNOWN;
298 static inline unsigned int canon_mode(unsigned int mode)
300 if (S_ISREG(mode))
301 return S_IFREG | ce_permissions(mode);
302 if (S_ISLNK(mode))
303 return S_IFLNK;
304 if (S_ISDIR(mode))
305 return S_IFDIR;
306 return S_IFGITLINK;
309 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
311 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
312 #define CE_ENTRY_CHANGED (1 << 1)
313 #define CE_ENTRY_REMOVED (1 << 2)
314 #define CE_ENTRY_ADDED (1 << 3)
315 #define RESOLVE_UNDO_CHANGED (1 << 4)
316 #define CACHE_TREE_CHANGED (1 << 5)
317 #define SPLIT_INDEX_ORDERED (1 << 6)
318 #define UNTRACKED_CHANGED (1 << 7)
320 struct split_index;
321 struct untracked_cache;
323 struct index_state {
324 struct cache_entry **cache;
325 unsigned int version;
326 unsigned int cache_nr, cache_alloc, cache_changed;
327 struct string_list *resolve_undo;
328 struct cache_tree *cache_tree;
329 struct split_index *split_index;
330 struct cache_time timestamp;
331 unsigned name_hash_initialized : 1,
332 initialized : 1;
333 struct hashmap name_hash;
334 struct hashmap dir_hash;
335 unsigned char sha1[20];
336 struct untracked_cache *untracked;
339 extern struct index_state the_index;
341 /* Name hashing */
342 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
343 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
344 extern void free_name_hash(struct index_state *istate);
347 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
348 #define active_cache (the_index.cache)
349 #define active_nr (the_index.cache_nr)
350 #define active_alloc (the_index.cache_alloc)
351 #define active_cache_changed (the_index.cache_changed)
352 #define active_cache_tree (the_index.cache_tree)
354 #define read_cache() read_index(&the_index)
355 #define read_cache_from(path) read_index_from(&the_index, (path))
356 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
357 #define is_cache_unborn() is_index_unborn(&the_index)
358 #define read_cache_unmerged() read_index_unmerged(&the_index)
359 #define discard_cache() discard_index(&the_index)
360 #define unmerged_cache() unmerged_index(&the_index)
361 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
362 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
363 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
364 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
365 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
366 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
367 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
368 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
369 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
370 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
371 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
372 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
373 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
374 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
375 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
376 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
377 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
378 #endif
380 enum object_type {
381 OBJ_BAD = -1,
382 OBJ_NONE = 0,
383 OBJ_COMMIT = 1,
384 OBJ_TREE = 2,
385 OBJ_BLOB = 3,
386 OBJ_TAG = 4,
387 /* 5 for future expansion */
388 OBJ_OFS_DELTA = 6,
389 OBJ_REF_DELTA = 7,
390 OBJ_ANY,
391 OBJ_MAX
394 static inline enum object_type object_type(unsigned int mode)
396 return S_ISDIR(mode) ? OBJ_TREE :
397 S_ISGITLINK(mode) ? OBJ_COMMIT :
398 OBJ_BLOB;
401 /* Double-check local_repo_env below if you add to this list. */
402 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
403 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
404 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
405 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
406 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
407 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
408 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
409 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
410 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
411 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
412 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
413 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
414 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
415 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
416 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
417 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
418 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
419 #define GITATTRIBUTES_FILE ".gitattributes"
420 #define INFOATTRIBUTES_FILE "info/attributes"
421 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
422 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
423 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
424 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
425 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
426 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
427 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
428 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
429 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
430 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
433 * This environment variable is expected to contain a boolean indicating
434 * whether we should or should not treat:
436 * GIT_DIR=foo.git git ...
438 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
439 * of this, but we use it internally to communicate to sub-processes that we
440 * are in a bare repo. If not set, defaults to true.
442 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
445 * Repository-local GIT_* environment variables; these will be cleared
446 * when git spawns a sub-process that runs inside another repository.
447 * The array is NULL-terminated, which makes it easy to pass in the "env"
448 * parameter of a run-command invocation, or to do a simple walk.
450 extern const char * const local_repo_env[];
452 extern int is_bare_repository_cfg;
453 extern int is_bare_repository(void);
454 extern int is_inside_git_dir(void);
455 extern char *git_work_tree_cfg;
456 extern int is_inside_work_tree(void);
457 extern const char *get_git_dir(void);
458 extern const char *get_git_common_dir(void);
459 extern int is_git_directory(const char *path);
460 extern char *get_object_directory(void);
461 extern char *get_index_file(void);
462 extern char *get_graft_file(void);
463 extern int set_git_dir(const char *path);
464 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
465 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
466 extern const char *get_git_namespace(void);
467 extern const char *strip_namespace(const char *namespaced_ref);
468 extern const char *get_git_work_tree(void);
470 #define READ_GITFILE_ERR_STAT_FAILED 1
471 #define READ_GITFILE_ERR_NOT_A_FILE 2
472 #define READ_GITFILE_ERR_OPEN_FAILED 3
473 #define READ_GITFILE_ERR_READ_FAILED 4
474 #define READ_GITFILE_ERR_INVALID_FORMAT 5
475 #define READ_GITFILE_ERR_NO_PATH 6
476 #define READ_GITFILE_ERR_NOT_A_REPO 7
477 #define READ_GITFILE_ERR_TOO_LARGE 8
478 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
479 #define read_gitfile(path) read_gitfile_gently((path), NULL)
480 extern const char *resolve_gitdir(const char *suspect);
481 extern void set_git_work_tree(const char *tree);
483 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
485 extern const char **get_pathspec(const char *prefix, const char **pathspec);
486 extern void setup_work_tree(void);
487 extern const char *setup_git_directory_gently(int *);
488 extern const char *setup_git_directory(void);
489 extern char *prefix_path(const char *prefix, int len, const char *path);
490 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
491 extern const char *prefix_filename(const char *prefix, int len, const char *path);
492 extern int check_filename(const char *prefix, const char *name);
493 extern void verify_filename(const char *prefix,
494 const char *name,
495 int diagnose_misspelt_rev);
496 extern void verify_non_filename(const char *prefix, const char *name);
497 extern int path_inside_repo(const char *prefix, const char *path);
499 #define INIT_DB_QUIET 0x0001
501 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
502 extern int init_db(const char *template_dir, unsigned int flags);
504 extern void sanitize_stdfds(void);
505 extern int daemonize(void);
507 #define alloc_nr(x) (((x)+16)*3/2)
510 * Realloc the buffer pointed at by variable 'x' so that it can hold
511 * at least 'nr' entries; the number of entries currently allocated
512 * is 'alloc', using the standard growing factor alloc_nr() macro.
514 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
516 #define ALLOC_GROW(x, nr, alloc) \
517 do { \
518 if ((nr) > alloc) { \
519 if (alloc_nr(alloc) < (nr)) \
520 alloc = (nr); \
521 else \
522 alloc = alloc_nr(alloc); \
523 REALLOC_ARRAY(x, alloc); \
525 } while (0)
527 /* Initialize and use the cache information */
528 struct lock_file;
529 extern int read_index(struct index_state *);
530 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
531 extern int do_read_index(struct index_state *istate, const char *path,
532 int must_exist); /* for testting only! */
533 extern int read_index_from(struct index_state *, const char *path);
534 extern int is_index_unborn(struct index_state *);
535 extern int read_index_unmerged(struct index_state *);
536 #define COMMIT_LOCK (1 << 0)
537 #define CLOSE_LOCK (1 << 1)
538 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
539 extern int discard_index(struct index_state *);
540 extern int unmerged_index(const struct index_state *);
541 extern int verify_path(const char *path);
542 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
543 extern void adjust_dirname_case(struct index_state *istate, char *name);
544 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
545 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
546 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
547 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
548 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
549 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
550 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
551 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
552 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
553 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
554 extern int remove_index_entry_at(struct index_state *, int pos);
555 extern void remove_marked_cache_entries(struct index_state *istate);
556 extern int remove_file_from_index(struct index_state *, const char *path);
557 #define ADD_CACHE_VERBOSE 1
558 #define ADD_CACHE_PRETEND 2
559 #define ADD_CACHE_IGNORE_ERRORS 4
560 #define ADD_CACHE_IGNORE_REMOVAL 8
561 #define ADD_CACHE_INTENT 16
562 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
563 extern int add_file_to_index(struct index_state *, const char *path, int flags);
564 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
565 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
566 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
567 extern int index_name_is_other(const struct index_state *, const char *, int);
568 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
570 /* do stat comparison even if CE_VALID is true */
571 #define CE_MATCH_IGNORE_VALID 01
572 /* do not check the contents but report dirty on racily-clean entries */
573 #define CE_MATCH_RACY_IS_DIRTY 02
574 /* do stat comparison even if CE_SKIP_WORKTREE is true */
575 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
576 /* ignore non-existent files during stat update */
577 #define CE_MATCH_IGNORE_MISSING 0x08
578 /* enable stat refresh */
579 #define CE_MATCH_REFRESH 0x10
580 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
581 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
583 #define HASH_WRITE_OBJECT 1
584 #define HASH_FORMAT_CHECK 2
585 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
586 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
589 * Record to sd the data from st that we use to check whether a file
590 * might have changed.
592 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
595 * Return 0 if st is consistent with a file not having been changed
596 * since sd was filled. If there are differences, return a
597 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
598 * INODE_CHANGED, and DATA_CHANGED.
600 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
601 extern int match_stat_data_racy(const struct index_state *istate,
602 const struct stat_data *sd, struct stat *st);
604 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
606 #define REFRESH_REALLY 0x0001 /* ignore_valid */
607 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
608 #define REFRESH_QUIET 0x0004 /* be quiet about it */
609 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
610 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
611 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
612 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
614 extern void update_index_if_able(struct index_state *, struct lock_file *);
616 extern int hold_locked_index(struct lock_file *, int);
617 extern void set_alternate_index_output(const char *);
619 /* Environment bits from configuration mechanism */
620 extern int trust_executable_bit;
621 extern int trust_ctime;
622 extern int check_stat;
623 extern int quote_path_fully;
624 extern int has_symlinks;
625 extern int minimum_abbrev, default_abbrev;
626 extern int ignore_case;
627 extern int assume_unchanged;
628 extern int prefer_symlink_refs;
629 extern int log_all_ref_updates;
630 extern int warn_ambiguous_refs;
631 extern int warn_on_object_refname_ambiguity;
632 extern int shared_repository;
633 extern const char *apply_default_whitespace;
634 extern const char *apply_default_ignorewhitespace;
635 extern const char *git_attributes_file;
636 extern int zlib_compression_level;
637 extern int core_compression_level;
638 extern int core_compression_seen;
639 extern size_t packed_git_window_size;
640 extern size_t packed_git_limit;
641 extern size_t delta_base_cache_limit;
642 extern unsigned long big_file_threshold;
643 extern unsigned long pack_size_limit_cfg;
646 * Do replace refs need to be checked this run? This variable is
647 * initialized to true unless --no-replace-object is used or
648 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
649 * commands that do not want replace references to be active. As an
650 * optimization it is also set to false if replace references have
651 * been sought but there were none.
653 extern int check_replace_refs;
654 extern char *git_replace_ref_base;
656 extern int fsync_object_files;
657 extern int core_preload_index;
658 extern int core_apply_sparse_checkout;
659 extern int precomposed_unicode;
660 extern int protect_hfs;
661 extern int protect_ntfs;
662 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
665 * Include broken refs in all ref iterations, which will
666 * generally choke dangerous operations rather than letting
667 * them silently proceed without taking the broken ref into
668 * account.
670 extern int ref_paranoia;
673 * The character that begins a commented line in user-editable file
674 * that is subject to stripspace.
676 extern char comment_line_char;
677 extern int auto_comment_line_char;
679 enum branch_track {
680 BRANCH_TRACK_UNSPECIFIED = -1,
681 BRANCH_TRACK_NEVER = 0,
682 BRANCH_TRACK_REMOTE,
683 BRANCH_TRACK_ALWAYS,
684 BRANCH_TRACK_EXPLICIT,
685 BRANCH_TRACK_OVERRIDE
688 enum rebase_setup_type {
689 AUTOREBASE_NEVER = 0,
690 AUTOREBASE_LOCAL,
691 AUTOREBASE_REMOTE,
692 AUTOREBASE_ALWAYS
695 enum push_default_type {
696 PUSH_DEFAULT_NOTHING = 0,
697 PUSH_DEFAULT_MATCHING,
698 PUSH_DEFAULT_SIMPLE,
699 PUSH_DEFAULT_UPSTREAM,
700 PUSH_DEFAULT_CURRENT,
701 PUSH_DEFAULT_UNSPECIFIED
704 extern enum branch_track git_branch_track;
705 extern enum rebase_setup_type autorebase;
706 extern enum push_default_type push_default;
708 enum object_creation_mode {
709 OBJECT_CREATION_USES_HARDLINKS = 0,
710 OBJECT_CREATION_USES_RENAMES = 1
713 extern enum object_creation_mode object_creation_mode;
715 extern char *notes_ref_name;
717 extern int grafts_replace_parents;
720 * GIT_REPO_VERSION is the version we write by default. The
721 * _READ variant is the highest number we know how to
722 * handle.
724 #define GIT_REPO_VERSION 0
725 #define GIT_REPO_VERSION_READ 1
726 extern int repository_format_version;
727 extern int repository_format_precious_objects;
728 extern int check_repository_format(void);
730 #define MTIME_CHANGED 0x0001
731 #define CTIME_CHANGED 0x0002
732 #define OWNER_CHANGED 0x0004
733 #define MODE_CHANGED 0x0008
734 #define INODE_CHANGED 0x0010
735 #define DATA_CHANGED 0x0020
736 #define TYPE_CHANGED 0x0040
739 * Return a statically allocated filename, either generically (mkpath), in
740 * the repository directory (git_path), or in a submodule's repository
741 * directory (git_path_submodule). In all cases, note that the result
742 * may be overwritten by another call to _any_ of the functions. Consider
743 * using the safer "dup" or "strbuf" formats below (in some cases, the
744 * unsafe versions have already been removed).
746 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
747 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
749 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
750 __attribute__((format (printf, 3, 4)));
751 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
752 __attribute__((format (printf, 2, 3)));
753 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
754 __attribute__((format (printf, 2, 3)));
755 extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
756 const char *fmt, ...)
757 __attribute__((format (printf, 3, 4)));
758 extern char *git_pathdup(const char *fmt, ...)
759 __attribute__((format (printf, 1, 2)));
760 extern char *mkpathdup(const char *fmt, ...)
761 __attribute__((format (printf, 1, 2)));
762 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
763 __attribute__((format (printf, 2, 3)));
765 extern void report_linked_checkout_garbage(void);
768 * You can define a static memoized git path like:
770 * static GIT_PATH_FUNC(git_path_foo, "FOO");
772 * or use one of the global ones below.
774 #define GIT_PATH_FUNC(func, filename) \
775 const char *func(void) \
777 static char *ret; \
778 if (!ret) \
779 ret = git_pathdup(filename); \
780 return ret; \
783 const char *git_path_cherry_pick_head(void);
784 const char *git_path_revert_head(void);
785 const char *git_path_squash_msg(void);
786 const char *git_path_merge_msg(void);
787 const char *git_path_merge_rr(void);
788 const char *git_path_merge_mode(void);
789 const char *git_path_merge_head(void);
790 const char *git_path_fetch_head(void);
791 const char *git_path_shallow(void);
794 * Return the name of the file in the local object database that would
795 * be used to store a loose object with the specified sha1. The
796 * return value is a pointer to a statically allocated buffer that is
797 * overwritten each time the function is called.
799 extern const char *sha1_file_name(const unsigned char *sha1);
802 * Return the name of the (local) packfile with the specified sha1 in
803 * its name. The return value is a pointer to memory that is
804 * overwritten each time this function is called.
806 extern char *sha1_pack_name(const unsigned char *sha1);
809 * Return the name of the (local) pack index file with the specified
810 * sha1 in its name. The return value is a pointer to memory that is
811 * overwritten each time this function is called.
813 extern char *sha1_pack_index_name(const unsigned char *sha1);
816 * Return an abbreviated sha1 unique within this repository's object database.
817 * The result will be at least `len` characters long, and will be NUL
818 * terminated.
820 * The non-`_r` version returns a static buffer which will be overwritten by
821 * subsequent calls.
823 * The `_r` variant writes to a buffer supplied by the caller, which must be at
824 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
825 * written (excluding the NUL terminator).
827 * Note that while this version avoids the static buffer, it is not fully
828 * reentrant, as it calls into other non-reentrant git code.
830 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
831 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
833 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
835 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
837 int i;
839 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
840 if (*sha1 != *sha2)
841 return *sha1 - *sha2;
844 return 0;
847 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
849 return hashcmp(oid1->hash, oid2->hash);
852 static inline int is_null_sha1(const unsigned char *sha1)
854 return !hashcmp(sha1, null_sha1);
857 static inline int is_null_oid(const struct object_id *oid)
859 return !hashcmp(oid->hash, null_sha1);
862 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
864 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
867 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
869 hashcpy(dst->hash, src->hash);
872 static inline void hashclr(unsigned char *hash)
874 memset(hash, 0, GIT_SHA1_RAWSZ);
877 static inline void oidclr(struct object_id *oid)
879 hashclr(oid->hash);
883 #define EMPTY_TREE_SHA1_HEX \
884 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
885 #define EMPTY_TREE_SHA1_BIN_LITERAL \
886 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
887 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
888 #define EMPTY_TREE_SHA1_BIN \
889 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
891 #define EMPTY_BLOB_SHA1_HEX \
892 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
893 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
894 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
895 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
896 #define EMPTY_BLOB_SHA1_BIN \
897 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
899 static inline int is_empty_blob_sha1(const unsigned char *sha1)
901 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
904 int git_mkstemp(char *path, size_t n, const char *template);
906 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
908 /* set default permissions by passing mode arguments to open(2) */
909 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
910 int git_mkstemp_mode(char *pattern, int mode);
913 * NOTE NOTE NOTE!!
915 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
916 * not be changed. Old repositories have core.sharedrepository written in
917 * numeric format, and therefore these values are preserved for compatibility
918 * reasons.
920 enum sharedrepo {
921 PERM_UMASK = 0,
922 OLD_PERM_GROUP = 1,
923 OLD_PERM_EVERYBODY = 2,
924 PERM_GROUP = 0660,
925 PERM_EVERYBODY = 0664
927 int git_config_perm(const char *var, const char *value);
928 int adjust_shared_perm(const char *path);
931 * Create the directory containing the named path, using care to be
932 * somewhat safe against races. Return one of the scld_error values
933 * to indicate success/failure.
935 * SCLD_VANISHED indicates that one of the ancestor directories of the
936 * path existed at one point during the function call and then
937 * suddenly vanished, probably because another process pruned the
938 * directory while we were working. To be robust against this kind of
939 * race, callers might want to try invoking the function again when it
940 * returns SCLD_VANISHED.
942 enum scld_error {
943 SCLD_OK = 0,
944 SCLD_FAILED = -1,
945 SCLD_PERMS = -2,
946 SCLD_EXISTS = -3,
947 SCLD_VANISHED = -4
949 enum scld_error safe_create_leading_directories(char *path);
950 enum scld_error safe_create_leading_directories_const(const char *path);
952 int mkdir_in_gitdir(const char *path);
953 extern char *expand_user_path(const char *path);
954 const char *enter_repo(const char *path, int strict);
955 static inline int is_absolute_path(const char *path)
957 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
959 int is_directory(const char *);
960 const char *real_path(const char *path);
961 const char *real_path_if_valid(const char *path);
962 const char *absolute_path(const char *path);
963 const char *remove_leading_path(const char *in, const char *prefix);
964 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
965 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
966 int normalize_path_copy(char *dst, const char *src);
967 int longest_ancestor_length(const char *path, struct string_list *prefixes);
968 char *strip_path_suffix(const char *path, const char *suffix);
969 int daemon_avoid_alias(const char *path);
970 extern int is_ntfs_dotgit(const char *name);
973 * Return a newly allocated string with the evaluation of
974 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
975 * "$HOME/.config/git/$filename". Return NULL upon error.
977 extern char *xdg_config_home(const char *filename);
979 /* object replacement */
980 #define LOOKUP_REPLACE_OBJECT 1
981 #define LOOKUP_UNKNOWN_OBJECT 2
982 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
983 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
985 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
989 * This internal function is only declared here for the benefit of
990 * lookup_replace_object(). Please do not call it directly.
992 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
995 * If object sha1 should be replaced, return the replacement object's
996 * name (replaced recursively, if necessary). The return value is
997 * either sha1 or a pointer to a permanently-allocated value. When
998 * object replacement is suppressed, always return sha1.
1000 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1002 if (!check_replace_refs)
1003 return sha1;
1004 return do_lookup_replace_object(sha1);
1007 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1009 if (!(flag & LOOKUP_REPLACE_OBJECT))
1010 return sha1;
1011 return lookup_replace_object(sha1);
1014 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1015 extern int sha1_object_info(const unsigned char *, unsigned long *);
1016 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1017 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1018 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1019 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1020 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1021 extern int git_open_noatime(const char *name);
1022 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1023 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1024 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1026 /* global flag to enable extra checks when accessing packed objects */
1027 extern int do_check_packed_object_crc;
1029 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1031 extern int finalize_object_file(const char *tmpfile, const char *filename);
1033 extern int has_sha1_pack(const unsigned char *sha1);
1036 * Return true iff we have an object named sha1, whether local or in
1037 * an alternate object database, and whether packed or loose. This
1038 * function does not respect replace references.
1040 * If the QUICK flag is set, do not re-check the pack directory
1041 * when we cannot find the object (this means we may give a false
1042 * negative answer if another process is simultaneously repacking).
1044 #define HAS_SHA1_QUICK 0x1
1045 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1046 static inline int has_sha1_file(const unsigned char *sha1)
1048 return has_sha1_file_with_flags(sha1, 0);
1052 * Return true iff an alternate object database has a loose object
1053 * with the specified name. This function does not respect replace
1054 * references.
1056 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1058 extern int has_pack_index(const unsigned char *sha1);
1060 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1062 extern const signed char hexval_table[256];
1063 static inline unsigned int hexval(unsigned char c)
1065 return hexval_table[c];
1068 /* Convert to/from hex/sha1 representation */
1069 #define MINIMUM_ABBREV minimum_abbrev
1070 #define DEFAULT_ABBREV default_abbrev
1072 struct object_context {
1073 unsigned char tree[20];
1074 char path[PATH_MAX];
1075 unsigned mode;
1077 * symlink_path is only used by get_tree_entry_follow_symlinks,
1078 * and only for symlinks that point outside the repository.
1080 struct strbuf symlink_path;
1083 #define GET_SHA1_QUIETLY 01
1084 #define GET_SHA1_COMMIT 02
1085 #define GET_SHA1_COMMITTISH 04
1086 #define GET_SHA1_TREE 010
1087 #define GET_SHA1_TREEISH 020
1088 #define GET_SHA1_BLOB 040
1089 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1090 #define GET_SHA1_ONLY_TO_DIE 04000
1092 extern int get_sha1(const char *str, unsigned char *sha1);
1093 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1094 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1095 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1096 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1097 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1098 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1099 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1101 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1102 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1105 * Try to read a SHA1 in hexadecimal format from the 40 characters
1106 * starting at hex. Write the 20-byte result to sha1 in binary form.
1107 * Return 0 on success. Reading stops if a NUL is encountered in the
1108 * input, so it is safe to pass this function an arbitrary
1109 * null-terminated string.
1111 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1112 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1115 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1116 * and writes the NUL-terminated output to the buffer `out`, which must be at
1117 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1118 * convenience.
1120 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1121 * buffers, making it safe to make multiple calls for a single statement, like:
1123 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1125 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1126 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1127 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1129 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1130 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1132 extern int validate_headref(const char *ref);
1134 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1135 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1136 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1137 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1139 extern void *read_object_with_reference(const unsigned char *sha1,
1140 const char *required_type,
1141 unsigned long *size,
1142 unsigned char *sha1_ret);
1144 extern struct object *peel_to_type(const char *name, int namelen,
1145 struct object *o, enum object_type);
1147 struct date_mode {
1148 enum date_mode_type {
1149 DATE_NORMAL = 0,
1150 DATE_RELATIVE,
1151 DATE_SHORT,
1152 DATE_ISO8601,
1153 DATE_ISO8601_STRICT,
1154 DATE_RFC2822,
1155 DATE_STRFTIME,
1156 DATE_RAW
1157 } type;
1158 const char *strftime_fmt;
1159 int local;
1163 * Convenience helper for passing a constant type, like:
1165 * show_date(t, tz, DATE_MODE(NORMAL));
1167 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1168 struct date_mode *date_mode_from_type(enum date_mode_type type);
1170 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1171 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1172 struct strbuf *timebuf);
1173 int parse_date(const char *date, struct strbuf *out);
1174 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1175 int parse_expiry_date(const char *date, unsigned long *timestamp);
1176 void datestamp(struct strbuf *out);
1177 #define approxidate(s) approxidate_careful((s), NULL)
1178 unsigned long approxidate_careful(const char *, int *);
1179 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1180 void parse_date_format(const char *format, struct date_mode *mode);
1181 int date_overflows(unsigned long date);
1183 #define IDENT_STRICT 1
1184 #define IDENT_NO_DATE 2
1185 #define IDENT_NO_NAME 4
1186 extern const char *git_author_info(int);
1187 extern const char *git_committer_info(int);
1188 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1189 extern const char *fmt_name(const char *name, const char *email);
1190 extern const char *ident_default_name(void);
1191 extern const char *ident_default_email(void);
1192 extern const char *git_editor(void);
1193 extern const char *git_pager(int stdout_is_tty);
1194 extern int git_ident_config(const char *, const char *, void *);
1196 struct ident_split {
1197 const char *name_begin;
1198 const char *name_end;
1199 const char *mail_begin;
1200 const char *mail_end;
1201 const char *date_begin;
1202 const char *date_end;
1203 const char *tz_begin;
1204 const char *tz_end;
1207 * Signals an success with 0, but time part of the result may be NULL
1208 * if the input lacks timestamp and zone
1210 extern int split_ident_line(struct ident_split *, const char *, int);
1213 * Like show_date, but pull the timestamp and tz parameters from
1214 * the ident_split. It will also sanity-check the values and produce
1215 * a well-known sentinel date if they appear bogus.
1217 const char *show_ident_date(const struct ident_split *id,
1218 const struct date_mode *mode);
1221 * Compare split idents for equality or strict ordering. Note that we
1222 * compare only the ident part of the line, ignoring any timestamp.
1224 * Because there are two fields, we must choose one as the primary key; we
1225 * currently arbitrarily pick the email.
1227 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1229 struct checkout {
1230 struct index_state *istate;
1231 const char *base_dir;
1232 int base_dir_len;
1233 unsigned force:1,
1234 quiet:1,
1235 not_new:1,
1236 refresh_cache:1;
1239 #define TEMPORARY_FILENAME_LENGTH 25
1240 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1242 struct cache_def {
1243 struct strbuf path;
1244 int flags;
1245 int track_flags;
1246 int prefix_len_stat_func;
1248 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1249 static inline void cache_def_clear(struct cache_def *cache)
1251 strbuf_release(&cache->path);
1254 extern int has_symlink_leading_path(const char *name, int len);
1255 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1256 extern int check_leading_path(const char *name, int len);
1257 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1258 extern void schedule_dir_for_removal(const char *name, int len);
1259 extern void remove_scheduled_dirs(void);
1261 extern struct alternate_object_database {
1262 struct alternate_object_database *next;
1263 char *name;
1264 char base[FLEX_ARRAY]; /* more */
1265 } *alt_odb_list;
1266 extern void prepare_alt_odb(void);
1267 extern void read_info_alternates(const char * relative_base, int depth);
1268 extern void add_to_alternates_file(const char *reference);
1269 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1270 extern int foreach_alt_odb(alt_odb_fn, void*);
1272 struct pack_window {
1273 struct pack_window *next;
1274 unsigned char *base;
1275 off_t offset;
1276 size_t len;
1277 unsigned int last_used;
1278 unsigned int inuse_cnt;
1281 extern struct packed_git {
1282 struct packed_git *next;
1283 struct pack_window *windows;
1284 off_t pack_size;
1285 const void *index_data;
1286 size_t index_size;
1287 uint32_t num_objects;
1288 uint32_t num_bad_objects;
1289 unsigned char *bad_object_sha1;
1290 int index_version;
1291 time_t mtime;
1292 int pack_fd;
1293 unsigned pack_local:1,
1294 pack_keep:1,
1295 freshened:1,
1296 do_not_close:1;
1297 unsigned char sha1[20];
1298 /* something like ".git/objects/pack/xxxxx.pack" */
1299 char pack_name[FLEX_ARRAY]; /* more */
1300 } *packed_git;
1302 struct pack_entry {
1303 off_t offset;
1304 unsigned char sha1[20];
1305 struct packed_git *p;
1308 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1310 /* A hook to report invalid files in pack directory */
1311 #define PACKDIR_FILE_PACK 1
1312 #define PACKDIR_FILE_IDX 2
1313 #define PACKDIR_FILE_GARBAGE 4
1314 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1316 extern void prepare_packed_git(void);
1317 extern void reprepare_packed_git(void);
1318 extern void install_packed_git(struct packed_git *pack);
1320 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1321 struct packed_git *packs);
1323 extern void pack_report(void);
1326 * mmap the index file for the specified packfile (if it is not
1327 * already mmapped). Return 0 on success.
1329 extern int open_pack_index(struct packed_git *);
1332 * munmap the index file for the specified packfile (if it is
1333 * currently mmapped).
1335 extern void close_pack_index(struct packed_git *);
1337 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1338 extern void close_pack_windows(struct packed_git *);
1339 extern void close_all_packs(void);
1340 extern void unuse_pack(struct pack_window **);
1341 extern void free_pack_by_name(const char *);
1342 extern void clear_delta_base_cache(void);
1343 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1346 * Return the SHA-1 of the nth object within the specified packfile.
1347 * Open the index if it is not already open. The return value points
1348 * at the SHA-1 within the mmapped index. Return NULL if there is an
1349 * error.
1351 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1354 * Return the offset of the nth object within the specified packfile.
1355 * The index must already be opened.
1357 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1360 * If the object named sha1 is present in the specified packfile,
1361 * return its offset within the packfile; otherwise, return 0.
1363 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1365 extern int is_pack_valid(struct packed_git *);
1366 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1367 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1368 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1369 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1372 * Iterate over the files in the loose-object parts of the object
1373 * directory "path", triggering the following callbacks:
1375 * - loose_object is called for each loose object we find.
1377 * - loose_cruft is called for any files that do not appear to be
1378 * loose objects. Note that we only look in the loose object
1379 * directories "objects/[0-9a-f]{2}/", so we will not report
1380 * "objects/foobar" as cruft.
1382 * - loose_subdir is called for each top-level hashed subdirectory
1383 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1384 * after the objects in the directory are processed.
1386 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1387 * will end the iteration.
1389 * In the "buf" variant, "path" is a strbuf which will also be used as a
1390 * scratch buffer, but restored to its original contents before
1391 * the function returns.
1393 typedef int each_loose_object_fn(const unsigned char *sha1,
1394 const char *path,
1395 void *data);
1396 typedef int each_loose_cruft_fn(const char *basename,
1397 const char *path,
1398 void *data);
1399 typedef int each_loose_subdir_fn(int nr,
1400 const char *path,
1401 void *data);
1402 int for_each_loose_file_in_objdir(const char *path,
1403 each_loose_object_fn obj_cb,
1404 each_loose_cruft_fn cruft_cb,
1405 each_loose_subdir_fn subdir_cb,
1406 void *data);
1407 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1408 each_loose_object_fn obj_cb,
1409 each_loose_cruft_fn cruft_cb,
1410 each_loose_subdir_fn subdir_cb,
1411 void *data);
1414 * Iterate over loose and packed objects in both the local
1415 * repository and any alternates repositories (unless the
1416 * LOCAL_ONLY flag is set).
1418 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1419 typedef int each_packed_object_fn(const unsigned char *sha1,
1420 struct packed_git *pack,
1421 uint32_t pos,
1422 void *data);
1423 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1424 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1426 struct object_info {
1427 /* Request */
1428 enum object_type *typep;
1429 unsigned long *sizep;
1430 unsigned long *disk_sizep;
1431 unsigned char *delta_base_sha1;
1432 struct strbuf *typename;
1434 /* Response */
1435 enum {
1436 OI_CACHED,
1437 OI_LOOSE,
1438 OI_PACKED,
1439 OI_DBCACHED
1440 } whence;
1441 union {
1443 * struct {
1444 * ... Nothing to expose in this case
1445 * } cached;
1446 * struct {
1447 * ... Nothing to expose in this case
1448 * } loose;
1450 struct {
1451 struct packed_git *pack;
1452 off_t offset;
1453 unsigned int is_delta;
1454 } packed;
1455 } u;
1457 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1459 /* Dumb servers support */
1460 extern int update_server_info(int);
1462 /* git_config_parse_key() returns these negated: */
1463 #define CONFIG_INVALID_KEY 1
1464 #define CONFIG_NO_SECTION_OR_NAME 2
1465 /* git_config_set(), git_config_set_multivar() return the above or these: */
1466 #define CONFIG_NO_LOCK -1
1467 #define CONFIG_INVALID_FILE 3
1468 #define CONFIG_NO_WRITE 4
1469 #define CONFIG_NOTHING_SET 5
1470 #define CONFIG_INVALID_PATTERN 6
1471 #define CONFIG_GENERIC_ERROR 7
1473 #define CONFIG_REGEX_NONE ((void *)1)
1475 struct git_config_source {
1476 unsigned int use_stdin:1;
1477 const char *file;
1478 const char *blob;
1481 typedef int (*config_fn_t)(const char *, const char *, void *);
1482 extern int git_default_config(const char *, const char *, void *);
1483 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1484 extern int git_config_from_buf(config_fn_t fn, const char *name,
1485 const char *buf, size_t len, void *data);
1486 extern void git_config_push_parameter(const char *text);
1487 extern int git_config_from_parameters(config_fn_t fn, void *data);
1488 extern void git_config(config_fn_t fn, void *);
1489 extern int git_config_with_options(config_fn_t fn, void *,
1490 struct git_config_source *config_source,
1491 int respect_includes);
1492 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1493 extern int git_parse_ulong(const char *, unsigned long *);
1494 extern int git_parse_maybe_bool(const char *);
1495 extern int git_config_int(const char *, const char *);
1496 extern int64_t git_config_int64(const char *, const char *);
1497 extern unsigned long git_config_ulong(const char *, const char *);
1498 extern int git_config_bool_or_int(const char *, const char *, int *);
1499 extern int git_config_bool(const char *, const char *);
1500 extern int git_config_maybe_bool(const char *, const char *);
1501 extern int git_config_string(const char **, const char *, const char *);
1502 extern int git_config_pathname(const char **, const char *, const char *);
1503 extern int git_config_set_in_file(const char *, const char *, const char *);
1504 extern int git_config_set(const char *, const char *);
1505 extern int git_config_parse_key(const char *, char **, int *);
1506 extern int git_config_key_is_valid(const char *key);
1507 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1508 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1509 extern int git_config_rename_section(const char *, const char *);
1510 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1511 extern const char *git_etc_gitconfig(void);
1512 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1513 extern int git_env_bool(const char *, int);
1514 extern unsigned long git_env_ulong(const char *, unsigned long);
1515 extern int git_config_system(void);
1516 extern int config_error_nonbool(const char *);
1517 #if defined(__GNUC__)
1518 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1519 #endif
1520 extern const char *get_log_output_encoding(void);
1521 extern const char *get_commit_output_encoding(void);
1523 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1525 struct config_include_data {
1526 int depth;
1527 config_fn_t fn;
1528 void *data;
1530 #define CONFIG_INCLUDE_INIT { 0 }
1531 extern int git_config_include(const char *name, const char *value, void *data);
1534 * Match and parse a config key of the form:
1536 * section.(subsection.)?key
1538 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1539 * we return -1 if it does not match, 0 otherwise. The subsection and key
1540 * out-parameters are filled by the function (and subsection is NULL if it is
1541 * missing).
1543 extern int parse_config_key(const char *var,
1544 const char *section,
1545 const char **subsection, int *subsection_len,
1546 const char **key);
1548 struct config_set_element {
1549 struct hashmap_entry ent;
1550 char *key;
1551 struct string_list value_list;
1554 struct configset_list_item {
1555 struct config_set_element *e;
1556 int value_index;
1560 * the contents of the list are ordered according to their
1561 * position in the config files and order of parsing the files.
1562 * (i.e. key-value pair at the last position of .git/config will
1563 * be at the last item of the list)
1565 struct configset_list {
1566 struct configset_list_item *items;
1567 unsigned int nr, alloc;
1570 struct config_set {
1571 struct hashmap config_hash;
1572 int hash_initialized;
1573 struct configset_list list;
1576 extern void git_configset_init(struct config_set *cs);
1577 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1578 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1579 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1580 extern void git_configset_clear(struct config_set *cs);
1581 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1582 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1583 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1584 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1585 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1586 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1587 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1588 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1590 extern int git_config_get_value(const char *key, const char **value);
1591 extern const struct string_list *git_config_get_value_multi(const char *key);
1592 extern void git_config_clear(void);
1593 extern void git_config_iter(config_fn_t fn, void *data);
1594 extern int git_config_get_string_const(const char *key, const char **dest);
1595 extern int git_config_get_string(const char *key, char **dest);
1596 extern int git_config_get_int(const char *key, int *dest);
1597 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1598 extern int git_config_get_bool(const char *key, int *dest);
1599 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1600 extern int git_config_get_maybe_bool(const char *key, int *dest);
1601 extern int git_config_get_pathname(const char *key, const char **dest);
1603 struct key_value_info {
1604 const char *filename;
1605 int linenr;
1608 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1609 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1611 extern int committer_ident_sufficiently_given(void);
1612 extern int author_ident_sufficiently_given(void);
1614 extern const char *git_commit_encoding;
1615 extern const char *git_log_output_encoding;
1616 extern const char *git_mailmap_file;
1617 extern const char *git_mailmap_blob;
1619 /* IO helper functions */
1620 extern void maybe_flush_or_die(FILE *, const char *);
1621 __attribute__((format (printf, 2, 3)))
1622 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1624 #define COPY_READ_ERROR (-2)
1625 #define COPY_WRITE_ERROR (-3)
1626 extern int copy_fd(int ifd, int ofd);
1627 extern int copy_file(const char *dst, const char *src, int mode);
1628 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1630 extern void write_or_die(int fd, const void *buf, size_t count);
1631 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1632 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1633 extern void fsync_or_die(int fd, const char *);
1635 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1636 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1637 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1639 static inline ssize_t write_str_in_full(int fd, const char *str)
1641 return write_in_full(fd, str, strlen(str));
1644 extern int write_file(const char *path, const char *fmt, ...);
1645 extern int write_file_gently(const char *path, const char *fmt, ...);
1647 /* pager.c */
1648 extern void setup_pager(void);
1649 extern const char *pager_program;
1650 extern int pager_in_use(void);
1651 extern int pager_use_color;
1652 extern int term_columns(void);
1653 extern int decimal_width(uintmax_t);
1654 extern int check_pager_config(const char *cmd);
1656 extern const char *editor_program;
1657 extern const char *askpass_program;
1658 extern const char *excludes_file;
1660 /* base85 */
1661 int decode_85(char *dst, const char *line, int linelen);
1662 void encode_85(char *buf, const unsigned char *data, int bytes);
1664 /* alloc.c */
1665 extern void *alloc_blob_node(void);
1666 extern void *alloc_tree_node(void);
1667 extern void *alloc_commit_node(void);
1668 extern void *alloc_tag_node(void);
1669 extern void *alloc_object_node(void);
1670 extern void alloc_report(void);
1671 extern unsigned int alloc_commit_index(void);
1673 /* pkt-line.c */
1674 void packet_trace_identity(const char *prog);
1676 /* add */
1678 * return 0 if success, 1 - if addition of a file failed and
1679 * ADD_FILES_IGNORE_ERRORS was specified in flags
1681 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1683 /* diff.c */
1684 extern int diff_auto_refresh_index;
1686 /* match-trees.c */
1687 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1688 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1691 * whitespace rules.
1692 * used by both diff and apply
1693 * last two digits are tab width
1695 #define WS_BLANK_AT_EOL 0100
1696 #define WS_SPACE_BEFORE_TAB 0200
1697 #define WS_INDENT_WITH_NON_TAB 0400
1698 #define WS_CR_AT_EOL 01000
1699 #define WS_BLANK_AT_EOF 02000
1700 #define WS_TAB_IN_INDENT 04000
1701 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1702 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1703 #define WS_TAB_WIDTH_MASK 077
1704 extern unsigned whitespace_rule_cfg;
1705 extern unsigned whitespace_rule(const char *);
1706 extern unsigned parse_whitespace_rule(const char *);
1707 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1708 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1709 extern char *whitespace_error_string(unsigned ws);
1710 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1711 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1712 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1714 /* ls-files */
1715 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1717 char *alias_lookup(const char *alias);
1718 int split_cmdline(char *cmdline, const char ***argv);
1719 /* Takes a negative value returned by split_cmdline */
1720 const char *split_cmdline_strerror(int cmdline_errno);
1722 /* git.c */
1723 struct startup_info {
1724 int have_repository;
1725 const char *prefix;
1727 extern struct startup_info *startup_info;
1729 /* merge.c */
1730 struct commit_list;
1731 int try_merge_command(const char *strategy, size_t xopts_nr,
1732 const char **xopts, struct commit_list *common,
1733 const char *head_arg, struct commit_list *remotes);
1734 int checkout_fast_forward(const unsigned char *from,
1735 const unsigned char *to,
1736 int overwrite_ignore);
1739 int sane_execvp(const char *file, char *const argv[]);
1742 * A struct to encapsulate the concept of whether a file has changed
1743 * since we last checked it. This uses criteria similar to those used
1744 * for the index.
1746 struct stat_validity {
1747 struct stat_data *sd;
1750 void stat_validity_clear(struct stat_validity *sv);
1753 * Returns 1 if the path is a regular file (or a symlink to a regular
1754 * file) and matches the saved stat_validity, 0 otherwise. A missing
1755 * or inaccessible file is considered a match if the struct was just
1756 * initialized, or if the previous update found an inaccessible file.
1758 int stat_validity_check(struct stat_validity *sv, const char *path);
1761 * Update the stat_validity from a file opened at descriptor fd. If
1762 * the file is missing, inaccessible, or not a regular file, then
1763 * future calls to stat_validity_check will match iff one of those
1764 * conditions continues to be true.
1766 void stat_validity_update(struct stat_validity *sv, int fd);
1768 int versioncmp(const char *s1, const char *s2);
1769 void sleep_millisec(int millisec);
1771 #endif /* CACHE_H */