cache.h 32.7 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

8
#include SHA1_HEADER
9 10 11 12 13 14
#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
15

16
#include <zlib.h>
17
#if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
18 19 20
#define deflateBound(c,s)  ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
#endif

Timo Hirvonen's avatar
Timo Hirvonen committed
21
#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
22 23
#define DTYPE(de)	((de)->d_type)
#else
24 25 26 27
#undef DT_UNKNOWN
#undef DT_DIR
#undef DT_REG
#undef DT_LNK
28 29 30
#define DT_UNKNOWN	0
#define DT_DIR		1
#define DT_REG		2
31
#define DT_LNK		3
32 33 34
#define DTYPE(de)	DT_UNKNOWN
#endif

Martin Koegler's avatar
Martin Koegler committed
35 36 37
/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
#define S_IFINVALID     0030000

38 39 40 41 42 43 44 45 46 47 48 49 50
/*
 * 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..)
 */
Martin Waitz's avatar
Martin Waitz committed
51 52
#define S_IFGITLINK	0160000
#define S_ISGITLINK(m)	(((m) & S_IFMT) == S_IFGITLINK)
53

54 55 56 57 58 59 60
/*
 * 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.
61 62 63 64 65 66 67 68 69 70 71
 *
 * 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 <[email protected]> as the point of
 * contact. September 2005.
 *
 * See http://www.iana.org/assignments/port-numbers
72 73 74
 */
#define DEFAULT_GIT_PORT 9418

75 76 77 78 79 80
/*
 * Basic data structures for the directory cache
 */

#define CACHE_SIGNATURE 0x44495243	/* "DIRC" */
struct cache_header {
81 82 83
	unsigned int hdr_signature;
	unsigned int hdr_version;
	unsigned int hdr_entries;
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
};

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

/*
 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
 * Again - this is just a (very strong in practice) heuristic that
 * the inode hasn't changed.
100 101 102
 *
 * We save the fields in big-endian order to allow using the
 * index file over NFS transparently.
103
 */
104 105 106 107 108 109 110 111 112 113 114 115 116 117
struct ondisk_cache_entry {
	struct cache_time ctime;
	struct cache_time mtime;
	unsigned int dev;
	unsigned int ino;
	unsigned int mode;
	unsigned int uid;
	unsigned int gid;
	unsigned int size;
	unsigned char sha1[20];
	unsigned short flags;
	char name[FLEX_ARRAY]; /* more */
};

Duy Nguyen's avatar
Duy Nguyen committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/*
 * This struct is used when CE_EXTENDED bit is 1
 * The struct must match ondisk_cache_entry exactly from
 * ctime till flags
 */
struct ondisk_cache_entry_extended {
	struct cache_time ctime;
	struct cache_time mtime;
	unsigned int dev;
	unsigned int ino;
	unsigned int mode;
	unsigned int uid;
	unsigned int gid;
	unsigned int size;
	unsigned char sha1[20];
	unsigned short flags;
	unsigned short flags2;
	char name[FLEX_ARRAY]; /* more */
};

138
struct cache_entry {
139 140
	unsigned int ce_ctime;
	unsigned int ce_mtime;
141 142 143 144 145 146
	unsigned int ce_dev;
	unsigned int ce_ino;
	unsigned int ce_mode;
	unsigned int ce_uid;
	unsigned int ce_gid;
	unsigned int ce_size;
147
	unsigned int ce_flags;
148
	unsigned char sha1[20];
149
	struct cache_entry *next;
150
	char name[FLEX_ARRAY]; /* more */
151 152
};

153 154
#define CE_NAMEMASK  (0x0fff)
#define CE_STAGEMASK (0x3000)
155
#define CE_EXTENDED  (0x4000)
Junio C Hamano's avatar
Junio C Hamano committed
156
#define CE_VALID     (0x8000)
157
#define CE_STAGESHIFT 12
158

Duy Nguyen's avatar
Duy Nguyen committed
159 160 161 162 163 164 165 166 167
/*
 * 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
 */
168 169
#define CE_UPDATE    (0x10000)
#define CE_REMOVE    (0x20000)
170
#define CE_UPTODATE  (0x40000)
171
#define CE_ADDED     (0x80000)
172 173 174

#define CE_HASHED    (0x100000)
#define CE_UNHASHED  (0x200000)
175

Duy Nguyen's avatar
Duy Nguyen committed
176 177 178
/*
 * Extended on-disk flags
 */
179
#define CE_INTENT_TO_ADD 0x20000000
Duy Nguyen's avatar
Duy Nguyen committed
180 181 182
/* CE_EXTENDED2 is for future extension */
#define CE_EXTENDED2 0x80000000

183
#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD)
Duy Nguyen's avatar
Duy Nguyen committed
184 185 186 187 188 189 190 191 192 193 194

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

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/*
 * 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;
}

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
static inline unsigned create_ce_flags(size_t len, unsigned stage)
{
	if (len >= CE_NAMEMASK)
		len = CE_NAMEMASK;
	return (len | (stage << CE_STAGESHIFT));
}

static inline size_t ce_namelen(const struct cache_entry *ce)
{
	size_t len = ce->ce_flags & CE_NAMEMASK;
	if (len < CE_NAMEMASK)
		return len;
	return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
}

226
#define ce_size(ce) cache_entry_size(ce_namelen(ce))
Duy Nguyen's avatar
Duy Nguyen committed
227 228 229
#define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
			    ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
			    ondisk_cache_entry_size(ce_namelen(ce)))
230
#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
231 232
#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
233

234
#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
235 236 237
static inline unsigned int create_ce_mode(unsigned int mode)
{
	if (S_ISLNK(mode))
238
		return S_IFLNK;
Martin Waitz's avatar
Martin Waitz committed
239
	if (S_ISDIR(mode) || S_ISGITLINK(mode))
240 241
		return S_IFGITLINK;
	return S_IFREG | ce_permissions(mode);
242
}
243 244
static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
{
245 246
	extern int trust_executable_bit, has_symlinks;
	if (!has_symlinks && S_ISREG(mode) &&
247
	    ce && S_ISLNK(ce->ce_mode))
248
		return ce->ce_mode;
249
	if (!trust_executable_bit && S_ISREG(mode)) {
250
		if (ce && S_ISREG(ce->ce_mode))
251 252 253 254 255
			return ce->ce_mode;
		return create_ce_mode(0666);
	}
	return create_ce_mode(mode);
}
256 257 258 259 260 261 262 263 264 265 266 267
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;
}
Junio C Hamano's avatar
Junio C Hamano committed
268 269
#define canon_mode(mode) \
	(S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
Martin Waitz's avatar
Martin Waitz committed
270
	S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
271

Duy Nguyen's avatar
Duy Nguyen committed
272 273 274 275
#define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
#define cache_entry_size(len) flexible_size(cache_entry,len)
#define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
#define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
276

277 278 279 280 281
struct index_state {
	struct cache_entry **cache;
	unsigned int cache_nr, cache_alloc, cache_changed;
	struct cache_tree *cache_tree;
	time_t timestamp;
282
	void *alloc;
283 284
	unsigned name_hash_initialized : 1,
		 initialized : 1;
285
	struct hash_table name_hash;
286 287 288 289
};

extern struct index_state the_index;

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
/* 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;
}


307
#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
308 309 310 311 312
#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)
313

314 315
#define read_cache() read_index(&the_index)
#define read_cache_from(path) read_index_from(&the_index, (path))
Linus Torvalds's avatar
Linus Torvalds committed
316
#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
317
#define is_cache_unborn() is_index_unborn(&the_index)
318
#define read_cache_unmerged() read_index_unmerged(&the_index)
319 320
#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
#define discard_cache() discard_index(&the_index)
321
#define unmerged_cache() unmerged_index(&the_index)
322 323
#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))
324
#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
325 326
#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))
327 328
#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))
329
#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
330 331
#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))
332
#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
333
#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
334
#endif
335

336 337 338 339 340 341 342 343 344 345
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,
346
	OBJ_ANY,
347 348 349
	OBJ_MAX,
};

350 351 352 353 354 355 356
static inline enum object_type object_type(unsigned int mode)
{
	return S_ISDIR(mode) ? OBJ_TREE :
		S_ISGITLINK(mode) ? OBJ_COMMIT :
		OBJ_BLOB;
}

357
#define GIT_DIR_ENVIRONMENT "GIT_DIR"
358
#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
359
#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
360
#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
361
#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
362
#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
363 364 365
#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
#define CONFIG_ENVIRONMENT "GIT_CONFIG"
#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
366
#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
367 368
#define GITATTRIBUTES_FILE ".gitattributes"
#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamano's avatar
Junio C Hamano committed
369
#define ATTRIBUTE_MACRO_PREFIX "[attr]"
370

371 372
extern int is_bare_repository_cfg;
extern int is_bare_repository(void);
373
extern int is_inside_git_dir(void);
374
extern char *git_work_tree_cfg;
375
extern int is_inside_work_tree(void);
Dmitry Potapov's avatar
Dmitry Potapov committed
376
extern int have_git_dir(void);
377
extern const char *get_git_dir(void);
378 379
extern char *get_object_directory(void);
extern char *get_index_file(void);
380
extern char *get_graft_file(void);
381
extern int set_git_dir(const char *path);
382
extern const char *get_git_work_tree(void);
383
extern const char *read_gitfile_gently(const char *path);
384
extern void set_git_work_tree(const char *tree);
385 386

#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
387

Junio C Hamano's avatar
Junio C Hamano committed
388
extern const char **get_pathspec(const char *prefix, const char **pathspec);
Mike Hommey's avatar
Mike Hommey committed
389
extern void setup_work_tree(void);
390
extern const char *setup_git_directory_gently(int *);
391
extern const char *setup_git_directory(void);
Junio C Hamano's avatar
Junio C Hamano committed
392
extern const char *prefix_path(const char *prefix, int len, const char *path);
393
extern const char *prefix_filename(const char *prefix, int len, const char *path);
394
extern void verify_filename(const char *prefix, const char *name);
395
extern void verify_non_filename(const char *prefix, const char *name);
396

397 398 399 400
#define INIT_DB_QUIET 0x0001

extern int init_db(const char *template_dir, unsigned int flags);

401 402
#define alloc_nr(x) (((x)+16)*3/2)

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

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

/* 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 */
#define CE_MATCH_RACY_IS_DIRTY	02
458 459
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);
460

461
extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
462
extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
463
extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
464 465
extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);

466 467 468 469
#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 */
470
#define REFRESH_IGNORE_SUBMODULES	0x0010	/* ignore submodules */
471
#define REFRESH_SAY_CHANGED	0x0020	/* say "changed" not "needs update" */
472
extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
473

474 475
struct lock_file {
	struct lock_file *next;
476
	int fd;
477
	pid_t owner;
478
	char on_list;
479
	char filename[PATH_MAX];
480
};
481 482
#define LOCK_DIE_ON_ERROR 1
#define LOCK_NODEREF 2
483
extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
484
extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
485
extern int commit_lock_file(struct lock_file *);
486 487 488

extern int hold_locked_index(struct lock_file *, int);
extern int commit_locked_index(struct lock_file *);
489
extern void set_alternate_index_output(const char *);
490
extern int close_lock_file(struct lock_file *);
491
extern void rollback_lock_file(struct lock_file *);
492
extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
493

494
/* Environment bits from configuration mechanism */
495
extern int trust_executable_bit;
496
extern int trust_ctime;
497
extern int quote_path_fully;
498
extern int has_symlinks;
499
extern int ignore_case;
Junio C Hamano's avatar
Junio C Hamano committed
500
extern int assume_unchanged;
501
extern int prefer_symlink_refs;
502
extern int log_all_ref_updates;
503
extern int warn_ambiguous_refs;
504
extern int shared_repository;
505
extern const char *apply_default_whitespace;
506
extern int zlib_compression_level;
507 508
extern int core_compression_level;
extern int core_compression_seen;
509
extern size_t packed_git_window_size;
510
extern size_t packed_git_limit;
511
extern size_t delta_base_cache_limit;
Linus Torvalds's avatar
Linus Torvalds committed
512
extern int auto_crlf;
513
extern int fsync_object_files;
Linus Torvalds's avatar
Linus Torvalds committed
514
extern int core_preload_index;
515

516 517 518 519 520 521 522 523
enum safe_crlf {
	SAFE_CRLF_FALSE = 0,
	SAFE_CRLF_FAIL = 1,
	SAFE_CRLF_WARN = 2,
};

extern enum safe_crlf safe_crlf;

524
enum branch_track {
525
	BRANCH_TRACK_UNSPECIFIED = -1,
526 527 528 529 530 531
	BRANCH_TRACK_NEVER = 0,
	BRANCH_TRACK_REMOTE,
	BRANCH_TRACK_ALWAYS,
	BRANCH_TRACK_EXPLICIT,
};

532 533 534 535 536 537 538
enum rebase_setup_type {
	AUTOREBASE_NEVER = 0,
	AUTOREBASE_LOCAL,
	AUTOREBASE_REMOTE,
	AUTOREBASE_ALWAYS,
};

539
extern enum branch_track git_branch_track;
540
extern enum rebase_setup_type autorebase;
541

542 543 544 545
#define GIT_REPO_VERSION 0
extern int repository_format_version;
extern int check_repository_format(void);

546 547 548 549 550 551
#define MTIME_CHANGED	0x0001
#define CTIME_CHANGED	0x0002
#define OWNER_CHANGED	0x0004
#define MODE_CHANGED    0x0008
#define INODE_CHANGED   0x0010
#define DATA_CHANGED    0x0020
552
#define TYPE_CHANGED    0x0040
553

554 555
extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
556 557
extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
558 559
extern char *git_pathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
560

561
/* Return a statically allocated filename matching the sha1 signature */
Timo Sirainen's avatar
Timo Sirainen committed
562 563
extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
564
extern char *sha1_file_name(const unsigned char *sha1);
565 566
extern char *sha1_pack_name(const unsigned char *sha1);
extern char *sha1_pack_index_name(const unsigned char *sha1);
567
extern const char *find_unique_abbrev(const unsigned char *sha1, int);
Junio C Hamano's avatar
Junio C Hamano committed
568
extern const unsigned char null_sha1[20];
569 570 571 572
static inline int is_null_sha1(const unsigned char *sha1)
{
	return !memcmp(sha1, null_sha1, 20);
}
573 574 575 576
static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
{
	return memcmp(sha1, sha2, 20);
}
577 578 579 580
static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
{
	memcpy(sha_dst, sha_src, 20);
}
581 582 583 584
static inline void hashclr(unsigned char *hash)
{
	memset(hash, 0, 20);
}
585
extern int is_empty_blob_sha1(const unsigned char *sha1);
586

587 588 589 590 591 592
#define EMPTY_TREE_SHA1_HEX \
	"4b825dc642cb6eb9a060e54bf8d69288fbee4904"
#define EMPTY_TREE_SHA1_BIN \
	 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
	 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"

593 594
int git_mkstemp(char *path, size_t n, const char *template);

595 596 597 598 599 600 601 602
/*
 * 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.
 */
603
enum sharedrepo {
604 605 606 607 608
	PERM_UMASK          = 0,
	OLD_PERM_GROUP      = 1,
	OLD_PERM_EVERYBODY  = 2,
	PERM_GROUP          = 0660,
	PERM_EVERYBODY      = 0664,
609 610
};
int git_config_perm(const char *var, const char *value);
611
int adjust_shared_perm(const char *path);
612
int safe_create_leading_directories(char *path);
613
int safe_create_leading_directories_const(const char *path);
Timo Hirvonen's avatar
Timo Hirvonen committed
614
char *enter_repo(char *path, int strict);
615 616
static inline int is_absolute_path(const char *path)
{
617
	return path[0] == '/' || has_dos_drive_prefix(path);
618
}
619
int is_directory(const char *);
620
const char *make_absolute_path(const char *path);
621
const char *make_nonrelative_path(const char *path);
622
const char *make_relative_path(const char *abs, const char *base);
623
int normalize_absolute_path(char *buf, const char *path);
624
int longest_ancestor_length(const char *path, const char *prefix_list);
625

626
/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
627 628
extern int sha1_object_info(const unsigned char *, unsigned long *);
extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
629
extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
630
extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
631
extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
632
extern int force_object_loose(const unsigned char *sha1, time_t mtime);
633

634 635 636
/* just like read_sha1_file(), but non fatal in presence of bad objects */
extern void *read_object(const unsigned char *sha1, enum object_type *type, unsigned long *size);

637 638 639
/* global flag to enable extra checks when accessing packed objects */
extern int do_check_packed_object_crc;

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

642
extern int move_temp_to_file(const char *tmpfile, const char *filename);
643

644
extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
645
extern int has_sha1_file(const unsigned char *sha1);
646
extern int has_loose_object_nonlocal(const unsigned char *sha1);
647

648 649 650
extern int has_pack_file(const unsigned char *sha1);
extern int has_pack_index(const unsigned char *sha1);

651 652
extern const signed char hexval_table[256];
static inline unsigned int hexval(unsigned char c)
653 654 655 656
{
	return hexval_table[c];
}

657
/* Convert to/from hex/sha1 representation */
658 659 660
#define MINIMUM_ABBREV 4
#define DEFAULT_ABBREV 7

661
extern int get_sha1(const char *str, unsigned char *sha1);
Martin Koegler's avatar
Martin Koegler committed
662
extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
663 664
extern int get_sha1_hex(const char *hex, unsigned char *sha1);
extern char *sha1_to_hex(const unsigned char *sha1);	/* static buffer result! */
665
extern int read_ref(const char *filename, unsigned char *sha1);
666
extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
667
extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
668
extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
669

sprohaska's avatar
sprohaska committed
670 671
extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
extern const char *ref_rev_parse_rules[];
672
extern const char *ref_fetch_rules[];
sprohaska's avatar
sprohaska committed
673

674
extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
675
extern int validate_headref(const char *ref);
676

677
extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
678
extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
679
extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
680

681
extern void *read_object_with_reference(const unsigned char *sha1,
682
					const char *required_type,
683 684
					unsigned long *size,
					unsigned char *sha1_ret);
685

686 687 688
extern struct object *peel_to_type(const char *name, int namelen,
				   struct object *o, enum object_type);

689 690 691 692 693 694 695 696 697
enum date_mode {
	DATE_NORMAL = 0,
	DATE_RELATIVE,
	DATE_SHORT,
	DATE_LOCAL,
	DATE_ISO8601,
	DATE_RFC2822
};

698
const char *show_date(unsigned long time, int timezone, enum date_mode mode);
699
int parse_date(const char *date, char *buf, int bufsize);
700
void datestamp(char *buf, int bufsize);
701
unsigned long approxidate(const char *);
702
enum date_mode parse_date_format(const char *format);
703

704 705 706
#define IDENT_WARN_ON_NO_NAME  1
#define IDENT_ERROR_ON_NO_NAME 2
#define IDENT_NO_DATE	       4
707 708
extern const char *git_author_info(int);
extern const char *git_committer_info(int);
709
extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
710
extern const char *fmt_name(const char *name, const char *email);
711

712 713 714 715 716 717 718 719 720
struct checkout {
	const char *base_dir;
	int base_dir_len;
	unsigned force:1,
		 quiet:1,
		 not_new:1,
		 refresh_cache:1;
};

721
extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
722
extern int has_symlink_leading_path(int len, const char *name);
723

724
extern struct alternate_object_database {
725
	struct alternate_object_database *next;
726
	char *name;
727
	char base[FLEX_ARRAY]; /* more */
728
} *alt_odb_list;
729
extern void prepare_alt_odb(void);
730
extern void add_to_alternates_file(const char *reference);
731 732
typedef int alt_odb_fn(struct alternate_object_database *, void *);
extern void foreach_alt_odb(alt_odb_fn, void*);
733

734 735 736 737 738 739 740 741 742
struct pack_window {
	struct pack_window *next;
	unsigned char *base;
	off_t offset;
	size_t len;
	unsigned int last_used;
	unsigned int inuse_cnt;
};

743 744
extern struct packed_git {
	struct packed_git *next;
745
	struct pack_window *windows;
746
	off_t pack_size;
747 748 749
	const void *index_data;
	size_t index_size;
	uint32_t num_objects;
750 751
	uint32_t num_bad_objects;
	unsigned char *bad_object_sha1;
752
	int index_version;
753
	time_t mtime;
754
	int pack_fd;
755 756
	unsigned pack_local:1,
		 pack_keep:1;
757
	unsigned char sha1[20];
758 759
	/* something like ".git/objects/pack/xxxxx.pack" */
	char pack_name[FLEX_ARRAY]; /* more */
760
} *packed_git;
761 762

struct pack_entry {
763
	off_t offset;
764 765 766 767
	unsigned char sha1[20];
	struct packed_git *p;
};

768 769 770 771
struct ref {
	struct ref *next;
	unsigned char old_sha1[20];
	unsigned char new_sha1[20];
772
	char *symref;
773 774 775 776
	unsigned int force:1,
		merge:1,
		nonfastforward:1,
		deletion:1;
777 778 779 780 781 782
	enum {
		REF_STATUS_NONE = 0,
		REF_STATUS_OK,
		REF_STATUS_REJECT_NONFASTFORWARD,
		REF_STATUS_REJECT_NODELETE,
		REF_STATUS_UPTODATE,
783
		REF_STATUS_REMOTE_REJECT,
784
		REF_STATUS_EXPECTING_REPORT,
785
	} status;
786
	char *remote_status;
Junio C Hamano's avatar
Junio C Hamano committed
787
	struct ref *peer_ref; /* when renaming */
788
	char name[FLEX_ARRAY]; /* more */
789 790
};

Linus Torvalds's avatar
Linus Torvalds committed
791 792 793 794
#define REF_NORMAL	(1u << 0)
#define REF_HEADS	(1u << 1)
#define REF_TAGS	(1u << 2)

795 796
extern struct ref *find_ref_by_name(struct ref *list, const char *name);

797
#define CONNECT_VERBOSE       (1u << 0)
798
extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
799
extern int finish_connect(struct child_process *conn);
800
extern int path_match(const char *path, int nr, char **match);
801
extern int get_ack(int fd, unsigned char *result_sha1);
802 803 804 805 806
struct extra_have_objects {
	int nr, alloc;
	unsigned char (*array)[20];
};
extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
807
extern int server_supports(const char *feature);
808

809 810
extern struct packed_git *parse_pack_index(unsigned char *sha1);

811
extern void prepare_packed_git(void);
812
extern void reprepare_packed_git(void);
813 814
extern void install_packed_git(struct packed_git *pack);

Junio C Hamano's avatar
Junio C Hamano committed
815
extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
816 817
					 struct packed_git *packs);

818
extern void pack_report(void);
819
extern int open_pack_index(struct packed_git *);
820
extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
821
extern void close_pack_windows(struct packed_git *);
822
extern void unuse_pack(struct pack_window **);
823
extern void free_pack_by_name(const char *);
824
extern struct packed_git *add_packed_git(const char *, int, int);
825
extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
Nicolas Pitre's avatar
Nicolas Pitre committed
826
extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
827 828
extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
829
extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
Nicolas Pitre's avatar
Nicolas Pitre committed
830
extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
831
extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
832
extern int matches_pack_name(struct packed_git *p, const char *name);
833

834 835 836
/* Dumb servers support */
extern int update_server_info(int);

837 838 839 840
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 *);
extern int git_config(config_fn_t fn, void *);
841
extern int git_parse_ulong(const char *, unsigned long *);
842
extern int git_config_int(const char *, const char *);
843
extern unsigned long git_config_ulong(const char *, const char *);
Junio C Hamano's avatar
Junio C Hamano committed
844
extern int git_config_bool_or_int(const char *, const char *, int *);
845
extern int git_config_bool(const char *, const char *);
846
extern int git_config_string(const char **, const char *, const char *);
847
extern int git_config_set(const char *, const char *);
848
extern int git_config_set_multivar(const char *, const char *, const char *, int);
849
extern int git_config_rename_section(const char *, const char *);
850
extern const char *git_etc_gitconfig(void);
851
extern int check_repository_format_version(const char *var, const char *value, void *cb);
852 853
extern int git_config_system(void);
extern int git_config_global(void);
854
extern int config_error_nonbool(const char *);
855
extern const char *config_exclusive_filename;
856

857 858 859
#define MAX_GITNAME (1000)
extern char git_default_email[MAX_GITNAME];
extern char git_default_name[MAX_GITNAME];
860
extern int user_ident_explicitly_given;
861

862
extern const char *git_commit_encoding;
863
extern const char *git_log_output_encoding;
864

865 866
/* IO helper functions */
extern void maybe_flush_or_die(FILE *, const char *);
867
extern int copy_fd(int ifd, int ofd);
868
extern int copy_file(const char *dst, const char *src, int mode);
869 870
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);
871
extern void write_or_die(int fd, const void *buf, size_t count);
872
extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
873
extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
874
extern void fsync_or_die(int fd, const char *);
875

876 877
/* pager.c */
extern void setup_pager(void);
878
extern const char *pager_program;
879
extern int pager_in_use(void);
880
extern int pager_use_color;
881

882
extern const char *editor_program;
883
extern const char *excludes_file;
884

Junio C Hamano's avatar
Junio C Hamano committed
885
/* base85 */
886 887
int decode_85(char *dst, const char *line, int linelen);
void encode_85(char *buf, const unsigned char *data, int bytes);
Junio C Hamano's avatar
Junio C Hamano committed
888

889
/* alloc.c */
890 891 892 893 894
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);
895 896
extern void alloc_report(void);

897 898
/* trace.c */
extern void trace_printf(const char *format, ...);
899
extern void trace_argv_printf(const char **argv, const char *format, ...);
900

Linus Torvalds's avatar
Linus Torvalds committed
901
/* convert.c */
902
/* returns 1 if *dst was used */
903 904
extern int convert_to_git(const char *path, const char *src, size_t len,
                          struct strbuf *dst, enum safe_crlf checksafe);
905
extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
Linus Torvalds's avatar
Linus Torvalds committed
906

907
/* add */
908 909 910 911 912
/*
 * 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);
913

914 915 916
/* diff.c */
extern int diff_auto_refresh_index;