Extend index to save more flags
[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 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
22 #define DTYPE(de) ((de)->d_type)
23 #else
24 #undef DT_UNKNOWN
25 #undef DT_DIR
26 #undef DT_REG
27 #undef DT_LNK
28 #define DT_UNKNOWN 0
29 #define DT_DIR 1
30 #define DT_REG 2
31 #define DT_LNK 3
32 #define DTYPE(de) DT_UNKNOWN
33 #endif
34
35 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
36 #define S_IFINVALID 0030000
37
38 /*
39 * A "directory link" is a link to another git directory.
40 *
41 * The value 0160000 is not normally a valid mode, and
42 * also just happens to be S_IFDIR + S_IFLNK
43 *
44 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
45 * always having the same values everywhere. We should use
46 * our internal git values for these things, and then we can
47 * translate that to the OS-specific value. It just so
48 * happens that everybody shares the same bit representation
49 * in the UNIX world (and apparently wider too..)
50 */
51 #define S_IFGITLINK 0160000
52 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
53
54 /*
55 * Intensive research over the course of many years has shown that
56 * port 9418 is totally unused by anything else. Or
57 *
58 * Your search - "port 9418" - did not match any documents.
59 *
60 * as www.google.com puts it.
61 *
62 * This port has been properly assigned for git use by IANA:
63 * git (Assigned-9418) [I06-050728-0001].
64 *
65 * git 9418/tcp git pack transfer service
66 * git 9418/udp git pack transfer service
67 *
68 * with Linus Torvalds <torvalds@osdl.org> as the point of
69 * contact. September 2005.
70 *
71 * See http://www.iana.org/assignments/port-numbers
72 */
73 #define DEFAULT_GIT_PORT 9418
74
75 /*
76 * Basic data structures for the directory cache
77 */
78
79 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
80 struct cache_header {
81 unsigned int hdr_signature;
82 unsigned int hdr_version;
83 unsigned int hdr_entries;
84 };
85
86 /*
87 * The "cache_time" is just the low 32 bits of the
88 * time. It doesn't matter if it overflows - we only
89 * check it for equality in the 32 bits we save.
90 */
91 struct cache_time {
92 unsigned int sec;
93 unsigned int nsec;
94 };
95
96 /*
97 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
98 * Again - this is just a (very strong in practice) heuristic that
99 * the inode hasn't changed.
100 *
101 * We save the fields in big-endian order to allow using the
102 * index file over NFS transparently.
103 */
104 struct ondisk_cache_entry {
105 struct cache_time ctime;
106 struct cache_time mtime;
107 unsigned int dev;
108 unsigned int ino;
109 unsigned int mode;
110 unsigned int uid;
111 unsigned int gid;
112 unsigned int size;
113 unsigned char sha1[20];
114 unsigned short flags;
115 char name[FLEX_ARRAY]; /* more */
116 };
117
118 /*
119 * This struct is used when CE_EXTENDED bit is 1
120 * The struct must match ondisk_cache_entry exactly from
121 * ctime till flags
122 */
123 struct ondisk_cache_entry_extended {
124 struct cache_time ctime;
125 struct cache_time mtime;
126 unsigned int dev;
127 unsigned int ino;
128 unsigned int mode;
129 unsigned int uid;
130 unsigned int gid;
131 unsigned int size;
132 unsigned char sha1[20];
133 unsigned short flags;
134 unsigned short flags2;
135 char name[FLEX_ARRAY]; /* more */
136 };
137
138 struct cache_entry {
139 unsigned int ce_ctime;
140 unsigned int ce_mtime;
141 unsigned int ce_dev;
142 unsigned int ce_ino;
143 unsigned int ce_mode;
144 unsigned int ce_uid;
145 unsigned int ce_gid;
146 unsigned int ce_size;
147 unsigned int ce_flags;
148 unsigned char sha1[20];
149 struct cache_entry *next;
150 char name[FLEX_ARRAY]; /* more */
151 };
152
153 #define CE_NAMEMASK (0x0fff)
154 #define CE_STAGEMASK (0x3000)
155 #define CE_EXTENDED (0x4000)
156 #define CE_VALID (0x8000)
157 #define CE_STAGESHIFT 12
158
159 /*
160 * Range 0xFFFF0000 in ce_flags is divided into
161 * two parts: in-memory flags and on-disk ones.
162 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
163 * if you want to save a new flag, add it in
164 * CE_EXTENDED_FLAGS
165 *
166 * In-memory only flags
167 */
168 #define CE_UPDATE (0x10000)
169 #define CE_REMOVE (0x20000)
170 #define CE_UPTODATE (0x40000)
171 #define CE_ADDED (0x80000)
172
173 #define CE_HASHED (0x100000)
174 #define CE_UNHASHED (0x200000)
175
176 /*
177 * Extended on-disk flags
178 */
179 /* CE_EXTENDED2 is for future extension */
180 #define CE_EXTENDED2 0x80000000
181
182 #define CE_EXTENDED_FLAGS (0)
183
184 /*
185 * Safeguard to avoid saving wrong flags:
186 * - CE_EXTENDED2 won't get saved until its semantic is known
187 * - Bits in 0x0000FFFF have been saved in ce_flags already
188 * - Bits in 0x003F0000 are currently in-memory flags
189 */
190 #if CE_EXTENDED_FLAGS & 0x803FFFFF
191 #error "CE_EXTENDED_FLAGS out of range"
192 #endif
193
194 /*
195 * Copy the sha1 and stat state of a cache entry from one to
196 * another. But we never change the name, or the hash state!
197 */
198 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
199 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
200 {
201 unsigned int state = dst->ce_flags & CE_STATE_MASK;
202
203 /* Don't copy hash chain and name */
204 memcpy(dst, src, offsetof(struct cache_entry, next));
205
206 /* Restore the hash state */
207 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
208 }
209
210 static inline unsigned create_ce_flags(size_t len, unsigned stage)
211 {
212 if (len >= CE_NAMEMASK)
213 len = CE_NAMEMASK;
214 return (len | (stage << CE_STAGESHIFT));
215 }
216
217 static inline size_t ce_namelen(const struct cache_entry *ce)
218 {
219 size_t len = ce->ce_flags & CE_NAMEMASK;
220 if (len < CE_NAMEMASK)
221 return len;
222 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
223 }
224
225 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
226 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
227 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
228 ondisk_cache_entry_size(ce_namelen(ce)))
229 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
230 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
231 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
232
233 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
234 static inline unsigned int create_ce_mode(unsigned int mode)
235 {
236 if (S_ISLNK(mode))
237 return S_IFLNK;
238 if (S_ISDIR(mode) || S_ISGITLINK(mode))
239 return S_IFGITLINK;
240 return S_IFREG | ce_permissions(mode);
241 }
242 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
243 {
244 extern int trust_executable_bit, has_symlinks;
245 if (!has_symlinks && S_ISREG(mode) &&
246 ce && S_ISLNK(ce->ce_mode))
247 return ce->ce_mode;
248 if (!trust_executable_bit && S_ISREG(mode)) {
249 if (ce && S_ISREG(ce->ce_mode))
250 return ce->ce_mode;
251 return create_ce_mode(0666);
252 }
253 return create_ce_mode(mode);
254 }
255 static inline int ce_to_dtype(const struct cache_entry *ce)
256 {
257 unsigned ce_mode = ntohl(ce->ce_mode);
258 if (S_ISREG(ce_mode))
259 return DT_REG;
260 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
261 return DT_DIR;
262 else if (S_ISLNK(ce_mode))
263 return DT_LNK;
264 else
265 return DT_UNKNOWN;
266 }
267 #define canon_mode(mode) \
268 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
269 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
270
271 #define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
272 #define cache_entry_size(len) flexible_size(cache_entry,len)
273 #define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
274 #define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
275
276 struct index_state {
277 struct cache_entry **cache;
278 unsigned int cache_nr, cache_alloc, cache_changed;
279 struct cache_tree *cache_tree;
280 time_t timestamp;
281 void *alloc;
282 unsigned name_hash_initialized : 1,
283 initialized : 1;
284 struct hash_table name_hash;
285 };
286
287 extern struct index_state the_index;
288
289 /* Name hashing */
290 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
291 /*
292 * We don't actually *remove* it, we can just mark it invalid so that
293 * we won't find it in lookups.
294 *
295 * Not only would we have to search the lists (simple enough), but
296 * we'd also have to rehash other hash buckets in case this makes the
297 * hash bucket empty (common). So it's much better to just mark
298 * it.
299 */
300 static inline void remove_name_hash(struct cache_entry *ce)
301 {
302 ce->ce_flags |= CE_UNHASHED;
303 }
304
305
306 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
307 #define active_cache (the_index.cache)
308 #define active_nr (the_index.cache_nr)
309 #define active_alloc (the_index.cache_alloc)
310 #define active_cache_changed (the_index.cache_changed)
311 #define active_cache_tree (the_index.cache_tree)
312
313 #define read_cache() read_index(&the_index)
314 #define read_cache_from(path) read_index_from(&the_index, (path))
315 #define read_cache_unmerged() read_index_unmerged(&the_index)
316 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
317 #define discard_cache() discard_index(&the_index)
318 #define unmerged_cache() unmerged_index(&the_index)
319 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
320 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
321 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
322 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
323 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
324 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
325 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
326 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
327 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
328 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
329 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
330 #endif
331
332 enum object_type {
333 OBJ_BAD = -1,
334 OBJ_NONE = 0,
335 OBJ_COMMIT = 1,
336 OBJ_TREE = 2,
337 OBJ_BLOB = 3,
338 OBJ_TAG = 4,
339 /* 5 for future expansion */
340 OBJ_OFS_DELTA = 6,
341 OBJ_REF_DELTA = 7,
342 OBJ_ANY,
343 OBJ_MAX,
344 };
345
346 static inline enum object_type object_type(unsigned int mode)
347 {
348 return S_ISDIR(mode) ? OBJ_TREE :
349 S_ISGITLINK(mode) ? OBJ_COMMIT :
350 OBJ_BLOB;
351 }
352
353 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
354 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
355 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
356 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
357 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
358 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
359 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
360 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
361 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
362 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
363 #define GITATTRIBUTES_FILE ".gitattributes"
364 #define INFOATTRIBUTES_FILE "info/attributes"
365 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
366
367 extern int is_bare_repository_cfg;
368 extern int is_bare_repository(void);
369 extern int is_inside_git_dir(void);
370 extern char *git_work_tree_cfg;
371 extern int is_inside_work_tree(void);
372 extern int have_git_dir(void);
373 extern const char *get_git_dir(void);
374 extern char *get_object_directory(void);
375 extern char *get_index_file(void);
376 extern char *get_graft_file(void);
377 extern int set_git_dir(const char *path);
378 extern const char *get_git_work_tree(void);
379 extern const char *read_gitfile_gently(const char *path);
380 extern void set_git_work_tree(const char *tree);
381
382 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
383
384 extern const char **get_pathspec(const char *prefix, const char **pathspec);
385 extern void setup_work_tree(void);
386 extern const char *setup_git_directory_gently(int *);
387 extern const char *setup_git_directory(void);
388 extern const char *prefix_path(const char *prefix, int len, const char *path);
389 extern const char *prefix_filename(const char *prefix, int len, const char *path);
390 extern void verify_filename(const char *prefix, const char *name);
391 extern void verify_non_filename(const char *prefix, const char *name);
392
393 #define INIT_DB_QUIET 0x0001
394
395 extern int init_db(const char *template_dir, unsigned int flags);
396
397 #define alloc_nr(x) (((x)+16)*3/2)
398
399 /*
400 * Realloc the buffer pointed at by variable 'x' so that it can hold
401 * at least 'nr' entries; the number of entries currently allocated
402 * is 'alloc', using the standard growing factor alloc_nr() macro.
403 *
404 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
405 */
406 #define ALLOC_GROW(x, nr, alloc) \
407 do { \
408 if ((nr) > alloc) { \
409 if (alloc_nr(alloc) < (nr)) \
410 alloc = (nr); \
411 else \
412 alloc = alloc_nr(alloc); \
413 x = xrealloc((x), alloc * sizeof(*(x))); \
414 } \
415 } while(0)
416
417 /* Initialize and use the cache information */
418 extern int read_index(struct index_state *);
419 extern int read_index_from(struct index_state *, const char *path);
420 extern int read_index_unmerged(struct index_state *);
421 extern int write_index(const struct index_state *, int newfd);
422 extern int discard_index(struct index_state *);
423 extern int unmerged_index(const struct index_state *);
424 extern int verify_path(const char *path);
425 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
426 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
427 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
428 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
429 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
430 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
431 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
432 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
433 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
434 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
435 extern int remove_index_entry_at(struct index_state *, int pos);
436 extern int remove_file_from_index(struct index_state *, const char *path);
437 #define ADD_CACHE_VERBOSE 1
438 #define ADD_CACHE_PRETEND 2
439 #define ADD_CACHE_IGNORE_ERRORS 4
440 #define ADD_CACHE_IGNORE_REMOVAL 8
441 #define ADD_CACHE_INTENT 16
442 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
443 extern int add_file_to_index(struct index_state *, const char *path, int flags);
444 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
445 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
446
447 /* do stat comparison even if CE_VALID is true */
448 #define CE_MATCH_IGNORE_VALID 01
449 /* do not check the contents but report dirty on racily-clean entries */
450 #define CE_MATCH_RACY_IS_DIRTY 02
451 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
452 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
453
454 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
455 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
456 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
457 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
458
459 #define REFRESH_REALLY 0x0001 /* ignore_valid */
460 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
461 #define REFRESH_QUIET 0x0004 /* be quiet about it */
462 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
463 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
464 #define REFRESH_SAY_CHANGED 0x0020 /* say "changed" not "needs update" */
465 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
466
467 struct lock_file {
468 struct lock_file *next;
469 int fd;
470 pid_t owner;
471 char on_list;
472 char filename[PATH_MAX];
473 };
474 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
475 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
476 extern int commit_lock_file(struct lock_file *);
477
478 extern int hold_locked_index(struct lock_file *, int);
479 extern int commit_locked_index(struct lock_file *);
480 extern void set_alternate_index_output(const char *);
481 extern int close_lock_file(struct lock_file *);
482 extern void rollback_lock_file(struct lock_file *);
483 extern int delete_ref(const char *, const unsigned char *sha1);
484
485 /* Environment bits from configuration mechanism */
486 extern int trust_executable_bit;
487 extern int trust_ctime;
488 extern int quote_path_fully;
489 extern int has_symlinks;
490 extern int ignore_case;
491 extern int assume_unchanged;
492 extern int prefer_symlink_refs;
493 extern int log_all_ref_updates;
494 extern int warn_ambiguous_refs;
495 extern int shared_repository;
496 extern const char *apply_default_whitespace;
497 extern int zlib_compression_level;
498 extern int core_compression_level;
499 extern int core_compression_seen;
500 extern size_t packed_git_window_size;
501 extern size_t packed_git_limit;
502 extern size_t delta_base_cache_limit;
503 extern int auto_crlf;
504 extern int fsync_object_files;
505
506 enum safe_crlf {
507 SAFE_CRLF_FALSE = 0,
508 SAFE_CRLF_FAIL = 1,
509 SAFE_CRLF_WARN = 2,
510 };
511
512 extern enum safe_crlf safe_crlf;
513
514 enum branch_track {
515 BRANCH_TRACK_UNSPECIFIED = -1,
516 BRANCH_TRACK_NEVER = 0,
517 BRANCH_TRACK_REMOTE,
518 BRANCH_TRACK_ALWAYS,
519 BRANCH_TRACK_EXPLICIT,
520 };
521
522 enum rebase_setup_type {
523 AUTOREBASE_NEVER = 0,
524 AUTOREBASE_LOCAL,
525 AUTOREBASE_REMOTE,
526 AUTOREBASE_ALWAYS,
527 };
528
529 extern enum branch_track git_branch_track;
530 extern enum rebase_setup_type autorebase;
531
532 #define GIT_REPO_VERSION 0
533 extern int repository_format_version;
534 extern int check_repository_format(void);
535
536 #define MTIME_CHANGED 0x0001
537 #define CTIME_CHANGED 0x0002
538 #define OWNER_CHANGED 0x0004
539 #define MODE_CHANGED 0x0008
540 #define INODE_CHANGED 0x0010
541 #define DATA_CHANGED 0x0020
542 #define TYPE_CHANGED 0x0040
543
544 /* Return a statically allocated filename matching the sha1 signature */
545 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
546 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
547 extern char *sha1_file_name(const unsigned char *sha1);
548 extern char *sha1_pack_name(const unsigned char *sha1);
549 extern char *sha1_pack_index_name(const unsigned char *sha1);
550 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
551 extern const unsigned char null_sha1[20];
552 static inline int is_null_sha1(const unsigned char *sha1)
553 {
554 return !memcmp(sha1, null_sha1, 20);
555 }
556 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
557 {
558 return memcmp(sha1, sha2, 20);
559 }
560 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
561 {
562 memcpy(sha_dst, sha_src, 20);
563 }
564 static inline void hashclr(unsigned char *hash)
565 {
566 memset(hash, 0, 20);
567 }
568
569 int git_mkstemp(char *path, size_t n, const char *template);
570
571 /*
572 * NOTE NOTE NOTE!!
573 *
574 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
575 * not be changed. Old repositories have core.sharedrepository written in
576 * numeric format, and therefore these values are preserved for compatibility
577 * reasons.
578 */
579 enum sharedrepo {
580 PERM_UMASK = 0,
581 OLD_PERM_GROUP = 1,
582 OLD_PERM_EVERYBODY = 2,
583 PERM_GROUP = 0660,
584 PERM_EVERYBODY = 0664,
585 };
586 int git_config_perm(const char *var, const char *value);
587 int adjust_shared_perm(const char *path);
588 int safe_create_leading_directories(char *path);
589 int safe_create_leading_directories_const(const char *path);
590 char *enter_repo(char *path, int strict);
591 static inline int is_absolute_path(const char *path)
592 {
593 return path[0] == '/' || has_dos_drive_prefix(path);
594 }
595 int is_directory(const char *);
596 const char *make_absolute_path(const char *path);
597 const char *make_nonrelative_path(const char *path);
598 const char *make_relative_path(const char *abs, const char *base);
599 int normalize_absolute_path(char *buf, const char *path);
600 int longest_ancestor_length(const char *path, const char *prefix_list);
601
602 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
603 extern int sha1_object_info(const unsigned char *, unsigned long *);
604 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
605 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
606 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
607 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
608 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
609
610 /* just like read_sha1_file(), but non fatal in presence of bad objects */
611 extern void *read_object(const unsigned char *sha1, enum object_type *type, unsigned long *size);
612
613 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
614
615 extern int move_temp_to_file(const char *tmpfile, const char *filename);
616
617 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
618 extern int has_sha1_file(const unsigned char *sha1);
619
620 extern int has_pack_file(const unsigned char *sha1);
621 extern int has_pack_index(const unsigned char *sha1);
622
623 extern const signed char hexval_table[256];
624 static inline unsigned int hexval(unsigned char c)
625 {
626 return hexval_table[c];
627 }
628
629 /* Convert to/from hex/sha1 representation */
630 #define MINIMUM_ABBREV 4
631 #define DEFAULT_ABBREV 7
632
633 extern int get_sha1(const char *str, unsigned char *sha1);
634 extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
635 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
636 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
637 extern int read_ref(const char *filename, unsigned char *sha1);
638 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
639 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
640 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
641
642 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
643 extern const char *ref_rev_parse_rules[];
644 extern const char *ref_fetch_rules[];
645
646 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
647 extern int validate_headref(const char *ref);
648
649 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
650 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
651 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
652
653 extern void *read_object_with_reference(const unsigned char *sha1,
654 const char *required_type,
655 unsigned long *size,
656 unsigned char *sha1_ret);
657
658 extern struct object *peel_to_type(const char *name, int namelen,
659 struct object *o, enum object_type);
660
661 enum date_mode {
662 DATE_NORMAL = 0,
663 DATE_RELATIVE,
664 DATE_SHORT,
665 DATE_LOCAL,
666 DATE_ISO8601,
667 DATE_RFC2822
668 };
669
670 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
671 int parse_date(const char *date, char *buf, int bufsize);
672 void datestamp(char *buf, int bufsize);
673 unsigned long approxidate(const char *);
674 enum date_mode parse_date_format(const char *format);
675
676 #define IDENT_WARN_ON_NO_NAME 1
677 #define IDENT_ERROR_ON_NO_NAME 2
678 #define IDENT_NO_DATE 4
679 extern const char *git_author_info(int);
680 extern const char *git_committer_info(int);
681 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
682 extern const char *fmt_name(const char *name, const char *email);
683
684 struct checkout {
685 const char *base_dir;
686 int base_dir_len;
687 unsigned force:1,
688 quiet:1,
689 not_new:1,
690 refresh_cache:1;
691 };
692
693 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
694 extern int has_symlink_leading_path(int len, const char *name);
695
696 extern struct alternate_object_database {
697 struct alternate_object_database *next;
698 char *name;
699 char base[FLEX_ARRAY]; /* more */
700 } *alt_odb_list;
701 extern void prepare_alt_odb(void);
702 extern void add_to_alternates_file(const char *reference);
703 typedef int alt_odb_fn(struct alternate_object_database *, void *);
704 extern void foreach_alt_odb(alt_odb_fn, void*);
705
706 struct pack_window {
707 struct pack_window *next;
708 unsigned char *base;
709 off_t offset;
710 size_t len;
711 unsigned int last_used;
712 unsigned int inuse_cnt;
713 };
714
715 extern struct packed_git {
716 struct packed_git *next;
717 struct pack_window *windows;
718 off_t pack_size;
719 const void *index_data;
720 size_t index_size;
721 uint32_t num_objects;
722 uint32_t num_bad_objects;
723 unsigned char *bad_object_sha1;
724 int index_version;
725 time_t mtime;
726 int pack_fd;
727 int pack_local;
728 unsigned char sha1[20];
729 /* something like ".git/objects/pack/xxxxx.pack" */
730 char pack_name[FLEX_ARRAY]; /* more */
731 } *packed_git;
732
733 struct pack_entry {
734 off_t offset;
735 unsigned char sha1[20];
736 struct packed_git *p;
737 };
738
739 struct ref {
740 struct ref *next;
741 unsigned char old_sha1[20];
742 unsigned char new_sha1[20];
743 char *symref;
744 unsigned int force:1,
745 merge:1,
746 nonfastforward:1,
747 deletion:1;
748 enum {
749 REF_STATUS_NONE = 0,
750 REF_STATUS_OK,
751 REF_STATUS_REJECT_NONFASTFORWARD,
752 REF_STATUS_REJECT_NODELETE,
753 REF_STATUS_UPTODATE,
754 REF_STATUS_REMOTE_REJECT,
755 REF_STATUS_EXPECTING_REPORT,
756 } status;
757 char *remote_status;
758 struct ref *peer_ref; /* when renaming */
759 char name[FLEX_ARRAY]; /* more */
760 };
761
762 #define REF_NORMAL (1u << 0)
763 #define REF_HEADS (1u << 1)
764 #define REF_TAGS (1u << 2)
765
766 extern struct ref *find_ref_by_name(struct ref *list, const char *name);
767
768 #define CONNECT_VERBOSE (1u << 0)
769 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
770 extern int finish_connect(struct child_process *conn);
771 extern int path_match(const char *path, int nr, char **match);
772 extern int get_ack(int fd, unsigned char *result_sha1);
773 struct extra_have_objects {
774 int nr, alloc;
775 unsigned char (*array)[20];
776 };
777 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
778 extern int server_supports(const char *feature);
779
780 extern struct packed_git *parse_pack_index(unsigned char *sha1);
781
782 extern void prepare_packed_git(void);
783 extern void reprepare_packed_git(void);
784 extern void install_packed_git(struct packed_git *pack);
785
786 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
787 struct packed_git *packs);
788
789 extern void pack_report(void);
790 extern int open_pack_index(struct packed_git *);
791 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
792 extern void close_pack_windows(struct packed_git *);
793 extern void unuse_pack(struct pack_window **);
794 extern struct packed_git *add_packed_git(const char *, int, int);
795 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
796 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
797 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
798 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
799 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
800 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
801 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
802 extern int matches_pack_name(struct packed_git *p, const char *name);
803
804 /* Dumb servers support */
805 extern int update_server_info(int);
806
807 typedef int (*config_fn_t)(const char *, const char *, void *);
808 extern int git_default_config(const char *, const char *, void *);
809 extern int git_config_from_file(config_fn_t fn, const char *, void *);
810 extern int git_config(config_fn_t fn, void *);
811 extern int git_parse_ulong(const char *, unsigned long *);
812 extern int git_config_int(const char *, const char *);
813 extern unsigned long git_config_ulong(const char *, const char *);
814 extern int git_config_bool_or_int(const char *, const char *, int *);
815 extern int git_config_bool(const char *, const char *);
816 extern int git_config_string(const char **, const char *, const char *);
817 extern int git_config_set(const char *, const char *);
818 extern int git_config_set_multivar(const char *, const char *, const char *, int);
819 extern int git_config_rename_section(const char *, const char *);
820 extern const char *git_etc_gitconfig(void);
821 extern int check_repository_format_version(const char *var, const char *value, void *cb);
822 extern int git_config_system(void);
823 extern int git_config_global(void);
824 extern int config_error_nonbool(const char *);
825 extern const char *config_exclusive_filename;
826
827 #define MAX_GITNAME (1000)
828 extern char git_default_email[MAX_GITNAME];
829 extern char git_default_name[MAX_GITNAME];
830 extern int user_ident_explicitly_given;
831
832 extern const char *git_commit_encoding;
833 extern const char *git_log_output_encoding;
834
835 /* IO helper functions */
836 extern void maybe_flush_or_die(FILE *, const char *);
837 extern int copy_fd(int ifd, int ofd);
838 extern int copy_file(const char *dst, const char *src, int mode);
839 extern ssize_t read_in_full(int fd, void *buf, size_t count);
840 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
841 extern void write_or_die(int fd, const void *buf, size_t count);
842 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
843 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
844 extern void fsync_or_die(int fd, const char *);
845
846 /* pager.c */
847 extern void setup_pager(void);
848 extern const char *pager_program;
849 extern int pager_in_use(void);
850 extern int pager_use_color;
851
852 extern const char *editor_program;
853 extern const char *excludes_file;
854
855 /* base85 */
856 int decode_85(char *dst, const char *line, int linelen);
857 void encode_85(char *buf, const unsigned char *data, int bytes);
858
859 /* alloc.c */
860 extern void *alloc_blob_node(void);
861 extern void *alloc_tree_node(void);
862 extern void *alloc_commit_node(void);
863 extern void *alloc_tag_node(void);
864 extern void *alloc_object_node(void);
865 extern void alloc_report(void);
866
867 /* trace.c */
868 extern void trace_printf(const char *format, ...);
869 extern void trace_argv_printf(const char **argv, const char *format, ...);
870
871 /* convert.c */
872 /* returns 1 if *dst was used */
873 extern int convert_to_git(const char *path, const char *src, size_t len,
874 struct strbuf *dst, enum safe_crlf checksafe);
875 extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
876
877 /* add */
878 /*
879 * return 0 if success, 1 - if addition of a file failed and
880 * ADD_FILES_IGNORE_ERRORS was specified in flags
881 */
882 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
883
884 /* diff.c */
885 extern int diff_auto_refresh_index;
886
887 /* match-trees.c */
888 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
889
890 /*
891 * whitespace rules.
892 * used by both diff and apply
893 */
894 #define WS_TRAILING_SPACE 01
895 #define WS_SPACE_BEFORE_TAB 02
896 #define WS_INDENT_WITH_NON_TAB 04
897 #define WS_CR_AT_EOL 010
898 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
899 extern unsigned whitespace_rule_cfg;
900 extern unsigned whitespace_rule(const char *);
901 extern unsigned parse_whitespace_rule(const char *);
902 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
903 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
904 extern char *whitespace_error_string(unsigned ws);
905 extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
906 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
907
908 /* ls-files */
909 int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
910 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
911 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
912
913 char *alias_lookup(const char *alias);
914 int split_cmdline(char *cmdline, const char ***argv);
915
916 #endif /* CACHE_H */