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