git-diff: Add --staged as a synonym for --cached.
[git/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
4050c0df 4#include "git-compat-util.h"
5ecd293d 5#include "strbuf.h"
cf558704 6#include "hash.h"
e83c5163 7
cef661fc 8#include SHA1_HEADER
9126f009
NP
9#ifndef git_SHA_CTX
10#define git_SHA_CTX SHA_CTX
11#define git_SHA1_Init SHA1_Init
12#define git_SHA1_Update SHA1_Update
13#define git_SHA1_Final SHA1_Final
14#endif
e83c5163 15
9126f009 16#include <zlib.h>
609a2289 17#if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
9da3acfb
ET
18#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
19#endif
20
962554c6 21#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
22#define DTYPE(de) ((de)->d_type)
23#else
0bdd79af
JH
24#undef DT_UNKNOWN
25#undef DT_DIR
26#undef DT_REG
27#undef DT_LNK
b6829693
ET
28#define DT_UNKNOWN 0
29#define DT_DIR 1
30#define DT_REG 2
a15c1c60 31#define DT_LNK 3
b6829693
ET
32#define DTYPE(de) DT_UNKNOWN
33#endif
34
40689ae1
MK
35/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
36#define S_IFINVALID 0030000
37
9eec4795
LT
38/*
39 * A "directory link" is a link to another git directory.
40 *
41 * The value 0160000 is not normally a valid mode, and
42 * also just happens to be S_IFDIR + S_IFLNK
43 *
44 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
45 * always having the same values everywhere. We should use
46 * our internal git values for these things, and then we can
47 * translate that to the OS-specific value. It just so
48 * happens that everybody shares the same bit representation
49 * in the UNIX world (and apparently wider too..)
50 */
302b9282
MW
51#define S_IFGITLINK 0160000
52#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
9eec4795 53
2386d658
LT
54/*
55 * Intensive research over the course of many years has shown that
56 * port 9418 is totally unused by anything else. Or
57 *
58 * Your search - "port 9418" - did not match any documents.
59 *
60 * as www.google.com puts it.
ba8a4970
LT
61 *
62 * This port has been properly assigned for git use by IANA:
63 * git (Assigned-9418) [I06-050728-0001].
64 *
65 * git 9418/tcp git pack transfer service
66 * git 9418/udp git pack transfer service
67 *
68 * with Linus Torvalds <torvalds@osdl.org> as the point of
69 * contact. September 2005.
70 *
71 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
72 */
73#define DEFAULT_GIT_PORT 9418
74
e83c5163
LT
75/*
76 * Basic data structures for the directory cache
e83c5163
LT
77 */
78
79#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
80struct cache_header {
ccc4feb5
LT
81 unsigned int hdr_signature;
82 unsigned int hdr_version;
83 unsigned int hdr_entries;
e83c5163
LT
84};
85
86/*
87 * The "cache_time" is just the low 32 bits of the
88 * time. It doesn't matter if it overflows - we only
89 * check it for equality in the 32 bits we save.
90 */
91struct cache_time {
92 unsigned int sec;
93 unsigned int nsec;
94};
95
96/*
97 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
98 * Again - this is just a (very strong in practice) heuristic that
99 * the inode hasn't changed.
ccc4feb5
LT
100 *
101 * We save the fields in big-endian order to allow using the
102 * index file over NFS transparently.
e83c5163 103 */
7a51ed66
LT
104struct ondisk_cache_entry {
105 struct cache_time ctime;
106 struct cache_time mtime;
107 unsigned int dev;
108 unsigned int ino;
109 unsigned int mode;
110 unsigned int uid;
111 unsigned int gid;
112 unsigned int size;
113 unsigned char sha1[20];
114 unsigned short flags;
115 char name[FLEX_ARRAY]; /* more */
116};
117
e83c5163 118struct cache_entry {
7a51ed66
LT
119 unsigned int ce_ctime;
120 unsigned int ce_mtime;
ccc4feb5
LT
121 unsigned int ce_dev;
122 unsigned int ce_ino;
123 unsigned int ce_mode;
124 unsigned int ce_uid;
125 unsigned int ce_gid;
126 unsigned int ce_size;
7a51ed66 127 unsigned int ce_flags;
e83c5163 128 unsigned char sha1[20];
eb7a2f1d 129 struct cache_entry *next;
8f1d2e6f 130 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
131};
132
95fd5bf8
LT
133#define CE_NAMEMASK (0x0fff)
134#define CE_STAGEMASK (0x3000)
16ce2e4c 135#define CE_EXTENDED (0x4000)
5f73076c 136#define CE_VALID (0x8000)
aee46198 137#define CE_STAGESHIFT 12
95fd5bf8 138
7a51ed66
LT
139/* In-memory only */
140#define CE_UPDATE (0x10000)
141#define CE_REMOVE (0x20000)
eadb5831 142#define CE_UPTODATE (0x40000)
1102952b 143#define CE_ADDED (0x80000)
a22c6371
LT
144
145#define CE_HASHED (0x100000)
146#define CE_UNHASHED (0x200000)
7a51ed66 147
eb7a2f1d
LT
148/*
149 * Copy the sha1 and stat state of a cache entry from one to
150 * another. But we never change the name, or the hash state!
151 */
152#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
153static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
154{
155 unsigned int state = dst->ce_flags & CE_STATE_MASK;
156
157 /* Don't copy hash chain and name */
158 memcpy(dst, src, offsetof(struct cache_entry, next));
159
160 /* Restore the hash state */
161 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
162}
163
7fec10b7
JH
164static inline unsigned create_ce_flags(size_t len, unsigned stage)
165{
166 if (len >= CE_NAMEMASK)
167 len = CE_NAMEMASK;
168 return (len | (stage << CE_STAGESHIFT));
169}
170
171static inline size_t ce_namelen(const struct cache_entry *ce)
172{
173 size_t len = ce->ce_flags & CE_NAMEMASK;
174 if (len < CE_NAMEMASK)
175 return len;
176 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
177}
178
aee46198 179#define ce_size(ce) cache_entry_size(ce_namelen(ce))
7a51ed66
LT
180#define ondisk_ce_size(ce) ondisk_cache_entry_size(ce_namelen(ce))
181#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831
JH
182#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
183#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
aee46198 184
e4479470 185#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
186static inline unsigned int create_ce_mode(unsigned int mode)
187{
8ae0a8c5 188 if (S_ISLNK(mode))
7a51ed66 189 return S_IFLNK;
302b9282 190 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
191 return S_IFGITLINK;
192 return S_IFREG | ce_permissions(mode);
8ae0a8c5 193}
185c975f
JH
194static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
195{
78a8d641
JS
196 extern int trust_executable_bit, has_symlinks;
197 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 198 ce && S_ISLNK(ce->ce_mode))
78a8d641 199 return ce->ce_mode;
185c975f 200 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 201 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
202 return ce->ce_mode;
203 return create_ce_mode(0666);
204 }
205 return create_ce_mode(mode);
206}
d6b8fc30
JH
207static inline int ce_to_dtype(const struct cache_entry *ce)
208{
209 unsigned ce_mode = ntohl(ce->ce_mode);
210 if (S_ISREG(ce_mode))
211 return DT_REG;
212 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
213 return DT_DIR;
214 else if (S_ISLNK(ce_mode))
215 return DT_LNK;
216 else
217 return DT_UNKNOWN;
218}
1b0c7174
JH
219#define canon_mode(mode) \
220 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
302b9282 221 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
e4479470 222
aee46198 223#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
7a51ed66 224#define ondisk_cache_entry_size(len) ((offsetof(struct ondisk_cache_entry,name) + (len) + 8) & ~7)
f5cabd13 225
228e94f9
JH
226struct index_state {
227 struct cache_entry **cache;
228 unsigned int cache_nr, cache_alloc, cache_changed;
229 struct cache_tree *cache_tree;
230 time_t timestamp;
7a51ed66 231 void *alloc;
913e0e99
JH
232 unsigned name_hash_initialized : 1,
233 initialized : 1;
cf558704 234 struct hash_table name_hash;
228e94f9
JH
235};
236
237extern struct index_state the_index;
238
96872bc2
LT
239/* Name hashing */
240extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
241/*
242 * We don't actually *remove* it, we can just mark it invalid so that
243 * we won't find it in lookups.
244 *
245 * Not only would we have to search the lists (simple enough), but
246 * we'd also have to rehash other hash buckets in case this makes the
247 * hash bucket empty (common). So it's much better to just mark
248 * it.
249 */
250static inline void remove_name_hash(struct cache_entry *ce)
251{
252 ce->ce_flags |= CE_UNHASHED;
253}
254
255
4aab5b46 256#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
257#define active_cache (the_index.cache)
258#define active_nr (the_index.cache_nr)
259#define active_alloc (the_index.cache_alloc)
260#define active_cache_changed (the_index.cache_changed)
261#define active_cache_tree (the_index.cache_tree)
e83c5163 262
4aab5b46
JH
263#define read_cache() read_index(&the_index)
264#define read_cache_from(path) read_index_from(&the_index, (path))
e46bbcf6 265#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46
JH
266#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
267#define discard_cache() discard_index(&the_index)
94a5728c 268#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
269#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
270#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 271#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
272#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
273#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
38ed1d89
JH
274#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
275#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
d616813d 276#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
4bd5b7da
JH
277#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
278#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
cd2fef59 279#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
98fa4738 280#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
4aab5b46 281#endif
e83c5163 282
edaec3fb
JH
283enum object_type {
284 OBJ_BAD = -1,
285 OBJ_NONE = 0,
286 OBJ_COMMIT = 1,
287 OBJ_TREE = 2,
288 OBJ_BLOB = 3,
289 OBJ_TAG = 4,
290 /* 5 for future expansion */
291 OBJ_OFS_DELTA = 6,
292 OBJ_REF_DELTA = 7,
355885d5 293 OBJ_ANY,
edaec3fb
JH
294 OBJ_MAX,
295};
296
b45563a2
JH
297static inline enum object_type object_type(unsigned int mode)
298{
299 return S_ISDIR(mode) ? OBJ_TREE :
300 S_ISGITLINK(mode) ? OBJ_COMMIT :
301 OBJ_BLOB;
302}
303
8ac069ac 304#define GIT_DIR_ENVIRONMENT "GIT_DIR"
892c41b9 305#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
8ac069ac 306#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 307#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 308#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 309#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
d4ebc36c
JH
310#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
311#define CONFIG_ENVIRONMENT "GIT_CONFIG"
d4ebc36c 312#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 313#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
d0bfd026
JH
314#define GITATTRIBUTES_FILE ".gitattributes"
315#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 316#define ATTRIBUTE_MACRO_PREFIX "[attr]"
bb233d69 317
7d1864ce
JH
318extern int is_bare_repository_cfg;
319extern int is_bare_repository(void);
68025633 320extern int is_inside_git_dir(void);
e90fdc39 321extern char *git_work_tree_cfg;
892c41b9 322extern int is_inside_work_tree(void);
d2b0708e 323extern int have_git_dir(void);
c5fba16c 324extern const char *get_git_dir(void);
8ac069ac
JH
325extern char *get_object_directory(void);
326extern char *get_index_file(void);
5da5c8f4 327extern char *get_graft_file(void);
d7ac12b2 328extern int set_git_dir(const char *path);
e90fdc39 329extern const char *get_git_work_tree(void);
b44ebb19 330extern const char *read_gitfile_gently(const char *path);
19757d80 331extern void set_git_work_tree(const char *tree);
8ac069ac
JH
332
333#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 334
6b5ee137 335extern const char **get_pathspec(const char *prefix, const char **pathspec);
59f0f2f3 336extern void setup_work_tree(void);
4ca06608 337extern const char *setup_git_directory_gently(int *);
d288a700 338extern const char *setup_git_directory(void);
6b5ee137 339extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 340extern const char *prefix_filename(const char *prefix, int len, const char *path);
e23d0b4a 341extern void verify_filename(const char *prefix, const char *name);
ea92f41f 342extern void verify_non_filename(const char *prefix, const char *name);
d288a700 343
f225aeb2
DB
344#define INIT_DB_QUIET 0x0001
345
346extern int init_db(const char *template_dir, unsigned int flags);
347
e83c5163
LT
348#define alloc_nr(x) (((x)+16)*3/2)
349
6815e569
JK
350/*
351 * Realloc the buffer pointed at by variable 'x' so that it can hold
352 * at least 'nr' entries; the number of entries currently allocated
353 * is 'alloc', using the standard growing factor alloc_nr() macro.
354 *
355 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
356 */
357#define ALLOC_GROW(x, nr, alloc) \
358 do { \
c927e6c6 359 if ((nr) > alloc) { \
4234a761
JH
360 if (alloc_nr(alloc) < (nr)) \
361 alloc = (nr); \
362 else \
363 alloc = alloc_nr(alloc); \
6815e569
JK
364 x = xrealloc((x), alloc * sizeof(*(x))); \
365 } \
366 } while(0)
367
734aab75 368/* Initialize and use the cache information */
4aab5b46
JH
369extern int read_index(struct index_state *);
370extern int read_index_from(struct index_state *, const char *path);
e46bbcf6 371extern int read_index_unmerged(struct index_state *);
d1f128b0 372extern int write_index(const struct index_state *, int newfd);
4aab5b46 373extern int discard_index(struct index_state *);
d1f128b0 374extern int unmerged_index(const struct index_state *);
8dcf39c4 375extern int verify_path(const char *path);
cd2fef59 376extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
d1f128b0 377extern int index_name_pos(const struct index_state *, const char *name, int namelen);
192268c1
JH
378#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
379#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 380#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 381#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 382#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
4aab5b46 383extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
8fd2cb40 384extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
81dc2307 385extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
4aab5b46
JH
386extern int remove_index_entry_at(struct index_state *, int pos);
387extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
388#define ADD_CACHE_VERBOSE 1
389#define ADD_CACHE_PRETEND 2
01665924 390#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 391#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 392#define ADD_CACHE_INTENT 16
38ed1d89
JH
393extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
394extern int add_file_to_index(struct index_state *, const char *path, int flags);
6640f881 395extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
dbbce55b 396extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
98fa4738 397extern int index_name_is_other(const struct index_state *, const char *, int);
4bd5b7da
JH
398
399/* do stat comparison even if CE_VALID is true */
400#define CE_MATCH_IGNORE_VALID 01
401/* do not check the contents but report dirty on racily-clean entries */
402#define CE_MATCH_RACY_IS_DIRTY 02
d1f128b0
LT
403extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
404extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 405
c0fd1f51 406extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
53bca91a 407extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
ec1fcc16 408extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
409extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
410
405e5b2f
LT
411#define REFRESH_REALLY 0x0001 /* ignore_valid */
412#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
413#define REFRESH_QUIET 0x0004 /* be quiet about it */
414#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 415#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
d14e7407 416#define REFRESH_SAY_CHANGED 0x0020 /* say "changed" not "needs update" */
d616813d 417extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
405e5b2f 418
021b6e45
JH
419struct lock_file {
420 struct lock_file *next;
4723ee99 421 int fd;
5e635e39 422 pid_t owner;
1084b845 423 char on_list;
021b6e45 424 char filename[PATH_MAX];
415e96c8 425};
acd3b9ec
JH
426#define LOCK_DIE_ON_ERROR 1
427#define LOCK_NODEREF 2
40aaae88 428extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
ea3cd5c7 429extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
021b6e45 430extern int commit_lock_file(struct lock_file *);
30ca07a2
JH
431
432extern int hold_locked_index(struct lock_file *, int);
433extern int commit_locked_index(struct lock_file *);
5e7f56ac 434extern void set_alternate_index_output(const char *);
d6cf61bf 435extern int close_lock_file(struct lock_file *);
021b6e45 436extern void rollback_lock_file(struct lock_file *);
eca35a25 437extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
734aab75 438
2ae1c53b 439/* Environment bits from configuration mechanism */
17712991 440extern int trust_executable_bit;
1ce4790b 441extern int trust_ctime;
9378c161 442extern int quote_path_fully;
78a8d641 443extern int has_symlinks;
0a9b88b7 444extern int ignore_case;
5f73076c 445extern int assume_unchanged;
9f0bb90d 446extern int prefer_symlink_refs;
6de08ae6 447extern int log_all_ref_updates;
2f8acdb3 448extern int warn_ambiguous_refs;
457f06d6 449extern int shared_repository;
2ae1c53b 450extern const char *apply_default_whitespace;
12f6c308 451extern int zlib_compression_level;
960ccca6
DH
452extern int core_compression_level;
453extern int core_compression_seen;
60bb8b14 454extern size_t packed_git_window_size;
77ccc5bb 455extern size_t packed_git_limit;
18bdec11 456extern size_t delta_base_cache_limit;
6c510bee 457extern int auto_crlf;
aafe9fba 458extern int fsync_object_files;
17712991 459
21e5ad50
SP
460enum safe_crlf {
461 SAFE_CRLF_FALSE = 0,
462 SAFE_CRLF_FAIL = 1,
463 SAFE_CRLF_WARN = 2,
464};
465
466extern enum safe_crlf safe_crlf;
467
9ed36cfa 468enum branch_track {
9188ed89 469 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
470 BRANCH_TRACK_NEVER = 0,
471 BRANCH_TRACK_REMOTE,
472 BRANCH_TRACK_ALWAYS,
473 BRANCH_TRACK_EXPLICIT,
474};
475
c998ae9b
DS
476enum rebase_setup_type {
477 AUTOREBASE_NEVER = 0,
478 AUTOREBASE_LOCAL,
479 AUTOREBASE_REMOTE,
480 AUTOREBASE_ALWAYS,
481};
482
9ed36cfa 483extern enum branch_track git_branch_track;
c998ae9b 484extern enum rebase_setup_type autorebase;
9ed36cfa 485
ab9cb76f
JH
486#define GIT_REPO_VERSION 0
487extern int repository_format_version;
488extern int check_repository_format(void);
489
734aab75
LT
490#define MTIME_CHANGED 0x0001
491#define CTIME_CHANGED 0x0002
492#define OWNER_CHANGED 0x0004
493#define MODE_CHANGED 0x0008
494#define INODE_CHANGED 0x0010
495#define DATA_CHANGED 0x0020
8ae0a8c5 496#define TYPE_CHANGED 0x0040
e83c5163 497
108bebea
AR
498extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
499 __attribute__((format (printf, 3, 4)));
fe2d7776
AR
500extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
501 __attribute__((format (printf, 3, 4)));
aba13e7c
AR
502extern char *git_pathdup(const char *fmt, ...)
503 __attribute__((format (printf, 1, 2)));
108bebea 504
e83c5163 505/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
506extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
507extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 508extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
509extern char *sha1_pack_name(const unsigned char *sha1);
510extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 511extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 512extern const unsigned char null_sha1[20];
0bef57ee
DR
513static inline int is_null_sha1(const unsigned char *sha1)
514{
515 return !memcmp(sha1, null_sha1, 20);
516}
a89fccd2
DR
517static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
518{
519 return memcmp(sha1, sha2, 20);
520}
e702496e
SP
521static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
522{
523 memcpy(sha_dst, sha_src, 20);
524}
a8e0d16d
JH
525static inline void hashclr(unsigned char *hash)
526{
527 memset(hash, 0, 20);
528}
f55527f8 529extern int is_empty_blob_sha1(const unsigned char *sha1);
e83c5163 530
f2db68ed
HE
531int git_mkstemp(char *path, size_t n, const char *template);
532
06cbe855
HO
533/*
534 * NOTE NOTE NOTE!!
535 *
536 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
537 * not be changed. Old repositories have core.sharedrepository written in
538 * numeric format, and therefore these values are preserved for compatibility
539 * reasons.
540 */
94df2506 541enum sharedrepo {
06cbe855
HO
542 PERM_UMASK = 0,
543 OLD_PERM_GROUP = 1,
544 OLD_PERM_EVERYBODY = 2,
545 PERM_GROUP = 0660,
546 PERM_EVERYBODY = 0664,
94df2506
JH
547};
548int git_config_perm(const char *var, const char *value);
457f06d6 549int adjust_shared_perm(const char *path);
b2cb9425 550int safe_create_leading_directories(char *path);
8e21d63b 551int safe_create_leading_directories_const(const char *path);
bd22c904 552char *enter_repo(char *path, int strict);
e5392c51
JS
553static inline int is_absolute_path(const char *path)
554{
25fe217b 555 return path[0] == '/' || has_dos_drive_prefix(path);
e5392c51 556}
90b4a71c 557int is_directory(const char *);
e5392c51 558const char *make_absolute_path(const char *path);
1b9a9467 559const char *make_nonrelative_path(const char *path);
044bbbcb 560const char *make_relative_path(const char *abs, const char *base);
ae299be0 561int normalize_absolute_path(char *buf, const char *path);
0454dd93 562int longest_ancestor_length(const char *path, const char *prefix_list);
b2cb9425 563
e83c5163 564/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 565extern int sha1_object_info(const unsigned char *, unsigned long *);
21666f1a 566extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
ce9fbf16 567extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
bf0f910d 568extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
21666f1a 569extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 570extern int force_object_loose(const unsigned char *sha1, time_t mtime);
8237b185 571
ac939109
NP
572/* just like read_sha1_file(), but non fatal in presence of bad objects */
573extern void *read_object(const unsigned char *sha1, enum object_type *type, unsigned long *size);
574
5d6ccf5c 575extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 576
839837b9 577extern int move_temp_to_file(const char *tmpfile, const char *filename);
8237b185 578
106d710b 579extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
8237b185
DB
580extern int has_sha1_file(const unsigned char *sha1);
581
bf592c50
DB
582extern int has_pack_file(const unsigned char *sha1);
583extern int has_pack_index(const unsigned char *sha1);
584
192a6be2
LT
585extern const signed char hexval_table[256];
586static inline unsigned int hexval(unsigned char c)
e49521b5
JH
587{
588 return hexval_table[c];
589}
590
e83c5163 591/* Convert to/from hex/sha1 representation */
46a6c262
JH
592#define MINIMUM_ABBREV 4
593#define DEFAULT_ABBREV 7
594
3c249c95 595extern int get_sha1(const char *str, unsigned char *sha1);
a0cd87a5 596extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
197ee8c9
LT
597extern int get_sha1_hex(const char *hex, unsigned char *sha1);
598extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 599extern int read_ref(const char *filename, unsigned char *sha1);
8da19775 600extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
e86eb666 601extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
eb3a4822 602extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
e86eb666 603
79803322
SP
604extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
605extern const char *ref_rev_parse_rules[];
605b4978 606extern const char *ref_fetch_rules[];
79803322 607
8b5157e4 608extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
c847f537 609extern int validate_headref(const char *ref);
e83c5163 610
958ba6c9 611extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 612extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 613extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 614
40469ee9 615extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 616 const char *required_type,
40469ee9
JH
617 unsigned long *size,
618 unsigned char *sha1_ret);
f4913f91 619
81776315
JH
620extern struct object *peel_to_type(const char *name, int namelen,
621 struct object *o, enum object_type);
622
73013afd
JH
623enum date_mode {
624 DATE_NORMAL = 0,
625 DATE_RELATIVE,
626 DATE_SHORT,
627 DATE_LOCAL,
628 DATE_ISO8601,
629 DATE_RFC2822
630};
631
f8493ec0 632const char *show_date(unsigned long time, int timezone, enum date_mode mode);
2a39064c 633int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 634void datestamp(char *buf, int bufsize);
3c07b1d1 635unsigned long approxidate(const char *);
856665f8 636enum date_mode parse_date_format(const char *format);
ecee9d9e 637
774751a8
JH
638#define IDENT_WARN_ON_NO_NAME 1
639#define IDENT_ERROR_ON_NO_NAME 2
640#define IDENT_NO_DATE 4
749be728
JH
641extern const char *git_author_info(int);
642extern const char *git_committer_info(int);
798123af 643extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 644extern const char *fmt_name(const char *name, const char *email);
6aa33f40 645
12dccc16
LT
646struct checkout {
647 const char *base_dir;
648 int base_dir_len;
649 unsigned force:1,
650 quiet:1,
651 not_new:1,
652 refresh_cache:1;
653};
654
efbc5831 655extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
c40641b7 656extern int has_symlink_leading_path(int len, const char *name);
12dccc16 657
9a217f2a 658extern struct alternate_object_database {
d5a63b99 659 struct alternate_object_database *next;
9a217f2a 660 char *name;
8f1d2e6f 661 char base[FLEX_ARRAY]; /* more */
d5a63b99 662} *alt_odb_list;
9a217f2a 663extern void prepare_alt_odb(void);
bef70b22 664extern void add_to_alternates_file(const char *reference);
d79796bc
JH
665typedef int alt_odb_fn(struct alternate_object_database *, void *);
666extern void foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 667
c41ee586
SP
668struct pack_window {
669 struct pack_window *next;
670 unsigned char *base;
671 off_t offset;
672 size_t len;
673 unsigned int last_used;
674 unsigned int inuse_cnt;
675};
676
9a217f2a
JH
677extern struct packed_git {
678 struct packed_git *next;
c41ee586 679 struct pack_window *windows;
2dc3a234 680 off_t pack_size;
57059091
NP
681 const void *index_data;
682 size_t index_size;
683 uint32_t num_objects;
8eca0b47
NP
684 uint32_t num_bad_objects;
685 unsigned char *bad_object_sha1;
42873078 686 int index_version;
57059091 687 time_t mtime;
9bc879c1 688 int pack_fd;
9d835df2 689 int pack_local;
bf592c50 690 unsigned char sha1[20];
8f1d2e6f
JH
691 /* something like ".git/objects/pack/xxxxx.pack" */
692 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 693} *packed_git;
f3bf9224
JH
694
695struct pack_entry {
c4001d92 696 off_t offset;
f3bf9224
JH
697 unsigned char sha1[20];
698 struct packed_git *p;
699};
700
d1c133f5
LT
701struct ref {
702 struct ref *next;
703 unsigned char old_sha1[20];
704 unsigned char new_sha1[20];
be885d96 705 char *symref;
9f8a15c7
SP
706 unsigned int force:1,
707 merge:1,
708 nonfastforward:1,
709 deletion:1;
8736a848
JK
710 enum {
711 REF_STATUS_NONE = 0,
712 REF_STATUS_OK,
713 REF_STATUS_REJECT_NONFASTFORWARD,
714 REF_STATUS_REJECT_NODELETE,
715 REF_STATUS_UPTODATE,
ca74c458 716 REF_STATUS_REMOTE_REJECT,
2a0fe89a 717 REF_STATUS_EXPECTING_REPORT,
8736a848 718 } status;
2a0fe89a 719 char *remote_status;
f88395ac 720 struct ref *peer_ref; /* when renaming */
8f1d2e6f 721 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
722};
723
2718ff09
LT
724#define REF_NORMAL (1u << 0)
725#define REF_HEADS (1u << 1)
726#define REF_TAGS (1u << 2)
727
cda69f48
JK
728extern struct ref *find_ref_by_name(struct ref *list, const char *name);
729
7841ce79 730#define CONNECT_VERBOSE (1u << 0)
4577370e 731extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
98158e9c 732extern int finish_connect(struct child_process *conn);
013e7c7f 733extern int path_match(const char *path, int nr, char **match);
41cb7488 734extern int get_ack(int fd, unsigned char *result_sha1);
40c155ff
JH
735struct extra_have_objects {
736 int nr, alloc;
737 unsigned char (*array)[20];
738};
739extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
211b5f9e 740extern int server_supports(const char *feature);
f7192598 741
bf592c50
DB
742extern struct packed_git *parse_pack_index(unsigned char *sha1);
743
9a217f2a 744extern void prepare_packed_git(void);
fc04c412 745extern void reprepare_packed_git(void);
bf592c50
DB
746extern void install_packed_git(struct packed_git *pack);
747
a6080a0a 748extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
749 struct packed_git *packs);
750
276bc2ca 751extern void pack_report(void);
d079837e 752extern int open_pack_index(struct packed_git *);
c4001d92 753extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
c9ced051 754extern void close_pack_windows(struct packed_git *);
03e79c88 755extern void unuse_pack(struct pack_window **);
42873078 756extern struct packed_git *add_packed_git(const char *, int, int);
d079837e 757extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
99093238 758extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
c4001d92
SP
759extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
760extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
72518e9c 761extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 762extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
c4001d92 763extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
000dfd3f 764extern int matches_pack_name(struct packed_git *p, const char *name);
9a217f2a 765
8f3f9b09
JH
766/* Dumb servers support */
767extern int update_server_info(int);
768
ef90d6d4
JS
769typedef int (*config_fn_t)(const char *, const char *, void *);
770extern int git_default_config(const char *, const char *, void *);
771extern int git_config_from_file(config_fn_t fn, const char *, void *);
772extern int git_config(config_fn_t fn, void *);
0b87b6e0 773extern int git_parse_ulong(const char *, unsigned long *);
17712991 774extern int git_config_int(const char *, const char *);
0b87b6e0 775extern unsigned long git_config_ulong(const char *, const char *);
a53f2ec6 776extern int git_config_bool_or_int(const char *, const char *, int *);
17712991 777extern int git_config_bool(const char *, const char *);
ea5105a5 778extern int git_config_string(const char **, const char *, const char *);
10bea152 779extern int git_config_set(const char *, const char *);
4ddba79d 780extern int git_config_set_multivar(const char *, const char *, const char *, int);
0667fcfb 781extern int git_config_rename_section(const char *, const char *);
506b17b1 782extern const char *git_etc_gitconfig(void);
ef90d6d4 783extern int check_repository_format_version(const char *var, const char *value, void *cb);
ab88c363
JK
784extern int git_config_system(void);
785extern int git_config_global(void);
40ea4ed9 786extern int config_error_nonbool(const char *);
dc871831 787extern const char *config_exclusive_filename;
17712991 788
e1b10391
LT
789#define MAX_GITNAME (1000)
790extern char git_default_email[MAX_GITNAME];
791extern char git_default_name[MAX_GITNAME];
bb1ae3f6 792extern int user_ident_explicitly_given;
e1b10391 793
1a8f2741 794extern const char *git_commit_encoding;
3a55602e 795extern const char *git_log_output_encoding;
4e72dcec 796
06f59e9f
TT
797/* IO helper functions */
798extern void maybe_flush_or_die(FILE *, const char *);
f3123c4a 799extern int copy_fd(int ifd, int ofd);
1468bd47 800extern int copy_file(const char *dst, const char *src, int mode);
0104ca09
HO
801extern ssize_t read_in_full(int fd, void *buf, size_t count);
802extern ssize_t write_in_full(int fd, const void *buf, size_t count);
7230e6d0 803extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 804extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 805extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
4c81b03e 806extern void fsync_or_die(int fd, const char *);
ad897215 807
f67b45f8
LT
808/* pager.c */
809extern void setup_pager(void);
872da32d 810extern const char *pager_program;
6e9af863 811extern int pager_in_use(void);
aa086eb8 812extern int pager_use_color;
f67b45f8 813
ee9601e6 814extern const char *editor_program;
dfb068be 815extern const char *excludes_file;
4d87b9c5 816
051308f6 817/* base85 */
f9815772
JM
818int decode_85(char *dst, const char *line, int linelen);
819void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 820
855419f7 821/* alloc.c */
100c5f3b
LT
822extern void *alloc_blob_node(void);
823extern void *alloc_tree_node(void);
824extern void *alloc_commit_node(void);
825extern void *alloc_tag_node(void);
826extern void *alloc_object_node(void);
855419f7
LT
827extern void alloc_report(void);
828
6ce4e61f 829/* trace.c */
6ce4e61f 830extern void trace_printf(const char *format, ...);
b319ce4c 831extern void trace_argv_printf(const char **argv, const char *format, ...);
6ce4e61f 832
6c510bee 833/* convert.c */
5ecd293d 834/* returns 1 if *dst was used */
21e5ad50
SP
835extern int convert_to_git(const char *path, const char *src, size_t len,
836 struct strbuf *dst, enum safe_crlf checksafe);
5ecd293d 837extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
6c510bee 838
b6ec1d61 839/* add */
7ae02a30
AR
840/*
841 * return 0 if success, 1 - if addition of a file failed and
842 * ADD_FILES_IGNORE_ERRORS was specified in flags
843 */
844int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
b6ec1d61 845
aecbf914
JH
846/* diff.c */
847extern int diff_auto_refresh_index;
848
68faf689
JH
849/* match-trees.c */
850void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
851
a9cc857a
JH
852/*
853 * whitespace rules.
854 * used by both diff and apply
855 */
856#define WS_TRAILING_SPACE 01
857#define WS_SPACE_BEFORE_TAB 02
459fa6d0 858#define WS_INDENT_WITH_NON_TAB 04
b2979ff5 859#define WS_CR_AT_EOL 010
a9cc857a 860#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
cf1b7869
JH
861extern unsigned whitespace_rule_cfg;
862extern unsigned whitespace_rule(const char *);
863extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
864extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
865extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 866extern char *whitespace_error_string(unsigned ws);
fe3403c3 867extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
877f23cc 868extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
a9cc857a 869
ee425e46
JH
870/* ls-files */
871int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
872int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
873void overlay_tree_on_cache(const char *tree_name, const char *prefix);
874
94351118 875char *alias_lookup(const char *alias);
0989fe96 876int split_cmdline(char *cmdline, const char ***argv);
94351118 877
e83c5163 878#endif /* CACHE_H */