]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - cache.h
projects / thirdparty / git.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Makefile: Include subdirectories in "make cover" reports
[thirdparty/git.git] / cache.h
... / ...
CommitLineData
1#ifndef CACHE_H
2#define CACHE_H
3
4#include "git-compat-util.h"
5#include "strbuf.h"
6#include "hash.h"
7#include "advice.h"
8
9#include SHA1_HEADER
10#ifndef git_SHA_CTX
11#define git_SHA_CTX SHA_CTX
12#define git_SHA1_Init SHA1_Init
13#define git_SHA1_Update SHA1_Update
14#define git_SHA1_Final SHA1_Final
15#endif
16
17#include <zlib.h>
18#if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
19#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
20#endif
21
22void git_inflate_init(z_streamp strm);
23void git_inflate_end(z_streamp strm);
24int git_inflate(z_streamp strm, int flush);
25
26#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
27#define DTYPE(de) ((de)->d_type)
28#else
29#undef DT_UNKNOWN
30#undef DT_DIR
31#undef DT_REG
32#undef DT_LNK
33#define DT_UNKNOWN 0
34#define DT_DIR 1
35#define DT_REG 2
36#define DT_LNK 3
37#define DTYPE(de) DT_UNKNOWN
38#endif
39
40/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
41#define S_IFINVALID 0030000
42
43/*
44 * A "directory link" is a link to another git directory.
45 *
46 * The value 0160000 is not normally a valid mode, and
47 * also just happens to be S_IFDIR + S_IFLNK
48 *
49 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
50 * always having the same values everywhere. We should use
51 * our internal git values for these things, and then we can
52 * translate that to the OS-specific value. It just so
53 * happens that everybody shares the same bit representation
54 * in the UNIX world (and apparently wider too..)
55 */
56#define S_IFGITLINK 0160000
57#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
58
59/*
60 * Intensive research over the course of many years has shown that
61 * port 9418 is totally unused by anything else. Or
62 *
63 * Your search - "port 9418" - did not match any documents.
64 *
65 * as www.google.com puts it.
66 *
67 * This port has been properly assigned for git use by IANA:
68 * git (Assigned-9418) [I06-050728-0001].
69 *
70 * git 9418/tcp git pack transfer service
71 * git 9418/udp git pack transfer service
72 *
73 * with Linus Torvalds <torvalds@osdl.org> as the point of
74 * contact. September 2005.
75 *
76 * See http://www.iana.org/assignments/port-numbers
77 */
78#define DEFAULT_GIT_PORT 9418
79
80/*
81 * Basic data structures for the directory cache
82 */
83
84#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
85struct cache_header {
86 unsigned int hdr_signature;
87 unsigned int hdr_version;
88 unsigned int hdr_entries;
89};
90
91/*
92 * The "cache_time" is just the low 32 bits of the
93 * time. It doesn't matter if it overflows - we only
94 * check it for equality in the 32 bits we save.
95 */
96struct cache_time {
97 unsigned int sec;
98 unsigned int nsec;
99};
100
101/*
102 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
103 * Again - this is just a (very strong in practice) heuristic that
104 * the inode hasn't changed.
105 *
106 * We save the fields in big-endian order to allow using the
107 * index file over NFS transparently.
108 */
109struct ondisk_cache_entry {
110 struct cache_time ctime;
111 struct cache_time mtime;
112 unsigned int dev;
113 unsigned int ino;
114 unsigned int mode;
115 unsigned int uid;
116 unsigned int gid;
117 unsigned int size;
118 unsigned char sha1[20];
119 unsigned short flags;
120 char name[FLEX_ARRAY]; /* more */
121};
122
123/*
124 * This struct is used when CE_EXTENDED bit is 1
125 * The struct must match ondisk_cache_entry exactly from
126 * ctime till flags
127 */
128struct ondisk_cache_entry_extended {
129 struct cache_time ctime;
130 struct cache_time mtime;
131 unsigned int dev;
132 unsigned int ino;
133 unsigned int mode;
134 unsigned int uid;
135 unsigned int gid;
136 unsigned int size;
137 unsigned char sha1[20];
138 unsigned short flags;
139 unsigned short flags2;
140 char name[FLEX_ARRAY]; /* more */
141};
142
143struct cache_entry {
144 struct cache_time ce_ctime;
145 struct cache_time ce_mtime;
146 unsigned int ce_dev;
147 unsigned int ce_ino;
148 unsigned int ce_mode;
149 unsigned int ce_uid;
150 unsigned int ce_gid;
151 unsigned int ce_size;
152 unsigned int ce_flags;
153 unsigned char sha1[20];
154 struct cache_entry *next;
155 char name[FLEX_ARRAY]; /* more */
156};
157
158#define CE_NAMEMASK (0x0fff)
159#define CE_STAGEMASK (0x3000)
160#define CE_EXTENDED (0x4000)
161#define CE_VALID (0x8000)
162#define CE_STAGESHIFT 12
163
164/*
165 * Range 0xFFFF0000 in ce_flags is divided into
166 * two parts: in-memory flags and on-disk ones.
167 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
168 * if you want to save a new flag, add it in
169 * CE_EXTENDED_FLAGS
170 *
171 * In-memory only flags
172 */
173#define CE_UPDATE (0x10000)
174#define CE_REMOVE (0x20000)
175#define CE_UPTODATE (0x40000)
176#define CE_ADDED (0x80000)
177
178#define CE_HASHED (0x100000)
179#define CE_UNHASHED (0x200000)
180#define CE_CONFLICTED (0x800000)
181
182/* Only remove in work directory, not index */
183#define CE_WT_REMOVE (0x400000)
184
185#define CE_UNPACKED (0x1000000)
186
187/*
188 * Extended on-disk flags
189 */
190#define CE_INTENT_TO_ADD 0x20000000
191#define CE_SKIP_WORKTREE 0x40000000
192/* CE_EXTENDED2 is for future extension */
193#define CE_EXTENDED2 0x80000000
194
195#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
196
197/*
198 * Safeguard to avoid saving wrong flags:
199 * - CE_EXTENDED2 won't get saved until its semantic is known
200 * - Bits in 0x0000FFFF have been saved in ce_flags already
201 * - Bits in 0x003F0000 are currently in-memory flags
202 */
203#if CE_EXTENDED_FLAGS & 0x803FFFFF
204#error "CE_EXTENDED_FLAGS out of range"
205#endif
206
207/*
208 * Copy the sha1 and stat state of a cache entry from one to
209 * another. But we never change the name, or the hash state!
210 */
211#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
212static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
213{
214 unsigned int state = dst->ce_flags & CE_STATE_MASK;
215
216 /* Don't copy hash chain and name */
217 memcpy(dst, src, offsetof(struct cache_entry, next));
218
219 /* Restore the hash state */
220 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
221}
222
223static inline unsigned create_ce_flags(size_t len, unsigned stage)
224{
225 if (len >= CE_NAMEMASK)
226 len = CE_NAMEMASK;
227 return (len | (stage << CE_STAGESHIFT));
228}
229
230static inline size_t ce_namelen(const struct cache_entry *ce)
231{
232 size_t len = ce->ce_flags & CE_NAMEMASK;
233 if (len < CE_NAMEMASK)
234 return len;
235 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
236}
237
238#define ce_size(ce) cache_entry_size(ce_namelen(ce))
239#define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
240 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
241 ondisk_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(struct cache_entry *ce, unsigned int mode)
257{
258 extern int trust_executable_bit, has_symlinks;
259 if (!has_symlinks && S_ISREG(mode) &&
260 ce && S_ISLNK(ce->ce_mode))
261 return ce->ce_mode;
262 if (!trust_executable_bit && S_ISREG(mode)) {
263 if (ce && S_ISREG(ce->ce_mode))
264 return ce->ce_mode;
265 return create_ce_mode(0666);
266 }
267 return create_ce_mode(mode);
268}
269static inline int ce_to_dtype(const struct cache_entry *ce)
270{
271 unsigned ce_mode = ntohl(ce->ce_mode);
272 if (S_ISREG(ce_mode))
273 return DT_REG;
274 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
275 return DT_DIR;
276 else if (S_ISLNK(ce_mode))
277 return DT_LNK;
278 else
279 return DT_UNKNOWN;
280}
281#define canon_mode(mode) \
282 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
283 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
284
285#define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
286#define cache_entry_size(len) flexible_size(cache_entry,len)
287#define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
288#define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
289
290struct index_state {
291 struct cache_entry **cache;
292 unsigned int cache_nr, cache_alloc, cache_changed;
293 struct string_list *resolve_undo;
294 struct cache_tree *cache_tree;
295 struct cache_time timestamp;
296 void *alloc;
297 unsigned name_hash_initialized : 1,
298 initialized : 1;
299 struct hash_table name_hash;
300};
301
302extern struct index_state the_index;
303
304/* Name hashing */
305extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
306/*
307 * We don't actually *remove* it, we can just mark it invalid so that
308 * we won't find it in lookups.
309 *
310 * Not only would we have to search the lists (simple enough), but
311 * we'd also have to rehash other hash buckets in case this makes the
312 * hash bucket empty (common). So it's much better to just mark
313 * it.
314 */
315static inline void remove_name_hash(struct cache_entry *ce)
316{
317 ce->ce_flags |= CE_UNHASHED;
318}
319
320
321#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
322#define active_cache (the_index.cache)
323#define active_nr (the_index.cache_nr)
324#define active_alloc (the_index.cache_alloc)
325#define active_cache_changed (the_index.cache_changed)
326#define active_cache_tree (the_index.cache_tree)
327
328#define read_cache() read_index(&the_index)
329#define read_cache_from(path) read_index_from(&the_index, (path))
330#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
331#define is_cache_unborn() is_index_unborn(&the_index)
332#define read_cache_unmerged() read_index_unmerged(&the_index)
333#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
334#define discard_cache() discard_index(&the_index)
335#define unmerged_cache() unmerged_index(&the_index)
336#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
337#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
338#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
339#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
340#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
341#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
342#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
343#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
344#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
345#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
346#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
347#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
348#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
349#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
350#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
351#endif
352
353enum object_type {
354 OBJ_BAD = -1,
355 OBJ_NONE = 0,
356 OBJ_COMMIT = 1,
357 OBJ_TREE = 2,
358 OBJ_BLOB = 3,
359 OBJ_TAG = 4,
360 /* 5 for future expansion */
361 OBJ_OFS_DELTA = 6,
362 OBJ_REF_DELTA = 7,
363 OBJ_ANY,
364 OBJ_MAX
365};
366
367static inline enum object_type object_type(unsigned int mode)
368{
369 return S_ISDIR(mode) ? OBJ_TREE :
370 S_ISGITLINK(mode) ? OBJ_COMMIT :
371 OBJ_BLOB;
372}
373
374#define GIT_DIR_ENVIRONMENT "GIT_DIR"
375#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
376#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
377#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
378#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
379#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
380#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
381#define CONFIG_ENVIRONMENT "GIT_CONFIG"
382#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
383#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
384#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
385#define GITATTRIBUTES_FILE ".gitattributes"
386#define INFOATTRIBUTES_FILE "info/attributes"
387#define ATTRIBUTE_MACRO_PREFIX "[attr]"
388#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
389#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
390#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
391#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
392#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
393
394/*
395 * Repository-local GIT_* environment variables
396 * The array is NULL-terminated to simplify its usage in contexts such
397 * environment creation or simple walk of the list.
398 * The number of non-NULL entries is available as a macro.
399 */
400#define LOCAL_REPO_ENV_SIZE 8
401extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
402
403extern int is_bare_repository_cfg;
404extern int is_bare_repository(void);
405extern int is_inside_git_dir(void);
406extern char *git_work_tree_cfg;
407extern int is_inside_work_tree(void);
408extern int have_git_dir(void);
409extern const char *get_git_dir(void);
410extern char *get_object_directory(void);
411extern char *get_index_file(void);
412extern char *get_graft_file(void);
413extern int set_git_dir(const char *path);
414extern const char *get_git_work_tree(void);
415extern const char *read_gitfile_gently(const char *path);
416extern void set_git_work_tree(const char *tree);
417
418#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
419
420extern const char **get_pathspec(const char *prefix, const char **pathspec);
421extern void setup_work_tree(void);
422extern const char *setup_git_directory_gently(int *);
423extern const char *setup_git_directory(void);
424extern const char *prefix_path(const char *prefix, int len, const char *path);
425extern const char *prefix_filename(const char *prefix, int len, const char *path);
426extern int check_filename(const char *prefix, const char *name);
427extern void verify_filename(const char *prefix, const char *name);
428extern void verify_non_filename(const char *prefix, const char *name);
429
430#define INIT_DB_QUIET 0x0001
431
432extern int init_db(const char *template_dir, unsigned int flags);
433
434#define alloc_nr(x) (((x)+16)*3/2)
435
436/*
437 * Realloc the buffer pointed at by variable 'x' so that it can hold
438 * at least 'nr' entries; the number of entries currently allocated
439 * is 'alloc', using the standard growing factor alloc_nr() macro.
440 *
441 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
442 */
443#define ALLOC_GROW(x, nr, alloc) \
444 do { \
445 if ((nr) > alloc) { \
446 if (alloc_nr(alloc) < (nr)) \
447 alloc = (nr); \
448 else \
449 alloc = alloc_nr(alloc); \
450 x = xrealloc((x), alloc * sizeof(*(x))); \
451 } \
452 } while (0)
453
454/* Initialize and use the cache information */
455extern int read_index(struct index_state *);
456extern int read_index_preload(struct index_state *, const char **pathspec);
457extern int read_index_from(struct index_state *, const char *path);
458extern int is_index_unborn(struct index_state *);
459extern int read_index_unmerged(struct index_state *);
460extern int write_index(struct index_state *, int newfd);
461extern int discard_index(struct index_state *);
462extern int unmerged_index(const struct index_state *);
463extern int verify_path(const char *path);
464extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
465extern int index_name_pos(const struct index_state *, const char *name, int namelen);
466#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
467#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
468#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
469#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
470#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
471extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
472extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
473extern int remove_index_entry_at(struct index_state *, int pos);
474extern void remove_marked_cache_entries(struct index_state *istate);
475extern int remove_file_from_index(struct index_state *, const char *path);
476#define ADD_CACHE_VERBOSE 1
477#define ADD_CACHE_PRETEND 2
478#define ADD_CACHE_IGNORE_ERRORS 4
479#define ADD_CACHE_IGNORE_REMOVAL 8
480#define ADD_CACHE_INTENT 16
481extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
482extern int add_file_to_index(struct index_state *, const char *path, int flags);
483extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
484extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
485extern int index_name_is_other(const struct index_state *, const char *, int);
486
487/* do stat comparison even if CE_VALID is true */
488#define CE_MATCH_IGNORE_VALID 01
489/* do not check the contents but report dirty on racily-clean entries */
490#define CE_MATCH_RACY_IS_DIRTY 02
491/* do stat comparison even if CE_SKIP_WORKTREE is true */
492#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
493extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
494extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
495
496extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
497extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
498extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
499extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
500
501#define REFRESH_REALLY 0x0001 /* ignore_valid */
502#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
503#define REFRESH_QUIET 0x0004 /* be quiet about it */
504#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
505#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
506#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
507extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, char *header_msg);
508
509struct lock_file {
510 struct lock_file *next;
511 int fd;
512 pid_t owner;
513 char on_list;
514 char filename[PATH_MAX];
515};
516#define LOCK_DIE_ON_ERROR 1
517#define LOCK_NODEREF 2
518extern int unable_to_lock_error(const char *path, int err);
519extern NORETURN void unable_to_lock_index_die(const char *path, int err);
520extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
521extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
522extern int commit_lock_file(struct lock_file *);
523
524extern int hold_locked_index(struct lock_file *, int);
525extern int commit_locked_index(struct lock_file *);
526extern void set_alternate_index_output(const char *);
527extern int close_lock_file(struct lock_file *);
528extern void rollback_lock_file(struct lock_file *);
529extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
530
531/* Environment bits from configuration mechanism */
532extern int trust_executable_bit;
533extern int trust_ctime;
534extern int quote_path_fully;
535extern int has_symlinks;
536extern int ignore_case;
537extern int assume_unchanged;
538extern int prefer_symlink_refs;
539extern int log_all_ref_updates;
540extern int warn_ambiguous_refs;
541extern int shared_repository;
542extern const char *apply_default_whitespace;
543extern const char *apply_default_ignorewhitespace;
544extern int zlib_compression_level;
545extern int core_compression_level;
546extern int core_compression_seen;
547extern size_t packed_git_window_size;
548extern size_t packed_git_limit;
549extern size_t delta_base_cache_limit;
550extern int read_replace_refs;
551extern int fsync_object_files;
552extern int core_preload_index;
553extern int core_apply_sparse_checkout;
554
555enum safe_crlf {
556 SAFE_CRLF_FALSE = 0,
557 SAFE_CRLF_FAIL = 1,
558 SAFE_CRLF_WARN = 2
559};
560
561extern enum safe_crlf safe_crlf;
562
563enum auto_crlf {
564 AUTO_CRLF_FALSE = 0,
565 AUTO_CRLF_TRUE = 1,
566 AUTO_CRLF_INPUT = -1,
567};
568
569extern enum auto_crlf auto_crlf;
570
571enum eol {
572 EOL_UNSET,
573 EOL_CRLF,
574 EOL_LF,
575#ifdef NATIVE_CRLF
576 EOL_NATIVE = EOL_CRLF
577#else
578 EOL_NATIVE = EOL_LF
579#endif
580};
581
582extern enum eol eol;
583
584enum branch_track {
585 BRANCH_TRACK_UNSPECIFIED = -1,
586 BRANCH_TRACK_NEVER = 0,
587 BRANCH_TRACK_REMOTE,
588 BRANCH_TRACK_ALWAYS,
589 BRANCH_TRACK_EXPLICIT,
590 BRANCH_TRACK_OVERRIDE
591};
592
593enum rebase_setup_type {
594 AUTOREBASE_NEVER = 0,
595 AUTOREBASE_LOCAL,
596 AUTOREBASE_REMOTE,
597 AUTOREBASE_ALWAYS
598};
599
600enum push_default_type {
601 PUSH_DEFAULT_NOTHING = 0,
602 PUSH_DEFAULT_MATCHING,
603 PUSH_DEFAULT_TRACKING,
604 PUSH_DEFAULT_CURRENT
605};
606
607extern enum branch_track git_branch_track;
608extern enum rebase_setup_type autorebase;
609extern enum push_default_type push_default;
610
611enum object_creation_mode {
612 OBJECT_CREATION_USES_HARDLINKS = 0,
613 OBJECT_CREATION_USES_RENAMES = 1
614};
615
616extern enum object_creation_mode object_creation_mode;
617
618extern char *notes_ref_name;
619
620extern int grafts_replace_parents;
621
622#define GIT_REPO_VERSION 0
623extern int repository_format_version;
624extern int check_repository_format(void);
625
626#define MTIME_CHANGED 0x0001
627#define CTIME_CHANGED 0x0002
628#define OWNER_CHANGED 0x0004
629#define MODE_CHANGED 0x0008
630#define INODE_CHANGED 0x0010
631#define DATA_CHANGED 0x0020
632#define TYPE_CHANGED 0x0040
633
634extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
635 __attribute__((format (printf, 3, 4)));
636extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
637 __attribute__((format (printf, 3, 4)));
638extern char *git_pathdup(const char *fmt, ...)
639 __attribute__((format (printf, 1, 2)));
640
641/* Return a statically allocated filename matching the sha1 signature */
642extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
643extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
644extern char *sha1_file_name(const unsigned char *sha1);
645extern char *sha1_pack_name(const unsigned char *sha1);
646extern char *sha1_pack_index_name(const unsigned char *sha1);
647extern const char *find_unique_abbrev(const unsigned char *sha1, int);
648extern const unsigned char null_sha1[20];
649static inline int is_null_sha1(const unsigned char *sha1)
650{
651 return !memcmp(sha1, null_sha1, 20);
652}
653static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
654{
655 return memcmp(sha1, sha2, 20);
656}
657static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
658{
659 memcpy(sha_dst, sha_src, 20);
660}
661static inline void hashclr(unsigned char *hash)
662{
663 memset(hash, 0, 20);
664}
665
666#define EMPTY_TREE_SHA1_HEX \
667 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
668#define EMPTY_TREE_SHA1_BIN \
669 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
670 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
671
672int git_mkstemp(char *path, size_t n, const char *template);
673
674int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
675
676/* set default permissions by passing mode arguments to open(2) */
677int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
678int git_mkstemp_mode(char *pattern, int mode);
679
680/*
681 * NOTE NOTE NOTE!!
682 *
683 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
684 * not be changed. Old repositories have core.sharedrepository written in
685 * numeric format, and therefore these values are preserved for compatibility
686 * reasons.
687 */
688enum sharedrepo {
689 PERM_UMASK = 0,
690 OLD_PERM_GROUP = 1,
691 OLD_PERM_EVERYBODY = 2,
692 PERM_GROUP = 0660,
693 PERM_EVERYBODY = 0664
694};
695int git_config_perm(const char *var, const char *value);
696int set_shared_perm(const char *path, int mode);
697#define adjust_shared_perm(path) set_shared_perm((path), 0)
698int safe_create_leading_directories(char *path);
699int safe_create_leading_directories_const(const char *path);
700extern char *expand_user_path(const char *path);
701char *enter_repo(char *path, int strict);
702static inline int is_absolute_path(const char *path)
703{
704 return path[0] == '/' || has_dos_drive_prefix(path);
705}
706int is_directory(const char *);
707const char *make_absolute_path(const char *path);
708const char *make_nonrelative_path(const char *path);
709const char *make_relative_path(const char *abs, const char *base);
710int normalize_path_copy(char *dst, const char *src);
711int longest_ancestor_length(const char *path, const char *prefix_list);
712char *strip_path_suffix(const char *path, const char *suffix);
713int daemon_avoid_alias(const char *path);
714int offset_1st_component(const char *path);
715
716/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
717extern int sha1_object_info(const unsigned char *, unsigned long *);
718extern void *read_sha1_file_repl(const unsigned char *sha1, enum object_type *type, unsigned long *size, const unsigned char **replacement);
719static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
720{
721 return read_sha1_file_repl(sha1, type, size, NULL);
722}
723extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
724extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
725extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
726extern int force_object_loose(const unsigned char *sha1, time_t mtime);
727
728/* global flag to enable extra checks when accessing packed objects */
729extern int do_check_packed_object_crc;
730
731extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
732
733extern int move_temp_to_file(const char *tmpfile, const char *filename);
734
735extern int has_sha1_pack(const unsigned char *sha1);
736extern int has_sha1_file(const unsigned char *sha1);
737extern int has_loose_object_nonlocal(const unsigned char *sha1);
738
739extern int has_pack_index(const unsigned char *sha1);
740
741extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
742
743extern const signed char hexval_table[256];
744static inline unsigned int hexval(unsigned char c)
745{
746 return hexval_table[c];
747}
748
749/* Convert to/from hex/sha1 representation */
750#define MINIMUM_ABBREV 4
751#define DEFAULT_ABBREV 7
752
753struct object_context {
754 unsigned char tree[20];
755 char path[PATH_MAX];
756 unsigned mode;
757};
758
759extern int get_sha1(const char *str, unsigned char *sha1);
760extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int gently, const char *prefix);
761static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
762{
763 return get_sha1_with_mode_1(str, sha1, mode, 1, NULL);
764}
765extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int gently, const char *prefix);
766static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
767{
768 return get_sha1_with_context_1(str, sha1, orc, 1, NULL);
769}
770extern int get_sha1_hex(const char *hex, unsigned char *sha1);
771extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
772extern int read_ref(const char *filename, unsigned char *sha1);
773extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
774extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
775extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
776extern int interpret_branch_name(const char *str, struct strbuf *);
777extern int get_sha1_mb(const char *str, unsigned char *sha1);
778
779extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
780extern const char *ref_rev_parse_rules[];
781extern const char *ref_fetch_rules[];
782
783extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
784extern int validate_headref(const char *ref);
785
786extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
787extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
788extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
789
790extern void *read_object_with_reference(const unsigned char *sha1,
791 const char *required_type,
792 unsigned long *size,
793 unsigned char *sha1_ret);
794
795extern struct object *peel_to_type(const char *name, int namelen,
796 struct object *o, enum object_type);
797
798enum date_mode {
799 DATE_NORMAL = 0,
800 DATE_RELATIVE,
801 DATE_SHORT,
802 DATE_LOCAL,
803 DATE_ISO8601,
804 DATE_RFC2822,
805 DATE_RAW
806};
807
808const char *show_date(unsigned long time, int timezone, enum date_mode mode);
809const char *show_date_relative(unsigned long time, int tz,
810 const struct timeval *now,
811 char *timebuf,
812 size_t timebuf_size);
813int parse_date(const char *date, char *buf, int bufsize);
814int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
815void datestamp(char *buf, int bufsize);
816#define approxidate(s) approxidate_careful((s), NULL)
817unsigned long approxidate_careful(const char *, int *);
818unsigned long approxidate_relative(const char *date, const struct timeval *now);
819enum date_mode parse_date_format(const char *format);
820
821#define IDENT_WARN_ON_NO_NAME 1
822#define IDENT_ERROR_ON_NO_NAME 2
823#define IDENT_NO_DATE 4
824extern const char *git_author_info(int);
825extern const char *git_committer_info(int);
826extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
827extern const char *fmt_name(const char *name, const char *email);
828extern const char *git_editor(void);
829extern const char *git_pager(int stdout_is_tty);
830
831struct checkout {
832 const char *base_dir;
833 int base_dir_len;
834 unsigned force:1,
835 quiet:1,
836 not_new:1,
837 refresh_cache:1;
838};
839
840extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
841
842struct cache_def {
843 char path[PATH_MAX + 1];
844 int len;
845 int flags;
846 int track_flags;
847 int prefix_len_stat_func;
848};
849
850extern int has_symlink_leading_path(const char *name, int len);
851extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
852extern int has_symlink_or_noent_leading_path(const char *name, int len);
853extern int has_dirs_only_path(const char *name, int len, int prefix_len);
854extern void schedule_dir_for_removal(const char *name, int len);
855extern void remove_scheduled_dirs(void);
856
857extern struct alternate_object_database {
858 struct alternate_object_database *next;
859 char *name;
860 char base[FLEX_ARRAY]; /* more */
861} *alt_odb_list;
862extern void prepare_alt_odb(void);
863extern void add_to_alternates_file(const char *reference);
864typedef int alt_odb_fn(struct alternate_object_database *, void *);
865extern void foreach_alt_odb(alt_odb_fn, void*);
866
867struct pack_window {
868 struct pack_window *next;
869 unsigned char *base;
870 off_t offset;
871 size_t len;
872 unsigned int last_used;
873 unsigned int inuse_cnt;
874};
875
876extern struct packed_git {
877 struct packed_git *next;
878 struct pack_window *windows;
879 off_t pack_size;
880 const void *index_data;
881 size_t index_size;
882 uint32_t num_objects;
883 uint32_t num_bad_objects;
884 unsigned char *bad_object_sha1;
885 int index_version;
886 time_t mtime;
887 int pack_fd;
888 unsigned pack_local:1,
889 pack_keep:1;
890 unsigned char sha1[20];
891 /* something like ".git/objects/pack/xxxxx.pack" */
892 char pack_name[FLEX_ARRAY]; /* more */
893} *packed_git;
894
895struct pack_entry {
896 off_t offset;
897 unsigned char sha1[20];
898 struct packed_git *p;
899};
900
901struct ref {
902 struct ref *next;
903 unsigned char old_sha1[20];
904 unsigned char new_sha1[20];
905 char *symref;
906 unsigned int force:1,
907 merge:1,
908 nonfastforward:1,
909 deletion:1;
910 enum {
911 REF_STATUS_NONE = 0,
912 REF_STATUS_OK,
913 REF_STATUS_REJECT_NONFASTFORWARD,
914 REF_STATUS_REJECT_NODELETE,
915 REF_STATUS_UPTODATE,
916 REF_STATUS_REMOTE_REJECT,
917 REF_STATUS_EXPECTING_REPORT
918 } status;
919 char *remote_status;
920 struct ref *peer_ref; /* when renaming */
921 char name[FLEX_ARRAY]; /* more */
922};
923
924#define REF_NORMAL (1u << 0)
925#define REF_HEADS (1u << 1)
926#define REF_TAGS (1u << 2)
927
928extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
929
930#define CONNECT_VERBOSE (1u << 0)
931extern char *git_getpass(const char *prompt);
932extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
933extern int finish_connect(struct child_process *conn);
934extern int path_match(const char *path, int nr, char **match);
935struct extra_have_objects {
936 int nr, alloc;
937 unsigned char (*array)[20];
938};
939extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
940extern int server_supports(const char *feature);
941
942extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
943
944extern void prepare_packed_git(void);
945extern void reprepare_packed_git(void);
946extern void install_packed_git(struct packed_git *pack);
947
948extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
949 struct packed_git *packs);
950
951extern void pack_report(void);
952extern int open_pack_index(struct packed_git *);
953extern void close_pack_index(struct packed_git *);
954extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
955extern void close_pack_windows(struct packed_git *);
956extern void unuse_pack(struct pack_window **);
957extern void free_pack_by_name(const char *);
958extern void clear_delta_base_cache(void);
959extern struct packed_git *add_packed_git(const char *, int, int);
960extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
961extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
962extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
963extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
964extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
965extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
966extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
967
968/* Dumb servers support */
969extern int update_server_info(int);
970
971typedef int (*config_fn_t)(const char *, const char *, void *);
972extern int git_default_config(const char *, const char *, void *);
973extern int git_config_from_file(config_fn_t fn, const char *, void *);
974extern int git_config_parse_parameter(const char *text);
975extern int git_config_from_parameters(config_fn_t fn, void *data);
976extern int git_config(config_fn_t fn, void *);
977extern int git_parse_ulong(const char *, unsigned long *);
978extern int git_config_int(const char *, const char *);
979extern unsigned long git_config_ulong(const char *, const char *);
980extern int git_config_bool_or_int(const char *, const char *, int *);
981extern int git_config_bool(const char *, const char *);
982extern int git_config_maybe_bool(const char *, const char *);
983extern int git_config_string(const char **, const char *, const char *);
984extern int git_config_pathname(const char **, const char *, const char *);
985extern int git_config_set(const char *, const char *);
986extern int git_config_set_multivar(const char *, const char *, const char *, int);
987extern int git_config_rename_section(const char *, const char *);
988extern const char *git_etc_gitconfig(void);
989extern int check_repository_format_version(const char *var, const char *value, void *cb);
990extern int git_env_bool(const char *, int);
991extern int git_config_system(void);
992extern int git_config_global(void);
993extern int config_error_nonbool(const char *);
994extern const char *config_exclusive_filename;
995
996#define MAX_GITNAME (1000)
997extern char git_default_email[MAX_GITNAME];
998extern char git_default_name[MAX_GITNAME];
999#define IDENT_NAME_GIVEN 01
1000#define IDENT_MAIL_GIVEN 02
1001#define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1002extern int user_ident_explicitly_given;
1003extern int user_ident_sufficiently_given(void);
1004
1005extern const char *git_commit_encoding;
1006extern const char *git_log_output_encoding;
1007extern const char *git_mailmap_file;
1008
1009/* IO helper functions */
1010extern void maybe_flush_or_die(FILE *, const char *);
1011extern int copy_fd(int ifd, int ofd);
1012extern int copy_file(const char *dst, const char *src, int mode);
1013extern int copy_file_with_time(const char *dst, const char *src, int mode);
1014extern void write_or_die(int fd, const void *buf, size_t count);
1015extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1016extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1017extern void fsync_or_die(int fd, const char *);
1018
1019extern ssize_t read_in_full(int fd, void *buf, size_t count);
1020extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1021static inline ssize_t write_str_in_full(int fd, const char *str)
1022{
1023 return write_in_full(fd, str, strlen(str));
1024}
1025
1026/* pager.c */
1027extern void setup_pager(void);
1028extern const char *pager_program;
1029extern int pager_in_use(void);
1030extern int pager_use_color;
1031
1032extern const char *editor_program;
1033extern const char *excludes_file;
1034
1035/* base85 */
1036int decode_85(char *dst, const char *line, int linelen);
1037void encode_85(char *buf, const unsigned char *data, int bytes);
1038
1039/* alloc.c */
1040extern void *alloc_blob_node(void);
1041extern void *alloc_tree_node(void);
1042extern void *alloc_commit_node(void);
1043extern void *alloc_tag_node(void);
1044extern void *alloc_object_node(void);
1045extern void alloc_report(void);
1046
1047/* trace.c */
1048__attribute__((format (printf, 1, 2)))
1049extern void trace_printf(const char *format, ...);
1050__attribute__((format (printf, 2, 3)))
1051extern void trace_argv_printf(const char **argv, const char *format, ...);
1052
1053/* convert.c */
1054/* returns 1 if *dst was used */
1055extern int convert_to_git(const char *path, const char *src, size_t len,
1056 struct strbuf *dst, enum safe_crlf checksafe);
1057extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
1058
1059/* add */
1060/*
1061 * return 0 if success, 1 - if addition of a file failed and
1062 * ADD_FILES_IGNORE_ERRORS was specified in flags
1063 */
1064int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1065
1066/* diff.c */
1067extern int diff_auto_refresh_index;
1068
1069/* match-trees.c */
1070void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1071void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1072
1073/*
1074 * whitespace rules.
1075 * used by both diff and apply
1076 */
1077#define WS_BLANK_AT_EOL 01
1078#define WS_SPACE_BEFORE_TAB 02
1079#define WS_INDENT_WITH_NON_TAB 04
1080#define WS_CR_AT_EOL 010
1081#define WS_BLANK_AT_EOF 020
1082#define WS_TAB_IN_INDENT 040
1083#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1084#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
1085extern unsigned whitespace_rule_cfg;
1086extern unsigned whitespace_rule(const char *);
1087extern unsigned parse_whitespace_rule(const char *);
1088extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1089extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1090extern char *whitespace_error_string(unsigned ws);
1091extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1092extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1093
1094/* ls-files */
1095int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
1096void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1097
1098char *alias_lookup(const char *alias);
1099int split_cmdline(char *cmdline, const char ***argv);
1100
1101/* builtin/merge.c */
1102int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1103
1104#endif /* CACHE_H */
Unnamed repository; edit this file 'description' to name the repository.