Update draft release notes for 1.8.1
[git.git] / cache.h
blobdbd8018b5827ce40fd72ac0ba84934551a11f225
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;
108 #define INDEX_FORMAT_LB 2
109 #define INDEX_FORMAT_UB 4
112 * The "cache_time" is just the low 32 bits of the
113 * time. It doesn't matter if it overflows - we only
114 * check it for equality in the 32 bits we save.
116 struct cache_time {
117 unsigned int sec;
118 unsigned int nsec;
121 struct cache_entry {
122 struct cache_time ce_ctime;
123 struct cache_time ce_mtime;
124 unsigned int ce_dev;
125 unsigned int ce_ino;
126 unsigned int ce_mode;
127 unsigned int ce_uid;
128 unsigned int ce_gid;
129 unsigned int ce_size;
130 unsigned int ce_flags;
131 unsigned int ce_namelen;
132 unsigned char sha1[20];
133 struct cache_entry *next;
134 struct cache_entry *dir_next;
135 char name[FLEX_ARRAY]; /* more */
138 #define CE_STAGEMASK (0x3000)
139 #define CE_EXTENDED (0x4000)
140 #define CE_VALID (0x8000)
141 #define CE_STAGESHIFT 12
144 * Range 0xFFFF0000 in ce_flags is divided into
145 * two parts: in-memory flags and on-disk ones.
146 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
147 * if you want to save a new flag, add it in
148 * CE_EXTENDED_FLAGS
150 * In-memory only flags
152 #define CE_UPDATE (1 << 16)
153 #define CE_REMOVE (1 << 17)
154 #define CE_UPTODATE (1 << 18)
155 #define CE_ADDED (1 << 19)
157 #define CE_HASHED (1 << 20)
158 #define CE_UNHASHED (1 << 21)
159 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
160 #define CE_CONFLICTED (1 << 23)
162 #define CE_UNPACKED (1 << 24)
163 #define CE_NEW_SKIP_WORKTREE (1 << 25)
166 * Extended on-disk flags
168 #define CE_INTENT_TO_ADD (1 << 29)
169 #define CE_SKIP_WORKTREE (1 << 30)
170 /* CE_EXTENDED2 is for future extension */
171 #define CE_EXTENDED2 (1 << 31)
173 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
176 * Safeguard to avoid saving wrong flags:
177 * - CE_EXTENDED2 won't get saved until its semantic is known
178 * - Bits in 0x0000FFFF have been saved in ce_flags already
179 * - Bits in 0x003F0000 are currently in-memory flags
181 #if CE_EXTENDED_FLAGS & 0x803FFFFF
182 #error "CE_EXTENDED_FLAGS out of range"
183 #endif
186 * Copy the sha1 and stat state of a cache entry from one to
187 * another. But we never change the name, or the hash state!
189 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
190 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
192 unsigned int state = dst->ce_flags & CE_STATE_MASK;
194 /* Don't copy hash chain and name */
195 memcpy(dst, src, offsetof(struct cache_entry, next));
197 /* Restore the hash state */
198 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
201 static inline unsigned create_ce_flags(unsigned stage)
203 return (stage << CE_STAGESHIFT);
206 #define ce_namelen(ce) ((ce)->ce_namelen)
207 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
208 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
209 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
210 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
211 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
213 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
214 static inline unsigned int create_ce_mode(unsigned int mode)
216 if (S_ISLNK(mode))
217 return S_IFLNK;
218 if (S_ISDIR(mode) || S_ISGITLINK(mode))
219 return S_IFGITLINK;
220 return S_IFREG | ce_permissions(mode);
222 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
224 extern int trust_executable_bit, has_symlinks;
225 if (!has_symlinks && S_ISREG(mode) &&
226 ce && S_ISLNK(ce->ce_mode))
227 return ce->ce_mode;
228 if (!trust_executable_bit && S_ISREG(mode)) {
229 if (ce && S_ISREG(ce->ce_mode))
230 return ce->ce_mode;
231 return create_ce_mode(0666);
233 return create_ce_mode(mode);
235 static inline int ce_to_dtype(const struct cache_entry *ce)
237 unsigned ce_mode = ntohl(ce->ce_mode);
238 if (S_ISREG(ce_mode))
239 return DT_REG;
240 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
241 return DT_DIR;
242 else if (S_ISLNK(ce_mode))
243 return DT_LNK;
244 else
245 return DT_UNKNOWN;
247 static inline unsigned int canon_mode(unsigned int mode)
249 if (S_ISREG(mode))
250 return S_IFREG | ce_permissions(mode);
251 if (S_ISLNK(mode))
252 return S_IFLNK;
253 if (S_ISDIR(mode))
254 return S_IFDIR;
255 return S_IFGITLINK;
258 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
260 struct index_state {
261 struct cache_entry **cache;
262 unsigned int version;
263 unsigned int cache_nr, cache_alloc, cache_changed;
264 struct string_list *resolve_undo;
265 struct cache_tree *cache_tree;
266 struct cache_time timestamp;
267 unsigned name_hash_initialized : 1,
268 initialized : 1;
269 struct hash_table name_hash;
272 extern struct index_state the_index;
274 /* Name hashing */
275 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
277 * We don't actually *remove* it, we can just mark it invalid so that
278 * we won't find it in lookups.
280 * Not only would we have to search the lists (simple enough), but
281 * we'd also have to rehash other hash buckets in case this makes the
282 * hash bucket empty (common). So it's much better to just mark
283 * it.
285 static inline void remove_name_hash(struct cache_entry *ce)
287 ce->ce_flags |= CE_UNHASHED;
291 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
292 #define active_cache (the_index.cache)
293 #define active_nr (the_index.cache_nr)
294 #define active_alloc (the_index.cache_alloc)
295 #define active_cache_changed (the_index.cache_changed)
296 #define active_cache_tree (the_index.cache_tree)
298 #define read_cache() read_index(&the_index)
299 #define read_cache_from(path) read_index_from(&the_index, (path))
300 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
301 #define is_cache_unborn() is_index_unborn(&the_index)
302 #define read_cache_unmerged() read_index_unmerged(&the_index)
303 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
304 #define discard_cache() discard_index(&the_index)
305 #define unmerged_cache() unmerged_index(&the_index)
306 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
307 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
308 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
309 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
310 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
311 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
312 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
313 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
314 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
315 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
316 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
317 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
318 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
319 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
320 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
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 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
345 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
346 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
347 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
348 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
349 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
350 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
351 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
352 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
353 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
354 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
355 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
356 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
357 #define GITATTRIBUTES_FILE ".gitattributes"
358 #define INFOATTRIBUTES_FILE "info/attributes"
359 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
360 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
361 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
362 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
363 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
364 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
367 * Repository-local GIT_* environment variables
368 * The array is NULL-terminated to simplify its usage in contexts such
369 * environment creation or simple walk of the list.
370 * The number of non-NULL entries is available as a macro.
372 #define LOCAL_REPO_ENV_SIZE 9
373 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
375 extern int is_bare_repository_cfg;
376 extern int is_bare_repository(void);
377 extern int is_inside_git_dir(void);
378 extern char *git_work_tree_cfg;
379 extern int is_inside_work_tree(void);
380 extern int have_git_dir(void);
381 extern const char *get_git_dir(void);
382 extern int is_git_directory(const char *path);
383 extern char *get_object_directory(void);
384 extern char *get_index_file(void);
385 extern char *get_graft_file(void);
386 extern int set_git_dir(const char *path);
387 extern const char *get_git_namespace(void);
388 extern const char *strip_namespace(const char *namespaced_ref);
389 extern const char *get_git_work_tree(void);
390 extern const char *read_gitfile(const char *path);
391 extern const char *resolve_gitdir(const char *suspect);
392 extern void set_git_work_tree(const char *tree);
394 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
396 extern const char **get_pathspec(const char *prefix, const char **pathspec);
397 extern void setup_work_tree(void);
398 extern const char *setup_git_directory_gently(int *);
399 extern const char *setup_git_directory(void);
400 extern char *prefix_path(const char *prefix, int len, const char *path);
401 extern const char *prefix_filename(const char *prefix, int len, const char *path);
402 extern int check_filename(const char *prefix, const char *name);
403 extern void verify_filename(const char *prefix,
404 const char *name,
405 int diagnose_misspelt_rev);
406 extern void verify_non_filename(const char *prefix, const char *name);
407 extern int path_inside_repo(const char *prefix, const char *path);
409 #define INIT_DB_QUIET 0x0001
411 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
412 extern int init_db(const char *template_dir, unsigned int flags);
414 #define alloc_nr(x) (((x)+16)*3/2)
417 * Realloc the buffer pointed at by variable 'x' so that it can hold
418 * at least 'nr' entries; the number of entries currently allocated
419 * is 'alloc', using the standard growing factor alloc_nr() macro.
421 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
423 #define ALLOC_GROW(x, nr, alloc) \
424 do { \
425 if ((nr) > alloc) { \
426 if (alloc_nr(alloc) < (nr)) \
427 alloc = (nr); \
428 else \
429 alloc = alloc_nr(alloc); \
430 x = xrealloc((x), alloc * sizeof(*(x))); \
432 } while (0)
434 /* Initialize and use the cache information */
435 extern int read_index(struct index_state *);
436 extern int read_index_preload(struct index_state *, const char **pathspec);
437 extern int read_index_from(struct index_state *, const char *path);
438 extern int is_index_unborn(struct index_state *);
439 extern int read_index_unmerged(struct index_state *);
440 extern int write_index(struct index_state *, int newfd);
441 extern int discard_index(struct index_state *);
442 extern int unmerged_index(const struct index_state *);
443 extern int verify_path(const char *path);
444 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
445 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
446 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
447 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
448 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
449 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
450 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
451 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
452 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
453 extern int remove_index_entry_at(struct index_state *, int pos);
454 extern void remove_marked_cache_entries(struct index_state *istate);
455 extern int remove_file_from_index(struct index_state *, const char *path);
456 #define ADD_CACHE_VERBOSE 1
457 #define ADD_CACHE_PRETEND 2
458 #define ADD_CACHE_IGNORE_ERRORS 4
459 #define ADD_CACHE_IGNORE_REMOVAL 8
460 #define ADD_CACHE_INTENT 16
461 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
462 extern int add_file_to_index(struct index_state *, const char *path, int flags);
463 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
464 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
465 extern int index_name_is_other(const struct index_state *, const char *, int);
467 /* do stat comparison even if CE_VALID is true */
468 #define CE_MATCH_IGNORE_VALID 01
469 /* do not check the contents but report dirty on racily-clean entries */
470 #define CE_MATCH_RACY_IS_DIRTY 02
471 /* do stat comparison even if CE_SKIP_WORKTREE is true */
472 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
473 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
474 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
476 struct pathspec {
477 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
478 int nr;
479 unsigned int has_wildcard:1;
480 unsigned int recursive:1;
481 int max_depth;
482 struct pathspec_item {
483 const char *match;
484 int len;
485 unsigned int use_wildcard:1;
486 } *items;
489 extern int init_pathspec(struct pathspec *, const char **);
490 extern void free_pathspec(struct pathspec *);
491 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
493 #define HASH_WRITE_OBJECT 1
494 #define HASH_FORMAT_CHECK 2
495 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
496 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
497 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
499 #define REFRESH_REALLY 0x0001 /* ignore_valid */
500 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
501 #define REFRESH_QUIET 0x0004 /* be quiet about it */
502 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
503 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
504 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
505 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
507 struct lock_file {
508 struct lock_file *next;
509 int fd;
510 pid_t owner;
511 char on_list;
512 char filename[PATH_MAX];
514 #define LOCK_DIE_ON_ERROR 1
515 #define LOCK_NODEREF 2
516 extern int unable_to_lock_error(const char *path, int err);
517 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
518 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
519 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
520 extern int commit_lock_file(struct lock_file *);
521 extern void update_index_if_able(struct index_state *, struct lock_file *);
523 extern int hold_locked_index(struct lock_file *, int);
524 extern int commit_locked_index(struct lock_file *);
525 extern void set_alternate_index_output(const char *);
526 extern int close_lock_file(struct lock_file *);
527 extern void rollback_lock_file(struct lock_file *);
528 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
530 /* Environment bits from configuration mechanism */
531 extern int trust_executable_bit;
532 extern int trust_ctime;
533 extern int quote_path_fully;
534 extern int has_symlinks;
535 extern int minimum_abbrev, default_abbrev;
536 extern int ignore_case;
537 extern int assume_unchanged;
538 extern int prefer_symlink_refs;
539 extern int log_all_ref_updates;
540 extern int warn_ambiguous_refs;
541 extern int shared_repository;
542 extern const char *apply_default_whitespace;
543 extern const char *apply_default_ignorewhitespace;
544 extern const char *git_attributes_file;
545 extern int zlib_compression_level;
546 extern int core_compression_level;
547 extern int core_compression_seen;
548 extern size_t packed_git_window_size;
549 extern size_t packed_git_limit;
550 extern size_t delta_base_cache_limit;
551 extern unsigned long big_file_threshold;
552 extern unsigned long pack_size_limit_cfg;
553 extern int read_replace_refs;
554 extern int fsync_object_files;
555 extern int core_preload_index;
556 extern int core_apply_sparse_checkout;
557 extern int precomposed_unicode;
559 enum branch_track {
560 BRANCH_TRACK_UNSPECIFIED = -1,
561 BRANCH_TRACK_NEVER = 0,
562 BRANCH_TRACK_REMOTE,
563 BRANCH_TRACK_ALWAYS,
564 BRANCH_TRACK_EXPLICIT,
565 BRANCH_TRACK_OVERRIDE
568 enum rebase_setup_type {
569 AUTOREBASE_NEVER = 0,
570 AUTOREBASE_LOCAL,
571 AUTOREBASE_REMOTE,
572 AUTOREBASE_ALWAYS
575 enum push_default_type {
576 PUSH_DEFAULT_NOTHING = 0,
577 PUSH_DEFAULT_MATCHING,
578 PUSH_DEFAULT_SIMPLE,
579 PUSH_DEFAULT_UPSTREAM,
580 PUSH_DEFAULT_CURRENT,
581 PUSH_DEFAULT_UNSPECIFIED
584 extern enum branch_track git_branch_track;
585 extern enum rebase_setup_type autorebase;
586 extern enum push_default_type push_default;
588 enum object_creation_mode {
589 OBJECT_CREATION_USES_HARDLINKS = 0,
590 OBJECT_CREATION_USES_RENAMES = 1
593 extern enum object_creation_mode object_creation_mode;
595 extern char *notes_ref_name;
597 extern int grafts_replace_parents;
599 #define GIT_REPO_VERSION 0
600 extern int repository_format_version;
601 extern int check_repository_format(void);
603 #define MTIME_CHANGED 0x0001
604 #define CTIME_CHANGED 0x0002
605 #define OWNER_CHANGED 0x0004
606 #define MODE_CHANGED 0x0008
607 #define INODE_CHANGED 0x0010
608 #define DATA_CHANGED 0x0020
609 #define TYPE_CHANGED 0x0040
611 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
612 __attribute__((format (printf, 3, 4)));
613 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
614 __attribute__((format (printf, 3, 4)));
615 extern char *git_pathdup(const char *fmt, ...)
616 __attribute__((format (printf, 1, 2)));
617 extern char *mkpathdup(const char *fmt, ...)
618 __attribute__((format (printf, 1, 2)));
620 /* Return a statically allocated filename matching the sha1 signature */
621 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
622 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
623 extern char *git_path_submodule(const char *path, const char *fmt, ...)
624 __attribute__((format (printf, 2, 3)));
626 extern char *sha1_file_name(const unsigned char *sha1);
627 extern char *sha1_pack_name(const unsigned char *sha1);
628 extern char *sha1_pack_index_name(const unsigned char *sha1);
629 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
630 extern const unsigned char null_sha1[20];
632 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
634 int i;
636 for (i = 0; i < 20; i++, sha1++, sha2++) {
637 if (*sha1 != *sha2)
638 return *sha1 - *sha2;
641 return 0;
644 static inline int is_null_sha1(const unsigned char *sha1)
646 return !hashcmp(sha1, null_sha1);
649 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
651 memcpy(sha_dst, sha_src, 20);
653 static inline void hashclr(unsigned char *hash)
655 memset(hash, 0, 20);
658 #define EMPTY_TREE_SHA1_HEX \
659 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
660 #define EMPTY_TREE_SHA1_BIN_LITERAL \
661 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
662 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
663 #define EMPTY_TREE_SHA1_BIN \
664 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
666 #define EMPTY_BLOB_SHA1_HEX \
667 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
668 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
669 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
670 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
671 #define EMPTY_BLOB_SHA1_BIN \
672 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
674 static inline int is_empty_blob_sha1(const unsigned char *sha1)
676 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
679 int git_mkstemp(char *path, size_t n, const char *template);
681 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
683 /* set default permissions by passing mode arguments to open(2) */
684 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
685 int git_mkstemp_mode(char *pattern, int mode);
688 * NOTE NOTE NOTE!!
690 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
691 * not be changed. Old repositories have core.sharedrepository written in
692 * numeric format, and therefore these values are preserved for compatibility
693 * reasons.
695 enum sharedrepo {
696 PERM_UMASK = 0,
697 OLD_PERM_GROUP = 1,
698 OLD_PERM_EVERYBODY = 2,
699 PERM_GROUP = 0660,
700 PERM_EVERYBODY = 0664
702 int git_config_perm(const char *var, const char *value);
703 int set_shared_perm(const char *path, int mode);
704 #define adjust_shared_perm(path) set_shared_perm((path), 0)
705 int safe_create_leading_directories(char *path);
706 int safe_create_leading_directories_const(const char *path);
707 int mkdir_in_gitdir(const char *path);
708 extern void home_config_paths(char **global, char **xdg, char *file);
709 extern char *expand_user_path(const char *path);
710 const char *enter_repo(const char *path, int strict);
711 static inline int is_absolute_path(const char *path)
713 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
715 int is_directory(const char *);
716 const char *real_path(const char *path);
717 const char *absolute_path(const char *path);
718 const char *relative_path(const char *abs, const char *base);
719 int normalize_path_copy(char *dst, const char *src);
720 int longest_ancestor_length(const char *path, const char *prefix_list);
721 char *strip_path_suffix(const char *path, const char *suffix);
722 int daemon_avoid_alias(const char *path);
723 int offset_1st_component(const char *path);
725 /* object replacement */
726 #define READ_SHA1_FILE_REPLACE 1
727 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
728 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
730 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
732 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
733 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
735 if (!read_replace_refs)
736 return sha1;
737 return do_lookup_replace_object(sha1);
740 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
741 extern int sha1_object_info(const unsigned char *, unsigned long *);
742 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
743 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
744 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
745 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
746 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
747 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
748 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
750 /* global flag to enable extra checks when accessing packed objects */
751 extern int do_check_packed_object_crc;
753 /* for development: log offset of pack access */
754 extern const char *log_pack_access;
756 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
758 extern int move_temp_to_file(const char *tmpfile, const char *filename);
760 extern int has_sha1_pack(const unsigned char *sha1);
761 extern int has_sha1_file(const unsigned char *sha1);
762 extern int has_loose_object_nonlocal(const unsigned char *sha1);
764 extern int has_pack_index(const unsigned char *sha1);
766 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
768 extern const signed char hexval_table[256];
769 static inline unsigned int hexval(unsigned char c)
771 return hexval_table[c];
774 /* Convert to/from hex/sha1 representation */
775 #define MINIMUM_ABBREV minimum_abbrev
776 #define DEFAULT_ABBREV default_abbrev
778 struct object_context {
779 unsigned char tree[20];
780 char path[PATH_MAX];
781 unsigned mode;
784 #define GET_SHA1_QUIETLY 01
785 #define GET_SHA1_COMMIT 02
786 #define GET_SHA1_COMMITTISH 04
787 #define GET_SHA1_TREE 010
788 #define GET_SHA1_TREEISH 020
789 #define GET_SHA1_BLOB 040
790 #define GET_SHA1_ONLY_TO_DIE 04000
792 extern int get_sha1(const char *str, unsigned char *sha1);
793 extern int get_sha1_commit(const char *str, unsigned char *sha1);
794 extern int get_sha1_committish(const char *str, unsigned char *sha1);
795 extern int get_sha1_tree(const char *str, unsigned char *sha1);
796 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
797 extern int get_sha1_blob(const char *str, unsigned char *sha1);
798 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
799 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
801 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
802 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
805 * Try to read a SHA1 in hexadecimal format from the 40 characters
806 * starting at hex. Write the 20-byte result to sha1 in binary form.
807 * Return 0 on success. Reading stops if a NUL is encountered in the
808 * input, so it is safe to pass this function an arbitrary
809 * null-terminated string.
811 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
813 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
814 extern int read_ref_full(const char *refname, unsigned char *sha1,
815 int reading, int *flags);
816 extern int read_ref(const char *refname, unsigned char *sha1);
819 * Resolve a reference, recursively following symbolic refererences.
821 * Store the referred-to object's name in sha1 and return the name of
822 * the non-symbolic reference that ultimately pointed at it. The
823 * return value, if not NULL, is a pointer into either a static buffer
824 * or the input ref.
826 * If the reference cannot be resolved to an object, the behavior
827 * depends on the "reading" argument:
829 * - If reading is set, return NULL.
831 * - If reading is not set, clear sha1 and return the name of the last
832 * reference name in the chain, which will either be a non-symbolic
833 * reference or an undefined reference. If this is a prelude to
834 * "writing" to the ref, the return value is the name of the ref
835 * that will actually be created or changed.
837 * If flag is non-NULL, set the value that it points to the
838 * combination of REF_ISPACKED (if the reference was found among the
839 * packed references) and REF_ISSYMREF (if the initial reference was a
840 * symbolic reference).
842 * If ref is not a properly-formatted, normalized reference, return
843 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
844 * give up and return NULL.
846 * errno is sometimes set on errors, but not always.
848 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
849 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
851 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
852 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
853 extern int interpret_branch_name(const char *str, struct strbuf *);
854 extern int get_sha1_mb(const char *str, unsigned char *sha1);
856 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
857 extern const char *ref_rev_parse_rules[];
858 #define ref_fetch_rules ref_rev_parse_rules
860 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
861 extern int validate_headref(const char *ref);
863 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
864 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
865 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
866 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
868 extern void *read_object_with_reference(const unsigned char *sha1,
869 const char *required_type,
870 unsigned long *size,
871 unsigned char *sha1_ret);
873 extern struct object *peel_to_type(const char *name, int namelen,
874 struct object *o, enum object_type);
876 enum date_mode {
877 DATE_NORMAL = 0,
878 DATE_RELATIVE,
879 DATE_SHORT,
880 DATE_LOCAL,
881 DATE_ISO8601,
882 DATE_RFC2822,
883 DATE_RAW
886 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
887 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
888 struct strbuf *timebuf);
889 int parse_date(const char *date, char *buf, int bufsize);
890 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
891 void datestamp(char *buf, int bufsize);
892 #define approxidate(s) approxidate_careful((s), NULL)
893 unsigned long approxidate_careful(const char *, int *);
894 unsigned long approxidate_relative(const char *date, const struct timeval *now);
895 enum date_mode parse_date_format(const char *format);
897 #define IDENT_STRICT 1
898 #define IDENT_NO_DATE 2
899 #define IDENT_NO_NAME 4
900 extern const char *git_author_info(int);
901 extern const char *git_committer_info(int);
902 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
903 extern const char *fmt_name(const char *name, const char *email);
904 extern const char *ident_default_email(void);
905 extern const char *git_editor(void);
906 extern const char *git_pager(int stdout_is_tty);
907 extern int git_ident_config(const char *, const char *, void *);
909 struct ident_split {
910 const char *name_begin;
911 const char *name_end;
912 const char *mail_begin;
913 const char *mail_end;
914 const char *date_begin;
915 const char *date_end;
916 const char *tz_begin;
917 const char *tz_end;
920 * Signals an success with 0, but time part of the result may be NULL
921 * if the input lacks timestamp and zone
923 extern int split_ident_line(struct ident_split *, const char *, int);
925 struct checkout {
926 const char *base_dir;
927 int base_dir_len;
928 unsigned force:1,
929 quiet:1,
930 not_new:1,
931 refresh_cache:1;
934 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
936 struct cache_def {
937 char path[PATH_MAX + 1];
938 int len;
939 int flags;
940 int track_flags;
941 int prefix_len_stat_func;
944 extern int has_symlink_leading_path(const char *name, int len);
945 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
946 extern int check_leading_path(const char *name, int len);
947 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
948 extern void schedule_dir_for_removal(const char *name, int len);
949 extern void remove_scheduled_dirs(void);
951 extern struct alternate_object_database {
952 struct alternate_object_database *next;
953 char *name;
954 char base[FLEX_ARRAY]; /* more */
955 } *alt_odb_list;
956 extern void prepare_alt_odb(void);
957 extern void read_info_alternates(const char * relative_base, int depth);
958 extern void add_to_alternates_file(const char *reference);
959 typedef int alt_odb_fn(struct alternate_object_database *, void *);
960 extern void foreach_alt_odb(alt_odb_fn, void*);
962 struct pack_window {
963 struct pack_window *next;
964 unsigned char *base;
965 off_t offset;
966 size_t len;
967 unsigned int last_used;
968 unsigned int inuse_cnt;
971 extern struct packed_git {
972 struct packed_git *next;
973 struct pack_window *windows;
974 off_t pack_size;
975 const void *index_data;
976 size_t index_size;
977 uint32_t num_objects;
978 uint32_t num_bad_objects;
979 unsigned char *bad_object_sha1;
980 int index_version;
981 time_t mtime;
982 int pack_fd;
983 unsigned pack_local:1,
984 pack_keep:1,
985 do_not_close:1;
986 unsigned char sha1[20];
987 /* something like ".git/objects/pack/xxxxx.pack" */
988 char pack_name[FLEX_ARRAY]; /* more */
989 } *packed_git;
991 struct pack_entry {
992 off_t offset;
993 unsigned char sha1[20];
994 struct packed_git *p;
997 struct ref {
998 struct ref *next;
999 unsigned char old_sha1[20];
1000 unsigned char new_sha1[20];
1001 char *symref;
1002 unsigned int force:1,
1003 merge:1,
1004 nonfastforward:1,
1005 deletion:1;
1006 enum {
1007 REF_STATUS_NONE = 0,
1008 REF_STATUS_OK,
1009 REF_STATUS_REJECT_NONFASTFORWARD,
1010 REF_STATUS_REJECT_NODELETE,
1011 REF_STATUS_UPTODATE,
1012 REF_STATUS_REMOTE_REJECT,
1013 REF_STATUS_EXPECTING_REPORT
1014 } status;
1015 char *remote_status;
1016 struct ref *peer_ref; /* when renaming */
1017 char name[FLEX_ARRAY]; /* more */
1020 #define REF_NORMAL (1u << 0)
1021 #define REF_HEADS (1u << 1)
1022 #define REF_TAGS (1u << 2)
1024 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1026 #define CONNECT_VERBOSE (1u << 0)
1027 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1028 extern int finish_connect(struct child_process *conn);
1029 extern int git_connection_is_socket(struct child_process *conn);
1030 struct extra_have_objects {
1031 int nr, alloc;
1032 unsigned char (*array)[20];
1034 extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
1035 extern int server_supports(const char *feature);
1036 extern int parse_feature_request(const char *features, const char *feature);
1037 extern const char *server_feature_value(const char *feature, int *len_ret);
1038 extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1040 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1042 extern void prepare_packed_git(void);
1043 extern void reprepare_packed_git(void);
1044 extern void install_packed_git(struct packed_git *pack);
1046 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1047 struct packed_git *packs);
1049 extern void pack_report(void);
1050 extern int open_pack_index(struct packed_git *);
1051 extern void close_pack_index(struct packed_git *);
1052 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1053 extern void close_pack_windows(struct packed_git *);
1054 extern void unuse_pack(struct pack_window **);
1055 extern void free_pack_by_name(const char *);
1056 extern void clear_delta_base_cache(void);
1057 extern struct packed_git *add_packed_git(const char *, int, int);
1058 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1059 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1060 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1061 extern int is_pack_valid(struct packed_git *);
1062 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1063 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1064 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1065 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1067 struct object_info {
1068 /* Request */
1069 unsigned long *sizep;
1071 /* Response */
1072 enum {
1073 OI_CACHED,
1074 OI_LOOSE,
1075 OI_PACKED,
1076 OI_DBCACHED
1077 } whence;
1078 union {
1080 * struct {
1081 * ... Nothing to expose in this case
1082 * } cached;
1083 * struct {
1084 * ... Nothing to expose in this case
1085 * } loose;
1087 struct {
1088 struct packed_git *pack;
1089 off_t offset;
1090 unsigned int is_delta;
1091 } packed;
1092 } u;
1094 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1096 /* Dumb servers support */
1097 extern int update_server_info(int);
1099 /* git_config_parse_key() returns these negated: */
1100 #define CONFIG_INVALID_KEY 1
1101 #define CONFIG_NO_SECTION_OR_NAME 2
1102 /* git_config_set(), git_config_set_multivar() return the above or these: */
1103 #define CONFIG_NO_LOCK -1
1104 #define CONFIG_INVALID_FILE 3
1105 #define CONFIG_NO_WRITE 4
1106 #define CONFIG_NOTHING_SET 5
1107 #define CONFIG_INVALID_PATTERN 6
1108 #define CONFIG_GENERIC_ERROR 7
1110 typedef int (*config_fn_t)(const char *, const char *, void *);
1111 extern int git_default_config(const char *, const char *, void *);
1112 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1113 extern void git_config_push_parameter(const char *text);
1114 extern int git_config_from_parameters(config_fn_t fn, void *data);
1115 extern int git_config(config_fn_t fn, void *);
1116 extern int git_config_with_options(config_fn_t fn, void *,
1117 const char *filename, int respect_includes);
1118 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1119 extern int git_parse_ulong(const char *, unsigned long *);
1120 extern int git_config_int(const char *, const char *);
1121 extern unsigned long git_config_ulong(const char *, const char *);
1122 extern int git_config_bool_or_int(const char *, const char *, int *);
1123 extern int git_config_bool(const char *, const char *);
1124 extern int git_config_maybe_bool(const char *, const char *);
1125 extern int git_config_string(const char **, const char *, const char *);
1126 extern int git_config_pathname(const char **, const char *, const char *);
1127 extern int git_config_set_in_file(const char *, const char *, const char *);
1128 extern int git_config_set(const char *, const char *);
1129 extern int git_config_parse_key(const char *, char **, int *);
1130 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1131 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1132 extern int git_config_rename_section(const char *, const char *);
1133 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1134 extern const char *git_etc_gitconfig(void);
1135 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1136 extern int git_env_bool(const char *, int);
1137 extern int git_config_system(void);
1138 extern int config_error_nonbool(const char *);
1139 extern const char *get_log_output_encoding(void);
1140 extern const char *get_commit_output_encoding(void);
1142 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1144 struct config_include_data {
1145 int depth;
1146 config_fn_t fn;
1147 void *data;
1149 #define CONFIG_INCLUDE_INIT { 0 }
1150 extern int git_config_include(const char *name, const char *value, void *data);
1152 #define IDENT_NAME_GIVEN 01
1153 #define IDENT_MAIL_GIVEN 02
1154 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1155 extern int user_ident_explicitly_given;
1156 extern int user_ident_sufficiently_given(void);
1158 extern const char *git_commit_encoding;
1159 extern const char *git_log_output_encoding;
1160 extern const char *git_mailmap_file;
1162 /* IO helper functions */
1163 extern void maybe_flush_or_die(FILE *, const char *);
1164 extern int copy_fd(int ifd, int ofd);
1165 extern int copy_file(const char *dst, const char *src, int mode);
1166 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1167 extern void write_or_die(int fd, const void *buf, size_t count);
1168 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1169 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1170 extern void fsync_or_die(int fd, const char *);
1172 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1173 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1174 static inline ssize_t write_str_in_full(int fd, const char *str)
1176 return write_in_full(fd, str, strlen(str));
1179 /* pager.c */
1180 extern void setup_pager(void);
1181 extern const char *pager_program;
1182 extern int pager_in_use(void);
1183 extern int pager_use_color;
1184 extern int term_columns(void);
1185 extern int decimal_width(int);
1186 extern int check_pager_config(const char *cmd);
1188 extern const char *editor_program;
1189 extern const char *askpass_program;
1190 extern const char *excludes_file;
1192 /* base85 */
1193 int decode_85(char *dst, const char *line, int linelen);
1194 void encode_85(char *buf, const unsigned char *data, int bytes);
1196 /* alloc.c */
1197 extern void *alloc_blob_node(void);
1198 extern void *alloc_tree_node(void);
1199 extern void *alloc_commit_node(void);
1200 extern void *alloc_tag_node(void);
1201 extern void *alloc_object_node(void);
1202 extern void alloc_report(void);
1204 /* trace.c */
1205 __attribute__((format (printf, 1, 2)))
1206 extern void trace_printf(const char *format, ...);
1207 __attribute__((format (printf, 2, 3)))
1208 extern void trace_argv_printf(const char **argv, const char *format, ...);
1209 extern void trace_repo_setup(const char *prefix);
1210 extern int trace_want(const char *key);
1211 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1213 void packet_trace_identity(const char *prog);
1215 /* add */
1217 * return 0 if success, 1 - if addition of a file failed and
1218 * ADD_FILES_IGNORE_ERRORS was specified in flags
1220 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1222 /* diff.c */
1223 extern int diff_auto_refresh_index;
1225 /* match-trees.c */
1226 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1227 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1230 * whitespace rules.
1231 * used by both diff and apply
1232 * last two digits are tab width
1234 #define WS_BLANK_AT_EOL 0100
1235 #define WS_SPACE_BEFORE_TAB 0200
1236 #define WS_INDENT_WITH_NON_TAB 0400
1237 #define WS_CR_AT_EOL 01000
1238 #define WS_BLANK_AT_EOF 02000
1239 #define WS_TAB_IN_INDENT 04000
1240 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1241 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1242 #define WS_TAB_WIDTH_MASK 077
1243 extern unsigned whitespace_rule_cfg;
1244 extern unsigned whitespace_rule(const char *);
1245 extern unsigned parse_whitespace_rule(const char *);
1246 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1247 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1248 extern char *whitespace_error_string(unsigned ws);
1249 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1250 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1251 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1253 /* ls-files */
1254 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1255 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1257 char *alias_lookup(const char *alias);
1258 int split_cmdline(char *cmdline, const char ***argv);
1259 /* Takes a negative value returned by split_cmdline */
1260 const char *split_cmdline_strerror(int cmdline_errno);
1262 /* git.c */
1263 struct startup_info {
1264 int have_repository;
1265 const char *prefix;
1267 extern struct startup_info *startup_info;
1269 /* merge.c */
1270 struct commit_list;
1271 int try_merge_command(const char *strategy, size_t xopts_nr,
1272 const char **xopts, struct commit_list *common,
1273 const char *head_arg, struct commit_list *remotes);
1274 int checkout_fast_forward(const unsigned char *from,
1275 const unsigned char *to,
1276 int overwrite_ignore);
1279 int sane_execvp(const char *file, char *const argv[]);
1281 #endif /* CACHE_H */