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