sha1-name.c: remove implicit dependency on the_index
[git/git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "list.h"
8 #include "advice.h"
9 #include "gettext.h"
10 #include "convert.h"
11 #include "trace.h"
12 #include "string-list.h"
13 #include "pack-revindex.h"
14 #include "hash.h"
15 #include "path.h"
16 #include "sha1-array.h"
17 #include "repository.h"
18 #include "mem-pool.h"
19
20 #include <zlib.h>
21 typedef struct git_zstream {
22 z_stream z;
23 unsigned long avail_in;
24 unsigned long avail_out;
25 unsigned long total_in;
26 unsigned long total_out;
27 unsigned char *next_in;
28 unsigned char *next_out;
29 } git_zstream;
30
31 void git_inflate_init(git_zstream *);
32 void git_inflate_init_gzip_only(git_zstream *);
33 void git_inflate_end(git_zstream *);
34 int git_inflate(git_zstream *, int flush);
35
36 void git_deflate_init(git_zstream *, int level);
37 void git_deflate_init_gzip(git_zstream *, int level);
38 void git_deflate_init_raw(git_zstream *, int level);
39 void git_deflate_end(git_zstream *);
40 int git_deflate_abort(git_zstream *);
41 int git_deflate_end_gently(git_zstream *);
42 int git_deflate(git_zstream *, int flush);
43 unsigned long git_deflate_bound(git_zstream *, unsigned long);
44
45 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
46 #define GIT_SHA1_RAWSZ 20
47 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
48
49 /* The length in byte and in hex digits of the largest possible hash value. */
50 #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
51 #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
52
53 struct object_id {
54 unsigned char hash[GIT_MAX_RAWSZ];
55 };
56
57 #define the_hash_algo the_repository->hash_algo
58
59 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
60 #define DTYPE(de) ((de)->d_type)
61 #else
62 #undef DT_UNKNOWN
63 #undef DT_DIR
64 #undef DT_REG
65 #undef DT_LNK
66 #define DT_UNKNOWN 0
67 #define DT_DIR 1
68 #define DT_REG 2
69 #define DT_LNK 3
70 #define DTYPE(de) DT_UNKNOWN
71 #endif
72
73 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
74 #define S_IFINVALID 0030000
75
76 /*
77 * A "directory link" is a link to another git directory.
78 *
79 * The value 0160000 is not normally a valid mode, and
80 * also just happens to be S_IFDIR + S_IFLNK
81 */
82 #define S_IFGITLINK 0160000
83 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
84
85 /*
86 * Some mode bits are also used internally for computations.
87 *
88 * They *must* not overlap with any valid modes, and they *must* not be emitted
89 * to outside world - i.e. appear on disk or network. In other words, it's just
90 * temporary fields, which we internally use, but they have to stay in-house.
91 *
92 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
93 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
94 */
95
96 /* used internally in tree-diff */
97 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
98
99
100 /*
101 * Intensive research over the course of many years has shown that
102 * port 9418 is totally unused by anything else. Or
103 *
104 * Your search - "port 9418" - did not match any documents.
105 *
106 * as www.google.com puts it.
107 *
108 * This port has been properly assigned for git use by IANA:
109 * git (Assigned-9418) [I06-050728-0001].
110 *
111 * git 9418/tcp git pack transfer service
112 * git 9418/udp git pack transfer service
113 *
114 * with Linus Torvalds <torvalds@osdl.org> as the point of
115 * contact. September 2005.
116 *
117 * See http://www.iana.org/assignments/port-numbers
118 */
119 #define DEFAULT_GIT_PORT 9418
120
121 /*
122 * Basic data structures for the directory cache
123 */
124
125 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
126 struct cache_header {
127 uint32_t hdr_signature;
128 uint32_t hdr_version;
129 uint32_t hdr_entries;
130 };
131
132 #define INDEX_FORMAT_LB 2
133 #define INDEX_FORMAT_UB 4
134
135 /*
136 * The "cache_time" is just the low 32 bits of the
137 * time. It doesn't matter if it overflows - we only
138 * check it for equality in the 32 bits we save.
139 */
140 struct cache_time {
141 uint32_t sec;
142 uint32_t nsec;
143 };
144
145 struct stat_data {
146 struct cache_time sd_ctime;
147 struct cache_time sd_mtime;
148 unsigned int sd_dev;
149 unsigned int sd_ino;
150 unsigned int sd_uid;
151 unsigned int sd_gid;
152 unsigned int sd_size;
153 };
154
155 struct cache_entry {
156 struct hashmap_entry ent;
157 struct stat_data ce_stat_data;
158 unsigned int ce_mode;
159 unsigned int ce_flags;
160 unsigned int mem_pool_allocated;
161 unsigned int ce_namelen;
162 unsigned int index; /* for link extension */
163 struct object_id oid;
164 char name[FLEX_ARRAY]; /* more */
165 };
166
167 #define CE_STAGEMASK (0x3000)
168 #define CE_EXTENDED (0x4000)
169 #define CE_VALID (0x8000)
170 #define CE_STAGESHIFT 12
171
172 /*
173 * Range 0xFFFF0FFF in ce_flags is divided into
174 * two parts: in-memory flags and on-disk ones.
175 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
176 * if you want to save a new flag, add it in
177 * CE_EXTENDED_FLAGS
178 *
179 * In-memory only flags
180 */
181 #define CE_UPDATE (1 << 16)
182 #define CE_REMOVE (1 << 17)
183 #define CE_UPTODATE (1 << 18)
184 #define CE_ADDED (1 << 19)
185
186 #define CE_HASHED (1 << 20)
187 #define CE_FSMONITOR_VALID (1 << 21)
188 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
189 #define CE_CONFLICTED (1 << 23)
190
191 #define CE_UNPACKED (1 << 24)
192 #define CE_NEW_SKIP_WORKTREE (1 << 25)
193
194 /* used to temporarily mark paths matched by pathspecs */
195 #define CE_MATCHED (1 << 26)
196
197 #define CE_UPDATE_IN_BASE (1 << 27)
198 #define CE_STRIP_NAME (1 << 28)
199
200 /*
201 * Extended on-disk flags
202 */
203 #define CE_INTENT_TO_ADD (1 << 29)
204 #define CE_SKIP_WORKTREE (1 << 30)
205 /* CE_EXTENDED2 is for future extension */
206 #define CE_EXTENDED2 (1U << 31)
207
208 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
209
210 /*
211 * Safeguard to avoid saving wrong flags:
212 * - CE_EXTENDED2 won't get saved until its semantic is known
213 * - Bits in 0x0000FFFF have been saved in ce_flags already
214 * - Bits in 0x003F0000 are currently in-memory flags
215 */
216 #if CE_EXTENDED_FLAGS & 0x803FFFFF
217 #error "CE_EXTENDED_FLAGS out of range"
218 #endif
219
220 /* Forward structure decls */
221 struct pathspec;
222 struct child_process;
223 struct tree;
224
225 /*
226 * Copy the sha1 and stat state of a cache entry from one to
227 * another. But we never change the name, or the hash state!
228 */
229 static inline void copy_cache_entry(struct cache_entry *dst,
230 const struct cache_entry *src)
231 {
232 unsigned int state = dst->ce_flags & CE_HASHED;
233 int mem_pool_allocated = dst->mem_pool_allocated;
234
235 /* Don't copy hash chain and name */
236 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
237 offsetof(struct cache_entry, name) -
238 offsetof(struct cache_entry, ce_stat_data));
239
240 /* Restore the hash state */
241 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
242
243 /* Restore the mem_pool_allocated flag */
244 dst->mem_pool_allocated = mem_pool_allocated;
245 }
246
247 static inline unsigned create_ce_flags(unsigned stage)
248 {
249 return (stage << CE_STAGESHIFT);
250 }
251
252 #define ce_namelen(ce) ((ce)->ce_namelen)
253 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
254 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
255 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
256 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
257 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
258 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
259
260 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
261 static inline unsigned int create_ce_mode(unsigned int mode)
262 {
263 if (S_ISLNK(mode))
264 return S_IFLNK;
265 if (S_ISDIR(mode) || S_ISGITLINK(mode))
266 return S_IFGITLINK;
267 return S_IFREG | ce_permissions(mode);
268 }
269 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
270 unsigned int mode)
271 {
272 extern int trust_executable_bit, has_symlinks;
273 if (!has_symlinks && S_ISREG(mode) &&
274 ce && S_ISLNK(ce->ce_mode))
275 return ce->ce_mode;
276 if (!trust_executable_bit && S_ISREG(mode)) {
277 if (ce && S_ISREG(ce->ce_mode))
278 return ce->ce_mode;
279 return create_ce_mode(0666);
280 }
281 return create_ce_mode(mode);
282 }
283 static inline int ce_to_dtype(const struct cache_entry *ce)
284 {
285 unsigned ce_mode = ntohl(ce->ce_mode);
286 if (S_ISREG(ce_mode))
287 return DT_REG;
288 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
289 return DT_DIR;
290 else if (S_ISLNK(ce_mode))
291 return DT_LNK;
292 else
293 return DT_UNKNOWN;
294 }
295 static inline unsigned int canon_mode(unsigned int mode)
296 {
297 if (S_ISREG(mode))
298 return S_IFREG | ce_permissions(mode);
299 if (S_ISLNK(mode))
300 return S_IFLNK;
301 if (S_ISDIR(mode))
302 return S_IFDIR;
303 return S_IFGITLINK;
304 }
305
306 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
307
308 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
309 #define CE_ENTRY_CHANGED (1 << 1)
310 #define CE_ENTRY_REMOVED (1 << 2)
311 #define CE_ENTRY_ADDED (1 << 3)
312 #define RESOLVE_UNDO_CHANGED (1 << 4)
313 #define CACHE_TREE_CHANGED (1 << 5)
314 #define SPLIT_INDEX_ORDERED (1 << 6)
315 #define UNTRACKED_CHANGED (1 << 7)
316 #define FSMONITOR_CHANGED (1 << 8)
317
318 struct split_index;
319 struct untracked_cache;
320
321 struct index_state {
322 struct cache_entry **cache;
323 unsigned int version;
324 unsigned int cache_nr, cache_alloc, cache_changed;
325 struct string_list *resolve_undo;
326 struct cache_tree *cache_tree;
327 struct split_index *split_index;
328 struct cache_time timestamp;
329 unsigned name_hash_initialized : 1,
330 initialized : 1,
331 drop_cache_tree : 1;
332 struct hashmap name_hash;
333 struct hashmap dir_hash;
334 struct object_id oid;
335 struct untracked_cache *untracked;
336 uint64_t fsmonitor_last_update;
337 struct ewah_bitmap *fsmonitor_dirty;
338 struct mem_pool *ce_mem_pool;
339 };
340
341 extern struct index_state the_index;
342
343 /* Name hashing */
344 extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
345 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
346 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
347 extern void free_name_hash(struct index_state *istate);
348
349
350 /* Cache entry creation and cleanup */
351
352 /*
353 * Create cache_entry intended for use in the specified index. Caller
354 * is responsible for discarding the cache_entry with
355 * `discard_cache_entry`.
356 */
357 struct cache_entry *make_cache_entry(struct index_state *istate,
358 unsigned int mode,
359 const struct object_id *oid,
360 const char *path,
361 int stage,
362 unsigned int refresh_options);
363
364 struct cache_entry *make_empty_cache_entry(struct index_state *istate,
365 size_t name_len);
366
367 /*
368 * Create a cache_entry that is not intended to be added to an index.
369 * Caller is responsible for discarding the cache_entry
370 * with `discard_cache_entry`.
371 */
372 struct cache_entry *make_transient_cache_entry(unsigned int mode,
373 const struct object_id *oid,
374 const char *path,
375 int stage);
376
377 struct cache_entry *make_empty_transient_cache_entry(size_t name_len);
378
379 /*
380 * Discard cache entry.
381 */
382 void discard_cache_entry(struct cache_entry *ce);
383
384 /*
385 * Check configuration if we should perform extra validation on cache
386 * entries.
387 */
388 int should_validate_cache_entries(void);
389
390 /*
391 * Duplicate a cache_entry. Allocate memory for the new entry from a
392 * memory_pool. Takes into account cache_entry fields that are meant
393 * for managing the underlying memory allocation of the cache_entry.
394 */
395 struct cache_entry *dup_cache_entry(const struct cache_entry *ce, struct index_state *istate);
396
397 /*
398 * Validate the cache entries in the index. This is an internal
399 * consistency check that the cache_entry structs are allocated from
400 * the expected memory pool.
401 */
402 void validate_cache_entries(const struct index_state *istate);
403
404 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
405 #define active_cache (the_index.cache)
406 #define active_nr (the_index.cache_nr)
407 #define active_alloc (the_index.cache_alloc)
408 #define active_cache_changed (the_index.cache_changed)
409 #define active_cache_tree (the_index.cache_tree)
410
411 #define read_cache() repo_read_index(the_repository)
412 #define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
413 #define read_cache_preload(pathspec) repo_read_index_preload(the_repository, (pathspec), 0)
414 #define is_cache_unborn() is_index_unborn(&the_index)
415 #define read_cache_unmerged() repo_read_index_unmerged(the_repository)
416 #define discard_cache() discard_index(&the_index)
417 #define unmerged_cache() unmerged_index(&the_index)
418 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
419 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
420 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
421 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
422 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
423 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
424 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
425 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
426 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
427 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
428 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
429 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
430 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
431 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
432 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
433 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
434 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
435 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
436 #define hold_locked_index(lock_file, flags) repo_hold_locked_index(the_repository, (lock_file), (flags))
437 #endif
438
439 #define TYPE_BITS 3
440
441 /*
442 * Values in this enum (except those outside the 3 bit range) are part
443 * of pack file format. See Documentation/technical/pack-format.txt
444 * for more information.
445 */
446 enum object_type {
447 OBJ_BAD = -1,
448 OBJ_NONE = 0,
449 OBJ_COMMIT = 1,
450 OBJ_TREE = 2,
451 OBJ_BLOB = 3,
452 OBJ_TAG = 4,
453 /* 5 for future expansion */
454 OBJ_OFS_DELTA = 6,
455 OBJ_REF_DELTA = 7,
456 OBJ_ANY,
457 OBJ_MAX
458 };
459
460 static inline enum object_type object_type(unsigned int mode)
461 {
462 return S_ISDIR(mode) ? OBJ_TREE :
463 S_ISGITLINK(mode) ? OBJ_COMMIT :
464 OBJ_BLOB;
465 }
466
467 /* Double-check local_repo_env below if you add to this list. */
468 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
469 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
470 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
471 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
472 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
473 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
474 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
475 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
476 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
477 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
478 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
479 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
480 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
481 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
482 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
483 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
484 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
485 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
486 #define GITATTRIBUTES_FILE ".gitattributes"
487 #define INFOATTRIBUTES_FILE "info/attributes"
488 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
489 #define GITMODULES_FILE ".gitmodules"
490 #define GITMODULES_INDEX ":.gitmodules"
491 #define GITMODULES_HEAD "HEAD:.gitmodules"
492 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
493 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
494 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
495 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
496 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
497 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
498 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
499 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
500 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
501 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
502 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
503 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
504
505 /*
506 * Environment variable used in handshaking the wire protocol.
507 * Contains a colon ':' separated list of keys with optional values
508 * 'key[=value]'. Presence of unknown keys and values must be
509 * ignored.
510 */
511 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
512 /* HTTP header used to handshake the wire protocol */
513 #define GIT_PROTOCOL_HEADER "Git-Protocol"
514
515 /*
516 * This environment variable is expected to contain a boolean indicating
517 * whether we should or should not treat:
518 *
519 * GIT_DIR=foo.git git ...
520 *
521 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
522 * of this, but we use it internally to communicate to sub-processes that we
523 * are in a bare repo. If not set, defaults to true.
524 */
525 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
526
527 /*
528 * Repository-local GIT_* environment variables; these will be cleared
529 * when git spawns a sub-process that runs inside another repository.
530 * The array is NULL-terminated, which makes it easy to pass in the "env"
531 * parameter of a run-command invocation, or to do a simple walk.
532 */
533 extern const char * const local_repo_env[];
534
535 extern void setup_git_env(const char *git_dir);
536
537 /*
538 * Returns true iff we have a configured git repository (either via
539 * setup_git_directory, or in the environment via $GIT_DIR).
540 */
541 int have_git_dir(void);
542
543 extern int is_bare_repository_cfg;
544 extern int is_bare_repository(void);
545 extern int is_inside_git_dir(void);
546 extern char *git_work_tree_cfg;
547 extern int is_inside_work_tree(void);
548 extern const char *get_git_dir(void);
549 extern const char *get_git_common_dir(void);
550 extern char *get_object_directory(void);
551 extern char *get_index_file(void);
552 extern char *get_graft_file(struct repository *r);
553 extern void set_git_dir(const char *path);
554 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
555 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
556 extern const char *get_git_namespace(void);
557 extern const char *strip_namespace(const char *namespaced_ref);
558 extern const char *get_super_prefix(void);
559 extern const char *get_git_work_tree(void);
560
561 /*
562 * Return true if the given path is a git directory; note that this _just_
563 * looks at the directory itself. If you want to know whether "foo/.git"
564 * is a repository, you must feed that path, not just "foo".
565 */
566 extern int is_git_directory(const char *path);
567
568 /*
569 * Return 1 if the given path is the root of a git repository or
570 * submodule, else 0. Will not return 1 for bare repositories with the
571 * exception of creating a bare repository in "foo/.git" and calling
572 * is_git_repository("foo").
573 *
574 * If we run into read errors, we err on the side of saying "yes, it is",
575 * as we usually consider sub-repos precious, and would prefer to err on the
576 * side of not disrupting or deleting them.
577 */
578 extern int is_nonbare_repository_dir(struct strbuf *path);
579
580 #define READ_GITFILE_ERR_STAT_FAILED 1
581 #define READ_GITFILE_ERR_NOT_A_FILE 2
582 #define READ_GITFILE_ERR_OPEN_FAILED 3
583 #define READ_GITFILE_ERR_READ_FAILED 4
584 #define READ_GITFILE_ERR_INVALID_FORMAT 5
585 #define READ_GITFILE_ERR_NO_PATH 6
586 #define READ_GITFILE_ERR_NOT_A_REPO 7
587 #define READ_GITFILE_ERR_TOO_LARGE 8
588 extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
589 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
590 #define read_gitfile(path) read_gitfile_gently((path), NULL)
591 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
592 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
593
594 extern void set_git_work_tree(const char *tree);
595
596 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
597
598 extern void setup_work_tree(void);
599 /*
600 * Find the commondir and gitdir of the repository that contains the current
601 * working directory, without changing the working directory or other global
602 * state. The result is appended to commondir and gitdir. If the discovered
603 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
604 * both have the same result appended to the buffer. The return value is
605 * either 0 upon success and non-zero if no repository was found.
606 */
607 extern int discover_git_directory(struct strbuf *commondir,
608 struct strbuf *gitdir);
609 extern const char *setup_git_directory_gently(int *);
610 extern const char *setup_git_directory(void);
611 extern char *prefix_path(const char *prefix, int len, const char *path);
612 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
613
614 /*
615 * Concatenate "prefix" (if len is non-zero) and "path", with no
616 * connecting characters (so "prefix" should end with a "/").
617 * Unlike prefix_path, this should be used if the named file does
618 * not have to interact with index entry; i.e. name of a random file
619 * on the filesystem.
620 *
621 * The return value is always a newly allocated string (even if the
622 * prefix was empty).
623 */
624 extern char *prefix_filename(const char *prefix, const char *path);
625
626 extern int check_filename(const char *prefix, const char *name);
627 extern void verify_filename(const char *prefix,
628 const char *name,
629 int diagnose_misspelt_rev);
630 extern void verify_non_filename(const char *prefix, const char *name);
631 extern int path_inside_repo(const char *prefix, const char *path);
632
633 #define INIT_DB_QUIET 0x0001
634 #define INIT_DB_EXIST_OK 0x0002
635
636 extern int init_db(const char *git_dir, const char *real_git_dir,
637 const char *template_dir, unsigned int flags);
638
639 extern void sanitize_stdfds(void);
640 extern int daemonize(void);
641
642 #define alloc_nr(x) (((x)+16)*3/2)
643
644 /*
645 * Realloc the buffer pointed at by variable 'x' so that it can hold
646 * at least 'nr' entries; the number of entries currently allocated
647 * is 'alloc', using the standard growing factor alloc_nr() macro.
648 *
649 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
650 */
651 #define ALLOC_GROW(x, nr, alloc) \
652 do { \
653 if ((nr) > alloc) { \
654 if (alloc_nr(alloc) < (nr)) \
655 alloc = (nr); \
656 else \
657 alloc = alloc_nr(alloc); \
658 REALLOC_ARRAY(x, alloc); \
659 } \
660 } while (0)
661
662 /* Initialize and use the cache information */
663 struct lock_file;
664 extern void preload_index(struct index_state *index,
665 const struct pathspec *pathspec,
666 unsigned int refresh_flags);
667 extern int do_read_index(struct index_state *istate, const char *path,
668 int must_exist); /* for testting only! */
669 extern int read_index_from(struct index_state *, const char *path,
670 const char *gitdir);
671 extern int is_index_unborn(struct index_state *);
672
673 /* For use with `write_locked_index()`. */
674 #define COMMIT_LOCK (1 << 0)
675 #define SKIP_IF_UNCHANGED (1 << 1)
676
677 /*
678 * Write the index while holding an already-taken lock. Close the lock,
679 * and if `COMMIT_LOCK` is given, commit it.
680 *
681 * Unless a split index is in use, write the index into the lockfile.
682 *
683 * With a split index, write the shared index to a temporary file,
684 * adjust its permissions and rename it into place, then write the
685 * split index to the lockfile. If the temporary file for the shared
686 * index cannot be created, fall back to the behavior described in
687 * the previous paragraph.
688 *
689 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
690 * Without it, the lock is closed, but neither committed nor rolled
691 * back.
692 *
693 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
694 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
695 */
696 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
697
698 extern int discard_index(struct index_state *);
699 extern void move_index_extensions(struct index_state *dst, struct index_state *src);
700 extern int unmerged_index(const struct index_state *);
701
702 /**
703 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
704 * compares istate to HEAD. If tree is NULL and on an unborn branch,
705 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
706 * provided, the space-separated list of files that differ will be appended
707 * to it.
708 */
709 extern int index_has_changes(struct index_state *istate,
710 struct tree *tree,
711 struct strbuf *sb);
712
713 extern int verify_path(const char *path, unsigned mode);
714 extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
715 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
716 extern void adjust_dirname_case(struct index_state *istate, char *name);
717 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
718
719 /*
720 * Searches for an entry defined by name and namelen in the given index.
721 * If the return value is positive (including 0) it is the position of an
722 * exact match. If the return value is negative, the negated value minus 1
723 * is the position where the entry would be inserted.
724 * Example: The current index consists of these files and its stages:
725 *
726 * b#0, d#0, f#1, f#3
727 *
728 * index_name_pos(&index, "a", 1) -> -1
729 * index_name_pos(&index, "b", 1) -> 0
730 * index_name_pos(&index, "c", 1) -> -2
731 * index_name_pos(&index, "d", 1) -> 1
732 * index_name_pos(&index, "e", 1) -> -3
733 * index_name_pos(&index, "f", 1) -> -3
734 * index_name_pos(&index, "g", 1) -> -5
735 */
736 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
737
738 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
739 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
740 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
741 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
742 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
743 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
744 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
745 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
746
747 /* Remove entry, return true if there are more entries to go. */
748 extern int remove_index_entry_at(struct index_state *, int pos);
749
750 extern void remove_marked_cache_entries(struct index_state *istate);
751 extern int remove_file_from_index(struct index_state *, const char *path);
752 #define ADD_CACHE_VERBOSE 1
753 #define ADD_CACHE_PRETEND 2
754 #define ADD_CACHE_IGNORE_ERRORS 4
755 #define ADD_CACHE_IGNORE_REMOVAL 8
756 #define ADD_CACHE_INTENT 16
757 /*
758 * These two are used to add the contents of the file at path
759 * to the index, marking the working tree up-to-date by storing
760 * the cached stat info in the resulting cache entry. A caller
761 * that has already run lstat(2) on the path can call
762 * add_to_index(), and all others can call add_file_to_index();
763 * the latter will do necessary lstat(2) internally before
764 * calling the former.
765 */
766 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
767 extern int add_file_to_index(struct index_state *, const char *path, int flags);
768
769 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
770 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
771 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
772 extern int index_name_is_other(const struct index_state *, const char *, int);
773 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
774
775 /* do stat comparison even if CE_VALID is true */
776 #define CE_MATCH_IGNORE_VALID 01
777 /* do not check the contents but report dirty on racily-clean entries */
778 #define CE_MATCH_RACY_IS_DIRTY 02
779 /* do stat comparison even if CE_SKIP_WORKTREE is true */
780 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
781 /* ignore non-existent files during stat update */
782 #define CE_MATCH_IGNORE_MISSING 0x08
783 /* enable stat refresh */
784 #define CE_MATCH_REFRESH 0x10
785 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
786 #define CE_MATCH_IGNORE_FSMONITOR 0X20
787 extern int is_racy_timestamp(const struct index_state *istate,
788 const struct cache_entry *ce);
789 extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
790 extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
791
792 #define HASH_WRITE_OBJECT 1
793 #define HASH_FORMAT_CHECK 2
794 #define HASH_RENORMALIZE 4
795 extern 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);
796 extern int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
797
798 /*
799 * Record to sd the data from st that we use to check whether a file
800 * might have changed.
801 */
802 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
803
804 /*
805 * Return 0 if st is consistent with a file not having been changed
806 * since sd was filled. If there are differences, return a
807 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
808 * INODE_CHANGED, and DATA_CHANGED.
809 */
810 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
811 extern int match_stat_data_racy(const struct index_state *istate,
812 const struct stat_data *sd, struct stat *st);
813
814 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
815
816 #define REFRESH_REALLY 0x0001 /* ignore_valid */
817 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
818 #define REFRESH_QUIET 0x0004 /* be quiet about it */
819 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
820 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
821 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
822 #define REFRESH_PROGRESS 0x0040 /* show progress bar if stderr is tty */
823 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
824 extern struct cache_entry *refresh_cache_entry(struct index_state *, struct cache_entry *, unsigned int);
825
826 extern void set_alternate_index_output(const char *);
827
828 extern int verify_index_checksum;
829 extern int verify_ce_order;
830
831 /* Environment bits from configuration mechanism */
832 extern int trust_executable_bit;
833 extern int trust_ctime;
834 extern int check_stat;
835 extern int quote_path_fully;
836 extern int has_symlinks;
837 extern int minimum_abbrev, default_abbrev;
838 extern int ignore_case;
839 extern int assume_unchanged;
840 extern int prefer_symlink_refs;
841 extern int warn_ambiguous_refs;
842 extern int warn_on_object_refname_ambiguity;
843 extern const char *apply_default_whitespace;
844 extern const char *apply_default_ignorewhitespace;
845 extern const char *git_attributes_file;
846 extern const char *git_hooks_path;
847 extern int zlib_compression_level;
848 extern int core_compression_level;
849 extern int pack_compression_level;
850 extern size_t packed_git_window_size;
851 extern size_t packed_git_limit;
852 extern size_t delta_base_cache_limit;
853 extern unsigned long big_file_threshold;
854 extern unsigned long pack_size_limit_cfg;
855
856 /*
857 * Accessors for the core.sharedrepository config which lazy-load the value
858 * from the config (if not already set). The "reset" function can be
859 * used to unset "set" or cached value, meaning that the value will be loaded
860 * fresh from the config file on the next call to get_shared_repository().
861 */
862 void set_shared_repository(int value);
863 int get_shared_repository(void);
864 void reset_shared_repository(void);
865
866 /*
867 * Do replace refs need to be checked this run? This variable is
868 * initialized to true unless --no-replace-object is used or
869 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
870 * commands that do not want replace references to be active.
871 */
872 extern int read_replace_refs;
873 extern char *git_replace_ref_base;
874
875 extern int fsync_object_files;
876 extern int core_preload_index;
877 extern int core_apply_sparse_checkout;
878 extern int precomposed_unicode;
879 extern int protect_hfs;
880 extern int protect_ntfs;
881 extern const char *core_fsmonitor;
882
883 /*
884 * Include broken refs in all ref iterations, which will
885 * generally choke dangerous operations rather than letting
886 * them silently proceed without taking the broken ref into
887 * account.
888 */
889 extern int ref_paranoia;
890
891 /*
892 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
893 */
894 int use_optional_locks(void);
895
896 /*
897 * The character that begins a commented line in user-editable file
898 * that is subject to stripspace.
899 */
900 extern char comment_line_char;
901 extern int auto_comment_line_char;
902
903 enum log_refs_config {
904 LOG_REFS_UNSET = -1,
905 LOG_REFS_NONE = 0,
906 LOG_REFS_NORMAL,
907 LOG_REFS_ALWAYS
908 };
909 extern enum log_refs_config log_all_ref_updates;
910
911 enum rebase_setup_type {
912 AUTOREBASE_NEVER = 0,
913 AUTOREBASE_LOCAL,
914 AUTOREBASE_REMOTE,
915 AUTOREBASE_ALWAYS
916 };
917
918 enum push_default_type {
919 PUSH_DEFAULT_NOTHING = 0,
920 PUSH_DEFAULT_MATCHING,
921 PUSH_DEFAULT_SIMPLE,
922 PUSH_DEFAULT_UPSTREAM,
923 PUSH_DEFAULT_CURRENT,
924 PUSH_DEFAULT_UNSPECIFIED
925 };
926
927 extern enum rebase_setup_type autorebase;
928 extern enum push_default_type push_default;
929
930 enum object_creation_mode {
931 OBJECT_CREATION_USES_HARDLINKS = 0,
932 OBJECT_CREATION_USES_RENAMES = 1
933 };
934
935 extern enum object_creation_mode object_creation_mode;
936
937 extern char *notes_ref_name;
938
939 extern int grafts_replace_parents;
940
941 /*
942 * GIT_REPO_VERSION is the version we write by default. The
943 * _READ variant is the highest number we know how to
944 * handle.
945 */
946 #define GIT_REPO_VERSION 0
947 #define GIT_REPO_VERSION_READ 1
948 extern int repository_format_precious_objects;
949 extern char *repository_format_partial_clone;
950 extern const char *core_partial_clone_filter_default;
951 extern int repository_format_worktree_config;
952
953 struct repository_format {
954 int version;
955 int precious_objects;
956 char *partial_clone; /* value of extensions.partialclone */
957 int worktree_config;
958 int is_bare;
959 int hash_algo;
960 char *work_tree;
961 struct string_list unknown_extensions;
962 };
963
964 /*
965 * Read the repository format characteristics from the config file "path" into
966 * "format" struct. Returns the numeric version. On error, -1 is returned,
967 * format->version is set to -1, and all other fields in the struct are
968 * undefined.
969 */
970 int read_repository_format(struct repository_format *format, const char *path);
971
972 /*
973 * Verify that the repository described by repository_format is something we
974 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
975 * any errors encountered.
976 */
977 int verify_repository_format(const struct repository_format *format,
978 struct strbuf *err);
979
980 /*
981 * Check the repository format version in the path found in get_git_dir(),
982 * and die if it is a version we don't understand. Generally one would
983 * set_git_dir() before calling this, and use it only for "are we in a valid
984 * repo?".
985 */
986 extern void check_repository_format(void);
987
988 #define MTIME_CHANGED 0x0001
989 #define CTIME_CHANGED 0x0002
990 #define OWNER_CHANGED 0x0004
991 #define MODE_CHANGED 0x0008
992 #define INODE_CHANGED 0x0010
993 #define DATA_CHANGED 0x0020
994 #define TYPE_CHANGED 0x0040
995
996 /*
997 * Return an abbreviated sha1 unique within this repository's object database.
998 * The result will be at least `len` characters long, and will be NUL
999 * terminated.
1000 *
1001 * The non-`_r` version returns a static buffer which remains valid until 4
1002 * more calls to find_unique_abbrev are made.
1003 *
1004 * The `_r` variant writes to a buffer supplied by the caller, which must be at
1005 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
1006 * written (excluding the NUL terminator).
1007 *
1008 * Note that while this version avoids the static buffer, it is not fully
1009 * reentrant, as it calls into other non-reentrant git code.
1010 */
1011 extern const char *find_unique_abbrev(const struct object_id *oid, int len);
1012 extern int find_unique_abbrev_r(char *hex, const struct object_id *oid, int len);
1013
1014 extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
1015 extern const struct object_id null_oid;
1016
1017 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
1018 {
1019 /*
1020 * This is a temporary optimization hack. By asserting the size here,
1021 * we let the compiler know that it's always going to be 20, which lets
1022 * it turn this fixed-size memcmp into a few inline instructions.
1023 *
1024 * This will need to be extended or ripped out when we learn about
1025 * hashes of different sizes.
1026 */
1027 if (the_hash_algo->rawsz != 20)
1028 BUG("hash size not yet supported by hashcmp");
1029 return memcmp(sha1, sha2, the_hash_algo->rawsz);
1030 }
1031
1032 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
1033 {
1034 return hashcmp(oid1->hash, oid2->hash);
1035 }
1036
1037 static inline int hasheq(const unsigned char *sha1, const unsigned char *sha2)
1038 {
1039 return !hashcmp(sha1, sha2);
1040 }
1041
1042 static inline int oideq(const struct object_id *oid1, const struct object_id *oid2)
1043 {
1044 return hasheq(oid1->hash, oid2->hash);
1045 }
1046
1047 static inline int is_null_sha1(const unsigned char *sha1)
1048 {
1049 return hasheq(sha1, null_sha1);
1050 }
1051
1052 static inline int is_null_oid(const struct object_id *oid)
1053 {
1054 return hasheq(oid->hash, null_sha1);
1055 }
1056
1057 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1058 {
1059 memcpy(sha_dst, sha_src, the_hash_algo->rawsz);
1060 }
1061
1062 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1063 {
1064 hashcpy(dst->hash, src->hash);
1065 }
1066
1067 static inline struct object_id *oiddup(const struct object_id *src)
1068 {
1069 struct object_id *dst = xmalloc(sizeof(struct object_id));
1070 oidcpy(dst, src);
1071 return dst;
1072 }
1073
1074 static inline void hashclr(unsigned char *hash)
1075 {
1076 memset(hash, 0, the_hash_algo->rawsz);
1077 }
1078
1079 static inline void oidclr(struct object_id *oid)
1080 {
1081 memset(oid->hash, 0, GIT_MAX_RAWSZ);
1082 }
1083
1084 static inline void oidread(struct object_id *oid, const unsigned char *hash)
1085 {
1086 memcpy(oid->hash, hash, the_hash_algo->rawsz);
1087 }
1088
1089 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1090 {
1091 return hasheq(sha1, the_hash_algo->empty_blob->hash);
1092 }
1093
1094 static inline int is_empty_blob_oid(const struct object_id *oid)
1095 {
1096 return oideq(oid, the_hash_algo->empty_blob);
1097 }
1098
1099 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1100 {
1101 return hasheq(sha1, the_hash_algo->empty_tree->hash);
1102 }
1103
1104 static inline int is_empty_tree_oid(const struct object_id *oid)
1105 {
1106 return oideq(oid, the_hash_algo->empty_tree);
1107 }
1108
1109 const char *empty_tree_oid_hex(void);
1110 const char *empty_blob_oid_hex(void);
1111
1112 /* set default permissions by passing mode arguments to open(2) */
1113 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1114 int git_mkstemp_mode(char *pattern, int mode);
1115
1116 /*
1117 * NOTE NOTE NOTE!!
1118 *
1119 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1120 * not be changed. Old repositories have core.sharedrepository written in
1121 * numeric format, and therefore these values are preserved for compatibility
1122 * reasons.
1123 */
1124 enum sharedrepo {
1125 PERM_UMASK = 0,
1126 OLD_PERM_GROUP = 1,
1127 OLD_PERM_EVERYBODY = 2,
1128 PERM_GROUP = 0660,
1129 PERM_EVERYBODY = 0664
1130 };
1131 int git_config_perm(const char *var, const char *value);
1132 int adjust_shared_perm(const char *path);
1133
1134 /*
1135 * Create the directory containing the named path, using care to be
1136 * somewhat safe against races. Return one of the scld_error values to
1137 * indicate success/failure. On error, set errno to describe the
1138 * problem.
1139 *
1140 * SCLD_VANISHED indicates that one of the ancestor directories of the
1141 * path existed at one point during the function call and then
1142 * suddenly vanished, probably because another process pruned the
1143 * directory while we were working. To be robust against this kind of
1144 * race, callers might want to try invoking the function again when it
1145 * returns SCLD_VANISHED.
1146 *
1147 * safe_create_leading_directories() temporarily changes path while it
1148 * is working but restores it before returning.
1149 * safe_create_leading_directories_const() doesn't modify path, even
1150 * temporarily.
1151 */
1152 enum scld_error {
1153 SCLD_OK = 0,
1154 SCLD_FAILED = -1,
1155 SCLD_PERMS = -2,
1156 SCLD_EXISTS = -3,
1157 SCLD_VANISHED = -4
1158 };
1159 enum scld_error safe_create_leading_directories(char *path);
1160 enum scld_error safe_create_leading_directories_const(const char *path);
1161
1162 /*
1163 * Callback function for raceproof_create_file(). This function is
1164 * expected to do something that makes dirname(path) permanent despite
1165 * the fact that other processes might be cleaning up empty
1166 * directories at the same time. Usually it will create a file named
1167 * path, but alternatively it could create another file in that
1168 * directory, or even chdir() into that directory. The function should
1169 * return 0 if the action was completed successfully. On error, it
1170 * should return a nonzero result and set errno.
1171 * raceproof_create_file() treats two errno values specially:
1172 *
1173 * - ENOENT -- dirname(path) does not exist. In this case,
1174 * raceproof_create_file() tries creating dirname(path)
1175 * (and any parent directories, if necessary) and calls
1176 * the function again.
1177 *
1178 * - EISDIR -- the file already exists and is a directory. In this
1179 * case, raceproof_create_file() removes the directory if
1180 * it is empty (and recursively any empty directories that
1181 * it contains) and calls the function again.
1182 *
1183 * Any other errno causes raceproof_create_file() to fail with the
1184 * callback's return value and errno.
1185 *
1186 * Obviously, this function should be OK with being called again if it
1187 * fails with ENOENT or EISDIR. In other scenarios it will not be
1188 * called again.
1189 */
1190 typedef int create_file_fn(const char *path, void *cb);
1191
1192 /*
1193 * Create a file in dirname(path) by calling fn, creating leading
1194 * directories if necessary. Retry a few times in case we are racing
1195 * with another process that is trying to clean up the directory that
1196 * contains path. See the documentation for create_file_fn for more
1197 * details.
1198 *
1199 * Return the value and set the errno that resulted from the most
1200 * recent call of fn. fn is always called at least once, and will be
1201 * called more than once if it returns ENOENT or EISDIR.
1202 */
1203 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1204
1205 int mkdir_in_gitdir(const char *path);
1206 extern char *expand_user_path(const char *path, int real_home);
1207 const char *enter_repo(const char *path, int strict);
1208 static inline int is_absolute_path(const char *path)
1209 {
1210 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1211 }
1212 int is_directory(const char *);
1213 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1214 int die_on_error);
1215 const char *real_path(const char *path);
1216 const char *real_path_if_valid(const char *path);
1217 char *real_pathdup(const char *path, int die_on_error);
1218 const char *absolute_path(const char *path);
1219 char *absolute_pathdup(const char *path);
1220 const char *remove_leading_path(const char *in, const char *prefix);
1221 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1222 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1223 int normalize_path_copy(char *dst, const char *src);
1224 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1225 char *strip_path_suffix(const char *path, const char *suffix);
1226 int daemon_avoid_alias(const char *path);
1227
1228 /*
1229 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1230 * details.
1231 */
1232 int is_ntfs_dotgit(const char *name);
1233 int is_ntfs_dotgitmodules(const char *name);
1234 int is_ntfs_dotgitignore(const char *name);
1235 int is_ntfs_dotgitattributes(const char *name);
1236
1237 /*
1238 * Returns true iff "str" could be confused as a command-line option when
1239 * passed to a sub-program like "ssh". Note that this has nothing to do with
1240 * shell-quoting, which should be handled separately; we're assuming here that
1241 * the string makes it verbatim to the sub-program.
1242 */
1243 int looks_like_command_line_option(const char *str);
1244
1245 /**
1246 * Return a newly allocated string with the evaluation of
1247 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1248 * "$HOME/.config/git/$filename". Return NULL upon error.
1249 */
1250 extern char *xdg_config_home(const char *filename);
1251
1252 /**
1253 * Return a newly allocated string with the evaluation of
1254 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1255 * "$HOME/.cache/git/$filename". Return NULL upon error.
1256 */
1257 extern char *xdg_cache_home(const char *filename);
1258
1259 extern int git_open_cloexec(const char *name, int flags);
1260 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1261 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1262 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1263
1264 extern int check_object_signature(const struct object_id *oid, void *buf, unsigned long size, const char *type);
1265
1266 extern int finalize_object_file(const char *tmpfile, const char *filename);
1267
1268 /* Helper to check and "touch" a file */
1269 extern int check_and_freshen_file(const char *fn, int freshen);
1270
1271 extern const signed char hexval_table[256];
1272 static inline unsigned int hexval(unsigned char c)
1273 {
1274 return hexval_table[c];
1275 }
1276
1277 /*
1278 * Convert two consecutive hexadecimal digits into a char. Return a
1279 * negative value on error. Don't run over the end of short strings.
1280 */
1281 static inline int hex2chr(const char *s)
1282 {
1283 unsigned int val = hexval(s[0]);
1284 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
1285 }
1286
1287 /* Convert to/from hex/sha1 representation */
1288 #define MINIMUM_ABBREV minimum_abbrev
1289 #define DEFAULT_ABBREV default_abbrev
1290
1291 /* used when the code does not know or care what the default abbrev is */
1292 #define FALLBACK_DEFAULT_ABBREV 7
1293
1294 struct object_context {
1295 unsigned mode;
1296 /*
1297 * symlink_path is only used by get_tree_entry_follow_symlinks,
1298 * and only for symlinks that point outside the repository.
1299 */
1300 struct strbuf symlink_path;
1301 /*
1302 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1303 * found when resolving the name. The caller is responsible for
1304 * releasing the memory.
1305 */
1306 char *path;
1307 };
1308
1309 #define GET_OID_QUIETLY 01
1310 #define GET_OID_COMMIT 02
1311 #define GET_OID_COMMITTISH 04
1312 #define GET_OID_TREE 010
1313 #define GET_OID_TREEISH 020
1314 #define GET_OID_BLOB 040
1315 #define GET_OID_FOLLOW_SYMLINKS 0100
1316 #define GET_OID_RECORD_PATH 0200
1317 #define GET_OID_ONLY_TO_DIE 04000
1318
1319 #define GET_OID_DISAMBIGUATORS \
1320 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1321 GET_OID_TREE | GET_OID_TREEISH | \
1322 GET_OID_BLOB)
1323
1324 extern int get_oid(const char *str, struct object_id *oid);
1325 extern int get_oid_commit(const char *str, struct object_id *oid);
1326 extern int get_oid_committish(const char *str, struct object_id *oid);
1327 extern int get_oid_tree(const char *str, struct object_id *oid);
1328 extern int get_oid_treeish(const char *str, struct object_id *oid);
1329 extern int get_oid_blob(const char *str, struct object_id *oid);
1330 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1331 extern int get_oid_with_context(struct repository *repo, const char *str,
1332 unsigned flags, struct object_id *oid,
1333 struct object_context *oc);
1334
1335
1336 typedef int each_abbrev_fn(const struct object_id *oid, void *);
1337 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1338
1339 extern int set_disambiguate_hint_config(const char *var, const char *value);
1340
1341 /*
1342 * Try to read a SHA1 in hexadecimal format from the 40 characters
1343 * starting at hex. Write the 20-byte result to sha1 in binary form.
1344 * Return 0 on success. Reading stops if a NUL is encountered in the
1345 * input, so it is safe to pass this function an arbitrary
1346 * null-terminated string.
1347 */
1348 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1349 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1350
1351 /*
1352 * Read `len` pairs of hexadecimal digits from `hex` and write the
1353 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1354 * the input does not consist of hex digits).
1355 */
1356 extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
1357
1358 /*
1359 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1360 * and writes the NUL-terminated output to the buffer `out`, which must be at
1361 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1362 * convenience.
1363 *
1364 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1365 * buffers, making it safe to make multiple calls for a single statement, like:
1366 *
1367 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1368 */
1369 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1370 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1371 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1372 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1373
1374 /*
1375 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1376 * pointer specified by end when parsing stops. The resulting object ID is
1377 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1378 * other invalid character. end is only updated on success; otherwise, it is
1379 * unmodified.
1380 */
1381 extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1382
1383 /*
1384 * This reads short-hand syntax that not only evaluates to a commit
1385 * object name, but also can act as if the end user spelled the name
1386 * of the branch from the command line.
1387 *
1388 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1389 * places the name of the branch in the given buf and returns the
1390 * number of characters parsed if successful.
1391 *
1392 * - "<branch>@{upstream}" finds the name of the other ref that
1393 * <branch> is configured to merge with (missing <branch> defaults
1394 * to the current branch), and places the name of the branch in the
1395 * given buf and returns the number of characters parsed if
1396 * successful.
1397 *
1398 * If the input is not of the accepted format, it returns a negative
1399 * number to signal an error.
1400 *
1401 * If the input was ok but there are not N branch switches in the
1402 * reflog, it returns 0.
1403 *
1404 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1405 * expansions: local branches ("refs/heads/"), remote branches
1406 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1407 * allowed, even ones to refs outside of those namespaces.
1408 */
1409 #define INTERPRET_BRANCH_LOCAL (1<<0)
1410 #define INTERPRET_BRANCH_REMOTE (1<<1)
1411 #define INTERPRET_BRANCH_HEAD (1<<2)
1412 extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1413 unsigned allowed);
1414 extern int get_oid_mb(const char *str, struct object_id *oid);
1415
1416 extern int validate_headref(const char *ref);
1417
1418 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1419 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1420 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1421 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1422
1423 extern void *read_object_with_reference(const struct object_id *oid,
1424 const char *required_type,
1425 unsigned long *size,
1426 struct object_id *oid_ret);
1427
1428 extern struct object *peel_to_type(const char *name, int namelen,
1429 struct object *o, enum object_type);
1430
1431 enum date_mode_type {
1432 DATE_NORMAL = 0,
1433 DATE_RELATIVE,
1434 DATE_SHORT,
1435 DATE_ISO8601,
1436 DATE_ISO8601_STRICT,
1437 DATE_RFC2822,
1438 DATE_STRFTIME,
1439 DATE_RAW,
1440 DATE_UNIX
1441 };
1442
1443 struct date_mode {
1444 enum date_mode_type type;
1445 const char *strftime_fmt;
1446 int local;
1447 };
1448
1449 /*
1450 * Convenience helper for passing a constant type, like:
1451 *
1452 * show_date(t, tz, DATE_MODE(NORMAL));
1453 */
1454 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1455 struct date_mode *date_mode_from_type(enum date_mode_type type);
1456
1457 const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1458 void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
1459 struct strbuf *timebuf);
1460 int parse_date(const char *date, struct strbuf *out);
1461 int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1462 int parse_expiry_date(const char *date, timestamp_t *timestamp);
1463 void datestamp(struct strbuf *out);
1464 #define approxidate(s) approxidate_careful((s), NULL)
1465 timestamp_t approxidate_careful(const char *, int *);
1466 timestamp_t approxidate_relative(const char *date, const struct timeval *now);
1467 void parse_date_format(const char *format, struct date_mode *mode);
1468 int date_overflows(timestamp_t date);
1469
1470 #define IDENT_STRICT 1
1471 #define IDENT_NO_DATE 2
1472 #define IDENT_NO_NAME 4
1473 extern const char *git_author_info(int);
1474 extern const char *git_committer_info(int);
1475 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1476 extern const char *fmt_name(const char *name, const char *email);
1477 extern const char *ident_default_name(void);
1478 extern const char *ident_default_email(void);
1479 extern const char *git_editor(void);
1480 extern const char *git_sequence_editor(void);
1481 extern const char *git_pager(int stdout_is_tty);
1482 extern int is_terminal_dumb(void);
1483 extern int git_ident_config(const char *, const char *, void *);
1484 extern void reset_ident_date(void);
1485
1486 struct ident_split {
1487 const char *name_begin;
1488 const char *name_end;
1489 const char *mail_begin;
1490 const char *mail_end;
1491 const char *date_begin;
1492 const char *date_end;
1493 const char *tz_begin;
1494 const char *tz_end;
1495 };
1496 /*
1497 * Signals an success with 0, but time part of the result may be NULL
1498 * if the input lacks timestamp and zone
1499 */
1500 extern int split_ident_line(struct ident_split *, const char *, int);
1501
1502 /*
1503 * Like show_date, but pull the timestamp and tz parameters from
1504 * the ident_split. It will also sanity-check the values and produce
1505 * a well-known sentinel date if they appear bogus.
1506 */
1507 const char *show_ident_date(const struct ident_split *id,
1508 const struct date_mode *mode);
1509
1510 /*
1511 * Compare split idents for equality or strict ordering. Note that we
1512 * compare only the ident part of the line, ignoring any timestamp.
1513 *
1514 * Because there are two fields, we must choose one as the primary key; we
1515 * currently arbitrarily pick the email.
1516 */
1517 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1518
1519 struct checkout {
1520 struct index_state *istate;
1521 const char *base_dir;
1522 int base_dir_len;
1523 struct delayed_checkout *delayed_checkout;
1524 unsigned force:1,
1525 quiet:1,
1526 not_new:1,
1527 clone:1,
1528 refresh_cache:1;
1529 };
1530 #define CHECKOUT_INIT { NULL, "" }
1531
1532 #define TEMPORARY_FILENAME_LENGTH 25
1533 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1534 extern void enable_delayed_checkout(struct checkout *state);
1535 extern int finish_delayed_checkout(struct checkout *state);
1536
1537 struct cache_def {
1538 struct strbuf path;
1539 int flags;
1540 int track_flags;
1541 int prefix_len_stat_func;
1542 };
1543 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1544 static inline void cache_def_clear(struct cache_def *cache)
1545 {
1546 strbuf_release(&cache->path);
1547 }
1548
1549 extern int has_symlink_leading_path(const char *name, int len);
1550 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1551 extern int check_leading_path(const char *name, int len);
1552 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1553 extern void schedule_dir_for_removal(const char *name, int len);
1554 extern void remove_scheduled_dirs(void);
1555
1556 struct pack_window {
1557 struct pack_window *next;
1558 unsigned char *base;
1559 off_t offset;
1560 size_t len;
1561 unsigned int last_used;
1562 unsigned int inuse_cnt;
1563 };
1564
1565 struct pack_entry {
1566 off_t offset;
1567 struct packed_git *p;
1568 };
1569
1570 /*
1571 * Create a temporary file rooted in the object database directory, or
1572 * die on failure. The filename is taken from "pattern", which should have the
1573 * usual "XXXXXX" trailer, and the resulting filename is written into the
1574 * "template" buffer. Returns the open descriptor.
1575 */
1576 extern int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);
1577
1578 /*
1579 * Create a pack .keep file named "name" (which should generally be the output
1580 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1581 * error.
1582 */
1583 extern int odb_pack_keep(const char *name);
1584
1585 /*
1586 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing
1587 * blobs. This has a difference only if extensions.partialClone is set.
1588 *
1589 * Its default value is 1.
1590 */
1591 extern int fetch_if_missing;
1592
1593 /* Dumb servers support */
1594 extern int update_server_info(int);
1595
1596 extern const char *get_log_output_encoding(void);
1597 extern const char *get_commit_output_encoding(void);
1598
1599 /*
1600 * This is a hack for test programs like test-dump-untracked-cache to
1601 * ensure that they do not modify the untracked cache when reading it.
1602 * Do not use it otherwise!
1603 */
1604 extern int ignore_untracked_cache_config;
1605
1606 extern int committer_ident_sufficiently_given(void);
1607 extern int author_ident_sufficiently_given(void);
1608
1609 extern const char *git_commit_encoding;
1610 extern const char *git_log_output_encoding;
1611 extern const char *git_mailmap_file;
1612 extern const char *git_mailmap_blob;
1613
1614 /* IO helper functions */
1615 extern void maybe_flush_or_die(FILE *, const char *);
1616 __attribute__((format (printf, 2, 3)))
1617 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1618
1619 #define COPY_READ_ERROR (-2)
1620 #define COPY_WRITE_ERROR (-3)
1621 extern int copy_fd(int ifd, int ofd);
1622 extern int copy_file(const char *dst, const char *src, int mode);
1623 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1624
1625 extern void write_or_die(int fd, const void *buf, size_t count);
1626 extern void fsync_or_die(int fd, const char *);
1627
1628 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1629 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1630 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1631
1632 static inline ssize_t write_str_in_full(int fd, const char *str)
1633 {
1634 return write_in_full(fd, str, strlen(str));
1635 }
1636
1637 /**
1638 * Open (and truncate) the file at path, write the contents of buf to it,
1639 * and close it. Dies if any errors are encountered.
1640 */
1641 extern void write_file_buf(const char *path, const char *buf, size_t len);
1642
1643 /**
1644 * Like write_file_buf(), but format the contents into a buffer first.
1645 * Additionally, write_file() will append a newline if one is not already
1646 * present, making it convenient to write text files:
1647 *
1648 * write_file(path, "counter: %d", ctr);
1649 */
1650 __attribute__((format (printf, 2, 3)))
1651 extern void write_file(const char *path, const char *fmt, ...);
1652
1653 /* pager.c */
1654 extern void setup_pager(void);
1655 extern int pager_in_use(void);
1656 extern int pager_use_color;
1657 extern int term_columns(void);
1658 extern int decimal_width(uintmax_t);
1659 extern int check_pager_config(const char *cmd);
1660 extern void prepare_pager_args(struct child_process *, const char *pager);
1661
1662 extern const char *editor_program;
1663 extern const char *askpass_program;
1664 extern const char *excludes_file;
1665
1666 /* base85 */
1667 int decode_85(char *dst, const char *line, int linelen);
1668 void encode_85(char *buf, const unsigned char *data, int bytes);
1669
1670 /* pkt-line.c */
1671 void packet_trace_identity(const char *prog);
1672
1673 /* add */
1674 /*
1675 * return 0 if success, 1 - if addition of a file failed and
1676 * ADD_FILES_IGNORE_ERRORS was specified in flags
1677 */
1678 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1679
1680 /* diff.c */
1681 extern int diff_auto_refresh_index;
1682
1683 /* match-trees.c */
1684 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1685 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1686
1687 /*
1688 * whitespace rules.
1689 * used by both diff and apply
1690 * last two digits are tab width
1691 */
1692 #define WS_BLANK_AT_EOL 0100
1693 #define WS_SPACE_BEFORE_TAB 0200
1694 #define WS_INDENT_WITH_NON_TAB 0400
1695 #define WS_CR_AT_EOL 01000
1696 #define WS_BLANK_AT_EOF 02000
1697 #define WS_TAB_IN_INDENT 04000
1698 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1699 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1700 #define WS_TAB_WIDTH_MASK 077
1701 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1702 #define WS_RULE_MASK 07777
1703 extern unsigned whitespace_rule_cfg;
1704 extern unsigned whitespace_rule(struct index_state *, const char *);
1705 extern unsigned parse_whitespace_rule(const char *);
1706 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1707 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1708 extern char *whitespace_error_string(unsigned ws);
1709 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1710 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1711 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1712
1713 /* ls-files */
1714 void overlay_tree_on_index(struct index_state *istate,
1715 const char *tree_name, const char *prefix);
1716
1717 /* setup.c */
1718 struct startup_info {
1719 int have_repository;
1720 const char *prefix;
1721 };
1722 extern struct startup_info *startup_info;
1723
1724 /* merge.c */
1725 struct commit_list;
1726 int try_merge_command(struct repository *r,
1727 const char *strategy, size_t xopts_nr,
1728 const char **xopts, struct commit_list *common,
1729 const char *head_arg, struct commit_list *remotes);
1730 int checkout_fast_forward(struct repository *r,
1731 const struct object_id *from,
1732 const struct object_id *to,
1733 int overwrite_ignore);
1734
1735
1736 int sane_execvp(const char *file, char *const argv[]);
1737
1738 /*
1739 * A struct to encapsulate the concept of whether a file has changed
1740 * since we last checked it. This uses criteria similar to those used
1741 * for the index.
1742 */
1743 struct stat_validity {
1744 struct stat_data *sd;
1745 };
1746
1747 void stat_validity_clear(struct stat_validity *sv);
1748
1749 /*
1750 * Returns 1 if the path is a regular file (or a symlink to a regular
1751 * file) and matches the saved stat_validity, 0 otherwise. A missing
1752 * or inaccessible file is considered a match if the struct was just
1753 * initialized, or if the previous update found an inaccessible file.
1754 */
1755 int stat_validity_check(struct stat_validity *sv, const char *path);
1756
1757 /*
1758 * Update the stat_validity from a file opened at descriptor fd. If
1759 * the file is missing, inaccessible, or not a regular file, then
1760 * future calls to stat_validity_check will match iff one of those
1761 * conditions continues to be true.
1762 */
1763 void stat_validity_update(struct stat_validity *sv, int fd);
1764
1765 int versioncmp(const char *s1, const char *s2);
1766 void sleep_millisec(int millisec);
1767
1768 /*
1769 * Create a directory and (if share is nonzero) adjust its permissions
1770 * according to the shared_repository setting. Only use this for
1771 * directories under $GIT_DIR. Don't use it for working tree
1772 * directories.
1773 */
1774 void safe_create_dir(const char *dir, int share);
1775
1776 /*
1777 * Should we print an ellipsis after an abbreviated SHA-1 value
1778 * when doing diff-raw output or indicating a detached HEAD?
1779 */
1780 extern int print_sha1_ellipsis(void);
1781
1782 #endif /* CACHE_H */