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