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