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