Stop ignoring Documentation/README
[git/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
4050c0df 4#include "git-compat-util.h"
e83c5163 5
cef661fc 6#include SHA1_HEADER
e83c5163
LT
7#include <zlib.h>
8
9da3acfb
ET
9#if ZLIB_VERNUM < 0x1200
10#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11#endif
12
962554c6 13#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
14#define DTYPE(de) ((de)->d_type)
15#else
0bdd79af
JH
16#undef DT_UNKNOWN
17#undef DT_DIR
18#undef DT_REG
19#undef DT_LNK
b6829693
ET
20#define DT_UNKNOWN 0
21#define DT_DIR 1
22#define DT_REG 2
a15c1c60 23#define DT_LNK 3
b6829693
ET
24#define DTYPE(de) DT_UNKNOWN
25#endif
26
2386d658
LT
27/*
28 * Intensive research over the course of many years has shown that
29 * port 9418 is totally unused by anything else. Or
30 *
31 * Your search - "port 9418" - did not match any documents.
32 *
33 * as www.google.com puts it.
ba8a4970
LT
34 *
35 * This port has been properly assigned for git use by IANA:
36 * git (Assigned-9418) [I06-050728-0001].
37 *
38 * git 9418/tcp git pack transfer service
39 * git 9418/udp git pack transfer service
40 *
41 * with Linus Torvalds <torvalds@osdl.org> as the point of
42 * contact. September 2005.
43 *
44 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
45 */
46#define DEFAULT_GIT_PORT 9418
47
e83c5163
LT
48/*
49 * Basic data structures for the directory cache
e83c5163
LT
50 */
51
52#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
53struct cache_header {
ccc4feb5
LT
54 unsigned int hdr_signature;
55 unsigned int hdr_version;
56 unsigned int hdr_entries;
e83c5163
LT
57};
58
59/*
60 * The "cache_time" is just the low 32 bits of the
61 * time. It doesn't matter if it overflows - we only
62 * check it for equality in the 32 bits we save.
63 */
64struct cache_time {
65 unsigned int sec;
66 unsigned int nsec;
67};
68
69/*
70 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
71 * Again - this is just a (very strong in practice) heuristic that
72 * the inode hasn't changed.
ccc4feb5
LT
73 *
74 * We save the fields in big-endian order to allow using the
75 * index file over NFS transparently.
e83c5163
LT
76 */
77struct cache_entry {
ccc4feb5
LT
78 struct cache_time ce_ctime;
79 struct cache_time ce_mtime;
80 unsigned int ce_dev;
81 unsigned int ce_ino;
82 unsigned int ce_mode;
83 unsigned int ce_uid;
84 unsigned int ce_gid;
85 unsigned int ce_size;
e83c5163 86 unsigned char sha1[20];
f5cabd13 87 unsigned short ce_flags;
8f1d2e6f 88 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
89};
90
95fd5bf8
LT
91#define CE_NAMEMASK (0x0fff)
92#define CE_STAGEMASK (0x3000)
220a0b52 93#define CE_UPDATE (0x4000)
5f73076c 94#define CE_VALID (0x8000)
aee46198 95#define CE_STAGESHIFT 12
95fd5bf8 96
aee46198
JH
97#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
98#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
99#define ce_size(ce) cache_entry_size(ce_namelen(ce))
100#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
101
e4479470 102#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
103static inline unsigned int create_ce_mode(unsigned int mode)
104{
8ae0a8c5
KS
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
db823d4a 107 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 108}
1b0c7174
JH
109#define canon_mode(mode) \
110 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
111 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
e4479470 112
aee46198 113#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 114
88355048
PB
115extern struct cache_entry **active_cache;
116extern unsigned int active_nr, active_alloc, active_cache_changed;
bad68ec9 117extern struct cache_tree *active_cache_tree;
8fd2cb40 118extern int cache_errno;
e83c5163 119
8ac069ac
JH
120#define GIT_DIR_ENVIRONMENT "GIT_DIR"
121#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 122#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 123#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 124#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
d4ebc36c
JH
125#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
126#define CONFIG_ENVIRONMENT "GIT_CONFIG"
127#define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
128#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
bb233d69 129
7d1864ce
JH
130extern int is_bare_repository_cfg;
131extern int is_bare_repository(void);
c5fba16c 132extern const char *get_git_dir(void);
8ac069ac 133extern char *get_object_directory(void);
95fc7512 134extern char *get_refs_directory(void);
8ac069ac 135extern char *get_index_file(void);
5da5c8f4 136extern char *get_graft_file(void);
8ac069ac
JH
137
138#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 139
6b5ee137 140extern const char **get_pathspec(const char *prefix, const char **pathspec);
4ca06608 141extern const char *setup_git_directory_gently(int *);
d288a700 142extern const char *setup_git_directory(void);
6b5ee137 143extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 144extern const char *prefix_filename(const char *prefix, int len, const char *path);
e23d0b4a 145extern void verify_filename(const char *prefix, const char *name);
ea92f41f 146extern void verify_non_filename(const char *prefix, const char *name);
d288a700 147
e83c5163
LT
148#define alloc_nr(x) (((x)+16)*3/2)
149
734aab75 150/* Initialize and use the cache information */
e83c5163 151extern int read_cache(void);
8fd2cb40 152extern int read_cache_from(const char *path);
197ee8c9 153extern int write_cache(int newfd, struct cache_entry **cache, int entries);
6d297f81 154extern int discard_cache(void);
8dcf39c4 155extern int verify_path(const char *path);
eb38c22f 156extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
157#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
158#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 159#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 160extern int add_cache_entry(struct cache_entry *ce, int option);
8fd2cb40 161extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
dbbce55b 162extern int remove_cache_entry_at(int pos);
6b5ee137 163extern int remove_file_from_cache(const char *path);
11be42a4 164extern int add_file_to_index(const char *path, int verbose);
dbbce55b 165extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5f73076c
JH
166extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
167extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
c0fd1f51 168extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
7672db20 169extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
e7332f96 170extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
024510c8 171extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
ec1fcc16 172extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
173extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
174
405e5b2f
LT
175#define REFRESH_REALLY 0x0001 /* ignore_valid */
176#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
177#define REFRESH_QUIET 0x0004 /* be quiet about it */
178#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
179extern int refresh_cache(unsigned int flags);
180
021b6e45
JH
181struct lock_file {
182 struct lock_file *next;
1084b845 183 char on_list;
021b6e45 184 char filename[PATH_MAX];
415e96c8 185};
40aaae88 186extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
021b6e45
JH
187extern int commit_lock_file(struct lock_file *);
188extern void rollback_lock_file(struct lock_file *);
ac5409e4 189extern int delete_ref(const char *, unsigned char *sha1);
734aab75 190
2ae1c53b 191/* Environment bits from configuration mechanism */
93821bd9 192extern int use_legacy_headers;
17712991 193extern int trust_executable_bit;
5f73076c 194extern int assume_unchanged;
9f0bb90d 195extern int prefer_symlink_refs;
6de08ae6 196extern int log_all_ref_updates;
2f8acdb3 197extern int warn_ambiguous_refs;
457f06d6 198extern int shared_repository;
2ae1c53b 199extern const char *apply_default_whitespace;
12f6c308 200extern int zlib_compression_level;
60bb8b14 201extern size_t packed_git_window_size;
77ccc5bb 202extern size_t packed_git_limit;
17712991 203
ab9cb76f
JH
204#define GIT_REPO_VERSION 0
205extern int repository_format_version;
206extern int check_repository_format(void);
207
734aab75
LT
208#define MTIME_CHANGED 0x0001
209#define CTIME_CHANGED 0x0002
210#define OWNER_CHANGED 0x0004
211#define MODE_CHANGED 0x0008
212#define INODE_CHANGED 0x0010
213#define DATA_CHANGED 0x0020
8ae0a8c5 214#define TYPE_CHANGED 0x0040
e83c5163
LT
215
216/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
217extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
218extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 219extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
220extern char *sha1_pack_name(const unsigned char *sha1);
221extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 222extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 223extern const unsigned char null_sha1[20];
0bef57ee
DR
224static inline int is_null_sha1(const unsigned char *sha1)
225{
226 return !memcmp(sha1, null_sha1, 20);
227}
a89fccd2
DR
228static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
229{
230 return memcmp(sha1, sha2, 20);
231}
e702496e
SP
232static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
233{
234 memcpy(sha_dst, sha_src, 20);
235}
a8e0d16d
JH
236static inline void hashclr(unsigned char *hash)
237{
238 memset(hash, 0, 20);
239}
e83c5163 240
f2db68ed
HE
241int git_mkstemp(char *path, size_t n, const char *template);
242
94df2506
JH
243enum sharedrepo {
244 PERM_UMASK = 0,
245 PERM_GROUP,
246 PERM_EVERYBODY
247};
248int git_config_perm(const char *var, const char *value);
457f06d6 249int adjust_shared_perm(const char *path);
b2cb9425 250int safe_create_leading_directories(char *path);
bd22c904 251char *enter_repo(char *path, int strict);
b2cb9425 252
e83c5163 253/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
36e4d74a 254extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 255extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 256extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
abdc3fc8 257extern int hash_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *sha1);
bf0f910d 258extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
8237b185 259
5d6ccf5c 260extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 261
70b9829e
DB
262extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
263 size_t bufsize, size_t *bufposn);
a5eda52b 264extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
839837b9 265extern int move_temp_to_file(const char *tmpfile, const char *filename);
8237b185 266
106d710b 267extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
8237b185 268extern int has_sha1_file(const unsigned char *sha1);
bb6b8e4f
JH
269extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
270extern int legacy_loose_object(unsigned char *);
8237b185 271
bf592c50
DB
272extern int has_pack_file(const unsigned char *sha1);
273extern int has_pack_index(const unsigned char *sha1);
274
72518e9c
JH
275enum object_type {
276 OBJ_NONE = 0,
277 OBJ_COMMIT = 1,
278 OBJ_TREE = 2,
279 OBJ_BLOB = 3,
280 OBJ_TAG = 4,
eb32d236
NP
281 /* 5 for future expansion */
282 OBJ_OFS_DELTA = 6,
283 OBJ_REF_DELTA = 7,
72518e9c
JH
284 OBJ_BAD,
285};
286
e49521b5
JH
287extern signed char hexval_table[256];
288static inline unsigned int hexval(unsigned int c)
289{
290 return hexval_table[c];
291}
292
e83c5163 293/* Convert to/from hex/sha1 representation */
46a6c262
JH
294#define MINIMUM_ABBREV 4
295#define DEFAULT_ABBREV 7
296
3c249c95 297extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
298extern int get_sha1_hex(const char *hex, unsigned char *sha1);
299extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 300extern int read_ref(const char *filename, unsigned char *sha1);
8da19775 301extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
e86eb666
JH
302extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
303
ed378ec7 304extern int create_symref(const char *ref, const char *refs_heads_master);
c847f537 305extern int validate_headref(const char *ref);
e83c5163 306
958ba6c9 307extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 308extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 309
40469ee9 310extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 311 const char *required_type,
40469ee9
JH
312 unsigned long *size,
313 unsigned char *sha1_ret);
f4913f91 314
9a8e35e9 315const char *show_date(unsigned long time, int timezone, int relative);
2a387043 316const char *show_rfc2822_date(unsigned long time, int timezone);
2a39064c 317int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 318void datestamp(char *buf, int bufsize);
3c07b1d1 319unsigned long approxidate(const char *);
ecee9d9e 320
6aa33f40 321extern int setup_ident(void);
276bc2ca 322extern void ignore_missing_committer_name(void);
749be728
JH
323extern const char *git_author_info(int);
324extern const char *git_committer_info(int);
6aa33f40 325
12dccc16
LT
326struct checkout {
327 const char *base_dir;
328 int base_dir_len;
329 unsigned force:1,
330 quiet:1,
331 not_new:1,
332 refresh_cache:1;
333};
334
de84f99c 335extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
12dccc16 336
9a217f2a 337extern struct alternate_object_database {
d5a63b99 338 struct alternate_object_database *next;
9a217f2a 339 char *name;
8f1d2e6f 340 char base[FLEX_ARRAY]; /* more */
d5a63b99 341} *alt_odb_list;
9a217f2a
JH
342extern void prepare_alt_odb(void);
343
c41ee586
SP
344struct pack_window {
345 struct pack_window *next;
346 unsigned char *base;
347 off_t offset;
348 size_t len;
349 unsigned int last_used;
350 unsigned int inuse_cnt;
351};
352
9a217f2a
JH
353extern struct packed_git {
354 struct packed_git *next;
c41ee586 355 struct pack_window *windows;
b18b00a6 356 uint32_t *index_base;
2dc3a234
SP
357 off_t index_size;
358 off_t pack_size;
9bc879c1 359 int pack_fd;
9d835df2 360 int pack_local;
bf592c50 361 unsigned char sha1[20];
8f1d2e6f
JH
362 /* something like ".git/objects/pack/xxxxx.pack" */
363 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 364} *packed_git;
f3bf9224
JH
365
366struct pack_entry {
367 unsigned int offset;
368 unsigned char sha1[20];
369 struct packed_git *p;
370};
371
d1c133f5
LT
372struct ref {
373 struct ref *next;
374 unsigned char old_sha1[20];
375 unsigned char new_sha1[20];
ff27adf3 376 unsigned char force;
f88395ac 377 struct ref *peer_ref; /* when renaming */
8f1d2e6f 378 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
379};
380
2718ff09
LT
381#define REF_NORMAL (1u << 0)
382#define REF_HEADS (1u << 1)
383#define REF_TAGS (1u << 2)
384
f42a5c4e 385extern pid_t git_connect(int fd[2], char *url, const char *prog);
f7192598 386extern int finish_connect(pid_t pid);
013e7c7f 387extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
388extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
389 int nr_refspec, char **refspec, int all);
41cb7488 390extern int get_ack(int fd, unsigned char *result_sha1);
2718ff09 391extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
211b5f9e 392extern int server_supports(const char *feature);
f7192598 393
bf592c50 394extern struct packed_git *parse_pack_index(unsigned char *sha1);
2ab141a2 395extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
c508df5e 396 char *idx_path);
bf592c50 397
9a217f2a 398extern void prepare_packed_git(void);
fc04c412 399extern void reprepare_packed_git(void);
bf592c50
DB
400extern void install_packed_git(struct packed_git *pack);
401
402extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
403 struct packed_git *packs);
404
276bc2ca 405extern void pack_report(void);
03e79c88
SP
406extern unsigned char* use_pack(struct packed_git *, struct pack_window **, unsigned long, unsigned int *);
407extern void unuse_pack(struct pack_window **);
9d835df2 408extern struct packed_git *add_packed_git(char *, int, int);
9a217f2a
JH
409extern int num_packed_objects(const struct packed_git *p);
410extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
43057304 411extern unsigned long find_pack_entry_one(const unsigned char *, struct packed_git *);
4d703a1a 412extern void *unpack_entry(struct packed_git *, unsigned long, char *, unsigned long *);
72518e9c 413extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
43057304 414extern void packed_object_info_detail(struct packed_git *, unsigned long, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
9a217f2a 415
8f3f9b09
JH
416/* Dumb servers support */
417extern int update_server_info(int);
418
17712991
LT
419typedef int (*config_fn_t)(const char *, const char *);
420extern int git_default_config(const char *, const char *);
4f629539 421extern int git_config_from_file(config_fn_t fn, const char *);
17712991
LT
422extern int git_config(config_fn_t fn);
423extern int git_config_int(const char *, const char *);
424extern int git_config_bool(const char *, const char *);
10bea152 425extern int git_config_set(const char *, const char *);
4ddba79d 426extern int git_config_set_multivar(const char *, const char *, const char *, int);
0667fcfb 427extern int git_config_rename_section(const char *, const char *);
ab9cb76f 428extern int check_repository_format_version(const char *var, const char *value);
17712991 429
e1b10391
LT
430#define MAX_GITNAME (1000)
431extern char git_default_email[MAX_GITNAME];
432extern char git_default_name[MAX_GITNAME];
433
d2c11a38
JH
434extern char *git_commit_encoding;
435extern char *git_log_output_encoding;
4e72dcec 436
f3123c4a 437extern int copy_fd(int ifd, int ofd);
93d26e4c 438extern int read_in_full(int fd, void *buf, size_t count);
e0814056 439extern int write_in_full(int fd, const void *buf, size_t count);
7230e6d0 440extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 441extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 442extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
ad897215 443
f67b45f8
LT
444/* pager.c */
445extern void setup_pager(void);
85fb65ed 446extern int pager_in_use;
aa086eb8 447extern int pager_use_color;
f67b45f8 448
051308f6
JH
449/* base85 */
450int decode_85(char *dst, char *line, int linelen);
0660626c 451void encode_85(char *buf, unsigned char *data, int bytes);
051308f6 452
855419f7
LT
453/* alloc.c */
454struct blob;
455struct tree;
456struct commit;
457struct tag;
458extern struct blob *alloc_blob_node(void);
459extern struct tree *alloc_tree_node(void);
460extern struct commit *alloc_commit_node(void);
461extern struct tag *alloc_tag_node(void);
462extern void alloc_report(void);
463
6ce4e61f
CC
464/* trace.c */
465extern int nfvasprintf(char **str, const char *fmt, va_list va);
466extern void trace_printf(const char *format, ...);
467extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
468
e83c5163 469#endif /* CACHE_H */