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