Rename get_ident() to fmt_ident() and make it available to outside
[git/git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5
6 #include SHA1_HEADER
7 #include <zlib.h>
8
9 #if ZLIB_VERNUM < 0x1200
10 #define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11 #endif
12
13 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
14 #define DTYPE(de) ((de)->d_type)
15 #else
16 #undef DT_UNKNOWN
17 #undef DT_DIR
18 #undef DT_REG
19 #undef DT_LNK
20 #define DT_UNKNOWN 0
21 #define DT_DIR 1
22 #define DT_REG 2
23 #define DT_LNK 3
24 #define DTYPE(de) DT_UNKNOWN
25 #endif
26
27 /*
28 * Intensive research over the course of many years has shown that
29 * port 9418 is totally unused by anything else. Or
30 *
31 * Your search - "port 9418" - did not match any documents.
32 *
33 * as www.google.com puts it.
34 *
35 * This port has been properly assigned for git use by IANA:
36 * git (Assigned-9418) [I06-050728-0001].
37 *
38 * git 9418/tcp git pack transfer service
39 * git 9418/udp git pack transfer service
40 *
41 * with Linus Torvalds <torvalds@osdl.org> as the point of
42 * contact. September 2005.
43 *
44 * See http://www.iana.org/assignments/port-numbers
45 */
46 #define DEFAULT_GIT_PORT 9418
47
48 /*
49 * Basic data structures for the directory cache
50 */
51
52 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
53 struct cache_header {
54 unsigned int hdr_signature;
55 unsigned int hdr_version;
56 unsigned int hdr_entries;
57 };
58
59 /*
60 * The "cache_time" is just the low 32 bits of the
61 * time. It doesn't matter if it overflows - we only
62 * check it for equality in the 32 bits we save.
63 */
64 struct cache_time {
65 unsigned int sec;
66 unsigned int nsec;
67 };
68
69 /*
70 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
71 * Again - this is just a (very strong in practice) heuristic that
72 * the inode hasn't changed.
73 *
74 * We save the fields in big-endian order to allow using the
75 * index file over NFS transparently.
76 */
77 struct cache_entry {
78 struct cache_time ce_ctime;
79 struct cache_time ce_mtime;
80 unsigned int ce_dev;
81 unsigned int ce_ino;
82 unsigned int ce_mode;
83 unsigned int ce_uid;
84 unsigned int ce_gid;
85 unsigned int ce_size;
86 unsigned char sha1[20];
87 unsigned short ce_flags;
88 char name[FLEX_ARRAY]; /* more */
89 };
90
91 #define CE_NAMEMASK (0x0fff)
92 #define CE_STAGEMASK (0x3000)
93 #define CE_UPDATE (0x4000)
94 #define CE_VALID (0x8000)
95 #define CE_STAGESHIFT 12
96
97 #define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
98 #define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
99 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
100 #define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
101
102 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
103 static inline unsigned int create_ce_mode(unsigned int mode)
104 {
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
107 return htonl(S_IFREG | ce_permissions(mode));
108 }
109 #define canon_mode(mode) \
110 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
111 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
112
113 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
114
115 extern struct cache_entry **active_cache;
116 extern unsigned int active_nr, active_alloc, active_cache_changed;
117 extern struct cache_tree *active_cache_tree;
118 extern int cache_errno;
119
120 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
121 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
122 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
123 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
124 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
125 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
126 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
127 #define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
128 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
129
130 extern int is_bare_repository_cfg;
131 extern int is_bare_repository(void);
132 extern int is_inside_git_dir(void);
133 extern const char *get_git_dir(void);
134 extern char *get_object_directory(void);
135 extern char *get_refs_directory(void);
136 extern char *get_index_file(void);
137 extern char *get_graft_file(void);
138
139 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
140
141 extern const char **get_pathspec(const char *prefix, const char **pathspec);
142 extern const char *setup_git_directory_gently(int *);
143 extern const char *setup_git_directory(void);
144 extern const char *prefix_path(const char *prefix, int len, const char *path);
145 extern const char *prefix_filename(const char *prefix, int len, const char *path);
146 extern void verify_filename(const char *prefix, const char *name);
147 extern void verify_non_filename(const char *prefix, const char *name);
148
149 #define alloc_nr(x) (((x)+16)*3/2)
150
151 /* Initialize and use the cache information */
152 extern int read_cache(void);
153 extern int read_cache_from(const char *path);
154 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
155 extern int discard_cache(void);
156 extern int verify_path(const char *path);
157 extern int cache_name_pos(const char *name, int namelen);
158 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
159 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
160 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
161 extern int add_cache_entry(struct cache_entry *ce, int option);
162 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
163 extern int remove_cache_entry_at(int pos);
164 extern int remove_file_from_cache(const char *path);
165 extern int add_file_to_index(const char *path, int verbose);
166 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
167 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
168 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
169 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
170 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
171 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
172 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
173 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
174 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
175
176 #define REFRESH_REALLY 0x0001 /* ignore_valid */
177 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
178 #define REFRESH_QUIET 0x0004 /* be quiet about it */
179 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
180 extern int refresh_cache(unsigned int flags);
181
182 struct lock_file {
183 struct lock_file *next;
184 char on_list;
185 char filename[PATH_MAX];
186 };
187 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
188 extern int commit_lock_file(struct lock_file *);
189 extern void rollback_lock_file(struct lock_file *);
190 extern int delete_ref(const char *, unsigned char *sha1);
191
192 /* Environment bits from configuration mechanism */
193 extern int use_legacy_headers;
194 extern int trust_executable_bit;
195 extern int assume_unchanged;
196 extern int prefer_symlink_refs;
197 extern int log_all_ref_updates;
198 extern int warn_ambiguous_refs;
199 extern int shared_repository;
200 extern const char *apply_default_whitespace;
201 extern int zlib_compression_level;
202 extern size_t packed_git_window_size;
203 extern size_t packed_git_limit;
204
205 #define GIT_REPO_VERSION 0
206 extern int repository_format_version;
207 extern int check_repository_format(void);
208
209 #define MTIME_CHANGED 0x0001
210 #define CTIME_CHANGED 0x0002
211 #define OWNER_CHANGED 0x0004
212 #define MODE_CHANGED 0x0008
213 #define INODE_CHANGED 0x0010
214 #define DATA_CHANGED 0x0020
215 #define TYPE_CHANGED 0x0040
216
217 /* Return a statically allocated filename matching the sha1 signature */
218 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
219 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
220 extern char *sha1_file_name(const unsigned char *sha1);
221 extern char *sha1_pack_name(const unsigned char *sha1);
222 extern char *sha1_pack_index_name(const unsigned char *sha1);
223 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
224 extern const unsigned char null_sha1[20];
225 static inline int is_null_sha1(const unsigned char *sha1)
226 {
227 return !memcmp(sha1, null_sha1, 20);
228 }
229 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
230 {
231 return memcmp(sha1, sha2, 20);
232 }
233 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
234 {
235 memcpy(sha_dst, sha_src, 20);
236 }
237 static inline void hashclr(unsigned char *hash)
238 {
239 memset(hash, 0, 20);
240 }
241
242 int git_mkstemp(char *path, size_t n, const char *template);
243
244 enum sharedrepo {
245 PERM_UMASK = 0,
246 PERM_GROUP,
247 PERM_EVERYBODY
248 };
249 int git_config_perm(const char *var, const char *value);
250 int adjust_shared_perm(const char *path);
251 int safe_create_leading_directories(char *path);
252 char *enter_repo(char *path, int strict);
253
254 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
255 extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
256 extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
257 extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
258 extern int hash_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *sha1);
259 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
260
261 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
262
263 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
264 size_t bufsize, size_t *bufposn);
265 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
266 extern int move_temp_to_file(const char *tmpfile, const char *filename);
267
268 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
269 extern int has_sha1_file(const unsigned char *sha1);
270 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
271 extern int legacy_loose_object(unsigned char *);
272
273 extern int has_pack_file(const unsigned char *sha1);
274 extern int has_pack_index(const unsigned char *sha1);
275
276 enum object_type {
277 OBJ_NONE = 0,
278 OBJ_COMMIT = 1,
279 OBJ_TREE = 2,
280 OBJ_BLOB = 3,
281 OBJ_TAG = 4,
282 /* 5 for future expansion */
283 OBJ_OFS_DELTA = 6,
284 OBJ_REF_DELTA = 7,
285 OBJ_BAD,
286 };
287
288 extern signed char hexval_table[256];
289 static inline unsigned int hexval(unsigned int c)
290 {
291 return hexval_table[c];
292 }
293
294 /* Convert to/from hex/sha1 representation */
295 #define MINIMUM_ABBREV 4
296 #define DEFAULT_ABBREV 7
297
298 extern int get_sha1(const char *str, unsigned char *sha1);
299 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
300 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
301 extern int read_ref(const char *filename, unsigned char *sha1);
302 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
303 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
304
305 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
306 extern int validate_headref(const char *ref);
307
308 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
309 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
310
311 extern void *read_object_with_reference(const unsigned char *sha1,
312 const char *required_type,
313 unsigned long *size,
314 unsigned char *sha1_ret);
315
316 const char *show_date(unsigned long time, int timezone, int relative);
317 const char *show_rfc2822_date(unsigned long time, int timezone);
318 int parse_date(const char *date, char *buf, int bufsize);
319 void datestamp(char *buf, int bufsize);
320 unsigned long approxidate(const char *);
321
322 extern const char *git_author_info(int);
323 extern const char *git_committer_info(int);
324 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
325
326 struct checkout {
327 const char *base_dir;
328 int base_dir_len;
329 unsigned force:1,
330 quiet:1,
331 not_new:1,
332 refresh_cache:1;
333 };
334
335 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
336
337 extern struct alternate_object_database {
338 struct alternate_object_database *next;
339 char *name;
340 char base[FLEX_ARRAY]; /* more */
341 } *alt_odb_list;
342 extern void prepare_alt_odb(void);
343
344 struct pack_window {
345 struct pack_window *next;
346 unsigned char *base;
347 off_t offset;
348 size_t len;
349 unsigned int last_used;
350 unsigned int inuse_cnt;
351 };
352
353 extern struct packed_git {
354 struct packed_git *next;
355 struct pack_window *windows;
356 uint32_t *index_base;
357 off_t index_size;
358 off_t pack_size;
359 int pack_fd;
360 int pack_local;
361 unsigned char sha1[20];
362 /* something like ".git/objects/pack/xxxxx.pack" */
363 char pack_name[FLEX_ARRAY]; /* more */
364 } *packed_git;
365
366 struct pack_entry {
367 unsigned int offset;
368 unsigned char sha1[20];
369 struct packed_git *p;
370 };
371
372 struct ref {
373 struct ref *next;
374 unsigned char old_sha1[20];
375 unsigned char new_sha1[20];
376 unsigned char force;
377 struct ref *peer_ref; /* when renaming */
378 char name[FLEX_ARRAY]; /* more */
379 };
380
381 #define REF_NORMAL (1u << 0)
382 #define REF_HEADS (1u << 1)
383 #define REF_TAGS (1u << 2)
384
385 extern pid_t git_connect(int fd[2], char *url, const char *prog);
386 extern int finish_connect(pid_t pid);
387 extern int path_match(const char *path, int nr, char **match);
388 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
389 int nr_refspec, char **refspec, int all);
390 extern int get_ack(int fd, unsigned char *result_sha1);
391 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
392 extern int server_supports(const char *feature);
393
394 extern struct packed_git *parse_pack_index(unsigned char *sha1);
395 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
396 char *idx_path);
397
398 extern void prepare_packed_git(void);
399 extern void reprepare_packed_git(void);
400 extern void install_packed_git(struct packed_git *pack);
401
402 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
403 struct packed_git *packs);
404
405 extern void pack_report(void);
406 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, unsigned long, unsigned int *);
407 extern void unuse_pack(struct pack_window **);
408 extern struct packed_git *add_packed_git(char *, int, int);
409 extern int num_packed_objects(const struct packed_git *p);
410 extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
411 extern unsigned long find_pack_entry_one(const unsigned char *, struct packed_git *);
412 extern void *unpack_entry(struct packed_git *, unsigned long, char *, unsigned long *);
413 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
414 extern void packed_object_info_detail(struct packed_git *, unsigned long, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
415
416 /* Dumb servers support */
417 extern int update_server_info(int);
418
419 typedef int (*config_fn_t)(const char *, const char *);
420 extern int git_default_config(const char *, const char *);
421 extern int git_config_from_file(config_fn_t fn, const char *);
422 extern int git_config(config_fn_t fn);
423 extern int git_config_int(const char *, const char *);
424 extern int git_config_bool(const char *, const char *);
425 extern int git_config_set(const char *, const char *);
426 extern int git_config_set_multivar(const char *, const char *, const char *, int);
427 extern int git_config_rename_section(const char *, const char *);
428 extern int check_repository_format_version(const char *var, const char *value);
429
430 #define MAX_GITNAME (1000)
431 extern char git_default_email[MAX_GITNAME];
432 extern char git_default_name[MAX_GITNAME];
433
434 extern char *git_commit_encoding;
435 extern char *git_log_output_encoding;
436
437 extern int copy_fd(int ifd, int ofd);
438 extern int read_in_full(int fd, void *buf, size_t count);
439 extern int write_in_full(int fd, const void *buf, size_t count);
440 extern void write_or_die(int fd, const void *buf, size_t count);
441 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
442 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
443
444 /* pager.c */
445 extern void setup_pager(void);
446 extern int pager_in_use;
447 extern int pager_use_color;
448
449 /* base85 */
450 int decode_85(char *dst, char *line, int linelen);
451 void encode_85(char *buf, unsigned char *data, int bytes);
452
453 /* alloc.c */
454 struct blob;
455 struct tree;
456 struct commit;
457 struct tag;
458 extern struct blob *alloc_blob_node(void);
459 extern struct tree *alloc_tree_node(void);
460 extern struct commit *alloc_commit_node(void);
461 extern struct tag *alloc_tag_node(void);
462 extern void alloc_report(void);
463
464 /* trace.c */
465 extern int nfvasprintf(char **str, const char *fmt, va_list va);
466 extern void trace_printf(const char *format, ...);
467 extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
468
469 #endif /* CACHE_H */