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