cache.h 44.9 KB
Newer Older
1 2 3
#ifndef CACHE_H
#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"
10

11
#include SHA1_HEADER
12 13 14 15 16 17
#ifndef git_SHA_CTX
#define git_SHA_CTX	SHA_CTX
#define git_SHA1_Init	SHA1_Init
#define git_SHA1_Update	SHA1_Update
#define git_SHA1_Final	SHA1_Final
#endif
18

19
#include <zlib.h>
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
typedef struct git_zstream {
	z_stream z;
	unsigned long avail_in;
	unsigned long avail_out;
	unsigned long total_in;
	unsigned long total_out;
	unsigned char *next_in;
	unsigned char *next_out;
} git_zstream;

void git_inflate_init(git_zstream *);
void git_inflate_init_gzip_only(git_zstream *);
void git_inflate_end(git_zstream *);
int git_inflate(git_zstream *, int flush);

void git_deflate_init(git_zstream *, int level);
void git_deflate_init_gzip(git_zstream *, int level);
void git_deflate_end(git_zstream *);
38
int git_deflate_abort(git_zstream *);
39 40 41
int git_deflate_end_gently(git_zstream *);
int git_deflate(git_zstream *, int flush);
unsigned long git_deflate_bound(git_zstream *, unsigned long);
42

T
Timo Hirvonen 已提交
43
#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
44 45
#define DTYPE(de)	((de)->d_type)
#else
46 47 48 49
#undef DT_UNKNOWN
#undef DT_DIR
#undef DT_REG
#undef DT_LNK
50 51 52
#define DT_UNKNOWN	0
#define DT_DIR		1
#define DT_REG		2
53
#define DT_LNK		3
54 55 56
#define DTYPE(de)	DT_UNKNOWN
#endif

M
Martin Koegler 已提交
57 58 59
/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
#define S_IFINVALID     0030000

60 61 62 63 64 65 66 67 68 69 70 71 72
/*
 * A "directory link" is a link to another git directory.
 *
 * The value 0160000 is not normally a valid mode, and
 * also just happens to be S_IFDIR + S_IFLNK
 *
 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
 * always having the same values everywhere. We should use
 * our internal git values for these things, and then we can
 * translate that to the OS-specific value. It just so
 * happens that everybody shares the same bit representation
 * in the UNIX world (and apparently wider too..)
 */
M
Martin Waitz 已提交
73 74
#define S_IFGITLINK	0160000
#define S_ISGITLINK(m)	(((m) & S_IFMT) == S_IFGITLINK)
75

76 77 78 79 80 81 82
/*
 * Intensive research over the course of many years has shown that
 * port 9418 is totally unused by anything else. Or
 *
 *	Your search - "port 9418" - did not match any documents.
 *
 * as www.google.com puts it.
83 84 85 86 87 88 89 90 91 92 93
 *
 * This port has been properly assigned for git use by IANA:
 * git (Assigned-9418) [I06-050728-0001].
 *
 *	git  9418/tcp   git pack transfer service
 *	git  9418/udp   git pack transfer service
 *
 * with Linus Torvalds <torvalds@osdl.org> as the point of
 * contact. September 2005.
 *
 * See http://www.iana.org/assignments/port-numbers
94 95 96
 */
#define DEFAULT_GIT_PORT 9418

97 98 99 100 101 102
/*
 * Basic data structures for the directory cache
 */

#define CACHE_SIGNATURE 0x44495243	/* "DIRC" */
struct cache_header {
103 104 105
	unsigned int hdr_signature;
	unsigned int hdr_version;
	unsigned int hdr_entries;
106 107
};

108 109 110
#define INDEX_FORMAT_LB 2
#define INDEX_FORMAT_UB 4

111 112 113 114 115 116 117 118 119 120 121
/*
 * The "cache_time" is just the low 32 bits of the
 * time. It doesn't matter if it overflows - we only
 * check it for equality in the 32 bits we save.
 */
struct cache_time {
	unsigned int sec;
	unsigned int nsec;
};

struct cache_entry {
K
Kjetil Barvik 已提交
122 123
	struct cache_time ce_ctime;
	struct cache_time ce_mtime;
124 125 126 127 128 129
	unsigned int ce_dev;
	unsigned int ce_ino;
	unsigned int ce_mode;
	unsigned int ce_uid;
	unsigned int ce_gid;
	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 */
136 137
};

138
#define CE_STAGEMASK (0x3000)
139
#define CE_EXTENDED  (0x4000)
J
Junio C Hamano 已提交
140
#define CE_VALID     (0x8000)
141
#define CE_STAGESHIFT 12
142

143 144 145 146 147 148 149 150 151
/*
 * Range 0xFFFF0000 in ce_flags is divided into
 * two parts: in-memory flags and on-disk ones.
 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 * if you want to save a new flag, add it in
 * CE_EXTENDED_FLAGS
 *
 * In-memory only flags
 */
152 153 154 155
#define CE_UPDATE            (1 << 16)
#define CE_REMOVE            (1 << 17)
#define CE_UPTODATE          (1 << 18)
#define CE_ADDED             (1 << 19)
L
Linus Torvalds 已提交
156

157 158 159 160
#define CE_HASHED            (1 << 20)
#define CE_UNHASHED          (1 << 21)
#define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
#define CE_CONFLICTED        (1 << 23)
161

162
#define CE_UNPACKED          (1 << 24)
163
#define CE_NEW_SKIP_WORKTREE (1 << 25)
164

165 166 167
/*
 * Extended on-disk flags
 */
168 169
#define CE_INTENT_TO_ADD     (1 << 29)
#define CE_SKIP_WORKTREE     (1 << 30)
170
/* CE_EXTENDED2 is for future extension */
171
#define CE_EXTENDED2         (1 << 31)
172

173
#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
174 175 176 177 178 179 180 181 182 183 184

/*
 * Safeguard to avoid saving wrong flags:
 *  - CE_EXTENDED2 won't get saved until its semantic is known
 *  - Bits in 0x0000FFFF have been saved in ce_flags already
 *  - Bits in 0x003F0000 are currently in-memory flags
 */
#if CE_EXTENDED_FLAGS & 0x803FFFFF
#error "CE_EXTENDED_FLAGS out of range"
#endif

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
/*
 * Copy the sha1 and stat state of a cache entry from one to
 * another. But we never change the name, or the hash state!
 */
#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
{
	unsigned int state = dst->ce_flags & CE_STATE_MASK;

	/* Don't copy hash chain and name */
	memcpy(dst, src, offsetof(struct cache_entry, next));

	/* Restore the hash state */
	dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
}

201
static inline unsigned create_ce_flags(unsigned stage)
202
{
203
	return (stage << CE_STAGESHIFT);
204 205
}

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)
212

213
#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
214 215 216
static inline unsigned int create_ce_mode(unsigned int mode)
{
	if (S_ISLNK(mode))
217
		return S_IFLNK;
M
Martin Waitz 已提交
218
	if (S_ISDIR(mode) || S_ISGITLINK(mode))
219 220
		return S_IFGITLINK;
	return S_IFREG | ce_permissions(mode);
221
}
222 223
static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
{
224 225
	extern int trust_executable_bit, has_symlinks;
	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 231 232 233 234
			return ce->ce_mode;
		return create_ce_mode(0666);
	}
	return create_ce_mode(mode);
}
235 236 237 238 239 240 241 242 243 244 245 246
static inline int ce_to_dtype(const struct cache_entry *ce)
{
	unsigned ce_mode = ntohl(ce->ce_mode);
	if (S_ISREG(ce_mode))
		return DT_REG;
	else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
		return DT_DIR;
	else if (S_ISLNK(ce_mode))
		return DT_LNK;
	else
		return DT_UNKNOWN;
}
247 248 249 250 251 252 253 254 255 256
static inline unsigned int canon_mode(unsigned int mode)
{
	if (S_ISREG(mode))
		return S_IFREG | ce_permissions(mode);
	if (S_ISLNK(mode))
		return S_IFLNK;
	if (S_ISDIR(mode))
		return S_IFDIR;
	return S_IFGITLINK;
}
257

258
#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
259

260 261
struct index_state {
	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;
K
Kjetil Barvik 已提交
266
	struct cache_time timestamp;
267 268
	unsigned name_hash_initialized : 1,
		 initialized : 1;
269
	struct hash_table name_hash;
270 271 272 273
};

extern struct index_state the_index;

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
/* Name hashing */
extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
/*
 * We don't actually *remove* it, we can just mark it invalid so that
 * we won't find it in lookups.
 *
 * Not only would we have to search the lists (simple enough), but
 * we'd also have to rehash other hash buckets in case this makes the
 * hash bucket empty (common). So it's much better to just mark
 * it.
 */
static inline void remove_name_hash(struct cache_entry *ce)
{
	ce->ce_flags |= CE_UNHASHED;
}


291
#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
292 293 294 295 296
#define active_cache (the_index.cache)
#define active_nr (the_index.cache_nr)
#define active_alloc (the_index.cache_alloc)
#define active_cache_changed (the_index.cache_changed)
#define active_cache_tree (the_index.cache_tree)
297

298 299
#define read_cache() read_index(&the_index)
#define read_cache_from(path) read_index_from(&the_index, (path))
L
Linus Torvalds 已提交
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 304
#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
#define discard_cache() discard_index(&the_index)
305
#define unmerged_cache() unmerged_index(&the_index)
306 307
#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
#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 310
#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
311 312
#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
#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 315
#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
#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
322

323 324 325 326 327 328 329 330 331 332
enum object_type {
	OBJ_BAD = -1,
	OBJ_NONE = 0,
	OBJ_COMMIT = 1,
	OBJ_TREE = 2,
	OBJ_BLOB = 3,
	OBJ_TAG = 4,
	/* 5 for future expansion */
	OBJ_OFS_DELTA = 6,
	OBJ_REF_DELTA = 7,
333
	OBJ_ANY,
334
	OBJ_MAX
335 336
};

337 338 339 340 341 342 343
static inline enum object_type object_type(unsigned int mode)
{
	return S_ISDIR(mode) ? OBJ_TREE :
		S_ISGITLINK(mode) ? OBJ_COMMIT :
		OBJ_BLOB;
}

344
#define GIT_DIR_ENVIRONMENT "GIT_DIR"
J
Josh Triplett 已提交
345
#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
346
#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
347
#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
J
Junio C Hamano 已提交
348
#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
349
#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
350
#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
351 352
#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
#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 358
#define GITATTRIBUTES_FILE ".gitattributes"
#define INFOATTRIBUTES_FILE "info/attributes"
J
Junio C Hamano 已提交
359
#define ATTRIBUTE_MACRO_PREFIX "[attr]"
J
Johannes Schindelin 已提交
360 361
#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
362
#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
363 364
#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
365

366 367 368 369 370 371
/*
 * Repository-local GIT_* environment variables
 * The array is NULL-terminated to simplify its usage in contexts such
 * environment creation or simple walk of the list.
 * The number of non-NULL entries is available as a macro.
 */
372
#define LOCAL_REPO_ENV_SIZE 9
373 374
extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];

375 376
extern int is_bare_repository_cfg;
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);
D
Dmitry Potapov 已提交
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 384
extern char *get_object_directory(void);
extern char *get_index_file(void);
385
extern char *get_graft_file(void);
J
Johannes Schindelin 已提交
386
extern int set_git_dir(const char *path);
J
Josh Triplett 已提交
387 388
extern const char *get_git_namespace(void);
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);
393 394

#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
395

J
Junio C Hamano 已提交
396
extern const char **get_pathspec(const char *prefix, const char **pathspec);
M
Mike Hommey 已提交
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 404 405
extern void verify_filename(const char *prefix,
			    const char *name,
			    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);
408

409 410
#define INIT_DB_QUIET 0x0001

411
extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
412 413
extern int init_db(const char *template_dir, unsigned int flags);

414 415
#define alloc_nr(x) (((x)+16)*3/2)

J
Jeff King 已提交
416 417 418 419 420
/*
 * Realloc the buffer pointed at by variable 'x' so that it can hold
 * at least 'nr' entries; the number of entries currently allocated
 * is 'alloc', using the standard growing factor alloc_nr() macro.
 *
421
 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
J
Jeff King 已提交
422 423 424
 */
#define ALLOC_GROW(x, nr, alloc) \
	do { \
J
Jeff King 已提交
425
		if ((nr) > alloc) { \
426 427 428 429
			if (alloc_nr(alloc) < (nr)) \
				alloc = (nr); \
			else \
				alloc = alloc_nr(alloc); \
J
Jeff King 已提交
430 431
			x = xrealloc((x), alloc * sizeof(*(x))); \
		} \
432
	} while (0)
J
Jeff King 已提交
433

434
/* Initialize and use the cache information */
435
extern int read_index(struct index_state *);
L
Linus Torvalds 已提交
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 447
#define ADD_CACHE_OK_TO_ADD 1		/* Ok to add */
#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() */
J
Junio C Hamano 已提交
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 457
#define ADD_CACHE_VERBOSE 1
#define ADD_CACHE_PRETEND 2
J
Junio C Hamano 已提交
458
#define ADD_CACHE_IGNORE_ERRORS	4
459
#define ADD_CACHE_IGNORE_REMOVAL 8
J
Junio C Hamano 已提交
460
#define ADD_CACHE_INTENT 16
461 462
extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
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);
466 467 468 469

/* do stat comparison even if CE_VALID is true */
#define CE_MATCH_IGNORE_VALID		01
/* do not check the contents but report dirty on racily-clean entries */
470 471 472
#define CE_MATCH_RACY_IS_DIRTY		02
/* do stat comparison even if CE_SKIP_WORKTREE is true */
#define CE_MATCH_IGNORE_SKIP_WORKTREE	04
473 474
extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
475

N
Nguyễn Thái Ngọc Duy 已提交
476 477 478
struct pathspec {
	const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
	int nr;
479 480
	unsigned int has_wildcard:1;
	unsigned int recursive:1;
481
	int max_depth;
N
Nguyễn Thái Ngọc Duy 已提交
482 483 484
	struct pathspec_item {
		const char *match;
		int len;
485
		unsigned int use_wildcard:1;
N
Nguyễn Thái Ngọc Duy 已提交
486 487 488 489 490
	} *items;
};

extern int init_pathspec(struct pathspec *, const char **);
extern void free_pathspec(struct pathspec *);
491
extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
492 493 494 495 496

#define HASH_WRITE_OBJECT 1
#define HASH_FORMAT_CHECK 2
extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
497 498
extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);

L
Linus Torvalds 已提交
499 500 501 502
#define REFRESH_REALLY		0x0001	/* ignore_valid */
#define REFRESH_UNMERGED	0x0002	/* allow unmerged */
#define REFRESH_QUIET		0x0004	/* be quiet about it */
#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);
L
Linus Torvalds 已提交
506

507 508
struct lock_file {
	struct lock_file *next;
509
	int fd;
510
	pid_t owner;
511
	char on_list;
512
	char filename[PATH_MAX];
513
};
514 515
#define LOCK_DIE_ON_ERROR 1
#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 *);
522 523 524

extern int hold_locked_index(struct lock_file *, int);
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 *);
M
Miklos Vajna 已提交
528
extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
529

530
/* Environment bits from configuration mechanism */
L
Linus Torvalds 已提交
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;
L
Linus Torvalds 已提交
536
extern int ignore_case;
J
Junio C Hamano 已提交
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 547
extern int core_compression_level;
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;
L
Linus Torvalds 已提交
555
extern int core_preload_index;
556
extern int core_apply_sparse_checkout;
557
extern int precomposed_unicode;
L
Linus Torvalds 已提交
558

559
enum branch_track {
560
	BRANCH_TRACK_UNSPECIFIED = -1,
561 562 563 564
	BRANCH_TRACK_NEVER = 0,
	BRANCH_TRACK_REMOTE,
	BRANCH_TRACK_ALWAYS,
	BRANCH_TRACK_EXPLICIT,
565
	BRANCH_TRACK_OVERRIDE
566 567
};

568 569 570 571
enum rebase_setup_type {
	AUTOREBASE_NEVER = 0,
	AUTOREBASE_LOCAL,
	AUTOREBASE_REMOTE,
572
	AUTOREBASE_ALWAYS
573 574
};

575 576 577
enum push_default_type {
	PUSH_DEFAULT_NOTHING = 0,
	PUSH_DEFAULT_MATCHING,
578
	PUSH_DEFAULT_SIMPLE,
579
	PUSH_DEFAULT_UPSTREAM,
580 581
	PUSH_DEFAULT_CURRENT,
	PUSH_DEFAULT_UNSPECIFIED
582 583
};

584
extern enum branch_track git_branch_track;
585
extern enum rebase_setup_type autorebase;
586
extern enum push_default_type push_default;
587

588 589
enum object_creation_mode {
	OBJECT_CREATION_USES_HARDLINKS = 0,
590
	OBJECT_CREATION_USES_RENAMES = 1
591 592 593
};

extern enum object_creation_mode object_creation_mode;
594

J
Johannes Schindelin 已提交
595 596
extern char *notes_ref_name;

597 598
extern int grafts_replace_parents;

J
Junio C Hamano 已提交
599 600 601 602
#define GIT_REPO_VERSION 0
extern int repository_format_version;
extern int check_repository_format(void);

603 604 605 606 607 608
#define MTIME_CHANGED	0x0001
#define CTIME_CHANGED	0x0002
#define OWNER_CHANGED	0x0004
#define MODE_CHANGED    0x0008
#define INODE_CHANGED   0x0010
#define DATA_CHANGED    0x0020
609
#define TYPE_CHANGED    0x0040
610

611 612
extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
613 614
extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
615 616
extern char *git_pathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
617 618
extern char *mkpathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
619

620
/* Return a statically allocated filename matching the sha1 signature */
T
Timo Sirainen 已提交
621 622
extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
623 624 625
extern char *git_path_submodule(const char *path, const char *fmt, ...)
	__attribute__((format (printf, 2, 3)));

626
extern char *sha1_file_name(const unsigned char *sha1);
627 628
extern char *sha1_pack_name(const unsigned char *sha1);
extern char *sha1_pack_index_name(const unsigned char *sha1);
629
extern const char *find_unique_abbrev(const unsigned char *sha1, int);
J
Junio C Hamano 已提交
630
extern const unsigned char null_sha1[20];
631 632

static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
D
David Rientjes 已提交
633
{
634 635 636 637 638 639 640 641
	int i;

	for (i = 0; i < 20; i++, sha1++, sha2++) {
		if (*sha1 != *sha2)
			return *sha1 - *sha2;
	}

	return 0;
D
David Rientjes 已提交
642
}
643 644

static inline int is_null_sha1(const unsigned char *sha1)
645
{
646
	return !hashcmp(sha1, null_sha1);
647
}
648

649 650 651 652
static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
{
	memcpy(sha_dst, sha_src, 20);
}
653 654 655 656
static inline void hashclr(unsigned char *hash)
{
	memset(hash, 0, 20);
}
657

J
Jeff King 已提交
658 659
#define EMPTY_TREE_SHA1_HEX \
	"4b825dc642cb6eb9a060e54bf8d69288fbee4904"
660
#define EMPTY_TREE_SHA1_BIN_LITERAL \
J
Jeff King 已提交
661 662
	 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
	 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
663 664
#define EMPTY_TREE_SHA1_BIN \
	 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
J
Jeff King 已提交
665

666 667 668 669 670 671 672 673 674 675 676 677 678
#define EMPTY_BLOB_SHA1_HEX \
	"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
#define EMPTY_BLOB_SHA1_BIN_LITERAL \
	"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
	"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
#define EMPTY_BLOB_SHA1_BIN \
	((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)

static inline int is_empty_blob_sha1(const unsigned char *sha1)
{
	return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
}

679 680
int git_mkstemp(char *path, size_t n, const char *template);

681 682
int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);

683 684 685 686
/* set default permissions by passing mode arguments to open(2) */
int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
int git_mkstemp_mode(char *pattern, int mode);

687 688 689 690 691 692 693 694
/*
 * NOTE NOTE NOTE!!
 *
 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 * not be changed. Old repositories have core.sharedrepository written in
 * numeric format, and therefore these values are preserved for compatibility
 * reasons.
 */
695
enum sharedrepo {
696 697 698 699
	PERM_UMASK          = 0,
	OLD_PERM_GROUP      = 1,
	OLD_PERM_EVERYBODY  = 2,
	PERM_GROUP          = 0660,
700
	PERM_EVERYBODY      = 0664
701 702
};
int git_config_perm(const char *var, const char *value);
703 704
int set_shared_perm(const char *path, int mode);
#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);
E
Erik Faye-Lund 已提交
710
const char *enter_repo(const char *path, int strict);
711 712
static inline int is_absolute_path(const char *path)
{
713
	return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
714
}
715
int is_directory(const char *);
716 717 718
const char *real_path(const char *path);
const char *absolute_path(const char *path);
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);
724

725
/* object replacement */
726 727
#define READ_SHA1_FILE_REPLACE 1
extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
728 729
static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
{
730 731
	return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
}
732 733 734 735 736 737
extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
{
	if (!read_replace_refs)
		return sha1;
	return do_lookup_replace_object(sha1);
738
}
739

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 *);
N
Nicolas Pitre 已提交
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);
J
Junio C Hamano 已提交
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);
749

750 751 752
/* global flag to enable extra checks when accessing packed objects */
extern int do_check_packed_object_crc;

753 754 755
/* for development: log offset of pack access */
extern const char *log_pack_access;

756
extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
757

758
extern int move_temp_to_file(const char *tmpfile, const char *filename);
759

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);
763

764 765
extern int has_pack_index(const unsigned char *sha1);

J
Jeff King 已提交
766 767
extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);

768 769
extern const signed char hexval_table[256];
static inline unsigned int hexval(unsigned char c)
770 771 772 773
{
	return hexval_table[c];
}

774
/* Convert to/from hex/sha1 representation */
775 776
#define MINIMUM_ABBREV minimum_abbrev
#define DEFAULT_ABBREV default_abbrev
777

778 779 780 781 782 783
struct object_context {
	unsigned char tree[20];
	char path[PATH_MAX];
	unsigned mode;
};

784 785 786 787 788 789
#define GET_SHA1_QUIETLY        01
#define GET_SHA1_COMMIT         02
#define GET_SHA1_COMMITTISH     04
#define GET_SHA1_TREE          010
#define GET_SHA1_TREEISH       020
#define GET_SHA1_BLOB	       040
790
#define GET_SHA1_ONLY_TO_DIE 04000
791

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 796 797
extern int get_sha1_tree(const char *str, unsigned char *sha1);
extern int get_sha1_treeish(const char *str, unsigned char *sha1);
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);
800

801 802
typedef int each_abbrev_fn(const unsigned char *sha1, void *);
extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
803 804 805 806 807 808 809 810

/*
 * Try to read a SHA1 in hexadecimal format from the 40 characters
 * starting at hex.  Write the 20-byte result to sha1 in binary form.
 * Return 0 on success.  Reading stops if a NUL is encountered in the
 * input, so it is safe to pass this function an arbitrary
 * null-terminated string.
 */
811
extern int get_sha1_hex(const char *hex, unsigned char *sha1);
812

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);
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847

/*
 * Resolve a reference, recursively following symbolic refererences.
 *
 * Store the referred-to object's name in sha1 and return the name of
 * the non-symbolic reference that ultimately pointed at it.  The
 * return value, if not NULL, is a pointer into either a static buffer
 * or the input ref.
 *
 * If the reference cannot be resolved to an object, the behavior
 * depends on the "reading" argument:
 *
 * - If reading is set, return NULL.
 *
 * - If reading is not set, clear sha1 and return the name of the last
 *   reference name in the chain, which will either be a non-symbolic
 *   reference or an undefined reference.  If this is a prelude to
 *   "writing" to the ref, the return value is the name of the ref
 *   that will actually be created or changed.
 *
 * If flag is non-NULL, set the value that it points to the
 * combination of REF_ISPACKED (if the reference was found among the
 * packed references) and REF_ISSYMREF (if the initial reference was a
 * symbolic reference).
 *
 * If ref is not a properly-formatted, normalized reference, return
 * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
 * give up and return NULL.
 *
 * 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);
850

851
extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
J
Johannes Schindelin 已提交
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);
855

S
Steffen Prohaska 已提交
856 857
extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
extern const char *ref_rev_parse_rules[];
858
#define ref_fetch_rules ref_rev_parse_rules
S
Steffen Prohaska 已提交
859

860
extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
J
Junio C Hamano 已提交
861
extern int validate_headref(const char *ref);
862

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);
867

868
extern void *read_object_with_reference(const unsigned char *sha1,
869
					const char *required_type,
870 871
					unsigned long *size,
					unsigned char *sha1_ret);
872

873 874 875
extern struct object *peel_to_type(const char *name, int namelen,
				   struct object *o, enum object_type);

876 877 878 879 880 881
enum date_mode {
	DATE_NORMAL = 0,
	DATE_RELATIVE,
	DATE_SHORT,
	DATE_LOCAL,
	DATE_ISO8601,
L
Linus Torvalds 已提交
882 883
	DATE_RFC2822,
	DATE_RAW
884 885
};

886
const char *show_date(unsigned long time, int timezone, enum date_mode mode);
887 888
void show_date_relative(unsigned long time, int tz, const struct timeval *now,
			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 893
#define approxidate(s) approxidate_careful((s), NULL)
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);
896

897
#define IDENT_STRICT	       1
898
#define IDENT_NO_DATE	       2
899
#define IDENT_NO_NAME	       4
900 901
extern const char *git_author_info(int);
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);
J
Jonathan Nieder 已提交
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 *);
908

909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
struct ident_split {
	const char *name_begin;
	const char *name_end;
	const char *mail_begin;
	const char *mail_end;
	const char *date_begin;
	const char *date_end;
	const char *tz_begin;
	const char *tz_end;
};
/*
 * Signals an success with 0, but time part of the result may be NULL
 * if the input lacks timestamp and zone
 */
extern int split_ident_line(struct ident_split *, const char *, int);

925 926 927 928 929 930 931 932 933
struct checkout {
	const char *base_dir;
	int base_dir_len;
	unsigned force:1,
		 quiet:1,
		 not_new:1,
		 refresh_cache:1;
};

934
extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
935 936 937 938 939 940 941 942 943

struct cache_def {
	char path[PATH_MAX + 1];
	int len;
	int flags;
	int track_flags;
	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 949
extern void schedule_dir_for_removal(const char *name, int len);
extern void remove_scheduled_dirs(void);
950

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 960
typedef int alt_odb_fn(struct alternate_object_database *, void *);
extern void foreach_alt_odb(alt_odb_fn, void*);
961

962 963 964 965 966 967 968 969 970
struct pack_window {
	struct pack_window *next;
	unsigned char *base;
	off_t offset;
	size_t len;
	unsigned int last_used;
	unsigned int inuse_cnt;
};

971 972
extern struct packed_git {
	struct packed_git *next;
973
	struct pack_window *windows;
974
	off_t pack_size;
N
Nicolas Pitre 已提交
975 976 977
	const void *index_data;
	size_t index_size;
	uint32_t num_objects;
978 979
	uint32_t num_bad_objects;
	unsigned char *bad_object_sha1;
980
	int index_version;
N
Nicolas Pitre 已提交
981
	time_t mtime;
982
	int pack_fd;
983
	unsigned pack_local:1,
984 985
		 pack_keep:1,
		 do_not_close:1;
986
	unsigned char sha1[20];
987 988
	/* something like ".git/objects/pack/xxxxx.pack" */
	char pack_name[FLEX_ARRAY]; /* more */
989
} *packed_git;
J
Junio C Hamano 已提交
990 991

struct pack_entry {
992
	off_t offset;
J
Junio C Hamano 已提交
993 994 995 996
	unsigned char sha1[20];
	struct packed_git *p;
};

997 998 999 1000
struct ref {
	struct ref *next;
	unsigned char old_sha1[20];
	unsigned char new_sha1[20];
1001
	char *symref;
1002 1003 1004 1005
	unsigned int force:1,
		merge:1,
		nonfastforward:1,
		deletion:1;
J
Jeff King 已提交
1006 1007 1008 1009 1010 1011
	enum {
		REF_STATUS_NONE = 0,
		REF_STATUS_OK,
		REF_STATUS_REJECT_NONFASTFORWARD,
		REF_STATUS_REJECT_NODELETE,
		REF_STATUS_UPTODATE,
1012
		REF_STATUS_REMOTE_REJECT,
1013
		REF_STATUS_EXPECTING_REPORT
J
Jeff King 已提交
1014
	} status;
1015
	char *remote_status;
J
Junio C Hamano 已提交
1016
	struct ref *peer_ref; /* when renaming */
1017
	char name[FLEX_ARRAY]; /* more */
1018 1019
};

L
Linus Torvalds 已提交
1020 1021 1022 1023
#define REF_NORMAL	(1u << 0)
#define REF_HEADS	(1u << 1)
#define REF_TAGS	(1u << 2)

1024
extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1025

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 1031 1032 1033
struct extra_have_objects {
	int nr, alloc;
	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 1037 1038
extern int parse_feature_request(const char *features, const char *feature);
extern const char *server_feature_value(const char *feature, int *len_ret);
extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1039

1040
extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1041

1042
extern void prepare_packed_git(void);
1043
extern void reprepare_packed_git(void);
1044 1045
extern void install_packed_git(struct packed_git *pack);

J
Junio C Hamano 已提交
1046
extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1047 1048
					 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);
N
Nicolas Pitre 已提交
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);
N
Nicolas Pitre 已提交
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 *);
1066

1067 1068 1069 1070 1071 1072 1073 1074
struct object_info {
	/* Request */
	unsigned long *sizep;

	/* Response */
	enum {
		OI_CACHED,
		OI_LOOSE,
1075 1076
		OI_PACKED,
		OI_DBCACHED
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
	} whence;
	union {
		/*
		 * struct {
		 * 	... Nothing to expose in this case
		 * } cached;
		 * struct {
		 * 	... Nothing to expose in this case
		 * } loose;
		 */
		struct {
			struct packed_git *pack;
			off_t offset;
			unsigned int is_delta;
		} packed;
	} u;
};
extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1095

J
Junio C Hamano 已提交
1096 1097 1098
/* Dumb servers support */
extern int update_server_info(int);

1099 1100 1101 1102 1103 1104 1105 1106 1107
/* git_config_parse_key() returns these negated: */
#define CONFIG_INVALID_KEY 1
#define CONFIG_NO_SECTION_OR_NAME 2
/* git_config_set(), git_config_set_multivar() return the above or these: */
#define CONFIG_NO_LOCK -1
#define CONFIG_INVALID_FILE 3
#define CONFIG_NO_WRITE 4
#define CONFIG_NOTHING_SET 5
#define CONFIG_INVALID_PATTERN 6
1108
#define CONFIG_GENERIC_ERROR 7
1109

1110 1111 1112
typedef int (*config_fn_t)(const char *, const char *, void *);
extern int git_default_config(const char *, const char *, void *);
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 *);
J
Jeff King 已提交
1116 1117
extern int git_config_with_options(config_fn_t fn, void *,
				   const char *filename, int respect_includes);
N
Nguyễn Thái Ngọc Duy 已提交
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 *);
L
Linus Torvalds 已提交
1120
extern int git_config_int(const char *, const char *);
1121
extern unsigned long git_config_ulong(const char *, const char *);
J
Junio C Hamano 已提交
1122
extern int git_config_bool_or_int(const char *, const char *, int *);
L
Linus Torvalds 已提交
1123
extern int git_config_bool(const char *, const char *);
J
Junio C Hamano 已提交
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 1140 1141
extern const char *get_log_output_encoding(void);
extern const char *get_commit_output_encoding(void);

1142 1143
extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);

J
Jeff King 已提交
1144 1145 1146 1147 1148 1149 1150
struct config_include_data {
	int depth;
	config_fn_t fn;
	void *data;
};
#define CONFIG_INCLUDE_INIT { 0 }
extern int git_config_include(const char *name, const char *value, void *data);
L
Linus Torvalds 已提交
1151

1152 1153 1154
#define IDENT_NAME_GIVEN 01
#define IDENT_MAIL_GIVEN 02
#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);
1157

1158
extern const char *git_commit_encoding;
1159
extern const char *git_log_output_encoding;
1160
extern const char *git_mailmap_file;
J
Junio C Hamano 已提交
1161

1162 1163
/* IO helper functions */
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 *);
1171

1172 1173 1174 1175 1176 1177 1178
extern ssize_t read_in_full(int fd, void *buf, size_t count);
extern ssize_t write_in_full(int fd, const void *buf, size_t count);
static inline ssize_t write_str_in_full(int fd, const char *str)
{
	return write_in_full(fd, str, strlen(str));
}

1179 1180
/* pager.c */
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);
1187

1188
extern const char *editor_program;
A
Anselm Kruis 已提交
1189
extern const char *askpass_program;
1190
extern const char *excludes_file;
1191

J
Junio C Hamano 已提交
1192
/* base85 */
1193 1194
int decode_85(char *dst, const char *line, int linelen);
void encode_85(char *buf, const unsigned char *data, int bytes);
J
Junio C Hamano 已提交
1195

1196
/* alloc.c */
1197 1198 1199 1200 1201
extern void *alloc_blob_node(void);
extern void *alloc_tree_node(void);
extern void *alloc_commit_node(void);
extern void *alloc_tag_node(void);
extern void *alloc_object_node(void);
1202 1203
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);
J
Jeff King 已提交
1211
extern void trace_strbuf(const char *key, const struct strbuf *buf);
1212

J
Jeff King 已提交
1213
void packet_trace_identity(const char *prog);
1214

1215
/* add */
1216 1217 1218 1219 1220
/*
 * return 0 if success, 1 - if addition of a file failed and
 * ADD_FILES_IGNORE_ERRORS was specified in flags
 */
int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1221

1222 1223 1224
/* diff.c */
extern int diff_auto_refresh_index;

J
Junio C Hamano 已提交
1225 1226
/* match-trees.c */
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 *);
J
Junio C Hamano 已提交
1228

1229 1230 1231
/*
 * whitespace rules.
 * used by both diff and apply
1232
 * last two digits are tab width
1233
 */
1234 1235 1236 1237 1238 1239
#define WS_BLANK_AT_EOL         0100
#define WS_SPACE_BEFORE_TAB     0200
#define WS_INDENT_WITH_NON_TAB  0400
#define WS_CR_AT_EOL           01000
#define WS_BLANK_AT_EOF        02000
#define WS_TAB_IN_INDENT       04000
1240
#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1241 1242
#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
#define WS_TAB_WIDTH_MASK        077
1243 1244 1245
extern unsigned whitespace_rule_cfg;
extern unsigned whitespace_rule(const char *);
extern unsigned parse_whitespace_rule(const char *);
1246 1247
extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
W
Wincent Colaiuta 已提交
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)
1252

1253
/* ls-files */
1254
int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1255 1256
void overlay_tree_on_cache(const char *tree_name, const char *prefix);

1257
char *alias_lookup(const char *alias);
M
Miklos Vajna 已提交
1258
int split_cmdline(char *cmdline, const char ***argv);
1259 1260
/* Takes a negative value returned by split_cmdline */
const char *split_cmdline_strerror(int cmdline_errno);
1261

1262 1263
/* git.c */
struct startup_info {
1264
	int have_repository;
1265
	const char *prefix;
1266 1267 1268
};
extern struct startup_info *startup_info;

1269 1270 1271 1272 1273 1274 1275 1276 1277
/* merge.c */
struct commit_list;
int try_merge_command(const char *strategy, size_t xopts_nr,
		const char **xopts, struct commit_list *common,
		const char *head_arg, struct commit_list *remotes);
int checkout_fast_forward(const unsigned char *from,
			  const unsigned char *to,
			  int overwrite_ignore);

1278

1279 1280
int sane_execvp(const char *file, char *const argv[]);

1281
#endif /* CACHE_H */