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