cache.h 47.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
#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
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);
37
void git_deflate_init_raw(git_zstream *, int level);
38
void git_deflate_end(git_zstream *);
39
int git_deflate_abort(git_zstream *);
40 41 42
int git_deflate_end_gently(git_zstream *);
int git_deflate(git_zstream *, int flush);
unsigned long git_deflate_bound(git_zstream *, unsigned long);
43

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

Martin Koegler's avatar
Martin Koegler committed
58 59 60
/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
#define S_IFINVALID     0030000

61 62 63 64 65 66 67 68 69 70 71 72 73
/*
 * 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
74 75
#define S_IFGITLINK	0160000
#define S_ISGITLINK(m)	(((m) & S_IFMT) == S_IFGITLINK)
76

77 78 79 80 81 82 83
/*
 * 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.
84 85 86 87 88 89 90 91 92 93 94
 *
 * 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
95 96 97
 */
#define DEFAULT_GIT_PORT 9418

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

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

109 110 111
#define INDEX_FORMAT_LB 2
#define INDEX_FORMAT_UB 4

112 113 114 115 116 117
/*
 * 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 {
118 119
	uint32_t sec;
	uint32_t nsec;
120 121
};

122 123 124 125 126 127 128 129 130 131
struct stat_data {
	struct cache_time sd_ctime;
	struct cache_time sd_mtime;
	unsigned int sd_dev;
	unsigned int sd_ino;
	unsigned int sd_uid;
	unsigned int sd_gid;
	unsigned int sd_size;
};

132
struct cache_entry {
133
	struct stat_data ce_stat_data;
134
	unsigned int ce_mode;
135
	unsigned int ce_flags;
136
	unsigned int ce_namelen;
137
	unsigned char sha1[20];
138
	struct cache_entry *next;
139
	char name[FLEX_ARRAY]; /* more */
140 141
};

142
#define CE_STAGEMASK (0x3000)
143
#define CE_EXTENDED  (0x4000)
Junio C Hamano's avatar
Junio C Hamano committed
144
#define CE_VALID     (0x8000)
145
#define CE_STAGESHIFT 12
146

Duy Nguyen's avatar
Duy Nguyen committed
147 148 149 150 151 152 153 154 155
/*
 * 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
 */
156 157 158 159
#define CE_UPDATE            (1 << 16)
#define CE_REMOVE            (1 << 17)
#define CE_UPTODATE          (1 << 18)
#define CE_ADDED             (1 << 19)
160

161 162 163 164
#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)
165

166
#define CE_UNPACKED          (1 << 24)
167
#define CE_NEW_SKIP_WORKTREE (1 << 25)
168

169 170 171
/* used to temporarily mark paths matched by pathspecs */
#define CE_MATCHED           (1 << 26)

Duy Nguyen's avatar
Duy Nguyen committed
172 173 174
/*
 * Extended on-disk flags
 */
175 176
#define CE_INTENT_TO_ADD     (1 << 29)
#define CE_SKIP_WORKTREE     (1 << 30)
Duy Nguyen's avatar
Duy Nguyen committed
177
/* CE_EXTENDED2 is for future extension */
178
#define CE_EXTENDED2         (1 << 31)
Duy Nguyen's avatar
Duy Nguyen committed
179

180
#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
Duy Nguyen's avatar
Duy Nguyen committed
181 182 183 184 185 186 187 188 189 190 191

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

192 193
struct pathspec;

194 195 196 197 198
/*
 * 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)
199 200
static inline void copy_cache_entry(struct cache_entry *dst,
				    const struct cache_entry *src)
201 202 203 204 205 206 207 208 209 210
{
	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
static inline unsigned create_ce_flags(unsigned stage)
212
{
213
	return (stage << CE_STAGESHIFT);
214 215
}

216
#define ce_namelen(ce) ((ce)->ce_namelen)
217
#define ce_size(ce) cache_entry_size(ce_namelen(ce))
218
#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
219
#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
220
#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
221
#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
222

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

269
#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
270

271 272
struct index_state {
	struct cache_entry **cache;
273
	unsigned int version;
274
	unsigned int cache_nr, cache_alloc, cache_changed;
275
	struct string_list *resolve_undo;
276
	struct cache_tree *cache_tree;
277
	struct cache_time timestamp;
278 279
	unsigned name_hash_initialized : 1,
		 initialized : 1;
280
	struct hash_table name_hash;
281
	struct hash_table dir_hash;
282 283 284 285
};

extern struct index_state the_index;

286 287
/* Name hashing */
extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
288 289
extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
extern void free_name_hash(struct index_state *istate);
290 291


292
#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
293 294 295 296 297
#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)
298

299 300
#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
301
#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
302
#define is_cache_unborn() is_index_unborn(&the_index)
303
#define read_cache_unmerged() read_index_unmerged(&the_index)
304 305
#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
#define discard_cache() discard_index(&the_index)
306
#define unmerged_cache() unmerged_index(&the_index)
307 308
#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))
309
#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
310 311
#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))
312 313
#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))
314
#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
315 316
#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))
317 318
#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
319
#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
320
#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
321
#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
322
#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
323
#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
324
#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
325
#endif
326

327 328 329 330 331 332 333 334 335 336
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,
337
	OBJ_ANY,
338
	OBJ_MAX
339 340
};

341 342 343 344 345 346 347
static inline enum object_type object_type(unsigned int mode)
{
	return S_ISDIR(mode) ? OBJ_TREE :
		S_ISGITLINK(mode) ? OBJ_COMMIT :
		OBJ_BLOB;
}

348
/* Double-check local_repo_env below if you add to this list. */
349
#define GIT_DIR_ENVIRONMENT "GIT_DIR"
350
#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
351
#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
352
#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
353
#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
354
#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
355
#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
356
#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
357 358
#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
#define CONFIG_ENVIRONMENT "GIT_CONFIG"
359
#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
360
#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
361
#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
362
#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
363 364
#define GITATTRIBUTES_FILE ".gitattributes"
#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamano's avatar
Junio C Hamano committed
365
#define ATTRIBUTE_MACRO_PREFIX "[attr]"
Johannes Schindelin's avatar
Johannes Schindelin committed
366 367
#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
368
#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
369 370
#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
371
#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
372 373
#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
374
#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
375

376
/*
377 378 379 380 381 382 383 384 385 386 387
 * This environment variable is expected to contain a boolean indicating
 * whether we should or should not treat:
 *
 *   GIT_DIR=foo.git git ...
 *
 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
 * of this, but we use it internally to communicate to sub-processes that we
 * are in a bare repo. If not set, defaults to true.
 */
#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"

388
/*
389 390 391 392
 * Repository-local GIT_* environment variables; these will be cleared
 * when git spawns a sub-process that runs inside another repository.
 * The array is NULL-terminated, which makes it easy to pass in the "env"
 * parameter of a run-command invocation, or to do a simple walk.
393
 */
394
extern const char * const local_repo_env[];
395

396 397
extern int is_bare_repository_cfg;
extern int is_bare_repository(void);
398
extern int is_inside_git_dir(void);
399
extern char *git_work_tree_cfg;
400
extern int is_inside_work_tree(void);
401
extern const char *get_git_dir(void);
402
extern int is_git_directory(const char *path);
403 404
extern char *get_object_directory(void);
extern char *get_index_file(void);
405
extern char *get_graft_file(void);
406
extern int set_git_dir(const char *path);
407 408
extern const char *get_git_namespace(void);
extern const char *strip_namespace(const char *namespaced_ref);
409
extern const char *get_git_work_tree(void);
410
extern const char *read_gitfile(const char *path);
411
extern const char *resolve_gitdir(const char *suspect);
412
extern void set_git_work_tree(const char *tree);
413 414

#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
415

Junio C Hamano's avatar
Junio C Hamano committed
416
extern const char **get_pathspec(const char *prefix, const char **pathspec);
Mike Hommey's avatar
Mike Hommey committed
417
extern void setup_work_tree(void);
418
extern const char *setup_git_directory_gently(int *);
419
extern const char *setup_git_directory(void);
420
extern char *prefix_path(const char *prefix, int len, const char *path);
421
extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
422
extern const char *prefix_filename(const char *prefix, int len, const char *path);
423
extern int check_filename(const char *prefix, const char *name);
424 425 426
extern void verify_filename(const char *prefix,
			    const char *name,
			    int diagnose_misspelt_rev);
427
extern void verify_non_filename(const char *prefix, const char *name);
428
extern int path_inside_repo(const char *prefix, const char *path);
429

430 431
#define INIT_DB_QUIET 0x0001

432
extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
433 434
extern int init_db(const char *template_dir, unsigned int flags);

435 436
extern void sanitize_stdfds(void);

437 438
#define alloc_nr(x) (((x)+16)*3/2)

Jeff King's avatar
Jeff King committed
439 440 441 442 443
/*
 * 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.
 *
444
 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
Jeff King's avatar
Jeff King committed
445 446 447
 */
#define ALLOC_GROW(x, nr, alloc) \
	do { \
Jeff King's avatar
Jeff King committed
448
		if ((nr) > alloc) { \
449 450 451 452
			if (alloc_nr(alloc) < (nr)) \
				alloc = (nr); \
			else \
				alloc = alloc_nr(alloc); \
Jeff King's avatar
Jeff King committed
453 454
			x = xrealloc((x), alloc * sizeof(*(x))); \
		} \
455
	} while (0)
Jeff King's avatar
Jeff King committed
456

457
/* Initialize and use the cache information */
458
extern int read_index(struct index_state *);
459
extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
460
extern int read_index_from(struct index_state *, const char *path);
461
extern int is_index_unborn(struct index_state *);
462
extern int read_index_unmerged(struct index_state *);
463
extern int write_index(struct index_state *, int newfd);
464
extern int discard_index(struct index_state *);
465
extern int unmerged_index(const struct index_state *);
466
extern int verify_path(const char *path);
467 468
extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
469
extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
470
extern int index_name_pos(const struct index_state *, const char *name, int namelen);
471 472
#define ADD_CACHE_OK_TO_ADD 1		/* Ok to add */
#define ADD_CACHE_OK_TO_REPLACE 2	/* Ok to replace file/directory */
473
#define ADD_CACHE_SKIP_DFCHECK 4	/* Ok to skip DF conflict checks */
474
#define ADD_CACHE_JUST_APPEND 8		/* Append only; tree.c::read_tree() */
475
#define ADD_CACHE_NEW_ONLY 16		/* Do not replace existing ones */
476
extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
477
extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
478
extern int remove_index_entry_at(struct index_state *, int pos);
479
extern void remove_marked_cache_entries(struct index_state *istate);
480
extern int remove_file_from_index(struct index_state *, const char *path);
481 482
#define ADD_CACHE_VERBOSE 1
#define ADD_CACHE_PRETEND 2
Junio C Hamano's avatar
Junio C Hamano committed
483
#define ADD_CACHE_IGNORE_ERRORS	4
484
#define ADD_CACHE_IGNORE_REMOVAL 8
485
#define ADD_CACHE_INTENT 16
486
#define ADD_CACHE_IMPLICIT_DOT 32	/* internal to "git add -u/-A" */
487 488
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);
489
extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
490
extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
491
extern int index_name_is_other(const struct index_state *, const char *, int);
492
extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
493 494 495 496

/* 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 */
497 498 499
#define CE_MATCH_RACY_IS_DIRTY		02
/* do stat comparison even if CE_SKIP_WORKTREE is true */
#define CE_MATCH_IGNORE_SKIP_WORKTREE	04
500 501
extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
502

503
extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
504 505 506 507 508

#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);
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523

/*
 * Record to sd the data from st that we use to check whether a file
 * might have changed.
 */
extern void fill_stat_data(struct stat_data *sd, struct stat *st);

/*
 * Return 0 if st is consistent with a file not having been changed
 * since sd was filled.  If there are differences, return a
 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
 * INODE_CHANGED, and DATA_CHANGED.
 */
extern int match_stat_data(const struct stat_data *sd, struct stat *st);

524 525
extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);

526 527 528 529
#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 */
530
#define REFRESH_IGNORE_SUBMODULES	0x0010	/* ignore submodules */
531
#define REFRESH_IN_PORCELAIN	0x0020	/* user friendly output, not "needs update" */
532
extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
533

534 535
struct lock_file {
	struct lock_file *next;
536
	int fd;
537
	pid_t owner;
538
	char on_list;
539
	char filename[PATH_MAX];
540
};
541 542
#define LOCK_DIE_ON_ERROR 1
#define LOCK_NODEREF 2
543
extern int unable_to_lock_error(const char *path, int err);
544
extern NORETURN void unable_to_lock_index_die(const char *path, int err);
545
extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
546
extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
547
extern int commit_lock_file(struct lock_file *);
548
extern void update_index_if_able(struct index_state *, struct lock_file *);
549 550 551

extern int hold_locked_index(struct lock_file *, int);
extern int commit_locked_index(struct lock_file *);
552
extern void set_alternate_index_output(const char *);
553
extern int close_lock_file(struct lock_file *);
554
extern void rollback_lock_file(struct lock_file *);
555
extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
556

557
/* Environment bits from configuration mechanism */
558
extern int trust_executable_bit;
559
extern int trust_ctime;
560
extern int check_stat;
561
extern int quote_path_fully;
562
extern int has_symlinks;
563
extern int minimum_abbrev, default_abbrev;
564
extern int ignore_case;
Junio C Hamano's avatar
Junio C Hamano committed
565
extern int assume_unchanged;
566
extern int prefer_symlink_refs;
567
extern int log_all_ref_updates;
568
extern int warn_ambiguous_refs;
569
extern int warn_on_object_refname_ambiguity;
570
extern int shared_repository;
571
extern const char *apply_default_whitespace;
572
extern const char *apply_default_ignorewhitespace;
573
extern const char *git_attributes_file;
574
extern int zlib_compression_level;
575 576
extern int core_compression_level;
extern int core_compression_seen;
577
extern size_t packed_git_window_size;
578
extern size_t packed_git_limit;
579
extern size_t delta_base_cache_limit;
580
extern unsigned long big_file_threshold;
581
extern unsigned long pack_size_limit_cfg;
582
extern int read_replace_refs;
583
extern int fsync_object_files;
Linus Torvalds's avatar
Linus Torvalds committed
584
extern int core_preload_index;
585
extern int core_apply_sparse_checkout;
586
extern int precomposed_unicode;
587
extern int protect_hfs;
588

Junio C Hamano's avatar
Junio C Hamano committed
589 590 591 592 593 594
/*
 * The character that begins a commented line in user-editable file
 * that is subject to stripspace.
 */
extern char comment_line_char;

595
enum branch_track {
596
	BRANCH_TRACK_UNSPECIFIED = -1,
597 598 599 600
	BRANCH_TRACK_NEVER = 0,
	BRANCH_TRACK_REMOTE,
	BRANCH_TRACK_ALWAYS,
	BRANCH_TRACK_EXPLICIT,
601
	BRANCH_TRACK_OVERRIDE
602 603
};

604 605 606 607
enum rebase_setup_type {
	AUTOREBASE_NEVER = 0,
	AUTOREBASE_LOCAL,
	AUTOREBASE_REMOTE,
608
	AUTOREBASE_ALWAYS
609 610
};

611 612 613
enum push_default_type {
	PUSH_DEFAULT_NOTHING = 0,
	PUSH_DEFAULT_MATCHING,
614
	PUSH_DEFAULT_SIMPLE,
615
	PUSH_DEFAULT_UPSTREAM,
616 617
	PUSH_DEFAULT_CURRENT,
	PUSH_DEFAULT_UNSPECIFIED
618 619
};

620
extern enum branch_track git_branch_track;
621
extern enum rebase_setup_type autorebase;
622
extern enum push_default_type push_default;
623

624 625
enum object_creation_mode {
	OBJECT_CREATION_USES_HARDLINKS = 0,
626
	OBJECT_CREATION_USES_RENAMES = 1
627 628 629
};

extern enum object_creation_mode object_creation_mode;
630

Johannes Schindelin's avatar
Johannes Schindelin committed
631 632
extern char *notes_ref_name;

633 634
extern int grafts_replace_parents;

635 636 637 638
#define GIT_REPO_VERSION 0
extern int repository_format_version;
extern int check_repository_format(void);

639 640 641 642 643 644
#define MTIME_CHANGED	0x0001
#define CTIME_CHANGED	0x0002
#define OWNER_CHANGED	0x0004
#define MODE_CHANGED    0x0008
#define INODE_CHANGED   0x0010
#define DATA_CHANGED    0x0020
645
#define TYPE_CHANGED    0x0040
646

647 648
extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
649 650
extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
	__attribute__((format (printf, 3, 4)));
651 652
extern char *git_pathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
653 654
extern char *mkpathdup(const char *fmt, ...)
	__attribute__((format (printf, 1, 2)));
655

656
/* Return a statically allocated filename matching the sha1 signature */
Timo Sirainen's avatar
Timo Sirainen committed
657 658
extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
659 660 661
extern char *git_path_submodule(const char *path, const char *fmt, ...)
	__attribute__((format (printf, 2, 3)));

662
extern char *sha1_file_name(const unsigned char *sha1);
663 664
extern char *sha1_pack_name(const unsigned char *sha1);
extern char *sha1_pack_index_name(const unsigned char *sha1);
665
extern const char *find_unique_abbrev(const unsigned char *sha1, int);
Junio C Hamano's avatar
Junio C Hamano committed
666
extern const unsigned char null_sha1[20];
667 668

static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
669
{
670 671 672 673 674 675 676 677
	int i;

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

	return 0;
678
}
679 680

static inline int is_null_sha1(const unsigned char *sha1)
681
{
682
	return !hashcmp(sha1, null_sha1);
683
}
684

685 686 687 688
static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
{
	memcpy(sha_dst, sha_src, 20);
}
689 690 691 692
static inline void hashclr(unsigned char *hash)
{
	memset(hash, 0, 20);
}
693

694 695
#define EMPTY_TREE_SHA1_HEX \
	"4b825dc642cb6eb9a060e54bf8d69288fbee4904"
696
#define EMPTY_TREE_SHA1_BIN_LITERAL \
697 698
	 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
	 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
699 700
#define EMPTY_TREE_SHA1_BIN \
	 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
701

702 703 704 705 706 707 708 709 710 711 712 713 714
#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);
}

715 716
int git_mkstemp(char *path, size_t n, const char *template);

717 718
int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);

719 720 721 722
/* 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);

723 724 725 726 727 728 729 730
/*
 * 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.
 */
731
enum sharedrepo {
732 733 734 735
	PERM_UMASK          = 0,
	OLD_PERM_GROUP      = 1,
	OLD_PERM_EVERYBODY  = 2,
	PERM_GROUP          = 0660,
736
	PERM_EVERYBODY      = 0664
737 738
};
int git_config_perm(const char *var, const char *value);
739
int adjust_shared_perm(const char *path);
740
int safe_create_leading_directories(char *path);
741
int safe_create_leading_directories_const(const char *path);
742
int mkdir_in_gitdir(const char *path);
743
extern void home_config_paths(char **global, char **xdg, char *file);
744
extern char *expand_user_path(const char *path);
745
const char *enter_repo(const char *path, int strict);
746 747
static inline int is_absolute_path(const char *path)
{
748
	return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
749
}
750
int is_directory(const char *);
751
const char *real_path(const char *path);
752
const char *real_path_if_valid(const char *path);
753
const char *absolute_path(const char *path);
754
const char *remove_leading_path(const char *in, const char *prefix);
755
const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
756
int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
757
int normalize_path_copy(char *dst, const char *src);
758
int longest_ancestor_length(const char *path, struct string_list *prefixes);
759
char *strip_path_suffix(const char *path, const char *suffix);
760
int daemon_avoid_alias(const char *path);
761
int offset_1st_component(const char *path);
762

763
/* object replacement */
764 765
#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);
766 767
static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
{
768 769
	return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
}
770 771 772 773 774 775
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);
776
}
777

778
/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
779
extern int sha1_object_info(const unsigned char *, unsigned long *);
780
extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
781
extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
782
extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
783
extern int force_object_loose(const unsigned char *sha1, time_t mtime);
784
extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
Junio C Hamano's avatar
Junio C Hamano committed
785
extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
786
extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
787

788 789 790
/* global flag to enable extra checks when accessing packed objects */
extern int do_check_packed_object_crc;

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

793
extern int move_temp_to_file(const char *tmpfile, const char *filename);
794

795
extern int has_sha1_pack(const unsigned char *sha1);
796
extern int has_sha1_file(const unsigned char *sha1);
797
extern int has_loose_object_nonlocal(const unsigned char *sha1);
798

799 800
extern int has_pack_index(const unsigned char *sha1);

801 802
extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);

803 804
extern const signed char hexval_table[256];
static inline unsigned int hexval(unsigned char c)
805 806 807 808
{
	return hexval_table[c];
}

809
/* Convert to/from hex/sha1 representation */
810 811
#define MINIMUM_ABBREV minimum_abbrev
#define DEFAULT_ABBREV default_abbrev
812

813 814 815 816 817 818
struct object_context {
	unsigned char tree[20];
	char path[PATH_MAX];
	unsigned mode;
};

819 820 821 822 823 824
#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
825
#define GET_SHA1_ONLY_TO_DIE 04000
826

827
extern int get_sha1(const char *str, unsigned char *sha1);
828
extern int get_sha1_commit(const char *str, unsigned char *sha1);
829
extern int get_sha1_committish(const char *str, unsigned char *sha1);
830 831 832
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);
833
extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
834
extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
835

836 837
typedef int each_abbrev_fn(const unsigned char *sha1, void *);
extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
838 839 840 841 842 843 844 845

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

848
extern char *sha1_to_hex(const unsigned char *sha1);	/* static buffer result! */
849
extern int read_ref_full(const char *refname, unsigned char *sha1,
850
			 int reading, int *flags);
851
extern int read_ref(const char *refname, unsigned char *sha1);
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882

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

886
extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
887
extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
888
extern int interpret_branch_name(const char *str, int len, struct strbuf *);
889
extern int get_sha1_mb(const char *str, unsigned char *sha1);
890

Steffen Prohaska's avatar
Steffen Prohaska committed
891 892
extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
extern const char *ref_rev_parse_rules[];
893
#define ref_fetch_rules ref_rev_parse_rules
Steffen Prohaska's avatar
Steffen Prohaska committed
894

895
extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
896
extern int validate_headref(const char *ref);
897

898
extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
899
extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
900
extern int cache_name_compare(const char *