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