read-cache.c: move code to copy incore to ondisk cache to a helper function
[git/mjg.git] / cache.h
blob65a7aba158cd5a556038039ea95d540609b67e8e
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_end(git_zstream *);
38 int git_deflate_abort(git_zstream *);
39 int git_deflate_end_gently(git_zstream *);
40 int git_deflate(git_zstream *, int flush);
41 unsigned long git_deflate_bound(git_zstream *, unsigned long);
43 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
44 #define DTYPE(de) ((de)->d_type)
45 #else
46 #undef DT_UNKNOWN
47 #undef DT_DIR
48 #undef DT_REG
49 #undef DT_LNK
50 #define DT_UNKNOWN 0
51 #define DT_DIR 1
52 #define DT_REG 2
53 #define DT_LNK 3
54 #define DTYPE(de) DT_UNKNOWN
55 #endif
57 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
58 #define S_IFINVALID 0030000
61 * A "directory link" is a link to another git directory.
63 * The value 0160000 is not normally a valid mode, and
64 * also just happens to be S_IFDIR + S_IFLNK
66 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
67 * always having the same values everywhere. We should use
68 * our internal git values for these things, and then we can
69 * translate that to the OS-specific value. It just so
70 * happens that everybody shares the same bit representation
71 * in the UNIX world (and apparently wider too..)
73 #define S_IFGITLINK 0160000
74 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
77 * Intensive research over the course of many years has shown that
78 * port 9418 is totally unused by anything else. Or
80 * Your search - "port 9418" - did not match any documents.
82 * as www.google.com puts it.
84 * This port has been properly assigned for git use by IANA:
85 * git (Assigned-9418) [I06-050728-0001].
87 * git 9418/tcp git pack transfer service
88 * git 9418/udp git pack transfer service
90 * with Linus Torvalds <torvalds@osdl.org> as the point of
91 * contact. September 2005.
93 * See http://www.iana.org/assignments/port-numbers
95 #define DEFAULT_GIT_PORT 9418
98 * Basic data structures for the directory cache
101 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
102 struct cache_header {
103 unsigned int hdr_signature;
104 unsigned int hdr_version;
105 unsigned int hdr_entries;
109 * The "cache_time" is just the low 32 bits of the
110 * time. It doesn't matter if it overflows - we only
111 * check it for equality in the 32 bits we save.
113 struct cache_time {
114 unsigned int sec;
115 unsigned int nsec;
118 struct cache_entry {
119 struct cache_time ce_ctime;
120 struct cache_time ce_mtime;
121 unsigned int ce_dev;
122 unsigned int ce_ino;
123 unsigned int ce_mode;
124 unsigned int ce_uid;
125 unsigned int ce_gid;
126 unsigned int ce_size;
127 unsigned int ce_flags;
128 unsigned char sha1[20];
129 struct cache_entry *next;
130 struct cache_entry *dir_next;
131 char name[FLEX_ARRAY]; /* more */
134 #define CE_NAMEMASK (0x0fff)
135 #define CE_STAGEMASK (0x3000)
136 #define CE_EXTENDED (0x4000)
137 #define CE_VALID (0x8000)
138 #define CE_STAGESHIFT 12
141 * Range 0xFFFF0000 in ce_flags is divided into
142 * two parts: in-memory flags and on-disk ones.
143 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
144 * if you want to save a new flag, add it in
145 * CE_EXTENDED_FLAGS
147 * In-memory only flags
149 #define CE_UPDATE (1 << 16)
150 #define CE_REMOVE (1 << 17)
151 #define CE_UPTODATE (1 << 18)
152 #define CE_ADDED (1 << 19)
154 #define CE_HASHED (1 << 20)
155 #define CE_UNHASHED (1 << 21)
156 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
157 #define CE_CONFLICTED (1 << 23)
159 #define CE_UNPACKED (1 << 24)
160 #define CE_NEW_SKIP_WORKTREE (1 << 25)
163 * Extended on-disk flags
165 #define CE_INTENT_TO_ADD (1 << 29)
166 #define CE_SKIP_WORKTREE (1 << 30)
167 /* CE_EXTENDED2 is for future extension */
168 #define CE_EXTENDED2 (1 << 31)
170 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
173 * Safeguard to avoid saving wrong flags:
174 * - CE_EXTENDED2 won't get saved until its semantic is known
175 * - Bits in 0x0000FFFF have been saved in ce_flags already
176 * - Bits in 0x003F0000 are currently in-memory flags
178 #if CE_EXTENDED_FLAGS & 0x803FFFFF
179 #error "CE_EXTENDED_FLAGS out of range"
180 #endif
183 * Copy the sha1 and stat state of a cache entry from one to
184 * another. But we never change the name, or the hash state!
186 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
187 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
189 unsigned int state = dst->ce_flags & CE_STATE_MASK;
191 /* Don't copy hash chain and name */
192 memcpy(dst, src, offsetof(struct cache_entry, next));
194 /* Restore the hash state */
195 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
198 static inline unsigned create_ce_flags(size_t len, unsigned stage)
200 if (len >= CE_NAMEMASK)
201 len = CE_NAMEMASK;
202 return (len | (stage << CE_STAGESHIFT));
205 static inline size_t ce_namelen(const struct cache_entry *ce)
207 size_t len = ce->ce_flags & CE_NAMEMASK;
208 if (len < CE_NAMEMASK)
209 return len;
210 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
213 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
214 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
215 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
216 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
217 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
219 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
220 static inline unsigned int create_ce_mode(unsigned int mode)
222 if (S_ISLNK(mode))
223 return S_IFLNK;
224 if (S_ISDIR(mode) || S_ISGITLINK(mode))
225 return S_IFGITLINK;
226 return S_IFREG | ce_permissions(mode);
228 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
230 extern int trust_executable_bit, has_symlinks;
231 if (!has_symlinks && S_ISREG(mode) &&
232 ce && S_ISLNK(ce->ce_mode))
233 return ce->ce_mode;
234 if (!trust_executable_bit && S_ISREG(mode)) {
235 if (ce && S_ISREG(ce->ce_mode))
236 return ce->ce_mode;
237 return create_ce_mode(0666);
239 return create_ce_mode(mode);
241 static inline int ce_to_dtype(const struct cache_entry *ce)
243 unsigned ce_mode = ntohl(ce->ce_mode);
244 if (S_ISREG(ce_mode))
245 return DT_REG;
246 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
247 return DT_DIR;
248 else if (S_ISLNK(ce_mode))
249 return DT_LNK;
250 else
251 return DT_UNKNOWN;
253 static inline unsigned int canon_mode(unsigned int mode)
255 if (S_ISREG(mode))
256 return S_IFREG | ce_permissions(mode);
257 if (S_ISLNK(mode))
258 return S_IFLNK;
259 if (S_ISDIR(mode))
260 return S_IFDIR;
261 return S_IFGITLINK;
264 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
266 struct index_state {
267 struct cache_entry **cache;
268 unsigned int cache_nr, cache_alloc, cache_changed;
269 struct string_list *resolve_undo;
270 struct cache_tree *cache_tree;
271 struct cache_time timestamp;
272 unsigned name_hash_initialized : 1,
273 initialized : 1;
274 struct hash_table name_hash;
277 extern struct index_state the_index;
279 /* Name hashing */
280 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
282 * We don't actually *remove* it, we can just mark it invalid so that
283 * we won't find it in lookups.
285 * Not only would we have to search the lists (simple enough), but
286 * we'd also have to rehash other hash buckets in case this makes the
287 * hash bucket empty (common). So it's much better to just mark
288 * it.
290 static inline void remove_name_hash(struct cache_entry *ce)
292 ce->ce_flags |= CE_UNHASHED;
296 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
297 #define active_cache (the_index.cache)
298 #define active_nr (the_index.cache_nr)
299 #define active_alloc (the_index.cache_alloc)
300 #define active_cache_changed (the_index.cache_changed)
301 #define active_cache_tree (the_index.cache_tree)
303 #define read_cache() read_index(&the_index)
304 #define read_cache_from(path) read_index_from(&the_index, (path))
305 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
306 #define is_cache_unborn() is_index_unborn(&the_index)
307 #define read_cache_unmerged() read_index_unmerged(&the_index)
308 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
309 #define discard_cache() discard_index(&the_index)
310 #define unmerged_cache() unmerged_index(&the_index)
311 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
312 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
313 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
314 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
315 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
316 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
317 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
318 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
319 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
320 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
321 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
322 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
323 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
324 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
325 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
326 #endif
328 enum object_type {
329 OBJ_BAD = -1,
330 OBJ_NONE = 0,
331 OBJ_COMMIT = 1,
332 OBJ_TREE = 2,
333 OBJ_BLOB = 3,
334 OBJ_TAG = 4,
335 /* 5 for future expansion */
336 OBJ_OFS_DELTA = 6,
337 OBJ_REF_DELTA = 7,
338 OBJ_ANY,
339 OBJ_MAX
342 static inline enum object_type object_type(unsigned int mode)
344 return S_ISDIR(mode) ? OBJ_TREE :
345 S_ISGITLINK(mode) ? OBJ_COMMIT :
346 OBJ_BLOB;
349 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
350 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
351 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
352 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
353 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
354 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
355 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
356 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
357 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
358 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
359 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
360 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
361 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
362 #define GITATTRIBUTES_FILE ".gitattributes"
363 #define INFOATTRIBUTES_FILE "info/attributes"
364 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
365 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
366 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
367 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
368 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
369 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
372 * Repository-local GIT_* environment variables
373 * The array is NULL-terminated to simplify its usage in contexts such
374 * environment creation or simple walk of the list.
375 * The number of non-NULL entries is available as a macro.
377 #define LOCAL_REPO_ENV_SIZE 9
378 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
380 extern int is_bare_repository_cfg;
381 extern int is_bare_repository(void);
382 extern int is_inside_git_dir(void);
383 extern char *git_work_tree_cfg;
384 extern int is_inside_work_tree(void);
385 extern int have_git_dir(void);
386 extern const char *get_git_dir(void);
387 extern int is_git_directory(const char *path);
388 extern char *get_object_directory(void);
389 extern char *get_index_file(void);
390 extern char *get_graft_file(void);
391 extern int set_git_dir(const char *path);
392 extern const char *get_git_namespace(void);
393 extern const char *strip_namespace(const char *namespaced_ref);
394 extern const char *get_git_work_tree(void);
395 extern const char *read_gitfile(const char *path);
396 extern const char *resolve_gitdir(const char *suspect);
397 extern void set_git_work_tree(const char *tree);
399 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
401 extern const char **get_pathspec(const char *prefix, const char **pathspec);
402 extern void setup_work_tree(void);
403 extern const char *setup_git_directory_gently(int *);
404 extern const char *setup_git_directory(void);
405 extern char *prefix_path(const char *prefix, int len, const char *path);
406 extern const char *prefix_filename(const char *prefix, int len, const char *path);
407 extern int check_filename(const char *prefix, const char *name);
408 extern void verify_filename(const char *prefix, const char *name);
409 extern void verify_non_filename(const char *prefix, const char *name);
411 #define INIT_DB_QUIET 0x0001
413 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
414 extern int init_db(const char *template_dir, unsigned int flags);
416 #define alloc_nr(x) (((x)+16)*3/2)
419 * Realloc the buffer pointed at by variable 'x' so that it can hold
420 * at least 'nr' entries; the number of entries currently allocated
421 * is 'alloc', using the standard growing factor alloc_nr() macro.
423 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
425 #define ALLOC_GROW(x, nr, alloc) \
426 do { \
427 if ((nr) > alloc) { \
428 if (alloc_nr(alloc) < (nr)) \
429 alloc = (nr); \
430 else \
431 alloc = alloc_nr(alloc); \
432 x = xrealloc((x), alloc * sizeof(*(x))); \
434 } while (0)
436 /* Initialize and use the cache information */
437 extern int read_index(struct index_state *);
438 extern int read_index_preload(struct index_state *, const char **pathspec);
439 extern int read_index_from(struct index_state *, const char *path);
440 extern int is_index_unborn(struct index_state *);
441 extern int read_index_unmerged(struct index_state *);
442 extern int write_index(struct index_state *, int newfd);
443 extern int discard_index(struct index_state *);
444 extern int unmerged_index(const struct index_state *);
445 extern int verify_path(const char *path);
446 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
447 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
448 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
449 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
450 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
451 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
452 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
453 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
454 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
455 extern int remove_index_entry_at(struct index_state *, int pos);
456 extern void remove_marked_cache_entries(struct index_state *istate);
457 extern int remove_file_from_index(struct index_state *, const char *path);
458 #define ADD_CACHE_VERBOSE 1
459 #define ADD_CACHE_PRETEND 2
460 #define ADD_CACHE_IGNORE_ERRORS 4
461 #define ADD_CACHE_IGNORE_REMOVAL 8
462 #define ADD_CACHE_INTENT 16
463 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
464 extern int add_file_to_index(struct index_state *, const char *path, int flags);
465 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
466 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
467 extern int index_name_is_other(const struct index_state *, const char *, int);
469 /* do stat comparison even if CE_VALID is true */
470 #define CE_MATCH_IGNORE_VALID 01
471 /* do not check the contents but report dirty on racily-clean entries */
472 #define CE_MATCH_RACY_IS_DIRTY 02
473 /* do stat comparison even if CE_SKIP_WORKTREE is true */
474 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
475 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
476 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
478 struct pathspec {
479 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
480 int nr;
481 unsigned int has_wildcard:1;
482 unsigned int recursive:1;
483 int max_depth;
484 struct pathspec_item {
485 const char *match;
486 int len;
487 unsigned int use_wildcard:1;
488 } *items;
491 extern int init_pathspec(struct pathspec *, const char **);
492 extern void free_pathspec(struct pathspec *);
493 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
495 #define HASH_WRITE_OBJECT 1
496 #define HASH_FORMAT_CHECK 2
497 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
498 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
499 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
501 #define REFRESH_REALLY 0x0001 /* ignore_valid */
502 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
503 #define REFRESH_QUIET 0x0004 /* be quiet about it */
504 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
505 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
506 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
507 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
509 struct lock_file {
510 struct lock_file *next;
511 int fd;
512 pid_t owner;
513 char on_list;
514 char filename[PATH_MAX];
516 #define LOCK_DIE_ON_ERROR 1
517 #define LOCK_NODEREF 2
518 extern int unable_to_lock_error(const char *path, int err);
519 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
520 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
521 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
522 extern int commit_lock_file(struct lock_file *);
523 extern void update_index_if_able(struct index_state *, struct lock_file *);
525 extern int hold_locked_index(struct lock_file *, int);
526 extern int commit_locked_index(struct lock_file *);
527 extern void set_alternate_index_output(const char *);
528 extern int close_lock_file(struct lock_file *);
529 extern void rollback_lock_file(struct lock_file *);
530 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
532 /* Environment bits from configuration mechanism */
533 extern int trust_executable_bit;
534 extern int trust_ctime;
535 extern int quote_path_fully;
536 extern int has_symlinks;
537 extern int minimum_abbrev, default_abbrev;
538 extern int ignore_case;
539 extern int assume_unchanged;
540 extern int prefer_symlink_refs;
541 extern int log_all_ref_updates;
542 extern int warn_ambiguous_refs;
543 extern int shared_repository;
544 extern const char *apply_default_whitespace;
545 extern const char *apply_default_ignorewhitespace;
546 extern const char *git_attributes_file;
547 extern int zlib_compression_level;
548 extern int core_compression_level;
549 extern int core_compression_seen;
550 extern size_t packed_git_window_size;
551 extern size_t packed_git_limit;
552 extern size_t delta_base_cache_limit;
553 extern unsigned long big_file_threshold;
554 extern unsigned long pack_size_limit_cfg;
555 extern int read_replace_refs;
556 extern int fsync_object_files;
557 extern int core_preload_index;
558 extern int core_apply_sparse_checkout;
560 enum branch_track {
561 BRANCH_TRACK_UNSPECIFIED = -1,
562 BRANCH_TRACK_NEVER = 0,
563 BRANCH_TRACK_REMOTE,
564 BRANCH_TRACK_ALWAYS,
565 BRANCH_TRACK_EXPLICIT,
566 BRANCH_TRACK_OVERRIDE
569 enum rebase_setup_type {
570 AUTOREBASE_NEVER = 0,
571 AUTOREBASE_LOCAL,
572 AUTOREBASE_REMOTE,
573 AUTOREBASE_ALWAYS
576 enum push_default_type {
577 PUSH_DEFAULT_NOTHING = 0,
578 PUSH_DEFAULT_MATCHING,
579 PUSH_DEFAULT_UPSTREAM,
580 PUSH_DEFAULT_CURRENT
583 extern enum branch_track git_branch_track;
584 extern enum rebase_setup_type autorebase;
585 extern enum push_default_type push_default;
587 enum object_creation_mode {
588 OBJECT_CREATION_USES_HARDLINKS = 0,
589 OBJECT_CREATION_USES_RENAMES = 1
592 extern enum object_creation_mode object_creation_mode;
594 extern char *notes_ref_name;
596 extern int grafts_replace_parents;
598 #define GIT_REPO_VERSION 0
599 extern int repository_format_version;
600 extern int check_repository_format(void);
602 #define MTIME_CHANGED 0x0001
603 #define CTIME_CHANGED 0x0002
604 #define OWNER_CHANGED 0x0004
605 #define MODE_CHANGED 0x0008
606 #define INODE_CHANGED 0x0010
607 #define DATA_CHANGED 0x0020
608 #define TYPE_CHANGED 0x0040
610 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
611 __attribute__((format (printf, 3, 4)));
612 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
613 __attribute__((format (printf, 3, 4)));
614 extern char *git_pathdup(const char *fmt, ...)
615 __attribute__((format (printf, 1, 2)));
617 /* Return a statically allocated filename matching the sha1 signature */
618 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
619 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
620 extern char *git_path_submodule(const char *path, const char *fmt, ...)
621 __attribute__((format (printf, 2, 3)));
623 extern char *sha1_file_name(const unsigned char *sha1);
624 extern char *sha1_pack_name(const unsigned char *sha1);
625 extern char *sha1_pack_index_name(const unsigned char *sha1);
626 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
627 extern const unsigned char null_sha1[20];
629 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
631 int i;
633 for (i = 0; i < 20; i++, sha1++, sha2++) {
634 if (*sha1 != *sha2)
635 return *sha1 - *sha2;
638 return 0;
641 static inline int is_null_sha1(const unsigned char *sha1)
643 return !hashcmp(sha1, null_sha1);
646 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
648 memcpy(sha_dst, sha_src, 20);
650 static inline void hashclr(unsigned char *hash)
652 memset(hash, 0, 20);
655 #define EMPTY_TREE_SHA1_HEX \
656 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
657 #define EMPTY_TREE_SHA1_BIN_LITERAL \
658 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
659 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
660 #define EMPTY_TREE_SHA1_BIN \
661 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
663 int git_mkstemp(char *path, size_t n, const char *template);
665 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
667 /* set default permissions by passing mode arguments to open(2) */
668 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
669 int git_mkstemp_mode(char *pattern, int mode);
672 * NOTE NOTE NOTE!!
674 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
675 * not be changed. Old repositories have core.sharedrepository written in
676 * numeric format, and therefore these values are preserved for compatibility
677 * reasons.
679 enum sharedrepo {
680 PERM_UMASK = 0,
681 OLD_PERM_GROUP = 1,
682 OLD_PERM_EVERYBODY = 2,
683 PERM_GROUP = 0660,
684 PERM_EVERYBODY = 0664
686 int git_config_perm(const char *var, const char *value);
687 int set_shared_perm(const char *path, int mode);
688 #define adjust_shared_perm(path) set_shared_perm((path), 0)
689 int safe_create_leading_directories(char *path);
690 int safe_create_leading_directories_const(const char *path);
691 int mkdir_in_gitdir(const char *path);
692 extern char *expand_user_path(const char *path);
693 const char *enter_repo(const char *path, int strict);
694 static inline int is_absolute_path(const char *path)
696 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
698 int is_directory(const char *);
699 const char *real_path(const char *path);
700 const char *absolute_path(const char *path);
701 const char *relative_path(const char *abs, const char *base);
702 int normalize_path_copy(char *dst, const char *src);
703 int longest_ancestor_length(const char *path, const char *prefix_list);
704 char *strip_path_suffix(const char *path, const char *suffix);
705 int daemon_avoid_alias(const char *path);
706 int offset_1st_component(const char *path);
708 /* object replacement */
709 #define READ_SHA1_FILE_REPLACE 1
710 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
711 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
713 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
715 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
716 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
718 if (!read_replace_refs)
719 return sha1;
720 return do_lookup_replace_object(sha1);
723 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
724 extern int sha1_object_info(const unsigned char *, unsigned long *);
725 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
726 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
727 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
728 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
729 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
730 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
731 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
733 /* global flag to enable extra checks when accessing packed objects */
734 extern int do_check_packed_object_crc;
736 /* for development: log offset of pack access */
737 extern const char *log_pack_access;
739 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
741 extern int move_temp_to_file(const char *tmpfile, const char *filename);
743 extern int has_sha1_pack(const unsigned char *sha1);
744 extern int has_sha1_file(const unsigned char *sha1);
745 extern int has_loose_object_nonlocal(const unsigned char *sha1);
747 extern int has_pack_index(const unsigned char *sha1);
749 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
751 extern const signed char hexval_table[256];
752 static inline unsigned int hexval(unsigned char c)
754 return hexval_table[c];
757 /* Convert to/from hex/sha1 representation */
758 #define MINIMUM_ABBREV minimum_abbrev
759 #define DEFAULT_ABBREV default_abbrev
761 struct object_context {
762 unsigned char tree[20];
763 char path[PATH_MAX];
764 unsigned mode;
767 extern int get_sha1(const char *str, unsigned char *sha1);
768 extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int only_to_die, const char *prefix);
769 static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
771 return get_sha1_with_mode_1(str, sha1, mode, 0, NULL);
773 extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int only_to_die, const char *prefix);
774 static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
776 return get_sha1_with_context_1(str, sha1, orc, 0, NULL);
780 * Try to read a SHA1 in hexadecimal format from the 40 characters
781 * starting at hex. Write the 20-byte result to sha1 in binary form.
782 * Return 0 on success. Reading stops if a NUL is encountered in the
783 * input, so it is safe to pass this function an arbitrary
784 * null-terminated string.
786 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
788 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
789 extern int read_ref_full(const char *refname, unsigned char *sha1,
790 int reading, int *flags);
791 extern int read_ref(const char *refname, unsigned char *sha1);
794 * Resolve a reference, recursively following symbolic refererences.
796 * Store the referred-to object's name in sha1 and return the name of
797 * the non-symbolic reference that ultimately pointed at it. The
798 * return value, if not NULL, is a pointer into either a static buffer
799 * or the input ref.
801 * If the reference cannot be resolved to an object, the behavior
802 * depends on the "reading" argument:
804 * - If reading is set, return NULL.
806 * - If reading is not set, clear sha1 and return the name of the last
807 * reference name in the chain, which will either be a non-symbolic
808 * reference or an undefined reference. If this is a prelude to
809 * "writing" to the ref, the return value is the name of the ref
810 * that will actually be created or changed.
812 * If flag is non-NULL, set the value that it points to the
813 * combination of REF_ISPACKED (if the reference was found among the
814 * packed references) and REF_ISSYMREF (if the initial reference was a
815 * symbolic reference).
817 * If ref is not a properly-formatted, normalized reference, return
818 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
819 * give up and return NULL.
821 * errno is sometimes set on errors, but not always.
823 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
824 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
826 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
827 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
828 extern int interpret_branch_name(const char *str, struct strbuf *);
829 extern int get_sha1_mb(const char *str, unsigned char *sha1);
831 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
832 extern const char *ref_rev_parse_rules[];
833 #define ref_fetch_rules ref_rev_parse_rules
835 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
836 extern int validate_headref(const char *ref);
838 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
839 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
840 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
842 extern void *read_object_with_reference(const unsigned char *sha1,
843 const char *required_type,
844 unsigned long *size,
845 unsigned char *sha1_ret);
847 extern struct object *peel_to_type(const char *name, int namelen,
848 struct object *o, enum object_type);
850 enum date_mode {
851 DATE_NORMAL = 0,
852 DATE_RELATIVE,
853 DATE_SHORT,
854 DATE_LOCAL,
855 DATE_ISO8601,
856 DATE_RFC2822,
857 DATE_RAW
860 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
861 const char *show_date_relative(unsigned long time, int tz,
862 const struct timeval *now,
863 char *timebuf,
864 size_t timebuf_size);
865 int parse_date(const char *date, char *buf, int bufsize);
866 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
867 void datestamp(char *buf, int bufsize);
868 #define approxidate(s) approxidate_careful((s), NULL)
869 unsigned long approxidate_careful(const char *, int *);
870 unsigned long approxidate_relative(const char *date, const struct timeval *now);
871 enum date_mode parse_date_format(const char *format);
873 #define IDENT_WARN_ON_NO_NAME 1
874 #define IDENT_ERROR_ON_NO_NAME 2
875 #define IDENT_NO_DATE 4
876 extern const char *git_author_info(int);
877 extern const char *git_committer_info(int);
878 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
879 extern const char *fmt_name(const char *name, const char *email);
880 extern const char *git_editor(void);
881 extern const char *git_pager(int stdout_is_tty);
883 struct checkout {
884 const char *base_dir;
885 int base_dir_len;
886 unsigned force:1,
887 quiet:1,
888 not_new:1,
889 refresh_cache:1;
892 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
894 struct cache_def {
895 char path[PATH_MAX + 1];
896 int len;
897 int flags;
898 int track_flags;
899 int prefix_len_stat_func;
902 extern int has_symlink_leading_path(const char *name, int len);
903 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
904 extern int check_leading_path(const char *name, int len);
905 extern int threaded_check_leading_path(struct cache_def *cache, const char *name, int len);
906 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
907 extern int threaded_has_dirs_only_path(struct cache_def *cache, const char *name, int len, int prefix_len);
908 extern void schedule_dir_for_removal(const char *name, int len);
909 extern void remove_scheduled_dirs(void);
911 extern struct alternate_object_database {
912 struct alternate_object_database *next;
913 char *name;
914 char base[FLEX_ARRAY]; /* more */
915 } *alt_odb_list;
916 extern void prepare_alt_odb(void);
917 extern void add_to_alternates_file(const char *reference);
918 typedef int alt_odb_fn(struct alternate_object_database *, void *);
919 extern void foreach_alt_odb(alt_odb_fn, void*);
921 struct pack_window {
922 struct pack_window *next;
923 unsigned char *base;
924 off_t offset;
925 size_t len;
926 unsigned int last_used;
927 unsigned int inuse_cnt;
930 extern struct packed_git {
931 struct packed_git *next;
932 struct pack_window *windows;
933 off_t pack_size;
934 const void *index_data;
935 size_t index_size;
936 uint32_t num_objects;
937 uint32_t num_bad_objects;
938 unsigned char *bad_object_sha1;
939 int index_version;
940 time_t mtime;
941 int pack_fd;
942 unsigned pack_local:1,
943 pack_keep:1,
944 do_not_close:1;
945 unsigned char sha1[20];
946 /* something like ".git/objects/pack/xxxxx.pack" */
947 char pack_name[FLEX_ARRAY]; /* more */
948 } *packed_git;
950 struct pack_entry {
951 off_t offset;
952 unsigned char sha1[20];
953 struct packed_git *p;
956 struct ref {
957 struct ref *next;
958 unsigned char old_sha1[20];
959 unsigned char new_sha1[20];
960 char *symref;
961 unsigned int force:1,
962 merge:1,
963 nonfastforward:1,
964 deletion:1;
965 enum {
966 REF_STATUS_NONE = 0,
967 REF_STATUS_OK,
968 REF_STATUS_REJECT_NONFASTFORWARD,
969 REF_STATUS_REJECT_NODELETE,
970 REF_STATUS_UPTODATE,
971 REF_STATUS_REMOTE_REJECT,
972 REF_STATUS_EXPECTING_REPORT
973 } status;
974 char *remote_status;
975 struct ref *peer_ref; /* when renaming */
976 char name[FLEX_ARRAY]; /* more */
979 #define REF_NORMAL (1u << 0)
980 #define REF_HEADS (1u << 1)
981 #define REF_TAGS (1u << 2)
983 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
985 #define CONNECT_VERBOSE (1u << 0)
986 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
987 extern int finish_connect(struct child_process *conn);
988 extern int git_connection_is_socket(struct child_process *conn);
989 struct extra_have_objects {
990 int nr, alloc;
991 unsigned char (*array)[20];
993 extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
994 extern int server_supports(const char *feature);
995 extern const char *parse_feature_request(const char *features, const char *feature);
997 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
999 extern void prepare_packed_git(void);
1000 extern void reprepare_packed_git(void);
1001 extern void install_packed_git(struct packed_git *pack);
1003 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1004 struct packed_git *packs);
1006 extern void pack_report(void);
1007 extern int open_pack_index(struct packed_git *);
1008 extern void close_pack_index(struct packed_git *);
1009 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1010 extern void close_pack_windows(struct packed_git *);
1011 extern void unuse_pack(struct pack_window **);
1012 extern void free_pack_by_name(const char *);
1013 extern void clear_delta_base_cache(void);
1014 extern struct packed_git *add_packed_git(const char *, int, int);
1015 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1016 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1017 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1018 extern int is_pack_valid(struct packed_git *);
1019 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1020 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1021 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1022 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1024 struct object_info {
1025 /* Request */
1026 unsigned long *sizep;
1028 /* Response */
1029 enum {
1030 OI_CACHED,
1031 OI_LOOSE,
1032 OI_PACKED,
1033 OI_DBCACHED
1034 } whence;
1035 union {
1037 * struct {
1038 * ... Nothing to expose in this case
1039 * } cached;
1040 * struct {
1041 * ... Nothing to expose in this case
1042 * } loose;
1044 struct {
1045 struct packed_git *pack;
1046 off_t offset;
1047 unsigned int is_delta;
1048 } packed;
1049 } u;
1051 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1053 /* Dumb servers support */
1054 extern int update_server_info(int);
1056 /* git_config_parse_key() returns these negated: */
1057 #define CONFIG_INVALID_KEY 1
1058 #define CONFIG_NO_SECTION_OR_NAME 2
1059 /* git_config_set(), git_config_set_multivar() return the above or these: */
1060 #define CONFIG_NO_LOCK -1
1061 #define CONFIG_INVALID_FILE 3
1062 #define CONFIG_NO_WRITE 4
1063 #define CONFIG_NOTHING_SET 5
1064 #define CONFIG_INVALID_PATTERN 6
1066 typedef int (*config_fn_t)(const char *, const char *, void *);
1067 extern int git_default_config(const char *, const char *, void *);
1068 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1069 extern void git_config_push_parameter(const char *text);
1070 extern int git_config_from_parameters(config_fn_t fn, void *data);
1071 extern int git_config(config_fn_t fn, void *);
1072 extern int git_config_with_options(config_fn_t fn, void *,
1073 const char *filename, int respect_includes);
1074 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1075 extern int git_parse_ulong(const char *, unsigned long *);
1076 extern int git_config_int(const char *, const char *);
1077 extern unsigned long git_config_ulong(const char *, const char *);
1078 extern int git_config_bool_or_int(const char *, const char *, int *);
1079 extern int git_config_bool(const char *, const char *);
1080 extern int git_config_maybe_bool(const char *, const char *);
1081 extern int git_config_string(const char **, const char *, const char *);
1082 extern int git_config_pathname(const char **, const char *, const char *);
1083 extern int git_config_set_in_file(const char *, const char *, const char *);
1084 extern int git_config_set(const char *, const char *);
1085 extern int git_config_parse_key(const char *, char **, int *);
1086 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1087 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1088 extern int git_config_rename_section(const char *, const char *);
1089 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1090 extern const char *git_etc_gitconfig(void);
1091 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1092 extern int git_env_bool(const char *, int);
1093 extern int git_config_system(void);
1094 extern int config_error_nonbool(const char *);
1095 extern const char *get_log_output_encoding(void);
1096 extern const char *get_commit_output_encoding(void);
1098 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1100 struct config_include_data {
1101 int depth;
1102 config_fn_t fn;
1103 void *data;
1105 #define CONFIG_INCLUDE_INIT { 0 }
1106 extern int git_config_include(const char *name, const char *value, void *data);
1108 #define MAX_GITNAME (1000)
1109 extern char git_default_email[MAX_GITNAME];
1110 extern char git_default_name[MAX_GITNAME];
1111 #define IDENT_NAME_GIVEN 01
1112 #define IDENT_MAIL_GIVEN 02
1113 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1114 extern int user_ident_explicitly_given;
1115 extern int user_ident_sufficiently_given(void);
1117 extern const char *git_commit_encoding;
1118 extern const char *git_log_output_encoding;
1119 extern const char *git_mailmap_file;
1121 /* IO helper functions */
1122 extern void maybe_flush_or_die(FILE *, const char *);
1123 extern int copy_fd(int ifd, int ofd);
1124 extern int copy_file(const char *dst, const char *src, int mode);
1125 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1126 extern void write_or_die(int fd, const void *buf, size_t count);
1127 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1128 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1129 extern void fsync_or_die(int fd, const char *);
1131 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1132 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1133 static inline ssize_t write_str_in_full(int fd, const char *str)
1135 return write_in_full(fd, str, strlen(str));
1138 /* pager.c */
1139 extern void setup_pager(void);
1140 extern const char *pager_program;
1141 extern int pager_in_use(void);
1142 extern int pager_use_color;
1143 extern int term_columns(void);
1144 extern int decimal_width(int);
1146 extern const char *editor_program;
1147 extern const char *askpass_program;
1148 extern const char *excludes_file;
1150 /* base85 */
1151 int decode_85(char *dst, const char *line, int linelen);
1152 void encode_85(char *buf, const unsigned char *data, int bytes);
1154 /* alloc.c */
1155 extern void *alloc_blob_node(void);
1156 extern void *alloc_tree_node(void);
1157 extern void *alloc_commit_node(void);
1158 extern void *alloc_tag_node(void);
1159 extern void *alloc_object_node(void);
1160 extern void alloc_report(void);
1162 /* trace.c */
1163 __attribute__((format (printf, 1, 2)))
1164 extern void trace_printf(const char *format, ...);
1165 extern void trace_vprintf(const char *key, const char *format, va_list ap);
1166 __attribute__((format (printf, 2, 3)))
1167 extern void trace_argv_printf(const char **argv, const char *format, ...);
1168 extern void trace_repo_setup(const char *prefix);
1169 extern int trace_want(const char *key);
1170 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1172 void packet_trace_identity(const char *prog);
1174 /* add */
1176 * return 0 if success, 1 - if addition of a file failed and
1177 * ADD_FILES_IGNORE_ERRORS was specified in flags
1179 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1181 /* diff.c */
1182 extern int diff_auto_refresh_index;
1184 /* match-trees.c */
1185 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1186 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1189 * whitespace rules.
1190 * used by both diff and apply
1191 * last two digits are tab width
1193 #define WS_BLANK_AT_EOL 0100
1194 #define WS_SPACE_BEFORE_TAB 0200
1195 #define WS_INDENT_WITH_NON_TAB 0400
1196 #define WS_CR_AT_EOL 01000
1197 #define WS_BLANK_AT_EOF 02000
1198 #define WS_TAB_IN_INDENT 04000
1199 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1200 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1201 #define WS_TAB_WIDTH_MASK 077
1202 extern unsigned whitespace_rule_cfg;
1203 extern unsigned whitespace_rule(const char *);
1204 extern unsigned parse_whitespace_rule(const char *);
1205 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1206 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1207 extern char *whitespace_error_string(unsigned ws);
1208 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1209 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1210 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1212 /* ls-files */
1213 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1214 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1216 char *alias_lookup(const char *alias);
1217 int split_cmdline(char *cmdline, const char ***argv);
1218 /* Takes a negative value returned by split_cmdline */
1219 const char *split_cmdline_strerror(int cmdline_errno);
1221 /* git.c */
1222 struct startup_info {
1223 int have_repository;
1224 const char *prefix;
1226 extern struct startup_info *startup_info;
1228 /* builtin/merge.c */
1229 int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1231 #endif /* CACHE_H */