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