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