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