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