7 #include "sha1-array.h"
10 struct object_directory {
11 struct object_directory *next;
14 * Used to store the results of readdir(3) calls when we are OK
15 * sacrificing accuracy due to races for speed. That includes
16 * object existence with OBJECT_INFO_QUICK, as well as
17 * our search for unique abbreviated hashes. Don't use it for tasks
18 * requiring greater accuracy!
20 * Be sure to call odb_load_loose_cache() before using.
22 char loose_objects_subdir_seen[256];
23 struct oid_array loose_objects_cache[256];
26 * Path to the alternative object store. If this is a relative path,
27 * it is relative to the current working directory.
32 void prepare_alt_odb(struct repository *r);
33 char *compute_alternate_path(const char *path, struct strbuf *err);
34 typedef int alt_odb_fn(struct object_directory *, void *);
35 int foreach_alt_odb(alt_odb_fn, void*);
36 typedef void alternate_ref_fn(const struct object_id *oid, void *);
37 void for_each_alternate_ref(alternate_ref_fn, void *);
40 * Add the directory to the on-disk alternates file; the new entry will also
41 * take effect in the current process.
43 void add_to_alternates_file(const char *dir);
46 * Add the directory to the in-memory list of alternates (along with any
47 * recursive alternates it points to), but do not modify the on-disk alternates
50 void add_to_alternates_memory(const char *dir);
53 * Populate and return the loose object cache array corresponding to the
56 struct oid_array *odb_loose_cache(struct object_directory *odb,
57 const struct object_id *oid);
59 /* Empty the loose object cache for the specified object directory. */
60 void odb_clear_loose_cache(struct object_directory *odb);
63 struct hashmap_entry packmap_ent;
64 struct packed_git *next;
66 struct pack_window *windows;
68 const void *index_data;
71 uint32_t num_bad_objects;
72 unsigned char *bad_object_sha1;
76 int index; /* for builtin/pack-objects.c */
77 unsigned pack_local:1,
84 unsigned char hash[GIT_MAX_RAWSZ];
85 struct revindex_entry *revindex;
86 /* something like ".git/objects/pack/xxxxx.pack" */
87 char pack_name[FLEX_ARRAY]; /* more */
90 struct multi_pack_index;
92 static inline int pack_map_entry_cmp(const void *unused_cmp_data,
93 const struct hashmap_entry *entry,
94 const struct hashmap_entry *entry2,
97 const char *key = keydata;
98 const struct packed_git *pg1, *pg2;
100 pg1 = container_of(entry, const struct packed_git, packmap_ent);
101 pg2 = container_of(entry2, const struct packed_git, packmap_ent);
103 return strcmp(pg1->pack_name, key ? key : pg2->pack_name);
106 struct raw_object_store {
108 * Set of all object directories; the main directory is first (and
109 * cannot be NULL after initialization). Subsequent directories are
112 struct object_directory *odb;
113 struct object_directory **odb_tail;
114 int loaded_alternates;
117 * A list of alternate object directories loaded from the environment;
118 * this should not generally need to be accessed directly, but will
119 * populate the "odb" list when prepare_alt_odb() is run.
124 * Objects that should be substituted by other objects
125 * (see git-replace(1)).
127 struct oidmap *replace_map;
129 struct commit_graph *commit_graph;
130 unsigned commit_graph_attempted : 1; /* if loading has been attempted */
135 * should only be accessed directly by packfile.c and midx.c
137 struct multi_pack_index *multi_pack_index;
142 * should only be accessed directly by packfile.c
145 struct packed_git *packed_git;
146 /* A most-recently-used ordered version of the packed_git list. */
147 struct list_head packed_git_mru;
150 * A map of packfiles to packed_git structs for tracking which
151 * packs have been loaded already.
153 struct hashmap pack_map;
156 * A fast, rough count of the number of objects in the repository.
157 * These two fields are not meant for direct access. Use
158 * approximate_object_count() instead.
160 unsigned long approximate_object_count;
161 unsigned approximate_object_count_valid : 1;
164 * Whether packed_git has already been populated with this repository's
167 unsigned packed_git_initialized : 1;
170 struct raw_object_store *raw_object_store_new(void);
171 void raw_object_store_clear(struct raw_object_store *o);
174 * Put in `buf` the name of the file in the local object database that
175 * would be used to store a loose object with the specified oid.
177 const char *loose_object_path(struct repository *r, struct strbuf *buf,
178 const struct object_id *oid);
180 void *map_loose_object(struct repository *r, const struct object_id *oid,
181 unsigned long *size);
183 void *read_object_file_extended(struct repository *r,
184 const struct object_id *oid,
185 enum object_type *type,
186 unsigned long *size, int lookup_replace);
187 static inline void *repo_read_object_file(struct repository *r,
188 const struct object_id *oid,
189 enum object_type *type,
192 return read_object_file_extended(r, oid, type, size, 1);
194 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
195 #define read_object_file(oid, type, size) repo_read_object_file(the_repository, oid, type, size)
198 /* Read and unpack an object file into memory, write memory to an object file */
199 int oid_object_info(struct repository *r, const struct object_id *, unsigned long *);
201 int hash_object_file(const void *buf, unsigned long len,
202 const char *type, struct object_id *oid);
204 int write_object_file(const void *buf, unsigned long len,
205 const char *type, struct object_id *oid);
207 int hash_object_file_literally(const void *buf, unsigned long len,
208 const char *type, struct object_id *oid,
212 * Add an object file to the in-memory object store, without writing it
215 * Callers are responsible for calling write_object_file to record the
216 * object in persistent storage before writing any other new objects
219 int pretend_object_file(void *, unsigned long, enum object_type,
220 struct object_id *oid);
222 int force_object_loose(const struct object_id *oid, time_t mtime);
225 * Open the loose object at path, check its hash, and return the contents,
226 * type, and size. If the object is a blob, then "contents" may return NULL,
227 * to allow streaming of large blobs.
229 * Returns 0 on success, negative on error (details may be written to stderr).
231 int read_loose_object(const char *path,
232 const struct object_id *expected_oid,
233 enum object_type *type,
237 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
238 #define has_sha1_file_with_flags(sha1, flags) repo_has_sha1_file_with_flags(the_repository, sha1, flags)
239 #define has_sha1_file(sha1) repo_has_sha1_file(the_repository, sha1)
242 /* Same as the above, except for struct object_id. */
243 int repo_has_object_file(struct repository *r, const struct object_id *oid);
244 int repo_has_object_file_with_flags(struct repository *r,
245 const struct object_id *oid, int flags);
246 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
247 #define has_object_file(oid) repo_has_object_file(the_repository, oid)
248 #define has_object_file_with_flags(oid, flags) repo_has_object_file_with_flags(the_repository, oid, flags)
252 * Return true iff an alternate object database has a loose object
253 * with the specified name. This function does not respect replace
256 int has_loose_object_nonlocal(const struct object_id *);
258 void assert_oid_type(const struct object_id *oid, enum object_type expect);
262 enum object_type *typep;
263 unsigned long *sizep;
265 unsigned char *delta_base_sha1;
266 struct strbuf *type_name;
279 * ... Nothing to expose in this case
282 * ... Nothing to expose in this case
286 struct packed_git *pack;
288 unsigned int is_delta;
294 * Initializer for a "struct object_info" that wants no items. You may
295 * also memset() the memory to all-zeroes.
297 #define OBJECT_INFO_INIT {NULL}
299 /* Invoke lookup_replace_object() on the given hash */
300 #define OBJECT_INFO_LOOKUP_REPLACE 1
301 /* Allow reading from a loose object file of unknown/bogus type */
302 #define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
303 /* Do not retry packed storage after checking packed and loose storage */
304 #define OBJECT_INFO_QUICK 8
305 /* Do not check loose object */
306 #define OBJECT_INFO_IGNORE_LOOSE 16
308 * Do not attempt to fetch the object if missing (even if fetch_is_missing is
311 #define OBJECT_INFO_SKIP_FETCH_OBJECT 32
313 * This is meant for bulk prefetching of missing blobs in a partial
314 * clone. Implies OBJECT_INFO_SKIP_FETCH_OBJECT and OBJECT_INFO_QUICK
316 #define OBJECT_INFO_FOR_PREFETCH (OBJECT_INFO_SKIP_FETCH_OBJECT | OBJECT_INFO_QUICK)
318 int oid_object_info_extended(struct repository *r,
319 const struct object_id *,
320 struct object_info *, unsigned flags);
323 * Iterate over the files in the loose-object parts of the object
324 * directory "path", triggering the following callbacks:
326 * - loose_object is called for each loose object we find.
328 * - loose_cruft is called for any files that do not appear to be
329 * loose objects. Note that we only look in the loose object
330 * directories "objects/[0-9a-f]{2}/", so we will not report
331 * "objects/foobar" as cruft.
333 * - loose_subdir is called for each top-level hashed subdirectory
334 * of the object directory (e.g., "$OBJDIR/f0"). It is called
335 * after the objects in the directory are processed.
337 * Any callback that is NULL will be ignored. Callbacks returning non-zero
338 * will end the iteration.
340 * In the "buf" variant, "path" is a strbuf which will also be used as a
341 * scratch buffer, but restored to its original contents before
342 * the function returns.
344 typedef int each_loose_object_fn(const struct object_id *oid,
347 typedef int each_loose_cruft_fn(const char *basename,
350 typedef int each_loose_subdir_fn(unsigned int nr,
353 int for_each_file_in_obj_subdir(unsigned int subdir_nr,
355 each_loose_object_fn obj_cb,
356 each_loose_cruft_fn cruft_cb,
357 each_loose_subdir_fn subdir_cb,
359 int for_each_loose_file_in_objdir(const char *path,
360 each_loose_object_fn obj_cb,
361 each_loose_cruft_fn cruft_cb,
362 each_loose_subdir_fn subdir_cb,
364 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
365 each_loose_object_fn obj_cb,
366 each_loose_cruft_fn cruft_cb,
367 each_loose_subdir_fn subdir_cb,
370 /* Flags for for_each_*_object() below. */
371 enum for_each_object_flags {
372 /* Iterate only over local objects, not alternates. */
373 FOR_EACH_OBJECT_LOCAL_ONLY = (1<<0),
375 /* Only iterate over packs obtained from the promisor remote. */
376 FOR_EACH_OBJECT_PROMISOR_ONLY = (1<<1),
379 * Visit objects within a pack in packfile order rather than .idx order
381 FOR_EACH_OBJECT_PACK_ORDER = (1<<2),
385 * Iterate over all accessible loose objects without respect to
386 * reachability. By default, this includes both local and alternate objects.
387 * The order in which objects are visited is unspecified.
389 * Any flags specific to packs are ignored.
391 int for_each_loose_object(each_loose_object_fn, void *,
392 enum for_each_object_flags flags);
395 * Iterate over all accessible packed objects without respect to reachability.
396 * By default, this includes both local and alternate packs.
398 * Note that some objects may appear twice if they are found in multiple packs.
399 * Each pack is visited in an unspecified order. By default, objects within a
400 * pack are visited in pack-idx order (i.e., sorted by oid).
402 typedef int each_packed_object_fn(const struct object_id *oid,
403 struct packed_git *pack,
406 int for_each_object_in_pack(struct packed_git *p,
407 each_packed_object_fn, void *data,
408 enum for_each_object_flags flags);
409 int for_each_packed_object(each_packed_object_fn, void *,
410 enum for_each_object_flags flags);
412 #endif /* OBJECT_STORE_H */