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