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*);
38 * Add the directory to the on-disk alternates file; the new entry will also
39 * take effect in the current process.
41 void add_to_alternates_file(const char *dir
);
44 * Add the directory to the in-memory list of alternates (along with any
45 * recursive alternates it points to), but do not modify the on-disk alternates
48 void add_to_alternates_memory(const char *dir
);
51 * Populate and return the loose object cache array corresponding to the
54 struct oid_array
*odb_loose_cache(struct object_directory
*odb
,
55 const struct object_id
*oid
);
57 /* Empty the loose object cache for the specified object directory. */
58 void odb_clear_loose_cache(struct object_directory
*odb
);
61 struct packed_git
*next
;
63 struct pack_window
*windows
;
65 const void *index_data
;
68 uint32_t num_bad_objects
;
69 unsigned char *bad_object_sha1
;
73 int index
; /* for builtin/pack-objects.c */
74 unsigned pack_local
:1,
80 unsigned char sha1
[20];
81 struct revindex_entry
*revindex
;
82 /* something like ".git/objects/pack/xxxxx.pack" */
83 char pack_name
[FLEX_ARRAY
]; /* more */
86 struct multi_pack_index
;
88 struct raw_object_store
{
90 * Set of all object directories; the main directory is first (and
91 * cannot be NULL after initialization). Subsequent directories are
94 struct object_directory
*odb
;
95 struct object_directory
**odb_tail
;
96 int loaded_alternates
;
99 * A list of alternate object directories loaded from the environment;
100 * this should not generally need to be accessed directly, but will
101 * populate the "odb" list when prepare_alt_odb() is run.
106 * Objects that should be substituted by other objects
107 * (see git-replace(1)).
109 struct oidmap
*replace_map
;
111 struct commit_graph
*commit_graph
;
112 unsigned commit_graph_attempted
: 1; /* if loading has been attempted */
117 * should only be accessed directly by packfile.c and midx.c
119 struct multi_pack_index
*multi_pack_index
;
124 * should only be accessed directly by packfile.c
127 struct packed_git
*packed_git
;
128 /* A most-recently-used ordered version of the packed_git list. */
129 struct list_head packed_git_mru
;
132 * A linked list containing all packfiles, starting with those
133 * contained in the multi_pack_index.
135 struct packed_git
*all_packs
;
138 * A fast, rough count of the number of objects in the repository.
139 * These two fields are not meant for direct access. Use
140 * approximate_object_count() instead.
142 unsigned long approximate_object_count
;
143 unsigned approximate_object_count_valid
: 1;
146 * Whether packed_git has already been populated with this repository's
149 unsigned packed_git_initialized
: 1;
152 struct raw_object_store
*raw_object_store_new(void);
153 void raw_object_store_clear(struct raw_object_store
*o
);
156 * Put in `buf` the name of the file in the local object database that
157 * would be used to store a loose object with the specified oid.
159 const char *loose_object_path(struct repository
*r
, struct strbuf
*buf
,
160 const struct object_id
*oid
);
162 void *map_loose_object(struct repository
*r
, const struct object_id
*oid
,
163 unsigned long *size
);
165 extern void *read_object_file_extended(const struct object_id
*oid
,
166 enum object_type
*type
,
167 unsigned long *size
, int lookup_replace
);
168 static inline void *read_object_file(const struct object_id
*oid
, enum object_type
*type
, unsigned long *size
)
170 return read_object_file_extended(oid
, type
, size
, 1);
173 /* Read and unpack an object file into memory, write memory to an object file */
174 int oid_object_info(struct repository
*r
, const struct object_id
*, unsigned long *);
176 extern int hash_object_file(const void *buf
, unsigned long len
,
177 const char *type
, struct object_id
*oid
);
179 extern int write_object_file(const void *buf
, unsigned long len
,
180 const char *type
, struct object_id
*oid
);
182 extern int hash_object_file_literally(const void *buf
, unsigned long len
,
183 const char *type
, struct object_id
*oid
,
186 extern int pretend_object_file(void *, unsigned long, enum object_type
,
187 struct object_id
*oid
);
189 extern int force_object_loose(const struct object_id
*oid
, time_t mtime
);
192 * Open the loose object at path, check its hash, and return the contents,
193 * type, and size. If the object is a blob, then "contents" may return NULL,
194 * to allow streaming of large blobs.
196 * Returns 0 on success, negative on error (details may be written to stderr).
198 int read_loose_object(const char *path
,
199 const struct object_id
*expected_oid
,
200 enum object_type
*type
,
205 * Convenience for oid_object_info_extended() with a NULL struct
206 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass
207 * nonzero flags to also set other flags.
209 int has_object_file_with_flags(const struct object_id
*oid
, int flags
);
210 static inline int has_object_file(const struct object_id
*oid
)
212 return has_object_file_with_flags(oid
, 0);
216 * Return true iff an alternate object database has a loose object
217 * with the specified name. This function does not respect replace
220 extern int has_loose_object_nonlocal(const struct object_id
*);
222 extern void assert_oid_type(const struct object_id
*oid
, enum object_type expect
);
226 enum object_type
*typep
;
227 unsigned long *sizep
;
229 unsigned char *delta_base_sha1
;
230 struct strbuf
*type_name
;
243 * ... Nothing to expose in this case
246 * ... Nothing to expose in this case
250 struct packed_git
*pack
;
252 unsigned int is_delta
;
258 * Initializer for a "struct object_info" that wants no items. You may
259 * also memset() the memory to all-zeroes.
261 #define OBJECT_INFO_INIT {NULL}
263 /* Invoke lookup_replace_object() on the given hash */
264 #define OBJECT_INFO_LOOKUP_REPLACE 1
265 /* Allow reading from a loose object file of unknown/bogus type */
266 #define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
267 /* Do not check cached storage */
268 #define OBJECT_INFO_SKIP_CACHED 4
269 /* Do not retry packed storage after checking packed and loose storage */
270 #define OBJECT_INFO_QUICK 8
271 /* Do not check loose object */
272 #define OBJECT_INFO_IGNORE_LOOSE 16
274 int oid_object_info_extended(struct repository
*r
,
275 const struct object_id
*,
276 struct object_info
*, unsigned flags
);
279 * Iterate over the files in the loose-object parts of the object
280 * directory "path", triggering the following callbacks:
282 * - loose_object is called for each loose object we find.
284 * - loose_cruft is called for any files that do not appear to be
285 * loose objects. Note that we only look in the loose object
286 * directories "objects/[0-9a-f]{2}/", so we will not report
287 * "objects/foobar" as cruft.
289 * - loose_subdir is called for each top-level hashed subdirectory
290 * of the object directory (e.g., "$OBJDIR/f0"). It is called
291 * after the objects in the directory are processed.
293 * Any callback that is NULL will be ignored. Callbacks returning non-zero
294 * will end the iteration.
296 * In the "buf" variant, "path" is a strbuf which will also be used as a
297 * scratch buffer, but restored to its original contents before
298 * the function returns.
300 typedef int each_loose_object_fn(const struct object_id
*oid
,
303 typedef int each_loose_cruft_fn(const char *basename
,
306 typedef int each_loose_subdir_fn(unsigned int nr
,
309 int for_each_file_in_obj_subdir(unsigned int subdir_nr
,
311 each_loose_object_fn obj_cb
,
312 each_loose_cruft_fn cruft_cb
,
313 each_loose_subdir_fn subdir_cb
,
315 int for_each_loose_file_in_objdir(const char *path
,
316 each_loose_object_fn obj_cb
,
317 each_loose_cruft_fn cruft_cb
,
318 each_loose_subdir_fn subdir_cb
,
320 int for_each_loose_file_in_objdir_buf(struct strbuf
*path
,
321 each_loose_object_fn obj_cb
,
322 each_loose_cruft_fn cruft_cb
,
323 each_loose_subdir_fn subdir_cb
,
326 /* Flags for for_each_*_object() below. */
327 enum for_each_object_flags
{
328 /* Iterate only over local objects, not alternates. */
329 FOR_EACH_OBJECT_LOCAL_ONLY
= (1<<0),
331 /* Only iterate over packs obtained from the promisor remote. */
332 FOR_EACH_OBJECT_PROMISOR_ONLY
= (1<<1),
335 * Visit objects within a pack in packfile order rather than .idx order
337 FOR_EACH_OBJECT_PACK_ORDER
= (1<<2),
341 * Iterate over all accessible loose objects without respect to
342 * reachability. By default, this includes both local and alternate objects.
343 * The order in which objects are visited is unspecified.
345 * Any flags specific to packs are ignored.
347 int for_each_loose_object(each_loose_object_fn
, void *,
348 enum for_each_object_flags flags
);
351 * Iterate over all accessible packed objects without respect to reachability.
352 * By default, this includes both local and alternate packs.
354 * Note that some objects may appear twice if they are found in multiple packs.
355 * Each pack is visited in an unspecified order. By default, objects within a
356 * pack are visited in pack-idx order (i.e., sorted by oid).
358 typedef int each_packed_object_fn(const struct object_id
*oid
,
359 struct packed_git
*pack
,
362 int for_each_object_in_pack(struct packed_git
*p
,
363 each_packed_object_fn
, void *data
,
364 enum for_each_object_flags flags
);
365 int for_each_packed_object(each_packed_object_fn
, void *,
366 enum for_each_object_flags flags
);
368 #endif /* OBJECT_STORE_H */