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