6 #include "sha1-array.h"
9 struct alternate_object_database
{
10 struct alternate_object_database
*next
;
12 /* see alt_scratch_buf() */
13 struct strbuf scratch
;
17 * Used to store the results of readdir(3) calls when searching
18 * for unique abbreviated hashes. This cache is never
19 * invalidated, thus it's racy and not necessarily accurate.
20 * That's fine for its purpose; don't use it for tasks requiring
23 char loose_objects_subdir_seen
[256];
24 struct oid_array loose_objects_cache
;
27 * Path to the alternative object store. If this is a relative path,
28 * it is relative to the current working directory.
30 char path
[FLEX_ARRAY
];
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 alternate_object_database
*, void *);
35 int foreach_alt_odb(alt_odb_fn
, void*);
38 * Allocate a "struct alternate_object_database" but do _not_ actually
39 * add it to the list of alternates.
41 struct alternate_object_database
*alloc_alt_odb(const char *dir
);
44 * Add the directory to the on-disk alternates file; the new entry will also
45 * take effect in the current process.
47 void add_to_alternates_file(const char *dir
);
50 * Add the directory to the in-memory list of alternates (along with any
51 * recursive alternates it points to), but do not modify the on-disk alternates
54 void add_to_alternates_memory(const char *dir
);
57 * Returns a scratch strbuf pre-filled with the alternate object directory,
58 * including a trailing slash, which can be used to access paths in the
59 * alternate. Always use this over direct access to alt->scratch, as it
60 * cleans up any previous use of the scratch buffer.
62 struct strbuf
*alt_scratch_buf(struct alternate_object_database
*alt
);
65 struct packed_git
*next
;
67 struct pack_window
*windows
;
69 const void *index_data
;
72 uint32_t num_bad_objects
;
73 unsigned char *bad_object_sha1
;
77 int index
; /* for builtin/pack-objects.c */
78 unsigned pack_local
:1,
84 unsigned char sha1
[20];
85 struct revindex_entry
*revindex
;
86 /* something like ".git/objects/pack/xxxxx.pack" */
87 char pack_name
[FLEX_ARRAY
]; /* more */
90 struct raw_object_store
{
92 * Path to the repository's object store.
93 * Cannot be NULL after initialization.
97 /* Path to extra alternate object database if not NULL */
100 struct alternate_object_database
*alt_odb_list
;
101 struct alternate_object_database
**alt_odb_tail
;
104 * Objects that should be substituted by other objects
105 * (see git-replace(1)).
107 struct oidmap
*replace_map
;
109 struct commit_graph
*commit_graph
;
110 unsigned commit_graph_attempted
: 1; /* if loading has been attempted */
115 * should only be accessed directly by packfile.c
118 struct packed_git
*packed_git
;
119 /* A most-recently-used ordered version of the packed_git list. */
120 struct list_head packed_git_mru
;
123 * A fast, rough count of the number of objects in the repository.
124 * These two fields are not meant for direct access. Use
125 * approximate_object_count() instead.
127 unsigned long approximate_object_count
;
128 unsigned approximate_object_count_valid
: 1;
131 * Whether packed_git has already been populated with this repository's
134 unsigned packed_git_initialized
: 1;
137 struct raw_object_store
*raw_object_store_new(void);
138 void raw_object_store_clear(struct raw_object_store
*o
);
141 * Put in `buf` the name of the file in the local object database that
142 * would be used to store a loose object with the specified sha1.
144 void sha1_file_name(struct repository
*r
, struct strbuf
*buf
, const unsigned char *sha1
);
146 void *map_sha1_file(struct repository
*r
, const unsigned char *sha1
, unsigned long *size
);
148 extern void *read_object_file_extended(const struct object_id
*oid
,
149 enum object_type
*type
,
150 unsigned long *size
, int lookup_replace
);
151 static inline void *read_object_file(const struct object_id
*oid
, enum object_type
*type
, unsigned long *size
)
153 return read_object_file_extended(oid
, type
, size
, 1);
156 /* Read and unpack an object file into memory, write memory to an object file */
157 int oid_object_info(struct repository
*r
, const struct object_id
*, unsigned long *);
159 extern int hash_object_file(const void *buf
, unsigned long len
,
160 const char *type
, struct object_id
*oid
);
162 extern int write_object_file(const void *buf
, unsigned long len
,
163 const char *type
, struct object_id
*oid
);
165 extern int hash_object_file_literally(const void *buf
, unsigned long len
,
166 const char *type
, struct object_id
*oid
,
169 extern int pretend_object_file(void *, unsigned long, enum object_type
,
170 struct object_id
*oid
);
172 extern int force_object_loose(const struct object_id
*oid
, time_t mtime
);
175 * Open the loose object at path, check its hash, and return the contents,
176 * type, and size. If the object is a blob, then "contents" may return NULL,
177 * to allow streaming of large blobs.
179 * Returns 0 on success, negative on error (details may be written to stderr).
181 int read_loose_object(const char *path
,
182 const struct object_id
*expected_oid
,
183 enum object_type
*type
,
188 * Convenience for sha1_object_info_extended() with a NULL struct
189 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass
190 * nonzero flags to also set other flags.
192 extern int has_sha1_file_with_flags(const unsigned char *sha1
, int flags
);
193 static inline int has_sha1_file(const unsigned char *sha1
)
195 return has_sha1_file_with_flags(sha1
, 0);
198 /* Same as the above, except for struct object_id. */
199 extern int has_object_file(const struct object_id
*oid
);
200 extern int has_object_file_with_flags(const struct object_id
*oid
, int flags
);
203 * Return true iff an alternate object database has a loose object
204 * with the specified name. This function does not respect replace
207 extern int has_loose_object_nonlocal(const struct object_id
*);
209 extern void assert_oid_type(const struct object_id
*oid
, enum object_type expect
);
213 enum object_type
*typep
;
214 unsigned long *sizep
;
216 unsigned char *delta_base_sha1
;
217 struct strbuf
*type_name
;
230 * ... Nothing to expose in this case
233 * ... Nothing to expose in this case
237 struct packed_git
*pack
;
239 unsigned int is_delta
;
245 * Initializer for a "struct object_info" that wants no items. You may
246 * also memset() the memory to all-zeroes.
248 #define OBJECT_INFO_INIT {NULL}
250 /* Invoke lookup_replace_object() on the given hash */
251 #define OBJECT_INFO_LOOKUP_REPLACE 1
252 /* Allow reading from a loose object file of unknown/bogus type */
253 #define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
254 /* Do not check cached storage */
255 #define OBJECT_INFO_SKIP_CACHED 4
256 /* Do not retry packed storage after checking packed and loose storage */
257 #define OBJECT_INFO_QUICK 8
258 /* Do not check loose object */
259 #define OBJECT_INFO_IGNORE_LOOSE 16
261 int oid_object_info_extended(struct repository
*r
,
262 const struct object_id
*,
263 struct object_info
*, unsigned flags
);
266 * Iterate over the files in the loose-object parts of the object
267 * directory "path", triggering the following callbacks:
269 * - loose_object is called for each loose object we find.
271 * - loose_cruft is called for any files that do not appear to be
272 * loose objects. Note that we only look in the loose object
273 * directories "objects/[0-9a-f]{2}/", so we will not report
274 * "objects/foobar" as cruft.
276 * - loose_subdir is called for each top-level hashed subdirectory
277 * of the object directory (e.g., "$OBJDIR/f0"). It is called
278 * after the objects in the directory are processed.
280 * Any callback that is NULL will be ignored. Callbacks returning non-zero
281 * will end the iteration.
283 * In the "buf" variant, "path" is a strbuf which will also be used as a
284 * scratch buffer, but restored to its original contents before
285 * the function returns.
287 typedef int each_loose_object_fn(const struct object_id
*oid
,
290 typedef int each_loose_cruft_fn(const char *basename
,
293 typedef int each_loose_subdir_fn(unsigned int nr
,
296 int for_each_file_in_obj_subdir(unsigned int subdir_nr
,
298 each_loose_object_fn obj_cb
,
299 each_loose_cruft_fn cruft_cb
,
300 each_loose_subdir_fn subdir_cb
,
302 int for_each_loose_file_in_objdir(const char *path
,
303 each_loose_object_fn obj_cb
,
304 each_loose_cruft_fn cruft_cb
,
305 each_loose_subdir_fn subdir_cb
,
307 int for_each_loose_file_in_objdir_buf(struct strbuf
*path
,
308 each_loose_object_fn obj_cb
,
309 each_loose_cruft_fn cruft_cb
,
310 each_loose_subdir_fn subdir_cb
,
313 /* Flags for for_each_*_object() below. */
314 enum for_each_object_flags
{
315 /* Iterate only over local objects, not alternates. */
316 FOR_EACH_OBJECT_LOCAL_ONLY
= (1<<0),
318 /* Only iterate over packs obtained from the promisor remote. */
319 FOR_EACH_OBJECT_PROMISOR_ONLY
= (1<<1),
322 * Visit objects within a pack in packfile order rather than .idx order
324 FOR_EACH_OBJECT_PACK_ORDER
= (1<<2),
328 * Iterate over all accessible loose objects without respect to
329 * reachability. By default, this includes both local and alternate objects.
330 * The order in which objects are visited is unspecified.
332 * Any flags specific to packs are ignored.
334 int for_each_loose_object(each_loose_object_fn
, void *,
335 enum for_each_object_flags flags
);
338 * Iterate over all accessible packed objects without respect to reachability.
339 * By default, this includes both local and alternate packs.
341 * Note that some objects may appear twice if they are found in multiple packs.
342 * Each pack is visited in an unspecified order. By default, objects within a
343 * pack are visited in pack-idx order (i.e., sorted by oid).
345 typedef int each_packed_object_fn(const struct object_id
*oid
,
346 struct packed_git
*pack
,
349 int for_each_object_in_pack(struct packed_git
*p
,
350 each_packed_object_fn
, void *data
,
351 enum for_each_object_flags flags
);
352 int for_each_packed_object(each_packed_object_fn
, void *,
353 enum for_each_object_flags flags
);
355 #endif /* OBJECT_STORE_H */