Documentation/branch: document -d --force and -m --force
[git/debian.git] / cache.h
blobdcf3a2afe9d782e4b2474d8834602f80610ba25f
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"
12 #include SHA1_HEADER
13 #ifndef git_SHA_CTX
14 #define git_SHA_CTX SHA_CTX
15 #define git_SHA1_Init SHA1_Init
16 #define git_SHA1_Update SHA1_Update
17 #define git_SHA1_Final SHA1_Final
18 #endif
20 #include <zlib.h>
21 typedef struct git_zstream {
22 z_stream z;
23 unsigned long avail_in;
24 unsigned long avail_out;
25 unsigned long total_in;
26 unsigned long total_out;
27 unsigned char *next_in;
28 unsigned char *next_out;
29 } git_zstream;
31 void git_inflate_init(git_zstream *);
32 void git_inflate_init_gzip_only(git_zstream *);
33 void git_inflate_end(git_zstream *);
34 int git_inflate(git_zstream *, int flush);
36 void git_deflate_init(git_zstream *, int level);
37 void git_deflate_init_gzip(git_zstream *, int level);
38 void git_deflate_init_raw(git_zstream *, int level);
39 void git_deflate_end(git_zstream *);
40 int git_deflate_abort(git_zstream *);
41 int git_deflate_end_gently(git_zstream *);
42 int git_deflate(git_zstream *, int flush);
43 unsigned long git_deflate_bound(git_zstream *, unsigned long);
45 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
46 #define DTYPE(de) ((de)->d_type)
47 #else
48 #undef DT_UNKNOWN
49 #undef DT_DIR
50 #undef DT_REG
51 #undef DT_LNK
52 #define DT_UNKNOWN 0
53 #define DT_DIR 1
54 #define DT_REG 2
55 #define DT_LNK 3
56 #define DTYPE(de) DT_UNKNOWN
57 #endif
59 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
60 #define S_IFINVALID 0030000
63 * A "directory link" is a link to another git directory.
65 * The value 0160000 is not normally a valid mode, and
66 * also just happens to be S_IFDIR + S_IFLNK
68 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
69 * always having the same values everywhere. We should use
70 * our internal git values for these things, and then we can
71 * translate that to the OS-specific value. It just so
72 * happens that everybody shares the same bit representation
73 * in the UNIX world (and apparently wider too..)
75 #define S_IFGITLINK 0160000
76 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
79 * Some mode bits are also used internally for computations.
81 * They *must* not overlap with any valid modes, and they *must* not be emitted
82 * to outside world - i.e. appear on disk or network. In other words, it's just
83 * temporary fields, which we internally use, but they have to stay in-house.
85 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
86 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
89 /* used internally in tree-diff */
90 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
94 * Intensive research over the course of many years has shown that
95 * port 9418 is totally unused by anything else. Or
97 * Your search - "port 9418" - did not match any documents.
99 * as www.google.com puts it.
101 * This port has been properly assigned for git use by IANA:
102 * git (Assigned-9418) [I06-050728-0001].
104 * git 9418/tcp git pack transfer service
105 * git 9418/udp git pack transfer service
107 * with Linus Torvalds <torvalds@osdl.org> as the point of
108 * contact. September 2005.
110 * See http://www.iana.org/assignments/port-numbers
112 #define DEFAULT_GIT_PORT 9418
115 * Basic data structures for the directory cache
118 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
119 struct cache_header {
120 uint32_t hdr_signature;
121 uint32_t hdr_version;
122 uint32_t hdr_entries;
125 #define INDEX_FORMAT_LB 2
126 #define INDEX_FORMAT_UB 4
129 * The "cache_time" is just the low 32 bits of the
130 * time. It doesn't matter if it overflows - we only
131 * check it for equality in the 32 bits we save.
133 struct cache_time {
134 uint32_t sec;
135 uint32_t nsec;
138 struct stat_data {
139 struct cache_time sd_ctime;
140 struct cache_time sd_mtime;
141 unsigned int sd_dev;
142 unsigned int sd_ino;
143 unsigned int sd_uid;
144 unsigned int sd_gid;
145 unsigned int sd_size;
148 struct cache_entry {
149 struct hashmap_entry ent;
150 struct stat_data ce_stat_data;
151 unsigned int ce_mode;
152 unsigned int ce_flags;
153 unsigned int ce_namelen;
154 unsigned int index; /* for link extension */
155 unsigned char sha1[20];
156 char name[FLEX_ARRAY]; /* more */
159 #define CE_STAGEMASK (0x3000)
160 #define CE_EXTENDED (0x4000)
161 #define CE_VALID (0x8000)
162 #define CE_STAGESHIFT 12
165 * Range 0xFFFF0FFF in ce_flags is divided into
166 * two parts: in-memory flags and on-disk ones.
167 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
168 * if you want to save a new flag, add it in
169 * CE_EXTENDED_FLAGS
171 * In-memory only flags
173 #define CE_UPDATE (1 << 16)
174 #define CE_REMOVE (1 << 17)
175 #define CE_UPTODATE (1 << 18)
176 #define CE_ADDED (1 << 19)
178 #define CE_HASHED (1 << 20)
179 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
180 #define CE_CONFLICTED (1 << 23)
182 #define CE_UNPACKED (1 << 24)
183 #define CE_NEW_SKIP_WORKTREE (1 << 25)
185 /* used to temporarily mark paths matched by pathspecs */
186 #define CE_MATCHED (1 << 26)
188 #define CE_UPDATE_IN_BASE (1 << 27)
189 #define CE_STRIP_NAME (1 << 28)
192 * Extended on-disk flags
194 #define CE_INTENT_TO_ADD (1 << 29)
195 #define CE_SKIP_WORKTREE (1 << 30)
196 /* CE_EXTENDED2 is for future extension */
197 #define CE_EXTENDED2 (1 << 31)
199 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
202 * Safeguard to avoid saving wrong flags:
203 * - CE_EXTENDED2 won't get saved until its semantic is known
204 * - Bits in 0x0000FFFF have been saved in ce_flags already
205 * - Bits in 0x003F0000 are currently in-memory flags
207 #if CE_EXTENDED_FLAGS & 0x803FFFFF
208 #error "CE_EXTENDED_FLAGS out of range"
209 #endif
211 struct pathspec;
214 * Copy the sha1 and stat state of a cache entry from one to
215 * another. But we never change the name, or the hash state!
217 static inline void copy_cache_entry(struct cache_entry *dst,
218 const struct cache_entry *src)
220 unsigned int state = dst->ce_flags & CE_HASHED;
222 /* Don't copy hash chain and name */
223 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
224 offsetof(struct cache_entry, name) -
225 offsetof(struct cache_entry, ce_stat_data));
227 /* Restore the hash state */
228 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
231 static inline unsigned create_ce_flags(unsigned stage)
233 return (stage << CE_STAGESHIFT);
236 #define ce_namelen(ce) ((ce)->ce_namelen)
237 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
238 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
239 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
240 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
241 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
243 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
244 static inline unsigned int create_ce_mode(unsigned int mode)
246 if (S_ISLNK(mode))
247 return S_IFLNK;
248 if (S_ISDIR(mode) || S_ISGITLINK(mode))
249 return S_IFGITLINK;
250 return S_IFREG | ce_permissions(mode);
252 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
253 unsigned int mode)
255 extern int trust_executable_bit, has_symlinks;
256 if (!has_symlinks && S_ISREG(mode) &&
257 ce && S_ISLNK(ce->ce_mode))
258 return ce->ce_mode;
259 if (!trust_executable_bit && S_ISREG(mode)) {
260 if (ce && S_ISREG(ce->ce_mode))
261 return ce->ce_mode;
262 return create_ce_mode(0666);
264 return create_ce_mode(mode);
266 static inline int ce_to_dtype(const struct cache_entry *ce)
268 unsigned ce_mode = ntohl(ce->ce_mode);
269 if (S_ISREG(ce_mode))
270 return DT_REG;
271 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
272 return DT_DIR;
273 else if (S_ISLNK(ce_mode))
274 return DT_LNK;
275 else
276 return DT_UNKNOWN;
278 static inline unsigned int canon_mode(unsigned int mode)
280 if (S_ISREG(mode))
281 return S_IFREG | ce_permissions(mode);
282 if (S_ISLNK(mode))
283 return S_IFLNK;
284 if (S_ISDIR(mode))
285 return S_IFDIR;
286 return S_IFGITLINK;
289 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
291 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
292 #define CE_ENTRY_CHANGED (1 << 1)
293 #define CE_ENTRY_REMOVED (1 << 2)
294 #define CE_ENTRY_ADDED (1 << 3)
295 #define RESOLVE_UNDO_CHANGED (1 << 4)
296 #define CACHE_TREE_CHANGED (1 << 5)
297 #define SPLIT_INDEX_ORDERED (1 << 6)
299 struct split_index;
300 struct index_state {
301 struct cache_entry **cache;
302 unsigned int version;
303 unsigned int cache_nr, cache_alloc, cache_changed;
304 struct string_list *resolve_undo;
305 struct cache_tree *cache_tree;
306 struct split_index *split_index;
307 struct cache_time timestamp;
308 unsigned name_hash_initialized : 1,
309 initialized : 1;
310 struct hashmap name_hash;
311 struct hashmap dir_hash;
312 unsigned char sha1[20];
315 extern struct index_state the_index;
317 /* Name hashing */
318 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
319 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
320 extern void free_name_hash(struct index_state *istate);
323 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
324 #define active_cache (the_index.cache)
325 #define active_nr (the_index.cache_nr)
326 #define active_alloc (the_index.cache_alloc)
327 #define active_cache_changed (the_index.cache_changed)
328 #define active_cache_tree (the_index.cache_tree)
330 #define read_cache() read_index(&the_index)
331 #define read_cache_from(path) read_index_from(&the_index, (path))
332 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
333 #define is_cache_unborn() is_index_unborn(&the_index)
334 #define read_cache_unmerged() read_index_unmerged(&the_index)
335 #define discard_cache() discard_index(&the_index)
336 #define unmerged_cache() unmerged_index(&the_index)
337 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
338 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
339 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
340 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
341 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
342 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
343 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
344 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
345 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
346 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
347 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
348 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
349 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
350 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
351 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
352 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
353 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
354 #endif
356 enum object_type {
357 OBJ_BAD = -1,
358 OBJ_NONE = 0,
359 OBJ_COMMIT = 1,
360 OBJ_TREE = 2,
361 OBJ_BLOB = 3,
362 OBJ_TAG = 4,
363 /* 5 for future expansion */
364 OBJ_OFS_DELTA = 6,
365 OBJ_REF_DELTA = 7,
366 OBJ_ANY,
367 OBJ_MAX
370 static inline enum object_type object_type(unsigned int mode)
372 return S_ISDIR(mode) ? OBJ_TREE :
373 S_ISGITLINK(mode) ? OBJ_COMMIT :
374 OBJ_BLOB;
377 /* Double-check local_repo_env below if you add to this list. */
378 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
379 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
380 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
381 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
382 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
383 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
384 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
385 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
386 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
387 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
388 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
389 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
390 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
391 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
392 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
393 #define GITATTRIBUTES_FILE ".gitattributes"
394 #define INFOATTRIBUTES_FILE "info/attributes"
395 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
396 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
397 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
398 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
399 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
400 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
401 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
402 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
403 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
404 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
407 * This environment variable is expected to contain a boolean indicating
408 * whether we should or should not treat:
410 * GIT_DIR=foo.git git ...
412 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
413 * of this, but we use it internally to communicate to sub-processes that we
414 * are in a bare repo. If not set, defaults to true.
416 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
419 * Repository-local GIT_* environment variables; these will be cleared
420 * when git spawns a sub-process that runs inside another repository.
421 * The array is NULL-terminated, which makes it easy to pass in the "env"
422 * parameter of a run-command invocation, or to do a simple walk.
424 extern const char * const local_repo_env[];
426 extern int is_bare_repository_cfg;
427 extern int is_bare_repository(void);
428 extern int is_inside_git_dir(void);
429 extern char *git_work_tree_cfg;
430 extern int is_inside_work_tree(void);
431 extern const char *get_git_dir(void);
432 extern int is_git_directory(const char *path);
433 extern char *get_object_directory(void);
434 extern char *get_index_file(void);
435 extern char *get_graft_file(void);
436 extern int set_git_dir(const char *path);
437 extern const char *get_git_namespace(void);
438 extern const char *strip_namespace(const char *namespaced_ref);
439 extern const char *get_git_work_tree(void);
440 extern const char *read_gitfile(const char *path);
441 extern const char *resolve_gitdir(const char *suspect);
442 extern void set_git_work_tree(const char *tree);
444 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
446 extern const char **get_pathspec(const char *prefix, const char **pathspec);
447 extern void setup_work_tree(void);
448 extern const char *setup_git_directory_gently(int *);
449 extern const char *setup_git_directory(void);
450 extern char *prefix_path(const char *prefix, int len, const char *path);
451 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
452 extern const char *prefix_filename(const char *prefix, int len, const char *path);
453 extern int check_filename(const char *prefix, const char *name);
454 extern void verify_filename(const char *prefix,
455 const char *name,
456 int diagnose_misspelt_rev);
457 extern void verify_non_filename(const char *prefix, const char *name);
458 extern int path_inside_repo(const char *prefix, const char *path);
460 #define INIT_DB_QUIET 0x0001
462 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
463 extern int init_db(const char *template_dir, unsigned int flags);
465 extern void sanitize_stdfds(void);
466 extern int daemonize(void);
468 #define alloc_nr(x) (((x)+16)*3/2)
471 * Realloc the buffer pointed at by variable 'x' so that it can hold
472 * at least 'nr' entries; the number of entries currently allocated
473 * is 'alloc', using the standard growing factor alloc_nr() macro.
475 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
477 #define ALLOC_GROW(x, nr, alloc) \
478 do { \
479 if ((nr) > alloc) { \
480 if (alloc_nr(alloc) < (nr)) \
481 alloc = (nr); \
482 else \
483 alloc = alloc_nr(alloc); \
484 x = xrealloc((x), alloc * sizeof(*(x))); \
486 } while (0)
488 /* Initialize and use the cache information */
489 struct lock_file;
490 extern int read_index(struct index_state *);
491 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
492 extern int do_read_index(struct index_state *istate, const char *path,
493 int must_exist); /* for testting only! */
494 extern int read_index_from(struct index_state *, const char *path);
495 extern int is_index_unborn(struct index_state *);
496 extern int read_index_unmerged(struct index_state *);
497 #define COMMIT_LOCK (1 << 0)
498 #define CLOSE_LOCK (1 << 1)
499 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
500 extern int discard_index(struct index_state *);
501 extern int unmerged_index(const struct index_state *);
502 extern int verify_path(const char *path);
503 extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
504 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
505 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
506 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
507 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
508 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
509 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
510 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
511 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
512 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
513 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
514 extern int remove_index_entry_at(struct index_state *, int pos);
515 extern void remove_marked_cache_entries(struct index_state *istate);
516 extern int remove_file_from_index(struct index_state *, const char *path);
517 #define ADD_CACHE_VERBOSE 1
518 #define ADD_CACHE_PRETEND 2
519 #define ADD_CACHE_IGNORE_ERRORS 4
520 #define ADD_CACHE_IGNORE_REMOVAL 8
521 #define ADD_CACHE_INTENT 16
522 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
523 extern int add_file_to_index(struct index_state *, const char *path, int flags);
524 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
525 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
526 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
527 extern int index_name_is_other(const struct index_state *, const char *, int);
528 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
530 /* do stat comparison even if CE_VALID is true */
531 #define CE_MATCH_IGNORE_VALID 01
532 /* do not check the contents but report dirty on racily-clean entries */
533 #define CE_MATCH_RACY_IS_DIRTY 02
534 /* do stat comparison even if CE_SKIP_WORKTREE is true */
535 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
536 /* ignore non-existent files during stat update */
537 #define CE_MATCH_IGNORE_MISSING 0x08
538 /* enable stat refresh */
539 #define CE_MATCH_REFRESH 0x10
540 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
541 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
543 #define HASH_WRITE_OBJECT 1
544 #define HASH_FORMAT_CHECK 2
545 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
546 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
549 * Record to sd the data from st that we use to check whether a file
550 * might have changed.
552 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
555 * Return 0 if st is consistent with a file not having been changed
556 * since sd was filled. If there are differences, return a
557 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
558 * INODE_CHANGED, and DATA_CHANGED.
560 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
562 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
564 #define REFRESH_REALLY 0x0001 /* ignore_valid */
565 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
566 #define REFRESH_QUIET 0x0004 /* be quiet about it */
567 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
568 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
569 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
570 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
572 struct lock_file {
573 struct lock_file *next;
574 int fd;
575 pid_t owner;
576 char on_list;
577 char filename[PATH_MAX];
579 #define LOCK_DIE_ON_ERROR 1
580 #define LOCK_NODEREF 2
581 extern int unable_to_lock_error(const char *path, int err);
582 extern void unable_to_lock_message(const char *path, int err,
583 struct strbuf *buf);
584 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
585 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
586 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
587 extern int commit_lock_file(struct lock_file *);
588 extern void update_index_if_able(struct index_state *, struct lock_file *);
590 extern int hold_locked_index(struct lock_file *, int);
591 extern void set_alternate_index_output(const char *);
592 extern int close_lock_file(struct lock_file *);
593 extern void rollback_lock_file(struct lock_file *);
594 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
596 /* Environment bits from configuration mechanism */
597 extern int trust_executable_bit;
598 extern int trust_ctime;
599 extern int check_stat;
600 extern int quote_path_fully;
601 extern int has_symlinks;
602 extern int minimum_abbrev, default_abbrev;
603 extern int ignore_case;
604 extern int assume_unchanged;
605 extern int prefer_symlink_refs;
606 extern int log_all_ref_updates;
607 extern int warn_ambiguous_refs;
608 extern int warn_on_object_refname_ambiguity;
609 extern int shared_repository;
610 extern const char *apply_default_whitespace;
611 extern const char *apply_default_ignorewhitespace;
612 extern const char *git_attributes_file;
613 extern int zlib_compression_level;
614 extern int core_compression_level;
615 extern int core_compression_seen;
616 extern size_t packed_git_window_size;
617 extern size_t packed_git_limit;
618 extern size_t delta_base_cache_limit;
619 extern unsigned long big_file_threshold;
620 extern unsigned long pack_size_limit_cfg;
623 * Do replace refs need to be checked this run? This variable is
624 * initialized to true unless --no-replace-object is used or
625 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
626 * commands that do not want replace references to be active. As an
627 * optimization it is also set to false if replace references have
628 * been sought but there were none.
630 extern int check_replace_refs;
632 extern int fsync_object_files;
633 extern int core_preload_index;
634 extern int core_apply_sparse_checkout;
635 extern int precomposed_unicode;
638 * The character that begins a commented line in user-editable file
639 * that is subject to stripspace.
641 extern char comment_line_char;
642 extern int auto_comment_line_char;
644 enum branch_track {
645 BRANCH_TRACK_UNSPECIFIED = -1,
646 BRANCH_TRACK_NEVER = 0,
647 BRANCH_TRACK_REMOTE,
648 BRANCH_TRACK_ALWAYS,
649 BRANCH_TRACK_EXPLICIT,
650 BRANCH_TRACK_OVERRIDE
653 enum rebase_setup_type {
654 AUTOREBASE_NEVER = 0,
655 AUTOREBASE_LOCAL,
656 AUTOREBASE_REMOTE,
657 AUTOREBASE_ALWAYS
660 enum push_default_type {
661 PUSH_DEFAULT_NOTHING = 0,
662 PUSH_DEFAULT_MATCHING,
663 PUSH_DEFAULT_SIMPLE,
664 PUSH_DEFAULT_UPSTREAM,
665 PUSH_DEFAULT_CURRENT,
666 PUSH_DEFAULT_UNSPECIFIED
669 extern enum branch_track git_branch_track;
670 extern enum rebase_setup_type autorebase;
671 extern enum push_default_type push_default;
673 enum object_creation_mode {
674 OBJECT_CREATION_USES_HARDLINKS = 0,
675 OBJECT_CREATION_USES_RENAMES = 1
678 extern enum object_creation_mode object_creation_mode;
680 extern char *notes_ref_name;
682 extern int grafts_replace_parents;
684 #define GIT_REPO_VERSION 0
685 extern int repository_format_version;
686 extern int check_repository_format(void);
688 #define MTIME_CHANGED 0x0001
689 #define CTIME_CHANGED 0x0002
690 #define OWNER_CHANGED 0x0004
691 #define MODE_CHANGED 0x0008
692 #define INODE_CHANGED 0x0010
693 #define DATA_CHANGED 0x0020
694 #define TYPE_CHANGED 0x0040
696 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
697 __attribute__((format (printf, 3, 4)));
698 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
699 __attribute__((format (printf, 3, 4)));
700 extern char *git_pathdup(const char *fmt, ...)
701 __attribute__((format (printf, 1, 2)));
702 extern char *mkpathdup(const char *fmt, ...)
703 __attribute__((format (printf, 1, 2)));
705 /* Return a statically allocated filename matching the sha1 signature */
706 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
707 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
708 extern char *git_path_submodule(const char *path, const char *fmt, ...)
709 __attribute__((format (printf, 2, 3)));
712 * Return the name of the file in the local object database that would
713 * be used to store a loose object with the specified sha1. The
714 * return value is a pointer to a statically allocated buffer that is
715 * overwritten each time the function is called.
717 extern const char *sha1_file_name(const unsigned char *sha1);
720 * Return the name of the (local) packfile with the specified sha1 in
721 * its name. The return value is a pointer to memory that is
722 * overwritten each time this function is called.
724 extern char *sha1_pack_name(const unsigned char *sha1);
727 * Return the name of the (local) pack index file with the specified
728 * sha1 in its name. The return value is a pointer to memory that is
729 * overwritten each time this function is called.
731 extern char *sha1_pack_index_name(const unsigned char *sha1);
733 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
734 extern const unsigned char null_sha1[20];
736 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
738 int i;
740 for (i = 0; i < 20; i++, sha1++, sha2++) {
741 if (*sha1 != *sha2)
742 return *sha1 - *sha2;
745 return 0;
748 static inline int is_null_sha1(const unsigned char *sha1)
750 return !hashcmp(sha1, null_sha1);
753 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
755 memcpy(sha_dst, sha_src, 20);
757 static inline void hashclr(unsigned char *hash)
759 memset(hash, 0, 20);
762 #define EMPTY_TREE_SHA1_HEX \
763 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
764 #define EMPTY_TREE_SHA1_BIN_LITERAL \
765 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
766 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
767 #define EMPTY_TREE_SHA1_BIN \
768 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
770 #define EMPTY_BLOB_SHA1_HEX \
771 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
772 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
773 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
774 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
775 #define EMPTY_BLOB_SHA1_BIN \
776 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
778 static inline int is_empty_blob_sha1(const unsigned char *sha1)
780 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
783 int git_mkstemp(char *path, size_t n, const char *template);
785 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
787 /* set default permissions by passing mode arguments to open(2) */
788 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
789 int git_mkstemp_mode(char *pattern, int mode);
792 * NOTE NOTE NOTE!!
794 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
795 * not be changed. Old repositories have core.sharedrepository written in
796 * numeric format, and therefore these values are preserved for compatibility
797 * reasons.
799 enum sharedrepo {
800 PERM_UMASK = 0,
801 OLD_PERM_GROUP = 1,
802 OLD_PERM_EVERYBODY = 2,
803 PERM_GROUP = 0660,
804 PERM_EVERYBODY = 0664
806 int git_config_perm(const char *var, const char *value);
807 int adjust_shared_perm(const char *path);
810 * Create the directory containing the named path, using care to be
811 * somewhat safe against races. Return one of the scld_error values
812 * to indicate success/failure.
814 * SCLD_VANISHED indicates that one of the ancestor directories of the
815 * path existed at one point during the function call and then
816 * suddenly vanished, probably because another process pruned the
817 * directory while we were working. To be robust against this kind of
818 * race, callers might want to try invoking the function again when it
819 * returns SCLD_VANISHED.
821 enum scld_error {
822 SCLD_OK = 0,
823 SCLD_FAILED = -1,
824 SCLD_PERMS = -2,
825 SCLD_EXISTS = -3,
826 SCLD_VANISHED = -4
828 enum scld_error safe_create_leading_directories(char *path);
829 enum scld_error safe_create_leading_directories_const(const char *path);
831 int mkdir_in_gitdir(const char *path);
832 extern void home_config_paths(char **global, char **xdg, char *file);
833 extern char *expand_user_path(const char *path);
834 const char *enter_repo(const char *path, int strict);
835 static inline int is_absolute_path(const char *path)
837 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
839 int is_directory(const char *);
840 const char *real_path(const char *path);
841 const char *real_path_if_valid(const char *path);
842 const char *absolute_path(const char *path);
843 const char *remove_leading_path(const char *in, const char *prefix);
844 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
845 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
846 int normalize_path_copy(char *dst, const char *src);
847 int longest_ancestor_length(const char *path, struct string_list *prefixes);
848 char *strip_path_suffix(const char *path, const char *suffix);
849 int daemon_avoid_alias(const char *path);
851 /* object replacement */
852 #define LOOKUP_REPLACE_OBJECT 1
853 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
854 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
856 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
860 * This internal function is only declared here for the benefit of
861 * lookup_replace_object(). Please do not call it directly.
863 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
866 * If object sha1 should be replaced, return the replacement object's
867 * name (replaced recursively, if necessary). The return value is
868 * either sha1 or a pointer to a permanently-allocated value. When
869 * object replacement is suppressed, always return sha1.
871 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
873 if (!check_replace_refs)
874 return sha1;
875 return do_lookup_replace_object(sha1);
878 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
880 if (!(flag & LOOKUP_REPLACE_OBJECT))
881 return sha1;
882 return lookup_replace_object(sha1);
885 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
886 extern int sha1_object_info(const unsigned char *, unsigned long *);
887 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
888 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
889 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
890 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
891 extern int git_open_noatime(const char *name);
892 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
893 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
894 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
896 /* global flag to enable extra checks when accessing packed objects */
897 extern int do_check_packed_object_crc;
899 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
901 extern int move_temp_to_file(const char *tmpfile, const char *filename);
903 extern int has_sha1_pack(const unsigned char *sha1);
906 * Return true iff we have an object named sha1, whether local or in
907 * an alternate object database, and whether packed or loose. This
908 * function does not respect replace references.
910 extern int has_sha1_file(const unsigned char *sha1);
913 * Return true iff an alternate object database has a loose object
914 * with the specified name. This function does not respect replace
915 * references.
917 extern int has_loose_object_nonlocal(const unsigned char *sha1);
919 extern int has_pack_index(const unsigned char *sha1);
921 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
923 extern const signed char hexval_table[256];
924 static inline unsigned int hexval(unsigned char c)
926 return hexval_table[c];
929 /* Convert to/from hex/sha1 representation */
930 #define MINIMUM_ABBREV minimum_abbrev
931 #define DEFAULT_ABBREV default_abbrev
933 struct object_context {
934 unsigned char tree[20];
935 char path[PATH_MAX];
936 unsigned mode;
939 #define GET_SHA1_QUIETLY 01
940 #define GET_SHA1_COMMIT 02
941 #define GET_SHA1_COMMITTISH 04
942 #define GET_SHA1_TREE 010
943 #define GET_SHA1_TREEISH 020
944 #define GET_SHA1_BLOB 040
945 #define GET_SHA1_ONLY_TO_DIE 04000
947 extern int get_sha1(const char *str, unsigned char *sha1);
948 extern int get_sha1_commit(const char *str, unsigned char *sha1);
949 extern int get_sha1_committish(const char *str, unsigned char *sha1);
950 extern int get_sha1_tree(const char *str, unsigned char *sha1);
951 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
952 extern int get_sha1_blob(const char *str, unsigned char *sha1);
953 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
954 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
956 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
957 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
960 * Try to read a SHA1 in hexadecimal format from the 40 characters
961 * starting at hex. Write the 20-byte result to sha1 in binary form.
962 * Return 0 on success. Reading stops if a NUL is encountered in the
963 * input, so it is safe to pass this function an arbitrary
964 * null-terminated string.
966 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
968 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
969 extern int read_ref_full(const char *refname, unsigned char *sha1,
970 int reading, int *flags);
971 extern int read_ref(const char *refname, unsigned char *sha1);
974 * Resolve a reference, recursively following symbolic refererences.
976 * Store the referred-to object's name in sha1 and return the name of
977 * the non-symbolic reference that ultimately pointed at it. The
978 * return value, if not NULL, is a pointer into either a static buffer
979 * or the input ref.
981 * If the reference cannot be resolved to an object, the behavior
982 * depends on the "reading" argument:
984 * - If reading is set, return NULL.
986 * - If reading is not set, clear sha1 and return the name of the last
987 * reference name in the chain, which will either be a non-symbolic
988 * reference or an undefined reference. If this is a prelude to
989 * "writing" to the ref, the return value is the name of the ref
990 * that will actually be created or changed.
992 * If flag is non-NULL, set the value that it points to the
993 * combination of REF_ISPACKED (if the reference was found among the
994 * packed references) and REF_ISSYMREF (if the initial reference was a
995 * symbolic reference).
997 * If ref is not a properly-formatted, normalized reference, return
998 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
999 * give up and return NULL.
1001 * errno is set to something meaningful on error.
1003 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
1004 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
1006 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
1007 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
1008 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1009 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1012 * Return true iff abbrev_name is a possible abbreviation for
1013 * full_name according to the rules defined by ref_rev_parse_rules in
1014 * refs.c.
1016 extern int refname_match(const char *abbrev_name, const char *full_name);
1018 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
1019 extern int validate_headref(const char *ref);
1021 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1022 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1023 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1024 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1026 extern void *read_object_with_reference(const unsigned char *sha1,
1027 const char *required_type,
1028 unsigned long *size,
1029 unsigned char *sha1_ret);
1031 extern struct object *peel_to_type(const char *name, int namelen,
1032 struct object *o, enum object_type);
1034 enum date_mode {
1035 DATE_NORMAL = 0,
1036 DATE_RELATIVE,
1037 DATE_SHORT,
1038 DATE_LOCAL,
1039 DATE_ISO8601,
1040 DATE_RFC2822,
1041 DATE_RAW
1044 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
1045 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1046 struct strbuf *timebuf);
1047 int parse_date(const char *date, char *buf, int bufsize);
1048 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1049 int parse_expiry_date(const char *date, unsigned long *timestamp);
1050 void datestamp(char *buf, int bufsize);
1051 #define approxidate(s) approxidate_careful((s), NULL)
1052 unsigned long approxidate_careful(const char *, int *);
1053 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1054 enum date_mode parse_date_format(const char *format);
1055 int date_overflows(unsigned long date);
1057 #define IDENT_STRICT 1
1058 #define IDENT_NO_DATE 2
1059 #define IDENT_NO_NAME 4
1060 extern const char *git_author_info(int);
1061 extern const char *git_committer_info(int);
1062 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1063 extern const char *fmt_name(const char *name, const char *email);
1064 extern const char *ident_default_email(void);
1065 extern const char *git_editor(void);
1066 extern const char *git_pager(int stdout_is_tty);
1067 extern int git_ident_config(const char *, const char *, void *);
1069 struct ident_split {
1070 const char *name_begin;
1071 const char *name_end;
1072 const char *mail_begin;
1073 const char *mail_end;
1074 const char *date_begin;
1075 const char *date_end;
1076 const char *tz_begin;
1077 const char *tz_end;
1080 * Signals an success with 0, but time part of the result may be NULL
1081 * if the input lacks timestamp and zone
1083 extern int split_ident_line(struct ident_split *, const char *, int);
1086 * Like show_date, but pull the timestamp and tz parameters from
1087 * the ident_split. It will also sanity-check the values and produce
1088 * a well-known sentinel date if they appear bogus.
1090 const char *show_ident_date(const struct ident_split *id, enum date_mode mode);
1093 * Compare split idents for equality or strict ordering. Note that we
1094 * compare only the ident part of the line, ignoring any timestamp.
1096 * Because there are two fields, we must choose one as the primary key; we
1097 * currently arbitrarily pick the email.
1099 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1101 struct checkout {
1102 struct index_state *istate;
1103 const char *base_dir;
1104 int base_dir_len;
1105 unsigned force:1,
1106 quiet:1,
1107 not_new:1,
1108 refresh_cache:1;
1111 #define TEMPORARY_FILENAME_LENGTH 25
1112 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1114 struct cache_def {
1115 struct strbuf path;
1116 int flags;
1117 int track_flags;
1118 int prefix_len_stat_func;
1120 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1121 static inline void cache_def_clear(struct cache_def *cache)
1123 strbuf_release(&cache->path);
1126 extern int has_symlink_leading_path(const char *name, int len);
1127 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1128 extern int check_leading_path(const char *name, int len);
1129 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1130 extern void schedule_dir_for_removal(const char *name, int len);
1131 extern void remove_scheduled_dirs(void);
1133 extern struct alternate_object_database {
1134 struct alternate_object_database *next;
1135 char *name;
1136 char base[FLEX_ARRAY]; /* more */
1137 } *alt_odb_list;
1138 extern void prepare_alt_odb(void);
1139 extern void read_info_alternates(const char * relative_base, int depth);
1140 extern void add_to_alternates_file(const char *reference);
1141 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1142 extern void foreach_alt_odb(alt_odb_fn, void*);
1144 struct pack_window {
1145 struct pack_window *next;
1146 unsigned char *base;
1147 off_t offset;
1148 size_t len;
1149 unsigned int last_used;
1150 unsigned int inuse_cnt;
1153 extern struct packed_git {
1154 struct packed_git *next;
1155 struct pack_window *windows;
1156 off_t pack_size;
1157 const void *index_data;
1158 size_t index_size;
1159 uint32_t num_objects;
1160 uint32_t num_bad_objects;
1161 unsigned char *bad_object_sha1;
1162 int index_version;
1163 time_t mtime;
1164 int pack_fd;
1165 unsigned pack_local:1,
1166 pack_keep:1,
1167 do_not_close:1;
1168 unsigned char sha1[20];
1169 /* something like ".git/objects/pack/xxxxx.pack" */
1170 char pack_name[FLEX_ARRAY]; /* more */
1171 } *packed_git;
1173 struct pack_entry {
1174 off_t offset;
1175 unsigned char sha1[20];
1176 struct packed_git *p;
1179 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1181 /* A hook for count-objects to report invalid files in pack directory */
1182 extern void (*report_garbage)(const char *desc, const char *path);
1184 extern void prepare_packed_git(void);
1185 extern void reprepare_packed_git(void);
1186 extern void install_packed_git(struct packed_git *pack);
1188 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1189 struct packed_git *packs);
1191 extern void pack_report(void);
1194 * mmap the index file for the specified packfile (if it is not
1195 * already mmapped). Return 0 on success.
1197 extern int open_pack_index(struct packed_git *);
1200 * munmap the index file for the specified packfile (if it is
1201 * currently mmapped).
1203 extern void close_pack_index(struct packed_git *);
1205 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1206 extern void close_pack_windows(struct packed_git *);
1207 extern void unuse_pack(struct pack_window **);
1208 extern void free_pack_by_name(const char *);
1209 extern void clear_delta_base_cache(void);
1210 extern struct packed_git *add_packed_git(const char *, int, int);
1213 * Return the SHA-1 of the nth object within the specified packfile.
1214 * Open the index if it is not already open. The return value points
1215 * at the SHA-1 within the mmapped index. Return NULL if there is an
1216 * error.
1218 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1221 * Return the offset of the nth object within the specified packfile.
1222 * The index must already be opened.
1224 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1227 * If the object named sha1 is present in the specified packfile,
1228 * return its offset within the packfile; otherwise, return 0.
1230 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1232 extern int is_pack_valid(struct packed_git *);
1233 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1234 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1235 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1236 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1238 struct object_info {
1239 /* Request */
1240 enum object_type *typep;
1241 unsigned long *sizep;
1242 unsigned long *disk_sizep;
1243 unsigned char *delta_base_sha1;
1245 /* Response */
1246 enum {
1247 OI_CACHED,
1248 OI_LOOSE,
1249 OI_PACKED,
1250 OI_DBCACHED
1251 } whence;
1252 union {
1254 * struct {
1255 * ... Nothing to expose in this case
1256 * } cached;
1257 * struct {
1258 * ... Nothing to expose in this case
1259 * } loose;
1261 struct {
1262 struct packed_git *pack;
1263 off_t offset;
1264 unsigned int is_delta;
1265 } packed;
1266 } u;
1268 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1270 /* Dumb servers support */
1271 extern int update_server_info(int);
1273 /* git_config_parse_key() returns these negated: */
1274 #define CONFIG_INVALID_KEY 1
1275 #define CONFIG_NO_SECTION_OR_NAME 2
1276 /* git_config_set(), git_config_set_multivar() return the above or these: */
1277 #define CONFIG_NO_LOCK -1
1278 #define CONFIG_INVALID_FILE 3
1279 #define CONFIG_NO_WRITE 4
1280 #define CONFIG_NOTHING_SET 5
1281 #define CONFIG_INVALID_PATTERN 6
1282 #define CONFIG_GENERIC_ERROR 7
1284 #define CONFIG_REGEX_NONE ((void *)1)
1286 struct git_config_source {
1287 unsigned int use_stdin:1;
1288 const char *file;
1289 const char *blob;
1292 typedef int (*config_fn_t)(const char *, const char *, void *);
1293 extern int git_default_config(const char *, const char *, void *);
1294 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1295 extern int git_config_from_buf(config_fn_t fn, const char *name,
1296 const char *buf, size_t len, void *data);
1297 extern void git_config_push_parameter(const char *text);
1298 extern int git_config_from_parameters(config_fn_t fn, void *data);
1299 extern int git_config(config_fn_t fn, void *);
1300 extern int git_config_with_options(config_fn_t fn, void *,
1301 struct git_config_source *config_source,
1302 int respect_includes);
1303 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1304 extern int git_parse_ulong(const char *, unsigned long *);
1305 extern int git_config_int(const char *, const char *);
1306 extern int64_t git_config_int64(const char *, const char *);
1307 extern unsigned long git_config_ulong(const char *, const char *);
1308 extern int git_config_bool_or_int(const char *, const char *, int *);
1309 extern int git_config_bool(const char *, const char *);
1310 extern int git_config_maybe_bool(const char *, const char *);
1311 extern int git_config_string(const char **, const char *, const char *);
1312 extern int git_config_pathname(const char **, const char *, const char *);
1313 extern int git_config_set_in_file(const char *, const char *, const char *);
1314 extern int git_config_set(const char *, const char *);
1315 extern int git_config_parse_key(const char *, char **, int *);
1316 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1317 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1318 extern int git_config_rename_section(const char *, const char *);
1319 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1320 extern const char *git_etc_gitconfig(void);
1321 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1322 extern int git_env_bool(const char *, int);
1323 extern int git_config_system(void);
1324 extern int config_error_nonbool(const char *);
1325 #if defined(__GNUC__)
1326 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1327 #endif
1328 extern const char *get_log_output_encoding(void);
1329 extern const char *get_commit_output_encoding(void);
1331 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1333 struct config_include_data {
1334 int depth;
1335 config_fn_t fn;
1336 void *data;
1338 #define CONFIG_INCLUDE_INIT { 0 }
1339 extern int git_config_include(const char *name, const char *value, void *data);
1342 * Match and parse a config key of the form:
1344 * section.(subsection.)?key
1346 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1347 * we return -1 if it does not match, 0 otherwise. The subsection and key
1348 * out-parameters are filled by the function (and subsection is NULL if it is
1349 * missing).
1351 extern int parse_config_key(const char *var,
1352 const char *section,
1353 const char **subsection, int *subsection_len,
1354 const char **key);
1356 extern int committer_ident_sufficiently_given(void);
1357 extern int author_ident_sufficiently_given(void);
1359 extern const char *git_commit_encoding;
1360 extern const char *git_log_output_encoding;
1361 extern const char *git_mailmap_file;
1362 extern const char *git_mailmap_blob;
1364 /* IO helper functions */
1365 extern void maybe_flush_or_die(FILE *, const char *);
1366 extern int copy_fd(int ifd, int ofd);
1367 extern int copy_file(const char *dst, const char *src, int mode);
1368 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1369 extern void write_or_die(int fd, const void *buf, size_t count);
1370 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1371 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1372 extern void fsync_or_die(int fd, const char *);
1374 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1375 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1376 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1378 static inline ssize_t write_str_in_full(int fd, const char *str)
1380 return write_in_full(fd, str, strlen(str));
1383 /* pager.c */
1384 extern void setup_pager(void);
1385 extern const char *pager_program;
1386 extern int pager_in_use(void);
1387 extern int pager_use_color;
1388 extern int term_columns(void);
1389 extern int decimal_width(int);
1390 extern int check_pager_config(const char *cmd);
1392 extern const char *editor_program;
1393 extern const char *askpass_program;
1394 extern const char *excludes_file;
1396 /* base85 */
1397 int decode_85(char *dst, const char *line, int linelen);
1398 void encode_85(char *buf, const unsigned char *data, int bytes);
1400 /* alloc.c */
1401 extern void *alloc_blob_node(void);
1402 extern void *alloc_tree_node(void);
1403 extern void *alloc_commit_node(void);
1404 extern void *alloc_tag_node(void);
1405 extern void *alloc_object_node(void);
1406 extern void alloc_report(void);
1407 extern unsigned int alloc_commit_index(void);
1409 /* pkt-line.c */
1410 void packet_trace_identity(const char *prog);
1412 /* add */
1414 * return 0 if success, 1 - if addition of a file failed and
1415 * ADD_FILES_IGNORE_ERRORS was specified in flags
1417 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1419 /* diff.c */
1420 extern int diff_auto_refresh_index;
1422 /* match-trees.c */
1423 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1424 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1427 * whitespace rules.
1428 * used by both diff and apply
1429 * last two digits are tab width
1431 #define WS_BLANK_AT_EOL 0100
1432 #define WS_SPACE_BEFORE_TAB 0200
1433 #define WS_INDENT_WITH_NON_TAB 0400
1434 #define WS_CR_AT_EOL 01000
1435 #define WS_BLANK_AT_EOF 02000
1436 #define WS_TAB_IN_INDENT 04000
1437 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1438 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1439 #define WS_TAB_WIDTH_MASK 077
1440 extern unsigned whitespace_rule_cfg;
1441 extern unsigned whitespace_rule(const char *);
1442 extern unsigned parse_whitespace_rule(const char *);
1443 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1444 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1445 extern char *whitespace_error_string(unsigned ws);
1446 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1447 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1448 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1450 /* ls-files */
1451 int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
1452 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1454 char *alias_lookup(const char *alias);
1455 int split_cmdline(char *cmdline, const char ***argv);
1456 /* Takes a negative value returned by split_cmdline */
1457 const char *split_cmdline_strerror(int cmdline_errno);
1459 /* git.c */
1460 struct startup_info {
1461 int have_repository;
1462 const char *prefix;
1464 extern struct startup_info *startup_info;
1466 /* merge.c */
1467 struct commit_list;
1468 int try_merge_command(const char *strategy, size_t xopts_nr,
1469 const char **xopts, struct commit_list *common,
1470 const char *head_arg, struct commit_list *remotes);
1471 int checkout_fast_forward(const unsigned char *from,
1472 const unsigned char *to,
1473 int overwrite_ignore);
1476 int sane_execvp(const char *file, char *const argv[]);
1479 * A struct to encapsulate the concept of whether a file has changed
1480 * since we last checked it. This uses criteria similar to those used
1481 * for the index.
1483 struct stat_validity {
1484 struct stat_data *sd;
1487 void stat_validity_clear(struct stat_validity *sv);
1490 * Returns 1 if the path is a regular file (or a symlink to a regular
1491 * file) and matches the saved stat_validity, 0 otherwise. A missing
1492 * or inaccessible file is considered a match if the struct was just
1493 * initialized, or if the previous update found an inaccessible file.
1495 int stat_validity_check(struct stat_validity *sv, const char *path);
1498 * Update the stat_validity from a file opened at descriptor fd. If
1499 * the file is missing, inaccessible, or not a regular file, then
1500 * future calls to stat_validity_check will match iff one of those
1501 * conditions continues to be true.
1503 void stat_validity_update(struct stat_validity *sv, int fd);
1505 int versioncmp(const char *s1, const char *s2);
1507 #endif /* CACHE_H */