Windows: boost startup by avoiding a static dependency on shell32.dll
[git/dscho.git] / cache.h
blobcf36c8160e8027aa608da4baf59e2d9f04f0ccdd
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hash.h"
7 #include "advice.h"
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
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
22 void git_inflate_init(z_streamp strm);
23 void git_inflate_end(z_streamp strm);
24 int git_inflate(z_streamp strm, int flush);
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
40 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
41 #define S_IFINVALID     0030000
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)
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
81  * Basic data structures for the directory cache
82  */
84 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
85 struct cache_header {
86         unsigned int hdr_signature;
87         unsigned int hdr_version;
88         unsigned int hdr_entries;
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  */
96 struct cache_time {
97         unsigned int sec;
98         unsigned int nsec;
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.
106  * We save the fields in big-endian order to allow using the
107  * index file over NFS transparently.
108  */
109 struct 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 */
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  */
128 struct 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 */
143 struct 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 */
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
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
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)
178 #define CE_HASHED    (0x100000)
179 #define CE_UNHASHED  (0x200000)
180 #define CE_CONFLICTED (0x800000)
182 /* Only remove in work directory, not index */
183 #define CE_WT_REMOVE (0x400000)
186  * Extended on-disk flags
187  */
188 #define CE_INTENT_TO_ADD 0x20000000
189 #define CE_SKIP_WORKTREE 0x40000000
190 /* CE_EXTENDED2 is for future extension */
191 #define CE_EXTENDED2 0x80000000
193 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
196  * Safeguard to avoid saving wrong flags:
197  *  - CE_EXTENDED2 won't get saved until its semantic is known
198  *  - Bits in 0x0000FFFF have been saved in ce_flags already
199  *  - Bits in 0x003F0000 are currently in-memory flags
200  */
201 #if CE_EXTENDED_FLAGS & 0x803FFFFF
202 #error "CE_EXTENDED_FLAGS out of range"
203 #endif
206  * Copy the sha1 and stat state of a cache entry from one to
207  * another. But we never change the name, or the hash state!
208  */
209 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
210 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
212         unsigned int state = dst->ce_flags & CE_STATE_MASK;
214         /* Don't copy hash chain and name */
215         memcpy(dst, src, offsetof(struct cache_entry, next));
217         /* Restore the hash state */
218         dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
221 static inline unsigned create_ce_flags(size_t len, unsigned stage)
223         if (len >= CE_NAMEMASK)
224                 len = CE_NAMEMASK;
225         return (len | (stage << CE_STAGESHIFT));
228 static inline size_t ce_namelen(const struct cache_entry *ce)
230         size_t len = ce->ce_flags & CE_NAMEMASK;
231         if (len < CE_NAMEMASK)
232                 return len;
233         return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
236 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
237 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
238                             ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
239                             ondisk_cache_entry_size(ce_namelen(ce)))
240 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
241 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
242 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
243 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
245 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
246 static inline unsigned int create_ce_mode(unsigned int mode)
248         if (S_ISLNK(mode))
249                 return S_IFLNK;
250         if (S_ISDIR(mode) || S_ISGITLINK(mode))
251                 return S_IFGITLINK;
252         return S_IFREG | ce_permissions(mode);
254 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
256         extern int trust_executable_bit, has_symlinks;
257         if (!has_symlinks && S_ISREG(mode) &&
258             ce && S_ISLNK(ce->ce_mode))
259                 return ce->ce_mode;
260         if (!trust_executable_bit && S_ISREG(mode)) {
261                 if (ce && S_ISREG(ce->ce_mode))
262                         return ce->ce_mode;
263                 return create_ce_mode(0666);
264         }
265         return create_ce_mode(mode);
267 static inline int ce_to_dtype(const struct cache_entry *ce)
269         unsigned ce_mode = ntohl(ce->ce_mode);
270         if (S_ISREG(ce_mode))
271                 return DT_REG;
272         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
273                 return DT_DIR;
274         else if (S_ISLNK(ce_mode))
275                 return DT_LNK;
276         else
277                 return DT_UNKNOWN;
279 #define canon_mode(mode) \
280         (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
281         S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
283 #define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
284 #define cache_entry_size(len) flexible_size(cache_entry,len)
285 #define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
286 #define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
288 struct index_state {
289         struct cache_entry **cache;
290         unsigned int cache_nr, cache_alloc, cache_changed;
291         struct cache_tree *cache_tree;
292         struct cache_time timestamp;
293         void *alloc;
294         unsigned name_hash_initialized : 1,
295                  initialized : 1;
296         struct hash_table name_hash;
299 extern struct index_state the_index;
301 /* Name hashing */
302 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
304  * We don't actually *remove* it, we can just mark it invalid so that
305  * we won't find it in lookups.
307  * Not only would we have to search the lists (simple enough), but
308  * we'd also have to rehash other hash buckets in case this makes the
309  * hash bucket empty (common). So it's much better to just mark
310  * it.
311  */
312 static inline void remove_name_hash(struct cache_entry *ce)
314         ce->ce_flags |= CE_UNHASHED;
318 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
319 #define active_cache (the_index.cache)
320 #define active_nr (the_index.cache_nr)
321 #define active_alloc (the_index.cache_alloc)
322 #define active_cache_changed (the_index.cache_changed)
323 #define active_cache_tree (the_index.cache_tree)
325 #define read_cache() read_index(&the_index)
326 #define read_cache_from(path) read_index_from(&the_index, (path))
327 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
328 #define is_cache_unborn() is_index_unborn(&the_index)
329 #define read_cache_unmerged() read_index_unmerged(&the_index)
330 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
331 #define discard_cache() discard_index(&the_index)
332 #define unmerged_cache() unmerged_index(&the_index)
333 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
334 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
335 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
336 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
337 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
338 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
339 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
340 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
341 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
342 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
343 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
344 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
345 #endif
347 enum object_type {
348         OBJ_BAD = -1,
349         OBJ_NONE = 0,
350         OBJ_COMMIT = 1,
351         OBJ_TREE = 2,
352         OBJ_BLOB = 3,
353         OBJ_TAG = 4,
354         /* 5 for future expansion */
355         OBJ_OFS_DELTA = 6,
356         OBJ_REF_DELTA = 7,
357         OBJ_ANY,
358         OBJ_MAX,
361 static inline enum object_type object_type(unsigned int mode)
363         return S_ISDIR(mode) ? OBJ_TREE :
364                 S_ISGITLINK(mode) ? OBJ_COMMIT :
365                 OBJ_BLOB;
368 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
369 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
370 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
371 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
372 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
373 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
374 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
375 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
376 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
377 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
378 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
379 #define GITATTRIBUTES_FILE ".gitattributes"
380 #define INFOATTRIBUTES_FILE "info/attributes"
381 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
382 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
383 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
385 extern int is_bare_repository_cfg;
386 extern int is_bare_repository(void);
387 extern int is_inside_git_dir(void);
388 extern char *git_work_tree_cfg;
389 extern int is_inside_work_tree(void);
390 extern int have_git_dir(void);
391 extern const char *get_git_dir(void);
392 extern char *get_object_directory(void);
393 extern char *get_index_file(void);
394 extern char *get_graft_file(void);
395 extern int set_git_dir(const char *path);
396 extern const char *get_git_work_tree(void);
397 extern const char *read_gitfile_gently(const char *path);
398 extern void set_git_work_tree(const char *tree);
400 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
402 extern const char **get_pathspec(const char *prefix, const char **pathspec);
403 extern void setup_work_tree(void);
404 extern const char *setup_git_directory_gently(int *);
405 extern const char *setup_git_directory(void);
406 extern const char *prefix_path(const char *prefix, int len, const char *path);
407 extern const char *prefix_filename(const char *prefix, int len, const char *path);
408 extern int check_filename(const char *prefix, const char *name);
409 extern void verify_filename(const char *prefix, const char *name);
410 extern void verify_non_filename(const char *prefix, const char *name);
412 #define INIT_DB_QUIET 0x0001
414 extern int init_db(const char *template_dir, unsigned int flags);
416 #define alloc_nr(x) (((x)+16)*3/2)
419  * Realloc the buffer pointed at by variable 'x' so that it can hold
420  * at least 'nr' entries; the number of entries currently allocated
421  * is 'alloc', using the standard growing factor alloc_nr() macro.
423  * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
424  */
425 #define ALLOC_GROW(x, nr, alloc) \
426         do { \
427                 if ((nr) > alloc) { \
428                         if (alloc_nr(alloc) < (nr)) \
429                                 alloc = (nr); \
430                         else \
431                                 alloc = alloc_nr(alloc); \
432                         x = xrealloc((x), alloc * sizeof(*(x))); \
433                 } \
434         } while(0)
436 /* Initialize and use the cache information */
437 extern int read_index(struct index_state *);
438 extern int read_index_preload(struct index_state *, const char **pathspec);
439 extern int read_index_from(struct index_state *, const char *path);
440 extern int is_index_unborn(struct index_state *);
441 extern int read_index_unmerged(struct index_state *);
442 extern int write_index(struct index_state *, int newfd);
443 extern int discard_index(struct index_state *);
444 extern int unmerged_index(const struct index_state *);
445 extern int verify_path(const char *path);
446 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
447 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
448 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
449 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
450 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
451 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
452 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
453 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
454 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
455 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
456 extern int remove_index_entry_at(struct index_state *, int pos);
457 extern void remove_marked_cache_entries(struct index_state *istate);
458 extern int remove_file_from_index(struct index_state *, const char *path);
459 #define ADD_CACHE_VERBOSE 1
460 #define ADD_CACHE_PRETEND 2
461 #define ADD_CACHE_IGNORE_ERRORS 4
462 #define ADD_CACHE_IGNORE_REMOVAL 8
463 #define ADD_CACHE_INTENT 16
464 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
465 extern int add_file_to_index(struct index_state *, const char *path, int flags);
466 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
467 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
468 extern int index_name_is_other(const struct index_state *, const char *, int);
470 /* do stat comparison even if CE_VALID is true */
471 #define CE_MATCH_IGNORE_VALID           01
472 /* do not check the contents but report dirty on racily-clean entries */
473 #define CE_MATCH_RACY_IS_DIRTY          02
474 /* do stat comparison even if CE_SKIP_WORKTREE is true */
475 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
476 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
477 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
479 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
480 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
481 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
482 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
484 /* "careful lstat()" */
485 extern int check_path(const char *path, int len, struct stat *st, int skiplen);
487 #define REFRESH_REALLY          0x0001  /* ignore_valid */
488 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
489 #define REFRESH_QUIET           0x0004  /* be quiet about it */
490 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
491 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
492 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
493 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, char *header_msg);
495 struct lock_file {
496         struct lock_file *next;
497         int fd;
498         pid_t owner;
499         char on_list;
500         char filename[PATH_MAX];
502 #define LOCK_DIE_ON_ERROR 1
503 #define LOCK_NODEREF 2
504 extern int unable_to_lock_error(const char *path, int err);
505 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
506 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
507 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
508 extern int commit_lock_file(struct lock_file *);
510 extern int hold_locked_index(struct lock_file *, int);
511 extern int commit_locked_index(struct lock_file *);
512 extern void set_alternate_index_output(const char *);
513 extern int close_lock_file(struct lock_file *);
514 extern void rollback_lock_file(struct lock_file *);
515 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
517 /* Environment bits from configuration mechanism */
518 extern int trust_executable_bit;
519 extern int trust_ctime;
520 extern int quote_path_fully;
521 extern int has_symlinks;
522 extern int ignore_case;
523 extern int assume_unchanged;
524 extern int prefer_symlink_refs;
525 extern int log_all_ref_updates;
526 extern int warn_ambiguous_refs;
527 extern int shared_repository;
528 extern const char *apply_default_whitespace;
529 extern const char *apply_default_ignorewhitespace;
530 extern int zlib_compression_level;
531 extern int core_compression_level;
532 extern int core_compression_seen;
533 extern size_t packed_git_window_size;
534 extern size_t packed_git_limit;
535 extern size_t delta_base_cache_limit;
536 extern int auto_crlf;
537 extern int read_replace_refs;
538 extern int fsync_object_files;
539 extern int core_preload_index;
540 extern int core_apply_sparse_checkout;
542 enum safe_crlf {
543         SAFE_CRLF_FALSE = 0,
544         SAFE_CRLF_FAIL = 1,
545         SAFE_CRLF_WARN = 2,
548 extern enum safe_crlf safe_crlf;
550 enum branch_track {
551         BRANCH_TRACK_UNSPECIFIED = -1,
552         BRANCH_TRACK_NEVER = 0,
553         BRANCH_TRACK_REMOTE,
554         BRANCH_TRACK_ALWAYS,
555         BRANCH_TRACK_EXPLICIT,
558 enum rebase_setup_type {
559         AUTOREBASE_NEVER = 0,
560         AUTOREBASE_LOCAL,
561         AUTOREBASE_REMOTE,
562         AUTOREBASE_ALWAYS,
565 enum push_default_type {
566         PUSH_DEFAULT_NOTHING = 0,
567         PUSH_DEFAULT_MATCHING,
568         PUSH_DEFAULT_TRACKING,
569         PUSH_DEFAULT_CURRENT,
572 extern enum branch_track git_branch_track;
573 extern enum rebase_setup_type autorebase;
574 extern enum push_default_type push_default;
576 enum object_creation_mode {
577         OBJECT_CREATION_USES_HARDLINKS = 0,
578         OBJECT_CREATION_USES_RENAMES = 1,
581 extern enum object_creation_mode object_creation_mode;
583 extern char *notes_ref_name;
585 extern int grafts_replace_parents;
587 #define GIT_REPO_VERSION 0
588 extern int repository_format_version;
589 extern int check_repository_format(void);
591 #define MTIME_CHANGED   0x0001
592 #define CTIME_CHANGED   0x0002
593 #define OWNER_CHANGED   0x0004
594 #define MODE_CHANGED    0x0008
595 #define INODE_CHANGED   0x0010
596 #define DATA_CHANGED    0x0020
597 #define TYPE_CHANGED    0x0040
599 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
600         __attribute__((format (printf, 3, 4)));
601 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
602         __attribute__((format (printf, 3, 4)));
603 extern char *git_pathdup(const char *fmt, ...)
604         __attribute__((format (printf, 1, 2)));
606 /* Return a statically allocated filename matching the sha1 signature */
607 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
608 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
609 extern char *sha1_file_name(const unsigned char *sha1);
610 extern char *sha1_pack_name(const unsigned char *sha1);
611 extern char *sha1_pack_index_name(const unsigned char *sha1);
612 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
613 extern const unsigned char null_sha1[20];
614 static inline int is_null_sha1(const unsigned char *sha1)
616         return !memcmp(sha1, null_sha1, 20);
618 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
620         return memcmp(sha1, sha2, 20);
622 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
624         memcpy(sha_dst, sha_src, 20);
626 static inline void hashclr(unsigned char *hash)
628         memset(hash, 0, 20);
630 extern int is_empty_blob_sha1(const unsigned char *sha1);
632 #define EMPTY_TREE_SHA1_HEX \
633         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
634 #define EMPTY_TREE_SHA1_BIN \
635          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
636          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
638 int git_mkstemp(char *path, size_t n, const char *template);
640 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
643  * NOTE NOTE NOTE!!
645  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
646  * not be changed. Old repositories have core.sharedrepository written in
647  * numeric format, and therefore these values are preserved for compatibility
648  * reasons.
649  */
650 enum sharedrepo {
651         PERM_UMASK          = 0,
652         OLD_PERM_GROUP      = 1,
653         OLD_PERM_EVERYBODY  = 2,
654         PERM_GROUP          = 0660,
655         PERM_EVERYBODY      = 0664,
657 int git_config_perm(const char *var, const char *value);
658 int set_shared_perm(const char *path, int mode);
659 #define adjust_shared_perm(path) set_shared_perm((path), 0)
660 int safe_create_leading_directories(char *path);
661 int safe_create_leading_directories_const(const char *path);
662 extern char *expand_user_path(const char *path);
663 char *enter_repo(char *path, int strict);
664 static inline int is_absolute_path(const char *path)
666         return path[0] == '/' || has_dos_drive_prefix(path);
668 int is_directory(const char *);
669 const char *make_absolute_path(const char *path);
670 const char *make_nonrelative_path(const char *path);
671 const char *make_relative_path(const char *abs, const char *base);
672 int normalize_path_copy(char *dst, const char *src);
673 int longest_ancestor_length(const char *path, const char *prefix_list);
674 char *strip_path_suffix(const char *path, const char *suffix);
675 int daemon_avoid_alias(const char *path);
677 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
678 extern int sha1_object_info(const unsigned char *, unsigned long *);
679 extern void *read_sha1_file_repl(const unsigned char *sha1, enum object_type *type, unsigned long *size, const unsigned char **replacement);
680 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
682         return read_sha1_file_repl(sha1, type, size, NULL);
684 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
685 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
686 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
687 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
689 /* global flag to enable extra checks when accessing packed objects */
690 extern int do_check_packed_object_crc;
692 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
694 extern int move_temp_to_file(const char *tmpfile, const char *filename);
696 extern int has_sha1_pack(const unsigned char *sha1);
697 extern int has_sha1_file(const unsigned char *sha1);
698 extern int has_loose_object_nonlocal(const unsigned char *sha1);
700 extern int has_pack_file(const unsigned char *sha1);
701 extern int has_pack_index(const unsigned char *sha1);
703 extern const signed char hexval_table[256];
704 static inline unsigned int hexval(unsigned char c)
706         return hexval_table[c];
709 /* Convert to/from hex/sha1 representation */
710 #define MINIMUM_ABBREV 4
711 #define DEFAULT_ABBREV 7
713 extern int get_sha1(const char *str, unsigned char *sha1);
714 extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int gently, const char *prefix);
715 static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
717         return get_sha1_with_mode_1(str, sha1, mode, 1, NULL);
719 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
720 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
721 extern int read_ref(const char *filename, unsigned char *sha1);
722 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
723 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
724 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
725 extern int interpret_branch_name(const char *str, struct strbuf *);
726 extern int get_sha1_mb(const char *str, unsigned char *sha1);
728 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
729 extern const char *ref_rev_parse_rules[];
730 extern const char *ref_fetch_rules[];
732 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
733 extern int validate_headref(const char *ref);
735 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
736 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
737 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
739 extern void *read_object_with_reference(const unsigned char *sha1,
740                                         const char *required_type,
741                                         unsigned long *size,
742                                         unsigned char *sha1_ret);
744 extern struct object *peel_to_type(const char *name, int namelen,
745                                    struct object *o, enum object_type);
747 enum date_mode {
748         DATE_NORMAL = 0,
749         DATE_RELATIVE,
750         DATE_SHORT,
751         DATE_LOCAL,
752         DATE_ISO8601,
753         DATE_RFC2822,
754         DATE_RAW
757 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
758 const char *show_date_relative(unsigned long time, int tz,
759                                const struct timeval *now,
760                                char *timebuf,
761                                size_t timebuf_size);
762 int parse_date(const char *date, char *buf, int bufsize);
763 void datestamp(char *buf, int bufsize);
764 unsigned long approxidate(const char *);
765 unsigned long approxidate_relative(const char *date, const struct timeval *now);
766 enum date_mode parse_date_format(const char *format);
768 #define IDENT_WARN_ON_NO_NAME  1
769 #define IDENT_ERROR_ON_NO_NAME 2
770 #define IDENT_NO_DATE          4
771 extern const char *git_author_info(int);
772 extern const char *git_committer_info(int);
773 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
774 extern const char *fmt_name(const char *name, const char *email);
775 extern const char *git_editor(void);
776 extern const char *git_pager(void);
778 struct checkout {
779         const char *base_dir;
780         int base_dir_len;
781         unsigned force:1,
782                  quiet:1,
783                  not_new:1,
784                  refresh_cache:1;
787 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
789 struct cache_def {
790         char path[PATH_MAX + 1];
791         int len;
792         int flags;
793         int track_flags;
794         int prefix_len_stat_func;
797 extern int has_symlink_leading_path(const char *name, int len);
798 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
799 extern int has_symlink_or_noent_leading_path(const char *name, int len);
800 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
801 extern void invalidate_lstat_cache(const char *name, int len);
802 extern void clear_lstat_cache(void);
803 extern void schedule_dir_for_removal(const char *name, int len);
804 extern void remove_scheduled_dirs(void);
806 extern struct alternate_object_database {
807         struct alternate_object_database *next;
808         char *name;
809         char base[FLEX_ARRAY]; /* more */
810 } *alt_odb_list;
811 extern void prepare_alt_odb(void);
812 extern void add_to_alternates_file(const char *reference);
813 typedef int alt_odb_fn(struct alternate_object_database *, void *);
814 extern void foreach_alt_odb(alt_odb_fn, void*);
816 struct pack_window {
817         struct pack_window *next;
818         unsigned char *base;
819         off_t offset;
820         size_t len;
821         unsigned int last_used;
822         unsigned int inuse_cnt;
825 extern struct packed_git {
826         struct packed_git *next;
827         struct pack_window *windows;
828         off_t pack_size;
829         const void *index_data;
830         size_t index_size;
831         uint32_t num_objects;
832         uint32_t num_bad_objects;
833         unsigned char *bad_object_sha1;
834         int index_version;
835         time_t mtime;
836         int pack_fd;
837         unsigned pack_local:1,
838                  pack_keep:1;
839         unsigned char sha1[20];
840         /* something like ".git/objects/pack/xxxxx.pack" */
841         char pack_name[FLEX_ARRAY]; /* more */
842 } *packed_git;
844 struct pack_entry {
845         off_t offset;
846         unsigned char sha1[20];
847         struct packed_git *p;
850 struct ref {
851         struct ref *next;
852         unsigned char old_sha1[20];
853         unsigned char new_sha1[20];
854         char *symref;
855         unsigned int force:1,
856                 merge:1,
857                 nonfastforward:1,
858                 deletion:1;
859         enum {
860                 REF_STATUS_NONE = 0,
861                 REF_STATUS_OK,
862                 REF_STATUS_REJECT_NONFASTFORWARD,
863                 REF_STATUS_REJECT_NODELETE,
864                 REF_STATUS_UPTODATE,
865                 REF_STATUS_REMOTE_REJECT,
866                 REF_STATUS_EXPECTING_REPORT,
867         } status;
868         char *remote_status;
869         struct ref *peer_ref; /* when renaming */
870         char name[FLEX_ARRAY]; /* more */
873 #define REF_NORMAL      (1u << 0)
874 #define REF_HEADS       (1u << 1)
875 #define REF_TAGS        (1u << 2)
877 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
879 #define CONNECT_VERBOSE       (1u << 0)
880 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
881 extern int finish_connect(struct child_process *conn);
882 extern int path_match(const char *path, int nr, char **match);
883 struct extra_have_objects {
884         int nr, alloc;
885         unsigned char (*array)[20];
887 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
888 extern int server_supports(const char *feature);
890 extern struct packed_git *parse_pack_index(unsigned char *sha1);
892 extern void prepare_packed_git(void);
893 extern void reprepare_packed_git(void);
894 extern void install_packed_git(struct packed_git *pack);
896 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
897                                          struct packed_git *packs);
899 extern void pack_report(void);
900 extern int open_pack_index(struct packed_git *);
901 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
902 extern void close_pack_windows(struct packed_git *);
903 extern void unuse_pack(struct pack_window **);
904 extern void free_pack_by_name(const char *);
905 extern void clear_delta_base_cache(void);
906 extern struct packed_git *add_packed_git(const char *, int, int);
907 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
908 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
909 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
910 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
911 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
912 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
913 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
915 /* Dumb servers support */
916 extern int update_server_info(int);
918 typedef int (*config_fn_t)(const char *, const char *, void *);
919 extern int git_default_config(const char *, const char *, void *);
920 extern int git_config_from_file(config_fn_t fn, const char *, void *);
921 extern int git_config(config_fn_t fn, void *);
922 extern int git_parse_ulong(const char *, unsigned long *);
923 extern int git_config_int(const char *, const char *);
924 extern unsigned long git_config_ulong(const char *, const char *);
925 extern int git_config_bool_or_int(const char *, const char *, int *);
926 extern int git_config_bool(const char *, const char *);
927 extern int git_config_string(const char **, const char *, const char *);
928 extern int git_config_pathname(const char **, const char *, const char *);
929 extern int git_config_set(const char *, const char *);
930 extern int git_config_set_multivar(const char *, const char *, const char *, int);
931 extern int git_config_rename_section(const char *, const char *);
932 extern const char *git_etc_gitconfig(void);
933 extern int check_repository_format_version(const char *var, const char *value, void *cb);
934 extern int git_config_system(void);
935 extern int git_config_global(void);
936 extern int config_error_nonbool(const char *);
937 extern const char *config_exclusive_filename;
939 #define MAX_GITNAME (1000)
940 extern char git_default_email[MAX_GITNAME];
941 extern char git_default_name[MAX_GITNAME];
942 extern int user_ident_explicitly_given;
944 extern const char *git_commit_encoding;
945 extern const char *git_log_output_encoding;
946 extern const char *git_mailmap_file;
948 /* IO helper functions */
949 extern void maybe_flush_or_die(FILE *, const char *);
950 extern int copy_fd(int ifd, int ofd);
951 extern int copy_file(const char *dst, const char *src, int mode);
952 extern int copy_file_with_time(const char *dst, const char *src, int mode);
953 extern void write_or_die(int fd, const void *buf, size_t count);
954 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
955 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
956 extern void fsync_or_die(int fd, const char *);
958 extern ssize_t read_in_full(int fd, void *buf, size_t count);
959 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
960 static inline ssize_t write_str_in_full(int fd, const char *str)
962         return write_in_full(fd, str, strlen(str));
965 /* pager.c */
966 extern void setup_pager(void);
967 extern const char *pager_program;
968 extern int pager_in_use(void);
969 extern int pager_use_color;
971 extern const char *editor_program;
972 extern const char *excludes_file;
974 /* base85 */
975 int decode_85(char *dst, const char *line, int linelen);
976 void encode_85(char *buf, const unsigned char *data, int bytes);
978 /* alloc.c */
979 extern void *alloc_blob_node(void);
980 extern void *alloc_tree_node(void);
981 extern void *alloc_commit_node(void);
982 extern void *alloc_tag_node(void);
983 extern void *alloc_object_node(void);
984 extern void alloc_report(void);
986 /* trace.c */
987 __attribute__((format (printf, 1, 2)))
988 extern void trace_printf(const char *format, ...);
989 __attribute__((format (printf, 2, 3)))
990 extern void trace_argv_printf(const char **argv, const char *format, ...);
992 /* convert.c */
993 /* returns 1 if *dst was used */
994 extern int convert_to_git(const char *path, const char *src, size_t len,
995                           struct strbuf *dst, enum safe_crlf checksafe);
996 extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
998 /* add */
1000  * return 0 if success, 1 - if addition of a file failed and
1001  * ADD_FILES_IGNORE_ERRORS was specified in flags
1002  */
1003 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1005 /* diff.c */
1006 extern int diff_auto_refresh_index;
1008 /* match-trees.c */
1009 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1012  * whitespace rules.
1013  * used by both diff and apply
1014  */
1015 #define WS_BLANK_AT_EOL         01
1016 #define WS_SPACE_BEFORE_TAB     02
1017 #define WS_INDENT_WITH_NON_TAB  04
1018 #define WS_CR_AT_EOL           010
1019 #define WS_BLANK_AT_EOF        020
1020 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1021 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
1022 extern unsigned whitespace_rule_cfg;
1023 extern unsigned whitespace_rule(const char *);
1024 extern unsigned parse_whitespace_rule(const char *);
1025 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1026 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1027 extern char *whitespace_error_string(unsigned ws);
1028 extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
1029 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1031 /* ls-files */
1032 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
1033 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1035 char *alias_lookup(const char *alias);
1036 int split_cmdline(char *cmdline, const char ***argv);
1038 #endif /* CACHE_H */