Documentation/describe: improve one-line summary
[git.git] / cache.h
blob22b7b8129072f3905c68f02fe19f463bdb738b9e
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 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
47 #define DTYPE(de) ((de)->d_type)
48 #else
49 #undef DT_UNKNOWN
50 #undef DT_DIR
51 #undef DT_REG
52 #undef DT_LNK
53 #define DT_UNKNOWN 0
54 #define DT_DIR 1
55 #define DT_REG 2
56 #define DT_LNK 3
57 #define DTYPE(de) DT_UNKNOWN
58 #endif
60 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
61 #define S_IFINVALID 0030000
64 * A "directory link" is a link to another git directory.
66 * The value 0160000 is not normally a valid mode, and
67 * also just happens to be S_IFDIR + S_IFLNK
69 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
70 * always having the same values everywhere. We should use
71 * our internal git values for these things, and then we can
72 * translate that to the OS-specific value. It just so
73 * happens that everybody shares the same bit representation
74 * in the UNIX world (and apparently wider too..)
76 #define S_IFGITLINK 0160000
77 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
80 * Some mode bits are also used internally for computations.
82 * They *must* not overlap with any valid modes, and they *must* not be emitted
83 * to outside world - i.e. appear on disk or network. In other words, it's just
84 * temporary fields, which we internally use, but they have to stay in-house.
86 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
87 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
90 /* used internally in tree-diff */
91 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
95 * Intensive research over the course of many years has shown that
96 * port 9418 is totally unused by anything else. Or
98 * Your search - "port 9418" - did not match any documents.
100 * as www.google.com puts it.
102 * This port has been properly assigned for git use by IANA:
103 * git (Assigned-9418) [I06-050728-0001].
105 * git 9418/tcp git pack transfer service
106 * git 9418/udp git pack transfer service
108 * with Linus Torvalds <torvalds@osdl.org> as the point of
109 * contact. September 2005.
111 * See http://www.iana.org/assignments/port-numbers
113 #define DEFAULT_GIT_PORT 9418
116 * Basic data structures for the directory cache
119 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
120 struct cache_header {
121 uint32_t hdr_signature;
122 uint32_t hdr_version;
123 uint32_t hdr_entries;
126 #define INDEX_FORMAT_LB 2
127 #define INDEX_FORMAT_UB 4
130 * The "cache_time" is just the low 32 bits of the
131 * time. It doesn't matter if it overflows - we only
132 * check it for equality in the 32 bits we save.
134 struct cache_time {
135 uint32_t sec;
136 uint32_t nsec;
139 struct stat_data {
140 struct cache_time sd_ctime;
141 struct cache_time sd_mtime;
142 unsigned int sd_dev;
143 unsigned int sd_ino;
144 unsigned int sd_uid;
145 unsigned int sd_gid;
146 unsigned int sd_size;
149 struct cache_entry {
150 struct hashmap_entry ent;
151 struct stat_data ce_stat_data;
152 unsigned int ce_mode;
153 unsigned int ce_flags;
154 unsigned int ce_namelen;
155 unsigned int index; /* for link extension */
156 unsigned char sha1[20];
157 char name[FLEX_ARRAY]; /* more */
160 #define CE_STAGEMASK (0x3000)
161 #define CE_EXTENDED (0x4000)
162 #define CE_VALID (0x8000)
163 #define CE_STAGESHIFT 12
166 * Range 0xFFFF0FFF in ce_flags is divided into
167 * two parts: in-memory flags and on-disk ones.
168 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
169 * if you want to save a new flag, add it in
170 * CE_EXTENDED_FLAGS
172 * In-memory only flags
174 #define CE_UPDATE (1 << 16)
175 #define CE_REMOVE (1 << 17)
176 #define CE_UPTODATE (1 << 18)
177 #define CE_ADDED (1 << 19)
179 #define CE_HASHED (1 << 20)
180 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
181 #define CE_CONFLICTED (1 << 23)
183 #define CE_UNPACKED (1 << 24)
184 #define CE_NEW_SKIP_WORKTREE (1 << 25)
186 /* used to temporarily mark paths matched by pathspecs */
187 #define CE_MATCHED (1 << 26)
189 #define CE_UPDATE_IN_BASE (1 << 27)
190 #define CE_STRIP_NAME (1 << 28)
193 * Extended on-disk flags
195 #define CE_INTENT_TO_ADD (1 << 29)
196 #define CE_SKIP_WORKTREE (1 << 30)
197 /* CE_EXTENDED2 is for future extension */
198 #define CE_EXTENDED2 (1 << 31)
200 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
203 * Safeguard to avoid saving wrong flags:
204 * - CE_EXTENDED2 won't get saved until its semantic is known
205 * - Bits in 0x0000FFFF have been saved in ce_flags already
206 * - Bits in 0x003F0000 are currently in-memory flags
208 #if CE_EXTENDED_FLAGS & 0x803FFFFF
209 #error "CE_EXTENDED_FLAGS out of range"
210 #endif
212 struct pathspec;
215 * Copy the sha1 and stat state of a cache entry from one to
216 * another. But we never change the name, or the hash state!
218 static inline void copy_cache_entry(struct cache_entry *dst,
219 const struct cache_entry *src)
221 unsigned int state = dst->ce_flags & CE_HASHED;
223 /* Don't copy hash chain and name */
224 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
225 offsetof(struct cache_entry, name) -
226 offsetof(struct cache_entry, ce_stat_data));
228 /* Restore the hash state */
229 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
232 static inline unsigned create_ce_flags(unsigned stage)
234 return (stage << CE_STAGESHIFT);
237 #define ce_namelen(ce) ((ce)->ce_namelen)
238 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
239 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
240 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
241 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
242 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
244 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
245 static inline unsigned int create_ce_mode(unsigned int mode)
247 if (S_ISLNK(mode))
248 return S_IFLNK;
249 if (S_ISDIR(mode) || S_ISGITLINK(mode))
250 return S_IFGITLINK;
251 return S_IFREG | ce_permissions(mode);
253 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
254 unsigned int mode)
256 extern int trust_executable_bit, has_symlinks;
257 if (!has_symlinks && S_ISREG(mode) &&
258 ce && S_ISLNK(ce->ce_mode))
259 return ce->ce_mode;
260 if (!trust_executable_bit && S_ISREG(mode)) {
261 if (ce && S_ISREG(ce->ce_mode))
262 return ce->ce_mode;
263 return create_ce_mode(0666);
265 return create_ce_mode(mode);
267 static inline int ce_to_dtype(const struct cache_entry *ce)
269 unsigned ce_mode = ntohl(ce->ce_mode);
270 if (S_ISREG(ce_mode))
271 return DT_REG;
272 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
273 return DT_DIR;
274 else if (S_ISLNK(ce_mode))
275 return DT_LNK;
276 else
277 return DT_UNKNOWN;
279 static inline unsigned int canon_mode(unsigned int mode)
281 if (S_ISREG(mode))
282 return S_IFREG | ce_permissions(mode);
283 if (S_ISLNK(mode))
284 return S_IFLNK;
285 if (S_ISDIR(mode))
286 return S_IFDIR;
287 return S_IFGITLINK;
290 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
292 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
293 #define CE_ENTRY_CHANGED (1 << 1)
294 #define CE_ENTRY_REMOVED (1 << 2)
295 #define CE_ENTRY_ADDED (1 << 3)
296 #define RESOLVE_UNDO_CHANGED (1 << 4)
297 #define CACHE_TREE_CHANGED (1 << 5)
298 #define SPLIT_INDEX_ORDERED (1 << 6)
300 struct split_index;
301 struct index_state {
302 struct cache_entry **cache;
303 unsigned int version;
304 unsigned int cache_nr, cache_alloc, cache_changed;
305 struct string_list *resolve_undo;
306 struct cache_tree *cache_tree;
307 struct split_index *split_index;
308 struct cache_time timestamp;
309 unsigned name_hash_initialized : 1,
310 initialized : 1;
311 struct hashmap name_hash;
312 struct hashmap dir_hash;
313 unsigned char sha1[20];
316 extern struct index_state the_index;
318 /* Name hashing */
319 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
320 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
321 extern void free_name_hash(struct index_state *istate);
324 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
325 #define active_cache (the_index.cache)
326 #define active_nr (the_index.cache_nr)
327 #define active_alloc (the_index.cache_alloc)
328 #define active_cache_changed (the_index.cache_changed)
329 #define active_cache_tree (the_index.cache_tree)
331 #define read_cache() read_index(&the_index)
332 #define read_cache_from(path) read_index_from(&the_index, (path))
333 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
334 #define is_cache_unborn() is_index_unborn(&the_index)
335 #define read_cache_unmerged() read_index_unmerged(&the_index)
336 #define discard_cache() discard_index(&the_index)
337 #define unmerged_cache() unmerged_index(&the_index)
338 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
339 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
340 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
341 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
342 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
343 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
344 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
345 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
346 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
347 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
348 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
349 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
350 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
351 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
352 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
353 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
354 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
355 #endif
357 enum object_type {
358 OBJ_BAD = -1,
359 OBJ_NONE = 0,
360 OBJ_COMMIT = 1,
361 OBJ_TREE = 2,
362 OBJ_BLOB = 3,
363 OBJ_TAG = 4,
364 /* 5 for future expansion */
365 OBJ_OFS_DELTA = 6,
366 OBJ_REF_DELTA = 7,
367 OBJ_ANY,
368 OBJ_MAX
371 static inline enum object_type object_type(unsigned int mode)
373 return S_ISDIR(mode) ? OBJ_TREE :
374 S_ISGITLINK(mode) ? OBJ_COMMIT :
375 OBJ_BLOB;
378 /* Double-check local_repo_env below if you add to this list. */
379 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
380 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
381 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
382 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
383 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
384 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
385 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
386 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
387 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
388 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
389 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
390 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
391 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
392 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
393 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
394 #define GITATTRIBUTES_FILE ".gitattributes"
395 #define INFOATTRIBUTES_FILE "info/attributes"
396 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
397 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
398 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
399 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
400 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
401 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
402 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
403 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
404 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
405 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
408 * This environment variable is expected to contain a boolean indicating
409 * whether we should or should not treat:
411 * GIT_DIR=foo.git git ...
413 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
414 * of this, but we use it internally to communicate to sub-processes that we
415 * are in a bare repo. If not set, defaults to true.
417 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
420 * Repository-local GIT_* environment variables; these will be cleared
421 * when git spawns a sub-process that runs inside another repository.
422 * The array is NULL-terminated, which makes it easy to pass in the "env"
423 * parameter of a run-command invocation, or to do a simple walk.
425 extern const char * const local_repo_env[];
427 extern int is_bare_repository_cfg;
428 extern int is_bare_repository(void);
429 extern int is_inside_git_dir(void);
430 extern char *git_work_tree_cfg;
431 extern int is_inside_work_tree(void);
432 extern const char *get_git_dir(void);
433 extern int is_git_directory(const char *path);
434 extern char *get_object_directory(void);
435 extern char *get_index_file(void);
436 extern char *get_graft_file(void);
437 extern int set_git_dir(const char *path);
438 extern const char *get_git_namespace(void);
439 extern const char *strip_namespace(const char *namespaced_ref);
440 extern const char *get_git_work_tree(void);
441 extern const char *read_gitfile(const char *path);
442 extern const char *resolve_gitdir(const char *suspect);
443 extern void set_git_work_tree(const char *tree);
445 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
447 extern const char **get_pathspec(const char *prefix, const char **pathspec);
448 extern void setup_work_tree(void);
449 extern const char *setup_git_directory_gently(int *);
450 extern const char *setup_git_directory(void);
451 extern char *prefix_path(const char *prefix, int len, const char *path);
452 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
453 extern const char *prefix_filename(const char *prefix, int len, const char *path);
454 extern int check_filename(const char *prefix, const char *name);
455 extern void verify_filename(const char *prefix,
456 const char *name,
457 int diagnose_misspelt_rev);
458 extern void verify_non_filename(const char *prefix, const char *name);
459 extern int path_inside_repo(const char *prefix, const char *path);
461 #define INIT_DB_QUIET 0x0001
463 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
464 extern int init_db(const char *template_dir, unsigned int flags);
466 extern void sanitize_stdfds(void);
467 extern int daemonize(void);
469 #define alloc_nr(x) (((x)+16)*3/2)
472 * Realloc the buffer pointed at by variable 'x' so that it can hold
473 * at least 'nr' entries; the number of entries currently allocated
474 * is 'alloc', using the standard growing factor alloc_nr() macro.
476 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
478 #define ALLOC_GROW(x, nr, alloc) \
479 do { \
480 if ((nr) > alloc) { \
481 if (alloc_nr(alloc) < (nr)) \
482 alloc = (nr); \
483 else \
484 alloc = alloc_nr(alloc); \
485 REALLOC_ARRAY(x, alloc); \
487 } while (0)
489 /* Initialize and use the cache information */
490 struct lock_file;
491 extern int read_index(struct index_state *);
492 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
493 extern int do_read_index(struct index_state *istate, const char *path,
494 int must_exist); /* for testting only! */
495 extern int read_index_from(struct index_state *, const char *path);
496 extern int is_index_unborn(struct index_state *);
497 extern int read_index_unmerged(struct index_state *);
498 #define COMMIT_LOCK (1 << 0)
499 #define CLOSE_LOCK (1 << 1)
500 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
501 extern int discard_index(struct index_state *);
502 extern int unmerged_index(const struct index_state *);
503 extern int verify_path(const char *path);
504 extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
505 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
506 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
507 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
508 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
509 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
510 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
511 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
512 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
513 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
514 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
515 extern int remove_index_entry_at(struct index_state *, int pos);
516 extern void remove_marked_cache_entries(struct index_state *istate);
517 extern int remove_file_from_index(struct index_state *, const char *path);
518 #define ADD_CACHE_VERBOSE 1
519 #define ADD_CACHE_PRETEND 2
520 #define ADD_CACHE_IGNORE_ERRORS 4
521 #define ADD_CACHE_IGNORE_REMOVAL 8
522 #define ADD_CACHE_INTENT 16
523 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
524 extern int add_file_to_index(struct index_state *, const char *path, int flags);
525 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
526 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
527 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
528 extern int index_name_is_other(const struct index_state *, const char *, int);
529 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
531 /* do stat comparison even if CE_VALID is true */
532 #define CE_MATCH_IGNORE_VALID 01
533 /* do not check the contents but report dirty on racily-clean entries */
534 #define CE_MATCH_RACY_IS_DIRTY 02
535 /* do stat comparison even if CE_SKIP_WORKTREE is true */
536 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
537 /* ignore non-existent files during stat update */
538 #define CE_MATCH_IGNORE_MISSING 0x08
539 /* enable stat refresh */
540 #define CE_MATCH_REFRESH 0x10
541 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
542 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
544 #define HASH_WRITE_OBJECT 1
545 #define HASH_FORMAT_CHECK 2
546 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
547 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
550 * Record to sd the data from st that we use to check whether a file
551 * might have changed.
553 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
556 * Return 0 if st is consistent with a file not having been changed
557 * since sd was filled. If there are differences, return a
558 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
559 * INODE_CHANGED, and DATA_CHANGED.
561 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
563 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
565 #define REFRESH_REALLY 0x0001 /* ignore_valid */
566 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
567 #define REFRESH_QUIET 0x0004 /* be quiet about it */
568 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
569 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
570 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
571 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
573 extern void update_index_if_able(struct index_state *, struct lock_file *);
575 extern int hold_locked_index(struct lock_file *, int);
576 extern void set_alternate_index_output(const char *);
578 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
580 /* Environment bits from configuration mechanism */
581 extern int trust_executable_bit;
582 extern int trust_ctime;
583 extern int check_stat;
584 extern int quote_path_fully;
585 extern int has_symlinks;
586 extern int minimum_abbrev, default_abbrev;
587 extern int ignore_case;
588 extern int assume_unchanged;
589 extern int prefer_symlink_refs;
590 extern int log_all_ref_updates;
591 extern int warn_ambiguous_refs;
592 extern int warn_on_object_refname_ambiguity;
593 extern int shared_repository;
594 extern const char *apply_default_whitespace;
595 extern const char *apply_default_ignorewhitespace;
596 extern const char *git_attributes_file;
597 extern int zlib_compression_level;
598 extern int core_compression_level;
599 extern int core_compression_seen;
600 extern size_t packed_git_window_size;
601 extern size_t packed_git_limit;
602 extern size_t delta_base_cache_limit;
603 extern unsigned long big_file_threshold;
604 extern unsigned long pack_size_limit_cfg;
607 * Do replace refs need to be checked this run? This variable is
608 * initialized to true unless --no-replace-object is used or
609 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
610 * commands that do not want replace references to be active. As an
611 * optimization it is also set to false if replace references have
612 * been sought but there were none.
614 extern int check_replace_refs;
616 extern int fsync_object_files;
617 extern int core_preload_index;
618 extern int core_apply_sparse_checkout;
619 extern int precomposed_unicode;
620 extern int protect_hfs;
621 extern int protect_ntfs;
624 * The character that begins a commented line in user-editable file
625 * that is subject to stripspace.
627 extern char comment_line_char;
628 extern int auto_comment_line_char;
630 enum branch_track {
631 BRANCH_TRACK_UNSPECIFIED = -1,
632 BRANCH_TRACK_NEVER = 0,
633 BRANCH_TRACK_REMOTE,
634 BRANCH_TRACK_ALWAYS,
635 BRANCH_TRACK_EXPLICIT,
636 BRANCH_TRACK_OVERRIDE
639 enum rebase_setup_type {
640 AUTOREBASE_NEVER = 0,
641 AUTOREBASE_LOCAL,
642 AUTOREBASE_REMOTE,
643 AUTOREBASE_ALWAYS
646 enum push_default_type {
647 PUSH_DEFAULT_NOTHING = 0,
648 PUSH_DEFAULT_MATCHING,
649 PUSH_DEFAULT_SIMPLE,
650 PUSH_DEFAULT_UPSTREAM,
651 PUSH_DEFAULT_CURRENT,
652 PUSH_DEFAULT_UNSPECIFIED
655 extern enum branch_track git_branch_track;
656 extern enum rebase_setup_type autorebase;
657 extern enum push_default_type push_default;
659 enum object_creation_mode {
660 OBJECT_CREATION_USES_HARDLINKS = 0,
661 OBJECT_CREATION_USES_RENAMES = 1
664 extern enum object_creation_mode object_creation_mode;
666 extern char *notes_ref_name;
668 extern int grafts_replace_parents;
670 #define GIT_REPO_VERSION 0
671 extern int repository_format_version;
672 extern int check_repository_format(void);
674 #define MTIME_CHANGED 0x0001
675 #define CTIME_CHANGED 0x0002
676 #define OWNER_CHANGED 0x0004
677 #define MODE_CHANGED 0x0008
678 #define INODE_CHANGED 0x0010
679 #define DATA_CHANGED 0x0020
680 #define TYPE_CHANGED 0x0040
682 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
683 __attribute__((format (printf, 3, 4)));
684 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
685 __attribute__((format (printf, 3, 4)));
686 extern char *git_pathdup(const char *fmt, ...)
687 __attribute__((format (printf, 1, 2)));
688 extern char *mkpathdup(const char *fmt, ...)
689 __attribute__((format (printf, 1, 2)));
691 /* Return a statically allocated filename matching the sha1 signature */
692 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
693 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
694 extern char *git_path_submodule(const char *path, const char *fmt, ...)
695 __attribute__((format (printf, 2, 3)));
698 * Return the name of the file in the local object database that would
699 * be used to store a loose object with the specified sha1. The
700 * return value is a pointer to a statically allocated buffer that is
701 * overwritten each time the function is called.
703 extern const char *sha1_file_name(const unsigned char *sha1);
706 * Return the name of the (local) packfile with the specified sha1 in
707 * its name. The return value is a pointer to memory that is
708 * overwritten each time this function is called.
710 extern char *sha1_pack_name(const unsigned char *sha1);
713 * Return the name of the (local) pack index file with the specified
714 * sha1 in its name. The return value is a pointer to memory that is
715 * overwritten each time this function is called.
717 extern char *sha1_pack_index_name(const unsigned char *sha1);
719 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
720 extern const unsigned char null_sha1[20];
722 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
724 int i;
726 for (i = 0; i < 20; i++, sha1++, sha2++) {
727 if (*sha1 != *sha2)
728 return *sha1 - *sha2;
731 return 0;
734 static inline int is_null_sha1(const unsigned char *sha1)
736 return !hashcmp(sha1, null_sha1);
739 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
741 memcpy(sha_dst, sha_src, 20);
743 static inline void hashclr(unsigned char *hash)
745 memset(hash, 0, 20);
748 #define EMPTY_TREE_SHA1_HEX \
749 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
750 #define EMPTY_TREE_SHA1_BIN_LITERAL \
751 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
752 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
753 #define EMPTY_TREE_SHA1_BIN \
754 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
756 #define EMPTY_BLOB_SHA1_HEX \
757 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
758 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
759 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
760 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
761 #define EMPTY_BLOB_SHA1_BIN \
762 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
764 static inline int is_empty_blob_sha1(const unsigned char *sha1)
766 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
769 int git_mkstemp(char *path, size_t n, const char *template);
771 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
773 /* set default permissions by passing mode arguments to open(2) */
774 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
775 int git_mkstemp_mode(char *pattern, int mode);
778 * NOTE NOTE NOTE!!
780 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
781 * not be changed. Old repositories have core.sharedrepository written in
782 * numeric format, and therefore these values are preserved for compatibility
783 * reasons.
785 enum sharedrepo {
786 PERM_UMASK = 0,
787 OLD_PERM_GROUP = 1,
788 OLD_PERM_EVERYBODY = 2,
789 PERM_GROUP = 0660,
790 PERM_EVERYBODY = 0664
792 int git_config_perm(const char *var, const char *value);
793 int adjust_shared_perm(const char *path);
796 * Create the directory containing the named path, using care to be
797 * somewhat safe against races. Return one of the scld_error values
798 * to indicate success/failure.
800 * SCLD_VANISHED indicates that one of the ancestor directories of the
801 * path existed at one point during the function call and then
802 * suddenly vanished, probably because another process pruned the
803 * directory while we were working. To be robust against this kind of
804 * race, callers might want to try invoking the function again when it
805 * returns SCLD_VANISHED.
807 enum scld_error {
808 SCLD_OK = 0,
809 SCLD_FAILED = -1,
810 SCLD_PERMS = -2,
811 SCLD_EXISTS = -3,
812 SCLD_VANISHED = -4
814 enum scld_error safe_create_leading_directories(char *path);
815 enum scld_error safe_create_leading_directories_const(const char *path);
817 int mkdir_in_gitdir(const char *path);
818 extern void home_config_paths(char **global, char **xdg, char *file);
819 extern char *expand_user_path(const char *path);
820 const char *enter_repo(const char *path, int strict);
821 static inline int is_absolute_path(const char *path)
823 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
825 int is_directory(const char *);
826 const char *real_path(const char *path);
827 const char *real_path_if_valid(const char *path);
828 const char *absolute_path(const char *path);
829 const char *remove_leading_path(const char *in, const char *prefix);
830 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
831 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
832 int normalize_path_copy(char *dst, const char *src);
833 int longest_ancestor_length(const char *path, struct string_list *prefixes);
834 char *strip_path_suffix(const char *path, const char *suffix);
835 int daemon_avoid_alias(const char *path);
836 extern int is_ntfs_dotgit(const char *name);
838 /* object replacement */
839 #define LOOKUP_REPLACE_OBJECT 1
840 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
841 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
843 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
847 * This internal function is only declared here for the benefit of
848 * lookup_replace_object(). Please do not call it directly.
850 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
853 * If object sha1 should be replaced, return the replacement object's
854 * name (replaced recursively, if necessary). The return value is
855 * either sha1 or a pointer to a permanently-allocated value. When
856 * object replacement is suppressed, always return sha1.
858 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
860 if (!check_replace_refs)
861 return sha1;
862 return do_lookup_replace_object(sha1);
865 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
867 if (!(flag & LOOKUP_REPLACE_OBJECT))
868 return sha1;
869 return lookup_replace_object(sha1);
872 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
873 extern int sha1_object_info(const unsigned char *, unsigned long *);
874 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
875 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
876 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
877 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
878 extern int git_open_noatime(const char *name);
879 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
880 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
881 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
883 /* global flag to enable extra checks when accessing packed objects */
884 extern int do_check_packed_object_crc;
886 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
888 extern int move_temp_to_file(const char *tmpfile, const char *filename);
890 extern int has_sha1_pack(const unsigned char *sha1);
893 * Return true iff we have an object named sha1, whether local or in
894 * an alternate object database, and whether packed or loose. This
895 * function does not respect replace references.
897 extern int has_sha1_file(const unsigned char *sha1);
900 * Return true iff an alternate object database has a loose object
901 * with the specified name. This function does not respect replace
902 * references.
904 extern int has_loose_object_nonlocal(const unsigned char *sha1);
906 extern int has_pack_index(const unsigned char *sha1);
908 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
910 extern const signed char hexval_table[256];
911 static inline unsigned int hexval(unsigned char c)
913 return hexval_table[c];
916 /* Convert to/from hex/sha1 representation */
917 #define MINIMUM_ABBREV minimum_abbrev
918 #define DEFAULT_ABBREV default_abbrev
920 struct object_context {
921 unsigned char tree[20];
922 char path[PATH_MAX];
923 unsigned mode;
926 #define GET_SHA1_QUIETLY 01
927 #define GET_SHA1_COMMIT 02
928 #define GET_SHA1_COMMITTISH 04
929 #define GET_SHA1_TREE 010
930 #define GET_SHA1_TREEISH 020
931 #define GET_SHA1_BLOB 040
932 #define GET_SHA1_ONLY_TO_DIE 04000
934 extern int get_sha1(const char *str, unsigned char *sha1);
935 extern int get_sha1_commit(const char *str, unsigned char *sha1);
936 extern int get_sha1_committish(const char *str, unsigned char *sha1);
937 extern int get_sha1_tree(const char *str, unsigned char *sha1);
938 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
939 extern int get_sha1_blob(const char *str, unsigned char *sha1);
940 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
941 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
943 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
944 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
947 * Try to read a SHA1 in hexadecimal format from the 40 characters
948 * starting at hex. Write the 20-byte result to sha1 in binary form.
949 * Return 0 on success. Reading stops if a NUL is encountered in the
950 * input, so it is safe to pass this function an arbitrary
951 * null-terminated string.
953 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
955 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
956 extern int read_ref_full(const char *refname, int resolve_flags,
957 unsigned char *sha1, int *flags);
958 extern int read_ref(const char *refname, unsigned char *sha1);
961 * Resolve a reference, recursively following symbolic refererences.
963 * Store the referred-to object's name in sha1 and return the name of
964 * the non-symbolic reference that ultimately pointed at it. The
965 * return value, if not NULL, is a pointer into either a static buffer
966 * or the input ref.
968 * If the reference cannot be resolved to an object, the behavior
969 * depends on the RESOLVE_REF_READING flag:
971 * - If RESOLVE_REF_READING is set, return NULL.
973 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
974 * the last reference name in the chain, which will either be a non-symbolic
975 * reference or an undefined reference. If this is a prelude to
976 * "writing" to the ref, the return value is the name of the ref
977 * that will actually be created or changed.
979 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
980 * level of symbolic reference. The value stored in sha1 for a symbolic
981 * reference will always be null_sha1 in this case, and the return
982 * value is the reference that the symref refers to directly.
984 * If flags is non-NULL, set the value that it points to the
985 * combination of REF_ISPACKED (if the reference was found among the
986 * packed references), REF_ISSYMREF (if the initial reference was a
987 * symbolic reference), REF_BAD_NAME (if the reference name is ill
988 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
989 * (if the ref is malformed or has a bad name). See refs.h for more detail
990 * on each flag.
992 * If ref is not a properly-formatted, normalized reference, return
993 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
994 * give up and return NULL.
996 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
997 * name is invalid according to git-check-ref-format(1). If the name
998 * is bad then the value stored in sha1 will be null_sha1 and the two
999 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
1001 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
1002 * directory and do not consist of all caps and underscores cannot be
1003 * resolved. The function returns NULL for such ref names.
1004 * Caps and underscores refers to the special refs, such as HEAD,
1005 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
1007 #define RESOLVE_REF_READING 0x01
1008 #define RESOLVE_REF_NO_RECURSE 0x02
1009 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
1010 extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1011 extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1013 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
1014 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
1015 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1016 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1019 * Return true iff abbrev_name is a possible abbreviation for
1020 * full_name according to the rules defined by ref_rev_parse_rules in
1021 * refs.c.
1023 extern int refname_match(const char *abbrev_name, const char *full_name);
1025 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
1026 extern int validate_headref(const char *ref);
1028 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1029 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1030 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1031 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1033 extern void *read_object_with_reference(const unsigned char *sha1,
1034 const char *required_type,
1035 unsigned long *size,
1036 unsigned char *sha1_ret);
1038 extern struct object *peel_to_type(const char *name, int namelen,
1039 struct object *o, enum object_type);
1041 enum date_mode {
1042 DATE_NORMAL = 0,
1043 DATE_RELATIVE,
1044 DATE_SHORT,
1045 DATE_LOCAL,
1046 DATE_ISO8601,
1047 DATE_ISO8601_STRICT,
1048 DATE_RFC2822,
1049 DATE_RAW
1052 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
1053 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1054 struct strbuf *timebuf);
1055 int parse_date(const char *date, struct strbuf *out);
1056 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1057 int parse_expiry_date(const char *date, unsigned long *timestamp);
1058 void datestamp(struct strbuf *out);
1059 #define approxidate(s) approxidate_careful((s), NULL)
1060 unsigned long approxidate_careful(const char *, int *);
1061 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1062 enum date_mode parse_date_format(const char *format);
1063 int date_overflows(unsigned long date);
1065 #define IDENT_STRICT 1
1066 #define IDENT_NO_DATE 2
1067 #define IDENT_NO_NAME 4
1068 extern const char *git_author_info(int);
1069 extern const char *git_committer_info(int);
1070 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1071 extern const char *fmt_name(const char *name, const char *email);
1072 extern const char *ident_default_name(void);
1073 extern const char *ident_default_email(void);
1074 extern const char *git_editor(void);
1075 extern const char *git_pager(int stdout_is_tty);
1076 extern int git_ident_config(const char *, const char *, void *);
1078 struct ident_split {
1079 const char *name_begin;
1080 const char *name_end;
1081 const char *mail_begin;
1082 const char *mail_end;
1083 const char *date_begin;
1084 const char *date_end;
1085 const char *tz_begin;
1086 const char *tz_end;
1089 * Signals an success with 0, but time part of the result may be NULL
1090 * if the input lacks timestamp and zone
1092 extern int split_ident_line(struct ident_split *, const char *, int);
1095 * Like show_date, but pull the timestamp and tz parameters from
1096 * the ident_split. It will also sanity-check the values and produce
1097 * a well-known sentinel date if they appear bogus.
1099 const char *show_ident_date(const struct ident_split *id, enum date_mode mode);
1102 * Compare split idents for equality or strict ordering. Note that we
1103 * compare only the ident part of the line, ignoring any timestamp.
1105 * Because there are two fields, we must choose one as the primary key; we
1106 * currently arbitrarily pick the email.
1108 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1110 struct checkout {
1111 struct index_state *istate;
1112 const char *base_dir;
1113 int base_dir_len;
1114 unsigned force:1,
1115 quiet:1,
1116 not_new:1,
1117 refresh_cache:1;
1120 #define TEMPORARY_FILENAME_LENGTH 25
1121 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1123 struct cache_def {
1124 struct strbuf path;
1125 int flags;
1126 int track_flags;
1127 int prefix_len_stat_func;
1129 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1130 static inline void cache_def_clear(struct cache_def *cache)
1132 strbuf_release(&cache->path);
1135 extern int has_symlink_leading_path(const char *name, int len);
1136 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1137 extern int check_leading_path(const char *name, int len);
1138 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1139 extern void schedule_dir_for_removal(const char *name, int len);
1140 extern void remove_scheduled_dirs(void);
1142 extern struct alternate_object_database {
1143 struct alternate_object_database *next;
1144 char *name;
1145 char base[FLEX_ARRAY]; /* more */
1146 } *alt_odb_list;
1147 extern void prepare_alt_odb(void);
1148 extern void read_info_alternates(const char * relative_base, int depth);
1149 extern void add_to_alternates_file(const char *reference);
1150 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1151 extern int foreach_alt_odb(alt_odb_fn, void*);
1153 struct pack_window {
1154 struct pack_window *next;
1155 unsigned char *base;
1156 off_t offset;
1157 size_t len;
1158 unsigned int last_used;
1159 unsigned int inuse_cnt;
1162 extern struct packed_git {
1163 struct packed_git *next;
1164 struct pack_window *windows;
1165 off_t pack_size;
1166 const void *index_data;
1167 size_t index_size;
1168 uint32_t num_objects;
1169 uint32_t num_bad_objects;
1170 unsigned char *bad_object_sha1;
1171 int index_version;
1172 time_t mtime;
1173 int pack_fd;
1174 unsigned pack_local:1,
1175 pack_keep:1,
1176 do_not_close:1;
1177 unsigned char sha1[20];
1178 /* something like ".git/objects/pack/xxxxx.pack" */
1179 char pack_name[FLEX_ARRAY]; /* more */
1180 } *packed_git;
1182 struct pack_entry {
1183 off_t offset;
1184 unsigned char sha1[20];
1185 struct packed_git *p;
1188 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1190 /* A hook for count-objects to report invalid files in pack directory */
1191 extern void (*report_garbage)(const char *desc, const char *path);
1193 extern void prepare_packed_git(void);
1194 extern void reprepare_packed_git(void);
1195 extern void install_packed_git(struct packed_git *pack);
1197 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1198 struct packed_git *packs);
1200 extern void pack_report(void);
1203 * mmap the index file for the specified packfile (if it is not
1204 * already mmapped). Return 0 on success.
1206 extern int open_pack_index(struct packed_git *);
1209 * munmap the index file for the specified packfile (if it is
1210 * currently mmapped).
1212 extern void close_pack_index(struct packed_git *);
1214 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1215 extern void close_pack_windows(struct packed_git *);
1216 extern void unuse_pack(struct pack_window **);
1217 extern void free_pack_by_name(const char *);
1218 extern void clear_delta_base_cache(void);
1219 extern struct packed_git *add_packed_git(const char *, int, int);
1222 * Return the SHA-1 of the nth object within the specified packfile.
1223 * Open the index if it is not already open. The return value points
1224 * at the SHA-1 within the mmapped index. Return NULL if there is an
1225 * error.
1227 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1230 * Return the offset of the nth object within the specified packfile.
1231 * The index must already be opened.
1233 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1236 * If the object named sha1 is present in the specified packfile,
1237 * return its offset within the packfile; otherwise, return 0.
1239 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1241 extern int is_pack_valid(struct packed_git *);
1242 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1243 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1244 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1245 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1248 * Iterate over the files in the loose-object parts of the object
1249 * directory "path", triggering the following callbacks:
1251 * - loose_object is called for each loose object we find.
1253 * - loose_cruft is called for any files that do not appear to be
1254 * loose objects. Note that we only look in the loose object
1255 * directories "objects/[0-9a-f]{2}/", so we will not report
1256 * "objects/foobar" as cruft.
1258 * - loose_subdir is called for each top-level hashed subdirectory
1259 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1260 * after the objects in the directory are processed.
1262 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1263 * will end the iteration.
1265 typedef int each_loose_object_fn(const unsigned char *sha1,
1266 const char *path,
1267 void *data);
1268 typedef int each_loose_cruft_fn(const char *basename,
1269 const char *path,
1270 void *data);
1271 typedef int each_loose_subdir_fn(int nr,
1272 const char *path,
1273 void *data);
1274 int for_each_loose_file_in_objdir(const char *path,
1275 each_loose_object_fn obj_cb,
1276 each_loose_cruft_fn cruft_cb,
1277 each_loose_subdir_fn subdir_cb,
1278 void *data);
1281 * Iterate over loose and packed objects in both the local
1282 * repository and any alternates repositories.
1284 typedef int each_packed_object_fn(const unsigned char *sha1,
1285 struct packed_git *pack,
1286 uint32_t pos,
1287 void *data);
1288 extern int for_each_loose_object(each_loose_object_fn, void *);
1289 extern int for_each_packed_object(each_packed_object_fn, void *);
1291 struct object_info {
1292 /* Request */
1293 enum object_type *typep;
1294 unsigned long *sizep;
1295 unsigned long *disk_sizep;
1296 unsigned char *delta_base_sha1;
1298 /* Response */
1299 enum {
1300 OI_CACHED,
1301 OI_LOOSE,
1302 OI_PACKED,
1303 OI_DBCACHED
1304 } whence;
1305 union {
1307 * struct {
1308 * ... Nothing to expose in this case
1309 * } cached;
1310 * struct {
1311 * ... Nothing to expose in this case
1312 * } loose;
1314 struct {
1315 struct packed_git *pack;
1316 off_t offset;
1317 unsigned int is_delta;
1318 } packed;
1319 } u;
1321 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1323 /* Dumb servers support */
1324 extern int update_server_info(int);
1326 /* git_config_parse_key() returns these negated: */
1327 #define CONFIG_INVALID_KEY 1
1328 #define CONFIG_NO_SECTION_OR_NAME 2
1329 /* git_config_set(), git_config_set_multivar() return the above or these: */
1330 #define CONFIG_NO_LOCK -1
1331 #define CONFIG_INVALID_FILE 3
1332 #define CONFIG_NO_WRITE 4
1333 #define CONFIG_NOTHING_SET 5
1334 #define CONFIG_INVALID_PATTERN 6
1335 #define CONFIG_GENERIC_ERROR 7
1337 #define CONFIG_REGEX_NONE ((void *)1)
1339 struct git_config_source {
1340 unsigned int use_stdin:1;
1341 const char *file;
1342 const char *blob;
1345 typedef int (*config_fn_t)(const char *, const char *, void *);
1346 extern int git_default_config(const char *, const char *, void *);
1347 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1348 extern int git_config_from_buf(config_fn_t fn, const char *name,
1349 const char *buf, size_t len, void *data);
1350 extern void git_config_push_parameter(const char *text);
1351 extern int git_config_from_parameters(config_fn_t fn, void *data);
1352 extern void git_config(config_fn_t fn, void *);
1353 extern int git_config_with_options(config_fn_t fn, void *,
1354 struct git_config_source *config_source,
1355 int respect_includes);
1356 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1357 extern int git_parse_ulong(const char *, unsigned long *);
1358 extern int git_config_int(const char *, const char *);
1359 extern int64_t git_config_int64(const char *, const char *);
1360 extern unsigned long git_config_ulong(const char *, const char *);
1361 extern int git_config_bool_or_int(const char *, const char *, int *);
1362 extern int git_config_bool(const char *, const char *);
1363 extern int git_config_maybe_bool(const char *, const char *);
1364 extern int git_config_string(const char **, const char *, const char *);
1365 extern int git_config_pathname(const char **, const char *, const char *);
1366 extern int git_config_set_in_file(const char *, const char *, const char *);
1367 extern int git_config_set(const char *, const char *);
1368 extern int git_config_parse_key(const char *, char **, int *);
1369 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1370 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1371 extern int git_config_rename_section(const char *, const char *);
1372 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1373 extern const char *git_etc_gitconfig(void);
1374 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1375 extern int git_env_bool(const char *, int);
1376 extern unsigned long git_env_ulong(const char *, unsigned long);
1377 extern int git_config_system(void);
1378 extern int config_error_nonbool(const char *);
1379 #if defined(__GNUC__)
1380 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1381 #endif
1382 extern const char *get_log_output_encoding(void);
1383 extern const char *get_commit_output_encoding(void);
1385 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1387 struct config_include_data {
1388 int depth;
1389 config_fn_t fn;
1390 void *data;
1392 #define CONFIG_INCLUDE_INIT { 0 }
1393 extern int git_config_include(const char *name, const char *value, void *data);
1396 * Match and parse a config key of the form:
1398 * section.(subsection.)?key
1400 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1401 * we return -1 if it does not match, 0 otherwise. The subsection and key
1402 * out-parameters are filled by the function (and subsection is NULL if it is
1403 * missing).
1405 extern int parse_config_key(const char *var,
1406 const char *section,
1407 const char **subsection, int *subsection_len,
1408 const char **key);
1410 struct config_set_element {
1411 struct hashmap_entry ent;
1412 char *key;
1413 struct string_list value_list;
1416 struct configset_list_item {
1417 struct config_set_element *e;
1418 int value_index;
1422 * the contents of the list are ordered according to their
1423 * position in the config files and order of parsing the files.
1424 * (i.e. key-value pair at the last position of .git/config will
1425 * be at the last item of the list)
1427 struct configset_list {
1428 struct configset_list_item *items;
1429 unsigned int nr, alloc;
1432 struct config_set {
1433 struct hashmap config_hash;
1434 int hash_initialized;
1435 struct configset_list list;
1438 extern void git_configset_init(struct config_set *cs);
1439 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1440 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1441 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1442 extern void git_configset_clear(struct config_set *cs);
1443 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1444 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1445 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1446 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1447 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1448 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1449 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1450 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1452 extern int git_config_get_value(const char *key, const char **value);
1453 extern const struct string_list *git_config_get_value_multi(const char *key);
1454 extern void git_config_clear(void);
1455 extern void git_config_iter(config_fn_t fn, void *data);
1456 extern int git_config_get_string_const(const char *key, const char **dest);
1457 extern int git_config_get_string(const char *key, char **dest);
1458 extern int git_config_get_int(const char *key, int *dest);
1459 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1460 extern int git_config_get_bool(const char *key, int *dest);
1461 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1462 extern int git_config_get_maybe_bool(const char *key, int *dest);
1463 extern int git_config_get_pathname(const char *key, const char **dest);
1465 struct key_value_info {
1466 const char *filename;
1467 int linenr;
1470 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1471 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1473 extern int committer_ident_sufficiently_given(void);
1474 extern int author_ident_sufficiently_given(void);
1476 extern const char *git_commit_encoding;
1477 extern const char *git_log_output_encoding;
1478 extern const char *git_mailmap_file;
1479 extern const char *git_mailmap_blob;
1481 /* IO helper functions */
1482 extern void maybe_flush_or_die(FILE *, const char *);
1483 __attribute__((format (printf, 2, 3)))
1484 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1485 extern int copy_fd(int ifd, int ofd);
1486 extern int copy_file(const char *dst, const char *src, int mode);
1487 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1488 extern void write_or_die(int fd, const void *buf, size_t count);
1489 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1490 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1491 extern void fsync_or_die(int fd, const char *);
1493 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1494 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1495 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1497 static inline ssize_t write_str_in_full(int fd, const char *str)
1499 return write_in_full(fd, str, strlen(str));
1502 /* pager.c */
1503 extern void setup_pager(void);
1504 extern const char *pager_program;
1505 extern int pager_in_use(void);
1506 extern int pager_use_color;
1507 extern int term_columns(void);
1508 extern int decimal_width(int);
1509 extern int check_pager_config(const char *cmd);
1511 extern const char *editor_program;
1512 extern const char *askpass_program;
1513 extern const char *excludes_file;
1515 /* base85 */
1516 int decode_85(char *dst, const char *line, int linelen);
1517 void encode_85(char *buf, const unsigned char *data, int bytes);
1519 /* alloc.c */
1520 extern void *alloc_blob_node(void);
1521 extern void *alloc_tree_node(void);
1522 extern void *alloc_commit_node(void);
1523 extern void *alloc_tag_node(void);
1524 extern void *alloc_object_node(void);
1525 extern void alloc_report(void);
1526 extern unsigned int alloc_commit_index(void);
1528 /* pkt-line.c */
1529 void packet_trace_identity(const char *prog);
1531 /* add */
1533 * return 0 if success, 1 - if addition of a file failed and
1534 * ADD_FILES_IGNORE_ERRORS was specified in flags
1536 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1538 /* diff.c */
1539 extern int diff_auto_refresh_index;
1541 /* match-trees.c */
1542 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1543 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1546 * whitespace rules.
1547 * used by both diff and apply
1548 * last two digits are tab width
1550 #define WS_BLANK_AT_EOL 0100
1551 #define WS_SPACE_BEFORE_TAB 0200
1552 #define WS_INDENT_WITH_NON_TAB 0400
1553 #define WS_CR_AT_EOL 01000
1554 #define WS_BLANK_AT_EOF 02000
1555 #define WS_TAB_IN_INDENT 04000
1556 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1557 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1558 #define WS_TAB_WIDTH_MASK 077
1559 extern unsigned whitespace_rule_cfg;
1560 extern unsigned whitespace_rule(const char *);
1561 extern unsigned parse_whitespace_rule(const char *);
1562 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1563 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1564 extern char *whitespace_error_string(unsigned ws);
1565 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1566 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1567 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1569 /* ls-files */
1570 int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
1571 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1573 char *alias_lookup(const char *alias);
1574 int split_cmdline(char *cmdline, const char ***argv);
1575 /* Takes a negative value returned by split_cmdline */
1576 const char *split_cmdline_strerror(int cmdline_errno);
1578 /* git.c */
1579 struct startup_info {
1580 int have_repository;
1581 const char *prefix;
1583 extern struct startup_info *startup_info;
1585 /* merge.c */
1586 struct commit_list;
1587 int try_merge_command(const char *strategy, size_t xopts_nr,
1588 const char **xopts, struct commit_list *common,
1589 const char *head_arg, struct commit_list *remotes);
1590 int checkout_fast_forward(const unsigned char *from,
1591 const unsigned char *to,
1592 int overwrite_ignore);
1595 int sane_execvp(const char *file, char *const argv[]);
1598 * A struct to encapsulate the concept of whether a file has changed
1599 * since we last checked it. This uses criteria similar to those used
1600 * for the index.
1602 struct stat_validity {
1603 struct stat_data *sd;
1606 void stat_validity_clear(struct stat_validity *sv);
1609 * Returns 1 if the path is a regular file (or a symlink to a regular
1610 * file) and matches the saved stat_validity, 0 otherwise. A missing
1611 * or inaccessible file is considered a match if the struct was just
1612 * initialized, or if the previous update found an inaccessible file.
1614 int stat_validity_check(struct stat_validity *sv, const char *path);
1617 * Update the stat_validity from a file opened at descriptor fd. If
1618 * the file is missing, inaccessible, or not a regular file, then
1619 * future calls to stat_validity_check will match iff one of those
1620 * conditions continues to be true.
1622 void stat_validity_update(struct stat_validity *sv, int fd);
1624 int versioncmp(const char *s1, const char *s2);
1626 #endif /* CACHE_H */