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