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