]>
Commit | Line | Data |
---|---|---|
e83c5163 LT |
1 | #ifndef CACHE_H |
2 | #define CACHE_H | |
3 | ||
4050c0df | 4 | #include "git-compat-util.h" |
5ecd293d | 5 | #include "strbuf.h" |
e05881a4 | 6 | #include "hashmap.h" |
75194438 | 7 | #include "advice.h" |
65784830 | 8 | #include "gettext.h" |
d1bf0e08 | 9 | #include "convert.h" |
5991a55c | 10 | #include "trace.h" |
155ef25f | 11 | #include "string-list.h" |
f4015337 | 12 | #include "pack-revindex.h" |
f18f816c | 13 | #include "hash.h" |
e83c5163 | 14 | |
3bc72fde APD |
15 | #ifndef platform_SHA_CTX |
16 | /* | |
17 | * platform's underlying implementation of SHA-1; could be OpenSSL, | |
18 | * blk_SHA, Apple CommonCrypto, etc... Note that including | |
19 | * SHA1_HEADER may have already defined platform_SHA_CTX for our | |
20 | * own implementations like block-sha1 and ppc-sha1, so we list | |
21 | * the default for OpenSSL compatible SHA-1 implementations here. | |
22 | */ | |
23 | #define platform_SHA_CTX SHA_CTX | |
24 | #define platform_SHA1_Init SHA1_Init | |
25 | #define platform_SHA1_Update SHA1_Update | |
26 | #define platform_SHA1_Final SHA1_Final | |
9126f009 | 27 | #endif |
e83c5163 | 28 | |
3bc72fde APD |
29 | #define git_SHA_CTX platform_SHA_CTX |
30 | #define git_SHA1_Init platform_SHA1_Init | |
31 | #define git_SHA1_Update platform_SHA1_Update | |
32 | #define git_SHA1_Final platform_SHA1_Final | |
33 | ||
001fd7a9 APD |
34 | #ifdef SHA1_MAX_BLOCK_SIZE |
35 | #include "compat/sha1-chunked.h" | |
36 | #undef git_SHA1_Update | |
37 | #define git_SHA1_Update git_SHA1_Update_Chunked | |
9126f009 | 38 | #endif |
e83c5163 | 39 | |
9126f009 | 40 | #include <zlib.h> |
ef49a7a0 JH |
41 | typedef struct git_zstream { |
42 | z_stream z; | |
43 | unsigned long avail_in; | |
44 | unsigned long avail_out; | |
45 | unsigned long total_in; | |
46 | unsigned long total_out; | |
47 | unsigned char *next_in; | |
48 | unsigned char *next_out; | |
49 | } git_zstream; | |
50 | ||
51 | void git_inflate_init(git_zstream *); | |
52 | void git_inflate_init_gzip_only(git_zstream *); | |
53 | void git_inflate_end(git_zstream *); | |
54 | int git_inflate(git_zstream *, int flush); | |
55 | ||
56 | void git_deflate_init(git_zstream *, int level); | |
57 | void git_deflate_init_gzip(git_zstream *, int level); | |
c3c2e1a0 | 58 | void git_deflate_init_raw(git_zstream *, int level); |
ef49a7a0 | 59 | void git_deflate_end(git_zstream *); |
568508e7 | 60 | int git_deflate_abort(git_zstream *); |
ef49a7a0 JH |
61 | int git_deflate_end_gently(git_zstream *); |
62 | int git_deflate(git_zstream *, int flush); | |
63 | unsigned long git_deflate_bound(git_zstream *, unsigned long); | |
39c68542 | 64 | |
5f7817c8 | 65 | /* The length in bytes and in hex digits of an object name (SHA-1 value). */ |
66 | #define GIT_SHA1_RAWSZ 20 | |
67 | #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) | |
68 | ||
5028bf62 | 69 | /* The length in byte and in hex digits of the largest possible hash value. */ |
70 | #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ | |
71 | #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ | |
72 | ||
5f7817c8 | 73 | struct object_id { |
5028bf62 | 74 | unsigned char hash[GIT_MAX_RAWSZ]; |
5f7817c8 | 75 | }; |
76 | ||
962554c6 | 77 | #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) |
b6829693 ET |
78 | #define DTYPE(de) ((de)->d_type) |
79 | #else | |
0bdd79af JH |
80 | #undef DT_UNKNOWN |
81 | #undef DT_DIR | |
82 | #undef DT_REG | |
83 | #undef DT_LNK | |
b6829693 ET |
84 | #define DT_UNKNOWN 0 |
85 | #define DT_DIR 1 | |
86 | #define DT_REG 2 | |
a15c1c60 | 87 | #define DT_LNK 3 |
b6829693 ET |
88 | #define DTYPE(de) DT_UNKNOWN |
89 | #endif | |
90 | ||
40689ae1 MK |
91 | /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ |
92 | #define S_IFINVALID 0030000 | |
93 | ||
9eec4795 LT |
94 | /* |
95 | * A "directory link" is a link to another git directory. | |
96 | * | |
97 | * The value 0160000 is not normally a valid mode, and | |
98 | * also just happens to be S_IFDIR + S_IFLNK | |
9eec4795 | 99 | */ |
302b9282 MW |
100 | #define S_IFGITLINK 0160000 |
101 | #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) | |
9eec4795 | 102 | |
72441af7 KS |
103 | /* |
104 | * Some mode bits are also used internally for computations. | |
105 | * | |
106 | * They *must* not overlap with any valid modes, and they *must* not be emitted | |
107 | * to outside world - i.e. appear on disk or network. In other words, it's just | |
108 | * temporary fields, which we internally use, but they have to stay in-house. | |
109 | * | |
110 | * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git | |
111 | * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) | |
112 | */ | |
113 | ||
114 | /* used internally in tree-diff */ | |
115 | #define S_DIFFTREE_IFXMIN_NEQ 0x80000000 | |
116 | ||
117 | ||
2386d658 LT |
118 | /* |
119 | * Intensive research over the course of many years has shown that | |
120 | * port 9418 is totally unused by anything else. Or | |
121 | * | |
122 | * Your search - "port 9418" - did not match any documents. | |
123 | * | |
124 | * as www.google.com puts it. | |
ba8a4970 LT |
125 | * |
126 | * This port has been properly assigned for git use by IANA: | |
127 | * git (Assigned-9418) [I06-050728-0001]. | |
128 | * | |
129 | * git 9418/tcp git pack transfer service | |
130 | * git 9418/udp git pack transfer service | |
131 | * | |
132 | * with Linus Torvalds <torvalds@osdl.org> as the point of | |
133 | * contact. September 2005. | |
134 | * | |
135 | * See http://www.iana.org/assignments/port-numbers | |
2386d658 LT |
136 | */ |
137 | #define DEFAULT_GIT_PORT 9418 | |
138 | ||
e83c5163 LT |
139 | /* |
140 | * Basic data structures for the directory cache | |
e83c5163 LT |
141 | */ |
142 | ||
143 | #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ | |
144 | struct cache_header { | |
7800c1eb TG |
145 | uint32_t hdr_signature; |
146 | uint32_t hdr_version; | |
147 | uint32_t hdr_entries; | |
e83c5163 LT |
148 | }; |
149 | ||
9d227781 JH |
150 | #define INDEX_FORMAT_LB 2 |
151 | #define INDEX_FORMAT_UB 4 | |
152 | ||
e83c5163 LT |
153 | /* |
154 | * The "cache_time" is just the low 32 bits of the | |
155 | * time. It doesn't matter if it overflows - we only | |
156 | * check it for equality in the 32 bits we save. | |
157 | */ | |
158 | struct cache_time { | |
7800c1eb TG |
159 | uint32_t sec; |
160 | uint32_t nsec; | |
e83c5163 LT |
161 | }; |
162 | ||
c21d39d7 MH |
163 | struct stat_data { |
164 | struct cache_time sd_ctime; | |
165 | struct cache_time sd_mtime; | |
166 | unsigned int sd_dev; | |
167 | unsigned int sd_ino; | |
168 | unsigned int sd_uid; | |
169 | unsigned int sd_gid; | |
170 | unsigned int sd_size; | |
171 | }; | |
172 | ||
e83c5163 | 173 | struct cache_entry { |
8b013788 | 174 | struct hashmap_entry ent; |
c21d39d7 | 175 | struct stat_data ce_stat_data; |
ccc4feb5 | 176 | unsigned int ce_mode; |
7a51ed66 | 177 | unsigned int ce_flags; |
b60e188c | 178 | unsigned int ce_namelen; |
5fc2fc8f | 179 | unsigned int index; /* for link extension */ |
99d1a986 | 180 | struct object_id oid; |
8f1d2e6f | 181 | char name[FLEX_ARRAY]; /* more */ |
e83c5163 LT |
182 | }; |
183 | ||
95fd5bf8 | 184 | #define CE_STAGEMASK (0x3000) |
16ce2e4c | 185 | #define CE_EXTENDED (0x4000) |
5f73076c | 186 | #define CE_VALID (0x8000) |
aee46198 | 187 | #define CE_STAGESHIFT 12 |
95fd5bf8 | 188 | |
06aaaa0b | 189 | /* |
ce51bf09 | 190 | * Range 0xFFFF0FFF in ce_flags is divided into |
06aaaa0b NTND |
191 | * two parts: in-memory flags and on-disk ones. |
192 | * Flags in CE_EXTENDED_FLAGS will get saved on-disk | |
193 | * if you want to save a new flag, add it in | |
194 | * CE_EXTENDED_FLAGS | |
195 | * | |
196 | * In-memory only flags | |
197 | */ | |
2977ffbb NTND |
198 | #define CE_UPDATE (1 << 16) |
199 | #define CE_REMOVE (1 << 17) | |
200 | #define CE_UPTODATE (1 << 18) | |
201 | #define CE_ADDED (1 << 19) | |
a22c6371 | 202 | |
2977ffbb | 203 | #define CE_HASHED (1 << 20) |
2977ffbb NTND |
204 | #define CE_WT_REMOVE (1 << 22) /* remove in work directory */ |
205 | #define CE_CONFLICTED (1 << 23) | |
7a51ed66 | 206 | |
2977ffbb | 207 | #define CE_UNPACKED (1 << 24) |
2431afbf | 208 | #define CE_NEW_SKIP_WORKTREE (1 << 25) |
da165f47 | 209 | |
e721c154 NTND |
210 | /* used to temporarily mark paths matched by pathspecs */ |
211 | #define CE_MATCHED (1 << 26) | |
212 | ||
078a58e8 | 213 | #define CE_UPDATE_IN_BASE (1 << 27) |
b3c96fb1 | 214 | #define CE_STRIP_NAME (1 << 28) |
078a58e8 | 215 | |
06aaaa0b NTND |
216 | /* |
217 | * Extended on-disk flags | |
218 | */ | |
2977ffbb NTND |
219 | #define CE_INTENT_TO_ADD (1 << 29) |
220 | #define CE_SKIP_WORKTREE (1 << 30) | |
06aaaa0b | 221 | /* CE_EXTENDED2 is for future extension */ |
9a93c668 | 222 | #define CE_EXTENDED2 (1U << 31) |
06aaaa0b | 223 | |
44a36913 | 224 | #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) |
06aaaa0b NTND |
225 | |
226 | /* | |
227 | * Safeguard to avoid saving wrong flags: | |
228 | * - CE_EXTENDED2 won't get saved until its semantic is known | |
229 | * - Bits in 0x0000FFFF have been saved in ce_flags already | |
230 | * - Bits in 0x003F0000 are currently in-memory flags | |
231 | */ | |
232 | #if CE_EXTENDED_FLAGS & 0x803FFFFF | |
233 | #error "CE_EXTENDED_FLAGS out of range" | |
234 | #endif | |
235 | ||
3e3a4a41 | 236 | /* Forward structure decls */ |
64acde94 | 237 | struct pathspec; |
3e3a4a41 | 238 | struct child_process; |
64acde94 | 239 | |
eb7a2f1d LT |
240 | /* |
241 | * Copy the sha1 and stat state of a cache entry from one to | |
242 | * another. But we never change the name, or the hash state! | |
243 | */ | |
20d142b4 RS |
244 | static inline void copy_cache_entry(struct cache_entry *dst, |
245 | const struct cache_entry *src) | |
eb7a2f1d | 246 | { |
419a597f | 247 | unsigned int state = dst->ce_flags & CE_HASHED; |
eb7a2f1d LT |
248 | |
249 | /* Don't copy hash chain and name */ | |
8b013788 KB |
250 | memcpy(&dst->ce_stat_data, &src->ce_stat_data, |
251 | offsetof(struct cache_entry, name) - | |
252 | offsetof(struct cache_entry, ce_stat_data)); | |
eb7a2f1d LT |
253 | |
254 | /* Restore the hash state */ | |
419a597f | 255 | dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; |
eb7a2f1d LT |
256 | } |
257 | ||
b60e188c | 258 | static inline unsigned create_ce_flags(unsigned stage) |
7fec10b7 | 259 | { |
b60e188c | 260 | return (stage << CE_STAGESHIFT); |
7fec10b7 JH |
261 | } |
262 | ||
b60e188c | 263 | #define ce_namelen(ce) ((ce)->ce_namelen) |
aee46198 | 264 | #define ce_size(ce) cache_entry_size(ce_namelen(ce)) |
7a51ed66 | 265 | #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) |
eadb5831 | 266 | #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) |
44a36913 | 267 | #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) |
eadb5831 | 268 | #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) |
895ff3b2 | 269 | #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) |
aee46198 | 270 | |
e4479470 | 271 | #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) |
8ae0a8c5 KS |
272 | static inline unsigned int create_ce_mode(unsigned int mode) |
273 | { | |
8ae0a8c5 | 274 | if (S_ISLNK(mode)) |
7a51ed66 | 275 | return S_IFLNK; |
302b9282 | 276 | if (S_ISDIR(mode) || S_ISGITLINK(mode)) |
7a51ed66 LT |
277 | return S_IFGITLINK; |
278 | return S_IFREG | ce_permissions(mode); | |
8ae0a8c5 | 279 | } |
20d142b4 RS |
280 | static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, |
281 | unsigned int mode) | |
185c975f | 282 | { |
78a8d641 JS |
283 | extern int trust_executable_bit, has_symlinks; |
284 | if (!has_symlinks && S_ISREG(mode) && | |
7a51ed66 | 285 | ce && S_ISLNK(ce->ce_mode)) |
78a8d641 | 286 | return ce->ce_mode; |
185c975f | 287 | if (!trust_executable_bit && S_ISREG(mode)) { |
7a51ed66 | 288 | if (ce && S_ISREG(ce->ce_mode)) |
185c975f JH |
289 | return ce->ce_mode; |
290 | return create_ce_mode(0666); | |
291 | } | |
292 | return create_ce_mode(mode); | |
293 | } | |
d6b8fc30 JH |
294 | static inline int ce_to_dtype(const struct cache_entry *ce) |
295 | { | |
296 | unsigned ce_mode = ntohl(ce->ce_mode); | |
297 | if (S_ISREG(ce_mode)) | |
298 | return DT_REG; | |
299 | else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) | |
300 | return DT_DIR; | |
301 | else if (S_ISLNK(ce_mode)) | |
302 | return DT_LNK; | |
303 | else | |
304 | return DT_UNKNOWN; | |
305 | } | |
b90d9b88 RS |
306 | static inline unsigned int canon_mode(unsigned int mode) |
307 | { | |
308 | if (S_ISREG(mode)) | |
309 | return S_IFREG | ce_permissions(mode); | |
310 | if (S_ISLNK(mode)) | |
311 | return S_IFLNK; | |
312 | if (S_ISDIR(mode)) | |
313 | return S_IFDIR; | |
314 | return S_IFGITLINK; | |
315 | } | |
e4479470 | 316 | |
ee7825b5 | 317 | #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) |
f5cabd13 | 318 | |
e636a7b4 NTND |
319 | #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ |
320 | #define CE_ENTRY_CHANGED (1 << 1) | |
321 | #define CE_ENTRY_REMOVED (1 << 2) | |
322 | #define CE_ENTRY_ADDED (1 << 3) | |
6c306a34 | 323 | #define RESOLVE_UNDO_CHANGED (1 << 4) |
a5400efe | 324 | #define CACHE_TREE_CHANGED (1 << 5) |
c18b80a0 | 325 | #define SPLIT_INDEX_ORDERED (1 << 6) |
1bbb3dba | 326 | #define UNTRACKED_CHANGED (1 << 7) |
e636a7b4 | 327 | |
5fc2fc8f | 328 | struct split_index; |
83c094ad NTND |
329 | struct untracked_cache; |
330 | ||
228e94f9 JH |
331 | struct index_state { |
332 | struct cache_entry **cache; | |
9d227781 | 333 | unsigned int version; |
228e94f9 | 334 | unsigned int cache_nr, cache_alloc, cache_changed; |
cfc5789a | 335 | struct string_list *resolve_undo; |
228e94f9 | 336 | struct cache_tree *cache_tree; |
5fc2fc8f | 337 | struct split_index *split_index; |
fba2f38a | 338 | struct cache_time timestamp; |
913e0e99 JH |
339 | unsigned name_hash_initialized : 1, |
340 | initialized : 1; | |
8b013788 | 341 | struct hashmap name_hash; |
e05881a4 | 342 | struct hashmap dir_hash; |
426ddeea | 343 | unsigned char sha1[20]; |
83c094ad | 344 | struct untracked_cache *untracked; |
228e94f9 JH |
345 | }; |
346 | ||
347 | extern struct index_state the_index; | |
348 | ||
96872bc2 | 349 | /* Name hashing */ |
ea194895 | 350 | extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded); |
96872bc2 | 351 | extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); |
2092678c KB |
352 | extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); |
353 | extern void free_name_hash(struct index_state *istate); | |
96872bc2 LT |
354 | |
355 | ||
4aab5b46 | 356 | #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS |
228e94f9 JH |
357 | #define active_cache (the_index.cache) |
358 | #define active_nr (the_index.cache_nr) | |
359 | #define active_alloc (the_index.cache_alloc) | |
360 | #define active_cache_changed (the_index.cache_changed) | |
361 | #define active_cache_tree (the_index.cache_tree) | |
e83c5163 | 362 | |
4aab5b46 JH |
363 | #define read_cache() read_index(&the_index) |
364 | #define read_cache_from(path) read_index_from(&the_index, (path)) | |
671c9b7e | 365 | #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) |
fa7b3c2f | 366 | #define is_cache_unborn() is_index_unborn(&the_index) |
e46bbcf6 | 367 | #define read_cache_unmerged() read_index_unmerged(&the_index) |
4aab5b46 | 368 | #define discard_cache() discard_index(&the_index) |
94a5728c | 369 | #define unmerged_cache() unmerged_index(&the_index) |
4aab5b46 JH |
370 | #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) |
371 | #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) | |
81dc2307 | 372 | #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) |
4aab5b46 JH |
373 | #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) |
374 | #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) | |
610d55af TG |
375 | #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) |
376 | #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) | |
d9d70966 | 377 | #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) |
3deffc52 | 378 | #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) |
4bd5b7da JH |
379 | #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) |
380 | #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) | |
db5360f3 ES |
381 | #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) |
382 | #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) | |
98fa4738 | 383 | #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) |
cfc5789a | 384 | #define resolve_undo_clear() resolve_undo_clear_index(&the_index) |
8aa38563 | 385 | #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) |
4421a823 | 386 | #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) |
ff366825 | 387 | #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) |
4aab5b46 | 388 | #endif |
e83c5163 | 389 | |
edaec3fb JH |
390 | enum object_type { |
391 | OBJ_BAD = -1, | |
392 | OBJ_NONE = 0, | |
393 | OBJ_COMMIT = 1, | |
394 | OBJ_TREE = 2, | |
395 | OBJ_BLOB = 3, | |
396 | OBJ_TAG = 4, | |
397 | /* 5 for future expansion */ | |
398 | OBJ_OFS_DELTA = 6, | |
399 | OBJ_REF_DELTA = 7, | |
355885d5 | 400 | OBJ_ANY, |
4b05548f | 401 | OBJ_MAX |
edaec3fb JH |
402 | }; |
403 | ||
b45563a2 JH |
404 | static inline enum object_type object_type(unsigned int mode) |
405 | { | |
406 | return S_ISDIR(mode) ? OBJ_TREE : | |
407 | S_ISGITLINK(mode) ? OBJ_COMMIT : | |
408 | OBJ_BLOB; | |
409 | } | |
410 | ||
2163e5db | 411 | /* Double-check local_repo_env below if you add to this list. */ |
8ac069ac | 412 | #define GIT_DIR_ENVIRONMENT "GIT_DIR" |
c7b3a3d2 | 413 | #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" |
a1bea2c1 | 414 | #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" |
892c41b9 | 415 | #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" |
a6f7f9a3 | 416 | #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" |
74866d75 | 417 | #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX" |
b58a68c1 | 418 | #define GIT_TOPLEVEL_PREFIX_ENVIRONMENT "GIT_INTERNAL_TOPLEVEL_PREFIX" |
8ac069ac | 419 | #define DEFAULT_GIT_DIR_ENVIRONMENT ".git" |
d19938ab | 420 | #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" |
bb233d69 | 421 | #define INDEX_ENVIRONMENT "GIT_INDEX_FILE" |
5da5c8f4 | 422 | #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" |
069c0532 | 423 | #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" |
d4ebc36c JH |
424 | #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" |
425 | #define CONFIG_ENVIRONMENT "GIT_CONFIG" | |
2b64fc89 | 426 | #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" |
d4ebc36c | 427 | #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" |
0454dd93 | 428 | #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" |
6476b38b | 429 | #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" |
58d121b2 | 430 | #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE" |
d0bfd026 JH |
431 | #define GITATTRIBUTES_FILE ".gitattributes" |
432 | #define INFOATTRIBUTES_FILE "info/attributes" | |
f48fd688 | 433 | #define ATTRIBUTE_MACRO_PREFIX "[attr]" |
a97a7468 JS |
434 | #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" |
435 | #define GIT_NOTES_DEFAULT_REF "refs/notes/commits" | |
894a9d33 | 436 | #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" |
6956f858 TR |
437 | #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" |
438 | #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" | |
823ab40f | 439 | #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" |
bd30c2e4 NTND |
440 | #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" |
441 | #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" | |
93d93537 | 442 | #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" |
e34c2e01 | 443 | #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH" |
bb233d69 | 444 | |
48a7c1c4 | 445 | /* |
2cd83d10 JK |
446 | * This environment variable is expected to contain a boolean indicating |
447 | * whether we should or should not treat: | |
448 | * | |
449 | * GIT_DIR=foo.git git ... | |
450 | * | |
451 | * as if GIT_WORK_TREE=. was given. It's not expected that users will make use | |
452 | * of this, but we use it internally to communicate to sub-processes that we | |
453 | * are in a bare repo. If not set, defaults to true. | |
454 | */ | |
455 | #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" | |
456 | ||
48a7c1c4 | 457 | /* |
2163e5db JK |
458 | * Repository-local GIT_* environment variables; these will be cleared |
459 | * when git spawns a sub-process that runs inside another repository. | |
460 | * The array is NULL-terminated, which makes it easy to pass in the "env" | |
461 | * parameter of a run-command invocation, or to do a simple walk. | |
48a7c1c4 | 462 | */ |
2163e5db | 463 | extern const char * const local_repo_env[]; |
48a7c1c4 | 464 | |
b9605bc4 JK |
465 | /* |
466 | * Returns true iff we have a configured git repository (either via | |
467 | * setup_git_directory, or in the environment via $GIT_DIR). | |
468 | */ | |
469 | int have_git_dir(void); | |
470 | ||
7d1864ce JH |
471 | extern int is_bare_repository_cfg; |
472 | extern int is_bare_repository(void); | |
68025633 | 473 | extern int is_inside_git_dir(void); |
e90fdc39 | 474 | extern char *git_work_tree_cfg; |
892c41b9 | 475 | extern int is_inside_work_tree(void); |
c5fba16c | 476 | extern const char *get_git_dir(void); |
c7b3a3d2 | 477 | extern const char *get_git_common_dir(void); |
8ac069ac JH |
478 | extern char *get_object_directory(void); |
479 | extern char *get_index_file(void); | |
5da5c8f4 | 480 | extern char *get_graft_file(void); |
d7ac12b2 | 481 | extern int set_git_dir(const char *path); |
11f9dd71 | 482 | extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir); |
31e26ebc | 483 | extern int get_common_dir(struct strbuf *sb, const char *gitdir); |
a1bea2c1 JT |
484 | extern const char *get_git_namespace(void); |
485 | extern const char *strip_namespace(const char *namespaced_ref); | |
74866d75 | 486 | extern const char *get_super_prefix(void); |
e90fdc39 | 487 | extern const char *get_git_work_tree(void); |
a93bedad | 488 | |
ffd036b1 JK |
489 | /* |
490 | * Return true if the given path is a git directory; note that this _just_ | |
491 | * looks at the directory itself. If you want to know whether "foo/.git" | |
492 | * is a repository, you must feed that path, not just "foo". | |
493 | */ | |
494 | extern int is_git_directory(const char *path); | |
495 | ||
496 | /* | |
497 | * Return 1 if the given path is the root of a git repository or | |
498 | * submodule, else 0. Will not return 1 for bare repositories with the | |
499 | * exception of creating a bare repository in "foo/.git" and calling | |
500 | * is_git_repository("foo"). | |
501 | * | |
502 | * If we run into read errors, we err on the side of saying "yes, it is", | |
503 | * as we usually consider sub-repos precious, and would prefer to err on the | |
504 | * side of not disrupting or deleting them. | |
505 | */ | |
506 | extern int is_nonbare_repository_dir(struct strbuf *path); | |
507 | ||
a93bedad EE |
508 | #define READ_GITFILE_ERR_STAT_FAILED 1 |
509 | #define READ_GITFILE_ERR_NOT_A_FILE 2 | |
510 | #define READ_GITFILE_ERR_OPEN_FAILED 3 | |
511 | #define READ_GITFILE_ERR_READ_FAILED 4 | |
512 | #define READ_GITFILE_ERR_INVALID_FORMAT 5 | |
513 | #define READ_GITFILE_ERR_NO_PATH 6 | |
514 | #define READ_GITFILE_ERR_NOT_A_REPO 7 | |
921bdd96 | 515 | #define READ_GITFILE_ERR_TOO_LARGE 8 |
5f29433f | 516 | extern void read_gitfile_error_die(int error_code, const char *path, const char *dir); |
a93bedad EE |
517 | extern const char *read_gitfile_gently(const char *path, int *return_error_code); |
518 | #define read_gitfile(path) read_gitfile_gently((path), NULL) | |
40d96325 SB |
519 | extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code); |
520 | #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) | |
521 | ||
19757d80 | 522 | extern void set_git_work_tree(const char *tree); |
8ac069ac JH |
523 | |
524 | #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" | |
bb233d69 | 525 | |
59f0f2f3 | 526 | extern void setup_work_tree(void); |
16ac8b8d | 527 | /* |
d3fb71b3 BW |
528 | * Find the commondir and gitdir of the repository that contains the current |
529 | * working directory, without changing the working directory or other global | |
530 | * state. The result is appended to commondir and gitdir. If the discovered | |
531 | * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will | |
532 | * both have the same result appended to the buffer. The return value is | |
533 | * either 0 upon success and non-zero if no repository was found. | |
16ac8b8d | 534 | */ |
d3fb71b3 BW |
535 | extern int discover_git_directory(struct strbuf *commondir, |
536 | struct strbuf *gitdir); | |
4ca06608 | 537 | extern const char *setup_git_directory_gently(int *); |
d288a700 | 538 | extern const char *setup_git_directory(void); |
edc54fb5 | 539 | extern char *prefix_path(const char *prefix, int len, const char *path); |
645a29c4 | 540 | extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); |
59801976 JK |
541 | |
542 | /* | |
543 | * Concatenate "prefix" (if len is non-zero) and "path", with no | |
544 | * connecting characters (so "prefix" should end with a "/"). | |
545 | * Unlike prefix_path, this should be used if the named file does | |
546 | * not have to interact with index entry; i.e. name of a random file | |
547 | * on the filesystem. | |
548 | * | |
e4da43b1 JK |
549 | * The return value is always a newly allocated string (even if the |
550 | * prefix was empty). | |
59801976 | 551 | */ |
e4da43b1 | 552 | extern char *prefix_filename(const char *prefix, const char *path); |
59801976 | 553 | |
c6e8c800 | 554 | extern int check_filename(const char *prefix, const char *name); |
023e37c3 MM |
555 | extern void verify_filename(const char *prefix, |
556 | const char *name, | |
557 | int diagnose_misspelt_rev); | |
ea92f41f | 558 | extern void verify_non_filename(const char *prefix, const char *name); |
546e0fd9 | 559 | extern int path_inside_repo(const char *prefix, const char *path); |
d288a700 | 560 | |
f225aeb2 | 561 | #define INIT_DB_QUIET 0x0001 |
33158701 | 562 | #define INIT_DB_EXIST_OK 0x0002 |
f225aeb2 | 563 | |
33158701 NTND |
564 | extern int init_db(const char *git_dir, const char *real_git_dir, |
565 | const char *template_dir, unsigned int flags); | |
f225aeb2 | 566 | |
1d999ddd | 567 | extern void sanitize_stdfds(void); |
de0957ce | 568 | extern int daemonize(void); |
1d999ddd | 569 | |
e83c5163 LT |
570 | #define alloc_nr(x) (((x)+16)*3/2) |
571 | ||
6815e569 JK |
572 | /* |
573 | * Realloc the buffer pointed at by variable 'x' so that it can hold | |
574 | * at least 'nr' entries; the number of entries currently allocated | |
575 | * is 'alloc', using the standard growing factor alloc_nr() macro. | |
576 | * | |
01f6fd4b | 577 | * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. |
6815e569 JK |
578 | */ |
579 | #define ALLOC_GROW(x, nr, alloc) \ | |
580 | do { \ | |
c927e6c6 | 581 | if ((nr) > alloc) { \ |
4234a761 JH |
582 | if (alloc_nr(alloc) < (nr)) \ |
583 | alloc = (nr); \ | |
584 | else \ | |
585 | alloc = alloc_nr(alloc); \ | |
2756ca43 | 586 | REALLOC_ARRAY(x, alloc); \ |
6815e569 | 587 | } \ |
98746061 | 588 | } while (0) |
6815e569 | 589 | |
734aab75 | 590 | /* Initialize and use the cache information */ |
03b86647 | 591 | struct lock_file; |
4aab5b46 | 592 | extern int read_index(struct index_state *); |
5ab2a2da | 593 | extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); |
3e52f70b NTND |
594 | extern int do_read_index(struct index_state *istate, const char *path, |
595 | int must_exist); /* for testting only! */ | |
4aab5b46 | 596 | extern int read_index_from(struct index_state *, const char *path); |
fa7b3c2f | 597 | extern int is_index_unborn(struct index_state *); |
e46bbcf6 | 598 | extern int read_index_unmerged(struct index_state *); |
03b86647 NTND |
599 | #define COMMIT_LOCK (1 << 0) |
600 | #define CLOSE_LOCK (1 << 1) | |
601 | extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); | |
4aab5b46 | 602 | extern int discard_index(struct index_state *); |
edf3b905 | 603 | extern void move_index_extensions(struct index_state *dst, struct index_state *src); |
d1f128b0 | 604 | extern int unmerged_index(const struct index_state *); |
8dcf39c4 | 605 | extern int verify_path(const char *path); |
a6db3fbb | 606 | extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change); |
41284eb0 DT |
607 | extern int index_dir_exists(struct index_state *istate, const char *name, int namelen); |
608 | extern void adjust_dirname_case(struct index_state *istate, char *name); | |
db5360f3 | 609 | extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); |
12733e9d SB |
610 | |
611 | /* | |
612 | * Searches for an entry defined by name and namelen in the given index. | |
613 | * If the return value is positive (including 0) it is the position of an | |
614 | * exact match. If the return value is negative, the negated value minus 1 | |
615 | * is the position where the entry would be inserted. | |
616 | * Example: The current index consists of these files and its stages: | |
617 | * | |
618 | * b#0, d#0, f#1, f#3 | |
619 | * | |
620 | * index_name_pos(&index, "a", 1) -> -1 | |
621 | * index_name_pos(&index, "b", 1) -> 0 | |
622 | * index_name_pos(&index, "c", 1) -> -2 | |
623 | * index_name_pos(&index, "d", 1) -> 1 | |
624 | * index_name_pos(&index, "e", 1) -> -3 | |
625 | * index_name_pos(&index, "f", 1) -> -3 | |
626 | * index_name_pos(&index, "g", 1) -> -5 | |
627 | */ | |
d1f128b0 | 628 | extern int index_name_pos(const struct index_state *, const char *name, int namelen); |
12733e9d | 629 | |
192268c1 JH |
630 | #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ |
631 | #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ | |
b155725d | 632 | #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ |
af3785dc | 633 | #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ |
39425819 | 634 | #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ |
ce7c614b | 635 | #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ |
4aab5b46 | 636 | extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); |
81dc2307 | 637 | extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); |
3bd72adf SB |
638 | |
639 | /* Remove entry, return true if there are more entries to go. */ | |
4aab5b46 | 640 | extern int remove_index_entry_at(struct index_state *, int pos); |
3bd72adf | 641 | |
36419c8e | 642 | extern void remove_marked_cache_entries(struct index_state *istate); |
4aab5b46 | 643 | extern int remove_file_from_index(struct index_state *, const char *path); |
38ed1d89 JH |
644 | #define ADD_CACHE_VERBOSE 1 |
645 | #define ADD_CACHE_PRETEND 2 | |
01665924 | 646 | #define ADD_CACHE_IGNORE_ERRORS 4 |
041aee31 | 647 | #define ADD_CACHE_IGNORE_REMOVAL 8 |
39425819 | 648 | #define ADD_CACHE_INTENT 16 |
20cf41d0 SB |
649 | /* |
650 | * These two are used to add the contents of the file at path | |
651 | * to the index, marking the working tree up-to-date by storing | |
652 | * the cached stat info in the resulting cache entry. A caller | |
653 | * that has already run lstat(2) on the path can call | |
654 | * add_to_index(), and all others can call add_file_to_index(); | |
655 | * the latter will do necessary lstat(2) internally before | |
656 | * calling the former. | |
657 | */ | |
610d55af TG |
658 | extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); |
659 | extern int add_file_to_index(struct index_state *, const char *path, int flags); | |
20cf41d0 | 660 | |
25762726 | 661 | extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); |
d9d70966 | 662 | extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip); |
9c5e6c80 | 663 | extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); |
b4b313f9 | 664 | extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); |
98fa4738 | 665 | extern int index_name_is_other(const struct index_state *, const char *, int); |
87542508 | 666 | extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *); |
4bd5b7da JH |
667 | |
668 | /* do stat comparison even if CE_VALID is true */ | |
669 | #define CE_MATCH_IGNORE_VALID 01 | |
670 | /* do not check the contents but report dirty on racily-clean entries */ | |
56cac48c NTND |
671 | #define CE_MATCH_RACY_IS_DIRTY 02 |
672 | /* do stat comparison even if CE_SKIP_WORKTREE is true */ | |
673 | #define CE_MATCH_IGNORE_SKIP_WORKTREE 04 | |
2e2e7ec1 BK |
674 | /* ignore non-existent files during stat update */ |
675 | #define CE_MATCH_IGNORE_MISSING 0x08 | |
25762726 BK |
676 | /* enable stat refresh */ |
677 | #define CE_MATCH_REFRESH 0x10 | |
21a6b9fa RS |
678 | extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); |
679 | extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); | |
4bd5b7da | 680 | |
c4ce46fc JH |
681 | #define HASH_WRITE_OBJECT 1 |
682 | #define HASH_FORMAT_CHECK 2 | |
683 | extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); | |
684 | extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); | |
c21d39d7 MH |
685 | |
686 | /* | |
687 | * Record to sd the data from st that we use to check whether a file | |
688 | * might have changed. | |
689 | */ | |
690 | extern void fill_stat_data(struct stat_data *sd, struct stat *st); | |
691 | ||
692 | /* | |
693 | * Return 0 if st is consistent with a file not having been changed | |
694 | * since sd was filled. If there are differences, return a | |
695 | * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, | |
696 | * INODE_CHANGED, and DATA_CHANGED. | |
697 | */ | |
698 | extern int match_stat_data(const struct stat_data *sd, struct stat *st); | |
ed4efab1 NTND |
699 | extern int match_stat_data_racy(const struct index_state *istate, |
700 | const struct stat_data *sd, struct stat *st); | |
c21d39d7 | 701 | |
415e96c8 JH |
702 | extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); |
703 | ||
405e5b2f LT |
704 | #define REFRESH_REALLY 0x0001 /* ignore_valid */ |
705 | #define REFRESH_UNMERGED 0x0002 /* allow unmerged */ | |
706 | #define REFRESH_QUIET 0x0004 /* be quiet about it */ | |
707 | #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ | |
3f1b7b60 | 708 | #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ |
43673fdd | 709 | #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ |
9b2d6149 | 710 | extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); |
1335d76e | 711 | extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int); |
405e5b2f | 712 | |
ccdc4ec3 | 713 | extern void update_index_if_able(struct index_state *, struct lock_file *); |
30ca07a2 JH |
714 | |
715 | extern int hold_locked_index(struct lock_file *, int); | |
5e7f56ac | 716 | extern void set_alternate_index_output(const char *); |
697cc8ef | 717 | |
a33fc72f JH |
718 | extern int verify_index_checksum; |
719 | ||
2ae1c53b | 720 | /* Environment bits from configuration mechanism */ |
17712991 | 721 | extern int trust_executable_bit; |
1ce4790b | 722 | extern int trust_ctime; |
c08e4d5b | 723 | extern int check_stat; |
9378c161 | 724 | extern int quote_path_fully; |
78a8d641 | 725 | extern int has_symlinks; |
dce96489 | 726 | extern int minimum_abbrev, default_abbrev; |
0a9b88b7 | 727 | extern int ignore_case; |
5f73076c | 728 | extern int assume_unchanged; |
9f0bb90d | 729 | extern int prefer_symlink_refs; |
2f8acdb3 | 730 | extern int warn_ambiguous_refs; |
25fba78d | 731 | extern int warn_on_object_refname_ambiguity; |
2ae1c53b | 732 | extern const char *apply_default_whitespace; |
86c91f91 | 733 | extern const char *apply_default_ignorewhitespace; |
64589a03 | 734 | extern const char *git_attributes_file; |
867ad08a | 735 | extern const char *git_hooks_path; |
12f6c308 | 736 | extern int zlib_compression_level; |
960ccca6 | 737 | extern int core_compression_level; |
8de7eeb5 | 738 | extern int pack_compression_level; |
60bb8b14 | 739 | extern size_t packed_git_window_size; |
77ccc5bb | 740 | extern size_t packed_git_limit; |
18bdec11 | 741 | extern size_t delta_base_cache_limit; |
15366280 | 742 | extern unsigned long big_file_threshold; |
568508e7 | 743 | extern unsigned long pack_size_limit_cfg; |
afc711b8 | 744 | |
4543926b JK |
745 | /* |
746 | * Accessors for the core.sharedrepository config which lazy-load the value | |
747 | * from the config (if not already set). The "reset" function can be | |
748 | * used to unset "set" or cached value, meaning that the value will be loaded | |
749 | * fresh from the config file on the next call to get_shared_repository(). | |
750 | */ | |
7875acb6 JK |
751 | void set_shared_repository(int value); |
752 | int get_shared_repository(void); | |
4543926b | 753 | void reset_shared_repository(void); |
7875acb6 | 754 | |
afc711b8 MH |
755 | /* |
756 | * Do replace refs need to be checked this run? This variable is | |
757 | * initialized to true unless --no-replace-object is used or | |
758 | * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some | |
759 | * commands that do not want replace references to be active. As an | |
760 | * optimization it is also set to false if replace references have | |
761 | * been sought but there were none. | |
762 | */ | |
763 | extern int check_replace_refs; | |
58d121b2 | 764 | extern char *git_replace_ref_base; |
afc711b8 | 765 | |
aafe9fba | 766 | extern int fsync_object_files; |
671c9b7e | 767 | extern int core_preload_index; |
08aefc9e | 768 | extern int core_apply_sparse_checkout; |
76759c7d | 769 | extern int precomposed_unicode; |
a42643aa | 770 | extern int protect_hfs; |
2b4c6efc | 771 | extern int protect_ntfs; |
c7b3a3d2 | 772 | extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env; |
17712991 | 773 | |
49672f26 JK |
774 | /* |
775 | * Include broken refs in all ref iterations, which will | |
776 | * generally choke dangerous operations rather than letting | |
777 | * them silently proceed without taking the broken ref into | |
778 | * account. | |
779 | */ | |
780 | extern int ref_paranoia; | |
781 | ||
eff80a9f JH |
782 | /* |
783 | * The character that begins a commented line in user-editable file | |
784 | * that is subject to stripspace. | |
785 | */ | |
786 | extern char comment_line_char; | |
84c9dc2c | 787 | extern int auto_comment_line_char; |
eff80a9f | 788 | |
f30afdab JS |
789 | /* Windows only */ |
790 | enum hide_dotfiles_type { | |
791 | HIDE_DOTFILES_FALSE = 0, | |
792 | HIDE_DOTFILES_TRUE, | |
793 | HIDE_DOTFILES_DOTGITONLY | |
794 | }; | |
795 | extern enum hide_dotfiles_type hide_dotfiles; | |
796 | ||
341fb286 CW |
797 | enum log_refs_config { |
798 | LOG_REFS_UNSET = -1, | |
799 | LOG_REFS_NONE = 0, | |
800 | LOG_REFS_NORMAL, | |
801 | LOG_REFS_ALWAYS | |
802 | }; | |
803 | extern enum log_refs_config log_all_ref_updates; | |
804 | ||
9ed36cfa | 805 | enum branch_track { |
9188ed89 | 806 | BRANCH_TRACK_UNSPECIFIED = -1, |
9ed36cfa JS |
807 | BRANCH_TRACK_NEVER = 0, |
808 | BRANCH_TRACK_REMOTE, | |
809 | BRANCH_TRACK_ALWAYS, | |
810 | BRANCH_TRACK_EXPLICIT, | |
4b05548f | 811 | BRANCH_TRACK_OVERRIDE |
9ed36cfa JS |
812 | }; |
813 | ||
c998ae9b DS |
814 | enum rebase_setup_type { |
815 | AUTOREBASE_NEVER = 0, | |
816 | AUTOREBASE_LOCAL, | |
817 | AUTOREBASE_REMOTE, | |
4b05548f | 818 | AUTOREBASE_ALWAYS |
c998ae9b DS |
819 | }; |
820 | ||
52153747 | 821 | enum push_default_type { |
52153747 FAG |
822 | PUSH_DEFAULT_NOTHING = 0, |
823 | PUSH_DEFAULT_MATCHING, | |
b55e6775 | 824 | PUSH_DEFAULT_SIMPLE, |
53c40311 | 825 | PUSH_DEFAULT_UPSTREAM, |
f25950f3 CT |
826 | PUSH_DEFAULT_CURRENT, |
827 | PUSH_DEFAULT_UNSPECIFIED | |
52153747 FAG |
828 | }; |
829 | ||
9ed36cfa | 830 | extern enum branch_track git_branch_track; |
c998ae9b | 831 | extern enum rebase_setup_type autorebase; |
52153747 | 832 | extern enum push_default_type push_default; |
9ed36cfa | 833 | |
348df166 JS |
834 | enum object_creation_mode { |
835 | OBJECT_CREATION_USES_HARDLINKS = 0, | |
4b05548f | 836 | OBJECT_CREATION_USES_RENAMES = 1 |
348df166 JS |
837 | }; |
838 | ||
839 | extern enum object_creation_mode object_creation_mode; | |
be66a6c4 | 840 | |
a97a7468 JS |
841 | extern char *notes_ref_name; |
842 | ||
7f3140cd JS |
843 | extern int grafts_replace_parents; |
844 | ||
00a09d57 JK |
845 | /* |
846 | * GIT_REPO_VERSION is the version we write by default. The | |
847 | * _READ variant is the highest number we know how to | |
848 | * handle. | |
849 | */ | |
ab9cb76f | 850 | #define GIT_REPO_VERSION 0 |
00a09d57 | 851 | #define GIT_REPO_VERSION_READ 1 |
067fbd41 | 852 | extern int repository_format_precious_objects; |
4b0d1eeb | 853 | |
2cc7c2c7 JK |
854 | struct repository_format { |
855 | int version; | |
856 | int precious_objects; | |
857 | int is_bare; | |
858 | char *work_tree; | |
859 | struct string_list unknown_extensions; | |
860 | }; | |
861 | ||
862 | /* | |
863 | * Read the repository format characteristics from the config file "path" into | |
864 | * "format" struct. Returns the numeric version. On error, -1 is returned, | |
865 | * format->version is set to -1, and all other fields in the struct are | |
866 | * undefined. | |
867 | */ | |
868 | int read_repository_format(struct repository_format *format, const char *path); | |
869 | ||
870 | /* | |
871 | * Verify that the repository described by repository_format is something we | |
872 | * can read. If it is, return 0. Otherwise, return -1, and "err" will describe | |
873 | * any errors encountered. | |
874 | */ | |
875 | int verify_repository_format(const struct repository_format *format, | |
876 | struct strbuf *err); | |
877 | ||
4b0d1eeb JK |
878 | /* |
879 | * Check the repository format version in the path found in get_git_dir(), | |
880 | * and die if it is a version we don't understand. Generally one would | |
881 | * set_git_dir() before calling this, and use it only for "are we in a valid | |
882 | * repo?". | |
883 | */ | |
884 | extern void check_repository_format(void); | |
ab9cb76f | 885 | |
734aab75 LT |
886 | #define MTIME_CHANGED 0x0001 |
887 | #define CTIME_CHANGED 0x0002 | |
888 | #define OWNER_CHANGED 0x0004 | |
889 | #define MODE_CHANGED 0x0008 | |
890 | #define INODE_CHANGED 0x0010 | |
891 | #define DATA_CHANGED 0x0020 | |
8ae0a8c5 | 892 | #define TYPE_CHANGED 0x0040 |
e83c5163 | 893 | |
69ddd231 JK |
894 | /* |
895 | * Return a statically allocated filename, either generically (mkpath), in | |
896 | * the repository directory (git_path), or in a submodule's repository | |
897 | * directory (git_path_submodule). In all cases, note that the result | |
898 | * may be overwritten by another call to _any_ of the functions. Consider | |
07e3070d JK |
899 | * using the safer "dup" or "strbuf" formats below (in some cases, the |
900 | * unsafe versions have already been removed). | |
69ddd231 JK |
901 | */ |
902 | extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); | |
903 | extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); | |
15cdfea7 | 904 | extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); |
69ddd231 | 905 | |
108bebea AR |
906 | extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) |
907 | __attribute__((format (printf, 3, 4))); | |
1a83c240 NTND |
908 | extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...) |
909 | __attribute__((format (printf, 2, 3))); | |
15cdfea7 NTND |
910 | extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...) |
911 | __attribute__((format (printf, 2, 3))); | |
bb3788ce JK |
912 | extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...) |
913 | __attribute__((format (printf, 2, 3))); | |
99b43a61 JK |
914 | extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path, |
915 | const char *fmt, ...) | |
f5895fd3 | 916 | __attribute__((format (printf, 3, 4))); |
aba13e7c AR |
917 | extern char *git_pathdup(const char *fmt, ...) |
918 | __attribute__((format (printf, 1, 2))); | |
21cf3227 HKNN |
919 | extern char *mkpathdup(const char *fmt, ...) |
920 | __attribute__((format (printf, 1, 2))); | |
f5895fd3 | 921 | extern char *git_pathdup_submodule(const char *path, const char *fmt, ...) |
0bad611b | 922 | __attribute__((format (printf, 2, 3))); |
108bebea | 923 | |
77a6d840 | 924 | extern void report_linked_checkout_garbage(void); |
0bad611b | 925 | |
f932729c JK |
926 | /* |
927 | * You can define a static memoized git path like: | |
928 | * | |
929 | * static GIT_PATH_FUNC(git_path_foo, "FOO"); | |
930 | * | |
931 | * or use one of the global ones below. | |
932 | */ | |
933 | #define GIT_PATH_FUNC(func, filename) \ | |
934 | const char *func(void) \ | |
935 | { \ | |
936 | static char *ret; \ | |
937 | if (!ret) \ | |
938 | ret = git_pathdup(filename); \ | |
939 | return ret; \ | |
940 | } | |
941 | ||
942 | const char *git_path_cherry_pick_head(void); | |
943 | const char *git_path_revert_head(void); | |
944 | const char *git_path_squash_msg(void); | |
945 | const char *git_path_merge_msg(void); | |
946 | const char *git_path_merge_rr(void); | |
947 | const char *git_path_merge_mode(void); | |
948 | const char *git_path_merge_head(void); | |
949 | const char *git_path_fetch_head(void); | |
950 | const char *git_path_shallow(void); | |
951 | ||
d40d535b MH |
952 | /* |
953 | * Return the name of the file in the local object database that would | |
954 | * be used to store a loose object with the specified sha1. The | |
955 | * return value is a pointer to a statically allocated buffer that is | |
956 | * overwritten each time the function is called. | |
957 | */ | |
30d6c6ea | 958 | extern const char *sha1_file_name(const unsigned char *sha1); |
d40d535b MH |
959 | |
960 | /* | |
961 | * Return the name of the (local) packfile with the specified sha1 in | |
962 | * its name. The return value is a pointer to memory that is | |
963 | * overwritten each time this function is called. | |
964 | */ | |
bf592c50 | 965 | extern char *sha1_pack_name(const unsigned char *sha1); |
d40d535b MH |
966 | |
967 | /* | |
968 | * Return the name of the (local) pack index file with the specified | |
969 | * sha1 in its name. The return value is a pointer to memory that is | |
970 | * overwritten each time this function is called. | |
971 | */ | |
bf592c50 | 972 | extern char *sha1_pack_index_name(const unsigned char *sha1); |
d40d535b | 973 | |
af49c6d0 JK |
974 | /* |
975 | * Return an abbreviated sha1 unique within this repository's object database. | |
976 | * The result will be at least `len` characters long, and will be NUL | |
977 | * terminated. | |
978 | * | |
ef2ed501 JK |
979 | * The non-`_r` version returns a static buffer which remains valid until 4 |
980 | * more calls to find_unique_abbrev are made. | |
af49c6d0 JK |
981 | * |
982 | * The `_r` variant writes to a buffer supplied by the caller, which must be at | |
983 | * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes | |
984 | * written (excluding the NUL terminator). | |
985 | * | |
986 | * Note that while this version avoids the static buffer, it is not fully | |
987 | * reentrant, as it calls into other non-reentrant git code. | |
988 | */ | |
989 | extern const char *find_unique_abbrev(const unsigned char *sha1, int len); | |
990 | extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len); | |
991 | ||
cd02599c | 992 | extern const unsigned char null_sha1[GIT_MAX_RAWSZ]; |
3e56e724 | 993 | extern const struct object_id null_oid; |
1a812f3a IM |
994 | |
995 | static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) | |
0bef57ee | 996 | { |
1a812f3a IM |
997 | int i; |
998 | ||
aa1c6fdf | 999 | for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { |
1a812f3a IM |
1000 | if (*sha1 != *sha2) |
1001 | return *sha1 - *sha2; | |
1002 | } | |
1003 | ||
1004 | return 0; | |
0bef57ee | 1005 | } |
1a812f3a | 1006 | |
aa1c6fdf | 1007 | static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2) |
1008 | { | |
1009 | return hashcmp(oid1->hash, oid2->hash); | |
1010 | } | |
1011 | ||
1a812f3a | 1012 | static inline int is_null_sha1(const unsigned char *sha1) |
a89fccd2 | 1013 | { |
1a812f3a | 1014 | return !hashcmp(sha1, null_sha1); |
a89fccd2 | 1015 | } |
1a812f3a | 1016 | |
aa1c6fdf | 1017 | static inline int is_null_oid(const struct object_id *oid) |
1018 | { | |
1019 | return !hashcmp(oid->hash, null_sha1); | |
1020 | } | |
1021 | ||
e702496e SP |
1022 | static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) |
1023 | { | |
aa1c6fdf | 1024 | memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); |
e702496e | 1025 | } |
aa1c6fdf | 1026 | |
1027 | static inline void oidcpy(struct object_id *dst, const struct object_id *src) | |
1028 | { | |
1029 | hashcpy(dst->hash, src->hash); | |
e702496e | 1030 | } |
aa1c6fdf | 1031 | |
1c41c82b BW |
1032 | static inline struct object_id *oiddup(const struct object_id *src) |
1033 | { | |
1034 | struct object_id *dst = xmalloc(sizeof(struct object_id)); | |
1035 | oidcpy(dst, src); | |
1036 | return dst; | |
1037 | } | |
1038 | ||
a8e0d16d JH |
1039 | static inline void hashclr(unsigned char *hash) |
1040 | { | |
aa1c6fdf | 1041 | memset(hash, 0, GIT_SHA1_RAWSZ); |
a8e0d16d | 1042 | } |
e83c5163 | 1043 | |
aa1c6fdf | 1044 | static inline void oidclr(struct object_id *oid) |
1045 | { | |
1046 | hashclr(oid->hash); | |
1047 | } | |
1048 | ||
1049 | ||
14d9c578 JK |
1050 | #define EMPTY_TREE_SHA1_HEX \ |
1051 | "4b825dc642cb6eb9a060e54bf8d69288fbee4904" | |
dab0d410 | 1052 | #define EMPTY_TREE_SHA1_BIN_LITERAL \ |
14d9c578 JK |
1053 | "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ |
1054 | "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" | |
8576fde6 JK |
1055 | extern const struct object_id empty_tree_oid; |
1056 | #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash) | |
14d9c578 | 1057 | |
f8582cad JK |
1058 | #define EMPTY_BLOB_SHA1_HEX \ |
1059 | "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" | |
1060 | #define EMPTY_BLOB_SHA1_BIN_LITERAL \ | |
1061 | "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ | |
1062 | "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" | |
8576fde6 JK |
1063 | extern const struct object_id empty_blob_oid; |
1064 | #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash) | |
1065 | ||
f8582cad JK |
1066 | |
1067 | static inline int is_empty_blob_sha1(const unsigned char *sha1) | |
1068 | { | |
1069 | return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN); | |
1070 | } | |
1071 | ||
8576fde6 JK |
1072 | static inline int is_empty_blob_oid(const struct object_id *oid) |
1073 | { | |
1074 | return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN); | |
1075 | } | |
1076 | ||
1077 | static inline int is_empty_tree_sha1(const unsigned char *sha1) | |
1078 | { | |
1079 | return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN); | |
1080 | } | |
1081 | ||
1082 | static inline int is_empty_tree_oid(const struct object_id *oid) | |
1083 | { | |
1084 | return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN); | |
1085 | } | |
1086 | ||
b862b61c MM |
1087 | /* set default permissions by passing mode arguments to open(2) */ |
1088 | int git_mkstemps_mode(char *pattern, int suffix_len, int mode); | |
1089 | int git_mkstemp_mode(char *pattern, int mode); | |
1090 | ||
06cbe855 HO |
1091 | /* |
1092 | * NOTE NOTE NOTE!! | |
1093 | * | |
1094 | * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must | |
1095 | * not be changed. Old repositories have core.sharedrepository written in | |
1096 | * numeric format, and therefore these values are preserved for compatibility | |
1097 | * reasons. | |
1098 | */ | |
94df2506 | 1099 | enum sharedrepo { |
06cbe855 HO |
1100 | PERM_UMASK = 0, |
1101 | OLD_PERM_GROUP = 1, | |
1102 | OLD_PERM_EVERYBODY = 2, | |
1103 | PERM_GROUP = 0660, | |
4b05548f | 1104 | PERM_EVERYBODY = 0664 |
94df2506 JH |
1105 | }; |
1106 | int git_config_perm(const char *var, const char *value); | |
3a429d3b | 1107 | int adjust_shared_perm(const char *path); |
0be0521b MH |
1108 | |
1109 | /* | |
1110 | * Create the directory containing the named path, using care to be | |
204a047f MH |
1111 | * somewhat safe against races. Return one of the scld_error values to |
1112 | * indicate success/failure. On error, set errno to describe the | |
1113 | * problem. | |
18d37e86 MH |
1114 | * |
1115 | * SCLD_VANISHED indicates that one of the ancestor directories of the | |
1116 | * path existed at one point during the function call and then | |
1117 | * suddenly vanished, probably because another process pruned the | |
1118 | * directory while we were working. To be robust against this kind of | |
1119 | * race, callers might want to try invoking the function again when it | |
1120 | * returns SCLD_VANISHED. | |
e95792e5 MH |
1121 | * |
1122 | * safe_create_leading_directories() temporarily changes path while it | |
1123 | * is working but restores it before returning. | |
1124 | * safe_create_leading_directories_const() doesn't modify path, even | |
1125 | * temporarily. | |
0be0521b MH |
1126 | */ |
1127 | enum scld_error { | |
1128 | SCLD_OK = 0, | |
1129 | SCLD_FAILED = -1, | |
1130 | SCLD_PERMS = -2, | |
18d37e86 MH |
1131 | SCLD_EXISTS = -3, |
1132 | SCLD_VANISHED = -4 | |
0be0521b MH |
1133 | }; |
1134 | enum scld_error safe_create_leading_directories(char *path); | |
1135 | enum scld_error safe_create_leading_directories_const(const char *path); | |
1136 | ||
177978f5 MH |
1137 | /* |
1138 | * Callback function for raceproof_create_file(). This function is | |
1139 | * expected to do something that makes dirname(path) permanent despite | |
1140 | * the fact that other processes might be cleaning up empty | |
1141 | * directories at the same time. Usually it will create a file named | |
1142 | * path, but alternatively it could create another file in that | |
1143 | * directory, or even chdir() into that directory. The function should | |
1144 | * return 0 if the action was completed successfully. On error, it | |
1145 | * should return a nonzero result and set errno. | |
1146 | * raceproof_create_file() treats two errno values specially: | |
1147 | * | |
1148 | * - ENOENT -- dirname(path) does not exist. In this case, | |
1149 | * raceproof_create_file() tries creating dirname(path) | |
1150 | * (and any parent directories, if necessary) and calls | |
1151 | * the function again. | |
1152 | * | |
1153 | * - EISDIR -- the file already exists and is a directory. In this | |
1154 | * case, raceproof_create_file() removes the directory if | |
1155 | * it is empty (and recursively any empty directories that | |
1156 | * it contains) and calls the function again. | |
1157 | * | |
1158 | * Any other errno causes raceproof_create_file() to fail with the | |
1159 | * callback's return value and errno. | |
1160 | * | |
1161 | * Obviously, this function should be OK with being called again if it | |
1162 | * fails with ENOENT or EISDIR. In other scenarios it will not be | |
1163 | * called again. | |
1164 | */ | |
1165 | typedef int create_file_fn(const char *path, void *cb); | |
1166 | ||
1167 | /* | |
1168 | * Create a file in dirname(path) by calling fn, creating leading | |
1169 | * directories if necessary. Retry a few times in case we are racing | |
1170 | * with another process that is trying to clean up the directory that | |
1171 | * contains path. See the documentation for create_file_fn for more | |
1172 | * details. | |
1173 | * | |
1174 | * Return the value and set the errno that resulted from the most | |
1175 | * recent call of fn. fn is always called at least once, and will be | |
1176 | * called more than once if it returns ENOENT or EISDIR. | |
1177 | */ | |
1178 | int raceproof_create_file(const char *path, create_file_fn fn, void *cb); | |
1179 | ||
90a6464b | 1180 | int mkdir_in_gitdir(const char *path); |
4aad2f16 | 1181 | extern char *expand_user_path(const char *path, int real_home); |
1c64b48e | 1182 | const char *enter_repo(const char *path, int strict); |
e5392c51 JS |
1183 | static inline int is_absolute_path(const char *path) |
1184 | { | |
88135203 | 1185 | return is_dir_sep(path[0]) || has_dos_drive_prefix(path); |
e5392c51 | 1186 | } |
90b4a71c | 1187 | int is_directory(const char *); |
a1ae4841 BW |
1188 | char *strbuf_realpath(struct strbuf *resolved, const char *path, |
1189 | int die_on_error); | |
e2a57aac | 1190 | const char *real_path(const char *path); |
e3e46cdb | 1191 | const char *real_path_if_valid(const char *path); |
ce83eadd | 1192 | char *real_pathdup(const char *path, int die_on_error); |
e2a57aac | 1193 | const char *absolute_path(const char *path); |
b1edb40f | 1194 | char *absolute_pathdup(const char *path); |
41894ae3 | 1195 | const char *remove_leading_path(const char *in, const char *prefix); |
e02ca72f | 1196 | const char *relative_path(const char *in, const char *prefix, struct strbuf *sb); |
645a29c4 | 1197 | int normalize_path_copy_len(char *dst, const char *src, int *prefix_len); |
f3cad0ad | 1198 | int normalize_path_copy(char *dst, const char *src); |
31171d9e | 1199 | int longest_ancestor_length(const char *path, struct string_list *prefixes); |
4fcc86b0 | 1200 | char *strip_path_suffix(const char *path, const char *suffix); |
34b6cb8b | 1201 | int daemon_avoid_alias(const char *path); |
1d1d69bc | 1202 | extern int is_ntfs_dotgit(const char *name); |
b2cb9425 | 1203 | |
ea19289b PT |
1204 | /** |
1205 | * Return a newly allocated string with the evaluation of | |
1206 | * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise | |
1207 | * "$HOME/.config/git/$filename". Return NULL upon error. | |
1208 | */ | |
1209 | extern char *xdg_config_home(const char *filename); | |
1210 | ||
e7f136bf DL |
1211 | /** |
1212 | * Return a newly allocated string with the evaluation of | |
1213 | * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise | |
1214 | * "$HOME/.cache/git/$filename". Return NULL upon error. | |
1215 | */ | |
1216 | extern char *xdg_cache_home(const char *filename); | |
1217 | ||
e1111cef | 1218 | /* object replacement */ |
ffe68cf9 | 1219 | #define LOOKUP_REPLACE_OBJECT 1 |
46f03448 | 1220 | #define LOOKUP_UNKNOWN_OBJECT 2 |
5bf29b95 | 1221 | extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag); |
f5552aee CC |
1222 | static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size) |
1223 | { | |
ffe68cf9 | 1224 | return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT); |
5bf29b95 | 1225 | } |
1f91e79c MH |
1226 | |
1227 | /* | |
1228 | * This internal function is only declared here for the benefit of | |
1229 | * lookup_replace_object(). Please do not call it directly. | |
1230 | */ | |
e1111cef | 1231 | extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1); |
1f91e79c MH |
1232 | |
1233 | /* | |
1234 | * If object sha1 should be replaced, return the replacement object's | |
1235 | * name (replaced recursively, if necessary). The return value is | |
1236 | * either sha1 or a pointer to a permanently-allocated value. When | |
1237 | * object replacement is suppressed, always return sha1. | |
1238 | */ | |
e1111cef JH |
1239 | static inline const unsigned char *lookup_replace_object(const unsigned char *sha1) |
1240 | { | |
afc711b8 | 1241 | if (!check_replace_refs) |
e1111cef JH |
1242 | return sha1; |
1243 | return do_lookup_replace_object(sha1); | |
f5552aee | 1244 | } |
1f91e79c | 1245 | |
bf93eea0 CC |
1246 | static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag) |
1247 | { | |
1248 | if (!(flag & LOOKUP_REPLACE_OBJECT)) | |
1249 | return sha1; | |
1250 | return lookup_replace_object(sha1); | |
1251 | } | |
e1111cef | 1252 | |
e83c5163 | 1253 | /* Read and unpack a sha1 file into memory, write memory to a sha1 file */ |
21666f1a | 1254 | extern int sha1_object_info(const unsigned char *, unsigned long *); |
ce9fbf16 | 1255 | extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1); |
c00e657d | 1256 | extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1); |
0c3db67c | 1257 | extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags); |
21666f1a | 1258 | extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *); |
bbac7311 | 1259 | extern int force_object_loose(const unsigned char *sha1, time_t mtime); |
1b8ac5ea | 1260 | extern int git_open_cloexec(const char *name, int flags); |
b4d065df | 1261 | #define git_open(name) git_open_cloexec(name, O_RDONLY) |
f0270efd | 1262 | extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size); |
eb4f4076 | 1263 | extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz); |
f0270efd | 1264 | extern int parse_sha1_header(const char *hdr, unsigned long *sizep); |
8237b185 | 1265 | |
0e8189e2 NP |
1266 | /* global flag to enable extra checks when accessing packed objects */ |
1267 | extern int do_check_packed_object_crc; | |
1268 | ||
5d6ccf5c | 1269 | extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type); |
e83c5163 | 1270 | |
cb5add58 | 1271 | extern int finalize_object_file(const char *tmpfile, const char *filename); |
8237b185 | 1272 | |
cd673c1f | 1273 | extern int has_sha1_pack(const unsigned char *sha1); |
d40d535b | 1274 | |
f6371f92 JK |
1275 | /* |
1276 | * Open the loose object at path, check its sha1, and return the contents, | |
1277 | * type, and size. If the object is a blob, then "contents" may return NULL, | |
1278 | * to allow streaming of large blobs. | |
1279 | * | |
1280 | * Returns 0 on success, negative on error (details may be written to stderr). | |
1281 | */ | |
1282 | int read_loose_object(const char *path, | |
1283 | const unsigned char *expected_sha1, | |
1284 | enum object_type *type, | |
1285 | unsigned long *size, | |
1286 | void **contents); | |
1287 | ||
d40d535b MH |
1288 | /* |
1289 | * Return true iff we have an object named sha1, whether local or in | |
1290 | * an alternate object database, and whether packed or loose. This | |
1291 | * function does not respect replace references. | |
0eeb077b JK |
1292 | * |
1293 | * If the QUICK flag is set, do not re-check the pack directory | |
1294 | * when we cannot find the object (this means we may give a false | |
1295 | * negative answer if another process is simultaneously repacking). | |
d40d535b | 1296 | */ |
0eeb077b JK |
1297 | #define HAS_SHA1_QUICK 0x1 |
1298 | extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags); | |
1299 | static inline int has_sha1_file(const unsigned char *sha1) | |
1300 | { | |
1301 | return has_sha1_file_with_flags(sha1, 0); | |
1302 | } | |
d40d535b | 1303 | |
b419aa25 | 1304 | /* Same as the above, except for struct object_id. */ |
1305 | extern int has_object_file(const struct object_id *oid); | |
5827a035 | 1306 | extern int has_object_file_with_flags(const struct object_id *oid, int flags); |
b419aa25 | 1307 | |
d40d535b MH |
1308 | /* |
1309 | * Return true iff an alternate object database has a loose object | |
1310 | * with the specified name. This function does not respect replace | |
1311 | * references. | |
1312 | */ | |
0f4dc14a | 1313 | extern int has_loose_object_nonlocal(const unsigned char *sha1); |
8237b185 | 1314 | |
bf592c50 DB |
1315 | extern int has_pack_index(const unsigned char *sha1); |
1316 | ||
40d52ff7 JK |
1317 | extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect); |
1318 | ||
6a5e6f5e CC |
1319 | /* Helper to check and "touch" a file */ |
1320 | extern int check_and_freshen_file(const char *fn, int freshen); | |
1321 | ||
192a6be2 LT |
1322 | extern const signed char hexval_table[256]; |
1323 | static inline unsigned int hexval(unsigned char c) | |
e49521b5 JH |
1324 | { |
1325 | return hexval_table[c]; | |
1326 | } | |
1327 | ||
d2330973 RS |
1328 | /* |
1329 | * Convert two consecutive hexadecimal digits into a char. Return a | |
1330 | * negative value on error. Don't run over the end of short strings. | |
1331 | */ | |
1332 | static inline int hex2chr(const char *s) | |
1333 | { | |
1334 | int val = hexval(s[0]); | |
1335 | return (val < 0) ? val : (val << 4) | hexval(s[1]); | |
1336 | } | |
1337 | ||
e83c5163 | 1338 | /* Convert to/from hex/sha1 representation */ |
dce96489 LT |
1339 | #define MINIMUM_ABBREV minimum_abbrev |
1340 | #define DEFAULT_ABBREV default_abbrev | |
46a6c262 | 1341 | |
65acfeac JH |
1342 | /* used when the code does not know or care what the default abbrev is */ |
1343 | #define FALLBACK_DEFAULT_ABBREV 7 | |
1344 | ||
573285e5 CP |
1345 | struct object_context { |
1346 | unsigned char tree[20]; | |
573285e5 | 1347 | unsigned mode; |
c4ec9677 DT |
1348 | /* |
1349 | * symlink_path is only used by get_tree_entry_follow_symlinks, | |
1350 | * and only for symlinks that point outside the repository. | |
1351 | */ | |
1352 | struct strbuf symlink_path; | |
dc944b65 JK |
1353 | /* |
1354 | * If GET_SHA1_RECORD_PATH is set, this will record path (if any) | |
1355 | * found when resolving the name. The caller is responsible for | |
1356 | * releasing the memory. | |
1357 | */ | |
1358 | char *path; | |
573285e5 CP |
1359 | }; |
1360 | ||
c4ec9677 DT |
1361 | #define GET_SHA1_QUIETLY 01 |
1362 | #define GET_SHA1_COMMIT 02 | |
1363 | #define GET_SHA1_COMMITTISH 04 | |
1364 | #define GET_SHA1_TREE 010 | |
1365 | #define GET_SHA1_TREEISH 020 | |
1366 | #define GET_SHA1_BLOB 040 | |
1367 | #define GET_SHA1_FOLLOW_SYMLINKS 0100 | |
dc944b65 | 1368 | #define GET_SHA1_RECORD_PATH 0200 |
c4ec9677 | 1369 | #define GET_SHA1_ONLY_TO_DIE 04000 |
37c00e55 | 1370 | |
259942f5 JK |
1371 | #define GET_SHA1_DISAMBIGUATORS \ |
1372 | (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \ | |
1373 | GET_SHA1_TREE | GET_SHA1_TREEISH | \ | |
1374 | GET_SHA1_BLOB) | |
1375 | ||
3c249c95 | 1376 | extern int get_sha1(const char *str, unsigned char *sha1); |
daba53ae | 1377 | extern int get_sha1_commit(const char *str, unsigned char *sha1); |
cd74e473 | 1378 | extern int get_sha1_committish(const char *str, unsigned char *sha1); |
daba53ae JH |
1379 | extern int get_sha1_tree(const char *str, unsigned char *sha1); |
1380 | extern int get_sha1_treeish(const char *str, unsigned char *sha1); | |
1381 | extern int get_sha1_blob(const char *str, unsigned char *sha1); | |
8c135ea2 | 1382 | extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix); |
c0a487ea | 1383 | extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *oc); |
d4e85a1a | 1384 | |
2764fd93 | 1385 | extern int get_oid(const char *str, struct object_id *oid); |
1386 | ||
1b7ba794 | 1387 | typedef int each_abbrev_fn(const struct object_id *oid, void *); |
957d7406 | 1388 | extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *); |
d4e85a1a | 1389 | |
5b33cb1f JK |
1390 | extern int set_disambiguate_hint_config(const char *var, const char *value); |
1391 | ||
d4e85a1a MH |
1392 | /* |
1393 | * Try to read a SHA1 in hexadecimal format from the 40 characters | |
1394 | * starting at hex. Write the 20-byte result to sha1 in binary form. | |
1395 | * Return 0 on success. Reading stops if a NUL is encountered in the | |
1396 | * input, so it is safe to pass this function an arbitrary | |
1397 | * null-terminated string. | |
1398 | */ | |
197ee8c9 | 1399 | extern int get_sha1_hex(const char *hex, unsigned char *sha1); |
aa1c6fdf | 1400 | extern int get_oid_hex(const char *hex, struct object_id *sha1); |
d4e85a1a | 1401 | |
af49c6d0 JK |
1402 | /* |
1403 | * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant, | |
1404 | * and writes the NUL-terminated output to the buffer `out`, which must be at | |
1405 | * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for | |
1406 | * convenience. | |
1407 | * | |
1408 | * The non-`_r` variant returns a static buffer, but uses a ring of 4 | |
1409 | * buffers, making it safe to make multiple calls for a single statement, like: | |
1410 | * | |
1411 | * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two)); | |
1412 | */ | |
1413 | extern char *sha1_to_hex_r(char *out, const unsigned char *sha1); | |
55c529a7 | 1414 | extern char *oid_to_hex_r(char *out, const struct object_id *oid); |
197ee8c9 | 1415 | extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */ |
aa1c6fdf | 1416 | extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */ |
7cb36842 | 1417 | |
605f430e | 1418 | /* |
1419 | * Parse a 40-character hexadecimal object ID starting from hex, updating the | |
1420 | * pointer specified by end when parsing stops. The resulting object ID is | |
1421 | * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or | |
1422 | * other invalid character. end is only updated on success; otherwise, it is | |
1423 | * unmodified. | |
1424 | */ | |
1425 | extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end); | |
1426 | ||
e322b60d JK |
1427 | /* |
1428 | * This reads short-hand syntax that not only evaluates to a commit | |
1429 | * object name, but also can act as if the end user spelled the name | |
1430 | * of the branch from the command line. | |
1431 | * | |
1432 | * - "@{-N}" finds the name of the Nth previous branch we were on, and | |
1433 | * places the name of the branch in the given buf and returns the | |
1434 | * number of characters parsed if successful. | |
1435 | * | |
1436 | * - "<branch>@{upstream}" finds the name of the other ref that | |
1437 | * <branch> is configured to merge with (missing <branch> defaults | |
1438 | * to the current branch), and places the name of the branch in the | |
1439 | * given buf and returns the number of characters parsed if | |
1440 | * successful. | |
1441 | * | |
1442 | * If the input is not of the accepted format, it returns a negative | |
1443 | * number to signal an error. | |
1444 | * | |
1445 | * If the input was ok but there are not N branch switches in the | |
1446 | * reflog, it returns 0. | |
0e9f62da JK |
1447 | * |
1448 | * If "allowed" is non-zero, it is a treated as a bitfield of allowable | |
1449 | * expansions: local branches ("refs/heads/"), remote branches | |
1450 | * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is | |
1451 | * allowed, even ones to refs outside of those namespaces. | |
e322b60d | 1452 | */ |
0e9f62da JK |
1453 | #define INTERPRET_BRANCH_LOCAL (1<<0) |
1454 | #define INTERPRET_BRANCH_REMOTE (1<<1) | |
1455 | #define INTERPRET_BRANCH_HEAD (1<<2) | |
1456 | extern int interpret_branch_name(const char *str, int len, struct strbuf *, | |
1457 | unsigned allowed); | |
151b2911 | 1458 | extern int get_oid_mb(const char *str, struct object_id *oid); |
e86eb666 | 1459 | |
c847f537 | 1460 | extern int validate_headref(const char *ref); |
e83c5163 | 1461 | |
958ba6c9 | 1462 | extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2); |
0ab9e1e8 | 1463 | extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2); |
ccdd4a0f | 1464 | extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2); |
b60e188c | 1465 | extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2); |
e83c5163 | 1466 | |
40469ee9 | 1467 | extern void *read_object_with_reference(const unsigned char *sha1, |
bf0f910d | 1468 | const char *required_type, |
40469ee9 JH |
1469 | unsigned long *size, |
1470 | unsigned char *sha1_ret); | |
f4913f91 | 1471 | |
81776315 JH |
1472 | extern struct object *peel_to_type(const char *name, int namelen, |
1473 | struct object *o, enum object_type); | |
1474 | ||
a5481a6c JK |
1475 | struct date_mode { |
1476 | enum date_mode_type { | |
1477 | DATE_NORMAL = 0, | |
1478 | DATE_RELATIVE, | |
1479 | DATE_SHORT, | |
a5481a6c JK |
1480 | DATE_ISO8601, |
1481 | DATE_ISO8601_STRICT, | |
1482 | DATE_RFC2822, | |
aa1462cc | 1483 | DATE_STRFTIME, |
642833db JK |
1484 | DATE_RAW, |
1485 | DATE_UNIX | |
a5481a6c | 1486 | } type; |
aa1462cc | 1487 | const char *strftime_fmt; |
add00ba2 | 1488 | int local; |
73013afd JH |
1489 | }; |
1490 | ||
a5481a6c JK |
1491 | /* |
1492 | * Convenience helper for passing a constant type, like: | |
1493 | * | |
1494 | * show_date(t, tz, DATE_MODE(NORMAL)); | |
1495 | */ | |
1496 | #define DATE_MODE(t) date_mode_from_type(DATE_##t) | |
1497 | struct date_mode *date_mode_from_type(enum date_mode_type type); | |
1498 | ||
dddbad72 JS |
1499 | const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode); |
1500 | void show_date_relative(timestamp_t time, int tz, const struct timeval *now, | |
7d29afd4 | 1501 | struct strbuf *timebuf); |
c33ddc2e | 1502 | int parse_date(const char *date, struct strbuf *out); |
dddbad72 JS |
1503 | int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset); |
1504 | int parse_expiry_date(const char *date, timestamp_t *timestamp); | |
c33ddc2e | 1505 | void datestamp(struct strbuf *out); |
93cfa7c7 | 1506 | #define approxidate(s) approxidate_careful((s), NULL) |
dddbad72 JS |
1507 | timestamp_t approxidate_careful(const char *, int *); |
1508 | timestamp_t approxidate_relative(const char *date, const struct timeval *now); | |
a5481a6c | 1509 | void parse_date_format(const char *format, struct date_mode *mode); |
dddbad72 | 1510 | int date_overflows(timestamp_t date); |
ecee9d9e | 1511 | |
f9bc573f | 1512 | #define IDENT_STRICT 1 |
b9f0ac17 | 1513 | #define IDENT_NO_DATE 2 |
c15e1987 | 1514 | #define IDENT_NO_NAME 4 |
749be728 JH |
1515 | extern const char *git_author_info(int); |
1516 | extern const char *git_committer_info(int); | |
798123af | 1517 | extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int); |
d9ccfe77 | 1518 | extern const char *fmt_name(const char *name, const char *email); |
9830534e | 1519 | extern const char *ident_default_name(void); |
bcb2b004 | 1520 | extern const char *ident_default_email(void); |
44fcb497 | 1521 | extern const char *git_editor(void); |
64778d24 | 1522 | extern const char *git_pager(int stdout_is_tty); |
9597921b | 1523 | extern int git_ident_config(const char *, const char *, void *); |
4d9c7e6f | 1524 | extern void reset_ident_date(void); |
6aa33f40 | 1525 | |
4b340cfa JH |
1526 | struct ident_split { |
1527 | const char *name_begin; | |
1528 | const char *name_end; | |
1529 | const char *mail_begin; | |
1530 | const char *mail_end; | |
1531 | const char *date_begin; | |
1532 | const char *date_end; | |
1533 | const char *tz_begin; | |
1534 | const char *tz_end; | |
1535 | }; | |
1536 | /* | |
1537 | * Signals an success with 0, but time part of the result may be NULL | |
1538 | * if the input lacks timestamp and zone | |
1539 | */ | |
1540 | extern int split_ident_line(struct ident_split *, const char *, int); | |
1541 | ||
d1053246 JK |
1542 | /* |
1543 | * Like show_date, but pull the timestamp and tz parameters from | |
1544 | * the ident_split. It will also sanity-check the values and produce | |
1545 | * a well-known sentinel date if they appear bogus. | |
1546 | */ | |
a5481a6c JK |
1547 | const char *show_ident_date(const struct ident_split *id, |
1548 | const struct date_mode *mode); | |
d1053246 | 1549 | |
662cc30c JK |
1550 | /* |
1551 | * Compare split idents for equality or strict ordering. Note that we | |
1552 | * compare only the ident part of the line, ignoring any timestamp. | |
1553 | * | |
1554 | * Because there are two fields, we must choose one as the primary key; we | |
1555 | * currently arbitrarily pick the email. | |
1556 | */ | |
1557 | extern int ident_cmp(const struct ident_split *, const struct ident_split *); | |
1558 | ||
12dccc16 | 1559 | struct checkout { |
d4a2024a | 1560 | struct index_state *istate; |
12dccc16 LT |
1561 | const char *base_dir; |
1562 | int base_dir_len; | |
1563 | unsigned force:1, | |
1564 | quiet:1, | |
1565 | not_new:1, | |
1566 | refresh_cache:1; | |
1567 | }; | |
68e3d629 | 1568 | #define CHECKOUT_INIT { NULL, "" } |
12dccc16 | 1569 | |
af2a651d | 1570 | #define TEMPORARY_FILENAME_LENGTH 25 |
efbc5831 | 1571 | extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath); |
b9fd2846 LT |
1572 | |
1573 | struct cache_def { | |
e7c73053 | 1574 | struct strbuf path; |
b9fd2846 LT |
1575 | int flags; |
1576 | int track_flags; | |
1577 | int prefix_len_stat_func; | |
1578 | }; | |
e7c73053 | 1579 | #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 } |
2a608391 | 1580 | static inline void cache_def_clear(struct cache_def *cache) |
e7c73053 KB |
1581 | { |
1582 | strbuf_release(&cache->path); | |
1583 | } | |
b9fd2846 | 1584 | |
57199892 | 1585 | extern int has_symlink_leading_path(const char *name, int len); |
b9fd2846 | 1586 | extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int); |
f66caaf9 | 1587 | extern int check_leading_path(const char *name, int len); |
57199892 | 1588 | extern int has_dirs_only_path(const char *name, int len, int prefix_len); |
78478927 KB |
1589 | extern void schedule_dir_for_removal(const char *name, int len); |
1590 | extern void remove_scheduled_dirs(void); | |
12dccc16 | 1591 | |
9a217f2a | 1592 | extern struct alternate_object_database { |
d5a63b99 | 1593 | struct alternate_object_database *next; |
597f9134 | 1594 | |
38dbe5f0 JK |
1595 | /* see alt_scratch_buf() */ |
1596 | struct strbuf scratch; | |
1597 | size_t base_len; | |
597f9134 JK |
1598 | |
1599 | char path[FLEX_ARRAY]; | |
d5a63b99 | 1600 | } *alt_odb_list; |
9a217f2a | 1601 | extern void prepare_alt_odb(void); |
5e73633d | 1602 | extern void read_info_alternates(const char * relative_base, int depth); |
9eeea7d2 | 1603 | extern char *compute_alternate_path(const char *path, struct strbuf *err); |
d79796bc | 1604 | typedef int alt_odb_fn(struct alternate_object_database *, void *); |
fe1b2268 | 1605 | extern int foreach_alt_odb(alt_odb_fn, void*); |
9a217f2a | 1606 | |
7f0fa2c0 JK |
1607 | /* |
1608 | * Allocate a "struct alternate_object_database" but do _not_ actually | |
1609 | * add it to the list of alternates. | |
1610 | */ | |
1611 | struct alternate_object_database *alloc_alt_odb(const char *dir); | |
1612 | ||
a5b34d21 JK |
1613 | /* |
1614 | * Add the directory to the on-disk alternates file; the new entry will also | |
1615 | * take effect in the current process. | |
1616 | */ | |
1617 | extern void add_to_alternates_file(const char *dir); | |
1618 | ||
1619 | /* | |
1620 | * Add the directory to the in-memory list of alternates (along with any | |
1621 | * recursive alternates it points to), but do not modify the on-disk alternates | |
1622 | * file. | |
1623 | */ | |
1624 | extern void add_to_alternates_memory(const char *dir); | |
1625 | ||
38dbe5f0 JK |
1626 | /* |
1627 | * Returns a scratch strbuf pre-filled with the alternate object directory, | |
1628 | * including a trailing slash, which can be used to access paths in the | |
1629 | * alternate. Always use this over direct access to alt->scratch, as it | |
1630 | * cleans up any previous use of the scratch buffer. | |
1631 | */ | |
1632 | extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt); | |
1633 | ||
c41ee586 SP |
1634 | struct pack_window { |
1635 | struct pack_window *next; | |
1636 | unsigned char *base; | |
1637 | off_t offset; | |
1638 | size_t len; | |
1639 | unsigned int last_used; | |
1640 | unsigned int inuse_cnt; | |
1641 | }; | |
1642 | ||
9a217f2a JH |
1643 | extern struct packed_git { |
1644 | struct packed_git *next; | |
c41ee586 | 1645 | struct pack_window *windows; |
2dc3a234 | 1646 | off_t pack_size; |
57059091 NP |
1647 | const void *index_data; |
1648 | size_t index_size; | |
1649 | uint32_t num_objects; | |
8eca0b47 NP |
1650 | uint32_t num_bad_objects; |
1651 | unsigned char *bad_object_sha1; | |
42873078 | 1652 | int index_version; |
57059091 | 1653 | time_t mtime; |
9bc879c1 | 1654 | int pack_fd; |
8d25931d | 1655 | unsigned pack_local:1, |
d131b7af | 1656 | pack_keep:1, |
ee1c6c34 | 1657 | freshened:1, |
d131b7af | 1658 | do_not_close:1; |
bf592c50 | 1659 | unsigned char sha1[20]; |
9d98bbf5 | 1660 | struct revindex_entry *revindex; |
8f1d2e6f JH |
1661 | /* something like ".git/objects/pack/xxxxx.pack" */ |
1662 | char pack_name[FLEX_ARRAY]; /* more */ | |
9a217f2a | 1663 | } *packed_git; |
f3bf9224 | 1664 | |
a73cdd21 JK |
1665 | /* |
1666 | * A most-recently-used ordered version of the packed_git list, which can | |
1667 | * be iterated instead of packed_git (and marked via mru_mark). | |
1668 | */ | |
1669 | struct mru; | |
1670 | extern struct mru *packed_git_mru; | |
1671 | ||
f3bf9224 | 1672 | struct pack_entry { |
c4001d92 | 1673 | off_t offset; |
f3bf9224 JH |
1674 | unsigned char sha1[20]; |
1675 | struct packed_git *p; | |
1676 | }; | |
1677 | ||
7b64469a | 1678 | extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path); |
bf592c50 | 1679 | |
0a489b06 JH |
1680 | /* A hook to report invalid files in pack directory */ |
1681 | #define PACKDIR_FILE_PACK 1 | |
1682 | #define PACKDIR_FILE_IDX 2 | |
1683 | #define PACKDIR_FILE_GARBAGE 4 | |
1684 | extern void (*report_garbage)(unsigned seen_bits, const char *path); | |
543c5caa | 1685 | |
9a217f2a | 1686 | extern void prepare_packed_git(void); |
fc04c412 | 1687 | extern void reprepare_packed_git(void); |
bf592c50 DB |
1688 | extern void install_packed_git(struct packed_git *pack); |
1689 | ||
8e3f52d7 JK |
1690 | /* |
1691 | * Give a rough count of objects in the repository. This sacrifices accuracy | |
1692 | * for speed. | |
1693 | */ | |
1694 | unsigned long approximate_object_count(void); | |
1695 | ||
a6080a0a | 1696 | extern struct packed_git *find_sha1_pack(const unsigned char *sha1, |
bf592c50 DB |
1697 | struct packed_git *packs); |
1698 | ||
276bc2ca | 1699 | extern void pack_report(void); |
d40d535b | 1700 | |
82c9d661 | 1701 | /* |
892e723a JK |
1702 | * Create a temporary file rooted in the object database directory, or |
1703 | * die on failure. The filename is taken from "pattern", which should have the | |
1704 | * usual "XXXXXX" trailer, and the resulting filename is written into the | |
1705 | * "template" buffer. Returns the open descriptor. | |
82c9d661 | 1706 | */ |
594fa999 | 1707 | extern int odb_mkstemp(struct strbuf *template, const char *pattern); |
82c9d661 | 1708 | |
1cec8c63 JK |
1709 | /* |
1710 | * Generate the filename to be used for a pack file with checksum "sha1" and | |
1711 | * extension "ext". The result is written into the strbuf "buf", overwriting | |
1712 | * any existing contents. A pointer to buf->buf is returned as a convenience. | |
1713 | * | |
1714 | * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx" | |
1715 | */ | |
1716 | extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext); | |
1717 | ||
82c9d661 | 1718 | /* |
eaeefc32 JK |
1719 | * Create a pack .keep file named "name" (which should generally be the output |
1720 | * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on | |
1721 | * error. | |
82c9d661 | 1722 | */ |
eaeefc32 | 1723 | extern int odb_pack_keep(const char *name); |
82c9d661 | 1724 | |
d40d535b MH |
1725 | /* |
1726 | * mmap the index file for the specified packfile (if it is not | |
1727 | * already mmapped). Return 0 on success. | |
1728 | */ | |
d079837e | 1729 | extern int open_pack_index(struct packed_git *); |
d40d535b MH |
1730 | |
1731 | /* | |
1732 | * munmap the index file for the specified packfile (if it is | |
1733 | * currently mmapped). | |
1734 | */ | |
fa5fc15d | 1735 | extern void close_pack_index(struct packed_git *); |
d40d535b | 1736 | |
ef49a7a0 | 1737 | extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *); |
c9ced051 | 1738 | extern void close_pack_windows(struct packed_git *); |
38849a81 | 1739 | extern void close_all_packs(void); |
03e79c88 | 1740 | extern void unuse_pack(struct pack_window **); |
3d20c636 | 1741 | extern void clear_delta_base_cache(void); |
48bcc1c3 | 1742 | extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local); |
d40d535b | 1743 | |
47fe3f6e JK |
1744 | /* |
1745 | * Make sure that a pointer access into an mmap'd index file is within bounds, | |
1746 | * and can provide at least 8 bytes of data. | |
1747 | * | |
1748 | * Note that this is only necessary for variable-length segments of the file | |
1749 | * (like the 64-bit extended offset table), as we compare the size to the | |
1750 | * fixed-length parts when we open the file. | |
1751 | */ | |
1752 | extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr); | |
1753 | ||
d40d535b MH |
1754 | /* |
1755 | * Return the SHA-1 of the nth object within the specified packfile. | |
1756 | * Open the index if it is not already open. The return value points | |
1757 | * at the SHA-1 within the mmapped index. Return NULL if there is an | |
1758 | * error. | |
1759 | */ | |
1760 | extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n); | |
068f85e3 | 1761 | /* |
1762 | * Like nth_packed_object_sha1, but write the data into the object specified by | |
1763 | * the the first argument. Returns the first argument on success, and NULL on | |
1764 | * error. | |
1765 | */ | |
1766 | extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n); | |
d40d535b MH |
1767 | |
1768 | /* | |
1769 | * Return the offset of the nth object within the specified packfile. | |
1770 | * The index must already be opened. | |
1771 | */ | |
1772 | extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n); | |
1773 | ||
1774 | /* | |
1775 | * If the object named sha1 is present in the specified packfile, | |
1776 | * return its offset within the packfile; otherwise, return 0. | |
1777 | */ | |
1778 | extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *); | |
1779 | ||
4c080182 | 1780 | extern int is_pack_valid(struct packed_git *); |
c4001d92 | 1781 | extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *); |
09ded04b | 1782 | extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep); |
54dab52a | 1783 | extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t); |
f8c8abc5 | 1784 | extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *); |
9a217f2a | 1785 | |
27e1e22d JK |
1786 | /* |
1787 | * Iterate over the files in the loose-object parts of the object | |
1788 | * directory "path", triggering the following callbacks: | |
1789 | * | |
1790 | * - loose_object is called for each loose object we find. | |
1791 | * | |
1792 | * - loose_cruft is called for any files that do not appear to be | |
1793 | * loose objects. Note that we only look in the loose object | |
1794 | * directories "objects/[0-9a-f]{2}/", so we will not report | |
1795 | * "objects/foobar" as cruft. | |
1796 | * | |
1797 | * - loose_subdir is called for each top-level hashed subdirectory | |
1798 | * of the object directory (e.g., "$OBJDIR/f0"). It is called | |
1799 | * after the objects in the directory are processed. | |
1800 | * | |
1801 | * Any callback that is NULL will be ignored. Callbacks returning non-zero | |
1802 | * will end the iteration. | |
e6f875e0 JK |
1803 | * |
1804 | * In the "buf" variant, "path" is a strbuf which will also be used as a | |
1805 | * scratch buffer, but restored to its original contents before | |
1806 | * the function returns. | |
27e1e22d | 1807 | */ |
76c1d9a0 | 1808 | typedef int each_loose_object_fn(const struct object_id *oid, |
27e1e22d JK |
1809 | const char *path, |
1810 | void *data); | |
1811 | typedef int each_loose_cruft_fn(const char *basename, | |
1812 | const char *path, | |
1813 | void *data); | |
1814 | typedef int each_loose_subdir_fn(int nr, | |
1815 | const char *path, | |
1816 | void *data); | |
1817 | int for_each_loose_file_in_objdir(const char *path, | |
1818 | each_loose_object_fn obj_cb, | |
1819 | each_loose_cruft_fn cruft_cb, | |
1820 | each_loose_subdir_fn subdir_cb, | |
1821 | void *data); | |
e6f875e0 JK |
1822 | int for_each_loose_file_in_objdir_buf(struct strbuf *path, |
1823 | each_loose_object_fn obj_cb, | |
1824 | each_loose_cruft_fn cruft_cb, | |
1825 | each_loose_subdir_fn subdir_cb, | |
1826 | void *data); | |
27e1e22d | 1827 | |
660c889e JK |
1828 | /* |
1829 | * Iterate over loose and packed objects in both the local | |
1385bb7b JK |
1830 | * repository and any alternates repositories (unless the |
1831 | * LOCAL_ONLY flag is set). | |
660c889e | 1832 | */ |
1385bb7b | 1833 | #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1 |
76c1d9a0 | 1834 | typedef int each_packed_object_fn(const struct object_id *oid, |
660c889e JK |
1835 | struct packed_git *pack, |
1836 | uint32_t pos, | |
1837 | void *data); | |
1385bb7b JK |
1838 | extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags); |
1839 | extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags); | |
660c889e | 1840 | |
9a490590 JH |
1841 | struct object_info { |
1842 | /* Request */ | |
5b086407 | 1843 | enum object_type *typep; |
9a490590 | 1844 | unsigned long *sizep; |
166df26f | 1845 | off_t *disk_sizep; |
5d642e75 | 1846 | unsigned char *delta_base_sha1; |
46f03448 | 1847 | struct strbuf *typename; |
9a490590 JH |
1848 | |
1849 | /* Response */ | |
1850 | enum { | |
1851 | OI_CACHED, | |
1852 | OI_LOOSE, | |
5266d369 JH |
1853 | OI_PACKED, |
1854 | OI_DBCACHED | |
9a490590 JH |
1855 | } whence; |
1856 | union { | |
1857 | /* | |
1858 | * struct { | |
1859 | * ... Nothing to expose in this case | |
1860 | * } cached; | |
1861 | * struct { | |
1862 | * ... Nothing to expose in this case | |
1863 | * } loose; | |
1864 | */ | |
1865 | struct { | |
1866 | struct packed_git *pack; | |
1867 | off_t offset; | |
1868 | unsigned int is_delta; | |
1869 | } packed; | |
1870 | } u; | |
1871 | }; | |
27b5c1a0 JK |
1872 | |
1873 | /* | |
1874 | * Initializer for a "struct object_info" that wants no items. You may | |
1875 | * also memset() the memory to all-zeroes. | |
1876 | */ | |
1877 | #define OBJECT_INFO_INIT {NULL} | |
1878 | ||
de7b5d62 | 1879 | extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags); |
ca79c985 | 1880 | extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *); |
9a217f2a | 1881 | |
8f3f9b09 JH |
1882 | /* Dumb servers support */ |
1883 | extern int update_server_info(int); | |
1884 | ||
a6fa5992 PN |
1885 | extern const char *get_log_output_encoding(void); |
1886 | extern const char *get_commit_output_encoding(void); | |
1887 | ||
dae6c322 CC |
1888 | /* |
1889 | * This is a hack for test programs like test-dump-untracked-cache to | |
1890 | * ensure that they do not modify the untracked cache when reading it. | |
1891 | * Do not use it otherwise! | |
1892 | */ | |
1893 | extern int ignore_untracked_cache_config; | |
3c8687a7 | 1894 | |
d6991cee JK |
1895 | extern int committer_ident_sufficiently_given(void); |
1896 | extern int author_ident_sufficiently_given(void); | |
e1b10391 | 1897 | |
1a8f2741 | 1898 | extern const char *git_commit_encoding; |
3a55602e | 1899 | extern const char *git_log_output_encoding; |
d551a488 | 1900 | extern const char *git_mailmap_file; |
08610900 | 1901 | extern const char *git_mailmap_blob; |
4e72dcec | 1902 | |
06f59e9f TT |
1903 | /* IO helper functions */ |
1904 | extern void maybe_flush_or_die(FILE *, const char *); | |
9540ce50 JK |
1905 | __attribute__((format (printf, 2, 3))) |
1906 | extern void fprintf_or_die(FILE *, const char *fmt, ...); | |
00b7cbfc JH |
1907 | |
1908 | #define COPY_READ_ERROR (-2) | |
1909 | #define COPY_WRITE_ERROR (-3) | |
f3123c4a | 1910 | extern int copy_fd(int ifd, int ofd); |
1468bd47 | 1911 | extern int copy_file(const char *dst, const char *src, int mode); |
f7835a25 | 1912 | extern int copy_file_with_time(const char *dst, const char *src, int mode); |
00b7cbfc | 1913 | |
7230e6d0 | 1914 | extern void write_or_die(int fd, const void *buf, size_t count); |
4c81b03e | 1915 | extern void fsync_or_die(int fd, const char *); |
ad897215 | 1916 | |
2b7ca830 JM |
1917 | extern ssize_t read_in_full(int fd, void *buf, size_t count); |
1918 | extern ssize_t write_in_full(int fd, const void *buf, size_t count); | |
426ddeea YM |
1919 | extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset); |
1920 | ||
2b7ca830 JM |
1921 | static inline ssize_t write_str_in_full(int fd, const char *str) |
1922 | { | |
1923 | return write_in_full(fd, str, strlen(str)); | |
1924 | } | |
12d6ce1d | 1925 | |
52563d7e JK |
1926 | /** |
1927 | * Open (and truncate) the file at path, write the contents of buf to it, | |
1928 | * and close it. Dies if any errors are encountered. | |
1929 | */ | |
1930 | extern void write_file_buf(const char *path, const char *buf, size_t len); | |
1931 | ||
e04d08a4 JK |
1932 | /** |
1933 | * Like write_file_buf(), but format the contents into a buffer first. | |
1934 | * Additionally, write_file() will append a newline if one is not already | |
1935 | * present, making it convenient to write text files: | |
1936 | * | |
1937 | * write_file(path, "counter: %d", ctr); | |
1938 | */ | |
1939 | __attribute__((format (printf, 2, 3))) | |
ef22318c | 1940 | extern void write_file(const char *path, const char *fmt, ...); |
2b7ca830 | 1941 | |
f67b45f8 LT |
1942 | /* pager.c */ |
1943 | extern void setup_pager(void); | |
6e9af863 | 1944 | extern int pager_in_use(void); |
aa086eb8 | 1945 | extern int pager_use_color; |
ad6c3739 | 1946 | extern int term_columns(void); |
d306f3d3 | 1947 | extern int decimal_width(uintmax_t); |
4914c962 | 1948 | extern int check_pager_config(const char *cmd); |
3e3a4a41 | 1949 | extern void prepare_pager_args(struct child_process *, const char *pager); |
f67b45f8 | 1950 | |
ee9601e6 | 1951 | extern const char *editor_program; |
d3e7da89 | 1952 | extern const char *askpass_program; |
dfb068be | 1953 | extern const char *excludes_file; |
4d87b9c5 | 1954 | |
051308f6 | 1955 | /* base85 */ |
f9815772 JM |
1956 | int decode_85(char *dst, const char *line, int linelen); |
1957 | void encode_85(char *buf, const unsigned char *data, int bytes); | |
051308f6 | 1958 | |
855419f7 | 1959 | /* alloc.c */ |
100c5f3b LT |
1960 | extern void *alloc_blob_node(void); |
1961 | extern void *alloc_tree_node(void); | |
1962 | extern void *alloc_commit_node(void); | |
1963 | extern void *alloc_tag_node(void); | |
1964 | extern void *alloc_object_node(void); | |
855419f7 | 1965 | extern void alloc_report(void); |
94d5a22c | 1966 | extern unsigned int alloc_commit_index(void); |
855419f7 | 1967 | |
5991a55c | 1968 | /* pkt-line.c */ |
bbc30f99 | 1969 | void packet_trace_identity(const char *prog); |
6ce4e61f | 1970 | |
b6ec1d61 | 1971 | /* add */ |
7ae02a30 AR |
1972 | /* |
1973 | * return 0 if success, 1 - if addition of a file failed and | |
1974 | * ADD_FILES_IGNORE_ERRORS was specified in flags | |
1975 | */ | |
610d55af | 1976 | int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags); |
b6ec1d61 | 1977 | |
aecbf914 JH |
1978 | /* diff.c */ |
1979 | extern int diff_auto_refresh_index; | |
1980 | ||
68faf689 | 1981 | /* match-trees.c */ |
82db3d44 | 1982 | void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int); |
1983 | void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *); | |
68faf689 | 1984 | |
a9cc857a JH |
1985 | /* |
1986 | * whitespace rules. | |
1987 | * used by both diff and apply | |
f4b05a49 | 1988 | * last two digits are tab width |
a9cc857a | 1989 | */ |
f4b05a49 JS |
1990 | #define WS_BLANK_AT_EOL 0100 |
1991 | #define WS_SPACE_BEFORE_TAB 0200 | |
1992 | #define WS_INDENT_WITH_NON_TAB 0400 | |
1993 | #define WS_CR_AT_EOL 01000 | |
1994 | #define WS_BLANK_AT_EOF 02000 | |
1995 | #define WS_TAB_IN_INDENT 04000 | |
aeb84b05 | 1996 | #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF) |
f4b05a49 JS |
1997 | #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8) |
1998 | #define WS_TAB_WIDTH_MASK 077 | |
cf1b7869 JH |
1999 | extern unsigned whitespace_rule_cfg; |
2000 | extern unsigned whitespace_rule(const char *); | |
2001 | extern unsigned parse_whitespace_rule(const char *); | |
8f8841e9 JH |
2002 | extern unsigned ws_check(const char *line, int len, unsigned ws_rule); |
2003 | extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws); | |
c1795bb0 | 2004 | extern char *whitespace_error_string(unsigned ws); |
d511bd33 | 2005 | extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *); |
877f23cc | 2006 | extern int ws_blank_line(const char *line, int len, unsigned ws_rule); |
f4b05a49 | 2007 | #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK) |
a9cc857a | 2008 | |
ee425e46 | 2009 | /* ls-files */ |
312c984a BW |
2010 | void overlay_tree_on_index(struct index_state *istate, |
2011 | const char *tree_name, const char *prefix); | |
ee425e46 | 2012 | |
94351118 | 2013 | char *alias_lookup(const char *alias); |
0989fe96 | 2014 | int split_cmdline(char *cmdline, const char ***argv); |
ad9ac6db GB |
2015 | /* Takes a negative value returned by split_cmdline */ |
2016 | const char *split_cmdline_strerror(int cmdline_errno); | |
94351118 | 2017 | |
46c3cd44 | 2018 | /* setup.c */ |
e37c1329 | 2019 | struct startup_info { |
a60645f9 | 2020 | int have_repository; |
f07d6a1a | 2021 | const char *prefix; |
e37c1329 NTND |
2022 | }; |
2023 | extern struct startup_info *startup_info; | |
2024 | ||
db699a8a NTND |
2025 | /* merge.c */ |
2026 | struct commit_list; | |
2027 | int try_merge_command(const char *strategy, size_t xopts_nr, | |
2028 | const char **xopts, struct commit_list *common, | |
2029 | const char *head_arg, struct commit_list *remotes); | |
f06e90da | 2030 | int checkout_fast_forward(const struct object_id *from, |
2031 | const struct object_id *to, | |
db699a8a NTND |
2032 | int overwrite_ignore); |
2033 | ||
cac42b26 | 2034 | |
38f865c2 JK |
2035 | int sane_execvp(const char *file, char *const argv[]); |
2036 | ||
38612532 MH |
2037 | /* |
2038 | * A struct to encapsulate the concept of whether a file has changed | |
2039 | * since we last checked it. This uses criteria similar to those used | |
2040 | * for the index. | |
2041 | */ | |
2042 | struct stat_validity { | |
2043 | struct stat_data *sd; | |
2044 | }; | |
2045 | ||
2046 | void stat_validity_clear(struct stat_validity *sv); | |
2047 | ||
2048 | /* | |
2049 | * Returns 1 if the path is a regular file (or a symlink to a regular | |
2050 | * file) and matches the saved stat_validity, 0 otherwise. A missing | |
2051 | * or inaccessible file is considered a match if the struct was just | |
2052 | * initialized, or if the previous update found an inaccessible file. | |
2053 | */ | |
2054 | int stat_validity_check(struct stat_validity *sv, const char *path); | |
2055 | ||
2056 | /* | |
2057 | * Update the stat_validity from a file opened at descriptor fd. If | |
2058 | * the file is missing, inaccessible, or not a regular file, then | |
2059 | * future calls to stat_validity_check will match iff one of those | |
2060 | * conditions continues to be true. | |
2061 | */ | |
2062 | void stat_validity_update(struct stat_validity *sv, int fd); | |
2063 | ||
9ef176b5 | 2064 | int versioncmp(const char *s1, const char *s2); |
2024d317 | 2065 | void sleep_millisec(int millisec); |
9ef176b5 | 2066 | |
eb33876c DT |
2067 | /* |
2068 | * Create a directory and (if share is nonzero) adjust its permissions | |
2069 | * according to the shared_repository setting. Only use this for | |
2070 | * directories under $GIT_DIR. Don't use it for working tree | |
2071 | * directories. | |
2072 | */ | |
2073 | void safe_create_dir(const char *dir, int share); | |
2074 | ||
e83c5163 | 2075 | #endif /* CACHE_H */ |