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 "advice.h"
8#include "gettext.h"
9#include "convert.h"
10#include "trace.h"
11#include "string-list.h"
12
13#include SHA1_HEADER
14#ifndef git_SHA_CTX
15#define git_SHA_CTX SHA_CTX
16#define git_SHA1_Init SHA1_Init
17#define git_SHA1_Update SHA1_Update
18#define git_SHA1_Final SHA1_Final
19#endif
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/* The length in bytes and in hex digits of an object name (SHA-1 value). */
47#define GIT_SHA1_RAWSZ 20
48#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
49
50struct object_id {
51 unsigned char hash[GIT_SHA1_RAWSZ];
52};
53
54#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
55#define DTYPE(de) ((de)->d_type)
56#else
57#undef DT_UNKNOWN
58#undef DT_DIR
59#undef DT_REG
60#undef DT_LNK
61#define DT_UNKNOWN 0
62#define DT_DIR 1
63#define DT_REG 2
64#define DT_LNK 3
65#define DTYPE(de) DT_UNKNOWN
66#endif
67
68/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
69#define S_IFINVALID 0030000
70
71/*
72 * A "directory link" is a link to another git directory.
73 *
74 * The value 0160000 is not normally a valid mode, and
75 * also just happens to be S_IFDIR + S_IFLNK
76 */
77#define S_IFGITLINK 0160000
78#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
79
80/*
81 * Some mode bits are also used internally for computations.
82 *
83 * They *must* not overlap with any valid modes, and they *must* not be emitted
84 * to outside world - i.e. appear on disk or network. In other words, it's just
85 * temporary fields, which we internally use, but they have to stay in-house.
86 *
87 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
88 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
89 */
90
91/* used internally in tree-diff */
92#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
93
94
95/*
96 * Intensive research over the course of many years has shown that
97 * port 9418 is totally unused by anything else. Or
98 *
99 * Your search - "port 9418" - did not match any documents.
100 *
101 * as www.google.com puts it.
102 *
103 * This port has been properly assigned for git use by IANA:
104 * git (Assigned-9418) [I06-050728-0001].
105 *
106 * git 9418/tcp git pack transfer service
107 * git 9418/udp git pack transfer service
108 *
109 * with Linus Torvalds <torvalds@osdl.org> as the point of
110 * contact. September 2005.
111 *
112 * See http://www.iana.org/assignments/port-numbers
113 */
114#define DEFAULT_GIT_PORT 9418
115
116/*
117 * Basic data structures for the directory cache
118 */
119
120#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
121struct cache_header {
122 uint32_t hdr_signature;
123 uint32_t hdr_version;
124 uint32_t hdr_entries;
125};
126
127#define INDEX_FORMAT_LB 2
128#define INDEX_FORMAT_UB 4
129
130/*
131 * The "cache_time" is just the low 32 bits of the
132 * time. It doesn't matter if it overflows - we only
133 * check it for equality in the 32 bits we save.
134 */
135struct cache_time {
136 uint32_t sec;
137 uint32_t nsec;
138};
139
140struct stat_data {
141 struct cache_time sd_ctime;
142 struct cache_time sd_mtime;
143 unsigned int sd_dev;
144 unsigned int sd_ino;
145 unsigned int sd_uid;
146 unsigned int sd_gid;
147 unsigned int sd_size;
148};
149
150struct cache_entry {
151 struct hashmap_entry ent;
152 struct stat_data ce_stat_data;
153 unsigned int ce_mode;
154 unsigned int ce_flags;
155 unsigned int ce_namelen;
156 unsigned int index; /* for link extension */
157 unsigned char sha1[20];
158 char name[FLEX_ARRAY]; /* more */
159};
160
161#define CE_STAGEMASK (0x3000)
162#define CE_EXTENDED (0x4000)
163#define CE_VALID (0x8000)
164#define CE_STAGESHIFT 12
165
166/*
167 * Range 0xFFFF0FFF in ce_flags is divided into
168 * two parts: in-memory flags and on-disk ones.
169 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
170 * if you want to save a new flag, add it in
171 * CE_EXTENDED_FLAGS
172 *
173 * In-memory only flags
174 */
175#define CE_UPDATE (1 << 16)
176#define CE_REMOVE (1 << 17)
177#define CE_UPTODATE (1 << 18)
178#define CE_ADDED (1 << 19)
179
180#define CE_HASHED (1 << 20)
181#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
182#define CE_CONFLICTED (1 << 23)
183
184#define CE_UNPACKED (1 << 24)
185#define CE_NEW_SKIP_WORKTREE (1 << 25)
186
187/* used to temporarily mark paths matched by pathspecs */
188#define CE_MATCHED (1 << 26)
189
190#define CE_UPDATE_IN_BASE (1 << 27)
191#define CE_STRIP_NAME (1 << 28)
192
193/*
194 * Extended on-disk flags
195 */
196#define CE_INTENT_TO_ADD (1 << 29)
197#define CE_SKIP_WORKTREE (1 << 30)
198/* CE_EXTENDED2 is for future extension */
199#define CE_EXTENDED2 (1 << 31)
200
201#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
202
203/*
204 * Safeguard to avoid saving wrong flags:
205 * - CE_EXTENDED2 won't get saved until its semantic is known
206 * - Bits in 0x0000FFFF have been saved in ce_flags already
207 * - Bits in 0x003F0000 are currently in-memory flags
208 */
209#if CE_EXTENDED_FLAGS & 0x803FFFFF
210#error "CE_EXTENDED_FLAGS out of range"
211#endif
212
213struct pathspec;
214
215/*
216 * Copy the sha1 and stat state of a cache entry from one to
217 * another. But we never change the name, or the hash state!
218 */
219static inline void copy_cache_entry(struct cache_entry *dst,
220 const struct cache_entry *src)
221{
222 unsigned int state = dst->ce_flags & CE_HASHED;
223
224 /* Don't copy hash chain and name */
225 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
226 offsetof(struct cache_entry, name) -
227 offsetof(struct cache_entry, ce_stat_data));
228
229 /* Restore the hash state */
230 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
231}
232
233static inline unsigned create_ce_flags(unsigned stage)
234{
235 return (stage << CE_STAGESHIFT);
236}
237
238#define ce_namelen(ce) ((ce)->ce_namelen)
239#define ce_size(ce) cache_entry_size(ce_namelen(ce))
240#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
241#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
242#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
243#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
244
245#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
246static inline unsigned int create_ce_mode(unsigned int mode)
247{
248 if (S_ISLNK(mode))
249 return S_IFLNK;
250 if (S_ISDIR(mode) || S_ISGITLINK(mode))
251 return S_IFGITLINK;
252 return S_IFREG | ce_permissions(mode);
253}
254static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
255 unsigned int mode)
256{
257 extern int trust_executable_bit, has_symlinks;
258 if (!has_symlinks && S_ISREG(mode) &&
259 ce && S_ISLNK(ce->ce_mode))
260 return ce->ce_mode;
261 if (!trust_executable_bit && S_ISREG(mode)) {
262 if (ce && S_ISREG(ce->ce_mode))
263 return ce->ce_mode;
264 return create_ce_mode(0666);
265 }
266 return create_ce_mode(mode);
267}
268static inline int ce_to_dtype(const struct cache_entry *ce)
269{
270 unsigned ce_mode = ntohl(ce->ce_mode);
271 if (S_ISREG(ce_mode))
272 return DT_REG;
273 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
274 return DT_DIR;
275 else if (S_ISLNK(ce_mode))
276 return DT_LNK;
277 else
278 return DT_UNKNOWN;
279}
280static inline unsigned int canon_mode(unsigned int mode)
281{
282 if (S_ISREG(mode))
283 return S_IFREG | ce_permissions(mode);
284 if (S_ISLNK(mode))
285 return S_IFLNK;
286 if (S_ISDIR(mode))
287 return S_IFDIR;
288 return S_IFGITLINK;
289}
290
291#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
292
293#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
294#define CE_ENTRY_CHANGED (1 << 1)
295#define CE_ENTRY_REMOVED (1 << 2)
296#define CE_ENTRY_ADDED (1 << 3)
297#define RESOLVE_UNDO_CHANGED (1 << 4)
298#define CACHE_TREE_CHANGED (1 << 5)
299#define SPLIT_INDEX_ORDERED (1 << 6)
300#define UNTRACKED_CHANGED (1 << 7)
301
302struct split_index;
303struct untracked_cache;
304
305struct index_state {
306 struct cache_entry **cache;
307 unsigned int version;
308 unsigned int cache_nr, cache_alloc, cache_changed;
309 struct string_list *resolve_undo;
310 struct cache_tree *cache_tree;
311 struct split_index *split_index;
312 struct cache_time timestamp;
313 unsigned name_hash_initialized : 1,
314 initialized : 1;
315 struct hashmap name_hash;
316 struct hashmap dir_hash;
317 unsigned char sha1[20];
318 struct untracked_cache *untracked;
319};
320
321extern struct index_state the_index;
322
323/* Name hashing */
324extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
325extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
326extern void free_name_hash(struct index_state *istate);
327
328
329#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
330#define active_cache (the_index.cache)
331#define active_nr (the_index.cache_nr)
332#define active_alloc (the_index.cache_alloc)
333#define active_cache_changed (the_index.cache_changed)
334#define active_cache_tree (the_index.cache_tree)
335
336#define read_cache() read_index(&the_index)
337#define read_cache_from(path) read_index_from(&the_index, (path))
338#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
339#define is_cache_unborn() is_index_unborn(&the_index)
340#define read_cache_unmerged() read_index_unmerged(&the_index)
341#define discard_cache() discard_index(&the_index)
342#define unmerged_cache() unmerged_index(&the_index)
343#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
344#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
345#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
346#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
347#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
348#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
349#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
350#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
351#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
352#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
353#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
354#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
355#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
356#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
357#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
358#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
359#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
360#endif
361
362enum object_type {
363 OBJ_BAD = -1,
364 OBJ_NONE = 0,
365 OBJ_COMMIT = 1,
366 OBJ_TREE = 2,
367 OBJ_BLOB = 3,
368 OBJ_TAG = 4,
369 /* 5 for future expansion */
370 OBJ_OFS_DELTA = 6,
371 OBJ_REF_DELTA = 7,
372 OBJ_ANY,
373 OBJ_MAX
374};
375
376static inline enum object_type object_type(unsigned int mode)
377{
378 return S_ISDIR(mode) ? OBJ_TREE :
379 S_ISGITLINK(mode) ? OBJ_COMMIT :
380 OBJ_BLOB;
381}
382
383/* Double-check local_repo_env below if you add to this list. */
384#define GIT_DIR_ENVIRONMENT "GIT_DIR"
385#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
386#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
387#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
388#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
389#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
390#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
391#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
392#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
393#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
394#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
395#define CONFIG_ENVIRONMENT "GIT_CONFIG"
396#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
397#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
398#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
399#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
400#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
401#define GITATTRIBUTES_FILE ".gitattributes"
402#define INFOATTRIBUTES_FILE "info/attributes"
403#define ATTRIBUTE_MACRO_PREFIX "[attr]"
404#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
405#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
406#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
407#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
408#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
409#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
410#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
411#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
412#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
413
414/*
415 * This environment variable is expected to contain a boolean indicating
416 * whether we should or should not treat:
417 *
418 * GIT_DIR=foo.git git ...
419 *
420 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
421 * of this, but we use it internally to communicate to sub-processes that we
422 * are in a bare repo. If not set, defaults to true.
423 */
424#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
425
426/*
427 * Repository-local GIT_* environment variables; these will be cleared
428 * when git spawns a sub-process that runs inside another repository.
429 * The array is NULL-terminated, which makes it easy to pass in the "env"
430 * parameter of a run-command invocation, or to do a simple walk.
431 */
432extern const char * const local_repo_env[];
433
434extern int is_bare_repository_cfg;
435extern int is_bare_repository(void);
436extern int is_inside_git_dir(void);
437extern char *git_work_tree_cfg;
438extern int is_inside_work_tree(void);
439extern const char *get_git_dir(void);
440extern const char *get_git_common_dir(void);
441extern int is_git_directory(const char *path);
442extern char *get_object_directory(void);
443extern char *get_index_file(void);
444extern char *get_graft_file(void);
445extern int set_git_dir(const char *path);
446extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
447extern int get_common_dir(struct strbuf *sb, const char *gitdir);
448extern const char *get_git_namespace(void);
449extern const char *strip_namespace(const char *namespaced_ref);
450extern const char *get_git_work_tree(void);
451
452#define READ_GITFILE_ERR_STAT_FAILED 1
453#define READ_GITFILE_ERR_NOT_A_FILE 2
454#define READ_GITFILE_ERR_OPEN_FAILED 3
455#define READ_GITFILE_ERR_READ_FAILED 4
456#define READ_GITFILE_ERR_INVALID_FORMAT 5
457#define READ_GITFILE_ERR_NO_PATH 6
458#define READ_GITFILE_ERR_NOT_A_REPO 7
459#define READ_GITFILE_ERR_TOO_LARGE 8
460extern const char *read_gitfile_gently(const char *path, int *return_error_code);
461#define read_gitfile(path) read_gitfile_gently((path), NULL)
462extern const char *resolve_gitdir(const char *suspect);
463extern void set_git_work_tree(const char *tree);
464
465#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
466
467extern const char **get_pathspec(const char *prefix, const char **pathspec);
468extern void setup_work_tree(void);
469extern const char *setup_git_directory_gently(int *);
470extern const char *setup_git_directory(void);
471extern char *prefix_path(const char *prefix, int len, const char *path);
472extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
473extern const char *prefix_filename(const char *prefix, int len, const char *path);
474extern int check_filename(const char *prefix, const char *name);
475extern void verify_filename(const char *prefix,
476 const char *name,
477 int diagnose_misspelt_rev);
478extern void verify_non_filename(const char *prefix, const char *name);
479extern int path_inside_repo(const char *prefix, const char *path);
480
481#define INIT_DB_QUIET 0x0001
482
483extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
484extern int init_db(const char *template_dir, unsigned int flags);
485
486extern void sanitize_stdfds(void);
487extern int daemonize(void);
488
489#define alloc_nr(x) (((x)+16)*3/2)
490
491/*
492 * Realloc the buffer pointed at by variable 'x' so that it can hold
493 * at least 'nr' entries; the number of entries currently allocated
494 * is 'alloc', using the standard growing factor alloc_nr() macro.
495 *
496 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
497 */
498#define ALLOC_GROW(x, nr, alloc) \
499 do { \
500 if ((nr) > alloc) { \
501 if (alloc_nr(alloc) < (nr)) \
502 alloc = (nr); \
503 else \
504 alloc = alloc_nr(alloc); \
505 REALLOC_ARRAY(x, alloc); \
506 } \
507 } while (0)
508
509/* Initialize and use the cache information */
510struct lock_file;
511extern int read_index(struct index_state *);
512extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
513extern int do_read_index(struct index_state *istate, const char *path,
514 int must_exist); /* for testting only! */
515extern int read_index_from(struct index_state *, const char *path);
516extern int is_index_unborn(struct index_state *);
517extern int read_index_unmerged(struct index_state *);
518#define COMMIT_LOCK (1 << 0)
519#define CLOSE_LOCK (1 << 1)
520extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
521extern int discard_index(struct index_state *);
522extern int unmerged_index(const struct index_state *);
523extern int verify_path(const char *path);
524extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
525extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
526extern int index_name_pos(const struct index_state *, const char *name, int namelen);
527#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
528#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
529#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
530#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
531#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
532#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
533extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
534extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
535extern int remove_index_entry_at(struct index_state *, int pos);
536extern void remove_marked_cache_entries(struct index_state *istate);
537extern int remove_file_from_index(struct index_state *, const char *path);
538#define ADD_CACHE_VERBOSE 1
539#define ADD_CACHE_PRETEND 2
540#define ADD_CACHE_IGNORE_ERRORS 4
541#define ADD_CACHE_IGNORE_REMOVAL 8
542#define ADD_CACHE_INTENT 16
543extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
544extern int add_file_to_index(struct index_state *, const char *path, int flags);
545extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
546extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
547extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
548extern int index_name_is_other(const struct index_state *, const char *, int);
549extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
550
551/* do stat comparison even if CE_VALID is true */
552#define CE_MATCH_IGNORE_VALID 01
553/* do not check the contents but report dirty on racily-clean entries */
554#define CE_MATCH_RACY_IS_DIRTY 02
555/* do stat comparison even if CE_SKIP_WORKTREE is true */
556#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
557/* ignore non-existent files during stat update */
558#define CE_MATCH_IGNORE_MISSING 0x08
559/* enable stat refresh */
560#define CE_MATCH_REFRESH 0x10
561extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
562extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
563
564#define HASH_WRITE_OBJECT 1
565#define HASH_FORMAT_CHECK 2
566extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
567extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
568
569/*
570 * Record to sd the data from st that we use to check whether a file
571 * might have changed.
572 */
573extern void fill_stat_data(struct stat_data *sd, struct stat *st);
574
575/*
576 * Return 0 if st is consistent with a file not having been changed
577 * since sd was filled. If there are differences, return a
578 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
579 * INODE_CHANGED, and DATA_CHANGED.
580 */
581extern int match_stat_data(const struct stat_data *sd, struct stat *st);
582extern int match_stat_data_racy(const struct index_state *istate,
583 const struct stat_data *sd, struct stat *st);
584
585extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
586
587#define REFRESH_REALLY 0x0001 /* ignore_valid */
588#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
589#define REFRESH_QUIET 0x0004 /* be quiet about it */
590#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
591#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
592#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
593extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
594
595extern void update_index_if_able(struct index_state *, struct lock_file *);
596
597extern int hold_locked_index(struct lock_file *, int);
598extern void set_alternate_index_output(const char *);
599
600/* Environment bits from configuration mechanism */
601extern int trust_executable_bit;
602extern int trust_ctime;
603extern int check_stat;
604extern int quote_path_fully;
605extern int has_symlinks;
606extern int minimum_abbrev, default_abbrev;
607extern int ignore_case;
608extern int assume_unchanged;
609extern int prefer_symlink_refs;
610extern int log_all_ref_updates;
611extern int warn_ambiguous_refs;
612extern int warn_on_object_refname_ambiguity;
613extern int shared_repository;
614extern const char *apply_default_whitespace;
615extern const char *apply_default_ignorewhitespace;
616extern const char *git_attributes_file;
617extern int zlib_compression_level;
618extern int core_compression_level;
619extern int core_compression_seen;
620extern size_t packed_git_window_size;
621extern size_t packed_git_limit;
622extern size_t delta_base_cache_limit;
623extern unsigned long big_file_threshold;
624extern unsigned long pack_size_limit_cfg;
625
626/*
627 * Do replace refs need to be checked this run? This variable is
628 * initialized to true unless --no-replace-object is used or
629 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
630 * commands that do not want replace references to be active. As an
631 * optimization it is also set to false if replace references have
632 * been sought but there were none.
633 */
634extern int check_replace_refs;
635extern char *git_replace_ref_base;
636
637extern int fsync_object_files;
638extern int core_preload_index;
639extern int core_apply_sparse_checkout;
640extern int precomposed_unicode;
641extern int protect_hfs;
642extern int protect_ntfs;
643extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
644
645/*
646 * Include broken refs in all ref iterations, which will
647 * generally choke dangerous operations rather than letting
648 * them silently proceed without taking the broken ref into
649 * account.
650 */
651extern int ref_paranoia;
652
653/*
654 * The character that begins a commented line in user-editable file
655 * that is subject to stripspace.
656 */
657extern char comment_line_char;
658extern int auto_comment_line_char;
659
660enum branch_track {
661 BRANCH_TRACK_UNSPECIFIED = -1,
662 BRANCH_TRACK_NEVER = 0,
663 BRANCH_TRACK_REMOTE,
664 BRANCH_TRACK_ALWAYS,
665 BRANCH_TRACK_EXPLICIT,
666 BRANCH_TRACK_OVERRIDE
667};
668
669enum rebase_setup_type {
670 AUTOREBASE_NEVER = 0,
671 AUTOREBASE_LOCAL,
672 AUTOREBASE_REMOTE,
673 AUTOREBASE_ALWAYS
674};
675
676enum push_default_type {
677 PUSH_DEFAULT_NOTHING = 0,
678 PUSH_DEFAULT_MATCHING,
679 PUSH_DEFAULT_SIMPLE,
680 PUSH_DEFAULT_UPSTREAM,
681 PUSH_DEFAULT_CURRENT,
682 PUSH_DEFAULT_UNSPECIFIED
683};
684
685extern enum branch_track git_branch_track;
686extern enum rebase_setup_type autorebase;
687extern enum push_default_type push_default;
688
689enum object_creation_mode {
690 OBJECT_CREATION_USES_HARDLINKS = 0,
691 OBJECT_CREATION_USES_RENAMES = 1
692};
693
694extern enum object_creation_mode object_creation_mode;
695
696extern char *notes_ref_name;
697
698extern int grafts_replace_parents;
699
700#define GIT_REPO_VERSION 0
701extern int repository_format_version;
702extern int check_repository_format(void);
703
704#define MTIME_CHANGED 0x0001
705#define CTIME_CHANGED 0x0002
706#define OWNER_CHANGED 0x0004
707#define MODE_CHANGED 0x0008
708#define INODE_CHANGED 0x0010
709#define DATA_CHANGED 0x0020
710#define TYPE_CHANGED 0x0040
711
712/*
713 * Return a statically allocated filename, either generically (mkpath), in
714 * the repository directory (git_path), or in a submodule's repository
715 * directory (git_path_submodule). In all cases, note that the result
716 * may be overwritten by another call to _any_ of the functions. Consider
717 * using the safer "dup" or "strbuf" formats below (in some cases, the
718 * unsafe versions have already been removed).
719 */
720extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
721extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
722
723extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
724 __attribute__((format (printf, 3, 4)));
725extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
726 __attribute__((format (printf, 2, 3)));
727extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
728 const char *fmt, ...)
729 __attribute__((format (printf, 3, 4)));
730extern char *git_pathdup(const char *fmt, ...)
731 __attribute__((format (printf, 1, 2)));
732extern char *mkpathdup(const char *fmt, ...)
733 __attribute__((format (printf, 1, 2)));
734extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
735 __attribute__((format (printf, 2, 3)));
736
737extern void report_linked_checkout_garbage(void);
738
739/*
740 * You can define a static memoized git path like:
741 *
742 * static GIT_PATH_FUNC(git_path_foo, "FOO");
743 *
744 * or use one of the global ones below.
745 */
746#define GIT_PATH_FUNC(func, filename) \
747 const char *func(void) \
748 { \
749 static char *ret; \
750 if (!ret) \
751 ret = git_pathdup(filename); \
752 return ret; \
753 }
754
755const char *git_path_cherry_pick_head(void);
756const char *git_path_revert_head(void);
757const char *git_path_squash_msg(void);
758const char *git_path_merge_msg(void);
759const char *git_path_merge_rr(void);
760const char *git_path_merge_mode(void);
761const char *git_path_merge_head(void);
762const char *git_path_fetch_head(void);
763const char *git_path_shallow(void);
764
765/*
766 * Return the name of the file in the local object database that would
767 * be used to store a loose object with the specified sha1. The
768 * return value is a pointer to a statically allocated buffer that is
769 * overwritten each time the function is called.
770 */
771extern const char *sha1_file_name(const unsigned char *sha1);
772
773/*
774 * Return the name of the (local) packfile with the specified sha1 in
775 * its name. The return value is a pointer to memory that is
776 * overwritten each time this function is called.
777 */
778extern char *sha1_pack_name(const unsigned char *sha1);
779
780/*
781 * Return the name of the (local) pack index file with the specified
782 * sha1 in its name. The return value is a pointer to memory that is
783 * overwritten each time this function is called.
784 */
785extern char *sha1_pack_index_name(const unsigned char *sha1);
786
787extern const char *find_unique_abbrev(const unsigned char *sha1, int);
788extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
789
790static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
791{
792 int i;
793
794 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
795 if (*sha1 != *sha2)
796 return *sha1 - *sha2;
797 }
798
799 return 0;
800}
801
802static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
803{
804 return hashcmp(oid1->hash, oid2->hash);
805}
806
807static inline int is_null_sha1(const unsigned char *sha1)
808{
809 return !hashcmp(sha1, null_sha1);
810}
811
812static inline int is_null_oid(const struct object_id *oid)
813{
814 return !hashcmp(oid->hash, null_sha1);
815}
816
817static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
818{
819 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
820}
821
822static inline void oidcpy(struct object_id *dst, const struct object_id *src)
823{
824 hashcpy(dst->hash, src->hash);
825}
826
827static inline void hashclr(unsigned char *hash)
828{
829 memset(hash, 0, GIT_SHA1_RAWSZ);
830}
831
832static inline void oidclr(struct object_id *oid)
833{
834 hashclr(oid->hash);
835}
836
837
838#define EMPTY_TREE_SHA1_HEX \
839 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
840#define EMPTY_TREE_SHA1_BIN_LITERAL \
841 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
842 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
843#define EMPTY_TREE_SHA1_BIN \
844 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
845
846#define EMPTY_BLOB_SHA1_HEX \
847 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
848#define EMPTY_BLOB_SHA1_BIN_LITERAL \
849 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
850 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
851#define EMPTY_BLOB_SHA1_BIN \
852 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
853
854static inline int is_empty_blob_sha1(const unsigned char *sha1)
855{
856 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
857}
858
859int git_mkstemp(char *path, size_t n, const char *template);
860
861int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
862
863/* set default permissions by passing mode arguments to open(2) */
864int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
865int git_mkstemp_mode(char *pattern, int mode);
866
867/*
868 * NOTE NOTE NOTE!!
869 *
870 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
871 * not be changed. Old repositories have core.sharedrepository written in
872 * numeric format, and therefore these values are preserved for compatibility
873 * reasons.
874 */
875enum sharedrepo {
876 PERM_UMASK = 0,
877 OLD_PERM_GROUP = 1,
878 OLD_PERM_EVERYBODY = 2,
879 PERM_GROUP = 0660,
880 PERM_EVERYBODY = 0664
881};
882int git_config_perm(const char *var, const char *value);
883int adjust_shared_perm(const char *path);
884
885/*
886 * Create the directory containing the named path, using care to be
887 * somewhat safe against races. Return one of the scld_error values
888 * to indicate success/failure.
889 *
890 * SCLD_VANISHED indicates that one of the ancestor directories of the
891 * path existed at one point during the function call and then
892 * suddenly vanished, probably because another process pruned the
893 * directory while we were working. To be robust against this kind of
894 * race, callers might want to try invoking the function again when it
895 * returns SCLD_VANISHED.
896 */
897enum scld_error {
898 SCLD_OK = 0,
899 SCLD_FAILED = -1,
900 SCLD_PERMS = -2,
901 SCLD_EXISTS = -3,
902 SCLD_VANISHED = -4
903};
904enum scld_error safe_create_leading_directories(char *path);
905enum scld_error safe_create_leading_directories_const(const char *path);
906
907int mkdir_in_gitdir(const char *path);
908extern char *expand_user_path(const char *path);
909const char *enter_repo(const char *path, int strict);
910static inline int is_absolute_path(const char *path)
911{
912 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
913}
914int is_directory(const char *);
915const char *real_path(const char *path);
916const char *real_path_if_valid(const char *path);
917const char *absolute_path(const char *path);
918const char *remove_leading_path(const char *in, const char *prefix);
919const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
920int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
921int normalize_path_copy(char *dst, const char *src);
922int longest_ancestor_length(const char *path, struct string_list *prefixes);
923char *strip_path_suffix(const char *path, const char *suffix);
924int daemon_avoid_alias(const char *path);
925extern int is_ntfs_dotgit(const char *name);
926
927/**
928 * Return a newly allocated string with the evaluation of
929 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
930 * "$HOME/.config/git/$filename". Return NULL upon error.
931 */
932extern char *xdg_config_home(const char *filename);
933
934/* object replacement */
935#define LOOKUP_REPLACE_OBJECT 1
936#define LOOKUP_UNKNOWN_OBJECT 2
937extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
938static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
939{
940 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
941}
942
943/*
944 * This internal function is only declared here for the benefit of
945 * lookup_replace_object(). Please do not call it directly.
946 */
947extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
948
949/*
950 * If object sha1 should be replaced, return the replacement object's
951 * name (replaced recursively, if necessary). The return value is
952 * either sha1 or a pointer to a permanently-allocated value. When
953 * object replacement is suppressed, always return sha1.
954 */
955static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
956{
957 if (!check_replace_refs)
958 return sha1;
959 return do_lookup_replace_object(sha1);
960}
961
962static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
963{
964 if (!(flag & LOOKUP_REPLACE_OBJECT))
965 return sha1;
966 return lookup_replace_object(sha1);
967}
968
969/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
970extern int sha1_object_info(const unsigned char *, unsigned long *);
971extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
972extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
973extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
974extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
975extern int force_object_loose(const unsigned char *sha1, time_t mtime);
976extern int git_open_noatime(const char *name);
977extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
978extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
979extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
980
981/* global flag to enable extra checks when accessing packed objects */
982extern int do_check_packed_object_crc;
983
984extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
985
986extern int finalize_object_file(const char *tmpfile, const char *filename);
987
988extern int has_sha1_pack(const unsigned char *sha1);
989
990/*
991 * Return true iff we have an object named sha1, whether local or in
992 * an alternate object database, and whether packed or loose. This
993 * function does not respect replace references.
994 *
995 * If the QUICK flag is set, do not re-check the pack directory
996 * when we cannot find the object (this means we may give a false
997 * negative answer if another process is simultaneously repacking).
998 */
999#define HAS_SHA1_QUICK 0x1
1000extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1001static inline int has_sha1_file(const unsigned char *sha1)
1002{
1003 return has_sha1_file_with_flags(sha1, 0);
1004}
1005
1006/*
1007 * Return true iff an alternate object database has a loose object
1008 * with the specified name. This function does not respect replace
1009 * references.
1010 */
1011extern int has_loose_object_nonlocal(const unsigned char *sha1);
1012
1013extern int has_pack_index(const unsigned char *sha1);
1014
1015extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1016
1017extern const signed char hexval_table[256];
1018static inline unsigned int hexval(unsigned char c)
1019{
1020 return hexval_table[c];
1021}
1022
1023/* Convert to/from hex/sha1 representation */
1024#define MINIMUM_ABBREV minimum_abbrev
1025#define DEFAULT_ABBREV default_abbrev
1026
1027struct object_context {
1028 unsigned char tree[20];
1029 char path[PATH_MAX];
1030 unsigned mode;
1031 /*
1032 * symlink_path is only used by get_tree_entry_follow_symlinks,
1033 * and only for symlinks that point outside the repository.
1034 */
1035 struct strbuf symlink_path;
1036};
1037
1038#define GET_SHA1_QUIETLY 01
1039#define GET_SHA1_COMMIT 02
1040#define GET_SHA1_COMMITTISH 04
1041#define GET_SHA1_TREE 010
1042#define GET_SHA1_TREEISH 020
1043#define GET_SHA1_BLOB 040
1044#define GET_SHA1_FOLLOW_SYMLINKS 0100
1045#define GET_SHA1_ONLY_TO_DIE 04000
1046
1047extern int get_sha1(const char *str, unsigned char *sha1);
1048extern int get_sha1_commit(const char *str, unsigned char *sha1);
1049extern int get_sha1_committish(const char *str, unsigned char *sha1);
1050extern int get_sha1_tree(const char *str, unsigned char *sha1);
1051extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1052extern int get_sha1_blob(const char *str, unsigned char *sha1);
1053extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1054extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1055
1056typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1057extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1058
1059/*
1060 * Try to read a SHA1 in hexadecimal format from the 40 characters
1061 * starting at hex. Write the 20-byte result to sha1 in binary form.
1062 * Return 0 on success. Reading stops if a NUL is encountered in the
1063 * input, so it is safe to pass this function an arbitrary
1064 * null-terminated string.
1065 */
1066extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1067extern int get_oid_hex(const char *hex, struct object_id *sha1);
1068
1069extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1070extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1071
1072extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1073extern int get_sha1_mb(const char *str, unsigned char *sha1);
1074
1075extern int validate_headref(const char *ref);
1076
1077extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1078extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1079extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1080extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1081
1082extern void *read_object_with_reference(const unsigned char *sha1,
1083 const char *required_type,
1084 unsigned long *size,
1085 unsigned char *sha1_ret);
1086
1087extern struct object *peel_to_type(const char *name, int namelen,
1088 struct object *o, enum object_type);
1089
1090struct date_mode {
1091 enum date_mode_type {
1092 DATE_NORMAL = 0,
1093 DATE_RELATIVE,
1094 DATE_SHORT,
1095 DATE_ISO8601,
1096 DATE_ISO8601_STRICT,
1097 DATE_RFC2822,
1098 DATE_STRFTIME,
1099 DATE_RAW
1100 } type;
1101 const char *strftime_fmt;
1102 int local;
1103};
1104
1105/*
1106 * Convenience helper for passing a constant type, like:
1107 *
1108 * show_date(t, tz, DATE_MODE(NORMAL));
1109 */
1110#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1111struct date_mode *date_mode_from_type(enum date_mode_type type);
1112
1113const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1114void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1115 struct strbuf *timebuf);
1116int parse_date(const char *date, struct strbuf *out);
1117int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1118int parse_expiry_date(const char *date, unsigned long *timestamp);
1119void datestamp(struct strbuf *out);
1120#define approxidate(s) approxidate_careful((s), NULL)
1121unsigned long approxidate_careful(const char *, int *);
1122unsigned long approxidate_relative(const char *date, const struct timeval *now);
1123void parse_date_format(const char *format, struct date_mode *mode);
1124int date_overflows(unsigned long date);
1125
1126#define IDENT_STRICT 1
1127#define IDENT_NO_DATE 2
1128#define IDENT_NO_NAME 4
1129extern const char *git_author_info(int);
1130extern const char *git_committer_info(int);
1131extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1132extern const char *fmt_name(const char *name, const char *email);
1133extern const char *ident_default_name(void);
1134extern const char *ident_default_email(void);
1135extern const char *git_editor(void);
1136extern const char *git_pager(int stdout_is_tty);
1137extern int git_ident_config(const char *, const char *, void *);
1138
1139struct ident_split {
1140 const char *name_begin;
1141 const char *name_end;
1142 const char *mail_begin;
1143 const char *mail_end;
1144 const char *date_begin;
1145 const char *date_end;
1146 const char *tz_begin;
1147 const char *tz_end;
1148};
1149/*
1150 * Signals an success with 0, but time part of the result may be NULL
1151 * if the input lacks timestamp and zone
1152 */
1153extern int split_ident_line(struct ident_split *, const char *, int);
1154
1155/*
1156 * Like show_date, but pull the timestamp and tz parameters from
1157 * the ident_split. It will also sanity-check the values and produce
1158 * a well-known sentinel date if they appear bogus.
1159 */
1160const char *show_ident_date(const struct ident_split *id,
1161 const struct date_mode *mode);
1162
1163/*
1164 * Compare split idents for equality or strict ordering. Note that we
1165 * compare only the ident part of the line, ignoring any timestamp.
1166 *
1167 * Because there are two fields, we must choose one as the primary key; we
1168 * currently arbitrarily pick the email.
1169 */
1170extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1171
1172struct checkout {
1173 struct index_state *istate;
1174 const char *base_dir;
1175 int base_dir_len;
1176 unsigned force:1,
1177 quiet:1,
1178 not_new:1,
1179 refresh_cache:1;
1180};
1181
1182#define TEMPORARY_FILENAME_LENGTH 25
1183extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1184
1185struct cache_def {
1186 struct strbuf path;
1187 int flags;
1188 int track_flags;
1189 int prefix_len_stat_func;
1190};
1191#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1192static inline void cache_def_clear(struct cache_def *cache)
1193{
1194 strbuf_release(&cache->path);
1195}
1196
1197extern int has_symlink_leading_path(const char *name, int len);
1198extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1199extern int check_leading_path(const char *name, int len);
1200extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1201extern void schedule_dir_for_removal(const char *name, int len);
1202extern void remove_scheduled_dirs(void);
1203
1204extern struct alternate_object_database {
1205 struct alternate_object_database *next;
1206 char *name;
1207 char base[FLEX_ARRAY]; /* more */
1208} *alt_odb_list;
1209extern void prepare_alt_odb(void);
1210extern void read_info_alternates(const char * relative_base, int depth);
1211extern void add_to_alternates_file(const char *reference);
1212typedef int alt_odb_fn(struct alternate_object_database *, void *);
1213extern int foreach_alt_odb(alt_odb_fn, void*);
1214
1215struct pack_window {
1216 struct pack_window *next;
1217 unsigned char *base;
1218 off_t offset;
1219 size_t len;
1220 unsigned int last_used;
1221 unsigned int inuse_cnt;
1222};
1223
1224extern struct packed_git {
1225 struct packed_git *next;
1226 struct pack_window *windows;
1227 off_t pack_size;
1228 const void *index_data;
1229 size_t index_size;
1230 uint32_t num_objects;
1231 uint32_t num_bad_objects;
1232 unsigned char *bad_object_sha1;
1233 int index_version;
1234 time_t mtime;
1235 int pack_fd;
1236 unsigned pack_local:1,
1237 pack_keep:1,
1238 freshened:1,
1239 do_not_close:1;
1240 unsigned char sha1[20];
1241 /* something like ".git/objects/pack/xxxxx.pack" */
1242 char pack_name[FLEX_ARRAY]; /* more */
1243} *packed_git;
1244
1245struct pack_entry {
1246 off_t offset;
1247 unsigned char sha1[20];
1248 struct packed_git *p;
1249};
1250
1251extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1252
1253/* A hook for count-objects to report invalid files in pack directory */
1254extern void (*report_garbage)(const char *desc, const char *path);
1255
1256extern void prepare_packed_git(void);
1257extern void reprepare_packed_git(void);
1258extern void install_packed_git(struct packed_git *pack);
1259
1260extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1261 struct packed_git *packs);
1262
1263extern void pack_report(void);
1264
1265/*
1266 * mmap the index file for the specified packfile (if it is not
1267 * already mmapped). Return 0 on success.
1268 */
1269extern int open_pack_index(struct packed_git *);
1270
1271/*
1272 * munmap the index file for the specified packfile (if it is
1273 * currently mmapped).
1274 */
1275extern void close_pack_index(struct packed_git *);
1276
1277extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1278extern void close_pack_windows(struct packed_git *);
1279extern void unuse_pack(struct pack_window **);
1280extern void free_pack_by_name(const char *);
1281extern void clear_delta_base_cache(void);
1282extern struct packed_git *add_packed_git(const char *, int, int);
1283
1284/*
1285 * Return the SHA-1 of the nth object within the specified packfile.
1286 * Open the index if it is not already open. The return value points
1287 * at the SHA-1 within the mmapped index. Return NULL if there is an
1288 * error.
1289 */
1290extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1291
1292/*
1293 * Return the offset of the nth object within the specified packfile.
1294 * The index must already be opened.
1295 */
1296extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1297
1298/*
1299 * If the object named sha1 is present in the specified packfile,
1300 * return its offset within the packfile; otherwise, return 0.
1301 */
1302extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1303
1304extern int is_pack_valid(struct packed_git *);
1305extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1306extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1307extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1308extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1309
1310/*
1311 * Iterate over the files in the loose-object parts of the object
1312 * directory "path", triggering the following callbacks:
1313 *
1314 * - loose_object is called for each loose object we find.
1315 *
1316 * - loose_cruft is called for any files that do not appear to be
1317 * loose objects. Note that we only look in the loose object
1318 * directories "objects/[0-9a-f]{2}/", so we will not report
1319 * "objects/foobar" as cruft.
1320 *
1321 * - loose_subdir is called for each top-level hashed subdirectory
1322 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1323 * after the objects in the directory are processed.
1324 *
1325 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1326 * will end the iteration.
1327 *
1328 * In the "buf" variant, "path" is a strbuf which will also be used as a
1329 * scratch buffer, but restored to its original contents before
1330 * the function returns.
1331 */
1332typedef int each_loose_object_fn(const unsigned char *sha1,
1333 const char *path,
1334 void *data);
1335typedef int each_loose_cruft_fn(const char *basename,
1336 const char *path,
1337 void *data);
1338typedef int each_loose_subdir_fn(int nr,
1339 const char *path,
1340 void *data);
1341int for_each_loose_file_in_objdir(const char *path,
1342 each_loose_object_fn obj_cb,
1343 each_loose_cruft_fn cruft_cb,
1344 each_loose_subdir_fn subdir_cb,
1345 void *data);
1346int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1347 each_loose_object_fn obj_cb,
1348 each_loose_cruft_fn cruft_cb,
1349 each_loose_subdir_fn subdir_cb,
1350 void *data);
1351
1352/*
1353 * Iterate over loose and packed objects in both the local
1354 * repository and any alternates repositories (unless the
1355 * LOCAL_ONLY flag is set).
1356 */
1357#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1358typedef int each_packed_object_fn(const unsigned char *sha1,
1359 struct packed_git *pack,
1360 uint32_t pos,
1361 void *data);
1362extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1363extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1364
1365struct object_info {
1366 /* Request */
1367 enum object_type *typep;
1368 unsigned long *sizep;
1369 unsigned long *disk_sizep;
1370 unsigned char *delta_base_sha1;
1371 struct strbuf *typename;
1372
1373 /* Response */
1374 enum {
1375 OI_CACHED,
1376 OI_LOOSE,
1377 OI_PACKED,
1378 OI_DBCACHED
1379 } whence;
1380 union {
1381 /*
1382 * struct {
1383 * ... Nothing to expose in this case
1384 * } cached;
1385 * struct {
1386 * ... Nothing to expose in this case
1387 * } loose;
1388 */
1389 struct {
1390 struct packed_git *pack;
1391 off_t offset;
1392 unsigned int is_delta;
1393 } packed;
1394 } u;
1395};
1396extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1397
1398/* Dumb servers support */
1399extern int update_server_info(int);
1400
1401/* git_config_parse_key() returns these negated: */
1402#define CONFIG_INVALID_KEY 1
1403#define CONFIG_NO_SECTION_OR_NAME 2
1404/* git_config_set(), git_config_set_multivar() return the above or these: */
1405#define CONFIG_NO_LOCK -1
1406#define CONFIG_INVALID_FILE 3
1407#define CONFIG_NO_WRITE 4
1408#define CONFIG_NOTHING_SET 5
1409#define CONFIG_INVALID_PATTERN 6
1410#define CONFIG_GENERIC_ERROR 7
1411
1412#define CONFIG_REGEX_NONE ((void *)1)
1413
1414struct git_config_source {
1415 unsigned int use_stdin:1;
1416 const char *file;
1417 const char *blob;
1418};
1419
1420typedef int (*config_fn_t)(const char *, const char *, void *);
1421extern int git_default_config(const char *, const char *, void *);
1422extern int git_config_from_file(config_fn_t fn, const char *, void *);
1423extern int git_config_from_buf(config_fn_t fn, const char *name,
1424 const char *buf, size_t len, void *data);
1425extern void git_config_push_parameter(const char *text);
1426extern int git_config_from_parameters(config_fn_t fn, void *data);
1427extern void git_config(config_fn_t fn, void *);
1428extern int git_config_with_options(config_fn_t fn, void *,
1429 struct git_config_source *config_source,
1430 int respect_includes);
1431extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1432extern int git_parse_ulong(const char *, unsigned long *);
1433extern int git_parse_maybe_bool(const char *);
1434extern int git_config_int(const char *, const char *);
1435extern int64_t git_config_int64(const char *, const char *);
1436extern unsigned long git_config_ulong(const char *, const char *);
1437extern int git_config_bool_or_int(const char *, const char *, int *);
1438extern int git_config_bool(const char *, const char *);
1439extern int git_config_maybe_bool(const char *, const char *);
1440extern int git_config_string(const char **, const char *, const char *);
1441extern int git_config_pathname(const char **, const char *, const char *);
1442extern int git_config_set_in_file(const char *, const char *, const char *);
1443extern int git_config_set(const char *, const char *);
1444extern int git_config_parse_key(const char *, char **, int *);
1445extern int git_config_key_is_valid(const char *key);
1446extern int git_config_set_multivar(const char *, const char *, const char *, int);
1447extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1448extern int git_config_rename_section(const char *, const char *);
1449extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1450extern const char *git_etc_gitconfig(void);
1451extern int check_repository_format_version(const char *var, const char *value, void *cb);
1452extern int git_env_bool(const char *, int);
1453extern unsigned long git_env_ulong(const char *, unsigned long);
1454extern int git_config_system(void);
1455extern int config_error_nonbool(const char *);
1456#if defined(__GNUC__)
1457#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1458#endif
1459extern const char *get_log_output_encoding(void);
1460extern const char *get_commit_output_encoding(void);
1461
1462extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1463
1464struct config_include_data {
1465 int depth;
1466 config_fn_t fn;
1467 void *data;
1468};
1469#define CONFIG_INCLUDE_INIT { 0 }
1470extern int git_config_include(const char *name, const char *value, void *data);
1471
1472/*
1473 * Match and parse a config key of the form:
1474 *
1475 * section.(subsection.)?key
1476 *
1477 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1478 * we return -1 if it does not match, 0 otherwise. The subsection and key
1479 * out-parameters are filled by the function (and subsection is NULL if it is
1480 * missing).
1481 */
1482extern int parse_config_key(const char *var,
1483 const char *section,
1484 const char **subsection, int *subsection_len,
1485 const char **key);
1486
1487struct config_set_element {
1488 struct hashmap_entry ent;
1489 char *key;
1490 struct string_list value_list;
1491};
1492
1493struct configset_list_item {
1494 struct config_set_element *e;
1495 int value_index;
1496};
1497
1498/*
1499 * the contents of the list are ordered according to their
1500 * position in the config files and order of parsing the files.
1501 * (i.e. key-value pair at the last position of .git/config will
1502 * be at the last item of the list)
1503 */
1504struct configset_list {
1505 struct configset_list_item *items;
1506 unsigned int nr, alloc;
1507};
1508
1509struct config_set {
1510 struct hashmap config_hash;
1511 int hash_initialized;
1512 struct configset_list list;
1513};
1514
1515extern void git_configset_init(struct config_set *cs);
1516extern int git_configset_add_file(struct config_set *cs, const char *filename);
1517extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1518extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1519extern void git_configset_clear(struct config_set *cs);
1520extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1521extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1522extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1523extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1524extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1525extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1526extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1527extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1528
1529extern int git_config_get_value(const char *key, const char **value);
1530extern const struct string_list *git_config_get_value_multi(const char *key);
1531extern void git_config_clear(void);
1532extern void git_config_iter(config_fn_t fn, void *data);
1533extern int git_config_get_string_const(const char *key, const char **dest);
1534extern int git_config_get_string(const char *key, char **dest);
1535extern int git_config_get_int(const char *key, int *dest);
1536extern int git_config_get_ulong(const char *key, unsigned long *dest);
1537extern int git_config_get_bool(const char *key, int *dest);
1538extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1539extern int git_config_get_maybe_bool(const char *key, int *dest);
1540extern int git_config_get_pathname(const char *key, const char **dest);
1541
1542struct key_value_info {
1543 const char *filename;
1544 int linenr;
1545};
1546
1547extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1548extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1549
1550extern int committer_ident_sufficiently_given(void);
1551extern int author_ident_sufficiently_given(void);
1552
1553extern const char *git_commit_encoding;
1554extern const char *git_log_output_encoding;
1555extern const char *git_mailmap_file;
1556extern const char *git_mailmap_blob;
1557
1558/* IO helper functions */
1559extern void maybe_flush_or_die(FILE *, const char *);
1560__attribute__((format (printf, 2, 3)))
1561extern void fprintf_or_die(FILE *, const char *fmt, ...);
1562
1563#define COPY_READ_ERROR (-2)
1564#define COPY_WRITE_ERROR (-3)
1565extern int copy_fd(int ifd, int ofd);
1566extern int copy_file(const char *dst, const char *src, int mode);
1567extern int copy_file_with_time(const char *dst, const char *src, int mode);
1568
1569extern void write_or_die(int fd, const void *buf, size_t count);
1570extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1571extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1572extern void fsync_or_die(int fd, const char *);
1573
1574extern ssize_t read_in_full(int fd, void *buf, size_t count);
1575extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1576extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1577
1578static inline ssize_t write_str_in_full(int fd, const char *str)
1579{
1580 return write_in_full(fd, str, strlen(str));
1581}
1582
1583extern int write_file(const char *path, const char *fmt, ...);
1584extern int write_file_gently(const char *path, const char *fmt, ...);
1585
1586/* pager.c */
1587extern void setup_pager(void);
1588extern const char *pager_program;
1589extern int pager_in_use(void);
1590extern int pager_use_color;
1591extern int term_columns(void);
1592extern int decimal_width(uintmax_t);
1593extern int check_pager_config(const char *cmd);
1594
1595extern const char *editor_program;
1596extern const char *askpass_program;
1597extern const char *excludes_file;
1598
1599/* base85 */
1600int decode_85(char *dst, const char *line, int linelen);
1601void encode_85(char *buf, const unsigned char *data, int bytes);
1602
1603/* alloc.c */
1604extern void *alloc_blob_node(void);
1605extern void *alloc_tree_node(void);
1606extern void *alloc_commit_node(void);
1607extern void *alloc_tag_node(void);
1608extern void *alloc_object_node(void);
1609extern void alloc_report(void);
1610extern unsigned int alloc_commit_index(void);
1611
1612/* pkt-line.c */
1613void packet_trace_identity(const char *prog);
1614
1615/* add */
1616/*
1617 * return 0 if success, 1 - if addition of a file failed and
1618 * ADD_FILES_IGNORE_ERRORS was specified in flags
1619 */
1620int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1621
1622/* diff.c */
1623extern int diff_auto_refresh_index;
1624
1625/* match-trees.c */
1626void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1627void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1628
1629/*
1630 * whitespace rules.
1631 * used by both diff and apply
1632 * last two digits are tab width
1633 */
1634#define WS_BLANK_AT_EOL 0100
1635#define WS_SPACE_BEFORE_TAB 0200
1636#define WS_INDENT_WITH_NON_TAB 0400
1637#define WS_CR_AT_EOL 01000
1638#define WS_BLANK_AT_EOF 02000
1639#define WS_TAB_IN_INDENT 04000
1640#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1641#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1642#define WS_TAB_WIDTH_MASK 077
1643extern unsigned whitespace_rule_cfg;
1644extern unsigned whitespace_rule(const char *);
1645extern unsigned parse_whitespace_rule(const char *);
1646extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1647extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1648extern char *whitespace_error_string(unsigned ws);
1649extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1650extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1651#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1652
1653/* ls-files */
1654void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1655
1656char *alias_lookup(const char *alias);
1657int split_cmdline(char *cmdline, const char ***argv);
1658/* Takes a negative value returned by split_cmdline */
1659const char *split_cmdline_strerror(int cmdline_errno);
1660
1661/* git.c */
1662struct startup_info {
1663 int have_repository;
1664 const char *prefix;
1665};
1666extern struct startup_info *startup_info;
1667
1668/* merge.c */
1669struct commit_list;
1670int try_merge_command(const char *strategy, size_t xopts_nr,
1671 const char **xopts, struct commit_list *common,
1672 const char *head_arg, struct commit_list *remotes);
1673int checkout_fast_forward(const unsigned char *from,
1674 const unsigned char *to,
1675 int overwrite_ignore);
1676
1677
1678int sane_execvp(const char *file, char *const argv[]);
1679
1680/*
1681 * A struct to encapsulate the concept of whether a file has changed
1682 * since we last checked it. This uses criteria similar to those used
1683 * for the index.
1684 */
1685struct stat_validity {
1686 struct stat_data *sd;
1687};
1688
1689void stat_validity_clear(struct stat_validity *sv);
1690
1691/*
1692 * Returns 1 if the path is a regular file (or a symlink to a regular
1693 * file) and matches the saved stat_validity, 0 otherwise. A missing
1694 * or inaccessible file is considered a match if the struct was just
1695 * initialized, or if the previous update found an inaccessible file.
1696 */
1697int stat_validity_check(struct stat_validity *sv, const char *path);
1698
1699/*
1700 * Update the stat_validity from a file opened at descriptor fd. If
1701 * the file is missing, inaccessible, or not a regular file, then
1702 * future calls to stat_validity_check will match iff one of those
1703 * conditions continues to be true.
1704 */
1705void stat_validity_update(struct stat_validity *sv, int fd);
1706
1707int versioncmp(const char *s1, const char *s2);
1708void sleep_millisec(int millisec);
1709
1710#endif /* CACHE_H */