cache.h 44.6 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
	char name[FLEX_ARRAY]; /* more */
135 136
};

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

142 143 144 145 146 147 148 149 150
/*
 * 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
 */
151 152 153 154
#define CE_UPDATE            (1 << 16)
#define CE_REMOVE            (1 << 17)
#define CE_UPTODATE          (1 << 18)
#define CE_ADDED             (1 << 19)
L
Linus Torvalds 已提交
155

156 157 158 159
#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)
160

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

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

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

/*
 * 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

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
/*
 * 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;
}

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

205
#define ce_namelen(ce) ((ce)->ce_namelen)
206
#define ce_size(ce) cache_entry_size(ce_namelen(ce))
207
#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
208
#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
209
#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
210
#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
211

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

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

259 260
struct index_state {
	struct cache_entry **cache;
261
	unsigned int version;
262
	unsigned int cache_nr, cache_alloc, cache_changed;
263
	struct string_list *resolve_undo;
264
	struct cache_tree *cache_tree;
K
Kjetil Barvik 已提交
265
	struct cache_time timestamp;
266 267
	unsigned name_hash_initialized : 1,
		 initialized : 1;
268
	struct hash_table name_hash;
269
	struct hash_table dir_hash;
270 271 272 273
};

extern struct index_state the_index;

274 275
/* Name hashing */
extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
276 277
extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
extern void free_name_hash(struct index_state *istate);
278 279


280
#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
281 282 283 284 285
#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)
286

287 288
#define read_cache() read_index(&the_index)
#define read_cache_from(path) read_index_from(&the_index, (path))
L
Linus Torvalds 已提交
289
#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
290
#define is_cache_unborn() is_index_unborn(&the_index)
291
#define read_cache_unmerged() read_index_unmerged(&the_index)
292 293
#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
#define discard_cache() discard_index(&the_index)
294
#define unmerged_cache() unmerged_index(&the_index)
295 296
#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))
297
#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
298 299
#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))
300 301
#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))
302
#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
303 304
#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))
305
#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
306
#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
307
#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
308
#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
309
#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
310
#endif
311

312 313 314 315 316 317 318 319 320 321
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,
322
	OBJ_ANY,
323
	OBJ_MAX
324 325
};

326 327 328 329 330 331 332
static inline enum object_type object_type(unsigned int mode)
{
	return S_ISDIR(mode) ? OBJ_TREE :
		S_ISGITLINK(mode) ? OBJ_COMMIT :
		OBJ_BLOB;
}

333
#define GIT_DIR_ENVIRONMENT "GIT_DIR"
J
Josh Triplett 已提交
334
#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
335
#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
336
#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
J
Junio C Hamano 已提交
337
#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
338
#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
339
#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
340 341
#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
#define CONFIG_ENVIRONMENT "GIT_CONFIG"
342
#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
343
#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
344
#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
345
#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
346 347
#define GITATTRIBUTES_FILE ".gitattributes"
#define INFOATTRIBUTES_FILE "info/attributes"
J
Junio C Hamano 已提交
348
#define ATTRIBUTE_MACRO_PREFIX "[attr]"
J
Johannes Schindelin 已提交
349 350
#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
351
#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
352 353
#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
354

355 356 357 358 359 360
/*
 * 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.
 */
361
#define LOCAL_REPO_ENV_SIZE 9
362 363
extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];

364 365
extern int is_bare_repository_cfg;
extern int is_bare_repository(void);
366
extern int is_inside_git_dir(void);
367
extern char *git_work_tree_cfg;
368
extern int is_inside_work_tree(void);
D
Dmitry Potapov 已提交
369
extern int have_git_dir(void);
370
extern const char *get_git_dir(void);
371
extern int is_git_directory(const char *path);
372 373
extern char *get_object_directory(void);
extern char *get_index_file(void);
374
extern char *get_graft_file(void);
J
Johannes Schindelin 已提交
375
extern int set_git_dir(const char *path);
J
Josh Triplett 已提交
376 377
extern const char *get_git_namespace(void);
extern const char *strip_namespace(const char *namespaced_ref);
378
extern const char *get_git_work_tree(void);
379
extern const char *read_gitfile(const char *path);
380
extern const char *resolve_gitdir(const char *suspect);
381
extern void set_git_work_tree(const char *tree);
382 383

#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
384

J
Junio C Hamano 已提交
385
extern const char **get_pathspec(const char *prefix, const char **pathspec);
M
Mike Hommey 已提交
386
extern void setup_work_tree(void);
387
extern const char *setup_git_directory_gently(int *);
388
extern const char *setup_git_directory(void);
389
extern char *prefix_path(const char *prefix, int len, const char *path);
390
extern const char *prefix_filename(const char *prefix, int len, const char *path);
391
extern int check_filename(const char *prefix, const char *name);
392 393 394
extern void verify_filename(const char *prefix,
			    const char *name,
			    int diagnose_misspelt_rev);
395
extern void verify_non_filename(const char *prefix, const char *name);
396
extern int path_inside_repo(const char *prefix, const char *path);
397

398 399
#define INIT_DB_QUIET 0x0001

400
extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
401 402
extern int init_db(const char *template_dir, unsigned int flags);

403 404
#define alloc_nr(x) (((x)+16)*3/2)

J
Jeff King 已提交
405 406 407 408 409
/*
 * 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.
 *
410
 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
J
Jeff King 已提交
411 412 413
 */
#define ALLOC_GROW(x, nr, alloc) \
	do { \
J
Jeff King 已提交
414
		if ((nr) > alloc) { \
415 416 417 418
			if (alloc_nr(alloc) < (nr)) \
				alloc = (nr); \
			else \
				alloc = alloc_nr(alloc); \
J
Jeff King 已提交
419 420
			x = xrealloc((x), alloc * sizeof(*(x))); \
		} \
421
	} while (0)
J
Jeff King 已提交
422

423
/* Initialize and use the cache information */
424
extern int read_index(struct index_state *);
L
Linus Torvalds 已提交
425
extern int read_index_preload(struct index_state *, const char **pathspec);
426
extern int read_index_from(struct index_state *, const char *path);
427
extern int is_index_unborn(struct index_state *);
428
extern int read_index_unmerged(struct index_state *);
429
extern int write_index(struct index_state *, int newfd);
430
extern int discard_index(struct index_state *);
431
extern int unmerged_index(const struct index_state *);
432
extern int verify_path(const char *path);
433
extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
434
extern int index_name_pos(const struct index_state *, const char *name, int namelen);
435 436
#define ADD_CACHE_OK_TO_ADD 1		/* Ok to add */
#define ADD_CACHE_OK_TO_REPLACE 2	/* Ok to replace file/directory */
437
#define ADD_CACHE_SKIP_DFCHECK 4	/* Ok to skip DF conflict checks */
438
#define ADD_CACHE_JUST_APPEND 8		/* Append only; tree.c::read_tree() */
J
Junio C Hamano 已提交
439
#define ADD_CACHE_NEW_ONLY 16		/* Do not replace existing ones */
440
extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
441
extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
442
extern int remove_index_entry_at(struct index_state *, int pos);
443
extern void remove_marked_cache_entries(struct index_state *istate);
444
extern int remove_file_from_index(struct index_state *, const char *path);
445 446
#define ADD_CACHE_VERBOSE 1
#define ADD_CACHE_PRETEND 2
J
Junio C Hamano 已提交
447
#define ADD_CACHE_IGNORE_ERRORS	4
448
#define ADD_CACHE_IGNORE_REMOVAL 8
J
Junio C Hamano 已提交
449
#define ADD_CACHE_INTENT 16
450 451
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);
452
extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
453
extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
454
extern int index_name_is_other(const struct index_state *, const char *, int);
455 456 457 458

/* 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 */
459 460 461
#define CE_MATCH_RACY_IS_DIRTY		02
/* do stat comparison even if CE_SKIP_WORKTREE is true */
#define CE_MATCH_IGNORE_SKIP_WORKTREE	04
462 463
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);
464

N
Nguyễn Thái Ngọc Duy 已提交
465 466 467
struct pathspec {
	const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
	int nr;
468 469
	unsigned int has_wildcard:1;
	unsigned int recursive:1;
470
	int max_depth;
N
Nguyễn Thái Ngọc Duy 已提交
471 472 473
	struct pathspec_item {
		const char *match;
		int len;
474
		unsigned int use_wildcard:1;
N
Nguyễn Thái Ngọc Duy 已提交
475 476 477 478 479
	} *items;
};

extern int init_pathspec(struct pathspec *, const char **);
extern void free_pathspec(struct pathspec *);
480
extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
481 482 483 484 485

#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);
486 487
extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);

L
Linus Torvalds 已提交
488 489 490 491
#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 */
492
#define REFRESH_IGNORE_SUBMODULES	0x0010	/* ignore submodules */
493
#define REFRESH_IN_PORCELAIN	0x0020	/* user friendly output, not "needs update" */
494
extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
L
Linus Torvalds 已提交
495

496 497
struct lock_file {
	struct lock_file *next;
498
	int fd;
499
	pid_t owner;
500
	char on_list;
501
	char filename[PATH_MAX];
502
};
503 504
#define LOCK_DIE_ON_ERROR 1
#define LOCK_NODEREF 2
505
extern int unable_to_lock_error(const char *path, int err);
506
extern NORETURN void unable_to_lock_index_die(const char *path, int err);
507
extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
508
extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
509
extern int commit_lock_file(struct lock_file *);
510
extern void update_index_if_able(struct index_state *, struct lock_file *);
511 512 513

extern int hold_locked_index(struct lock_file *, int);
extern int commit_locked_index(struct lock_file *);
514
extern void set_alternate_index_output(const char *);
515
extern int close_lock_file(struct lock_file *);
516
extern void rollback_lock_file(struct lock_file *);
M
Miklos Vajna 已提交
517
extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
518

519
/* Environment bits from configuration mechanism */
L
Linus Torvalds 已提交
520
extern int trust_executable_bit;
521
extern int trust_ctime;
522
extern int quote_path_fully;
523
extern int has_symlinks;
524
extern int minimum_abbrev, default_abbrev;
L
Linus Torvalds 已提交
525
extern int ignore_case;
J
Junio C Hamano 已提交
526
extern int assume_unchanged;
527
extern int prefer_symlink_refs;
528
extern int log_all_ref_updates;
529
extern int warn_ambiguous_refs;
530
extern int shared_repository;
531
extern const char *apply_default_whitespace;
532
extern const char *apply_default_ignorewhitespace;
533
extern const char *git_attributes_file;
534
extern int zlib_compression_level;
535 536
extern int core_compression_level;
extern int core_compression_seen;
537
extern size_t packed_git_window_size;
538
extern size_t packed_git_limit;
539
extern size_t delta_base_cache_limit;
540
extern unsigned long big_file_threshold;
541
extern unsigned long pack_size_limit_cfg;
542
extern int read_replace_refs;
543
extern int fsync_object_files;
L
Linus Torvalds 已提交
544
extern int core_preload_index;
545
extern int core_apply_sparse_checkout;
546
extern int precomposed_unicode;
L
Linus Torvalds 已提交
547

548
enum branch_track {
549
	BRANCH_TRACK_UNSPECIFIED = -1,
550 551 552 553
	BRANCH_TRACK_NEVER = 0,
	BRANCH_TRACK_REMOTE,
	BRANCH_TRACK_ALWAYS,
	BRANCH_TRACK_EXPLICIT,
554
	BRANCH_TRACK_OVERRIDE
555 556
};

557 558 559 560
enum rebase_setup_type {
	AUTOREBASE_NEVER = 0,
	AUTOREBASE_LOCAL,
	AUTOREBASE_REMOTE,
561
	AUTOREBASE_ALWAYS
562 563
};

564 565 566
enum push_default_type {
	PUSH_DEFAULT_NOTHING = 0,
	PUSH_DEFAULT_MATCHING,
567
	PUSH_DEFAULT_SIMPLE,
568
	PUSH_DEFAULT_UPSTREAM,
569 570
	PUSH_DEFAULT_CURRENT,
	PUSH_DEFAULT_UNSPECIFIED
571 572
};

573
extern enum branch_track git_branch_track;
574
extern enum rebase_setup_type autorebase;
575
extern enum push_default_type push_default;
576

577 578
enum object_creation_mode {
	OBJECT_CREATION_USES_HARDLINKS = 0,
579
	OBJECT_CREATION_USES_RENAMES = 1
580 581 582
};

extern enum object_creation_mode object_creation_mode;
583

J
Johannes Schindelin 已提交
584 585
extern char *notes_ref_name;

586 587
extern int grafts_replace_parents;

J
Junio C Hamano 已提交
588 589 590 591
#define GIT_REPO_VERSION 0
extern int repository_format_version;
extern int check_repository_format(void);

592 593 594 595 596 597
#define MTIME_CHANGED	0x0001
#define CTIME_CHANGED	0x0002
#define OWNER_CHANGED	0x0004
#define MODE_CHANGED    0x0008
#define INODE_CHANGED   0x0010
#define DATA_CHANGED    0x0020
598
#define TYPE_CHANGED    0x0040
599

600 601
extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
602 603
extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
604 605
extern char *git_pathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
606 607
extern char *mkpathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
608

609
/* Return a statically allocated filename matching the sha1 signature */
T
Timo Sirainen 已提交
610 611
extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
612 613 614
extern char *git_path_submodule(const char *path, const char *fmt, ...)
	__attribute__((format (printf, 2, 3)));

615
extern char *sha1_file_name(const unsigned char *sha1);
616 617
extern char *sha1_pack_name(const unsigned char *sha1);
extern char *sha1_pack_index_name(const unsigned char *sha1);
618
extern const char *find_unique_abbrev(const unsigned char *sha1, int);
J
Junio C Hamano 已提交
619
extern const unsigned char null_sha1[20];
620 621

static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
D
David Rientjes 已提交
622
{
623 624 625 626 627 628 629 630
	int i;

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

	return 0;
D
David Rientjes 已提交
631
}
632 633

static inline int is_null_sha1(const unsigned char *sha1)
634
{
635
	return !hashcmp(sha1, null_sha1);
636
}
637

638 639 640 641
static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
{
	memcpy(sha_dst, sha_src, 20);
}
642 643 644 645
static inline void hashclr(unsigned char *hash)
{
	memset(hash, 0, 20);
}
646

J
Jeff King 已提交
647 648
#define EMPTY_TREE_SHA1_HEX \
	"4b825dc642cb6eb9a060e54bf8d69288fbee4904"
649
#define EMPTY_TREE_SHA1_BIN_LITERAL \
J
Jeff King 已提交
650 651
	 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
	 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
652 653
#define EMPTY_TREE_SHA1_BIN \
	 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
J
Jeff King 已提交
654

655 656 657 658 659 660 661 662 663 664 665 666 667
#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);
}

668 669
int git_mkstemp(char *path, size_t n, const char *template);

670 671
int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);

672 673 674 675
/* 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);

676 677 678 679 680 681 682 683
/*
 * 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.
 */
684
enum sharedrepo {
685 686 687 688
	PERM_UMASK          = 0,
	OLD_PERM_GROUP      = 1,
	OLD_PERM_EVERYBODY  = 2,
	PERM_GROUP          = 0660,
689
	PERM_EVERYBODY      = 0664
690 691
};
int git_config_perm(const char *var, const char *value);
692 693
int set_shared_perm(const char *path, int mode);
#define adjust_shared_perm(path) set_shared_perm((path), 0)
694
int safe_create_leading_directories(char *path);
695
int safe_create_leading_directories_const(const char *path);
696
int mkdir_in_gitdir(const char *path);
697
extern void home_config_paths(char **global, char **xdg, char *file);
698
extern char *expand_user_path(const char *path);
E
Erik Faye-Lund 已提交
699
const char *enter_repo(const char *path, int strict);
700 701
static inline int is_absolute_path(const char *path)
{
702
	return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
703
}
704
int is_directory(const char *);
705
const char *real_path(const char *path);
706
const char *real_path_if_valid(const char *path);
707 708
const char *absolute_path(const char *path);
const char *relative_path(const char *abs, const char *base);
709
int normalize_path_copy(char *dst, const char *src);
710
int longest_ancestor_length(const char *path, struct string_list *prefixes);
711
char *strip_path_suffix(const char *path, const char *suffix);
712
int daemon_avoid_alias(const char *path);
713
int offset_1st_component(const char *path);
714

715
/* object replacement */
716 717
#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);
718 719
static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
{
720 721
	return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
}
722 723 724 725 726 727
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);
728
}
729

730
/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
731
extern int sha1_object_info(const unsigned char *, unsigned long *);
N
Nicolas Pitre 已提交
732
extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
733
extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
734
extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
735
extern int force_object_loose(const unsigned char *sha1, time_t mtime);
736
extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
J
Junio C Hamano 已提交
737
extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
738
extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
739

740 741 742
/* global flag to enable extra checks when accessing packed objects */
extern int do_check_packed_object_crc;

743 744 745
/* for development: log offset of pack access */
extern const char *log_pack_access;

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

748
extern int move_temp_to_file(const char *tmpfile, const char *filename);
749

750
extern int has_sha1_pack(const unsigned char *sha1);
751
extern int has_sha1_file(const unsigned char *sha1);
752
extern int has_loose_object_nonlocal(const unsigned char *sha1);
753

754 755
extern int has_pack_index(const unsigned char *sha1);

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

758 759
extern const signed char hexval_table[256];
static inline unsigned int hexval(unsigned char c)
760 761 762 763
{
	return hexval_table[c];
}

764
/* Convert to/from hex/sha1 representation */
765 766
#define MINIMUM_ABBREV minimum_abbrev
#define DEFAULT_ABBREV default_abbrev
767

768 769 770 771 772 773
struct object_context {
	unsigned char tree[20];
	char path[PATH_MAX];
	unsigned mode;
};

774 775 776 777 778 779
#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
780
#define GET_SHA1_ONLY_TO_DIE 04000
781

782
extern int get_sha1(const char *str, unsigned char *sha1);
783
extern int get_sha1_commit(const char *str, unsigned char *sha1);
784
extern int get_sha1_committish(const char *str, unsigned char *sha1);
785 786 787
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);
788
extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
789
extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
790

791 792
typedef int each_abbrev_fn(const unsigned char *sha1, void *);
extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
793 794 795 796 797 798 799 800

/*
 * 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.
 */
801
extern int get_sha1_hex(const char *hex, unsigned char *sha1);
802

803
extern char *sha1_to_hex(const unsigned char *sha1);	/* static buffer result! */
804
extern int read_ref_full(const char *refname, unsigned char *sha1,
805
			 int reading, int *flags);
806
extern int read_ref(const char *refname, unsigned char *sha1);
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837

/*
 * 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.
 */
838
extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
839
extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
840

841
extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
J
Johannes Schindelin 已提交
842
extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
843
extern int interpret_branch_name(const char *str, struct strbuf *);
844
extern int get_sha1_mb(const char *str, unsigned char *sha1);
845

S
Steffen Prohaska 已提交
846 847
extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
extern const char *ref_rev_parse_rules[];
848
#define ref_fetch_rules ref_rev_parse_rules
S
Steffen Prohaska 已提交
849

850
extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
J
Junio C Hamano 已提交
851
extern int validate_headref(const char *ref);
852

853
extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
854
extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
855
extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
856
extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
857

858
extern void *read_object_with_reference(const unsigned char *sha1,
859
					const char *required_type,
860 861
					unsigned long *size,
					unsigned char *sha1_ret);
862

863 864 865
extern struct object *peel_to_type(const char *name, int namelen,
				   struct object *o, enum object_type);

866 867 868 869 870 871
enum date_mode {
	DATE_NORMAL = 0,
	DATE_RELATIVE,
	DATE_SHORT,
	DATE_LOCAL,
	DATE_ISO8601,
L
Linus Torvalds 已提交
872 873
	DATE_RFC2822,
	DATE_RAW
874 875
};

876
const char *show_date(unsigned long time, int timezone, enum date_mode mode);
877 878
void show_date_relative(unsigned long time, int tz, const struct timeval *now,
			struct strbuf *timebuf);
879
int parse_date(const char *date, char *buf, int bufsize);
880
int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
J
Junio C Hamano 已提交
881
int parse_expiry_date(const char *date, unsigned long *timestamp);
882
void datestamp(char *buf, int bufsize);
883 884
#define approxidate(s) approxidate_careful((s), NULL)
unsigned long approxidate_careful(const char *, int *);
885
unsigned long approxidate_relative(const char *date, const struct timeval *now);
886
enum date_mode parse_date_format(const char *format);
887

888
#define IDENT_STRICT	       1
889
#define IDENT_NO_DATE	       2
890
#define IDENT_NO_NAME	       4
891 892
extern const char *git_author_info(int);
extern const char *git_committer_info(int);
893
extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
894
extern const char *fmt_name(const char *name, const char *email);
895
extern const char *ident_default_email(void);
J
Jonathan Nieder 已提交
896
extern const char *git_editor(void);
897
extern const char *git_pager(int stdout_is_tty);
898
extern int git_ident_config(const char *, const char *, void *);
899

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
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);

916 917 918 919 920 921 922 923 924
struct checkout {
	const char *base_dir;
	int base_dir_len;
	unsigned force:1,
		 quiet:1,
		 not_new:1,
		 refresh_cache:1;
};

925
extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
926 927 928 929 930 931 932 933 934

struct cache_def {
	char path[PATH_MAX + 1];
	int len;
	int flags;
	int track_flags;
	int prefix_len_stat_func;
};

935
extern int has_symlink_leading_path(const char *name, int len);
936
extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
937
extern int check_leading_path(const char *name, int len);
938
extern int has_dirs_only_path(const char *name, int len, int prefix_len);
939 940
extern void schedule_dir_for_removal(const char *name, int len);
extern void remove_scheduled_dirs(void);
941

942
extern struct alternate_object_database {
943
	struct alternate_object_database *next;
944
	char *name;
945
	char base[FLEX_ARRAY]; /* more */
946
} *alt_odb_list;
947
extern void prepare_alt_odb(void);
948
extern void read_info_alternates(const char * relative_base, int depth);
949
extern void add_to_alternates_file(const char *reference);
950 951
typedef int alt_odb_fn(struct alternate_object_database *, void *);
extern void foreach_alt_odb(alt_odb_fn, void*);
952

953 954 955 956 957 958 959 960 961
struct pack_window {
	struct pack_window *next;
	unsigned char *base;
	off_t offset;
	size_t len;
	unsigned int last_used;
	unsigned int inuse_cnt;
};

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

struct pack_entry {
983
	off_t offset;
J
Junio C Hamano 已提交
984 985 986 987
	unsigned char sha1[20];
	struct packed_git *p;
};

988 989 990 991
struct ref {
	struct ref *next;
	unsigned char old_sha1[20];
	unsigned char new_sha1[20];
992
	char *symref;
993 994 995 996
	unsigned int force:1,
		merge:1,
		nonfastforward:1,
		deletion:1;
J
Jeff King 已提交
997 998 999 1000 1001 1002
	enum {
		REF_STATUS_NONE = 0,
		REF_STATUS_OK,
		REF_STATUS_REJECT_NONFASTFORWARD,
		REF_STATUS_REJECT_NODELETE,
		REF_STATUS_UPTODATE,
1003
		REF_STATUS_REMOTE_REJECT,
1004
		REF_STATUS_EXPECTING_REPORT
J
Jeff King 已提交
1005
	} status;
1006
	char *remote_status;
J
Junio C Hamano 已提交
1007
	struct ref *peer_ref; /* when renaming */
1008
	char name[FLEX_ARRAY]; /* more */
1009 1010
};

L
Linus Torvalds 已提交
1011 1012 1013 1014
#define REF_NORMAL	(1u << 0)
#define REF_HEADS	(1u << 1)
#define REF_TAGS	(1u << 2)

1015
extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1016

1017
#define CONNECT_VERBOSE       (1u << 0)
1018
extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1019
extern int finish_connect(struct child_process *conn);
1020
extern int git_connection_is_socket(struct child_process *conn);
1021 1022 1023 1024
struct extra_have_objects {
	int nr, alloc;
	unsigned char (*array)[20];
};
1025
extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
1026
extern int server_supports(const char *feature);
1027 1028 1029
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);
1030

1031
extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1032

1033
extern void prepare_packed_git(void);
1034
extern void reprepare_packed_git(void);
1035 1036
extern void install_packed_git(struct packed_git *pack);

J
Junio C Hamano 已提交
1037
extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1038 1039
					 struct packed_git *packs);

1040
extern void pack_report(void);
1041
extern int open_pack_index(struct packed_git *);
1042
extern void close_pack_index(struct packed_git *);
1043
extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1044
extern void close_pack_windows(struct packed_git *);
1045
extern void unuse_pack(struct pack_window **);
1046
extern void free_pack_by_name(const char *);
1047
extern void clear_delta_base_cache(void);
1048
extern struct packed_git *add_packed_git(const char *, int, int);
1049
extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
N
Nicolas Pitre 已提交
1050
extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1051
extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1052
extern int is_pack_valid(struct packed_git *);
1053
extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1054
extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
N
Nicolas Pitre 已提交
1055
extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1056
extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1057

1058 1059 1060 1061 1062 1063 1064 1065
struct object_info {
	/* Request */
	unsigned long *sizep;

	/* Response */
	enum {
		OI_CACHED,
		OI_LOOSE,
1066 1067
		OI_PACKED,
		OI_DBCACHED
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
	} 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 *);
1086

J
Junio C Hamano 已提交
1087 1088 1089
/* Dumb servers support */
extern int update_server_info(int);

1090 1091 1092 1093 1094 1095 1096 1097 1098
/* 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
1099
#define CONFIG_GENERIC_ERROR 7
1100

1101 1102 1103
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 *);
1104
extern void git_config_push_parameter(const char *text);
1105
extern int git_config_from_parameters(config_fn_t fn, void *data);
1106
extern int git_config(config_fn_t fn, void *);
J
Jeff King 已提交
1107 1108
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 已提交
1109
extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1110
extern int git_parse_ulong(const char *, unsigned long *);
L
Linus Torvalds 已提交
1111
extern int git_config_int(const char *, const char *);
1112
extern unsigned long git_config_ulong(const char *, const char *);
J
Junio C Hamano 已提交
1113
extern int git_config_bool_or_int(const char *, const char *, int *);
L
Linus Torvalds 已提交
1114
extern int git_config_bool(const char *, const char *);
J
Junio C Hamano 已提交
1115
extern int git_config_maybe_bool(const char *, const char *);
1116
extern int git_config_string(const char **, const char *, const char *);
1117
extern int git_config_pathname(const char **, const char *, const char *);
1118
extern int git_config_set_in_file(const char *, const char *, const char *);
1119
extern int git_config_set(const char *, const char *);
1120
extern int git_config_parse_key(const char *, char **, int *);
1121
extern int git_config_set_multivar(const char *, const char *, const char *, int);
1122
extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1123
extern int git_config_rename_section(const char *, const char *);
1124
extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1125
extern const char *git_etc_gitconfig(void);
1126
extern int check_repository_format_version(const char *var, const char *value, void *cb);
1127
extern int git_env_bool(const char *, int);
1128
extern int git_config_system(void);
1129
extern int config_error_nonbool(const char *);
1130 1131 1132
extern const char *get_log_output_encoding(void);
extern const char *get_commit_output_encoding(void);

1133 1134
extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);

J
Jeff King 已提交
1135 1136 1137 1138 1139 1140 1141
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 已提交
1142

1143 1144
extern int committer_ident_sufficiently_given(void);
extern int author_ident_sufficiently_given(void);
1145

1146
extern const char *git_commit_encoding;
1147
extern const char *git_log_output_encoding;
1148
extern const char *git_mailmap_file;
J
Junio C Hamano 已提交
1149

1150 1151
/* IO helper functions */
extern void maybe_flush_or_die(FILE *, const char *);
1152
extern int copy_fd(int ifd, int ofd);
1153
extern int copy_file(const char *dst, const char *src, int mode);
1154
extern int copy_file_with_time(const char *dst, const char *src, int mode);
1155
extern void write_or_die(int fd, const void *buf, size_t count);
1156
extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1157
extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1158
extern void fsync_or_die(int fd, const char *);
1159

1160 1161 1162 1163 1164 1165 1166
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));
}

1167 1168
/* pager.c */
extern void setup_pager(void);
1169
extern const char *pager_program;
1170
extern int pager_in_use(void);
1171
extern int pager_use_color;
1172
extern int term_columns(void);
1173
extern int decimal_width(int);
1174
extern int check_pager_config(const char *cmd);
1175

1176
extern const char *editor_program;
A
Anselm Kruis 已提交
1177
extern const char *askpass_program;
1178
extern const char *excludes_file;
1179

J
Junio C Hamano 已提交
1180
/* base85 */
1181 1182
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 已提交
1183

1184
/* alloc.c */
1185 1186 1187 1188 1189
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);
1190 1191
extern void alloc_report(void);

1192
/* trace.c */
1193
__attribute__((format (printf, 1, 2)))
1194
extern void trace_printf(const char *format, ...);
1195
__attribute__((format (printf, 2, 3)))
1196
extern void trace_argv_printf(const char **argv, const char *format, ...);
1197
extern void trace_repo_setup(const char *prefix);
1198
extern int trace_want(const char *key);
J
Jeff King 已提交
1199
extern void trace_strbuf(const char *key, const struct strbuf *buf);
1200

J
Jeff King 已提交
1201
void packet_trace_identity(const char *prog);
1202

1203
/* add */
1204 1205 1206 1207 1208
/*
 * 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);
1209

1210 1211 1212
/* diff.c */
extern int diff_auto_refresh_index;

J
Junio C Hamano 已提交
1213 1214
/* match-trees.c */
void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1215
void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
J
Junio C Hamano 已提交
1216

1217 1218 1219
/*
 * whitespace rules.
 * used by both diff and apply
1220
 * last two digits are tab width
1221
 */
1222 1223 1224 1225 1226 1227
#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
1228
#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1229 1230
#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
#define WS_TAB_WIDTH_MASK        077
1231 1232 1233
extern unsigned whitespace_rule_cfg;
extern unsigned whitespace_rule(const char *);
extern unsigned parse_whitespace_rule(const char *);
1234 1235
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 已提交
1236
extern char *whitespace_error_string(unsigned ws);
1237
extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1238
extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1239
#define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1240

1241
/* ls-files */
1242
int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1243 1244
void overlay_tree_on_cache(const char *tree_name, const char *prefix);

1245
char *alias_lookup(const char *alias);
M
Miklos Vajna 已提交
1246
int split_cmdline(char *cmdline, const char ***argv);
1247 1248
/* Takes a negative value returned by split_cmdline */
const char *split_cmdline_strerror(int cmdline_errno);
1249

1250 1251
/* git.c */
struct startup_info {
1252
	int have_repository;
1253
	const char *prefix;
1254 1255 1256
};
extern struct startup_info *startup_info;

1257 1258 1259 1260 1261 1262 1263 1264 1265
/* 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);

1266

1267 1268
int sane_execvp(const char *file, char *const argv[]);

1269
#endif /* CACHE_H */