]>
Commit | Line | Data |
---|---|---|
e83c5163 LT |
1 | #ifndef CACHE_H |
2 | #define CACHE_H | |
3 | ||
4050c0df | 4 | #include "git-compat-util.h" |
5ecd293d | 5 | #include "strbuf.h" |
e05881a4 | 6 | #include "hashmap.h" |
75194438 | 7 | #include "advice.h" |
65784830 | 8 | #include "gettext.h" |
d1bf0e08 | 9 | #include "convert.h" |
5991a55c | 10 | #include "trace.h" |
155ef25f | 11 | #include "string-list.h" |
e83c5163 | 12 | |
cef661fc | 13 | #include SHA1_HEADER |
9126f009 NP |
14 | #ifndef git_SHA_CTX |
15 | #define git_SHA_CTX SHA_CTX | |
16 | #define git_SHA1_Init SHA1_Init | |
17 | #define git_SHA1_Update SHA1_Update | |
18 | #define git_SHA1_Final SHA1_Final | |
19 | #endif | |
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 | |
68 | * | |
69 | * NOTE! We *really* shouldn't depend on the S_IFxxx macros | |
70 | * always having the same values everywhere. We should use | |
71 | * our internal git values for these things, and then we can | |
72 | * translate that to the OS-specific value. It just so | |
73 | * happens that everybody shares the same bit representation | |
74 | * in the UNIX world (and apparently wider too..) | |
75 | */ | |
302b9282 MW |
76 | #define S_IFGITLINK 0160000 |
77 | #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) | |
9eec4795 | 78 | |
72441af7 KS |
79 | /* |
80 | * Some mode bits are also used internally for computations. | |
81 | * | |
82 | * They *must* not overlap with any valid modes, and they *must* not be emitted | |
83 | * to outside world - i.e. appear on disk or network. In other words, it's just | |
84 | * temporary fields, which we internally use, but they have to stay in-house. | |
85 | * | |
86 | * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git | |
87 | * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) | |
88 | */ | |
89 | ||
90 | /* used internally in tree-diff */ | |
91 | #define S_DIFFTREE_IFXMIN_NEQ 0x80000000 | |
92 | ||
93 | ||
2386d658 LT |
94 | /* |
95 | * Intensive research over the course of many years has shown that | |
96 | * port 9418 is totally unused by anything else. Or | |
97 | * | |
98 | * Your search - "port 9418" - did not match any documents. | |
99 | * | |
100 | * as www.google.com puts it. | |
ba8a4970 LT |
101 | * |
102 | * This port has been properly assigned for git use by IANA: | |
103 | * git (Assigned-9418) [I06-050728-0001]. | |
104 | * | |
105 | * git 9418/tcp git pack transfer service | |
106 | * git 9418/udp git pack transfer service | |
107 | * | |
108 | * with Linus Torvalds <torvalds@osdl.org> as the point of | |
109 | * contact. September 2005. | |
110 | * | |
111 | * See http://www.iana.org/assignments/port-numbers | |
2386d658 LT |
112 | */ |
113 | #define DEFAULT_GIT_PORT 9418 | |
114 | ||
e83c5163 LT |
115 | /* |
116 | * Basic data structures for the directory cache | |
e83c5163 LT |
117 | */ |
118 | ||
119 | #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ | |
120 | struct cache_header { | |
7800c1eb TG |
121 | uint32_t hdr_signature; |
122 | uint32_t hdr_version; | |
123 | uint32_t hdr_entries; | |
e83c5163 LT |
124 | }; |
125 | ||
9d227781 JH |
126 | #define INDEX_FORMAT_LB 2 |
127 | #define INDEX_FORMAT_UB 4 | |
128 | ||
e83c5163 LT |
129 | /* |
130 | * The "cache_time" is just the low 32 bits of the | |
131 | * time. It doesn't matter if it overflows - we only | |
132 | * check it for equality in the 32 bits we save. | |
133 | */ | |
134 | struct cache_time { | |
7800c1eb TG |
135 | uint32_t sec; |
136 | uint32_t nsec; | |
e83c5163 LT |
137 | }; |
138 | ||
c21d39d7 MH |
139 | struct stat_data { |
140 | struct cache_time sd_ctime; | |
141 | struct cache_time sd_mtime; | |
142 | unsigned int sd_dev; | |
143 | unsigned int sd_ino; | |
144 | unsigned int sd_uid; | |
145 | unsigned int sd_gid; | |
146 | unsigned int sd_size; | |
147 | }; | |
148 | ||
e83c5163 | 149 | struct cache_entry { |
8b013788 | 150 | struct hashmap_entry ent; |
c21d39d7 | 151 | struct stat_data ce_stat_data; |
ccc4feb5 | 152 | unsigned int ce_mode; |
7a51ed66 | 153 | unsigned int ce_flags; |
b60e188c | 154 | unsigned int ce_namelen; |
5fc2fc8f | 155 | unsigned int index; /* for link extension */ |
e83c5163 | 156 | unsigned char sha1[20]; |
8f1d2e6f | 157 | char name[FLEX_ARRAY]; /* more */ |
e83c5163 LT |
158 | }; |
159 | ||
95fd5bf8 | 160 | #define CE_STAGEMASK (0x3000) |
16ce2e4c | 161 | #define CE_EXTENDED (0x4000) |
5f73076c | 162 | #define CE_VALID (0x8000) |
aee46198 | 163 | #define CE_STAGESHIFT 12 |
95fd5bf8 | 164 | |
06aaaa0b | 165 | /* |
ce51bf09 | 166 | * Range 0xFFFF0FFF in ce_flags is divided into |
06aaaa0b NTND |
167 | * two parts: in-memory flags and on-disk ones. |
168 | * Flags in CE_EXTENDED_FLAGS will get saved on-disk | |
169 | * if you want to save a new flag, add it in | |
170 | * CE_EXTENDED_FLAGS | |
171 | * | |
172 | * In-memory only flags | |
173 | */ | |
2977ffbb NTND |
174 | #define CE_UPDATE (1 << 16) |
175 | #define CE_REMOVE (1 << 17) | |
176 | #define CE_UPTODATE (1 << 18) | |
177 | #define CE_ADDED (1 << 19) | |
a22c6371 | 178 | |
2977ffbb | 179 | #define CE_HASHED (1 << 20) |
2977ffbb NTND |
180 | #define CE_WT_REMOVE (1 << 22) /* remove in work directory */ |
181 | #define CE_CONFLICTED (1 << 23) | |
7a51ed66 | 182 | |
2977ffbb | 183 | #define CE_UNPACKED (1 << 24) |
2431afbf | 184 | #define CE_NEW_SKIP_WORKTREE (1 << 25) |
da165f47 | 185 | |
e721c154 NTND |
186 | /* used to temporarily mark paths matched by pathspecs */ |
187 | #define CE_MATCHED (1 << 26) | |
188 | ||
078a58e8 | 189 | #define CE_UPDATE_IN_BASE (1 << 27) |
b3c96fb1 | 190 | #define CE_STRIP_NAME (1 << 28) |
078a58e8 | 191 | |
06aaaa0b NTND |
192 | /* |
193 | * Extended on-disk flags | |
194 | */ | |
2977ffbb NTND |
195 | #define CE_INTENT_TO_ADD (1 << 29) |
196 | #define CE_SKIP_WORKTREE (1 << 30) | |
06aaaa0b | 197 | /* CE_EXTENDED2 is for future extension */ |
2977ffbb | 198 | #define CE_EXTENDED2 (1 << 31) |
06aaaa0b | 199 | |
44a36913 | 200 | #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) |
06aaaa0b NTND |
201 | |
202 | /* | |
203 | * Safeguard to avoid saving wrong flags: | |
204 | * - CE_EXTENDED2 won't get saved until its semantic is known | |
205 | * - Bits in 0x0000FFFF have been saved in ce_flags already | |
206 | * - Bits in 0x003F0000 are currently in-memory flags | |
207 | */ | |
208 | #if CE_EXTENDED_FLAGS & 0x803FFFFF | |
209 | #error "CE_EXTENDED_FLAGS out of range" | |
210 | #endif | |
211 | ||
64acde94 NTND |
212 | struct pathspec; |
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; |
eb7a2f1d LT |
222 | |
223 | /* Don't copy hash chain and name */ | |
8b013788 KB |
224 | memcpy(&dst->ce_stat_data, &src->ce_stat_data, |
225 | offsetof(struct cache_entry, name) - | |
226 | offsetof(struct cache_entry, ce_stat_data)); | |
eb7a2f1d LT |
227 | |
228 | /* Restore the hash state */ | |
419a597f | 229 | dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; |
eb7a2f1d LT |
230 | } |
231 | ||
b60e188c | 232 | static inline unsigned create_ce_flags(unsigned stage) |
7fec10b7 | 233 | { |
b60e188c | 234 | return (stage << CE_STAGESHIFT); |
7fec10b7 JH |
235 | } |
236 | ||
b60e188c | 237 | #define ce_namelen(ce) ((ce)->ce_namelen) |
aee46198 | 238 | #define ce_size(ce) cache_entry_size(ce_namelen(ce)) |
7a51ed66 | 239 | #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) |
eadb5831 | 240 | #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) |
44a36913 | 241 | #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) |
eadb5831 | 242 | #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) |
aee46198 | 243 | |
e4479470 | 244 | #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) |
8ae0a8c5 KS |
245 | static inline unsigned int create_ce_mode(unsigned int mode) |
246 | { | |
8ae0a8c5 | 247 | if (S_ISLNK(mode)) |
7a51ed66 | 248 | return S_IFLNK; |
302b9282 | 249 | if (S_ISDIR(mode) || S_ISGITLINK(mode)) |
7a51ed66 LT |
250 | return S_IFGITLINK; |
251 | return S_IFREG | ce_permissions(mode); | |
8ae0a8c5 | 252 | } |
20d142b4 RS |
253 | static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, |
254 | unsigned int mode) | |
185c975f | 255 | { |
78a8d641 JS |
256 | extern int trust_executable_bit, has_symlinks; |
257 | if (!has_symlinks && S_ISREG(mode) && | |
7a51ed66 | 258 | ce && S_ISLNK(ce->ce_mode)) |
78a8d641 | 259 | return ce->ce_mode; |
185c975f | 260 | if (!trust_executable_bit && S_ISREG(mode)) { |
7a51ed66 | 261 | if (ce && S_ISREG(ce->ce_mode)) |
185c975f JH |
262 | return ce->ce_mode; |
263 | return create_ce_mode(0666); | |
264 | } | |
265 | return create_ce_mode(mode); | |
266 | } | |
d6b8fc30 JH |
267 | static inline int ce_to_dtype(const struct cache_entry *ce) |
268 | { | |
269 | unsigned ce_mode = ntohl(ce->ce_mode); | |
270 | if (S_ISREG(ce_mode)) | |
271 | return DT_REG; | |
272 | else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) | |
273 | return DT_DIR; | |
274 | else if (S_ISLNK(ce_mode)) | |
275 | return DT_LNK; | |
276 | else | |
277 | return DT_UNKNOWN; | |
278 | } | |
b90d9b88 RS |
279 | static inline unsigned int canon_mode(unsigned int mode) |
280 | { | |
281 | if (S_ISREG(mode)) | |
282 | return S_IFREG | ce_permissions(mode); | |
283 | if (S_ISLNK(mode)) | |
284 | return S_IFLNK; | |
285 | if (S_ISDIR(mode)) | |
286 | return S_IFDIR; | |
287 | return S_IFGITLINK; | |
288 | } | |
e4479470 | 289 | |
ee7825b5 | 290 | #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) |
f5cabd13 | 291 | |
e636a7b4 NTND |
292 | #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ |
293 | #define CE_ENTRY_CHANGED (1 << 1) | |
294 | #define CE_ENTRY_REMOVED (1 << 2) | |
295 | #define CE_ENTRY_ADDED (1 << 3) | |
6c306a34 | 296 | #define RESOLVE_UNDO_CHANGED (1 << 4) |
a5400efe | 297 | #define CACHE_TREE_CHANGED (1 << 5) |
c18b80a0 | 298 | #define SPLIT_INDEX_ORDERED (1 << 6) |
e636a7b4 | 299 | |
5fc2fc8f | 300 | struct split_index; |
228e94f9 JH |
301 | struct index_state { |
302 | struct cache_entry **cache; | |
9d227781 | 303 | unsigned int version; |
228e94f9 | 304 | unsigned int cache_nr, cache_alloc, cache_changed; |
cfc5789a | 305 | struct string_list *resolve_undo; |
228e94f9 | 306 | struct cache_tree *cache_tree; |
5fc2fc8f | 307 | struct split_index *split_index; |
fba2f38a | 308 | struct cache_time timestamp; |
913e0e99 JH |
309 | unsigned name_hash_initialized : 1, |
310 | initialized : 1; | |
8b013788 | 311 | struct hashmap name_hash; |
e05881a4 | 312 | struct hashmap dir_hash; |
426ddeea | 313 | unsigned char sha1[20]; |
228e94f9 JH |
314 | }; |
315 | ||
316 | extern struct index_state the_index; | |
317 | ||
96872bc2 LT |
318 | /* Name hashing */ |
319 | extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); | |
2092678c KB |
320 | extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); |
321 | extern void free_name_hash(struct index_state *istate); | |
96872bc2 LT |
322 | |
323 | ||
4aab5b46 | 324 | #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS |
228e94f9 JH |
325 | #define active_cache (the_index.cache) |
326 | #define active_nr (the_index.cache_nr) | |
327 | #define active_alloc (the_index.cache_alloc) | |
328 | #define active_cache_changed (the_index.cache_changed) | |
329 | #define active_cache_tree (the_index.cache_tree) | |
e83c5163 | 330 | |
4aab5b46 JH |
331 | #define read_cache() read_index(&the_index) |
332 | #define read_cache_from(path) read_index_from(&the_index, (path)) | |
671c9b7e | 333 | #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) |
fa7b3c2f | 334 | #define is_cache_unborn() is_index_unborn(&the_index) |
e46bbcf6 | 335 | #define read_cache_unmerged() read_index_unmerged(&the_index) |
4aab5b46 | 336 | #define discard_cache() discard_index(&the_index) |
94a5728c | 337 | #define unmerged_cache() unmerged_index(&the_index) |
4aab5b46 JH |
338 | #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) |
339 | #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) | |
81dc2307 | 340 | #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) |
4aab5b46 JH |
341 | #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) |
342 | #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) | |
38ed1d89 JH |
343 | #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) |
344 | #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) | |
3deffc52 | 345 | #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) |
4bd5b7da JH |
346 | #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) |
347 | #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) | |
db5360f3 ES |
348 | #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) |
349 | #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) | |
98fa4738 | 350 | #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) |
cfc5789a | 351 | #define resolve_undo_clear() resolve_undo_clear_index(&the_index) |
8aa38563 | 352 | #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) |
4421a823 | 353 | #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) |
ff366825 | 354 | #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) |
4aab5b46 | 355 | #endif |
e83c5163 | 356 | |
edaec3fb JH |
357 | enum object_type { |
358 | OBJ_BAD = -1, | |
359 | OBJ_NONE = 0, | |
360 | OBJ_COMMIT = 1, | |
361 | OBJ_TREE = 2, | |
362 | OBJ_BLOB = 3, | |
363 | OBJ_TAG = 4, | |
364 | /* 5 for future expansion */ | |
365 | OBJ_OFS_DELTA = 6, | |
366 | OBJ_REF_DELTA = 7, | |
355885d5 | 367 | OBJ_ANY, |
4b05548f | 368 | OBJ_MAX |
edaec3fb JH |
369 | }; |
370 | ||
b45563a2 JH |
371 | static inline enum object_type object_type(unsigned int mode) |
372 | { | |
373 | return S_ISDIR(mode) ? OBJ_TREE : | |
374 | S_ISGITLINK(mode) ? OBJ_COMMIT : | |
375 | OBJ_BLOB; | |
376 | } | |
377 | ||
2163e5db | 378 | /* Double-check local_repo_env below if you add to this list. */ |
8ac069ac | 379 | #define GIT_DIR_ENVIRONMENT "GIT_DIR" |
a1bea2c1 | 380 | #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" |
892c41b9 | 381 | #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" |
a6f7f9a3 | 382 | #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" |
8ac069ac | 383 | #define DEFAULT_GIT_DIR_ENVIRONMENT ".git" |
d19938ab | 384 | #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" |
bb233d69 | 385 | #define INDEX_ENVIRONMENT "GIT_INDEX_FILE" |
5da5c8f4 | 386 | #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" |
069c0532 | 387 | #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" |
d4ebc36c JH |
388 | #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" |
389 | #define CONFIG_ENVIRONMENT "GIT_CONFIG" | |
2b64fc89 | 390 | #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" |
d4ebc36c | 391 | #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" |
0454dd93 | 392 | #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" |
6476b38b | 393 | #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" |
d0bfd026 JH |
394 | #define GITATTRIBUTES_FILE ".gitattributes" |
395 | #define INFOATTRIBUTES_FILE "info/attributes" | |
f48fd688 | 396 | #define ATTRIBUTE_MACRO_PREFIX "[attr]" |
a97a7468 JS |
397 | #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" |
398 | #define GIT_NOTES_DEFAULT_REF "refs/notes/commits" | |
894a9d33 | 399 | #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" |
6956f858 TR |
400 | #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" |
401 | #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" | |
823ab40f | 402 | #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" |
bd30c2e4 NTND |
403 | #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" |
404 | #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" | |
93d93537 | 405 | #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" |
bb233d69 | 406 | |
48a7c1c4 | 407 | /* |
2cd83d10 JK |
408 | * This environment variable is expected to contain a boolean indicating |
409 | * whether we should or should not treat: | |
410 | * | |
411 | * GIT_DIR=foo.git git ... | |
412 | * | |
413 | * as if GIT_WORK_TREE=. was given. It's not expected that users will make use | |
414 | * of this, but we use it internally to communicate to sub-processes that we | |
415 | * are in a bare repo. If not set, defaults to true. | |
416 | */ | |
417 | #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" | |
418 | ||
48a7c1c4 | 419 | /* |
2163e5db JK |
420 | * Repository-local GIT_* environment variables; these will be cleared |
421 | * when git spawns a sub-process that runs inside another repository. | |
422 | * The array is NULL-terminated, which makes it easy to pass in the "env" | |
423 | * parameter of a run-command invocation, or to do a simple walk. | |
48a7c1c4 | 424 | */ |
2163e5db | 425 | extern const char * const local_repo_env[]; |
48a7c1c4 | 426 | |
7d1864ce JH |
427 | extern int is_bare_repository_cfg; |
428 | extern int is_bare_repository(void); | |
68025633 | 429 | extern int is_inside_git_dir(void); |
e90fdc39 | 430 | extern char *git_work_tree_cfg; |
892c41b9 | 431 | extern int is_inside_work_tree(void); |
c5fba16c | 432 | extern const char *get_git_dir(void); |
b3256eb8 | 433 | extern int is_git_directory(const char *path); |
8ac069ac JH |
434 | extern char *get_object_directory(void); |
435 | extern char *get_index_file(void); | |
5da5c8f4 | 436 | extern char *get_graft_file(void); |
d7ac12b2 | 437 | extern int set_git_dir(const char *path); |
a1bea2c1 JT |
438 | extern const char *get_git_namespace(void); |
439 | extern const char *strip_namespace(const char *namespaced_ref); | |
e90fdc39 | 440 | extern const char *get_git_work_tree(void); |
13d6ec91 | 441 | extern const char *read_gitfile(const char *path); |
abc06822 | 442 | extern const char *resolve_gitdir(const char *suspect); |
19757d80 | 443 | extern void set_git_work_tree(const char *tree); |
8ac069ac JH |
444 | |
445 | #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" | |
bb233d69 | 446 | |
6b5ee137 | 447 | extern const char **get_pathspec(const char *prefix, const char **pathspec); |
59f0f2f3 | 448 | extern void setup_work_tree(void); |
4ca06608 | 449 | extern const char *setup_git_directory_gently(int *); |
d288a700 | 450 | extern const char *setup_git_directory(void); |
edc54fb5 | 451 | extern char *prefix_path(const char *prefix, int len, const char *path); |
645a29c4 | 452 | extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); |
4ca06608 | 453 | extern const char *prefix_filename(const char *prefix, int len, const char *path); |
c6e8c800 | 454 | extern int check_filename(const char *prefix, const char *name); |
023e37c3 MM |
455 | extern void verify_filename(const char *prefix, |
456 | const char *name, | |
457 | int diagnose_misspelt_rev); | |
ea92f41f | 458 | extern void verify_non_filename(const char *prefix, const char *name); |
546e0fd9 | 459 | extern int path_inside_repo(const char *prefix, const char *path); |
d288a700 | 460 | |
f225aeb2 DB |
461 | #define INIT_DB_QUIET 0x0001 |
462 | ||
b57fb80a | 463 | extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int); |
f225aeb2 DB |
464 | extern int init_db(const char *template_dir, unsigned int flags); |
465 | ||
1d999ddd | 466 | extern void sanitize_stdfds(void); |
de0957ce | 467 | extern int daemonize(void); |
1d999ddd | 468 | |
e83c5163 LT |
469 | #define alloc_nr(x) (((x)+16)*3/2) |
470 | ||
6815e569 JK |
471 | /* |
472 | * Realloc the buffer pointed at by variable 'x' so that it can hold | |
473 | * at least 'nr' entries; the number of entries currently allocated | |
474 | * is 'alloc', using the standard growing factor alloc_nr() macro. | |
475 | * | |
01f6fd4b | 476 | * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. |
6815e569 JK |
477 | */ |
478 | #define ALLOC_GROW(x, nr, alloc) \ | |
479 | do { \ | |
c927e6c6 | 480 | if ((nr) > alloc) { \ |
4234a761 JH |
481 | if (alloc_nr(alloc) < (nr)) \ |
482 | alloc = (nr); \ | |
483 | else \ | |
484 | alloc = alloc_nr(alloc); \ | |
2756ca43 | 485 | REALLOC_ARRAY(x, alloc); \ |
6815e569 | 486 | } \ |
98746061 | 487 | } while (0) |
6815e569 | 488 | |
734aab75 | 489 | /* Initialize and use the cache information */ |
03b86647 | 490 | struct lock_file; |
4aab5b46 | 491 | extern int read_index(struct index_state *); |
5ab2a2da | 492 | extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); |
3e52f70b NTND |
493 | extern int do_read_index(struct index_state *istate, const char *path, |
494 | int must_exist); /* for testting only! */ | |
4aab5b46 | 495 | extern int read_index_from(struct index_state *, const char *path); |
fa7b3c2f | 496 | extern int is_index_unborn(struct index_state *); |
e46bbcf6 | 497 | extern int read_index_unmerged(struct index_state *); |
03b86647 NTND |
498 | #define COMMIT_LOCK (1 << 0) |
499 | #define CLOSE_LOCK (1 << 1) | |
500 | extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); | |
4aab5b46 | 501 | extern int discard_index(struct index_state *); |
d1f128b0 | 502 | extern int unmerged_index(const struct index_state *); |
8dcf39c4 | 503 | extern int verify_path(const char *path); |
db5360f3 ES |
504 | extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen); |
505 | extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); | |
d1f128b0 | 506 | extern int index_name_pos(const struct index_state *, const char *name, int namelen); |
192268c1 JH |
507 | #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ |
508 | #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ | |
b155725d | 509 | #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ |
af3785dc | 510 | #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ |
39425819 | 511 | #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ |
ce7c614b | 512 | #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ |
4aab5b46 | 513 | extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); |
81dc2307 | 514 | extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); |
4aab5b46 | 515 | extern int remove_index_entry_at(struct index_state *, int pos); |
36419c8e | 516 | extern void remove_marked_cache_entries(struct index_state *istate); |
4aab5b46 | 517 | extern int remove_file_from_index(struct index_state *, const char *path); |
38ed1d89 JH |
518 | #define ADD_CACHE_VERBOSE 1 |
519 | #define ADD_CACHE_PRETEND 2 | |
01665924 | 520 | #define ADD_CACHE_IGNORE_ERRORS 4 |
041aee31 | 521 | #define ADD_CACHE_IGNORE_REMOVAL 8 |
39425819 | 522 | #define ADD_CACHE_INTENT 16 |
38ed1d89 JH |
523 | extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); |
524 | extern int add_file_to_index(struct index_state *, const char *path, int flags); | |
25762726 | 525 | extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); |
9c5e6c80 | 526 | extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); |
b4b313f9 | 527 | extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); |
98fa4738 | 528 | extern int index_name_is_other(const struct index_state *, const char *, int); |
ff366825 | 529 | extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *); |
4bd5b7da JH |
530 | |
531 | /* do stat comparison even if CE_VALID is true */ | |
532 | #define CE_MATCH_IGNORE_VALID 01 | |
533 | /* do not check the contents but report dirty on racily-clean entries */ | |
56cac48c NTND |
534 | #define CE_MATCH_RACY_IS_DIRTY 02 |
535 | /* do stat comparison even if CE_SKIP_WORKTREE is true */ | |
536 | #define CE_MATCH_IGNORE_SKIP_WORKTREE 04 | |
2e2e7ec1 BK |
537 | /* ignore non-existent files during stat update */ |
538 | #define CE_MATCH_IGNORE_MISSING 0x08 | |
25762726 BK |
539 | /* enable stat refresh */ |
540 | #define CE_MATCH_REFRESH 0x10 | |
21a6b9fa RS |
541 | extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); |
542 | extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); | |
4bd5b7da | 543 | |
c4ce46fc JH |
544 | #define HASH_WRITE_OBJECT 1 |
545 | #define HASH_FORMAT_CHECK 2 | |
546 | extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); | |
547 | extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); | |
c21d39d7 MH |
548 | |
549 | /* | |
550 | * Record to sd the data from st that we use to check whether a file | |
551 | * might have changed. | |
552 | */ | |
553 | extern void fill_stat_data(struct stat_data *sd, struct stat *st); | |
554 | ||
555 | /* | |
556 | * Return 0 if st is consistent with a file not having been changed | |
557 | * since sd was filled. If there are differences, return a | |
558 | * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, | |
559 | * INODE_CHANGED, and DATA_CHANGED. | |
560 | */ | |
561 | extern int match_stat_data(const struct stat_data *sd, struct stat *st); | |
562 | ||
415e96c8 JH |
563 | extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); |
564 | ||
405e5b2f LT |
565 | #define REFRESH_REALLY 0x0001 /* ignore_valid */ |
566 | #define REFRESH_UNMERGED 0x0002 /* allow unmerged */ | |
567 | #define REFRESH_QUIET 0x0004 /* be quiet about it */ | |
568 | #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ | |
3f1b7b60 | 569 | #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ |
43673fdd | 570 | #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ |
9b2d6149 | 571 | extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); |
405e5b2f | 572 | |
ccdc4ec3 | 573 | extern void update_index_if_able(struct index_state *, struct lock_file *); |
30ca07a2 JH |
574 | |
575 | extern int hold_locked_index(struct lock_file *, int); | |
5e7f56ac | 576 | extern void set_alternate_index_output(const char *); |
697cc8ef | 577 | |
eca35a25 | 578 | extern int delete_ref(const char *, const unsigned char *sha1, int delopt); |
734aab75 | 579 | |
2ae1c53b | 580 | /* Environment bits from configuration mechanism */ |
17712991 | 581 | extern int trust_executable_bit; |
1ce4790b | 582 | extern int trust_ctime; |
c08e4d5b | 583 | extern int check_stat; |
9378c161 | 584 | extern int quote_path_fully; |
78a8d641 | 585 | extern int has_symlinks; |
dce96489 | 586 | extern int minimum_abbrev, default_abbrev; |
0a9b88b7 | 587 | extern int ignore_case; |
5f73076c | 588 | extern int assume_unchanged; |
9f0bb90d | 589 | extern int prefer_symlink_refs; |
6de08ae6 | 590 | extern int log_all_ref_updates; |
2f8acdb3 | 591 | extern int warn_ambiguous_refs; |
25fba78d | 592 | extern int warn_on_object_refname_ambiguity; |
457f06d6 | 593 | extern int shared_repository; |
2ae1c53b | 594 | extern const char *apply_default_whitespace; |
86c91f91 | 595 | extern const char *apply_default_ignorewhitespace; |
64589a03 | 596 | extern const char *git_attributes_file; |
12f6c308 | 597 | extern int zlib_compression_level; |
960ccca6 DH |
598 | extern int core_compression_level; |
599 | extern int core_compression_seen; | |
60bb8b14 | 600 | extern size_t packed_git_window_size; |
77ccc5bb | 601 | extern size_t packed_git_limit; |
18bdec11 | 602 | extern size_t delta_base_cache_limit; |
15366280 | 603 | extern unsigned long big_file_threshold; |
568508e7 | 604 | extern unsigned long pack_size_limit_cfg; |
afc711b8 MH |
605 | |
606 | /* | |
607 | * Do replace refs need to be checked this run? This variable is | |
608 | * initialized to true unless --no-replace-object is used or | |
609 | * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some | |
610 | * commands that do not want replace references to be active. As an | |
611 | * optimization it is also set to false if replace references have | |
612 | * been sought but there were none. | |
613 | */ | |
614 | extern int check_replace_refs; | |
615 | ||
aafe9fba | 616 | extern int fsync_object_files; |
671c9b7e | 617 | extern int core_preload_index; |
08aefc9e | 618 | extern int core_apply_sparse_checkout; |
76759c7d | 619 | extern int precomposed_unicode; |
557bd833 | 620 | extern int git_db_env, git_index_env, git_graft_env; |
17712991 | 621 | |
eff80a9f JH |
622 | /* |
623 | * The character that begins a commented line in user-editable file | |
624 | * that is subject to stripspace. | |
625 | */ | |
626 | extern char comment_line_char; | |
84c9dc2c | 627 | extern int auto_comment_line_char; |
eff80a9f | 628 | |
9ed36cfa | 629 | enum branch_track { |
9188ed89 | 630 | BRANCH_TRACK_UNSPECIFIED = -1, |
9ed36cfa JS |
631 | BRANCH_TRACK_NEVER = 0, |
632 | BRANCH_TRACK_REMOTE, | |
633 | BRANCH_TRACK_ALWAYS, | |
634 | BRANCH_TRACK_EXPLICIT, | |
4b05548f | 635 | BRANCH_TRACK_OVERRIDE |
9ed36cfa JS |
636 | }; |
637 | ||
c998ae9b DS |
638 | enum rebase_setup_type { |
639 | AUTOREBASE_NEVER = 0, | |
640 | AUTOREBASE_LOCAL, | |
641 | AUTOREBASE_REMOTE, | |
4b05548f | 642 | AUTOREBASE_ALWAYS |
c998ae9b DS |
643 | }; |
644 | ||
52153747 | 645 | enum push_default_type { |
52153747 FAG |
646 | PUSH_DEFAULT_NOTHING = 0, |
647 | PUSH_DEFAULT_MATCHING, | |
b55e6775 | 648 | PUSH_DEFAULT_SIMPLE, |
53c40311 | 649 | PUSH_DEFAULT_UPSTREAM, |
f25950f3 CT |
650 | PUSH_DEFAULT_CURRENT, |
651 | PUSH_DEFAULT_UNSPECIFIED | |
52153747 FAG |
652 | }; |
653 | ||
9ed36cfa | 654 | extern enum branch_track git_branch_track; |
c998ae9b | 655 | extern enum rebase_setup_type autorebase; |
52153747 | 656 | extern enum push_default_type push_default; |
9ed36cfa | 657 | |
348df166 JS |
658 | enum object_creation_mode { |
659 | OBJECT_CREATION_USES_HARDLINKS = 0, | |
4b05548f | 660 | OBJECT_CREATION_USES_RENAMES = 1 |
348df166 JS |
661 | }; |
662 | ||
663 | extern enum object_creation_mode object_creation_mode; | |
be66a6c4 | 664 | |
a97a7468 JS |
665 | extern char *notes_ref_name; |
666 | ||
7f3140cd JS |
667 | extern int grafts_replace_parents; |
668 | ||
ab9cb76f JH |
669 | #define GIT_REPO_VERSION 0 |
670 | extern int repository_format_version; | |
671 | extern int check_repository_format(void); | |
672 | ||
734aab75 LT |
673 | #define MTIME_CHANGED 0x0001 |
674 | #define CTIME_CHANGED 0x0002 | |
675 | #define OWNER_CHANGED 0x0004 | |
676 | #define MODE_CHANGED 0x0008 | |
677 | #define INODE_CHANGED 0x0010 | |
678 | #define DATA_CHANGED 0x0020 | |
8ae0a8c5 | 679 | #define TYPE_CHANGED 0x0040 |
e83c5163 | 680 | |
108bebea AR |
681 | extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) |
682 | __attribute__((format (printf, 3, 4))); | |
1a83c240 NTND |
683 | extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...) |
684 | __attribute__((format (printf, 2, 3))); | |
aba13e7c AR |
685 | extern char *git_pathdup(const char *fmt, ...) |
686 | __attribute__((format (printf, 1, 2))); | |
21cf3227 HKNN |
687 | extern char *mkpathdup(const char *fmt, ...) |
688 | __attribute__((format (printf, 1, 2))); | |
108bebea | 689 | |
e83c5163 | 690 | /* Return a statically allocated filename matching the sha1 signature */ |
dcf69262 NTND |
691 | extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); |
692 | extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); | |
693 | extern const char *git_path_submodule(const char *path, const char *fmt, ...) | |
0bad611b HV |
694 | __attribute__((format (printf, 2, 3))); |
695 | ||
d40d535b MH |
696 | /* |
697 | * Return the name of the file in the local object database that would | |
698 | * be used to store a loose object with the specified sha1. The | |
699 | * return value is a pointer to a statically allocated buffer that is | |
700 | * overwritten each time the function is called. | |
701 | */ | |
30d6c6ea | 702 | extern const char *sha1_file_name(const unsigned char *sha1); |
d40d535b MH |
703 | |
704 | /* | |
705 | * Return the name of the (local) packfile with the specified sha1 in | |
706 | * its name. The return value is a pointer to memory that is | |
707 | * overwritten each time this function is called. | |
708 | */ | |
bf592c50 | 709 | extern char *sha1_pack_name(const unsigned char *sha1); |
d40d535b MH |
710 | |
711 | /* | |
712 | * Return the name of the (local) pack index file with the specified | |
713 | * sha1 in its name. The return value is a pointer to memory that is | |
714 | * overwritten each time this function is called. | |
715 | */ | |
bf592c50 | 716 | extern char *sha1_pack_index_name(const unsigned char *sha1); |
d40d535b | 717 | |
013f276e | 718 | extern const char *find_unique_abbrev(const unsigned char *sha1, int); |
88cd621d | 719 | extern const unsigned char null_sha1[20]; |
1a812f3a IM |
720 | |
721 | static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) | |
0bef57ee | 722 | { |
1a812f3a IM |
723 | int i; |
724 | ||
725 | for (i = 0; i < 20; i++, sha1++, sha2++) { | |
726 | if (*sha1 != *sha2) | |
727 | return *sha1 - *sha2; | |
728 | } | |
729 | ||
730 | return 0; | |
0bef57ee | 731 | } |
1a812f3a IM |
732 | |
733 | static inline int is_null_sha1(const unsigned char *sha1) | |
a89fccd2 | 734 | { |
1a812f3a | 735 | return !hashcmp(sha1, null_sha1); |
a89fccd2 | 736 | } |
1a812f3a | 737 | |
e702496e SP |
738 | static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) |
739 | { | |
740 | memcpy(sha_dst, sha_src, 20); | |
741 | } | |
a8e0d16d JH |
742 | static inline void hashclr(unsigned char *hash) |
743 | { | |
744 | memset(hash, 0, 20); | |
745 | } | |
e83c5163 | 746 | |
14d9c578 JK |
747 | #define EMPTY_TREE_SHA1_HEX \ |
748 | "4b825dc642cb6eb9a060e54bf8d69288fbee4904" | |
dab0d410 | 749 | #define EMPTY_TREE_SHA1_BIN_LITERAL \ |
14d9c578 JK |
750 | "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ |
751 | "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" | |
dab0d410 JN |
752 | #define EMPTY_TREE_SHA1_BIN \ |
753 | ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL) | |
14d9c578 | 754 | |
f8582cad JK |
755 | #define EMPTY_BLOB_SHA1_HEX \ |
756 | "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" | |
757 | #define EMPTY_BLOB_SHA1_BIN_LITERAL \ | |
758 | "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ | |
759 | "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" | |
760 | #define EMPTY_BLOB_SHA1_BIN \ | |
761 | ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL) | |
762 | ||
763 | static inline int is_empty_blob_sha1(const unsigned char *sha1) | |
764 | { | |
765 | return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN); | |
766 | } | |
767 | ||
f2db68ed HE |
768 | int git_mkstemp(char *path, size_t n, const char *template); |
769 | ||
003b33a8 DA |
770 | int git_mkstemps(char *path, size_t n, const char *template, int suffix_len); |
771 | ||
b862b61c MM |
772 | /* set default permissions by passing mode arguments to open(2) */ |
773 | int git_mkstemps_mode(char *pattern, int suffix_len, int mode); | |
774 | int git_mkstemp_mode(char *pattern, int mode); | |
775 | ||
06cbe855 HO |
776 | /* |
777 | * NOTE NOTE NOTE!! | |
778 | * | |
779 | * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must | |
780 | * not be changed. Old repositories have core.sharedrepository written in | |
781 | * numeric format, and therefore these values are preserved for compatibility | |
782 | * reasons. | |
783 | */ | |
94df2506 | 784 | enum sharedrepo { |
06cbe855 HO |
785 | PERM_UMASK = 0, |
786 | OLD_PERM_GROUP = 1, | |
787 | OLD_PERM_EVERYBODY = 2, | |
788 | PERM_GROUP = 0660, | |
4b05548f | 789 | PERM_EVERYBODY = 0664 |
94df2506 JH |
790 | }; |
791 | int git_config_perm(const char *var, const char *value); | |
3a429d3b | 792 | int adjust_shared_perm(const char *path); |
0be0521b MH |
793 | |
794 | /* | |
795 | * Create the directory containing the named path, using care to be | |
796 | * somewhat safe against races. Return one of the scld_error values | |
797 | * to indicate success/failure. | |
18d37e86 MH |
798 | * |
799 | * SCLD_VANISHED indicates that one of the ancestor directories of the | |
800 | * path existed at one point during the function call and then | |
801 | * suddenly vanished, probably because another process pruned the | |
802 | * directory while we were working. To be robust against this kind of | |
803 | * race, callers might want to try invoking the function again when it | |
804 | * returns SCLD_VANISHED. | |
0be0521b MH |
805 | */ |
806 | enum scld_error { | |
807 | SCLD_OK = 0, | |
808 | SCLD_FAILED = -1, | |
809 | SCLD_PERMS = -2, | |
18d37e86 MH |
810 | SCLD_EXISTS = -3, |
811 | SCLD_VANISHED = -4 | |
0be0521b MH |
812 | }; |
813 | enum scld_error safe_create_leading_directories(char *path); | |
814 | enum scld_error safe_create_leading_directories_const(const char *path); | |
815 | ||
90a6464b | 816 | int mkdir_in_gitdir(const char *path); |
21cf3227 | 817 | extern void home_config_paths(char **global, char **xdg, char *file); |
395de250 | 818 | extern char *expand_user_path(const char *path); |
1c64b48e | 819 | const char *enter_repo(const char *path, int strict); |
e5392c51 JS |
820 | static inline int is_absolute_path(const char *path) |
821 | { | |
88135203 | 822 | return is_dir_sep(path[0]) || has_dos_drive_prefix(path); |
e5392c51 | 823 | } |
90b4a71c | 824 | int is_directory(const char *); |
e2a57aac | 825 | const char *real_path(const char *path); |
e3e46cdb | 826 | const char *real_path_if_valid(const char *path); |
e2a57aac | 827 | const char *absolute_path(const char *path); |
41894ae3 | 828 | const char *remove_leading_path(const char *in, const char *prefix); |
e02ca72f | 829 | const char *relative_path(const char *in, const char *prefix, struct strbuf *sb); |
645a29c4 | 830 | int normalize_path_copy_len(char *dst, const char *src, int *prefix_len); |
f3cad0ad | 831 | int normalize_path_copy(char *dst, const char *src); |
31171d9e | 832 | int longest_ancestor_length(const char *path, struct string_list *prefixes); |
4fcc86b0 | 833 | char *strip_path_suffix(const char *path, const char *suffix); |
34b6cb8b | 834 | int daemon_avoid_alias(const char *path); |
b2cb9425 | 835 | |
e1111cef | 836 | /* object replacement */ |
ffe68cf9 | 837 | #define LOOKUP_REPLACE_OBJECT 1 |
5bf29b95 | 838 | extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag); |
f5552aee CC |
839 | static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size) |
840 | { | |
ffe68cf9 | 841 | return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT); |
5bf29b95 | 842 | } |
1f91e79c MH |
843 | |
844 | /* | |
845 | * This internal function is only declared here for the benefit of | |
846 | * lookup_replace_object(). Please do not call it directly. | |
847 | */ | |
e1111cef | 848 | extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1); |
1f91e79c MH |
849 | |
850 | /* | |
851 | * If object sha1 should be replaced, return the replacement object's | |
852 | * name (replaced recursively, if necessary). The return value is | |
853 | * either sha1 or a pointer to a permanently-allocated value. When | |
854 | * object replacement is suppressed, always return sha1. | |
855 | */ | |
e1111cef JH |
856 | static inline const unsigned char *lookup_replace_object(const unsigned char *sha1) |
857 | { | |
afc711b8 | 858 | if (!check_replace_refs) |
e1111cef JH |
859 | return sha1; |
860 | return do_lookup_replace_object(sha1); | |
f5552aee | 861 | } |
1f91e79c | 862 | |
bf93eea0 CC |
863 | static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag) |
864 | { | |
865 | if (!(flag & LOOKUP_REPLACE_OBJECT)) | |
866 | return sha1; | |
867 | return lookup_replace_object(sha1); | |
868 | } | |
e1111cef | 869 | |
e83c5163 | 870 | /* Read and unpack a sha1 file into memory, write memory to a sha1 file */ |
21666f1a | 871 | extern int sha1_object_info(const unsigned char *, unsigned long *); |
ce9fbf16 | 872 | extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1); |
c00e657d | 873 | extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1); |
21666f1a | 874 | extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *); |
bbac7311 | 875 | extern int force_object_loose(const unsigned char *sha1, time_t mtime); |
ec73f580 | 876 | extern int git_open_noatime(const char *name); |
f0270efd | 877 | extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size); |
eb4f4076 | 878 | extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz); |
f0270efd | 879 | extern int parse_sha1_header(const char *hdr, unsigned long *sizep); |
8237b185 | 880 | |
0e8189e2 NP |
881 | /* global flag to enable extra checks when accessing packed objects */ |
882 | extern int do_check_packed_object_crc; | |
883 | ||
5d6ccf5c | 884 | extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type); |
e83c5163 | 885 | |
839837b9 | 886 | extern int move_temp_to_file(const char *tmpfile, const char *filename); |
8237b185 | 887 | |
cd673c1f | 888 | extern int has_sha1_pack(const unsigned char *sha1); |
d40d535b MH |
889 | |
890 | /* | |
891 | * Return true iff we have an object named sha1, whether local or in | |
892 | * an alternate object database, and whether packed or loose. This | |
893 | * function does not respect replace references. | |
894 | */ | |
8237b185 | 895 | extern int has_sha1_file(const unsigned char *sha1); |
d40d535b MH |
896 | |
897 | /* | |
898 | * Return true iff an alternate object database has a loose object | |
899 | * with the specified name. This function does not respect replace | |
900 | * references. | |
901 | */ | |
0f4dc14a | 902 | extern int has_loose_object_nonlocal(const unsigned char *sha1); |
8237b185 | 903 | |
bf592c50 DB |
904 | extern int has_pack_index(const unsigned char *sha1); |
905 | ||
40d52ff7 JK |
906 | extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect); |
907 | ||
192a6be2 LT |
908 | extern const signed char hexval_table[256]; |
909 | static inline unsigned int hexval(unsigned char c) | |
e49521b5 JH |
910 | { |
911 | return hexval_table[c]; | |
912 | } | |
913 | ||
e83c5163 | 914 | /* Convert to/from hex/sha1 representation */ |
dce96489 LT |
915 | #define MINIMUM_ABBREV minimum_abbrev |
916 | #define DEFAULT_ABBREV default_abbrev | |
46a6c262 | 917 | |
573285e5 CP |
918 | struct object_context { |
919 | unsigned char tree[20]; | |
920 | char path[PATH_MAX]; | |
921 | unsigned mode; | |
922 | }; | |
923 | ||
daba53ae JH |
924 | #define GET_SHA1_QUIETLY 01 |
925 | #define GET_SHA1_COMMIT 02 | |
926 | #define GET_SHA1_COMMITTISH 04 | |
927 | #define GET_SHA1_TREE 010 | |
928 | #define GET_SHA1_TREEISH 020 | |
929 | #define GET_SHA1_BLOB 040 | |
33bd598c | 930 | #define GET_SHA1_ONLY_TO_DIE 04000 |
37c00e55 | 931 | |
3c249c95 | 932 | extern int get_sha1(const char *str, unsigned char *sha1); |
daba53ae | 933 | extern int get_sha1_commit(const char *str, unsigned char *sha1); |
cd74e473 | 934 | extern int get_sha1_committish(const char *str, unsigned char *sha1); |
daba53ae JH |
935 | extern int get_sha1_tree(const char *str, unsigned char *sha1); |
936 | extern int get_sha1_treeish(const char *str, unsigned char *sha1); | |
937 | extern int get_sha1_blob(const char *str, unsigned char *sha1); | |
8c135ea2 | 938 | extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix); |
33bd598c | 939 | extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc); |
d4e85a1a | 940 | |
957d7406 JH |
941 | typedef int each_abbrev_fn(const unsigned char *sha1, void *); |
942 | extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *); | |
d4e85a1a MH |
943 | |
944 | /* | |
945 | * Try to read a SHA1 in hexadecimal format from the 40 characters | |
946 | * starting at hex. Write the 20-byte result to sha1 in binary form. | |
947 | * Return 0 on success. Reading stops if a NUL is encountered in the | |
948 | * input, so it is safe to pass this function an arbitrary | |
949 | * null-terminated string. | |
950 | */ | |
197ee8c9 | 951 | extern int get_sha1_hex(const char *hex, unsigned char *sha1); |
d4e85a1a | 952 | |
197ee8c9 | 953 | extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */ |
7695d118 RS |
954 | extern int read_ref_full(const char *refname, int resolve_flags, |
955 | unsigned char *sha1, int *flags); | |
dfefa935 | 956 | extern int read_ref(const char *refname, unsigned char *sha1); |
7cb36842 MH |
957 | |
958 | /* | |
959 | * Resolve a reference, recursively following symbolic refererences. | |
960 | * | |
961 | * Store the referred-to object's name in sha1 and return the name of | |
962 | * the non-symbolic reference that ultimately pointed at it. The | |
963 | * return value, if not NULL, is a pointer into either a static buffer | |
964 | * or the input ref. | |
965 | * | |
966 | * If the reference cannot be resolved to an object, the behavior | |
7695d118 | 967 | * depends on the RESOLVE_REF_READING flag: |
7cb36842 | 968 | * |
7695d118 | 969 | * - If RESOLVE_REF_READING is set, return NULL. |
7cb36842 | 970 | * |
7695d118 RS |
971 | * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of |
972 | * the last reference name in the chain, which will either be a non-symbolic | |
7cb36842 MH |
973 | * reference or an undefined reference. If this is a prelude to |
974 | * "writing" to the ref, the return value is the name of the ref | |
975 | * that will actually be created or changed. | |
976 | * | |
62a2d525 JN |
977 | * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one |
978 | * level of symbolic reference. The value stored in sha1 for a symbolic | |
979 | * reference will always be null_sha1 in this case, and the return | |
980 | * value is the reference that the symref refers to directly. | |
981 | * | |
7695d118 | 982 | * If flags is non-NULL, set the value that it points to the |
7cb36842 | 983 | * combination of REF_ISPACKED (if the reference was found among the |
7695d118 | 984 | * packed references), REF_ISSYMREF (if the initial reference was a |
d0f810f0 RS |
985 | * symbolic reference), REF_BAD_NAME (if the reference name is ill |
986 | * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN | |
987 | * (if the ref is malformed or has a bad name). See refs.h for more detail | |
988 | * on each flag. | |
7cb36842 MH |
989 | * |
990 | * If ref is not a properly-formatted, normalized reference, return | |
991 | * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, | |
992 | * give up and return NULL. | |
993 | * | |
d0f810f0 RS |
994 | * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their |
995 | * name is invalid according to git-check-ref-format(1). If the name | |
996 | * is bad then the value stored in sha1 will be null_sha1 and the two | |
997 | * flags REF_ISBROKEN and REF_BAD_NAME will be set. | |
998 | * | |
999 | * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/ | |
1000 | * directory and do not consist of all caps and underscores cannot be | |
1001 | * resolved. The function returns NULL for such ref names. | |
1002 | * Caps and underscores refers to the special refs, such as HEAD, | |
1003 | * FETCH_HEAD and friends, that all live outside of the refs/ directory. | |
7cb36842 | 1004 | */ |
7695d118 | 1005 | #define RESOLVE_REF_READING 0x01 |
62a2d525 | 1006 | #define RESOLVE_REF_NO_RECURSE 0x02 |
d0f810f0 | 1007 | #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 |
7695d118 RS |
1008 | extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags); |
1009 | extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags); | |
7cb36842 | 1010 | |
e86eb666 | 1011 | extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref); |
eb3a4822 | 1012 | extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref); |
cf99a761 | 1013 | extern int interpret_branch_name(const char *str, int len, struct strbuf *); |
619a644d | 1014 | extern int get_sha1_mb(const char *str, unsigned char *sha1); |
e86eb666 | 1015 | |
54457fe5 MH |
1016 | /* |
1017 | * Return true iff abbrev_name is a possible abbreviation for | |
1018 | * full_name according to the rules defined by ref_rev_parse_rules in | |
1019 | * refs.c. | |
1020 | */ | |
1021 | extern int refname_match(const char *abbrev_name, const char *full_name); | |
79803322 | 1022 | |
8b5157e4 | 1023 | extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg); |
c847f537 | 1024 | extern int validate_headref(const char *ref); |
e83c5163 | 1025 | |
958ba6c9 | 1026 | extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2); |
0ab9e1e8 | 1027 | extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2); |
ccdd4a0f | 1028 | extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2); |
b60e188c | 1029 | extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2); |
e83c5163 | 1030 | |
40469ee9 | 1031 | extern void *read_object_with_reference(const unsigned char *sha1, |
bf0f910d | 1032 | const char *required_type, |
40469ee9 JH |
1033 | unsigned long *size, |
1034 | unsigned char *sha1_ret); | |
f4913f91 | 1035 | |
81776315 JH |
1036 | extern struct object *peel_to_type(const char *name, int namelen, |
1037 | struct object *o, enum object_type); | |
1038 | ||
73013afd JH |
1039 | enum date_mode { |
1040 | DATE_NORMAL = 0, | |
1041 | DATE_RELATIVE, | |
1042 | DATE_SHORT, | |
1043 | DATE_LOCAL, | |
1044 | DATE_ISO8601, | |
466fb674 | 1045 | DATE_ISO8601_STRICT, |
7dff9b30 LT |
1046 | DATE_RFC2822, |
1047 | DATE_RAW | |
73013afd JH |
1048 | }; |
1049 | ||
f8493ec0 | 1050 | const char *show_date(unsigned long time, int timezone, enum date_mode mode); |
7d29afd4 JN |
1051 | void show_date_relative(unsigned long time, int tz, const struct timeval *now, |
1052 | struct strbuf *timebuf); | |
c33ddc2e | 1053 | int parse_date(const char *date, struct strbuf *out); |
9644c061 | 1054 | int parse_date_basic(const char *date, unsigned long *timestamp, int *offset); |
3d27b9b0 | 1055 | int parse_expiry_date(const char *date, unsigned long *timestamp); |
c33ddc2e | 1056 | void datestamp(struct strbuf *out); |
93cfa7c7 JH |
1057 | #define approxidate(s) approxidate_careful((s), NULL) |
1058 | unsigned long approxidate_careful(const char *, int *); | |
33012fc4 | 1059 | unsigned long approxidate_relative(const char *date, const struct timeval *now); |
856665f8 | 1060 | enum date_mode parse_date_format(const char *format); |
7ca36d93 | 1061 | int date_overflows(unsigned long date); |
ecee9d9e | 1062 | |
f9bc573f | 1063 | #define IDENT_STRICT 1 |
b9f0ac17 | 1064 | #define IDENT_NO_DATE 2 |
c15e1987 | 1065 | #define IDENT_NO_NAME 4 |
749be728 JH |
1066 | extern const char *git_author_info(int); |
1067 | extern const char *git_committer_info(int); | |
798123af | 1068 | extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int); |
d9ccfe77 | 1069 | extern const char *fmt_name(const char *name, const char *email); |
9830534e | 1070 | extern const char *ident_default_name(void); |
bcb2b004 | 1071 | extern const char *ident_default_email(void); |
44fcb497 | 1072 | extern const char *git_editor(void); |
64778d24 | 1073 | extern const char *git_pager(int stdout_is_tty); |
9597921b | 1074 | extern int git_ident_config(const char *, const char *, void *); |
6aa33f40 | 1075 | |
4b340cfa JH |
1076 | struct ident_split { |
1077 | const char *name_begin; | |
1078 | const char *name_end; | |
1079 | const char *mail_begin; | |
1080 | const char *mail_end; | |
1081 | const char *date_begin; | |
1082 | const char *date_end; | |
1083 | const char *tz_begin; | |
1084 | const char *tz_end; | |
1085 | }; | |
1086 | /* | |
1087 | * Signals an success with 0, but time part of the result may be NULL | |
1088 | * if the input lacks timestamp and zone | |
1089 | */ | |
1090 | extern int split_ident_line(struct ident_split *, const char *, int); | |
1091 | ||
d1053246 JK |
1092 | /* |
1093 | * Like show_date, but pull the timestamp and tz parameters from | |
1094 | * the ident_split. It will also sanity-check the values and produce | |
1095 | * a well-known sentinel date if they appear bogus. | |
1096 | */ | |
1097 | const char *show_ident_date(const struct ident_split *id, enum date_mode mode); | |
1098 | ||
662cc30c JK |
1099 | /* |
1100 | * Compare split idents for equality or strict ordering. Note that we | |
1101 | * compare only the ident part of the line, ignoring any timestamp. | |
1102 | * | |
1103 | * Because there are two fields, we must choose one as the primary key; we | |
1104 | * currently arbitrarily pick the email. | |
1105 | */ | |
1106 | extern int ident_cmp(const struct ident_split *, const struct ident_split *); | |
1107 | ||
12dccc16 | 1108 | struct checkout { |
d4a2024a | 1109 | struct index_state *istate; |
12dccc16 LT |
1110 | const char *base_dir; |
1111 | int base_dir_len; | |
1112 | unsigned force:1, | |
1113 | quiet:1, | |
1114 | not_new:1, | |
1115 | refresh_cache:1; | |
1116 | }; | |
1117 | ||
af2a651d | 1118 | #define TEMPORARY_FILENAME_LENGTH 25 |
efbc5831 | 1119 | extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath); |
b9fd2846 LT |
1120 | |
1121 | struct cache_def { | |
e7c73053 | 1122 | struct strbuf path; |
b9fd2846 LT |
1123 | int flags; |
1124 | int track_flags; | |
1125 | int prefix_len_stat_func; | |
1126 | }; | |
e7c73053 | 1127 | #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 } |
2a608391 | 1128 | static inline void cache_def_clear(struct cache_def *cache) |
e7c73053 KB |
1129 | { |
1130 | strbuf_release(&cache->path); | |
1131 | } | |
b9fd2846 | 1132 | |
57199892 | 1133 | extern int has_symlink_leading_path(const char *name, int len); |
b9fd2846 | 1134 | extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int); |
f66caaf9 | 1135 | extern int check_leading_path(const char *name, int len); |
57199892 | 1136 | extern int has_dirs_only_path(const char *name, int len, int prefix_len); |
78478927 KB |
1137 | extern void schedule_dir_for_removal(const char *name, int len); |
1138 | extern void remove_scheduled_dirs(void); | |
12dccc16 | 1139 | |
9a217f2a | 1140 | extern struct alternate_object_database { |
d5a63b99 | 1141 | struct alternate_object_database *next; |
9a217f2a | 1142 | char *name; |
8f1d2e6f | 1143 | char base[FLEX_ARRAY]; /* more */ |
d5a63b99 | 1144 | } *alt_odb_list; |
9a217f2a | 1145 | extern void prepare_alt_odb(void); |
5e73633d | 1146 | extern void read_info_alternates(const char * relative_base, int depth); |
bef70b22 | 1147 | extern void add_to_alternates_file(const char *reference); |
d79796bc | 1148 | typedef int alt_odb_fn(struct alternate_object_database *, void *); |
fe1b2268 | 1149 | extern int foreach_alt_odb(alt_odb_fn, void*); |
9a217f2a | 1150 | |
c41ee586 SP |
1151 | struct pack_window { |
1152 | struct pack_window *next; | |
1153 | unsigned char *base; | |
1154 | off_t offset; | |
1155 | size_t len; | |
1156 | unsigned int last_used; | |
1157 | unsigned int inuse_cnt; | |
1158 | }; | |
1159 | ||
9a217f2a JH |
1160 | extern struct packed_git { |
1161 | struct packed_git *next; | |
c41ee586 | 1162 | struct pack_window *windows; |
2dc3a234 | 1163 | off_t pack_size; |
57059091 NP |
1164 | const void *index_data; |
1165 | size_t index_size; | |
1166 | uint32_t num_objects; | |
8eca0b47 NP |
1167 | uint32_t num_bad_objects; |
1168 | unsigned char *bad_object_sha1; | |
42873078 | 1169 | int index_version; |
57059091 | 1170 | time_t mtime; |
9bc879c1 | 1171 | int pack_fd; |
8d25931d | 1172 | unsigned pack_local:1, |
d131b7af SP |
1173 | pack_keep:1, |
1174 | do_not_close:1; | |
bf592c50 | 1175 | unsigned char sha1[20]; |
8f1d2e6f JH |
1176 | /* something like ".git/objects/pack/xxxxx.pack" */ |
1177 | char pack_name[FLEX_ARRAY]; /* more */ | |
9a217f2a | 1178 | } *packed_git; |
f3bf9224 JH |
1179 | |
1180 | struct pack_entry { | |
c4001d92 | 1181 | off_t offset; |
f3bf9224 JH |
1182 | unsigned char sha1[20]; |
1183 | struct packed_git *p; | |
1184 | }; | |
1185 | ||
7b64469a | 1186 | extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path); |
bf592c50 | 1187 | |
543c5caa NTND |
1188 | /* A hook for count-objects to report invalid files in pack directory */ |
1189 | extern void (*report_garbage)(const char *desc, const char *path); | |
1190 | ||
9a217f2a | 1191 | extern void prepare_packed_git(void); |
fc04c412 | 1192 | extern void reprepare_packed_git(void); |
bf592c50 DB |
1193 | extern void install_packed_git(struct packed_git *pack); |
1194 | ||
a6080a0a | 1195 | extern struct packed_git *find_sha1_pack(const unsigned char *sha1, |
bf592c50 DB |
1196 | struct packed_git *packs); |
1197 | ||
276bc2ca | 1198 | extern void pack_report(void); |
d40d535b MH |
1199 | |
1200 | /* | |
1201 | * mmap the index file for the specified packfile (if it is not | |
1202 | * already mmapped). Return 0 on success. | |
1203 | */ | |
d079837e | 1204 | extern int open_pack_index(struct packed_git *); |
d40d535b MH |
1205 | |
1206 | /* | |
1207 | * munmap the index file for the specified packfile (if it is | |
1208 | * currently mmapped). | |
1209 | */ | |
fa5fc15d | 1210 | extern void close_pack_index(struct packed_git *); |
d40d535b | 1211 | |
ef49a7a0 | 1212 | extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *); |
c9ced051 | 1213 | extern void close_pack_windows(struct packed_git *); |
03e79c88 | 1214 | extern void unuse_pack(struct pack_window **); |
c74faea1 | 1215 | extern void free_pack_by_name(const char *); |
3d20c636 | 1216 | extern void clear_delta_base_cache(void); |
42873078 | 1217 | extern struct packed_git *add_packed_git(const char *, int, int); |
d40d535b MH |
1218 | |
1219 | /* | |
1220 | * Return the SHA-1 of the nth object within the specified packfile. | |
1221 | * Open the index if it is not already open. The return value points | |
1222 | * at the SHA-1 within the mmapped index. Return NULL if there is an | |
1223 | * error. | |
1224 | */ | |
1225 | extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n); | |
1226 | ||
1227 | /* | |
1228 | * Return the offset of the nth object within the specified packfile. | |
1229 | * The index must already be opened. | |
1230 | */ | |
1231 | extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n); | |
1232 | ||
1233 | /* | |
1234 | * If the object named sha1 is present in the specified packfile, | |
1235 | * return its offset within the packfile; otherwise, return 0. | |
1236 | */ | |
1237 | extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *); | |
1238 | ||
4c080182 | 1239 | extern int is_pack_valid(struct packed_git *); |
c4001d92 | 1240 | extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *); |
09ded04b | 1241 | extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep); |
54dab52a | 1242 | extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t); |
f8c8abc5 | 1243 | extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *); |
9a217f2a | 1244 | |
27e1e22d JK |
1245 | /* |
1246 | * Iterate over the files in the loose-object parts of the object | |
1247 | * directory "path", triggering the following callbacks: | |
1248 | * | |
1249 | * - loose_object is called for each loose object we find. | |
1250 | * | |
1251 | * - loose_cruft is called for any files that do not appear to be | |
1252 | * loose objects. Note that we only look in the loose object | |
1253 | * directories "objects/[0-9a-f]{2}/", so we will not report | |
1254 | * "objects/foobar" as cruft. | |
1255 | * | |
1256 | * - loose_subdir is called for each top-level hashed subdirectory | |
1257 | * of the object directory (e.g., "$OBJDIR/f0"). It is called | |
1258 | * after the objects in the directory are processed. | |
1259 | * | |
1260 | * Any callback that is NULL will be ignored. Callbacks returning non-zero | |
1261 | * will end the iteration. | |
1262 | */ | |
1263 | typedef int each_loose_object_fn(const unsigned char *sha1, | |
1264 | const char *path, | |
1265 | void *data); | |
1266 | typedef int each_loose_cruft_fn(const char *basename, | |
1267 | const char *path, | |
1268 | void *data); | |
1269 | typedef int each_loose_subdir_fn(int nr, | |
1270 | const char *path, | |
1271 | void *data); | |
1272 | int for_each_loose_file_in_objdir(const char *path, | |
1273 | each_loose_object_fn obj_cb, | |
1274 | each_loose_cruft_fn cruft_cb, | |
1275 | each_loose_subdir_fn subdir_cb, | |
1276 | void *data); | |
1277 | ||
660c889e JK |
1278 | /* |
1279 | * Iterate over loose and packed objects in both the local | |
1280 | * repository and any alternates repositories. | |
1281 | */ | |
1282 | typedef int each_packed_object_fn(const unsigned char *sha1, | |
1283 | struct packed_git *pack, | |
1284 | uint32_t pos, | |
1285 | void *data); | |
1286 | extern int for_each_loose_object(each_loose_object_fn, void *); | |
1287 | extern int for_each_packed_object(each_packed_object_fn, void *); | |
1288 | ||
9a490590 JH |
1289 | struct object_info { |
1290 | /* Request */ | |
5b086407 | 1291 | enum object_type *typep; |
9a490590 | 1292 | unsigned long *sizep; |
161f00e7 | 1293 | unsigned long *disk_sizep; |
5d642e75 | 1294 | unsigned char *delta_base_sha1; |
9a490590 JH |
1295 | |
1296 | /* Response */ | |
1297 | enum { | |
1298 | OI_CACHED, | |
1299 | OI_LOOSE, | |
5266d369 JH |
1300 | OI_PACKED, |
1301 | OI_DBCACHED | |
9a490590 JH |
1302 | } whence; |
1303 | union { | |
1304 | /* | |
1305 | * struct { | |
1306 | * ... Nothing to expose in this case | |
1307 | * } cached; | |
1308 | * struct { | |
1309 | * ... Nothing to expose in this case | |
1310 | * } loose; | |
1311 | */ | |
1312 | struct { | |
1313 | struct packed_git *pack; | |
1314 | off_t offset; | |
1315 | unsigned int is_delta; | |
1316 | } packed; | |
1317 | } u; | |
1318 | }; | |
de7b5d62 | 1319 | extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags); |
9a217f2a | 1320 | |
8f3f9b09 JH |
1321 | /* Dumb servers support */ |
1322 | extern int update_server_info(int); | |
1323 | ||
7a397419 MG |
1324 | /* git_config_parse_key() returns these negated: */ |
1325 | #define CONFIG_INVALID_KEY 1 | |
1326 | #define CONFIG_NO_SECTION_OR_NAME 2 | |
1327 | /* git_config_set(), git_config_set_multivar() return the above or these: */ | |
1328 | #define CONFIG_NO_LOCK -1 | |
1329 | #define CONFIG_INVALID_FILE 3 | |
1330 | #define CONFIG_NO_WRITE 4 | |
1331 | #define CONFIG_NOTHING_SET 5 | |
1332 | #define CONFIG_INVALID_PATTERN 6 | |
9409c7a5 | 1333 | #define CONFIG_GENERIC_ERROR 7 |
7a397419 | 1334 | |
c1063be2 JK |
1335 | #define CONFIG_REGEX_NONE ((void *)1) |
1336 | ||
c8985ce0 | 1337 | struct git_config_source { |
3caec73b | 1338 | unsigned int use_stdin:1; |
c8985ce0 KS |
1339 | const char *file; |
1340 | const char *blob; | |
1341 | }; | |
1342 | ||
ef90d6d4 JS |
1343 | typedef int (*config_fn_t)(const char *, const char *, void *); |
1344 | extern int git_default_config(const char *, const char *, void *); | |
1345 | extern int git_config_from_file(config_fn_t fn, const char *, void *); | |
1bc88819 HV |
1346 | extern int git_config_from_buf(config_fn_t fn, const char *name, |
1347 | const char *buf, size_t len, void *data); | |
2b64fc89 | 1348 | extern void git_config_push_parameter(const char *text); |
b3d83d9f | 1349 | extern int git_config_from_parameters(config_fn_t fn, void *data); |
aace4385 | 1350 | extern void git_config(config_fn_t fn, void *); |
9b25a0b5 | 1351 | extern int git_config_with_options(config_fn_t fn, void *, |
c8985ce0 | 1352 | struct git_config_source *config_source, |
1bc88819 | 1353 | int respect_includes); |
dbdf5854 | 1354 | extern int git_config_early(config_fn_t fn, void *, const char *repo_config); |
0b87b6e0 | 1355 | extern int git_parse_ulong(const char *, unsigned long *); |
17712991 | 1356 | extern int git_config_int(const char *, const char *); |
00160242 | 1357 | extern int64_t git_config_int64(const char *, const char *); |
0b87b6e0 | 1358 | extern unsigned long git_config_ulong(const char *, const char *); |
a53f2ec6 | 1359 | extern int git_config_bool_or_int(const char *, const char *, int *); |
17712991 | 1360 | extern int git_config_bool(const char *, const char *); |
8420ccd8 | 1361 | extern int git_config_maybe_bool(const char *, const char *); |
ea5105a5 | 1362 | extern int git_config_string(const char **, const char *, const char *); |
395de250 | 1363 | extern int git_config_pathname(const char **, const char *, const char *); |
5ec31182 | 1364 | extern int git_config_set_in_file(const char *, const char *, const char *); |
10bea152 | 1365 | extern int git_config_set(const char *, const char *); |
b09c53a3 | 1366 | extern int git_config_parse_key(const char *, char **, int *); |
4ddba79d | 1367 | extern int git_config_set_multivar(const char *, const char *, const char *, int); |
5ec31182 | 1368 | extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int); |
0667fcfb | 1369 | extern int git_config_rename_section(const char *, const char *); |
42bd39b5 | 1370 | extern int git_config_rename_section_in_file(const char *, const char *, const char *); |
506b17b1 | 1371 | extern const char *git_etc_gitconfig(void); |
ef90d6d4 | 1372 | extern int check_repository_format_version(const char *var, const char *value, void *cb); |
0ef37164 | 1373 | extern int git_env_bool(const char *, int); |
23b0c478 | 1374 | extern unsigned long git_env_ulong(const char *, unsigned long); |
ab88c363 | 1375 | extern int git_config_system(void); |
40ea4ed9 | 1376 | extern int config_error_nonbool(const char *); |
ff0a80af | 1377 | #if defined(__GNUC__) |
87fe5df3 | 1378 | #define config_error_nonbool(s) (config_error_nonbool(s), const_error()) |
a469a101 | 1379 | #endif |
a6fa5992 PN |
1380 | extern const char *get_log_output_encoding(void); |
1381 | extern const char *get_commit_output_encoding(void); | |
1382 | ||
2496844b JK |
1383 | extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data); |
1384 | ||
9b25a0b5 JK |
1385 | struct config_include_data { |
1386 | int depth; | |
1387 | config_fn_t fn; | |
1388 | void *data; | |
1389 | }; | |
1390 | #define CONFIG_INCLUDE_INIT { 0 } | |
1391 | extern int git_config_include(const char *name, const char *value, void *data); | |
17712991 | 1392 | |
1b86bbb0 JK |
1393 | /* |
1394 | * Match and parse a config key of the form: | |
1395 | * | |
1396 | * section.(subsection.)?key | |
1397 | * | |
1398 | * (i.e., what gets handed to a config_fn_t). The caller provides the section; | |
1399 | * we return -1 if it does not match, 0 otherwise. The subsection and key | |
1400 | * out-parameters are filled by the function (and subsection is NULL if it is | |
1401 | * missing). | |
1402 | */ | |
1403 | extern int parse_config_key(const char *var, | |
1404 | const char *section, | |
1405 | const char **subsection, int *subsection_len, | |
1406 | const char **key); | |
1407 | ||
155ef25f TA |
1408 | struct config_set_element { |
1409 | struct hashmap_entry ent; | |
1410 | char *key; | |
1411 | struct string_list value_list; | |
1412 | }; | |
1413 | ||
1414 | struct configset_list_item { | |
1415 | struct config_set_element *e; | |
1416 | int value_index; | |
1417 | }; | |
1418 | ||
1419 | /* | |
1420 | * the contents of the list are ordered according to their | |
1421 | * position in the config files and order of parsing the files. | |
1422 | * (i.e. key-value pair at the last position of .git/config will | |
1423 | * be at the last item of the list) | |
1424 | */ | |
1425 | struct configset_list { | |
1426 | struct configset_list_item *items; | |
1427 | unsigned int nr, alloc; | |
1428 | }; | |
1429 | ||
3c8687a7 TA |
1430 | struct config_set { |
1431 | struct hashmap config_hash; | |
1432 | int hash_initialized; | |
155ef25f | 1433 | struct configset_list list; |
3c8687a7 TA |
1434 | }; |
1435 | ||
1436 | extern void git_configset_init(struct config_set *cs); | |
1437 | extern int git_configset_add_file(struct config_set *cs, const char *filename); | |
1438 | extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value); | |
1439 | extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key); | |
1440 | extern void git_configset_clear(struct config_set *cs); | |
1441 | extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest); | |
1442 | extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest); | |
1443 | extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest); | |
1444 | extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest); | |
1445 | extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest); | |
1446 | extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest); | |
1447 | extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest); | |
1448 | extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest); | |
1449 | ||
1450 | extern int git_config_get_value(const char *key, const char **value); | |
1451 | extern const struct string_list *git_config_get_value_multi(const char *key); | |
1452 | extern void git_config_clear(void); | |
1453 | extern void git_config_iter(config_fn_t fn, void *data); | |
1454 | extern int git_config_get_string_const(const char *key, const char **dest); | |
1455 | extern int git_config_get_string(const char *key, char **dest); | |
1456 | extern int git_config_get_int(const char *key, int *dest); | |
1457 | extern int git_config_get_ulong(const char *key, unsigned long *dest); | |
1458 | extern int git_config_get_bool(const char *key, int *dest); | |
1459 | extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest); | |
1460 | extern int git_config_get_maybe_bool(const char *key, int *dest); | |
1461 | extern int git_config_get_pathname(const char *key, const char **dest); | |
1462 | ||
3df8fd62 TA |
1463 | struct key_value_info { |
1464 | const char *filename; | |
1465 | int linenr; | |
1466 | }; | |
1467 | ||
5a80e97c TA |
1468 | extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3))); |
1469 | extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr); | |
1470 | ||
d6991cee JK |
1471 | extern int committer_ident_sufficiently_given(void); |
1472 | extern int author_ident_sufficiently_given(void); | |
e1b10391 | 1473 | |
1a8f2741 | 1474 | extern const char *git_commit_encoding; |
3a55602e | 1475 | extern const char *git_log_output_encoding; |
d551a488 | 1476 | extern const char *git_mailmap_file; |
08610900 | 1477 | extern const char *git_mailmap_blob; |
4e72dcec | 1478 | |
06f59e9f TT |
1479 | /* IO helper functions */ |
1480 | extern void maybe_flush_or_die(FILE *, const char *); | |
9540ce50 JK |
1481 | __attribute__((format (printf, 2, 3))) |
1482 | extern void fprintf_or_die(FILE *, const char *fmt, ...); | |
f3123c4a | 1483 | extern int copy_fd(int ifd, int ofd); |
1468bd47 | 1484 | extern int copy_file(const char *dst, const char *src, int mode); |
f7835a25 | 1485 | extern int copy_file_with_time(const char *dst, const char *src, int mode); |
7230e6d0 | 1486 | extern void write_or_die(int fd, const void *buf, size_t count); |
6ce4e61f | 1487 | extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg); |
e0814056 | 1488 | extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg); |
4c81b03e | 1489 | extern void fsync_or_die(int fd, const char *); |
ad897215 | 1490 | |
2b7ca830 JM |
1491 | extern ssize_t read_in_full(int fd, void *buf, size_t count); |
1492 | extern ssize_t write_in_full(int fd, const void *buf, size_t count); | |
426ddeea YM |
1493 | extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset); |
1494 | ||
2b7ca830 JM |
1495 | static inline ssize_t write_str_in_full(int fd, const char *str) |
1496 | { | |
1497 | return write_in_full(fd, str, strlen(str)); | |
1498 | } | |
1499 | ||
f67b45f8 LT |
1500 | /* pager.c */ |
1501 | extern void setup_pager(void); | |
872da32d | 1502 | extern const char *pager_program; |
6e9af863 | 1503 | extern int pager_in_use(void); |
aa086eb8 | 1504 | extern int pager_use_color; |
ad6c3739 | 1505 | extern int term_columns(void); |
ec7ff5ba | 1506 | extern int decimal_width(int); |
4914c962 | 1507 | extern int check_pager_config(const char *cmd); |
f67b45f8 | 1508 | |
ee9601e6 | 1509 | extern const char *editor_program; |
d3e7da89 | 1510 | extern const char *askpass_program; |
dfb068be | 1511 | extern const char *excludes_file; |
4d87b9c5 | 1512 | |
051308f6 | 1513 | /* base85 */ |
f9815772 JM |
1514 | int decode_85(char *dst, const char *line, int linelen); |
1515 | void encode_85(char *buf, const unsigned char *data, int bytes); | |
051308f6 | 1516 | |
855419f7 | 1517 | /* alloc.c */ |
100c5f3b LT |
1518 | extern void *alloc_blob_node(void); |
1519 | extern void *alloc_tree_node(void); | |
1520 | extern void *alloc_commit_node(void); | |
1521 | extern void *alloc_tag_node(void); | |
1522 | extern void *alloc_object_node(void); | |
855419f7 | 1523 | extern void alloc_report(void); |
94d5a22c | 1524 | extern unsigned int alloc_commit_index(void); |
855419f7 | 1525 | |
5991a55c | 1526 | /* pkt-line.c */ |
bbc30f99 | 1527 | void packet_trace_identity(const char *prog); |
6ce4e61f | 1528 | |
b6ec1d61 | 1529 | /* add */ |
7ae02a30 AR |
1530 | /* |
1531 | * return 0 if success, 1 - if addition of a file failed and | |
1532 | * ADD_FILES_IGNORE_ERRORS was specified in flags | |
1533 | */ | |
3efe8e43 | 1534 | int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags); |
b6ec1d61 | 1535 | |
aecbf914 JH |
1536 | /* diff.c */ |
1537 | extern int diff_auto_refresh_index; | |
1538 | ||
68faf689 JH |
1539 | /* match-trees.c */ |
1540 | void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int); | |
85e51b78 | 1541 | void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *); |
68faf689 | 1542 | |
a9cc857a JH |
1543 | /* |
1544 | * whitespace rules. | |
1545 | * used by both diff and apply | |
f4b05a49 | 1546 | * last two digits are tab width |
a9cc857a | 1547 | */ |
f4b05a49 JS |
1548 | #define WS_BLANK_AT_EOL 0100 |
1549 | #define WS_SPACE_BEFORE_TAB 0200 | |
1550 | #define WS_INDENT_WITH_NON_TAB 0400 | |
1551 | #define WS_CR_AT_EOL 01000 | |
1552 | #define WS_BLANK_AT_EOF 02000 | |
1553 | #define WS_TAB_IN_INDENT 04000 | |
aeb84b05 | 1554 | #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF) |
f4b05a49 JS |
1555 | #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8) |
1556 | #define WS_TAB_WIDTH_MASK 077 | |
cf1b7869 JH |
1557 | extern unsigned whitespace_rule_cfg; |
1558 | extern unsigned whitespace_rule(const char *); | |
1559 | extern unsigned parse_whitespace_rule(const char *); | |
8f8841e9 JH |
1560 | extern unsigned ws_check(const char *line, int len, unsigned ws_rule); |
1561 | extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws); | |
c1795bb0 | 1562 | extern char *whitespace_error_string(unsigned ws); |
d511bd33 | 1563 | extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *); |
877f23cc | 1564 | extern int ws_blank_line(const char *line, int len, unsigned ws_rule); |
f4b05a49 | 1565 | #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK) |
a9cc857a | 1566 | |
ee425e46 | 1567 | /* ls-files */ |
17ddc66e | 1568 | int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix); |
ee425e46 JH |
1569 | void overlay_tree_on_cache(const char *tree_name, const char *prefix); |
1570 | ||
94351118 | 1571 | char *alias_lookup(const char *alias); |
0989fe96 | 1572 | int split_cmdline(char *cmdline, const char ***argv); |
ad9ac6db GB |
1573 | /* Takes a negative value returned by split_cmdline */ |
1574 | const char *split_cmdline_strerror(int cmdline_errno); | |
94351118 | 1575 | |
e37c1329 NTND |
1576 | /* git.c */ |
1577 | struct startup_info { | |
a60645f9 | 1578 | int have_repository; |
f07d6a1a | 1579 | const char *prefix; |
e37c1329 NTND |
1580 | }; |
1581 | extern struct startup_info *startup_info; | |
1582 | ||
db699a8a NTND |
1583 | /* merge.c */ |
1584 | struct commit_list; | |
1585 | int try_merge_command(const char *strategy, size_t xopts_nr, | |
1586 | const char **xopts, struct commit_list *common, | |
1587 | const char *head_arg, struct commit_list *remotes); | |
1588 | int checkout_fast_forward(const unsigned char *from, | |
1589 | const unsigned char *to, | |
1590 | int overwrite_ignore); | |
1591 | ||
cac42b26 | 1592 | |
38f865c2 JK |
1593 | int sane_execvp(const char *file, char *const argv[]); |
1594 | ||
38612532 MH |
1595 | /* |
1596 | * A struct to encapsulate the concept of whether a file has changed | |
1597 | * since we last checked it. This uses criteria similar to those used | |
1598 | * for the index. | |
1599 | */ | |
1600 | struct stat_validity { | |
1601 | struct stat_data *sd; | |
1602 | }; | |
1603 | ||
1604 | void stat_validity_clear(struct stat_validity *sv); | |
1605 | ||
1606 | /* | |
1607 | * Returns 1 if the path is a regular file (or a symlink to a regular | |
1608 | * file) and matches the saved stat_validity, 0 otherwise. A missing | |
1609 | * or inaccessible file is considered a match if the struct was just | |
1610 | * initialized, or if the previous update found an inaccessible file. | |
1611 | */ | |
1612 | int stat_validity_check(struct stat_validity *sv, const char *path); | |
1613 | ||
1614 | /* | |
1615 | * Update the stat_validity from a file opened at descriptor fd. If | |
1616 | * the file is missing, inaccessible, or not a regular file, then | |
1617 | * future calls to stat_validity_check will match iff one of those | |
1618 | * conditions continues to be true. | |
1619 | */ | |
1620 | void stat_validity_update(struct stat_validity *sv, int fd); | |
1621 | ||
9ef176b5 NTND |
1622 | int versioncmp(const char *s1, const char *s2); |
1623 | ||
e83c5163 | 1624 | #endif /* CACHE_H */ |