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