1#ifndef CACHE_H
2#define CACHE_H
3
4#include "git-compat-util.h"
5#include "strbuf.h"
6#include "hash.h"
7#include "advice.h"
8#include "gettext.h"
9#include "convert.h"
10
11#include SHA1_HEADER
12#ifndef git_SHA_CTX
13#define git_SHA_CTX SHA_CTX
14#define git_SHA1_Init SHA1_Init
15#define git_SHA1_Update SHA1_Update
16#define git_SHA1_Final SHA1_Final
17#endif
18
19#include <zlib.h>
20typedef struct git_zstream {
21 z_stream z;
22 unsigned long avail_in;
23 unsigned long avail_out;
24 unsigned long total_in;
25 unsigned long total_out;
26 unsigned char *next_in;
27 unsigned char *next_out;
28} git_zstream;
29
30void git_inflate_init(git_zstream *);
31void git_inflate_init_gzip_only(git_zstream *);
32void git_inflate_end(git_zstream *);
33int git_inflate(git_zstream *, int flush);
34
35void git_deflate_init(git_zstream *, int level);
36void git_deflate_init_gzip(git_zstream *, int level);
37void git_deflate_init_raw(git_zstream *, int level);
38void git_deflate_end(git_zstream *);
39int git_deflate_abort(git_zstream *);
40int git_deflate_end_gently(git_zstream *);
41int git_deflate(git_zstream *, int flush);
42unsigned long git_deflate_bound(git_zstream *, unsigned long);
43
44#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
45#define DTYPE(de) ((de)->d_type)
46#else
47#undef DT_UNKNOWN
48#undef DT_DIR
49#undef DT_REG
50#undef DT_LNK
51#define DT_UNKNOWN 0
52#define DT_DIR 1
53#define DT_REG 2
54#define DT_LNK 3
55#define DTYPE(de) DT_UNKNOWN
56#endif
57
58/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
59#define S_IFINVALID 0030000
60
61/*
62 * A "directory link" is a link to another git directory.
63 *
64 * The value 0160000 is not normally a valid mode, and
65 * also just happens to be S_IFDIR + S_IFLNK
66 *
67 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
68 * always having the same values everywhere. We should use
69 * our internal git values for these things, and then we can
70 * translate that to the OS-specific value. It just so
71 * happens that everybody shares the same bit representation
72 * in the UNIX world (and apparently wider too..)
73 */
74#define S_IFGITLINK 0160000
75#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
76
77/*
78 * Intensive research over the course of many years has shown that
79 * port 9418 is totally unused by anything else. Or
80 *
81 * Your search - "port 9418" - did not match any documents.
82 *
83 * as www.google.com puts it.
84 *
85 * This port has been properly assigned for git use by IANA:
86 * git (Assigned-9418) [I06-050728-0001].
87 *
88 * git 9418/tcp git pack transfer service
89 * git 9418/udp git pack transfer service
90 *
91 * with Linus Torvalds <torvalds@osdl.org> as the point of
92 * contact. September 2005.
93 *
94 * See http://www.iana.org/assignments/port-numbers
95 */
96#define DEFAULT_GIT_PORT 9418
97
98/*
99 * Basic data structures for the directory cache
100 */
101
102#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
103struct cache_header {
104 uint32_t hdr_signature;
105 uint32_t hdr_version;
106 uint32_t hdr_entries;
107};
108
109#define INDEX_FORMAT_LB 2
110#define INDEX_FORMAT_UB 4
111
112/*
113 * The "cache_time" is just the low 32 bits of the
114 * time. It doesn't matter if it overflows - we only
115 * check it for equality in the 32 bits we save.
116 */
117struct cache_time {
118 uint32_t sec;
119 uint32_t nsec;
120};
121
122struct stat_data {
123 struct cache_time sd_ctime;
124 struct cache_time sd_mtime;
125 unsigned int sd_dev;
126 unsigned int sd_ino;
127 unsigned int sd_uid;
128 unsigned int sd_gid;
129 unsigned int sd_size;
130};
131
132struct cache_entry {
133 struct stat_data ce_stat_data;
134 unsigned int ce_mode;
135 unsigned int ce_flags;
136 unsigned int ce_namelen;
137 unsigned char sha1[20];
138 struct cache_entry *next;
139 char name[FLEX_ARRAY]; /* more */
140};
141
142#define CE_STAGEMASK (0x3000)
143#define CE_EXTENDED (0x4000)
144#define CE_VALID (0x8000)
145#define CE_STAGESHIFT 12
146
147/*
148 * Range 0xFFFF0000 in ce_flags is divided into
149 * two parts: in-memory flags and on-disk ones.
150 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
151 * if you want to save a new flag, add it in
152 * CE_EXTENDED_FLAGS
153 *
154 * In-memory only flags
155 */
156#define CE_UPDATE (1 << 16)
157#define CE_REMOVE (1 << 17)
158#define CE_UPTODATE (1 << 18)
159#define CE_ADDED (1 << 19)
160
161#define CE_HASHED (1 << 20)
162#define CE_UNHASHED (1 << 21)
163#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
164#define CE_CONFLICTED (1 << 23)
165
166#define CE_UNPACKED (1 << 24)
167#define CE_NEW_SKIP_WORKTREE (1 << 25)
168
169/* used to temporarily mark paths matched by pathspecs */
170#define CE_MATCHED (1 << 26)
171
172/*
173 * Extended on-disk flags
174 */
175#define CE_INTENT_TO_ADD (1 << 29)
176#define CE_SKIP_WORKTREE (1 << 30)
177/* CE_EXTENDED2 is for future extension */
178#define CE_EXTENDED2 (1 << 31)
179
180#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
181
182/*
183 * Safeguard to avoid saving wrong flags:
184 * - CE_EXTENDED2 won't get saved until its semantic is known
185 * - Bits in 0x0000FFFF have been saved in ce_flags already
186 * - Bits in 0x003F0000 are currently in-memory flags
187 */
188#if CE_EXTENDED_FLAGS & 0x803FFFFF
189#error "CE_EXTENDED_FLAGS out of range"
190#endif
191
192struct pathspec;
193
194/*
195 * Copy the sha1 and stat state of a cache entry from one to
196 * another. But we never change the name, or the hash state!
197 */
198#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
199static inline void copy_cache_entry(struct cache_entry *dst,
200 const struct cache_entry *src)
201{
202 unsigned int state = dst->ce_flags & CE_STATE_MASK;
203
204 /* Don't copy hash chain and name */
205 memcpy(dst, src, offsetof(struct cache_entry, next));
206
207 /* Restore the hash state */
208 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
209}
210
211static inline unsigned create_ce_flags(unsigned stage)
212{
213 return (stage << CE_STAGESHIFT);
214}
215
216#define ce_namelen(ce) ((ce)->ce_namelen)
217#define ce_size(ce) cache_entry_size(ce_namelen(ce))
218#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
219#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
220#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
221#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
222
223#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
224static inline unsigned int create_ce_mode(unsigned int mode)
225{
226 if (S_ISLNK(mode))
227 return S_IFLNK;
228 if (S_ISDIR(mode) || S_ISGITLINK(mode))
229 return S_IFGITLINK;
230 return S_IFREG | ce_permissions(mode);
231}
232static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
233 unsigned int mode)
234{
235 extern int trust_executable_bit, has_symlinks;
236 if (!has_symlinks && S_ISREG(mode) &&
237 ce && S_ISLNK(ce->ce_mode))
238 return ce->ce_mode;
239 if (!trust_executable_bit && S_ISREG(mode)) {
240 if (ce && S_ISREG(ce->ce_mode))
241 return ce->ce_mode;
242 return create_ce_mode(0666);
243 }
244 return create_ce_mode(mode);
245}
246static inline int ce_to_dtype(const struct cache_entry *ce)
247{
248 unsigned ce_mode = ntohl(ce->ce_mode);
249 if (S_ISREG(ce_mode))
250 return DT_REG;
251 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
252 return DT_DIR;
253 else if (S_ISLNK(ce_mode))
254 return DT_LNK;
255 else
256 return DT_UNKNOWN;
257}
258static inline unsigned int canon_mode(unsigned int mode)
259{
260 if (S_ISREG(mode))
261 return S_IFREG | ce_permissions(mode);
262 if (S_ISLNK(mode))
263 return S_IFLNK;
264 if (S_ISDIR(mode))
265 return S_IFDIR;
266 return S_IFGITLINK;
267}
268
269#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
270
271struct index_state {
272 struct cache_entry **cache;
273 unsigned int version;
274 unsigned int cache_nr, cache_alloc, cache_changed;
275 struct string_list *resolve_undo;
276 struct cache_tree *cache_tree;
277 struct cache_time timestamp;
278 unsigned name_hash_initialized : 1,
279 initialized : 1;
280 struct hash_table name_hash;
281 struct hash_table dir_hash;
282};
283
284extern struct index_state the_index;
285
286/* Name hashing */
287extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
288extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
289extern void free_name_hash(struct index_state *istate);
290
291
292#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
293#define active_cache (the_index.cache)
294#define active_nr (the_index.cache_nr)
295#define active_alloc (the_index.cache_alloc)
296#define active_cache_changed (the_index.cache_changed)
297#define active_cache_tree (the_index.cache_tree)
298
299#define read_cache() read_index(&the_index)
300#define read_cache_from(path) read_index_from(&the_index, (path))
301#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
302#define is_cache_unborn() is_index_unborn(&the_index)
303#define read_cache_unmerged() read_index_unmerged(&the_index)
304#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
305#define discard_cache() discard_index(&the_index)
306#define unmerged_cache() unmerged_index(&the_index)
307#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
308#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
309#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
310#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
311#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
312#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
313#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
314#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
315#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
316#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
317#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
318#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
319#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
320#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
321#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
322#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
323#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
324#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
325#endif
326
327enum object_type {
328 OBJ_BAD = -1,
329 OBJ_NONE = 0,
330 OBJ_COMMIT = 1,
331 OBJ_TREE = 2,
332 OBJ_BLOB = 3,
333 OBJ_TAG = 4,
334 /* 5 for future expansion */
335 OBJ_OFS_DELTA = 6,
336 OBJ_REF_DELTA = 7,
337 OBJ_ANY,
338 OBJ_MAX
339};
340
341static inline enum object_type object_type(unsigned int mode)
342{
343 return S_ISDIR(mode) ? OBJ_TREE :
344 S_ISGITLINK(mode) ? OBJ_COMMIT :
345 OBJ_BLOB;
346}
347
348/* Double-check local_repo_env below if you add to this list. */
349#define GIT_DIR_ENVIRONMENT "GIT_DIR"
350#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
351#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
352#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
353#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
354#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
355#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
356#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
357#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
358#define CONFIG_ENVIRONMENT "GIT_CONFIG"
359#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
360#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
361#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
362#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
363#define GITATTRIBUTES_FILE ".gitattributes"
364#define INFOATTRIBUTES_FILE "info/attributes"
365#define ATTRIBUTE_MACRO_PREFIX "[attr]"
366#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
367#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
368#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
369#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
370#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
371#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
372#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
373#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
374#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
375
376/*
377 * This environment variable is expected to contain a boolean indicating
378 * whether we should or should not treat:
379 *
380 * GIT_DIR=foo.git git ...
381 *
382 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
383 * of this, but we use it internally to communicate to sub-processes that we
384 * are in a bare repo. If not set, defaults to true.
385 */
386#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
387
388/*
389 * Repository-local GIT_* environment variables; these will be cleared
390 * when git spawns a sub-process that runs inside another repository.
391 * The array is NULL-terminated, which makes it easy to pass in the "env"
392 * parameter of a run-command invocation, or to do a simple walk.
393 */
394extern const char * const local_repo_env[];
395
396extern int is_bare_repository_cfg;
397extern int is_bare_repository(void);
398extern int is_inside_git_dir(void);
399extern char *git_work_tree_cfg;
400extern int is_inside_work_tree(void);
401extern int have_git_dir(void);
402extern const char *get_git_dir(void);
403extern int is_git_directory(const char *path);
404extern char *get_object_directory(void);
405extern char *get_index_file(void);
406extern char *get_graft_file(void);
407extern int set_git_dir(const char *path);
408extern const char *get_git_namespace(void);
409extern const char *strip_namespace(const char *namespaced_ref);
410extern const char *get_git_work_tree(void);
411extern const char *read_gitfile(const char *path);
412extern const char *resolve_gitdir(const char *suspect);
413extern void set_git_work_tree(const char *tree);
414
415#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
416
417extern const char **get_pathspec(const char *prefix, const char **pathspec);
418extern void setup_work_tree(void);
419extern const char *setup_git_directory_gently(int *);
420extern const char *setup_git_directory(void);
421extern char *prefix_path(const char *prefix, int len, const char *path);
422extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
423extern const char *prefix_filename(const char *prefix, int len, const char *path);
424extern int check_filename(const char *prefix, const char *name);
425extern void verify_filename(const char *prefix,
426 const char *name,
427 int diagnose_misspelt_rev);
428extern void verify_non_filename(const char *prefix, const char *name);
429extern int path_inside_repo(const char *prefix, const char *path);
430
431#define INIT_DB_QUIET 0x0001
432
433extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
434extern int init_db(const char *template_dir, unsigned int flags);
435
436extern void sanitize_stdfds(void);
437
438#define alloc_nr(x) (((x)+16)*3/2)
439
440/*
441 * Realloc the buffer pointed at by variable 'x' so that it can hold
442 * at least 'nr' entries; the number of entries currently allocated
443 * is 'alloc', using the standard growing factor alloc_nr() macro.
444 *
445 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
446 */
447#define ALLOC_GROW(x, nr, alloc) \
448 do { \
449 if ((nr) > alloc) { \
450 if (alloc_nr(alloc) < (nr)) \
451 alloc = (nr); \
452 else \
453 alloc = alloc_nr(alloc); \
454 x = xrealloc((x), alloc * sizeof(*(x))); \
455 } \
456 } while (0)
457
458/* Initialize and use the cache information */
459extern int read_index(struct index_state *);
460extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
461extern int read_index_from(struct index_state *, const char *path);
462extern int is_index_unborn(struct index_state *);
463extern int read_index_unmerged(struct index_state *);
464extern int write_index(struct index_state *, int newfd);
465extern int discard_index(struct index_state *);
466extern int unmerged_index(const struct index_state *);
467extern int verify_path(const char *path);
468extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
469extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
470extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
471extern int index_name_pos(const struct index_state *, const char *name, int namelen);
472#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
473#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
474#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
475#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
476#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
477extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
478extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
479extern int remove_index_entry_at(struct index_state *, int pos);
480extern void remove_marked_cache_entries(struct index_state *istate);
481extern int remove_file_from_index(struct index_state *, const char *path);
482#define ADD_CACHE_VERBOSE 1
483#define ADD_CACHE_PRETEND 2
484#define ADD_CACHE_IGNORE_ERRORS 4
485#define ADD_CACHE_IGNORE_REMOVAL 8
486#define ADD_CACHE_INTENT 16
487#define ADD_CACHE_IMPLICIT_DOT 32 /* internal to "git add -u/-A" */
488extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
489extern int add_file_to_index(struct index_state *, const char *path, int flags);
490extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
491extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
492extern int index_name_is_other(const struct index_state *, const char *, int);
493extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
494
495/* do stat comparison even if CE_VALID is true */
496#define CE_MATCH_IGNORE_VALID 01
497/* do not check the contents but report dirty on racily-clean entries */
498#define CE_MATCH_RACY_IS_DIRTY 02
499/* do stat comparison even if CE_SKIP_WORKTREE is true */
500#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
501extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
502extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
503
504extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
505
506#define HASH_WRITE_OBJECT 1
507#define HASH_FORMAT_CHECK 2
508extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
509extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
510
511/*
512 * Record to sd the data from st that we use to check whether a file
513 * might have changed.
514 */
515extern void fill_stat_data(struct stat_data *sd, struct stat *st);
516
517/*
518 * Return 0 if st is consistent with a file not having been changed
519 * since sd was filled. If there are differences, return a
520 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
521 * INODE_CHANGED, and DATA_CHANGED.
522 */
523extern int match_stat_data(const struct stat_data *sd, struct stat *st);
524
525extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
526
527#define REFRESH_REALLY 0x0001 /* ignore_valid */
528#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
529#define REFRESH_QUIET 0x0004 /* be quiet about it */
530#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
531#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
532#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
533extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
534
535struct lock_file {
536 struct lock_file *next;
537 int fd;
538 pid_t owner;
539 char on_list;
540 char filename[PATH_MAX];
541};
542#define LOCK_DIE_ON_ERROR 1
543#define LOCK_NODEREF 2
544extern int unable_to_lock_error(const char *path, int err);
545extern NORETURN void unable_to_lock_index_die(const char *path, int err);
546extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
547extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
548extern int commit_lock_file(struct lock_file *);
549extern void update_index_if_able(struct index_state *, struct lock_file *);
550
551extern int hold_locked_index(struct lock_file *, int);
552extern int commit_locked_index(struct lock_file *);
553extern void set_alternate_index_output(const char *);
554extern int close_lock_file(struct lock_file *);
555extern void rollback_lock_file(struct lock_file *);
556extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
557
558/* Environment bits from configuration mechanism */
559extern int trust_executable_bit;
560extern int trust_ctime;
561extern int check_stat;
562extern int quote_path_fully;
563extern int has_symlinks;
564extern int minimum_abbrev, default_abbrev;
565extern int ignore_case;
566extern int assume_unchanged;
567extern int prefer_symlink_refs;
568extern int log_all_ref_updates;
569extern int warn_ambiguous_refs;
570extern int warn_on_object_refname_ambiguity;
571extern int shared_repository;
572extern const char *apply_default_whitespace;
573extern const char *apply_default_ignorewhitespace;
574extern const char *git_attributes_file;
575extern int zlib_compression_level;
576extern int core_compression_level;
577extern int core_compression_seen;
578extern size_t packed_git_window_size;
579extern size_t packed_git_limit;
580extern size_t delta_base_cache_limit;
581extern unsigned long big_file_threshold;
582extern unsigned long pack_size_limit_cfg;
583extern int read_replace_refs;
584extern int fsync_object_files;
585extern int core_preload_index;
586extern int core_apply_sparse_checkout;
587extern int precomposed_unicode;
588
589/*
590 * The character that begins a commented line in user-editable file
591 * that is subject to stripspace.
592 */
593extern char comment_line_char;
594
595enum branch_track {
596 BRANCH_TRACK_UNSPECIFIED = -1,
597 BRANCH_TRACK_NEVER = 0,
598 BRANCH_TRACK_REMOTE,
599 BRANCH_TRACK_ALWAYS,
600 BRANCH_TRACK_EXPLICIT,
601 BRANCH_TRACK_OVERRIDE
602};
603
604enum rebase_setup_type {
605 AUTOREBASE_NEVER = 0,
606 AUTOREBASE_LOCAL,
607 AUTOREBASE_REMOTE,
608 AUTOREBASE_ALWAYS
609};
610
611enum push_default_type {
612 PUSH_DEFAULT_NOTHING = 0,
613 PUSH_DEFAULT_MATCHING,
614 PUSH_DEFAULT_SIMPLE,
615 PUSH_DEFAULT_UPSTREAM,
616 PUSH_DEFAULT_CURRENT,
617 PUSH_DEFAULT_UNSPECIFIED
618};
619
620extern enum branch_track git_branch_track;
621extern enum rebase_setup_type autorebase;
622extern enum push_default_type push_default;
623
624enum object_creation_mode {
625 OBJECT_CREATION_USES_HARDLINKS = 0,
626 OBJECT_CREATION_USES_RENAMES = 1
627};
628
629extern enum object_creation_mode object_creation_mode;
630
631extern char *notes_ref_name;
632
633extern int grafts_replace_parents;
634
635#define GIT_REPO_VERSION 0
636extern int repository_format_version;
637extern int check_repository_format(void);
638
639#define MTIME_CHANGED 0x0001
640#define CTIME_CHANGED 0x0002
641#define OWNER_CHANGED 0x0004
642#define MODE_CHANGED 0x0008
643#define INODE_CHANGED 0x0010
644#define DATA_CHANGED 0x0020
645#define TYPE_CHANGED 0x0040
646
647extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
648 __attribute__((format (printf, 3, 4)));
649extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
650 __attribute__((format (printf, 3, 4)));
651extern char *git_pathdup(const char *fmt, ...)
652 __attribute__((format (printf, 1, 2)));
653extern char *mkpathdup(const char *fmt, ...)
654 __attribute__((format (printf, 1, 2)));
655
656/* Return a statically allocated filename matching the sha1 signature */
657extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
658extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
659extern char *git_path_submodule(const char *path, const char *fmt, ...)
660 __attribute__((format (printf, 2, 3)));
661
662extern char *sha1_file_name(const unsigned char *sha1);
663extern char *sha1_pack_name(const unsigned char *sha1);
664extern char *sha1_pack_index_name(const unsigned char *sha1);
665extern const char *find_unique_abbrev(const unsigned char *sha1, int);
666extern const unsigned char null_sha1[20];
667
668static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
669{
670 int i;
671
672 for (i = 0; i < 20; i++, sha1++, sha2++) {
673 if (*sha1 != *sha2)
674 return *sha1 - *sha2;
675 }
676
677 return 0;
678}
679
680static inline int is_null_sha1(const unsigned char *sha1)
681{
682 return !hashcmp(sha1, null_sha1);
683}
684
685static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
686{
687 memcpy(sha_dst, sha_src, 20);
688}
689static inline void hashclr(unsigned char *hash)
690{
691 memset(hash, 0, 20);
692}
693
694#define EMPTY_TREE_SHA1_HEX \
695 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
696#define EMPTY_TREE_SHA1_BIN_LITERAL \
697 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
698 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
699#define EMPTY_TREE_SHA1_BIN \
700 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
701
702#define EMPTY_BLOB_SHA1_HEX \
703 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
704#define EMPTY_BLOB_SHA1_BIN_LITERAL \
705 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
706 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
707#define EMPTY_BLOB_SHA1_BIN \
708 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
709
710static inline int is_empty_blob_sha1(const unsigned char *sha1)
711{
712 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
713}
714
715int git_mkstemp(char *path, size_t n, const char *template);
716
717int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
718
719/* set default permissions by passing mode arguments to open(2) */
720int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
721int git_mkstemp_mode(char *pattern, int mode);
722
723/*
724 * NOTE NOTE NOTE!!
725 *
726 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
727 * not be changed. Old repositories have core.sharedrepository written in
728 * numeric format, and therefore these values are preserved for compatibility
729 * reasons.
730 */
731enum sharedrepo {
732 PERM_UMASK = 0,
733 OLD_PERM_GROUP = 1,
734 OLD_PERM_EVERYBODY = 2,
735 PERM_GROUP = 0660,
736 PERM_EVERYBODY = 0664
737};
738int git_config_perm(const char *var, const char *value);
739int adjust_shared_perm(const char *path);
740int safe_create_leading_directories(char *path);
741int safe_create_leading_directories_const(const char *path);
742int mkdir_in_gitdir(const char *path);
743extern void home_config_paths(char **global, char **xdg, char *file);
744extern char *expand_user_path(const char *path);
745const char *enter_repo(const char *path, int strict);
746static inline int is_absolute_path(const char *path)
747{
748 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
749}
750int is_directory(const char *);
751const char *real_path(const char *path);
752const char *real_path_if_valid(const char *path);
753const char *absolute_path(const char *path);
754const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
755int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
756int normalize_path_copy(char *dst, const char *src);
757int longest_ancestor_length(const char *path, struct string_list *prefixes);
758char *strip_path_suffix(const char *path, const char *suffix);
759int daemon_avoid_alias(const char *path);
760int offset_1st_component(const char *path);
761
762/* object replacement */
763#define READ_SHA1_FILE_REPLACE 1
764extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
765static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
766{
767 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
768}
769extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
770static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
771{
772 if (!read_replace_refs)
773 return sha1;
774 return do_lookup_replace_object(sha1);
775}
776
777/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
778extern int sha1_object_info(const unsigned char *, unsigned long *);
779extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
780extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
781extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
782extern int force_object_loose(const unsigned char *sha1, time_t mtime);
783extern int git_open_noatime(const char *name);
784extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
785extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
786extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
787
788/* global flag to enable extra checks when accessing packed objects */
789extern int do_check_packed_object_crc;
790
791extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
792
793extern int move_temp_to_file(const char *tmpfile, const char *filename);
794
795extern int has_sha1_pack(const unsigned char *sha1);
796extern int has_sha1_file(const unsigned char *sha1);
797extern int has_loose_object_nonlocal(const unsigned char *sha1);
798
799extern int has_pack_index(const unsigned char *sha1);
800
801extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
802
803extern const signed char hexval_table[256];
804static inline unsigned int hexval(unsigned char c)
805{
806 return hexval_table[c];
807}
808
809/* Convert to/from hex/sha1 representation */
810#define MINIMUM_ABBREV minimum_abbrev
811#define DEFAULT_ABBREV default_abbrev
812
813struct object_context {
814 unsigned char tree[20];
815 char path[PATH_MAX];
816 unsigned mode;
817};
818
819#define GET_SHA1_QUIETLY 01
820#define GET_SHA1_COMMIT 02
821#define GET_SHA1_COMMITTISH 04
822#define GET_SHA1_TREE 010
823#define GET_SHA1_TREEISH 020
824#define GET_SHA1_BLOB 040
825#define GET_SHA1_ONLY_TO_DIE 04000
826
827extern int get_sha1(const char *str, unsigned char *sha1);
828extern int get_sha1_commit(const char *str, unsigned char *sha1);
829extern int get_sha1_committish(const char *str, unsigned char *sha1);
830extern int get_sha1_tree(const char *str, unsigned char *sha1);
831extern int get_sha1_treeish(const char *str, unsigned char *sha1);
832extern int get_sha1_blob(const char *str, unsigned char *sha1);
833extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
834extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
835
836typedef int each_abbrev_fn(const unsigned char *sha1, void *);
837extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
838
839/*
840 * Try to read a SHA1 in hexadecimal format from the 40 characters
841 * starting at hex. Write the 20-byte result to sha1 in binary form.
842 * Return 0 on success. Reading stops if a NUL is encountered in the
843 * input, so it is safe to pass this function an arbitrary
844 * null-terminated string.
845 */
846extern int get_sha1_hex(const char *hex, unsigned char *sha1);
847
848extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
849extern int read_ref_full(const char *refname, unsigned char *sha1,
850 int reading, int *flags);
851extern int read_ref(const char *refname, unsigned char *sha1);
852
853/*
854 * Resolve a reference, recursively following symbolic refererences.
855 *
856 * Store the referred-to object's name in sha1 and return the name of
857 * the non-symbolic reference that ultimately pointed at it. The
858 * return value, if not NULL, is a pointer into either a static buffer
859 * or the input ref.
860 *
861 * If the reference cannot be resolved to an object, the behavior
862 * depends on the "reading" argument:
863 *
864 * - If reading is set, return NULL.
865 *
866 * - If reading is not set, clear sha1 and return the name of the last
867 * reference name in the chain, which will either be a non-symbolic
868 * reference or an undefined reference. If this is a prelude to
869 * "writing" to the ref, the return value is the name of the ref
870 * that will actually be created or changed.
871 *
872 * If flag is non-NULL, set the value that it points to the
873 * combination of REF_ISPACKED (if the reference was found among the
874 * packed references) and REF_ISSYMREF (if the initial reference was a
875 * symbolic reference).
876 *
877 * If ref is not a properly-formatted, normalized reference, return
878 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
879 * give up and return NULL.
880 *
881 * errno is sometimes set on errors, but not always.
882 */
883extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
884extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
885
886extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
887extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
888extern int interpret_branch_name(const char *str, int len, struct strbuf *);
889extern int get_sha1_mb(const char *str, unsigned char *sha1);
890
891extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
892extern const char *ref_rev_parse_rules[];
893#define ref_fetch_rules ref_rev_parse_rules
894
895extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
896extern int validate_headref(const char *ref);
897
898extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
899extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
900extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
901extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
902
903extern void *read_object_with_reference(const unsigned char *sha1,
904 const char *required_type,
905 unsigned long *size,
906 unsigned char *sha1_ret);
907
908extern struct object *peel_to_type(const char *name, int namelen,
909 struct object *o, enum object_type);
910
911enum date_mode {
912 DATE_NORMAL = 0,
913 DATE_RELATIVE,
914 DATE_SHORT,
915 DATE_LOCAL,
916 DATE_ISO8601,
917 DATE_RFC2822,
918 DATE_RAW
919};
920
921const char *show_date(unsigned long time, int timezone, enum date_mode mode);
922void show_date_relative(unsigned long time, int tz, const struct timeval *now,
923 struct strbuf *timebuf);
924int parse_date(const char *date, char *buf, int bufsize);
925int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
926int parse_expiry_date(const char *date, unsigned long *timestamp);
927void datestamp(char *buf, int bufsize);
928#define approxidate(s) approxidate_careful((s), NULL)
929unsigned long approxidate_careful(const char *, int *);
930unsigned long approxidate_relative(const char *date, const struct timeval *now);
931enum date_mode parse_date_format(const char *format);
932
933#define IDENT_STRICT 1
934#define IDENT_NO_DATE 2
935#define IDENT_NO_NAME 4
936extern const char *git_author_info(int);
937extern const char *git_committer_info(int);
938extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
939extern const char *fmt_name(const char *name, const char *email);
940extern const char *ident_default_email(void);
941extern const char *git_editor(void);
942extern const char *git_pager(int stdout_is_tty);
943extern int git_ident_config(const char *, const char *, void *);
944
945struct ident_split {
946 const char *name_begin;
947 const char *name_end;
948 const char *mail_begin;
949 const char *mail_end;
950 const char *date_begin;
951 const char *date_end;
952 const char *tz_begin;
953 const char *tz_end;
954};
955/*
956 * Signals an success with 0, but time part of the result may be NULL
957 * if the input lacks timestamp and zone
958 */
959extern int split_ident_line(struct ident_split *, const char *, int);
960
961/*
962 * Compare split idents for equality or strict ordering. Note that we
963 * compare only the ident part of the line, ignoring any timestamp.
964 *
965 * Because there are two fields, we must choose one as the primary key; we
966 * currently arbitrarily pick the email.
967 */
968extern int ident_cmp(const struct ident_split *, const struct ident_split *);
969
970struct checkout {
971 const char *base_dir;
972 int base_dir_len;
973 unsigned force:1,
974 quiet:1,
975 not_new:1,
976 refresh_cache:1;
977};
978
979extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
980
981struct cache_def {
982 char path[PATH_MAX + 1];
983 int len;
984 int flags;
985 int track_flags;
986 int prefix_len_stat_func;
987};
988
989extern int has_symlink_leading_path(const char *name, int len);
990extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
991extern int check_leading_path(const char *name, int len);
992extern int has_dirs_only_path(const char *name, int len, int prefix_len);
993extern void schedule_dir_for_removal(const char *name, int len);
994extern void remove_scheduled_dirs(void);
995
996extern struct alternate_object_database {
997 struct alternate_object_database *next;
998 char *name;
999 char base[FLEX_ARRAY]; /* more */
1000} *alt_odb_list;
1001extern void prepare_alt_odb(void);
1002extern void read_info_alternates(const char * relative_base, int depth);
1003extern void add_to_alternates_file(const char *reference);
1004typedef int alt_odb_fn(struct alternate_object_database *, void *);
1005extern void foreach_alt_odb(alt_odb_fn, void*);
1006
1007struct pack_window {
1008 struct pack_window *next;
1009 unsigned char *base;
1010 off_t offset;
1011 size_t len;
1012 unsigned int last_used;
1013 unsigned int inuse_cnt;
1014};
1015
1016extern struct packed_git {
1017 struct packed_git *next;
1018 struct pack_window *windows;
1019 off_t pack_size;
1020 const void *index_data;
1021 size_t index_size;
1022 uint32_t num_objects;
1023 uint32_t num_bad_objects;
1024 unsigned char *bad_object_sha1;
1025 int index_version;
1026 time_t mtime;
1027 int pack_fd;
1028 unsigned pack_local:1,
1029 pack_keep:1,
1030 do_not_close:1;
1031 unsigned char sha1[20];
1032 /* something like ".git/objects/pack/xxxxx.pack" */
1033 char pack_name[FLEX_ARRAY]; /* more */
1034} *packed_git;
1035
1036struct pack_entry {
1037 off_t offset;
1038 unsigned char sha1[20];
1039 struct packed_git *p;
1040};
1041
1042extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1043
1044/* A hook for count-objects to report invalid files in pack directory */
1045extern void (*report_garbage)(const char *desc, const char *path);
1046
1047extern void prepare_packed_git(void);
1048extern void reprepare_packed_git(void);
1049extern void install_packed_git(struct packed_git *pack);
1050
1051extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1052 struct packed_git *packs);
1053
1054extern void pack_report(void);
1055extern int open_pack_index(struct packed_git *);
1056extern void close_pack_index(struct packed_git *);
1057extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1058extern void close_pack_windows(struct packed_git *);
1059extern void unuse_pack(struct pack_window **);
1060extern void free_pack_by_name(const char *);
1061extern void clear_delta_base_cache(void);
1062extern struct packed_git *add_packed_git(const char *, int, int);
1063extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1064extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1065extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1066extern int is_pack_valid(struct packed_git *);
1067extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1068extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1069extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1070extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1071
1072struct object_info {
1073 /* Request */
1074 enum object_type *typep;
1075 unsigned long *sizep;
1076 unsigned long *disk_sizep;
1077
1078 /* Response */
1079 enum {
1080 OI_CACHED,
1081 OI_LOOSE,
1082 OI_PACKED,
1083 OI_DBCACHED
1084 } whence;
1085 union {
1086 /*
1087 * struct {
1088 * ... Nothing to expose in this case
1089 * } cached;
1090 * struct {
1091 * ... Nothing to expose in this case
1092 * } loose;
1093 */
1094 struct {
1095 struct packed_git *pack;
1096 off_t offset;
1097 unsigned int is_delta;
1098 } packed;
1099 } u;
1100};
1101extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1102
1103/* Dumb servers support */
1104extern int update_server_info(int);
1105
1106/* git_config_parse_key() returns these negated: */
1107#define CONFIG_INVALID_KEY 1
1108#define CONFIG_NO_SECTION_OR_NAME 2
1109/* git_config_set(), git_config_set_multivar() return the above or these: */
1110#define CONFIG_NO_LOCK -1
1111#define CONFIG_INVALID_FILE 3
1112#define CONFIG_NO_WRITE 4
1113#define CONFIG_NOTHING_SET 5
1114#define CONFIG_INVALID_PATTERN 6
1115#define CONFIG_GENERIC_ERROR 7
1116
1117typedef int (*config_fn_t)(const char *, const char *, void *);
1118extern int git_default_config(const char *, const char *, void *);
1119extern int git_config_from_file(config_fn_t fn, const char *, void *);
1120extern int git_config_from_buf(config_fn_t fn, const char *name,
1121 const char *buf, size_t len, void *data);
1122extern void git_config_push_parameter(const char *text);
1123extern int git_config_from_parameters(config_fn_t fn, void *data);
1124extern int git_config(config_fn_t fn, void *);
1125extern int git_config_with_options(config_fn_t fn, void *,
1126 const char *filename,
1127 const char *blob_ref,
1128 int respect_includes);
1129extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1130extern int git_parse_ulong(const char *, unsigned long *);
1131extern int git_config_int(const char *, const char *);
1132extern int64_t git_config_int64(const char *, const char *);
1133extern unsigned long git_config_ulong(const char *, const char *);
1134extern int git_config_bool_or_int(const char *, const char *, int *);
1135extern int git_config_bool(const char *, const char *);
1136extern int git_config_maybe_bool(const char *, const char *);
1137extern int git_config_string(const char **, const char *, const char *);
1138extern int git_config_pathname(const char **, const char *, const char *);
1139extern int git_config_set_in_file(const char *, const char *, const char *);
1140extern int git_config_set(const char *, const char *);
1141extern int git_config_parse_key(const char *, char **, int *);
1142extern int git_config_set_multivar(const char *, const char *, const char *, int);
1143extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1144extern int git_config_rename_section(const char *, const char *);
1145extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1146extern const char *git_etc_gitconfig(void);
1147extern int check_repository_format_version(const char *var, const char *value, void *cb);
1148extern int git_env_bool(const char *, int);
1149extern int git_config_system(void);
1150extern int config_error_nonbool(const char *);
1151#if defined(__GNUC__) && ! defined(__clang__)
1152#define config_error_nonbool(s) (config_error_nonbool(s), -1)
1153#endif
1154extern const char *get_log_output_encoding(void);
1155extern const char *get_commit_output_encoding(void);
1156
1157extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1158
1159struct config_include_data {
1160 int depth;
1161 config_fn_t fn;
1162 void *data;
1163};
1164#define CONFIG_INCLUDE_INIT { 0 }
1165extern int git_config_include(const char *name, const char *value, void *data);
1166
1167/*
1168 * Match and parse a config key of the form:
1169 *
1170 * section.(subsection.)?key
1171 *
1172 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1173 * we return -1 if it does not match, 0 otherwise. The subsection and key
1174 * out-parameters are filled by the function (and subsection is NULL if it is
1175 * missing).
1176 */
1177extern int parse_config_key(const char *var,
1178 const char *section,
1179 const char **subsection, int *subsection_len,
1180 const char **key);
1181
1182extern int committer_ident_sufficiently_given(void);
1183extern int author_ident_sufficiently_given(void);
1184
1185extern const char *git_commit_encoding;
1186extern const char *git_log_output_encoding;
1187extern const char *git_mailmap_file;
1188extern const char *git_mailmap_blob;
1189
1190/* IO helper functions */
1191extern void maybe_flush_or_die(FILE *, const char *);
1192extern int copy_fd(int ifd, int ofd);
1193extern int copy_file(const char *dst, const char *src, int mode);
1194extern int copy_file_with_time(const char *dst, const char *src, int mode);
1195extern void write_or_die(int fd, const void *buf, size_t count);
1196extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1197extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1198extern void fsync_or_die(int fd, const char *);
1199
1200extern ssize_t read_in_full(int fd, void *buf, size_t count);
1201extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1202static inline ssize_t write_str_in_full(int fd, const char *str)
1203{
1204 return write_in_full(fd, str, strlen(str));
1205}
1206
1207/* pager.c */
1208extern void setup_pager(void);
1209extern const char *pager_program;
1210extern int pager_in_use(void);
1211extern int pager_use_color;
1212extern int term_columns(void);
1213extern int decimal_width(int);
1214extern int check_pager_config(const char *cmd);
1215
1216extern const char *editor_program;
1217extern const char *askpass_program;
1218extern const char *excludes_file;
1219
1220/* base85 */
1221int decode_85(char *dst, const char *line, int linelen);
1222void encode_85(char *buf, const unsigned char *data, int bytes);
1223
1224/* alloc.c */
1225extern void *alloc_blob_node(void);
1226extern void *alloc_tree_node(void);
1227extern void *alloc_commit_node(void);
1228extern void *alloc_tag_node(void);
1229extern void *alloc_object_node(void);
1230extern void alloc_report(void);
1231
1232/* trace.c */
1233__attribute__((format (printf, 1, 2)))
1234extern void trace_printf(const char *format, ...);
1235__attribute__((format (printf, 2, 3)))
1236extern void trace_argv_printf(const char **argv, const char *format, ...);
1237extern void trace_repo_setup(const char *prefix);
1238extern int trace_want(const char *key);
1239extern void trace_strbuf(const char *key, const struct strbuf *buf);
1240
1241void packet_trace_identity(const char *prog);
1242
1243/* add */
1244/*
1245 * return 0 if success, 1 - if addition of a file failed and
1246 * ADD_FILES_IGNORE_ERRORS was specified in flags
1247 */
1248int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1249
1250/* diff.c */
1251extern int diff_auto_refresh_index;
1252
1253/* match-trees.c */
1254void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1255void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1256
1257/*
1258 * whitespace rules.
1259 * used by both diff and apply
1260 * last two digits are tab width
1261 */
1262#define WS_BLANK_AT_EOL 0100
1263#define WS_SPACE_BEFORE_TAB 0200
1264#define WS_INDENT_WITH_NON_TAB 0400
1265#define WS_CR_AT_EOL 01000
1266#define WS_BLANK_AT_EOF 02000
1267#define WS_TAB_IN_INDENT 04000
1268#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1269#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1270#define WS_TAB_WIDTH_MASK 077
1271extern unsigned whitespace_rule_cfg;
1272extern unsigned whitespace_rule(const char *);
1273extern unsigned parse_whitespace_rule(const char *);
1274extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1275extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1276extern char *whitespace_error_string(unsigned ws);
1277extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1278extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1279#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1280
1281/* ls-files */
1282int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
1283void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1284
1285char *alias_lookup(const char *alias);
1286int split_cmdline(char *cmdline, const char ***argv);
1287/* Takes a negative value returned by split_cmdline */
1288const char *split_cmdline_strerror(int cmdline_errno);
1289
1290/* git.c */
1291struct startup_info {
1292 int have_repository;
1293 const char *prefix;
1294};
1295extern struct startup_info *startup_info;
1296
1297/* merge.c */
1298struct commit_list;
1299int try_merge_command(const char *strategy, size_t xopts_nr,
1300 const char **xopts, struct commit_list *common,
1301 const char *head_arg, struct commit_list *remotes);
1302int checkout_fast_forward(const unsigned char *from,
1303 const unsigned char *to,
1304 int overwrite_ignore);
1305
1306
1307int sane_execvp(const char *file, char *const argv[]);
1308
1309/*
1310 * A struct to encapsulate the concept of whether a file has changed
1311 * since we last checked it. This uses criteria similar to those used
1312 * for the index.
1313 */
1314struct stat_validity {
1315 struct stat_data *sd;
1316};
1317
1318void stat_validity_clear(struct stat_validity *sv);
1319
1320/*
1321 * Returns 1 if the path is a regular file (or a symlink to a regular
1322 * file) and matches the saved stat_validity, 0 otherwise. A missing
1323 * or inaccessible file is considered a match if the struct was just
1324 * initialized, or if the previous update found an inaccessible file.
1325 */
1326int stat_validity_check(struct stat_validity *sv, const char *path);
1327
1328/*
1329 * Update the stat_validity from a file opened at descriptor fd. If
1330 * the file is missing, inaccessible, or not a regular file, then
1331 * future calls to stat_validity_check will match iff one of those
1332 * conditions continues to be true.
1333 */
1334void stat_validity_update(struct stat_validity *sv, int fd);
1335
1336#endif /* CACHE_H */