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