99afa2c3c49b56c7c807dd692cb7a83f8f00ade0
1#ifndef CACHE_H
2#define CACHE_H
3
4#include <unistd.h>
5#include <stdio.h>
6#include <sys/stat.h>
7#include <fcntl.h>
8#include <stddef.h>
9#include <stdlib.h>
10#include <stdarg.h>
11#include <string.h>
12#include <errno.h>
13#include <limits.h>
14#ifndef NO_MMAP
15#include <sys/mman.h>
16#endif
17#include <sys/param.h>
18#include <netinet/in.h>
19#include <sys/types.h>
20#include <dirent.h>
21
22#include SHA1_HEADER
23#include <zlib.h>
24
25#if ZLIB_VERNUM < 0x1200
26#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
27#endif
28
29#ifdef DT_UNKNOWN
30#define DTYPE(de) ((de)->d_type)
31#else
32#define DT_UNKNOWN 0
33#define DT_DIR 1
34#define DT_REG 2
35#define DT_LNK 3
36#define DTYPE(de) DT_UNKNOWN
37#endif
38
39#ifdef __GNUC__
40#define NORETURN __attribute__((__noreturn__))
41#else
42#define NORETURN
43#ifndef __attribute__
44#define __attribute__(x)
45#endif
46#endif
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 cache_entry {
99 struct cache_time ce_ctime;
100 struct cache_time ce_mtime;
101 unsigned int ce_dev;
102 unsigned int ce_ino;
103 unsigned int ce_mode;
104 unsigned int ce_uid;
105 unsigned int ce_gid;
106 unsigned int ce_size;
107 unsigned char sha1[20];
108 unsigned short ce_flags;
109 char name[0];
110};
111
112#define CE_NAMEMASK (0x0fff)
113#define CE_STAGEMASK (0x3000)
114#define CE_UPDATE (0x4000)
115#define CE_STAGESHIFT 12
116
117#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
118#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
119#define ce_size(ce) cache_entry_size(ce_namelen(ce))
120#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
121
122#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
123static inline unsigned int create_ce_mode(unsigned int mode)
124{
125 if (S_ISLNK(mode))
126 return htonl(S_IFLNK);
127 return htonl(S_IFREG | ce_permissions(mode));
128}
129
130#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
131
132extern struct cache_entry **active_cache;
133extern unsigned int active_nr, active_alloc, active_cache_changed;
134
135#define GIT_DIR_ENVIRONMENT "GIT_DIR"
136#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
137#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
138#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
139#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
140
141extern char *get_git_dir(void);
142extern char *get_object_directory(void);
143extern char *get_refs_directory(void);
144extern char *get_index_file(void);
145extern char *get_graft_file(void);
146
147#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
148
149extern const char **get_pathspec(const char *prefix, const char **pathspec);
150extern const char *setup_git_directory(void);
151extern const char *prefix_path(const char *prefix, int len, const char *path);
152
153#define alloc_nr(x) (((x)+16)*3/2)
154
155/* Initialize and use the cache information */
156extern int read_cache(void);
157extern int write_cache(int newfd, struct cache_entry **cache, int entries);
158extern int cache_name_pos(const char *name, int namelen);
159#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
160#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
161#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
162extern int add_cache_entry(struct cache_entry *ce, int option);
163extern int remove_cache_entry_at(int pos);
164extern int remove_file_from_cache(const char *path);
165extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
166extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
167extern int ce_modified(struct cache_entry *ce, struct stat *st);
168extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
169extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
170extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
171extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
172
173struct cache_file {
174 struct cache_file *next;
175 char lockfile[PATH_MAX];
176};
177extern int hold_index_file_for_update(struct cache_file *, const char *path);
178extern int commit_index_file(struct cache_file *);
179extern void rollback_index_file(struct cache_file *);
180
181extern int trust_executable_bit;
182extern int only_use_symrefs;
183extern int diff_rename_limit_default;
184
185#define MTIME_CHANGED 0x0001
186#define CTIME_CHANGED 0x0002
187#define OWNER_CHANGED 0x0004
188#define MODE_CHANGED 0x0008
189#define INODE_CHANGED 0x0010
190#define DATA_CHANGED 0x0020
191#define TYPE_CHANGED 0x0040
192
193/* Return a statically allocated filename matching the sha1 signature */
194extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
195extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
196extern char *sha1_file_name(const unsigned char *sha1);
197extern char *sha1_pack_name(const unsigned char *sha1);
198extern char *sha1_pack_index_name(const unsigned char *sha1);
199extern const char *find_unique_abbrev(const unsigned char *sha1, int);
200extern const unsigned char null_sha1[20];
201
202int git_mkstemp(char *path, size_t n, const char *template);
203
204int safe_create_leading_directories(char *path);
205char *safe_strncpy(char *, const char *, size_t);
206
207/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
208extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
209extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
210extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
211extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
212extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
213extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
214extern char *write_sha1_file_prepare(void *buf,
215 unsigned long len,
216 const char *type,
217 unsigned char *sha1,
218 unsigned char *hdr,
219 int *hdrlen);
220
221extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
222
223/* Read a tree into the cache */
224extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
225
226extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
227 size_t bufsize, size_t *bufposn);
228extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
229extern int move_temp_to_file(const char *tmpfile, char *filename);
230
231extern int has_sha1_pack(const unsigned char *sha1);
232extern int has_sha1_file(const unsigned char *sha1);
233
234extern int has_pack_file(const unsigned char *sha1);
235extern int has_pack_index(const unsigned char *sha1);
236
237/* Convert to/from hex/sha1 representation */
238extern int get_sha1(const char *str, unsigned char *sha1);
239extern int get_sha1_hex(const char *hex, unsigned char *sha1);
240extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
241extern int read_ref(const char *filename, unsigned char *sha1);
242extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
243extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
244extern int validate_symref(const char *git_HEAD);
245
246/* General helper functions */
247extern void usage(const char *err) NORETURN;
248extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
249extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
250
251extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
252extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
253
254extern void *read_object_with_reference(const unsigned char *sha1,
255 const char *required_type,
256 unsigned long *size,
257 unsigned char *sha1_ret);
258
259const char *show_date(unsigned long time, int timezone);
260int parse_date(const char *date, char *buf, int bufsize);
261void datestamp(char *buf, int bufsize);
262unsigned long approxidate(const char *);
263
264extern int setup_ident(void);
265extern char *get_ident(const char *name, const char *email, const char *date_str);
266extern char *git_author_info(void);
267extern char *git_committer_info(void);
268
269static inline void *xmalloc(size_t size)
270{
271 void *ret = malloc(size);
272 if (!ret)
273 die("Out of memory, malloc failed");
274 return ret;
275}
276
277static inline void *xrealloc(void *ptr, size_t size)
278{
279 void *ret = realloc(ptr, size);
280 if (!ret)
281 die("Out of memory, realloc failed");
282 return ret;
283}
284
285static inline void *xcalloc(size_t nmemb, size_t size)
286{
287 void *ret = calloc(nmemb, size);
288 if (!ret)
289 die("Out of memory, calloc failed");
290 return ret;
291}
292
293struct checkout {
294 const char *base_dir;
295 int base_dir_len;
296 unsigned force:1,
297 quiet:1,
298 not_new:1,
299 refresh_cache:1;
300};
301
302extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
303
304extern struct alternate_object_database {
305 struct alternate_object_database *next;
306 char *name;
307 char base[0]; /* more */
308} *alt_odb_list;
309extern void prepare_alt_odb(void);
310
311extern struct packed_git {
312 struct packed_git *next;
313 unsigned long index_size;
314 unsigned long pack_size;
315 unsigned int *index_base;
316 void *pack_base;
317 unsigned int pack_last_used;
318 unsigned int pack_use_cnt;
319 int pack_local;
320 unsigned char sha1[20];
321 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
322} *packed_git;
323
324struct pack_entry {
325 unsigned int offset;
326 unsigned char sha1[20];
327 struct packed_git *p;
328};
329
330struct ref {
331 struct ref *next;
332 unsigned char old_sha1[20];
333 unsigned char new_sha1[20];
334 unsigned char force;
335 struct ref *peer_ref; /* when renaming */
336 char name[0];
337};
338
339extern int git_connect(int fd[2], char *url, const char *prog);
340extern int finish_connect(pid_t pid);
341extern int path_match(const char *path, int nr, char **match);
342extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
343 int nr_refspec, char **refspec, int all);
344extern int get_ack(int fd, unsigned char *result_sha1);
345extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
346extern int server_supports(const char *feature);
347
348extern struct packed_git *parse_pack_index(unsigned char *sha1);
349extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
350 char *idx_path);
351
352extern void prepare_packed_git(void);
353extern void install_packed_git(struct packed_git *pack);
354
355extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
356 struct packed_git *packs);
357
358extern int use_packed_git(struct packed_git *);
359extern void unuse_packed_git(struct packed_git *);
360extern struct packed_git *add_packed_git(char *, int, int);
361extern int num_packed_objects(const struct packed_git *p);
362extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
363extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
364extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
365extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
366
367/* Dumb servers support */
368extern int update_server_info(int);
369
370#ifdef NO_MMAP
371
372#ifndef PROT_READ
373#define PROT_READ 1
374#define PROT_WRITE 2
375#define MAP_PRIVATE 1
376#define MAP_FAILED ((void*)-1)
377#endif
378
379extern void *gitfakemmap(void *start, size_t length, int prot , int flags, int fd, off_t offset);
380extern int gitfakemunmap(void *start, size_t length);
381
382#endif
383
384typedef int (*config_fn_t)(const char *, const char *);
385extern int git_default_config(const char *, const char *);
386extern int git_config(config_fn_t fn);
387extern int git_config_int(const char *, const char *);
388extern int git_config_bool(const char *, const char *);
389
390#define MAX_GITNAME (1000)
391extern char git_default_email[MAX_GITNAME];
392extern char git_default_name[MAX_GITNAME];
393
394/* Sane ctype - no locale, and works with signed chars */
395#undef isspace
396#undef isdigit
397#undef isalpha
398#undef isalnum
399#undef tolower
400#undef toupper
401extern unsigned char sane_ctype[256];
402#define GIT_SPACE 0x01
403#define GIT_DIGIT 0x02
404#define GIT_ALPHA 0x04
405#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
406#define isspace(x) sane_istest(x,GIT_SPACE)
407#define isdigit(x) sane_istest(x,GIT_DIGIT)
408#define isalpha(x) sane_istest(x,GIT_ALPHA)
409#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
410#define tolower(x) sane_case((unsigned char)(x), 0x20)
411#define toupper(x) sane_case((unsigned char)(x), 0)
412
413static inline int sane_case(int x, int high)
414{
415 if (sane_istest(x, GIT_ALPHA))
416 x = (x & ~0x20) | high;
417 return x;
418}
419
420extern int copy_fd(int ifd, int ofd);
421#endif /* CACHE_H */