Add missing includes and forward declarations
[git/git.git] / object-store.h
1 #ifndef OBJECT_STORE_H
2 #define OBJECT_STORE_H
3
4 #include "cache.h"
5 #include "oidmap.h"
6 #include "list.h"
7 #include "sha1-array.h"
8 #include "strbuf.h"
9
10 struct alternate_object_database {
11 struct alternate_object_database *next;
12
13 /* see alt_scratch_buf() */
14 struct strbuf scratch;
15 size_t base_len;
16
17 /*
18 * Used to store the results of readdir(3) calls when searching
19 * for unique abbreviated hashes. This cache is never
20 * invalidated, thus it's racy and not necessarily accurate.
21 * That's fine for its purpose; don't use it for tasks requiring
22 * greater accuracy!
23 */
24 char loose_objects_subdir_seen[256];
25 struct oid_array loose_objects_cache;
26
27 /*
28 * Path to the alternative object store. If this is a relative path,
29 * it is relative to the current working directory.
30 */
31 char path[FLEX_ARRAY];
32 };
33 void prepare_alt_odb(struct repository *r);
34 char *compute_alternate_path(const char *path, struct strbuf *err);
35 typedef int alt_odb_fn(struct alternate_object_database *, void *);
36 int foreach_alt_odb(alt_odb_fn, void*);
37
38 /*
39 * Allocate a "struct alternate_object_database" but do _not_ actually
40 * add it to the list of alternates.
41 */
42 struct alternate_object_database *alloc_alt_odb(const char *dir);
43
44 /*
45 * Add the directory to the on-disk alternates file; the new entry will also
46 * take effect in the current process.
47 */
48 void add_to_alternates_file(const char *dir);
49
50 /*
51 * Add the directory to the in-memory list of alternates (along with any
52 * recursive alternates it points to), but do not modify the on-disk alternates
53 * file.
54 */
55 void add_to_alternates_memory(const char *dir);
56
57 /*
58 * Returns a scratch strbuf pre-filled with the alternate object directory,
59 * including a trailing slash, which can be used to access paths in the
60 * alternate. Always use this over direct access to alt->scratch, as it
61 * cleans up any previous use of the scratch buffer.
62 */
63 struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
64
65 struct packed_git {
66 struct packed_git *next;
67 struct list_head mru;
68 struct pack_window *windows;
69 off_t pack_size;
70 const void *index_data;
71 size_t index_size;
72 uint32_t num_objects;
73 uint32_t num_bad_objects;
74 unsigned char *bad_object_sha1;
75 int index_version;
76 time_t mtime;
77 int pack_fd;
78 int index; /* for builtin/pack-objects.c */
79 unsigned pack_local:1,
80 pack_keep:1,
81 pack_keep_in_core:1,
82 freshened:1,
83 do_not_close:1,
84 pack_promisor:1;
85 unsigned char sha1[20];
86 struct revindex_entry *revindex;
87 /* something like ".git/objects/pack/xxxxx.pack" */
88 char pack_name[FLEX_ARRAY]; /* more */
89 };
90
91 struct raw_object_store {
92 /*
93 * Path to the repository's object store.
94 * Cannot be NULL after initialization.
95 */
96 char *objectdir;
97
98 /* Path to extra alternate object database if not NULL */
99 char *alternate_db;
100
101 struct alternate_object_database *alt_odb_list;
102 struct alternate_object_database **alt_odb_tail;
103
104 /*
105 * Objects that should be substituted by other objects
106 * (see git-replace(1)).
107 */
108 struct oidmap *replace_map;
109
110 struct commit_graph *commit_graph;
111 unsigned commit_graph_attempted : 1; /* if loading has been attempted */
112
113 /*
114 * private data
115 *
116 * should only be accessed directly by packfile.c
117 */
118
119 struct packed_git *packed_git;
120 /* A most-recently-used ordered version of the packed_git list. */
121 struct list_head packed_git_mru;
122
123 /*
124 * A fast, rough count of the number of objects in the repository.
125 * These two fields are not meant for direct access. Use
126 * approximate_object_count() instead.
127 */
128 unsigned long approximate_object_count;
129 unsigned approximate_object_count_valid : 1;
130
131 /*
132 * Whether packed_git has already been populated with this repository's
133 * packs.
134 */
135 unsigned packed_git_initialized : 1;
136 };
137
138 struct raw_object_store *raw_object_store_new(void);
139 void raw_object_store_clear(struct raw_object_store *o);
140
141 /*
142 * Put in `buf` the name of the file in the local object database that
143 * would be used to store a loose object with the specified sha1.
144 */
145 void sha1_file_name(struct repository *r, struct strbuf *buf, const unsigned char *sha1);
146
147 void *map_sha1_file(struct repository *r, const unsigned char *sha1, unsigned long *size);
148
149 extern void *read_object_file_extended(const struct object_id *oid,
150 enum object_type *type,
151 unsigned long *size, int lookup_replace);
152 static inline void *read_object_file(const struct object_id *oid, enum object_type *type, unsigned long *size)
153 {
154 return read_object_file_extended(oid, type, size, 1);
155 }
156
157 /* Read and unpack an object file into memory, write memory to an object file */
158 int oid_object_info(struct repository *r, const struct object_id *, unsigned long *);
159
160 extern int hash_object_file(const void *buf, unsigned long len,
161 const char *type, struct object_id *oid);
162
163 extern int write_object_file(const void *buf, unsigned long len,
164 const char *type, struct object_id *oid);
165
166 extern int hash_object_file_literally(const void *buf, unsigned long len,
167 const char *type, struct object_id *oid,
168 unsigned flags);
169
170 extern int pretend_object_file(void *, unsigned long, enum object_type,
171 struct object_id *oid);
172
173 extern int force_object_loose(const struct object_id *oid, time_t mtime);
174
175 /*
176 * Open the loose object at path, check its hash, and return the contents,
177 * type, and size. If the object is a blob, then "contents" may return NULL,
178 * to allow streaming of large blobs.
179 *
180 * Returns 0 on success, negative on error (details may be written to stderr).
181 */
182 int read_loose_object(const char *path,
183 const struct object_id *expected_oid,
184 enum object_type *type,
185 unsigned long *size,
186 void **contents);
187
188 /*
189 * Convenience for sha1_object_info_extended() with a NULL struct
190 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass
191 * nonzero flags to also set other flags.
192 */
193 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
194 static inline int has_sha1_file(const unsigned char *sha1)
195 {
196 return has_sha1_file_with_flags(sha1, 0);
197 }
198
199 /* Same as the above, except for struct object_id. */
200 extern int has_object_file(const struct object_id *oid);
201 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
202
203 /*
204 * Return true iff an alternate object database has a loose object
205 * with the specified name. This function does not respect replace
206 * references.
207 */
208 extern int has_loose_object_nonlocal(const struct object_id *);
209
210 extern void assert_oid_type(const struct object_id *oid, enum object_type expect);
211
212 struct object_info {
213 /* Request */
214 enum object_type *typep;
215 unsigned long *sizep;
216 off_t *disk_sizep;
217 unsigned char *delta_base_sha1;
218 struct strbuf *type_name;
219 void **contentp;
220
221 /* Response */
222 enum {
223 OI_CACHED,
224 OI_LOOSE,
225 OI_PACKED,
226 OI_DBCACHED
227 } whence;
228 union {
229 /*
230 * struct {
231 * ... Nothing to expose in this case
232 * } cached;
233 * struct {
234 * ... Nothing to expose in this case
235 * } loose;
236 */
237 struct {
238 struct packed_git *pack;
239 off_t offset;
240 unsigned int is_delta;
241 } packed;
242 } u;
243 };
244
245 /*
246 * Initializer for a "struct object_info" that wants no items. You may
247 * also memset() the memory to all-zeroes.
248 */
249 #define OBJECT_INFO_INIT {NULL}
250
251 /* Invoke lookup_replace_object() on the given hash */
252 #define OBJECT_INFO_LOOKUP_REPLACE 1
253 /* Allow reading from a loose object file of unknown/bogus type */
254 #define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
255 /* Do not check cached storage */
256 #define OBJECT_INFO_SKIP_CACHED 4
257 /* Do not retry packed storage after checking packed and loose storage */
258 #define OBJECT_INFO_QUICK 8
259 /* Do not check loose object */
260 #define OBJECT_INFO_IGNORE_LOOSE 16
261
262 int oid_object_info_extended(struct repository *r,
263 const struct object_id *,
264 struct object_info *, unsigned flags);
265
266 #endif /* OBJECT_STORE_H */