ie_match_stat(): do not ignore skip-worktree bit with CE_MATCH_IGNORE_VALID
[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
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
21 void git_inflate_init(z_streamp strm);
22 void git_inflate_end(z_streamp strm);
23 int 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" */
84 struct 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 */
95 struct 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 */
108 struct 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 */
127 struct 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
142 struct 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)
208 static 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
219 static 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
226 static 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)
244 static 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 }
252 static 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 }
265 static 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
286 struct 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
297 extern struct index_state the_index;
298
299 /* Name hashing */
300 extern 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 */
310 static 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
345 enum 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
359 static 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
380 extern int is_bare_repository_cfg;
381 extern int is_bare_repository(void);
382 extern int is_inside_git_dir(void);
383 extern char *git_work_tree_cfg;
384 extern int is_inside_work_tree(void);
385 extern int have_git_dir(void);
386 extern const char *get_git_dir(void);
387 extern char *get_object_directory(void);
388 extern char *get_index_file(void);
389 extern char *get_graft_file(void);
390 extern int set_git_dir(const char *path);
391 extern const char *get_git_work_tree(void);
392 extern const char *read_gitfile_gently(const char *path);
393 extern void set_git_work_tree(const char *tree);
394
395 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
396
397 extern const char **get_pathspec(const char *prefix, const char **pathspec);
398 extern void setup_work_tree(void);
399 extern const char *setup_git_directory_gently(int *);
400 extern const char *setup_git_directory(void);
401 extern const char *prefix_path(const char *prefix, int len, const char *path);
402 extern const char *prefix_filename(const char *prefix, int len, const char *path);
403 extern void verify_filename(const char *prefix, const char *name);
404 extern void verify_non_filename(const char *prefix, const char *name);
405
406 #define INIT_DB_QUIET 0x0001
407
408 extern 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 */
431 extern int read_index(struct index_state *);
432 extern int read_index_preload(struct index_state *, const char **pathspec);
433 extern int read_index_from(struct index_state *, const char *path);
434 extern int is_index_unborn(struct index_state *);
435 extern int read_index_unmerged(struct index_state *);
436 extern int write_index(struct index_state *, int newfd);
437 extern int discard_index(struct index_state *);
438 extern int unmerged_index(const struct index_state *);
439 extern int verify_path(const char *path);
440 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
441 extern 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 */
447 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
448 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
449 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
450 extern int remove_index_entry_at(struct index_state *, int pos);
451 extern void remove_marked_cache_entries(struct index_state *istate);
452 extern 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
458 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
459 extern int add_file_to_index(struct index_state *, const char *path, int flags);
460 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
461 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
462 extern 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
468 /* do stat comparison even if CE_SKIP_WORKTREE is true */
469 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
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);
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_SAY_CHANGED 0x0020 /* say "changed" not "needs update" */
487 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
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 NORETURN void unable_to_lock_index_die(const char *path, int err);
499 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
500 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
501 extern int commit_lock_file(struct lock_file *);
502
503 extern int hold_locked_index(struct lock_file *, int);
504 extern int commit_locked_index(struct lock_file *);
505 extern void set_alternate_index_output(const char *);
506 extern int close_lock_file(struct lock_file *);
507 extern void rollback_lock_file(struct lock_file *);
508 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
509
510 /* Environment bits from configuration mechanism */
511 extern int trust_executable_bit;
512 extern int trust_ctime;
513 extern int quote_path_fully;
514 extern int has_symlinks;
515 extern int ignore_case;
516 extern int assume_unchanged;
517 extern int prefer_symlink_refs;
518 extern int log_all_ref_updates;
519 extern int warn_ambiguous_refs;
520 extern int shared_repository;
521 extern const char *apply_default_whitespace;
522 extern int zlib_compression_level;
523 extern int core_compression_level;
524 extern int core_compression_seen;
525 extern size_t packed_git_window_size;
526 extern size_t packed_git_limit;
527 extern size_t delta_base_cache_limit;
528 extern int auto_crlf;
529 extern int fsync_object_files;
530 extern int core_preload_index;
531 extern int core_apply_sparse_checkout;
532
533 enum safe_crlf {
534 SAFE_CRLF_FALSE = 0,
535 SAFE_CRLF_FAIL = 1,
536 SAFE_CRLF_WARN = 2,
537 };
538
539 extern enum safe_crlf safe_crlf;
540
541 enum branch_track {
542 BRANCH_TRACK_UNSPECIFIED = -1,
543 BRANCH_TRACK_NEVER = 0,
544 BRANCH_TRACK_REMOTE,
545 BRANCH_TRACK_ALWAYS,
546 BRANCH_TRACK_EXPLICIT,
547 };
548
549 enum rebase_setup_type {
550 AUTOREBASE_NEVER = 0,
551 AUTOREBASE_LOCAL,
552 AUTOREBASE_REMOTE,
553 AUTOREBASE_ALWAYS,
554 };
555
556 enum push_default_type {
557 PUSH_DEFAULT_NOTHING = 0,
558 PUSH_DEFAULT_MATCHING,
559 PUSH_DEFAULT_TRACKING,
560 PUSH_DEFAULT_CURRENT,
561 };
562
563 extern enum branch_track git_branch_track;
564 extern enum rebase_setup_type autorebase;
565 extern enum push_default_type push_default;
566
567 enum object_creation_mode {
568 OBJECT_CREATION_USES_HARDLINKS = 0,
569 OBJECT_CREATION_USES_RENAMES = 1,
570 };
571
572 extern enum object_creation_mode object_creation_mode;
573
574 extern int grafts_replace_parents;
575
576 #define GIT_REPO_VERSION 0
577 extern int repository_format_version;
578 extern int check_repository_format(void);
579
580 #define MTIME_CHANGED 0x0001
581 #define CTIME_CHANGED 0x0002
582 #define OWNER_CHANGED 0x0004
583 #define MODE_CHANGED 0x0008
584 #define INODE_CHANGED 0x0010
585 #define DATA_CHANGED 0x0020
586 #define TYPE_CHANGED 0x0040
587
588 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
589 __attribute__((format (printf, 3, 4)));
590 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
591 __attribute__((format (printf, 3, 4)));
592 extern char *git_pathdup(const char *fmt, ...)
593 __attribute__((format (printf, 1, 2)));
594
595 /* Return a statically allocated filename matching the sha1 signature */
596 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
597 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
598 extern char *sha1_file_name(const unsigned char *sha1);
599 extern char *sha1_pack_name(const unsigned char *sha1);
600 extern char *sha1_pack_index_name(const unsigned char *sha1);
601 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
602 extern const unsigned char null_sha1[20];
603 static inline int is_null_sha1(const unsigned char *sha1)
604 {
605 return !memcmp(sha1, null_sha1, 20);
606 }
607 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
608 {
609 return memcmp(sha1, sha2, 20);
610 }
611 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
612 {
613 memcpy(sha_dst, sha_src, 20);
614 }
615 static inline void hashclr(unsigned char *hash)
616 {
617 memset(hash, 0, 20);
618 }
619 extern int is_empty_blob_sha1(const unsigned char *sha1);
620
621 #define EMPTY_TREE_SHA1_HEX \
622 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
623 #define EMPTY_TREE_SHA1_BIN \
624 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
625 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
626
627 int git_mkstemp(char *path, size_t n, const char *template);
628
629 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
630
631 /*
632 * NOTE NOTE NOTE!!
633 *
634 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
635 * not be changed. Old repositories have core.sharedrepository written in
636 * numeric format, and therefore these values are preserved for compatibility
637 * reasons.
638 */
639 enum sharedrepo {
640 PERM_UMASK = 0,
641 OLD_PERM_GROUP = 1,
642 OLD_PERM_EVERYBODY = 2,
643 PERM_GROUP = 0660,
644 PERM_EVERYBODY = 0664,
645 };
646 int git_config_perm(const char *var, const char *value);
647 int set_shared_perm(const char *path, int mode);
648 #define adjust_shared_perm(path) set_shared_perm((path), 0)
649 int safe_create_leading_directories(char *path);
650 int safe_create_leading_directories_const(const char *path);
651 char *enter_repo(char *path, int strict);
652 static inline int is_absolute_path(const char *path)
653 {
654 return path[0] == '/' || has_dos_drive_prefix(path);
655 }
656 int is_directory(const char *);
657 const char *make_absolute_path(const char *path);
658 const char *make_nonrelative_path(const char *path);
659 const char *make_relative_path(const char *abs, const char *base);
660 int normalize_path_copy(char *dst, const char *src);
661 int longest_ancestor_length(const char *path, const char *prefix_list);
662 char *strip_path_suffix(const char *path, const char *suffix);
663
664 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
665 extern int sha1_object_info(const unsigned char *, unsigned long *);
666 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
667 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
668 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
669 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
670 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
671
672 /* global flag to enable extra checks when accessing packed objects */
673 extern int do_check_packed_object_crc;
674
675 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
676
677 extern int move_temp_to_file(const char *tmpfile, const char *filename);
678
679 extern int has_sha1_pack(const unsigned char *sha1);
680 extern int has_sha1_file(const unsigned char *sha1);
681 extern int has_loose_object_nonlocal(const unsigned char *sha1);
682
683 extern int has_pack_file(const unsigned char *sha1);
684 extern int has_pack_index(const unsigned char *sha1);
685
686 extern const signed char hexval_table[256];
687 static inline unsigned int hexval(unsigned char c)
688 {
689 return hexval_table[c];
690 }
691
692 /* Convert to/from hex/sha1 representation */
693 #define MINIMUM_ABBREV 4
694 #define DEFAULT_ABBREV 7
695
696 extern int get_sha1(const char *str, unsigned char *sha1);
697 extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
698 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
699 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
700 extern int read_ref(const char *filename, unsigned char *sha1);
701 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
702 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
703 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
704 extern int interpret_branch_name(const char *str, struct strbuf *);
705
706 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
707 extern const char *ref_rev_parse_rules[];
708 extern const char *ref_fetch_rules[];
709
710 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
711 extern int validate_headref(const char *ref);
712
713 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
714 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
715 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
716
717 extern void *read_object_with_reference(const unsigned char *sha1,
718 const char *required_type,
719 unsigned long *size,
720 unsigned char *sha1_ret);
721
722 extern struct object *peel_to_type(const char *name, int namelen,
723 struct object *o, enum object_type);
724
725 enum date_mode {
726 DATE_NORMAL = 0,
727 DATE_RELATIVE,
728 DATE_SHORT,
729 DATE_LOCAL,
730 DATE_ISO8601,
731 DATE_RFC2822,
732 DATE_RAW
733 };
734
735 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
736 int parse_date(const char *date, char *buf, int bufsize);
737 void datestamp(char *buf, int bufsize);
738 unsigned long approxidate(const char *);
739 enum date_mode parse_date_format(const char *format);
740
741 #define IDENT_WARN_ON_NO_NAME 1
742 #define IDENT_ERROR_ON_NO_NAME 2
743 #define IDENT_NO_DATE 4
744 extern const char *git_author_info(int);
745 extern const char *git_committer_info(int);
746 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
747 extern const char *fmt_name(const char *name, const char *email);
748
749 struct checkout {
750 const char *base_dir;
751 int base_dir_len;
752 unsigned force:1,
753 quiet:1,
754 not_new:1,
755 refresh_cache:1;
756 };
757
758 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
759
760 struct cache_def {
761 char path[PATH_MAX + 1];
762 int len;
763 int flags;
764 int track_flags;
765 int prefix_len_stat_func;
766 };
767
768 extern int has_symlink_leading_path(const char *name, int len);
769 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
770 extern int has_symlink_or_noent_leading_path(const char *name, int len);
771 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
772 extern void invalidate_lstat_cache(const char *name, int len);
773 extern void clear_lstat_cache(void);
774 extern void schedule_dir_for_removal(const char *name, int len);
775 extern void remove_scheduled_dirs(void);
776
777 extern struct alternate_object_database {
778 struct alternate_object_database *next;
779 char *name;
780 char base[FLEX_ARRAY]; /* more */
781 } *alt_odb_list;
782 extern void prepare_alt_odb(void);
783 extern void add_to_alternates_file(const char *reference);
784 typedef int alt_odb_fn(struct alternate_object_database *, void *);
785 extern void foreach_alt_odb(alt_odb_fn, void*);
786
787 struct pack_window {
788 struct pack_window *next;
789 unsigned char *base;
790 off_t offset;
791 size_t len;
792 unsigned int last_used;
793 unsigned int inuse_cnt;
794 };
795
796 extern struct packed_git {
797 struct packed_git *next;
798 struct pack_window *windows;
799 off_t pack_size;
800 const void *index_data;
801 size_t index_size;
802 uint32_t num_objects;
803 uint32_t num_bad_objects;
804 unsigned char *bad_object_sha1;
805 int index_version;
806 time_t mtime;
807 int pack_fd;
808 unsigned pack_local:1,
809 pack_keep:1;
810 unsigned char sha1[20];
811 /* something like ".git/objects/pack/xxxxx.pack" */
812 char pack_name[FLEX_ARRAY]; /* more */
813 } *packed_git;
814
815 struct pack_entry {
816 off_t offset;
817 unsigned char sha1[20];
818 struct packed_git *p;
819 };
820
821 struct ref {
822 struct ref *next;
823 unsigned char old_sha1[20];
824 unsigned char new_sha1[20];
825 char *symref;
826 unsigned int force:1,
827 merge:1,
828 nonfastforward:1,
829 deletion:1;
830 enum {
831 REF_STATUS_NONE = 0,
832 REF_STATUS_OK,
833 REF_STATUS_REJECT_NONFASTFORWARD,
834 REF_STATUS_REJECT_NODELETE,
835 REF_STATUS_UPTODATE,
836 REF_STATUS_REMOTE_REJECT,
837 REF_STATUS_EXPECTING_REPORT,
838 } status;
839 char *remote_status;
840 struct ref *peer_ref; /* when renaming */
841 char name[FLEX_ARRAY]; /* more */
842 };
843
844 #define REF_NORMAL (1u << 0)
845 #define REF_HEADS (1u << 1)
846 #define REF_TAGS (1u << 2)
847
848 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
849
850 #define CONNECT_VERBOSE (1u << 0)
851 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
852 extern int finish_connect(struct child_process *conn);
853 extern int path_match(const char *path, int nr, char **match);
854 extern int get_ack(int fd, unsigned char *result_sha1);
855 struct extra_have_objects {
856 int nr, alloc;
857 unsigned char (*array)[20];
858 };
859 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
860 extern int server_supports(const char *feature);
861
862 extern struct packed_git *parse_pack_index(unsigned char *sha1);
863
864 extern void prepare_packed_git(void);
865 extern void reprepare_packed_git(void);
866 extern void install_packed_git(struct packed_git *pack);
867
868 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
869 struct packed_git *packs);
870
871 extern void pack_report(void);
872 extern int open_pack_index(struct packed_git *);
873 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
874 extern void close_pack_windows(struct packed_git *);
875 extern void unuse_pack(struct pack_window **);
876 extern void free_pack_by_name(const char *);
877 extern void clear_delta_base_cache(void);
878 extern struct packed_git *add_packed_git(const char *, int, int);
879 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
880 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
881 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
882 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
883 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
884 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
885 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
886
887 /* Dumb servers support */
888 extern int update_server_info(int);
889
890 typedef int (*config_fn_t)(const char *, const char *, void *);
891 extern int git_default_config(const char *, const char *, void *);
892 extern int git_config_from_file(config_fn_t fn, const char *, void *);
893 extern int git_config(config_fn_t fn, void *);
894 extern int git_parse_ulong(const char *, unsigned long *);
895 extern int git_config_int(const char *, const char *);
896 extern unsigned long git_config_ulong(const char *, const char *);
897 extern int git_config_bool_or_int(const char *, const char *, int *);
898 extern int git_config_bool(const char *, const char *);
899 extern int git_config_string(const char **, const char *, const char *);
900 extern int git_config_set(const char *, const char *);
901 extern int git_config_set_multivar(const char *, const char *, const char *, int);
902 extern int git_config_rename_section(const char *, const char *);
903 extern const char *git_etc_gitconfig(void);
904 extern int check_repository_format_version(const char *var, const char *value, void *cb);
905 extern int git_config_system(void);
906 extern int git_config_global(void);
907 extern int config_error_nonbool(const char *);
908 extern const char *config_exclusive_filename;
909
910 #define MAX_GITNAME (1000)
911 extern char git_default_email[MAX_GITNAME];
912 extern char git_default_name[MAX_GITNAME];
913 extern int user_ident_explicitly_given;
914
915 extern const char *git_commit_encoding;
916 extern const char *git_log_output_encoding;
917 extern const char *git_mailmap_file;
918
919 /* IO helper functions */
920 extern void maybe_flush_or_die(FILE *, const char *);
921 extern int copy_fd(int ifd, int ofd);
922 extern int copy_file(const char *dst, const char *src, int mode);
923 extern ssize_t read_in_full(int fd, void *buf, size_t count);
924 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
925 extern void write_or_die(int fd, const void *buf, size_t count);
926 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
927 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
928 extern void fsync_or_die(int fd, const char *);
929
930 /* pager.c */
931 extern void setup_pager(void);
932 extern const char *pager_program;
933 extern int pager_in_use(void);
934 extern int pager_use_color;
935
936 extern const char *editor_program;
937 extern const char *excludes_file;
938
939 /* base85 */
940 int decode_85(char *dst, const char *line, int linelen);
941 void encode_85(char *buf, const unsigned char *data, int bytes);
942
943 /* alloc.c */
944 extern void *alloc_blob_node(void);
945 extern void *alloc_tree_node(void);
946 extern void *alloc_commit_node(void);
947 extern void *alloc_tag_node(void);
948 extern void *alloc_object_node(void);
949 extern void alloc_report(void);
950
951 /* trace.c */
952 extern void trace_printf(const char *format, ...);
953 extern void trace_argv_printf(const char **argv, const char *format, ...);
954
955 /* convert.c */
956 /* returns 1 if *dst was used */
957 extern int convert_to_git(const char *path, const char *src, size_t len,
958 struct strbuf *dst, enum safe_crlf checksafe);
959 extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
960
961 /* add */
962 /*
963 * return 0 if success, 1 - if addition of a file failed and
964 * ADD_FILES_IGNORE_ERRORS was specified in flags
965 */
966 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
967
968 /* diff.c */
969 extern int diff_auto_refresh_index;
970
971 /* match-trees.c */
972 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
973
974 /*
975 * whitespace rules.
976 * used by both diff and apply
977 */
978 #define WS_TRAILING_SPACE 01
979 #define WS_SPACE_BEFORE_TAB 02
980 #define WS_INDENT_WITH_NON_TAB 04
981 #define WS_CR_AT_EOL 010
982 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
983 extern unsigned whitespace_rule_cfg;
984 extern unsigned whitespace_rule(const char *);
985 extern unsigned parse_whitespace_rule(const char *);
986 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
987 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
988 extern char *whitespace_error_string(unsigned ws);
989 extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
990 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
991
992 /* ls-files */
993 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
994 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
995
996 char *alias_lookup(const char *alias);
997 int split_cmdline(char *cmdline, const char ***argv);
998
999 #endif /* CACHE_H */