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 (1 << 16)
174#define CE_REMOVE (1 << 17)
175#define CE_UPTODATE (1 << 18)
176#define CE_ADDED (1 << 19)
177
178#define CE_HASHED (1 << 20)
179#define CE_UNHASHED (1 << 21)
180#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
181#define CE_CONFLICTED (1 << 23)
182
183#define CE_UNPACKED (1 << 24)
184#define CE_NEW_SKIP_WORKTREE (1 << 25)
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
206/*
207 * Copy the sha1 and stat state of a cache entry from one to
208 * another. But we never change the name, or the hash state!
209 */
210#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
211static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
212{
213 unsigned int state = dst->ce_flags & CE_STATE_MASK;
214
215 /* Don't copy hash chain and name */
216 memcpy(dst, src, offsetof(struct cache_entry, next));
217
218 /* Restore the hash state */
219 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
220}
221
222static inline unsigned create_ce_flags(size_t len, unsigned stage)
223{
224 if (len >= CE_NAMEMASK)
225 len = CE_NAMEMASK;
226 return (len | (stage << CE_STAGESHIFT));
227}
228
229static inline size_t ce_namelen(const struct cache_entry *ce)
230{
231 size_t len = ce->ce_flags & CE_NAMEMASK;
232 if (len < CE_NAMEMASK)
233 return len;
234 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
235}
236
237#define ce_size(ce) cache_entry_size(ce_namelen(ce))
238#define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
239 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
240 ondisk_cache_entry_size(ce_namelen(ce)))
241#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
242#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
243#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
244#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
245
246#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
247static inline unsigned int create_ce_mode(unsigned int mode)
248{
249 if (S_ISLNK(mode))
250 return S_IFLNK;
251 if (S_ISDIR(mode) || S_ISGITLINK(mode))
252 return S_IFGITLINK;
253 return S_IFREG | ce_permissions(mode);
254}
255static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
256{
257 extern int trust_executable_bit, has_symlinks;
258 if (!has_symlinks && S_ISREG(mode) &&
259 ce && S_ISLNK(ce->ce_mode))
260 return ce->ce_mode;
261 if (!trust_executable_bit && S_ISREG(mode)) {
262 if (ce && S_ISREG(ce->ce_mode))
263 return ce->ce_mode;
264 return create_ce_mode(0666);
265 }
266 return create_ce_mode(mode);
267}
268static inline int ce_to_dtype(const struct cache_entry *ce)
269{
270 unsigned ce_mode = ntohl(ce->ce_mode);
271 if (S_ISREG(ce_mode))
272 return DT_REG;
273 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
274 return DT_DIR;
275 else if (S_ISLNK(ce_mode))
276 return DT_LNK;
277 else
278 return DT_UNKNOWN;
279}
280static inline unsigned int canon_mode(unsigned int mode)
281{
282 if (S_ISREG(mode))
283 return S_IFREG | ce_permissions(mode);
284 if (S_ISLNK(mode))
285 return S_IFLNK;
286 if (S_ISDIR(mode))
287 return S_IFDIR;
288 return S_IFGITLINK;
289}
290
291#define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
292#define cache_entry_size(len) flexible_size(cache_entry,len)
293#define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
294#define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
295
296struct index_state {
297 struct cache_entry **cache;
298 unsigned int cache_nr, cache_alloc, cache_changed;
299 struct string_list *resolve_undo;
300 struct cache_tree *cache_tree;
301 struct cache_time timestamp;
302 void *alloc;
303 unsigned name_hash_initialized : 1,
304 initialized : 1;
305 struct hash_table name_hash;
306};
307
308extern struct index_state the_index;
309
310/* Name hashing */
311extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
312/*
313 * We don't actually *remove* it, we can just mark it invalid so that
314 * we won't find it in lookups.
315 *
316 * Not only would we have to search the lists (simple enough), but
317 * we'd also have to rehash other hash buckets in case this makes the
318 * hash bucket empty (common). So it's much better to just mark
319 * it.
320 */
321static inline void remove_name_hash(struct cache_entry *ce)
322{
323 ce->ce_flags |= CE_UNHASHED;
324}
325
326
327#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
328#define active_cache (the_index.cache)
329#define active_nr (the_index.cache_nr)
330#define active_alloc (the_index.cache_alloc)
331#define active_cache_changed (the_index.cache_changed)
332#define active_cache_tree (the_index.cache_tree)
333
334#define read_cache() read_index(&the_index)
335#define read_cache_from(path) read_index_from(&the_index, (path))
336#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
337#define is_cache_unborn() is_index_unborn(&the_index)
338#define read_cache_unmerged() read_index_unmerged(&the_index)
339#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
340#define discard_cache() discard_index(&the_index)
341#define unmerged_cache() unmerged_index(&the_index)
342#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
343#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
344#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
345#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
346#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
347#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
348#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
349#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
350#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
351#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
352#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
353#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
354#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
355#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
356#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
357#endif
358
359enum object_type {
360 OBJ_BAD = -1,
361 OBJ_NONE = 0,
362 OBJ_COMMIT = 1,
363 OBJ_TREE = 2,
364 OBJ_BLOB = 3,
365 OBJ_TAG = 4,
366 /* 5 for future expansion */
367 OBJ_OFS_DELTA = 6,
368 OBJ_REF_DELTA = 7,
369 OBJ_ANY,
370 OBJ_MAX
371};
372
373static inline enum object_type object_type(unsigned int mode)
374{
375 return S_ISDIR(mode) ? OBJ_TREE :
376 S_ISGITLINK(mode) ? OBJ_COMMIT :
377 OBJ_BLOB;
378}
379
380#define GIT_DIR_ENVIRONMENT "GIT_DIR"
381#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
382#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
383#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
384#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
385#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
386#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
387#define CONFIG_ENVIRONMENT "GIT_CONFIG"
388#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
389#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
390#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
391#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
392#define GITATTRIBUTES_FILE ".gitattributes"
393#define INFOATTRIBUTES_FILE "info/attributes"
394#define ATTRIBUTE_MACRO_PREFIX "[attr]"
395#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
396#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
397#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
398#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
399#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
400
401/*
402 * Repository-local GIT_* environment variables
403 * The array is NULL-terminated to simplify its usage in contexts such
404 * environment creation or simple walk of the list.
405 * The number of non-NULL entries is available as a macro.
406 */
407#define LOCAL_REPO_ENV_SIZE 9
408extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
409
410extern int is_bare_repository_cfg;
411extern int is_bare_repository(void);
412extern int is_inside_git_dir(void);
413extern char *git_work_tree_cfg;
414extern int is_inside_work_tree(void);
415extern int have_git_dir(void);
416extern const char *get_git_dir(void);
417extern char *get_object_directory(void);
418extern char *get_index_file(void);
419extern char *get_graft_file(void);
420extern int set_git_dir(const char *path);
421extern const char *get_git_work_tree(void);
422extern const char *read_gitfile_gently(const char *path);
423extern void set_git_work_tree(const char *tree);
424
425#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
426
427extern const char **get_pathspec(const char *prefix, const char **pathspec);
428extern void setup_work_tree(void);
429extern const char *setup_git_directory_gently(int *);
430extern const char *setup_git_directory(void);
431extern char *prefix_path(const char *prefix, int len, const char *path);
432extern const char *prefix_filename(const char *prefix, int len, const char *path);
433extern int check_filename(const char *prefix, const char *name);
434extern void verify_filename(const char *prefix, const char *name);
435extern void verify_non_filename(const char *prefix, const char *name);
436
437#define INIT_DB_QUIET 0x0001
438
439extern int init_db(const char *template_dir, unsigned int flags);
440
441#define alloc_nr(x) (((x)+16)*3/2)
442
443/*
444 * Realloc the buffer pointed at by variable 'x' so that it can hold
445 * at least 'nr' entries; the number of entries currently allocated
446 * is 'alloc', using the standard growing factor alloc_nr() macro.
447 *
448 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
449 */
450#define ALLOC_GROW(x, nr, alloc) \
451 do { \
452 if ((nr) > alloc) { \
453 if (alloc_nr(alloc) < (nr)) \
454 alloc = (nr); \
455 else \
456 alloc = alloc_nr(alloc); \
457 x = xrealloc((x), alloc * sizeof(*(x))); \
458 } \
459 } while (0)
460
461/* Initialize and use the cache information */
462extern int read_index(struct index_state *);
463extern int read_index_preload(struct index_state *, const char **pathspec);
464extern int read_index_from(struct index_state *, const char *path);
465extern int is_index_unborn(struct index_state *);
466extern int read_index_unmerged(struct index_state *);
467extern int write_index(struct index_state *, int newfd);
468extern int discard_index(struct index_state *);
469extern int unmerged_index(const struct index_state *);
470extern int verify_path(const char *path);
471extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
472extern int index_name_pos(const struct index_state *, const char *name, int namelen);
473#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
474#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
475#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
476#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
477#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
478extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
479extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
480extern int remove_index_entry_at(struct index_state *, int pos);
481extern void remove_marked_cache_entries(struct index_state *istate);
482extern int remove_file_from_index(struct index_state *, const char *path);
483#define ADD_CACHE_VERBOSE 1
484#define ADD_CACHE_PRETEND 2
485#define ADD_CACHE_IGNORE_ERRORS 4
486#define ADD_CACHE_IGNORE_REMOVAL 8
487#define ADD_CACHE_INTENT 16
488extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
489extern int add_file_to_index(struct index_state *, const char *path, int flags);
490extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
491extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
492extern int index_name_is_other(const struct index_state *, const char *, int);
493
494/* do stat comparison even if CE_VALID is true */
495#define CE_MATCH_IGNORE_VALID 01
496/* do not check the contents but report dirty on racily-clean entries */
497#define CE_MATCH_RACY_IS_DIRTY 02
498/* do stat comparison even if CE_SKIP_WORKTREE is true */
499#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
500extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
501extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
502
503extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
504extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
505extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
506extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
507
508#define REFRESH_REALLY 0x0001 /* ignore_valid */
509#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
510#define REFRESH_QUIET 0x0004 /* be quiet about it */
511#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
512#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
513#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
514extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, char *header_msg);
515
516struct lock_file {
517 struct lock_file *next;
518 int fd;
519 pid_t owner;
520 char on_list;
521 char filename[PATH_MAX];
522};
523#define LOCK_DIE_ON_ERROR 1
524#define LOCK_NODEREF 2
525extern int unable_to_lock_error(const char *path, int err);
526extern NORETURN void unable_to_lock_index_die(const char *path, int err);
527extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
528extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
529extern int commit_lock_file(struct lock_file *);
530
531extern int hold_locked_index(struct lock_file *, int);
532extern int commit_locked_index(struct lock_file *);
533extern void set_alternate_index_output(const char *);
534extern int close_lock_file(struct lock_file *);
535extern void rollback_lock_file(struct lock_file *);
536extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
537
538/* Environment bits from configuration mechanism */
539extern int trust_executable_bit;
540extern int trust_ctime;
541extern int quote_path_fully;
542extern int has_symlinks;
543extern int ignore_case;
544extern int assume_unchanged;
545extern int prefer_symlink_refs;
546extern int log_all_ref_updates;
547extern int warn_ambiguous_refs;
548extern int shared_repository;
549extern const char *apply_default_whitespace;
550extern const char *apply_default_ignorewhitespace;
551extern int zlib_compression_level;
552extern int core_compression_level;
553extern int core_compression_seen;
554extern size_t packed_git_window_size;
555extern size_t packed_git_limit;
556extern size_t delta_base_cache_limit;
557extern int read_replace_refs;
558extern int fsync_object_files;
559extern int core_preload_index;
560extern int core_apply_sparse_checkout;
561
562enum safe_crlf {
563 SAFE_CRLF_FALSE = 0,
564 SAFE_CRLF_FAIL = 1,
565 SAFE_CRLF_WARN = 2
566};
567
568extern enum safe_crlf safe_crlf;
569
570enum auto_crlf {
571 AUTO_CRLF_FALSE = 0,
572 AUTO_CRLF_TRUE = 1,
573 AUTO_CRLF_INPUT = -1
574};
575
576extern enum auto_crlf auto_crlf;
577
578enum eol {
579 EOL_UNSET,
580 EOL_CRLF,
581 EOL_LF,
582#ifdef NATIVE_CRLF
583 EOL_NATIVE = EOL_CRLF
584#else
585 EOL_NATIVE = EOL_LF
586#endif
587};
588
589extern enum eol eol;
590
591enum branch_track {
592 BRANCH_TRACK_UNSPECIFIED = -1,
593 BRANCH_TRACK_NEVER = 0,
594 BRANCH_TRACK_REMOTE,
595 BRANCH_TRACK_ALWAYS,
596 BRANCH_TRACK_EXPLICIT,
597 BRANCH_TRACK_OVERRIDE
598};
599
600enum rebase_setup_type {
601 AUTOREBASE_NEVER = 0,
602 AUTOREBASE_LOCAL,
603 AUTOREBASE_REMOTE,
604 AUTOREBASE_ALWAYS
605};
606
607enum push_default_type {
608 PUSH_DEFAULT_NOTHING = 0,
609 PUSH_DEFAULT_MATCHING,
610 PUSH_DEFAULT_UPSTREAM,
611 PUSH_DEFAULT_CURRENT
612};
613
614extern enum branch_track git_branch_track;
615extern enum rebase_setup_type autorebase;
616extern enum push_default_type push_default;
617
618enum object_creation_mode {
619 OBJECT_CREATION_USES_HARDLINKS = 0,
620 OBJECT_CREATION_USES_RENAMES = 1
621};
622
623extern enum object_creation_mode object_creation_mode;
624
625extern char *notes_ref_name;
626
627extern int grafts_replace_parents;
628
629#define GIT_REPO_VERSION 0
630extern int repository_format_version;
631extern int check_repository_format(void);
632
633#define MTIME_CHANGED 0x0001
634#define CTIME_CHANGED 0x0002
635#define OWNER_CHANGED 0x0004
636#define MODE_CHANGED 0x0008
637#define INODE_CHANGED 0x0010
638#define DATA_CHANGED 0x0020
639#define TYPE_CHANGED 0x0040
640
641extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
642 __attribute__((format (printf, 3, 4)));
643extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
644 __attribute__((format (printf, 3, 4)));
645extern char *git_pathdup(const char *fmt, ...)
646 __attribute__((format (printf, 1, 2)));
647
648/* Return a statically allocated filename matching the sha1 signature */
649extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
650extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
651extern char *git_path_submodule(const char *path, const char *fmt, ...)
652 __attribute__((format (printf, 2, 3)));
653
654extern char *sha1_file_name(const unsigned char *sha1);
655extern char *sha1_pack_name(const unsigned char *sha1);
656extern char *sha1_pack_index_name(const unsigned char *sha1);
657extern const char *find_unique_abbrev(const unsigned char *sha1, int);
658extern const unsigned char null_sha1[20];
659static inline int is_null_sha1(const unsigned char *sha1)
660{
661 return !memcmp(sha1, null_sha1, 20);
662}
663static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
664{
665 return memcmp(sha1, sha2, 20);
666}
667static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
668{
669 memcpy(sha_dst, sha_src, 20);
670}
671static inline void hashclr(unsigned char *hash)
672{
673 memset(hash, 0, 20);
674}
675
676#define EMPTY_TREE_SHA1_HEX \
677 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
678#define EMPTY_TREE_SHA1_BIN_LITERAL \
679 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
680 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
681#define EMPTY_TREE_SHA1_BIN \
682 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
683
684int git_mkstemp(char *path, size_t n, const char *template);
685
686int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
687
688/* set default permissions by passing mode arguments to open(2) */
689int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
690int git_mkstemp_mode(char *pattern, int mode);
691
692/*
693 * NOTE NOTE NOTE!!
694 *
695 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
696 * not be changed. Old repositories have core.sharedrepository written in
697 * numeric format, and therefore these values are preserved for compatibility
698 * reasons.
699 */
700enum sharedrepo {
701 PERM_UMASK = 0,
702 OLD_PERM_GROUP = 1,
703 OLD_PERM_EVERYBODY = 2,
704 PERM_GROUP = 0660,
705 PERM_EVERYBODY = 0664
706};
707int git_config_perm(const char *var, const char *value);
708int set_shared_perm(const char *path, int mode);
709#define adjust_shared_perm(path) set_shared_perm((path), 0)
710int safe_create_leading_directories(char *path);
711int safe_create_leading_directories_const(const char *path);
712extern char *expand_user_path(const char *path);
713char *enter_repo(char *path, int strict);
714static inline int is_absolute_path(const char *path)
715{
716 return path[0] == '/' || has_dos_drive_prefix(path);
717}
718int is_directory(const char *);
719const char *make_absolute_path(const char *path);
720const char *make_nonrelative_path(const char *path);
721const char *make_relative_path(const char *abs, const char *base);
722int normalize_path_copy(char *dst, const char *src);
723int longest_ancestor_length(const char *path, const char *prefix_list);
724char *strip_path_suffix(const char *path, const char *suffix);
725int daemon_avoid_alias(const char *path);
726int offset_1st_component(const char *path);
727
728/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
729extern int sha1_object_info(const unsigned char *, unsigned long *);
730extern void *read_sha1_file_repl(const unsigned char *sha1, enum object_type *type, unsigned long *size, const unsigned char **replacement);
731static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
732{
733 return read_sha1_file_repl(sha1, type, size, NULL);
734}
735extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
736extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
737extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
738extern int force_object_loose(const unsigned char *sha1, time_t mtime);
739
740/* global flag to enable extra checks when accessing packed objects */
741extern int do_check_packed_object_crc;
742
743extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
744
745extern int move_temp_to_file(const char *tmpfile, const char *filename);
746
747extern int has_sha1_pack(const unsigned char *sha1);
748extern int has_sha1_file(const unsigned char *sha1);
749extern int has_loose_object_nonlocal(const unsigned char *sha1);
750
751extern int has_pack_index(const unsigned char *sha1);
752
753extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
754
755extern const signed char hexval_table[256];
756static inline unsigned int hexval(unsigned char c)
757{
758 return hexval_table[c];
759}
760
761/* Convert to/from hex/sha1 representation */
762#define MINIMUM_ABBREV 4
763#define DEFAULT_ABBREV 7
764
765struct object_context {
766 unsigned char tree[20];
767 char path[PATH_MAX];
768 unsigned mode;
769};
770
771extern int get_sha1(const char *str, unsigned char *sha1);
772extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int gently, const char *prefix);
773static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
774{
775 return get_sha1_with_mode_1(str, sha1, mode, 1, NULL);
776}
777extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int gently, const char *prefix);
778static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
779{
780 return get_sha1_with_context_1(str, sha1, orc, 1, NULL);
781}
782extern int get_sha1_hex(const char *hex, unsigned char *sha1);
783extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
784extern int read_ref(const char *filename, unsigned char *sha1);
785extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
786extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
787extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
788extern int interpret_branch_name(const char *str, struct strbuf *);
789extern int get_sha1_mb(const char *str, unsigned char *sha1);
790
791extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
792extern const char *ref_rev_parse_rules[];
793extern const char *ref_fetch_rules[];
794
795extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
796extern int validate_headref(const char *ref);
797
798extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
799extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
800extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
801
802extern void *read_object_with_reference(const unsigned char *sha1,
803 const char *required_type,
804 unsigned long *size,
805 unsigned char *sha1_ret);
806
807extern struct object *peel_to_type(const char *name, int namelen,
808 struct object *o, enum object_type);
809
810enum date_mode {
811 DATE_NORMAL = 0,
812 DATE_RELATIVE,
813 DATE_SHORT,
814 DATE_LOCAL,
815 DATE_ISO8601,
816 DATE_RFC2822,
817 DATE_RAW
818};
819
820const char *show_date(unsigned long time, int timezone, enum date_mode mode);
821const char *show_date_relative(unsigned long time, int tz,
822 const struct timeval *now,
823 char *timebuf,
824 size_t timebuf_size);
825int parse_date(const char *date, char *buf, int bufsize);
826int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
827void datestamp(char *buf, int bufsize);
828#define approxidate(s) approxidate_careful((s), NULL)
829unsigned long approxidate_careful(const char *, int *);
830unsigned long approxidate_relative(const char *date, const struct timeval *now);
831enum date_mode parse_date_format(const char *format);
832
833#define IDENT_WARN_ON_NO_NAME 1
834#define IDENT_ERROR_ON_NO_NAME 2
835#define IDENT_NO_DATE 4
836extern const char *git_author_info(int);
837extern const char *git_committer_info(int);
838extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
839extern const char *fmt_name(const char *name, const char *email);
840extern const char *git_editor(void);
841extern const char *git_pager(int stdout_is_tty);
842
843struct checkout {
844 const char *base_dir;
845 int base_dir_len;
846 unsigned force:1,
847 quiet:1,
848 not_new:1,
849 refresh_cache:1;
850};
851
852extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
853
854struct cache_def {
855 char path[PATH_MAX + 1];
856 int len;
857 int flags;
858 int track_flags;
859 int prefix_len_stat_func;
860};
861
862extern int has_symlink_leading_path(const char *name, int len);
863extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
864extern int check_leading_path(const char *name, int len);
865extern int has_dirs_only_path(const char *name, int len, int prefix_len);
866extern void schedule_dir_for_removal(const char *name, int len);
867extern void remove_scheduled_dirs(void);
868
869extern struct alternate_object_database {
870 struct alternate_object_database *next;
871 char *name;
872 char base[FLEX_ARRAY]; /* more */
873} *alt_odb_list;
874extern void prepare_alt_odb(void);
875extern void add_to_alternates_file(const char *reference);
876typedef int alt_odb_fn(struct alternate_object_database *, void *);
877extern void foreach_alt_odb(alt_odb_fn, void*);
878
879struct pack_window {
880 struct pack_window *next;
881 unsigned char *base;
882 off_t offset;
883 size_t len;
884 unsigned int last_used;
885 unsigned int inuse_cnt;
886};
887
888extern struct packed_git {
889 struct packed_git *next;
890 struct pack_window *windows;
891 off_t pack_size;
892 const void *index_data;
893 size_t index_size;
894 uint32_t num_objects;
895 uint32_t num_bad_objects;
896 unsigned char *bad_object_sha1;
897 int index_version;
898 time_t mtime;
899 int pack_fd;
900 unsigned pack_local:1,
901 pack_keep:1,
902 do_not_close:1;
903 unsigned char sha1[20];
904 /* something like ".git/objects/pack/xxxxx.pack" */
905 char pack_name[FLEX_ARRAY]; /* more */
906} *packed_git;
907
908struct pack_entry {
909 off_t offset;
910 unsigned char sha1[20];
911 struct packed_git *p;
912};
913
914struct ref {
915 struct ref *next;
916 unsigned char old_sha1[20];
917 unsigned char new_sha1[20];
918 char *symref;
919 unsigned int force:1,
920 merge:1,
921 nonfastforward:1,
922 deletion:1;
923 enum {
924 REF_STATUS_NONE = 0,
925 REF_STATUS_OK,
926 REF_STATUS_REJECT_NONFASTFORWARD,
927 REF_STATUS_REJECT_NODELETE,
928 REF_STATUS_UPTODATE,
929 REF_STATUS_REMOTE_REJECT,
930 REF_STATUS_EXPECTING_REPORT
931 } status;
932 char *remote_status;
933 struct ref *peer_ref; /* when renaming */
934 char name[FLEX_ARRAY]; /* more */
935};
936
937#define REF_NORMAL (1u << 0)
938#define REF_HEADS (1u << 1)
939#define REF_TAGS (1u << 2)
940
941extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
942
943#define CONNECT_VERBOSE (1u << 0)
944extern char *git_getpass(const char *prompt);
945extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
946extern int finish_connect(struct child_process *conn);
947extern int path_match(const char *path, int nr, char **match);
948struct extra_have_objects {
949 int nr, alloc;
950 unsigned char (*array)[20];
951};
952extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
953extern int server_supports(const char *feature);
954
955extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
956
957extern void prepare_packed_git(void);
958extern void reprepare_packed_git(void);
959extern void install_packed_git(struct packed_git *pack);
960
961extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
962 struct packed_git *packs);
963
964extern void pack_report(void);
965extern int open_pack_index(struct packed_git *);
966extern void close_pack_index(struct packed_git *);
967extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
968extern void close_pack_windows(struct packed_git *);
969extern void unuse_pack(struct pack_window **);
970extern void free_pack_by_name(const char *);
971extern void clear_delta_base_cache(void);
972extern struct packed_git *add_packed_git(const char *, int, int);
973extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
974extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
975extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
976extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
977extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
978extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
979extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
980
981/* Dumb servers support */
982extern int update_server_info(int);
983
984typedef int (*config_fn_t)(const char *, const char *, void *);
985extern int git_default_config(const char *, const char *, void *);
986extern int git_config_from_file(config_fn_t fn, const char *, void *);
987extern void git_config_push_parameter(const char *text);
988extern int git_config_parse_parameter(const char *text);
989extern int git_config_parse_environment(void);
990extern int git_config_from_parameters(config_fn_t fn, void *data);
991extern int git_config(config_fn_t fn, void *);
992extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
993extern int git_parse_ulong(const char *, unsigned long *);
994extern int git_config_int(const char *, const char *);
995extern unsigned long git_config_ulong(const char *, const char *);
996extern int git_config_bool_or_int(const char *, const char *, int *);
997extern int git_config_bool(const char *, const char *);
998extern int git_config_maybe_bool(const char *, const char *);
999extern int git_config_string(const char **, const char *, const char *);
1000extern int git_config_pathname(const char **, const char *, const char *);
1001extern int git_config_set(const char *, const char *);
1002extern int git_config_set_multivar(const char *, const char *, const char *, int);
1003extern int git_config_rename_section(const char *, const char *);
1004extern const char *git_etc_gitconfig(void);
1005extern int check_repository_format_version(const char *var, const char *value, void *cb);
1006extern int git_env_bool(const char *, int);
1007extern int git_config_system(void);
1008extern int git_config_global(void);
1009extern int config_error_nonbool(const char *);
1010extern const char *get_log_output_encoding(void);
1011extern const char *get_commit_output_encoding(void);
1012
1013extern const char *config_exclusive_filename;
1014
1015#define MAX_GITNAME (1000)
1016extern char git_default_email[MAX_GITNAME];
1017extern char git_default_name[MAX_GITNAME];
1018#define IDENT_NAME_GIVEN 01
1019#define IDENT_MAIL_GIVEN 02
1020#define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1021extern int user_ident_explicitly_given;
1022extern int user_ident_sufficiently_given(void);
1023
1024extern const char *git_commit_encoding;
1025extern const char *git_log_output_encoding;
1026extern const char *git_mailmap_file;
1027
1028/* IO helper functions */
1029extern void maybe_flush_or_die(FILE *, const char *);
1030extern int copy_fd(int ifd, int ofd);
1031extern int copy_file(const char *dst, const char *src, int mode);
1032extern int copy_file_with_time(const char *dst, const char *src, int mode);
1033extern void write_or_die(int fd, const void *buf, size_t count);
1034extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1035extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1036extern void fsync_or_die(int fd, const char *);
1037
1038extern ssize_t read_in_full(int fd, void *buf, size_t count);
1039extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1040static inline ssize_t write_str_in_full(int fd, const char *str)
1041{
1042 return write_in_full(fd, str, strlen(str));
1043}
1044
1045/* pager.c */
1046extern void setup_pager(void);
1047extern const char *pager_program;
1048extern int pager_in_use(void);
1049extern int pager_use_color;
1050
1051extern const char *editor_program;
1052extern const char *askpass_program;
1053extern const char *excludes_file;
1054
1055/* base85 */
1056int decode_85(char *dst, const char *line, int linelen);
1057void encode_85(char *buf, const unsigned char *data, int bytes);
1058
1059/* alloc.c */
1060extern void *alloc_blob_node(void);
1061extern void *alloc_tree_node(void);
1062extern void *alloc_commit_node(void);
1063extern void *alloc_tag_node(void);
1064extern void *alloc_object_node(void);
1065extern void alloc_report(void);
1066
1067/* trace.c */
1068__attribute__((format (printf, 1, 2)))
1069extern void trace_printf(const char *format, ...);
1070__attribute__((format (printf, 2, 3)))
1071extern void trace_argv_printf(const char **argv, const char *format, ...);
1072extern void trace_repo_setup(const char *prefix);
1073
1074/* convert.c */
1075/* returns 1 if *dst was used */
1076extern int convert_to_git(const char *path, const char *src, size_t len,
1077 struct strbuf *dst, enum safe_crlf checksafe);
1078extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
1079extern int renormalize_buffer(const char *path, const char *src, size_t len, struct strbuf *dst);
1080
1081/* add */
1082/*
1083 * return 0 if success, 1 - if addition of a file failed and
1084 * ADD_FILES_IGNORE_ERRORS was specified in flags
1085 */
1086int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1087
1088/* diff.c */
1089extern int diff_auto_refresh_index;
1090
1091/* match-trees.c */
1092void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1093void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1094
1095/*
1096 * whitespace rules.
1097 * used by both diff and apply
1098 * last two digits are tab width
1099 */
1100#define WS_BLANK_AT_EOL 0100
1101#define WS_SPACE_BEFORE_TAB 0200
1102#define WS_INDENT_WITH_NON_TAB 0400
1103#define WS_CR_AT_EOL 01000
1104#define WS_BLANK_AT_EOF 02000
1105#define WS_TAB_IN_INDENT 04000
1106#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1107#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1108#define WS_TAB_WIDTH_MASK 077
1109extern unsigned whitespace_rule_cfg;
1110extern unsigned whitespace_rule(const char *);
1111extern unsigned parse_whitespace_rule(const char *);
1112extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1113extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1114extern char *whitespace_error_string(unsigned ws);
1115extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1116extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1117#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1118
1119/* ls-files */
1120int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
1121void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1122
1123char *alias_lookup(const char *alias);
1124int split_cmdline(char *cmdline, const char ***argv);
1125/* Takes a negative value returned by split_cmdline */
1126const char *split_cmdline_strerror(int cmdline_errno);
1127
1128/* git.c */
1129struct startup_info {
1130 int have_repository;
1131 const char *prefix;
1132};
1133extern struct startup_info *startup_info;
1134
1135/* builtin/merge.c */
1136int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1137
1138#endif /* CACHE_H */