t8001/t8002: blame: demonstrate acceptance of bogus -LX,+0 and -LX,-0
[git.git] / cache.h
blob85b544f38d934fe68d1e155c86337f1400eea14d
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hash.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
11 #include SHA1_HEADER
12 #ifndef git_SHA_CTX
13 #define git_SHA_CTX SHA_CTX
14 #define git_SHA1_Init SHA1_Init
15 #define git_SHA1_Update SHA1_Update
16 #define git_SHA1_Final SHA1_Final
17 #endif
19 #include <zlib.h>
20 typedef struct git_zstream {
21 z_stream z;
22 unsigned long avail_in;
23 unsigned long avail_out;
24 unsigned long total_in;
25 unsigned long total_out;
26 unsigned char *next_in;
27 unsigned char *next_out;
28 } git_zstream;
30 void git_inflate_init(git_zstream *);
31 void git_inflate_init_gzip_only(git_zstream *);
32 void git_inflate_end(git_zstream *);
33 int git_inflate(git_zstream *, int flush);
35 void git_deflate_init(git_zstream *, int level);
36 void git_deflate_init_gzip(git_zstream *, int level);
37 void git_deflate_init_raw(git_zstream *, int level);
38 void git_deflate_end(git_zstream *);
39 int git_deflate_abort(git_zstream *);
40 int git_deflate_end_gently(git_zstream *);
41 int git_deflate(git_zstream *, int flush);
42 unsigned long git_deflate_bound(git_zstream *, unsigned long);
44 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
45 #define DTYPE(de) ((de)->d_type)
46 #else
47 #undef DT_UNKNOWN
48 #undef DT_DIR
49 #undef DT_REG
50 #undef DT_LNK
51 #define DT_UNKNOWN 0
52 #define DT_DIR 1
53 #define DT_REG 2
54 #define DT_LNK 3
55 #define DTYPE(de) DT_UNKNOWN
56 #endif
58 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
59 #define S_IFINVALID 0030000
62 * A "directory link" is a link to another git directory.
64 * The value 0160000 is not normally a valid mode, and
65 * also just happens to be S_IFDIR + S_IFLNK
67 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
68 * always having the same values everywhere. We should use
69 * our internal git values for these things, and then we can
70 * translate that to the OS-specific value. It just so
71 * happens that everybody shares the same bit representation
72 * in the UNIX world (and apparently wider too..)
74 #define S_IFGITLINK 0160000
75 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
78 * Intensive research over the course of many years has shown that
79 * port 9418 is totally unused by anything else. Or
81 * Your search - "port 9418" - did not match any documents.
83 * as www.google.com puts it.
85 * This port has been properly assigned for git use by IANA:
86 * git (Assigned-9418) [I06-050728-0001].
88 * git 9418/tcp git pack transfer service
89 * git 9418/udp git pack transfer service
91 * with Linus Torvalds <torvalds@osdl.org> as the point of
92 * contact. September 2005.
94 * See http://www.iana.org/assignments/port-numbers
96 #define DEFAULT_GIT_PORT 9418
99 * Basic data structures for the directory cache
102 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
103 struct cache_header {
104 unsigned int hdr_signature;
105 unsigned int hdr_version;
106 unsigned int hdr_entries;
109 #define INDEX_FORMAT_LB 2
110 #define INDEX_FORMAT_UB 4
113 * The "cache_time" is just the low 32 bits of the
114 * time. It doesn't matter if it overflows - we only
115 * check it for equality in the 32 bits we save.
117 struct cache_time {
118 unsigned int sec;
119 unsigned int nsec;
122 struct stat_data {
123 struct cache_time sd_ctime;
124 struct cache_time sd_mtime;
125 unsigned int sd_dev;
126 unsigned int sd_ino;
127 unsigned int sd_uid;
128 unsigned int sd_gid;
129 unsigned int sd_size;
132 struct cache_entry {
133 struct stat_data ce_stat_data;
134 unsigned int ce_mode;
135 unsigned int ce_flags;
136 unsigned int ce_namelen;
137 unsigned char sha1[20];
138 struct cache_entry *next;
139 char name[FLEX_ARRAY]; /* more */
142 #define CE_STAGEMASK (0x3000)
143 #define CE_EXTENDED (0x4000)
144 #define CE_VALID (0x8000)
145 #define CE_STAGESHIFT 12
148 * Range 0xFFFF0000 in ce_flags is divided into
149 * two parts: in-memory flags and on-disk ones.
150 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
151 * if you want to save a new flag, add it in
152 * CE_EXTENDED_FLAGS
154 * In-memory only flags
156 #define CE_UPDATE (1 << 16)
157 #define CE_REMOVE (1 << 17)
158 #define CE_UPTODATE (1 << 18)
159 #define CE_ADDED (1 << 19)
161 #define CE_HASHED (1 << 20)
162 #define CE_UNHASHED (1 << 21)
163 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
164 #define CE_CONFLICTED (1 << 23)
166 #define CE_UNPACKED (1 << 24)
167 #define CE_NEW_SKIP_WORKTREE (1 << 25)
169 /* used to temporarily mark paths matched by pathspecs */
170 #define CE_MATCHED (1 << 26)
173 * Extended on-disk flags
175 #define CE_INTENT_TO_ADD (1 << 29)
176 #define CE_SKIP_WORKTREE (1 << 30)
177 /* CE_EXTENDED2 is for future extension */
178 #define CE_EXTENDED2 (1 << 31)
180 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
183 * Safeguard to avoid saving wrong flags:
184 * - CE_EXTENDED2 won't get saved until its semantic is known
185 * - Bits in 0x0000FFFF have been saved in ce_flags already
186 * - Bits in 0x003F0000 are currently in-memory flags
188 #if CE_EXTENDED_FLAGS & 0x803FFFFF
189 #error "CE_EXTENDED_FLAGS out of range"
190 #endif
193 * Copy the sha1 and stat state of a cache entry from one to
194 * another. But we never change the name, or the hash state!
196 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
197 static inline void copy_cache_entry(struct cache_entry *dst,
198 const struct cache_entry *src)
200 unsigned int state = dst->ce_flags & CE_STATE_MASK;
202 /* Don't copy hash chain and name */
203 memcpy(dst, src, offsetof(struct cache_entry, next));
205 /* Restore the hash state */
206 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
209 static inline unsigned create_ce_flags(unsigned stage)
211 return (stage << CE_STAGESHIFT);
214 #define ce_namelen(ce) ((ce)->ce_namelen)
215 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
216 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
217 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
218 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
219 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
221 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
222 static inline unsigned int create_ce_mode(unsigned int mode)
224 if (S_ISLNK(mode))
225 return S_IFLNK;
226 if (S_ISDIR(mode) || S_ISGITLINK(mode))
227 return S_IFGITLINK;
228 return S_IFREG | ce_permissions(mode);
230 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
231 unsigned int mode)
233 extern int trust_executable_bit, has_symlinks;
234 if (!has_symlinks && S_ISREG(mode) &&
235 ce && S_ISLNK(ce->ce_mode))
236 return ce->ce_mode;
237 if (!trust_executable_bit && S_ISREG(mode)) {
238 if (ce && S_ISREG(ce->ce_mode))
239 return ce->ce_mode;
240 return create_ce_mode(0666);
242 return create_ce_mode(mode);
244 static inline int ce_to_dtype(const struct cache_entry *ce)
246 unsigned ce_mode = ntohl(ce->ce_mode);
247 if (S_ISREG(ce_mode))
248 return DT_REG;
249 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
250 return DT_DIR;
251 else if (S_ISLNK(ce_mode))
252 return DT_LNK;
253 else
254 return DT_UNKNOWN;
256 static inline unsigned int canon_mode(unsigned int mode)
258 if (S_ISREG(mode))
259 return S_IFREG | ce_permissions(mode);
260 if (S_ISLNK(mode))
261 return S_IFLNK;
262 if (S_ISDIR(mode))
263 return S_IFDIR;
264 return S_IFGITLINK;
267 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
269 struct index_state {
270 struct cache_entry **cache;
271 unsigned int version;
272 unsigned int cache_nr, cache_alloc, cache_changed;
273 struct string_list *resolve_undo;
274 struct cache_tree *cache_tree;
275 struct cache_time timestamp;
276 unsigned name_hash_initialized : 1,
277 initialized : 1;
278 struct hash_table name_hash;
279 struct hash_table dir_hash;
282 extern struct index_state the_index;
284 /* Name hashing */
285 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
286 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
287 extern void free_name_hash(struct index_state *istate);
290 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
291 #define active_cache (the_index.cache)
292 #define active_nr (the_index.cache_nr)
293 #define active_alloc (the_index.cache_alloc)
294 #define active_cache_changed (the_index.cache_changed)
295 #define active_cache_tree (the_index.cache_tree)
297 #define read_cache() read_index(&the_index)
298 #define read_cache_from(path) read_index_from(&the_index, (path))
299 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
300 #define is_cache_unborn() is_index_unborn(&the_index)
301 #define read_cache_unmerged() read_index_unmerged(&the_index)
302 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
303 #define discard_cache() discard_index(&the_index)
304 #define unmerged_cache() unmerged_index(&the_index)
305 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
306 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
307 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
308 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
309 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
310 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
311 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
312 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
313 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
314 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
315 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
316 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
317 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
318 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
319 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
320 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
321 #endif
323 enum object_type {
324 OBJ_BAD = -1,
325 OBJ_NONE = 0,
326 OBJ_COMMIT = 1,
327 OBJ_TREE = 2,
328 OBJ_BLOB = 3,
329 OBJ_TAG = 4,
330 /* 5 for future expansion */
331 OBJ_OFS_DELTA = 6,
332 OBJ_REF_DELTA = 7,
333 OBJ_ANY,
334 OBJ_MAX
337 static inline enum object_type object_type(unsigned int mode)
339 return S_ISDIR(mode) ? OBJ_TREE :
340 S_ISGITLINK(mode) ? OBJ_COMMIT :
341 OBJ_BLOB;
344 /* Double-check local_repo_env below if you add to this list. */
345 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
346 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
347 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
348 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
349 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
350 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
351 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
352 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
353 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
354 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
355 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
356 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
357 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
358 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
359 #define GITATTRIBUTES_FILE ".gitattributes"
360 #define INFOATTRIBUTES_FILE "info/attributes"
361 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
362 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
363 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
364 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
365 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
366 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
367 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
370 * This environment variable is expected to contain a boolean indicating
371 * whether we should or should not treat:
373 * GIT_DIR=foo.git git ...
375 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
376 * of this, but we use it internally to communicate to sub-processes that we
377 * are in a bare repo. If not set, defaults to true.
379 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
382 * Repository-local GIT_* environment variables; these will be cleared
383 * when git spawns a sub-process that runs inside another repository.
384 * The array is NULL-terminated, which makes it easy to pass in the "env"
385 * parameter of a run-command invocation, or to do a simple walk.
387 extern const char * const local_repo_env[];
389 extern int is_bare_repository_cfg;
390 extern int is_bare_repository(void);
391 extern int is_inside_git_dir(void);
392 extern char *git_work_tree_cfg;
393 extern int is_inside_work_tree(void);
394 extern int have_git_dir(void);
395 extern const char *get_git_dir(void);
396 extern int is_git_directory(const char *path);
397 extern char *get_object_directory(void);
398 extern char *get_index_file(void);
399 extern char *get_graft_file(void);
400 extern int set_git_dir(const char *path);
401 extern const char *get_git_namespace(void);
402 extern const char *strip_namespace(const char *namespaced_ref);
403 extern const char *get_git_work_tree(void);
404 extern const char *read_gitfile(const char *path);
405 extern const char *resolve_gitdir(const char *suspect);
406 extern void set_git_work_tree(const char *tree);
408 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
410 extern const char **get_pathspec(const char *prefix, const char **pathspec);
411 extern void setup_work_tree(void);
412 extern const char *setup_git_directory_gently(int *);
413 extern const char *setup_git_directory(void);
414 extern char *prefix_path(const char *prefix, int len, const char *path);
415 extern const char *prefix_filename(const char *prefix, int len, const char *path);
416 extern int check_filename(const char *prefix, const char *name);
417 extern void verify_filename(const char *prefix,
418 const char *name,
419 int diagnose_misspelt_rev);
420 extern void verify_non_filename(const char *prefix, const char *name);
421 extern int path_inside_repo(const char *prefix, const char *path);
423 #define INIT_DB_QUIET 0x0001
425 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
426 extern int init_db(const char *template_dir, unsigned int flags);
428 extern void sanitize_stdfds(void);
430 #define alloc_nr(x) (((x)+16)*3/2)
433 * Realloc the buffer pointed at by variable 'x' so that it can hold
434 * at least 'nr' entries; the number of entries currently allocated
435 * is 'alloc', using the standard growing factor alloc_nr() macro.
437 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
439 #define ALLOC_GROW(x, nr, alloc) \
440 do { \
441 if ((nr) > alloc) { \
442 if (alloc_nr(alloc) < (nr)) \
443 alloc = (nr); \
444 else \
445 alloc = alloc_nr(alloc); \
446 x = xrealloc((x), alloc * sizeof(*(x))); \
448 } while (0)
450 /* Initialize and use the cache information */
451 extern int read_index(struct index_state *);
452 extern int read_index_preload(struct index_state *, const char **pathspec);
453 extern int read_index_from(struct index_state *, const char *path);
454 extern int is_index_unborn(struct index_state *);
455 extern int read_index_unmerged(struct index_state *);
456 extern int write_index(struct index_state *, int newfd);
457 extern int discard_index(struct index_state *);
458 extern int unmerged_index(const struct index_state *);
459 extern int verify_path(const char *path);
460 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
461 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
462 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
463 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
464 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
465 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
466 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
467 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
468 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
469 extern int remove_index_entry_at(struct index_state *, int pos);
470 extern void remove_marked_cache_entries(struct index_state *istate);
471 extern int remove_file_from_index(struct index_state *, const char *path);
472 #define ADD_CACHE_VERBOSE 1
473 #define ADD_CACHE_PRETEND 2
474 #define ADD_CACHE_IGNORE_ERRORS 4
475 #define ADD_CACHE_IGNORE_REMOVAL 8
476 #define ADD_CACHE_INTENT 16
477 #define ADD_CACHE_IMPLICIT_DOT 32 /* internal to "git add -u/-A" */
478 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
479 extern int add_file_to_index(struct index_state *, const char *path, int flags);
480 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
481 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
482 extern int index_name_is_other(const struct index_state *, const char *, int);
483 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
485 /* do stat comparison even if CE_VALID is true */
486 #define CE_MATCH_IGNORE_VALID 01
487 /* do not check the contents but report dirty on racily-clean entries */
488 #define CE_MATCH_RACY_IS_DIRTY 02
489 /* do stat comparison even if CE_SKIP_WORKTREE is true */
490 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
491 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
492 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
494 #define PATHSPEC_ONESTAR 1 /* the pathspec pattern satisfies GFNM_ONESTAR */
496 struct pathspec {
497 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
498 int nr;
499 unsigned int has_wildcard:1;
500 unsigned int recursive:1;
501 int max_depth;
502 struct pathspec_item {
503 const char *match;
504 int len;
505 int nowildcard_len;
506 int flags;
507 } *items;
510 extern int init_pathspec(struct pathspec *, const char **);
511 extern void free_pathspec(struct pathspec *);
512 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
514 extern int limit_pathspec_to_literal(void);
516 #define HASH_WRITE_OBJECT 1
517 #define HASH_FORMAT_CHECK 2
518 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
519 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
522 * Record to sd the data from st that we use to check whether a file
523 * might have changed.
525 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
528 * Return 0 if st is consistent with a file not having been changed
529 * since sd was filled. If there are differences, return a
530 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
531 * INODE_CHANGED, and DATA_CHANGED.
533 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
535 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
537 #define REFRESH_REALLY 0x0001 /* ignore_valid */
538 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
539 #define REFRESH_QUIET 0x0004 /* be quiet about it */
540 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
541 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
542 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
543 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
545 struct lock_file {
546 struct lock_file *next;
547 int fd;
548 pid_t owner;
549 char on_list;
550 char filename[PATH_MAX];
552 #define LOCK_DIE_ON_ERROR 1
553 #define LOCK_NODEREF 2
554 extern int unable_to_lock_error(const char *path, int err);
555 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
556 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
557 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
558 extern int commit_lock_file(struct lock_file *);
559 extern void update_index_if_able(struct index_state *, struct lock_file *);
561 extern int hold_locked_index(struct lock_file *, int);
562 extern int commit_locked_index(struct lock_file *);
563 extern void set_alternate_index_output(const char *);
564 extern int close_lock_file(struct lock_file *);
565 extern void rollback_lock_file(struct lock_file *);
566 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
568 /* Environment bits from configuration mechanism */
569 extern int trust_executable_bit;
570 extern int trust_ctime;
571 extern int check_stat;
572 extern int quote_path_fully;
573 extern int has_symlinks;
574 extern int minimum_abbrev, default_abbrev;
575 extern int ignore_case;
576 extern int assume_unchanged;
577 extern int prefer_symlink_refs;
578 extern int log_all_ref_updates;
579 extern int warn_ambiguous_refs;
580 extern int warn_on_object_refname_ambiguity;
581 extern int shared_repository;
582 extern const char *apply_default_whitespace;
583 extern const char *apply_default_ignorewhitespace;
584 extern const char *git_attributes_file;
585 extern int zlib_compression_level;
586 extern int core_compression_level;
587 extern int core_compression_seen;
588 extern size_t packed_git_window_size;
589 extern size_t packed_git_limit;
590 extern size_t delta_base_cache_limit;
591 extern unsigned long big_file_threshold;
592 extern unsigned long pack_size_limit_cfg;
593 extern int read_replace_refs;
594 extern int fsync_object_files;
595 extern int core_preload_index;
596 extern int core_apply_sparse_checkout;
597 extern int precomposed_unicode;
600 * The character that begins a commented line in user-editable file
601 * that is subject to stripspace.
603 extern char comment_line_char;
605 enum branch_track {
606 BRANCH_TRACK_UNSPECIFIED = -1,
607 BRANCH_TRACK_NEVER = 0,
608 BRANCH_TRACK_REMOTE,
609 BRANCH_TRACK_ALWAYS,
610 BRANCH_TRACK_EXPLICIT,
611 BRANCH_TRACK_OVERRIDE
614 enum rebase_setup_type {
615 AUTOREBASE_NEVER = 0,
616 AUTOREBASE_LOCAL,
617 AUTOREBASE_REMOTE,
618 AUTOREBASE_ALWAYS
621 enum push_default_type {
622 PUSH_DEFAULT_NOTHING = 0,
623 PUSH_DEFAULT_MATCHING,
624 PUSH_DEFAULT_SIMPLE,
625 PUSH_DEFAULT_UPSTREAM,
626 PUSH_DEFAULT_CURRENT,
627 PUSH_DEFAULT_UNSPECIFIED
630 extern enum branch_track git_branch_track;
631 extern enum rebase_setup_type autorebase;
632 extern enum push_default_type push_default;
634 enum object_creation_mode {
635 OBJECT_CREATION_USES_HARDLINKS = 0,
636 OBJECT_CREATION_USES_RENAMES = 1
639 extern enum object_creation_mode object_creation_mode;
641 extern char *notes_ref_name;
643 extern int grafts_replace_parents;
645 #define GIT_REPO_VERSION 0
646 extern int repository_format_version;
647 extern int check_repository_format(void);
649 #define MTIME_CHANGED 0x0001
650 #define CTIME_CHANGED 0x0002
651 #define OWNER_CHANGED 0x0004
652 #define MODE_CHANGED 0x0008
653 #define INODE_CHANGED 0x0010
654 #define DATA_CHANGED 0x0020
655 #define TYPE_CHANGED 0x0040
657 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
658 __attribute__((format (printf, 3, 4)));
659 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
660 __attribute__((format (printf, 3, 4)));
661 extern char *git_pathdup(const char *fmt, ...)
662 __attribute__((format (printf, 1, 2)));
663 extern char *mkpathdup(const char *fmt, ...)
664 __attribute__((format (printf, 1, 2)));
666 /* Return a statically allocated filename matching the sha1 signature */
667 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
668 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
669 extern char *git_path_submodule(const char *path, const char *fmt, ...)
670 __attribute__((format (printf, 2, 3)));
672 extern char *sha1_file_name(const unsigned char *sha1);
673 extern char *sha1_pack_name(const unsigned char *sha1);
674 extern char *sha1_pack_index_name(const unsigned char *sha1);
675 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
676 extern const unsigned char null_sha1[20];
678 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
680 int i;
682 for (i = 0; i < 20; i++, sha1++, sha2++) {
683 if (*sha1 != *sha2)
684 return *sha1 - *sha2;
687 return 0;
690 static inline int is_null_sha1(const unsigned char *sha1)
692 return !hashcmp(sha1, null_sha1);
695 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
697 memcpy(sha_dst, sha_src, 20);
699 static inline void hashclr(unsigned char *hash)
701 memset(hash, 0, 20);
704 #define EMPTY_TREE_SHA1_HEX \
705 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
706 #define EMPTY_TREE_SHA1_BIN_LITERAL \
707 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
708 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
709 #define EMPTY_TREE_SHA1_BIN \
710 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
712 #define EMPTY_BLOB_SHA1_HEX \
713 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
714 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
715 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
716 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
717 #define EMPTY_BLOB_SHA1_BIN \
718 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
720 static inline int is_empty_blob_sha1(const unsigned char *sha1)
722 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
725 int git_mkstemp(char *path, size_t n, const char *template);
727 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
729 /* set default permissions by passing mode arguments to open(2) */
730 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
731 int git_mkstemp_mode(char *pattern, int mode);
734 * NOTE NOTE NOTE!!
736 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
737 * not be changed. Old repositories have core.sharedrepository written in
738 * numeric format, and therefore these values are preserved for compatibility
739 * reasons.
741 enum sharedrepo {
742 PERM_UMASK = 0,
743 OLD_PERM_GROUP = 1,
744 OLD_PERM_EVERYBODY = 2,
745 PERM_GROUP = 0660,
746 PERM_EVERYBODY = 0664
748 int git_config_perm(const char *var, const char *value);
749 int adjust_shared_perm(const char *path);
750 int safe_create_leading_directories(char *path);
751 int safe_create_leading_directories_const(const char *path);
752 int mkdir_in_gitdir(const char *path);
753 extern void home_config_paths(char **global, char **xdg, char *file);
754 extern char *expand_user_path(const char *path);
755 const char *enter_repo(const char *path, int strict);
756 static inline int is_absolute_path(const char *path)
758 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
760 int is_directory(const char *);
761 const char *real_path(const char *path);
762 const char *real_path_if_valid(const char *path);
763 const char *absolute_path(const char *path);
764 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
765 int normalize_path_copy(char *dst, const char *src);
766 int longest_ancestor_length(const char *path, struct string_list *prefixes);
767 char *strip_path_suffix(const char *path, const char *suffix);
768 int daemon_avoid_alias(const char *path);
769 int offset_1st_component(const char *path);
771 /* object replacement */
772 #define READ_SHA1_FILE_REPLACE 1
773 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
774 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
776 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
778 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
779 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
781 if (!read_replace_refs)
782 return sha1;
783 return do_lookup_replace_object(sha1);
786 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
787 extern int sha1_object_info(const unsigned char *, unsigned long *);
788 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
789 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
790 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
791 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
792 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
793 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
794 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
796 /* global flag to enable extra checks when accessing packed objects */
797 extern int do_check_packed_object_crc;
799 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
801 extern int move_temp_to_file(const char *tmpfile, const char *filename);
803 extern int has_sha1_pack(const unsigned char *sha1);
804 extern int has_sha1_file(const unsigned char *sha1);
805 extern int has_loose_object_nonlocal(const unsigned char *sha1);
807 extern int has_pack_index(const unsigned char *sha1);
809 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
811 extern const signed char hexval_table[256];
812 static inline unsigned int hexval(unsigned char c)
814 return hexval_table[c];
817 /* Convert to/from hex/sha1 representation */
818 #define MINIMUM_ABBREV minimum_abbrev
819 #define DEFAULT_ABBREV default_abbrev
821 struct object_context {
822 unsigned char tree[20];
823 char path[PATH_MAX];
824 unsigned mode;
827 #define GET_SHA1_QUIETLY 01
828 #define GET_SHA1_COMMIT 02
829 #define GET_SHA1_COMMITTISH 04
830 #define GET_SHA1_TREE 010
831 #define GET_SHA1_TREEISH 020
832 #define GET_SHA1_BLOB 040
833 #define GET_SHA1_ONLY_TO_DIE 04000
835 extern int get_sha1(const char *str, unsigned char *sha1);
836 extern int get_sha1_commit(const char *str, unsigned char *sha1);
837 extern int get_sha1_committish(const char *str, unsigned char *sha1);
838 extern int get_sha1_tree(const char *str, unsigned char *sha1);
839 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
840 extern int get_sha1_blob(const char *str, unsigned char *sha1);
841 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
842 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
844 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
845 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
848 * Try to read a SHA1 in hexadecimal format from the 40 characters
849 * starting at hex. Write the 20-byte result to sha1 in binary form.
850 * Return 0 on success. Reading stops if a NUL is encountered in the
851 * input, so it is safe to pass this function an arbitrary
852 * null-terminated string.
854 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
856 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
857 extern int read_ref_full(const char *refname, unsigned char *sha1,
858 int reading, int *flags);
859 extern int read_ref(const char *refname, unsigned char *sha1);
862 * Resolve a reference, recursively following symbolic refererences.
864 * Store the referred-to object's name in sha1 and return the name of
865 * the non-symbolic reference that ultimately pointed at it. The
866 * return value, if not NULL, is a pointer into either a static buffer
867 * or the input ref.
869 * If the reference cannot be resolved to an object, the behavior
870 * depends on the "reading" argument:
872 * - If reading is set, return NULL.
874 * - If reading is not set, clear sha1 and return the name of the last
875 * reference name in the chain, which will either be a non-symbolic
876 * reference or an undefined reference. If this is a prelude to
877 * "writing" to the ref, the return value is the name of the ref
878 * that will actually be created or changed.
880 * If flag is non-NULL, set the value that it points to the
881 * combination of REF_ISPACKED (if the reference was found among the
882 * packed references) and REF_ISSYMREF (if the initial reference was a
883 * symbolic reference).
885 * If ref is not a properly-formatted, normalized reference, return
886 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
887 * give up and return NULL.
889 * errno is sometimes set on errors, but not always.
891 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
892 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
894 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
895 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
896 extern int interpret_branch_name(const char *str, struct strbuf *);
897 extern int get_sha1_mb(const char *str, unsigned char *sha1);
899 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
900 extern const char *ref_rev_parse_rules[];
901 #define ref_fetch_rules ref_rev_parse_rules
903 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
904 extern int validate_headref(const char *ref);
906 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
907 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
908 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
909 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
911 extern void *read_object_with_reference(const unsigned char *sha1,
912 const char *required_type,
913 unsigned long *size,
914 unsigned char *sha1_ret);
916 extern struct object *peel_to_type(const char *name, int namelen,
917 struct object *o, enum object_type);
919 enum date_mode {
920 DATE_NORMAL = 0,
921 DATE_RELATIVE,
922 DATE_SHORT,
923 DATE_LOCAL,
924 DATE_ISO8601,
925 DATE_RFC2822,
926 DATE_RAW
929 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
930 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
931 struct strbuf *timebuf);
932 int parse_date(const char *date, char *buf, int bufsize);
933 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
934 int parse_expiry_date(const char *date, unsigned long *timestamp);
935 void datestamp(char *buf, int bufsize);
936 #define approxidate(s) approxidate_careful((s), NULL)
937 unsigned long approxidate_careful(const char *, int *);
938 unsigned long approxidate_relative(const char *date, const struct timeval *now);
939 enum date_mode parse_date_format(const char *format);
941 #define IDENT_STRICT 1
942 #define IDENT_NO_DATE 2
943 #define IDENT_NO_NAME 4
944 extern const char *git_author_info(int);
945 extern const char *git_committer_info(int);
946 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
947 extern const char *fmt_name(const char *name, const char *email);
948 extern const char *ident_default_email(void);
949 extern const char *git_editor(void);
950 extern const char *git_pager(int stdout_is_tty);
951 extern int git_ident_config(const char *, const char *, void *);
953 struct ident_split {
954 const char *name_begin;
955 const char *name_end;
956 const char *mail_begin;
957 const char *mail_end;
958 const char *date_begin;
959 const char *date_end;
960 const char *tz_begin;
961 const char *tz_end;
964 * Signals an success with 0, but time part of the result may be NULL
965 * if the input lacks timestamp and zone
967 extern int split_ident_line(struct ident_split *, const char *, int);
969 struct checkout {
970 const char *base_dir;
971 int base_dir_len;
972 unsigned force:1,
973 quiet:1,
974 not_new:1,
975 refresh_cache:1;
978 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
980 struct cache_def {
981 char path[PATH_MAX + 1];
982 int len;
983 int flags;
984 int track_flags;
985 int prefix_len_stat_func;
988 extern int has_symlink_leading_path(const char *name, int len);
989 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
990 extern int check_leading_path(const char *name, int len);
991 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
992 extern void schedule_dir_for_removal(const char *name, int len);
993 extern void remove_scheduled_dirs(void);
995 extern struct alternate_object_database {
996 struct alternate_object_database *next;
997 char *name;
998 char base[FLEX_ARRAY]; /* more */
999 } *alt_odb_list;
1000 extern void prepare_alt_odb(void);
1001 extern void read_info_alternates(const char * relative_base, int depth);
1002 extern void add_to_alternates_file(const char *reference);
1003 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1004 extern void foreach_alt_odb(alt_odb_fn, void*);
1006 struct pack_window {
1007 struct pack_window *next;
1008 unsigned char *base;
1009 off_t offset;
1010 size_t len;
1011 unsigned int last_used;
1012 unsigned int inuse_cnt;
1015 extern struct packed_git {
1016 struct packed_git *next;
1017 struct pack_window *windows;
1018 off_t pack_size;
1019 const void *index_data;
1020 size_t index_size;
1021 uint32_t num_objects;
1022 uint32_t num_bad_objects;
1023 unsigned char *bad_object_sha1;
1024 int index_version;
1025 time_t mtime;
1026 int pack_fd;
1027 unsigned pack_local:1,
1028 pack_keep:1,
1029 do_not_close:1;
1030 unsigned char sha1[20];
1031 /* something like ".git/objects/pack/xxxxx.pack" */
1032 char pack_name[FLEX_ARRAY]; /* more */
1033 } *packed_git;
1035 struct pack_entry {
1036 off_t offset;
1037 unsigned char sha1[20];
1038 struct packed_git *p;
1041 struct ref {
1042 struct ref *next;
1043 unsigned char old_sha1[20];
1044 unsigned char new_sha1[20];
1045 char *symref;
1046 unsigned int
1047 force:1,
1048 forced_update:1,
1049 deletion:1,
1050 matched:1;
1053 * Order is important here, as we write to FETCH_HEAD
1054 * in numeric order. And the default NOT_FOR_MERGE
1055 * should be 0, so that xcalloc'd structures get it
1056 * by default.
1058 enum {
1059 FETCH_HEAD_MERGE = -1,
1060 FETCH_HEAD_NOT_FOR_MERGE = 0,
1061 FETCH_HEAD_IGNORE = 1
1062 } fetch_head_status;
1064 enum {
1065 REF_STATUS_NONE = 0,
1066 REF_STATUS_OK,
1067 REF_STATUS_REJECT_NONFASTFORWARD,
1068 REF_STATUS_REJECT_ALREADY_EXISTS,
1069 REF_STATUS_REJECT_NODELETE,
1070 REF_STATUS_REJECT_FETCH_FIRST,
1071 REF_STATUS_REJECT_NEEDS_FORCE,
1072 REF_STATUS_UPTODATE,
1073 REF_STATUS_REMOTE_REJECT,
1074 REF_STATUS_EXPECTING_REPORT
1075 } status;
1076 char *remote_status;
1077 struct ref *peer_ref; /* when renaming */
1078 char name[FLEX_ARRAY]; /* more */
1081 #define REF_NORMAL (1u << 0)
1082 #define REF_HEADS (1u << 1)
1083 #define REF_TAGS (1u << 2)
1085 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1087 #define CONNECT_VERBOSE (1u << 0)
1088 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1089 extern int finish_connect(struct child_process *conn);
1090 extern int git_connection_is_socket(struct child_process *conn);
1091 struct extra_have_objects {
1092 int nr, alloc;
1093 unsigned char (*array)[20];
1095 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
1096 struct ref **list, unsigned int flags,
1097 struct extra_have_objects *);
1098 extern int server_supports(const char *feature);
1099 extern int parse_feature_request(const char *features, const char *feature);
1100 extern const char *server_feature_value(const char *feature, int *len_ret);
1101 extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1103 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1105 /* A hook for count-objects to report invalid files in pack directory */
1106 extern void (*report_garbage)(const char *desc, const char *path);
1108 extern void prepare_packed_git(void);
1109 extern void reprepare_packed_git(void);
1110 extern void install_packed_git(struct packed_git *pack);
1112 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1113 struct packed_git *packs);
1115 extern void pack_report(void);
1116 extern int open_pack_index(struct packed_git *);
1117 extern void close_pack_index(struct packed_git *);
1118 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1119 extern void close_pack_windows(struct packed_git *);
1120 extern void unuse_pack(struct pack_window **);
1121 extern void free_pack_by_name(const char *);
1122 extern void clear_delta_base_cache(void);
1123 extern struct packed_git *add_packed_git(const char *, int, int);
1124 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1125 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1126 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1127 extern int is_pack_valid(struct packed_git *);
1128 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1129 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1130 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1131 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1133 struct object_info {
1134 /* Request */
1135 enum object_type *typep;
1136 unsigned long *sizep;
1137 unsigned long *disk_sizep;
1139 /* Response */
1140 enum {
1141 OI_CACHED,
1142 OI_LOOSE,
1143 OI_PACKED,
1144 OI_DBCACHED
1145 } whence;
1146 union {
1148 * struct {
1149 * ... Nothing to expose in this case
1150 * } cached;
1151 * struct {
1152 * ... Nothing to expose in this case
1153 * } loose;
1155 struct {
1156 struct packed_git *pack;
1157 off_t offset;
1158 unsigned int is_delta;
1159 } packed;
1160 } u;
1162 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1164 /* Dumb servers support */
1165 extern int update_server_info(int);
1167 /* git_config_parse_key() returns these negated: */
1168 #define CONFIG_INVALID_KEY 1
1169 #define CONFIG_NO_SECTION_OR_NAME 2
1170 /* git_config_set(), git_config_set_multivar() return the above or these: */
1171 #define CONFIG_NO_LOCK -1
1172 #define CONFIG_INVALID_FILE 3
1173 #define CONFIG_NO_WRITE 4
1174 #define CONFIG_NOTHING_SET 5
1175 #define CONFIG_INVALID_PATTERN 6
1176 #define CONFIG_GENERIC_ERROR 7
1178 typedef int (*config_fn_t)(const char *, const char *, void *);
1179 extern int git_default_config(const char *, const char *, void *);
1180 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1181 extern int git_config_from_buf(config_fn_t fn, const char *name,
1182 const char *buf, size_t len, void *data);
1183 extern void git_config_push_parameter(const char *text);
1184 extern int git_config_from_parameters(config_fn_t fn, void *data);
1185 extern int git_config(config_fn_t fn, void *);
1186 extern int git_config_with_options(config_fn_t fn, void *,
1187 const char *filename,
1188 const char *blob_ref,
1189 int respect_includes);
1190 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1191 extern int git_parse_ulong(const char *, unsigned long *);
1192 extern int git_config_int(const char *, const char *);
1193 extern unsigned long git_config_ulong(const char *, const char *);
1194 extern int git_config_bool_or_int(const char *, const char *, int *);
1195 extern int git_config_bool(const char *, const char *);
1196 extern int git_config_maybe_bool(const char *, const char *);
1197 extern int git_config_string(const char **, const char *, const char *);
1198 extern int git_config_pathname(const char **, const char *, const char *);
1199 extern int git_config_set_in_file(const char *, const char *, const char *);
1200 extern int git_config_set(const char *, const char *);
1201 extern int git_config_parse_key(const char *, char **, int *);
1202 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1203 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1204 extern int git_config_rename_section(const char *, const char *);
1205 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1206 extern const char *git_etc_gitconfig(void);
1207 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1208 extern int git_env_bool(const char *, int);
1209 extern int git_config_system(void);
1210 extern int config_error_nonbool(const char *);
1211 #if defined(__GNUC__) && ! defined(__clang__)
1212 #define config_error_nonbool(s) (config_error_nonbool(s), -1)
1213 #endif
1214 extern const char *get_log_output_encoding(void);
1215 extern const char *get_commit_output_encoding(void);
1217 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1219 struct config_include_data {
1220 int depth;
1221 config_fn_t fn;
1222 void *data;
1224 #define CONFIG_INCLUDE_INIT { 0 }
1225 extern int git_config_include(const char *name, const char *value, void *data);
1228 * Match and parse a config key of the form:
1230 * section.(subsection.)?key
1232 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1233 * we return -1 if it does not match, 0 otherwise. The subsection and key
1234 * out-parameters are filled by the function (and subsection is NULL if it is
1235 * missing).
1237 extern int parse_config_key(const char *var,
1238 const char *section,
1239 const char **subsection, int *subsection_len,
1240 const char **key);
1242 extern int committer_ident_sufficiently_given(void);
1243 extern int author_ident_sufficiently_given(void);
1245 extern const char *git_commit_encoding;
1246 extern const char *git_log_output_encoding;
1247 extern const char *git_mailmap_file;
1248 extern const char *git_mailmap_blob;
1250 /* IO helper functions */
1251 extern void maybe_flush_or_die(FILE *, const char *);
1252 extern int copy_fd(int ifd, int ofd);
1253 extern int copy_file(const char *dst, const char *src, int mode);
1254 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1255 extern void write_or_die(int fd, const void *buf, size_t count);
1256 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1257 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1258 extern void fsync_or_die(int fd, const char *);
1260 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1261 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1262 static inline ssize_t write_str_in_full(int fd, const char *str)
1264 return write_in_full(fd, str, strlen(str));
1267 /* pager.c */
1268 extern void setup_pager(void);
1269 extern const char *pager_program;
1270 extern int pager_in_use(void);
1271 extern int pager_use_color;
1272 extern int term_columns(void);
1273 extern int decimal_width(int);
1274 extern int check_pager_config(const char *cmd);
1276 extern const char *editor_program;
1277 extern const char *askpass_program;
1278 extern const char *excludes_file;
1280 /* base85 */
1281 int decode_85(char *dst, const char *line, int linelen);
1282 void encode_85(char *buf, const unsigned char *data, int bytes);
1284 /* alloc.c */
1285 extern void *alloc_blob_node(void);
1286 extern void *alloc_tree_node(void);
1287 extern void *alloc_commit_node(void);
1288 extern void *alloc_tag_node(void);
1289 extern void *alloc_object_node(void);
1290 extern void alloc_report(void);
1292 /* trace.c */
1293 __attribute__((format (printf, 1, 2)))
1294 extern void trace_printf(const char *format, ...);
1295 __attribute__((format (printf, 2, 3)))
1296 extern void trace_argv_printf(const char **argv, const char *format, ...);
1297 extern void trace_repo_setup(const char *prefix);
1298 extern int trace_want(const char *key);
1299 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1301 void packet_trace_identity(const char *prog);
1303 /* add */
1305 * return 0 if success, 1 - if addition of a file failed and
1306 * ADD_FILES_IGNORE_ERRORS was specified in flags
1308 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1310 /* diff.c */
1311 extern int diff_auto_refresh_index;
1313 /* match-trees.c */
1314 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1315 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1318 * whitespace rules.
1319 * used by both diff and apply
1320 * last two digits are tab width
1322 #define WS_BLANK_AT_EOL 0100
1323 #define WS_SPACE_BEFORE_TAB 0200
1324 #define WS_INDENT_WITH_NON_TAB 0400
1325 #define WS_CR_AT_EOL 01000
1326 #define WS_BLANK_AT_EOF 02000
1327 #define WS_TAB_IN_INDENT 04000
1328 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1329 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1330 #define WS_TAB_WIDTH_MASK 077
1331 extern unsigned whitespace_rule_cfg;
1332 extern unsigned whitespace_rule(const char *);
1333 extern unsigned parse_whitespace_rule(const char *);
1334 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1335 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1336 extern char *whitespace_error_string(unsigned ws);
1337 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1338 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1339 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1341 /* ls-files */
1342 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1343 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1345 char *alias_lookup(const char *alias);
1346 int split_cmdline(char *cmdline, const char ***argv);
1347 /* Takes a negative value returned by split_cmdline */
1348 const char *split_cmdline_strerror(int cmdline_errno);
1350 /* git.c */
1351 struct startup_info {
1352 int have_repository;
1353 const char *prefix;
1355 extern struct startup_info *startup_info;
1357 /* merge.c */
1358 struct commit_list;
1359 int try_merge_command(const char *strategy, size_t xopts_nr,
1360 const char **xopts, struct commit_list *common,
1361 const char *head_arg, struct commit_list *remotes);
1362 int checkout_fast_forward(const unsigned char *from,
1363 const unsigned char *to,
1364 int overwrite_ignore);
1367 int sane_execvp(const char *file, char *const argv[]);
1370 * A struct to encapsulate the concept of whether a file has changed
1371 * since we last checked it. This uses criteria similar to those used
1372 * for the index.
1374 struct stat_validity {
1375 struct stat_data *sd;
1378 void stat_validity_clear(struct stat_validity *sv);
1381 * Returns 1 if the path is a regular file (or a symlink to a regular
1382 * file) and matches the saved stat_validity, 0 otherwise. A missing
1383 * or inaccessible file is considered a match if the struct was just
1384 * initialized, or if the previous update found an inaccessible file.
1386 int stat_validity_check(struct stat_validity *sv, const char *path);
1389 * Update the stat_validity from a file opened at descriptor fd. If
1390 * the file is missing, inaccessible, or not a regular file, then
1391 * future calls to stat_validity_check will match iff one of those
1392 * conditions continues to be true.
1394 void stat_validity_update(struct stat_validity *sv, int fd);
1396 #endif /* CACHE_H */