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