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