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