Simplify calling of CR/LF conversion routines
[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 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
110 {
111 extern int trust_executable_bit, has_symlinks;
112 if (!has_symlinks && S_ISREG(mode) &&
113 ce && S_ISLNK(ntohl(ce->ce_mode)))
114 return ce->ce_mode;
115 if (!trust_executable_bit && S_ISREG(mode)) {
116 if (ce && S_ISREG(ntohl(ce->ce_mode)))
117 return ce->ce_mode;
118 return create_ce_mode(0666);
119 }
120 return create_ce_mode(mode);
121 }
122 #define canon_mode(mode) \
123 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
124 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
125
126 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
127
128 extern struct cache_entry **active_cache;
129 extern unsigned int active_nr, active_alloc, active_cache_changed;
130 extern struct cache_tree *active_cache_tree;
131
132 enum object_type {
133 OBJ_BAD = -1,
134 OBJ_NONE = 0,
135 OBJ_COMMIT = 1,
136 OBJ_TREE = 2,
137 OBJ_BLOB = 3,
138 OBJ_TAG = 4,
139 /* 5 for future expansion */
140 OBJ_OFS_DELTA = 6,
141 OBJ_REF_DELTA = 7,
142 OBJ_MAX,
143 };
144
145 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
146 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
147 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
148 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
149 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
150 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
151 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
152 #define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
153 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
154 #define GITATTRIBUTES_FILE ".gitattributes"
155 #define INFOATTRIBUTES_FILE "info/attributes"
156 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
157
158 extern int is_bare_repository_cfg;
159 extern int is_bare_repository(void);
160 extern int is_inside_git_dir(void);
161 extern const char *get_git_dir(void);
162 extern char *get_object_directory(void);
163 extern char *get_refs_directory(void);
164 extern char *get_index_file(void);
165 extern char *get_graft_file(void);
166
167 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
168
169 extern const char **get_pathspec(const char *prefix, const char **pathspec);
170 extern const char *setup_git_directory_gently(int *);
171 extern const char *setup_git_directory(void);
172 extern const char *prefix_path(const char *prefix, int len, const char *path);
173 extern const char *prefix_filename(const char *prefix, int len, const char *path);
174 extern void verify_filename(const char *prefix, const char *name);
175 extern void verify_non_filename(const char *prefix, const char *name);
176
177 #define alloc_nr(x) (((x)+16)*3/2)
178
179 /* Initialize and use the cache information */
180 extern int read_cache(void);
181 extern int read_cache_from(const char *path);
182 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
183 extern int discard_cache(void);
184 extern int verify_path(const char *path);
185 extern int cache_name_pos(const char *name, int namelen);
186 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
187 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
188 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
189 extern int add_cache_entry(struct cache_entry *ce, int option);
190 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
191 extern int remove_cache_entry_at(int pos);
192 extern int remove_file_from_cache(const char *path);
193 extern int add_file_to_cache(const char *path, int verbose);
194 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
195 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
196 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
197 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
198 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
199 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
200 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
201 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
202 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
203
204 #define REFRESH_REALLY 0x0001 /* ignore_valid */
205 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
206 #define REFRESH_QUIET 0x0004 /* be quiet about it */
207 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
208 extern int refresh_cache(unsigned int flags);
209
210 struct lock_file {
211 struct lock_file *next;
212 char on_list;
213 char filename[PATH_MAX];
214 };
215 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
216 extern int commit_lock_file(struct lock_file *);
217
218 extern int hold_locked_index(struct lock_file *, int);
219 extern int commit_locked_index(struct lock_file *);
220 extern void set_alternate_index_output(const char *);
221
222 extern void rollback_lock_file(struct lock_file *);
223 extern int delete_ref(const char *, unsigned char *sha1);
224
225 /* Environment bits from configuration mechanism */
226 extern int use_legacy_headers;
227 extern int trust_executable_bit;
228 extern int has_symlinks;
229 extern int assume_unchanged;
230 extern int prefer_symlink_refs;
231 extern int log_all_ref_updates;
232 extern int warn_ambiguous_refs;
233 extern int shared_repository;
234 extern const char *apply_default_whitespace;
235 extern int zlib_compression_level;
236 extern size_t packed_git_window_size;
237 extern size_t packed_git_limit;
238 extern size_t delta_base_cache_limit;
239 extern int auto_crlf;
240
241 #define GIT_REPO_VERSION 0
242 extern int repository_format_version;
243 extern int check_repository_format(void);
244
245 #define MTIME_CHANGED 0x0001
246 #define CTIME_CHANGED 0x0002
247 #define OWNER_CHANGED 0x0004
248 #define MODE_CHANGED 0x0008
249 #define INODE_CHANGED 0x0010
250 #define DATA_CHANGED 0x0020
251 #define TYPE_CHANGED 0x0040
252
253 /* Return a statically allocated filename matching the sha1 signature */
254 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
255 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
256 extern char *sha1_file_name(const unsigned char *sha1);
257 extern char *sha1_pack_name(const unsigned char *sha1);
258 extern char *sha1_pack_index_name(const unsigned char *sha1);
259 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
260 extern const unsigned char null_sha1[20];
261 static inline int is_null_sha1(const unsigned char *sha1)
262 {
263 return !memcmp(sha1, null_sha1, 20);
264 }
265 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
266 {
267 return memcmp(sha1, sha2, 20);
268 }
269 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
270 {
271 memcpy(sha_dst, sha_src, 20);
272 }
273 static inline void hashclr(unsigned char *hash)
274 {
275 memset(hash, 0, 20);
276 }
277
278 int git_mkstemp(char *path, size_t n, const char *template);
279
280 enum sharedrepo {
281 PERM_UMASK = 0,
282 PERM_GROUP,
283 PERM_EVERYBODY
284 };
285 int git_config_perm(const char *var, const char *value);
286 int adjust_shared_perm(const char *path);
287 int safe_create_leading_directories(char *path);
288 char *enter_repo(char *path, int strict);
289
290 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
291 extern int sha1_object_info(const unsigned char *, unsigned long *);
292 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
293 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
294 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
295 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
296
297 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
298
299 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
300 size_t bufsize, size_t *bufposn);
301 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
302 extern int move_temp_to_file(const char *tmpfile, const char *filename);
303
304 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
305 extern int has_sha1_file(const unsigned char *sha1);
306 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
307 extern int legacy_loose_object(unsigned char *);
308
309 extern int has_pack_file(const unsigned char *sha1);
310 extern int has_pack_index(const unsigned char *sha1);
311
312 extern signed char hexval_table[256];
313 static inline unsigned int hexval(unsigned int c)
314 {
315 return hexval_table[c];
316 }
317
318 /* Convert to/from hex/sha1 representation */
319 #define MINIMUM_ABBREV 4
320 #define DEFAULT_ABBREV 7
321
322 extern int get_sha1(const char *str, unsigned char *sha1);
323 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
324 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
325 extern int read_ref(const char *filename, unsigned char *sha1);
326 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
327 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
328 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
329
330 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
331 extern int validate_headref(const char *ref);
332
333 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
334 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
335
336 extern void *read_object_with_reference(const unsigned char *sha1,
337 const char *required_type,
338 unsigned long *size,
339 unsigned char *sha1_ret);
340
341 enum date_mode { DATE_NORMAL = 0, DATE_RELATIVE, DATE_SHORT };
342 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
343 const char *show_rfc2822_date(unsigned long time, int timezone);
344 int parse_date(const char *date, char *buf, int bufsize);
345 void datestamp(char *buf, int bufsize);
346 unsigned long approxidate(const char *);
347
348 extern const char *git_author_info(int);
349 extern const char *git_committer_info(int);
350 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
351
352 struct checkout {
353 const char *base_dir;
354 int base_dir_len;
355 unsigned force:1,
356 quiet:1,
357 not_new:1,
358 refresh_cache:1;
359 };
360
361 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
362
363 extern struct alternate_object_database {
364 struct alternate_object_database *next;
365 char *name;
366 char base[FLEX_ARRAY]; /* more */
367 } *alt_odb_list;
368 extern void prepare_alt_odb(void);
369
370 struct pack_window {
371 struct pack_window *next;
372 unsigned char *base;
373 off_t offset;
374 size_t len;
375 unsigned int last_used;
376 unsigned int inuse_cnt;
377 };
378
379 extern struct packed_git {
380 struct packed_git *next;
381 struct pack_window *windows;
382 const void *index_data;
383 off_t index_size;
384 off_t pack_size;
385 time_t mtime;
386 int index_version;
387 int pack_fd;
388 int pack_local;
389 unsigned char sha1[20];
390 /* something like ".git/objects/pack/xxxxx.pack" */
391 char pack_name[FLEX_ARRAY]; /* more */
392 } *packed_git;
393
394 struct pack_entry {
395 off_t offset;
396 unsigned char sha1[20];
397 struct packed_git *p;
398 };
399
400 struct ref {
401 struct ref *next;
402 unsigned char old_sha1[20];
403 unsigned char new_sha1[20];
404 unsigned char force;
405 struct ref *peer_ref; /* when renaming */
406 char name[FLEX_ARRAY]; /* more */
407 };
408
409 #define REF_NORMAL (1u << 0)
410 #define REF_HEADS (1u << 1)
411 #define REF_TAGS (1u << 2)
412
413 extern pid_t git_connect(int fd[2], char *url, const char *prog);
414 extern int finish_connect(pid_t pid);
415 extern int path_match(const char *path, int nr, char **match);
416 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
417 int nr_refspec, char **refspec, int all);
418 extern int get_ack(int fd, unsigned char *result_sha1);
419 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
420 extern int server_supports(const char *feature);
421
422 extern struct packed_git *parse_pack_index(unsigned char *sha1);
423 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
424 const char *idx_path);
425
426 extern void prepare_packed_git(void);
427 extern void reprepare_packed_git(void);
428 extern void install_packed_git(struct packed_git *pack);
429
430 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
431 struct packed_git *packs);
432
433 extern void pack_report(void);
434 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
435 extern void unuse_pack(struct pack_window **);
436 extern struct packed_git *add_packed_git(const char *, int, int);
437 extern uint32_t num_packed_objects(const struct packed_git *p);
438 extern const unsigned char *nth_packed_object_sha1(const struct packed_git *, uint32_t);
439 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
440 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
441 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
442 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
443
444 /* Dumb servers support */
445 extern int update_server_info(int);
446
447 typedef int (*config_fn_t)(const char *, const char *);
448 extern int git_default_config(const char *, const char *);
449 extern int git_config_from_file(config_fn_t fn, const char *);
450 extern int git_config(config_fn_t fn);
451 extern int git_config_int(const char *, const char *);
452 extern int git_config_bool(const char *, const char *);
453 extern int git_config_set(const char *, const char *);
454 extern int git_config_set_multivar(const char *, const char *, const char *, int);
455 extern int git_config_rename_section(const char *, const char *);
456 extern int check_repository_format_version(const char *var, const char *value);
457
458 #define MAX_GITNAME (1000)
459 extern char git_default_email[MAX_GITNAME];
460 extern char git_default_name[MAX_GITNAME];
461
462 extern const char *git_commit_encoding;
463 extern const char *git_log_output_encoding;
464
465 extern int copy_fd(int ifd, int ofd);
466 extern int read_in_full(int fd, void *buf, size_t count);
467 extern int write_in_full(int fd, const void *buf, size_t count);
468 extern void write_or_die(int fd, const void *buf, size_t count);
469 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
470 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
471
472 /* pager.c */
473 extern void setup_pager(void);
474 extern int pager_in_use;
475 extern int pager_use_color;
476
477 /* base85 */
478 int decode_85(char *dst, const char *line, int linelen);
479 void encode_85(char *buf, const unsigned char *data, int bytes);
480
481 /* alloc.c */
482 struct blob;
483 struct tree;
484 struct commit;
485 struct tag;
486 extern struct blob *alloc_blob_node(void);
487 extern struct tree *alloc_tree_node(void);
488 extern struct commit *alloc_commit_node(void);
489 extern struct tag *alloc_tag_node(void);
490 extern void alloc_report(void);
491
492 /* trace.c */
493 extern int nfasprintf(char **str, const char *fmt, ...);
494 extern int nfvasprintf(char **str, const char *fmt, va_list va);
495 extern void trace_printf(const char *format, ...);
496 extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
497
498 /* convert.c */
499 extern char *convert_to_git(const char *path, const char *src, unsigned long *sizep);
500 extern char *convert_to_working_tree(const char *path, const char *src, unsigned long *sizep);
501
502 /* match-trees.c */
503 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
504
505 #endif /* CACHE_H */