[thirdparty/git.git] / object-store.h

#ifndef OBJECT_STORE_H
#define OBJECT_STORE_H

#include "cache.h"
#include "oidmap.h"
#include "list.h"
#include "sha1-array.h"
#include "strbuf.h"

struct object_directory {
	struct object_directory *next;

	/*
	 * Used to store the results of readdir(3) calls when we are OK
	 * sacrificing accuracy due to races for speed. That includes
	 * object existence with OBJECT_INFO_QUICK, as well as
	 * our search for unique abbreviated hashes. Don't use it for tasks
	 * requiring greater accuracy!
	 *
	 * Be sure to call odb_load_loose_cache() before using.
	 */
	char loose_objects_subdir_seen[256];
	struct oid_array loose_objects_cache[256];

	/*
	 * Path to the alternative object store. If this is a relative path,
	 * it is relative to the current working directory.
	 */
	char *path;
};

void prepare_alt_odb(struct repository *r);
char *compute_alternate_path(const char *path, struct strbuf *err);
typedef int alt_odb_fn(struct object_directory *, void *);
int foreach_alt_odb(alt_odb_fn, void*);

/*
 * Add the directory to the on-disk alternates file; the new entry will also
 * take effect in the current process.
 */
void add_to_alternates_file(const char *dir);

/*
 * Add the directory to the in-memory list of alternates (along with any
 * recursive alternates it points to), but do not modify the on-disk alternates
 * file.
 */
void add_to_alternates_memory(const char *dir);

/*
 * Populate and return the loose object cache array corresponding to the
 * given object ID.
 */
struct oid_array *odb_loose_cache(struct object_directory *odb,
				  const struct object_id *oid);

/* Empty the loose object cache for the specified object directory. */
void odb_clear_loose_cache(struct object_directory *odb);

struct packed_git {
	struct packed_git *next;
	struct list_head mru;
	struct pack_window *windows;
	off_t pack_size;
	const void *index_data;
	size_t index_size;
	uint32_t num_objects;
	uint32_t num_bad_objects;
	unsigned char *bad_object_sha1;
	int index_version;
	time_t mtime;
	int pack_fd;
	int index;              /* for builtin/pack-objects.c */
	unsigned pack_local:1,
		 pack_keep:1,
		 pack_keep_in_core:1,
		 freshened:1,
		 do_not_close:1,
		 pack_promisor:1,
		 multi_pack_index:1;
	unsigned char hash[GIT_MAX_RAWSZ];
	struct revindex_entry *revindex;
	/* something like ".git/objects/pack/xxxxx.pack" */
	char pack_name[FLEX_ARRAY]; /* more */
};

struct multi_pack_index;

struct raw_object_store {
	/*
	 * Set of all object directories; the main directory is first (and
	 * cannot be NULL after initialization). Subsequent directories are
	 * alternates.
	 */
	struct object_directory *odb;
	struct object_directory **odb_tail;
	int loaded_alternates;

	/*
	 * A list of alternate object directories loaded from the environment;
	 * this should not generally need to be accessed directly, but will
	 * populate the "odb" list when prepare_alt_odb() is run.
	 */
	char *alternate_db;

	/*
	 * Objects that should be substituted by other objects
	 * (see git-replace(1)).
	 */
	struct oidmap *replace_map;

	struct commit_graph *commit_graph;
	unsigned commit_graph_attempted : 1; /* if loading has been attempted */

	/*
	 * private data
	 *
	 * should only be accessed directly by packfile.c and midx.c
	 */
	struct multi_pack_index *multi_pack_index;

	/*
	 * private data
	 *
	 * should only be accessed directly by packfile.c
	 */

	struct packed_git *packed_git;
	/* A most-recently-used ordered version of the packed_git list. */
	struct list_head packed_git_mru;

	/*
	 * A fast, rough count of the number of objects in the repository.
	 * These two fields are not meant for direct access. Use
	 * approximate_object_count() instead.
	 */
	unsigned long approximate_object_count;
	unsigned approximate_object_count_valid : 1;

	/*
	 * Whether packed_git has already been populated with this repository's
	 * packs.
	 */
	unsigned packed_git_initialized : 1;
};

struct raw_object_store *raw_object_store_new(void);
void raw_object_store_clear(struct raw_object_store *o);

/*
 * Put in `buf` the name of the file in the local object database that
 * would be used to store a loose object with the specified oid.
 */
const char *loose_object_path(struct repository *r, struct strbuf *buf,
			      const struct object_id *oid);

void *map_loose_object(struct repository *r, const struct object_id *oid,
		       unsigned long *size);

void *read_object_file_extended(struct repository *r,
				const struct object_id *oid,
				enum object_type *type,
				unsigned long *size, int lookup_replace);
static inline void *repo_read_object_file(struct repository *r,
					  const struct object_id *oid,
					  enum object_type *type,
					  unsigned long *size)
{
	return read_object_file_extended(r, oid, type, size, 1);
}
#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
#define read_object_file(oid, type, size) repo_read_object_file(the_repository, oid, type, size)
#endif

/* Read and unpack an object file into memory, write memory to an object file */
int oid_object_info(struct repository *r, const struct object_id *, unsigned long *);

int hash_object_file(const void *buf, unsigned long len,
		     const char *type, struct object_id *oid);

int write_object_file(const void *buf, unsigned long len,
		      const char *type, struct object_id *oid);

int hash_object_file_literally(const void *buf, unsigned long len,
			       const char *type, struct object_id *oid,
			       unsigned flags);

int pretend_object_file(void *, unsigned long, enum object_type,
			struct object_id *oid);

int force_object_loose(const struct object_id *oid, time_t mtime);

/*
 * Open the loose object at path, check its hash, and return the contents,
 * type, and size. If the object is a blob, then "contents" may return NULL,
 * to allow streaming of large blobs.
 *
 * Returns 0 on success, negative on error (details may be written to stderr).
 */
int read_loose_object(const char *path,
		      const struct object_id *expected_oid,
		      enum object_type *type,
		      unsigned long *size,
		      void **contents);

#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
#define has_sha1_file_with_flags(sha1, flags) repo_has_sha1_file_with_flags(the_repository, sha1, flags)
#define has_sha1_file(sha1) repo_has_sha1_file(the_repository, sha1)
#endif

/* Same as the above, except for struct object_id. */
int repo_has_object_file(struct repository *r, const struct object_id *oid);
int repo_has_object_file_with_flags(struct repository *r,
				    const struct object_id *oid, int flags);
#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
#define has_object_file(oid) repo_has_object_file(the_repository, oid)
#define has_object_file_with_flags(oid, flags) repo_has_object_file_with_flags(the_repository, oid, flags)
#endif

/*
 * Return true iff an alternate object database has a loose object
 * with the specified name.  This function does not respect replace
 * references.
 */
int has_loose_object_nonlocal(const struct object_id *);

void assert_oid_type(const struct object_id *oid, enum object_type expect);

struct object_info {
	/* Request */
	enum object_type *typep;
	unsigned long *sizep;
	off_t *disk_sizep;
	unsigned char *delta_base_sha1;
	struct strbuf *type_name;
	void **contentp;

	/* Response */
	enum {
		OI_CACHED,
		OI_LOOSE,
		OI_PACKED,
		OI_DBCACHED
	} whence;
	union {
		/*
		 * struct {
		 * 	... Nothing to expose in this case
		 * } cached;
		 * struct {
		 * 	... Nothing to expose in this case
		 * } loose;
		 */
		struct {
			struct packed_git *pack;
			off_t offset;
			unsigned int is_delta;
		} packed;
	} u;
};

/*
 * Initializer for a "struct object_info" that wants no items. You may
 * also memset() the memory to all-zeroes.
 */
#define OBJECT_INFO_INIT {NULL}

/* Invoke lookup_replace_object() on the given hash */
#define OBJECT_INFO_LOOKUP_REPLACE 1
/* Allow reading from a loose object file of unknown/bogus type */
#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
/* Do not check cached storage */
#define OBJECT_INFO_SKIP_CACHED 4
/* Do not retry packed storage after checking packed and loose storage */
#define OBJECT_INFO_QUICK 8
/* Do not check loose object */
#define OBJECT_INFO_IGNORE_LOOSE 16
/*
 * Do not attempt to fetch the object if missing (even if fetch_is_missing is
 * nonzero).
 */
#define OBJECT_INFO_SKIP_FETCH_OBJECT 32
/*
 * This is meant for bulk prefetching of missing blobs in a partial
 * clone. Implies OBJECT_INFO_SKIP_FETCH_OBJECT and OBJECT_INFO_QUICK
 */
#define OBJECT_INFO_FOR_PREFETCH (OBJECT_INFO_SKIP_FETCH_OBJECT | OBJECT_INFO_QUICK)

int oid_object_info_extended(struct repository *r,
			     const struct object_id *,
			     struct object_info *, unsigned flags);

/*
 * Iterate over the files in the loose-object parts of the object
 * directory "path", triggering the following callbacks:
 *
 *  - loose_object is called for each loose object we find.
 *
 *  - loose_cruft is called for any files that do not appear to be
 *    loose objects. Note that we only look in the loose object
 *    directories "objects/[0-9a-f]{2}/", so we will not report
 *    "objects/foobar" as cruft.
 *
 *  - loose_subdir is called for each top-level hashed subdirectory
 *    of the object directory (e.g., "$OBJDIR/f0"). It is called
 *    after the objects in the directory are processed.
 *
 * Any callback that is NULL will be ignored. Callbacks returning non-zero
 * will end the iteration.
 *
 * In the "buf" variant, "path" is a strbuf which will also be used as a
 * scratch buffer, but restored to its original contents before
 * the function returns.
 */
typedef int each_loose_object_fn(const struct object_id *oid,
				 const char *path,
				 void *data);
typedef int each_loose_cruft_fn(const char *basename,
				const char *path,
				void *data);
typedef int each_loose_subdir_fn(unsigned int nr,
				 const char *path,
				 void *data);
int for_each_file_in_obj_subdir(unsigned int subdir_nr,
				struct strbuf *path,
				each_loose_object_fn obj_cb,
				each_loose_cruft_fn cruft_cb,
				each_loose_subdir_fn subdir_cb,
				void *data);
int for_each_loose_file_in_objdir(const char *path,
				  each_loose_object_fn obj_cb,
				  each_loose_cruft_fn cruft_cb,
				  each_loose_subdir_fn subdir_cb,
				  void *data);
int for_each_loose_file_in_objdir_buf(struct strbuf *path,
				      each_loose_object_fn obj_cb,
				      each_loose_cruft_fn cruft_cb,
				      each_loose_subdir_fn subdir_cb,
				      void *data);

/* Flags for for_each_*_object() below. */
enum for_each_object_flags {
	/* Iterate only over local objects, not alternates. */
	FOR_EACH_OBJECT_LOCAL_ONLY = (1<<0),

	/* Only iterate over packs obtained from the promisor remote. */
	FOR_EACH_OBJECT_PROMISOR_ONLY = (1<<1),

	/*
	 * Visit objects within a pack in packfile order rather than .idx order
	 */
	FOR_EACH_OBJECT_PACK_ORDER = (1<<2),
};

/*
 * Iterate over all accessible loose objects without respect to
 * reachability. By default, this includes both local and alternate objects.
 * The order in which objects are visited is unspecified.
 *
 * Any flags specific to packs are ignored.
 */
int for_each_loose_object(each_loose_object_fn, void *,
			  enum for_each_object_flags flags);

/*
 * Iterate over all accessible packed objects without respect to reachability.
 * By default, this includes both local and alternate packs.
 *
 * Note that some objects may appear twice if they are found in multiple packs.
 * Each pack is visited in an unspecified order. By default, objects within a
 * pack are visited in pack-idx order (i.e., sorted by oid).
 */
typedef int each_packed_object_fn(const struct object_id *oid,
				  struct packed_git *pack,
				  uint32_t pos,
				  void *data);
int for_each_object_in_pack(struct packed_git *p,
			    each_packed_object_fn, void *data,
			    enum for_each_object_flags flags);
int for_each_packed_object(each_packed_object_fn, void *,
			   enum for_each_object_flags flags);

#endif /* OBJECT_STORE_H */
Commit	Line	Data
90c62155 SB	1	#ifndef OBJECT_STORE_H
	2	#define OBJECT_STORE_H
	3
ef3ca954	4	#include "cache.h"
d88f9fdf	5	#include "oidmap.h"
14727b7f JT	6	#include "list.h"
	7	#include "sha1-array.h"
	8	#include "strbuf.h"
d88f9fdf	9
263db403 JK	10	struct object_directory {
263db403 JK	11	struct object_directory *next;
0d4a1321	12
0d4a1321	13	/*
3a2e0824 JK	14	* Used to store the results of readdir(3) calls when we are OK
3a2e0824 JK	15	* sacrificing accuracy due to races for speed. That includes
61c7711c	16	* object existence with OBJECT_INFO_QUICK, as well as
3a2e0824 JK	17	* our search for unique abbreviated hashes. Don't use it for tasks
	18	* requiring greater accuracy!
	19	*
	20	* Be sure to call odb_load_loose_cache() before using.
0d4a1321 SB	21	*/
0d4a1321 SB	22	char loose_objects_subdir_seen[256];
4cea1ce0	23	struct oid_array loose_objects_cache[256];
0d4a1321	24
77f012e8 SB	25	/*
	26	* Path to the alternative object store. If this is a relative path,
	27	* it is relative to the current working directory.
	28	*/
f0eaf638	29	char *path;
031dc927	30	};
f0eaf638	31
13068bf0	32	void prepare_alt_odb(struct repository *r);
0d4a1321	33	char compute_alternate_path(const char path, struct strbuf *err);
263db403	34	typedef int alt_odb_fn(struct object_directory , void );
0d4a1321 SB	35	int foreach_alt_odb(alt_odb_fn, void*);
0d4a1321 SB	36
0d4a1321 SB	37	/*
	38	* Add the directory to the on-disk alternates file; the new entry will also
	39	* take effect in the current process.
	40	*/
	41	void add_to_alternates_file(const char *dir);
	42
	43	/*
	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
	46	* file.
	47	*/
	48	void add_to_alternates_memory(const char *dir);
	49
0000d654 RS	50	/*
	51	* Populate and return the loose object cache array corresponding to the
	52	* given object ID.
	53	*/
	54	struct oid_array odb_loose_cache(struct object_directory odb,
	55	const struct object_id *oid);
	56
d4e19e51 RS	57	/* Empty the loose object cache for the specified object directory. */
	58	void odb_clear_loose_cache(struct object_directory *odb);
	59
a80d72db SB	60	struct packed_git {
	61	struct packed_git *next;
	62	struct list_head mru;
	63	struct pack_window *windows;
	64	off_t pack_size;
	65	const void *index_data;
	66	size_t index_size;
	67	uint32_t num_objects;
	68	uint32_t num_bad_objects;
	69	unsigned char *bad_object_sha1;
	70	int index_version;
	71	time_t mtime;
	72	int pack_fd;
43fa44fa	73	int index; /* for builtin/pack-objects.c */
a80d72db SB	74	unsigned pack_local:1,
a80d72db SB	75	pack_keep:1,
ed7e5fc3	76	pack_keep_in_core:1,
a80d72db SB	77	freshened:1,
a80d72db SB	78	do_not_close:1,
af96fe33 DS	79	pack_promisor:1,
af96fe33 DS	80	multi_pack_index:1;
538b1523	81	unsigned char hash[GIT_MAX_RAWSZ];
a80d72db SB	82	struct revindex_entry *revindex;
	83	/* something like ".git/objects/pack/xxxxx.pack" */
	84	char pack_name[FLEX_ARRAY]; /* more */
	85	};
	86
4d80560c DS	87	struct multi_pack_index;
4d80560c DS	88
90c62155 SB	89	struct raw_object_store {
90c62155 SB	90	/*
f0eaf638 JK	91	* Set of all object directories; the main directory is first (and
	92	* cannot be NULL after initialization). Subsequent directories are
	93	* alternates.
90c62155	94	*/
f0eaf638 JK	95	struct object_directory *odb;
	96	struct object_directory **odb_tail;
	97	int loaded_alternates;
90c62155	98
f0eaf638 JK	99	/*
	100	* A list of alternate object directories loaded from the environment;
	101	* this should not generally need to be accessed directly, but will
	102	* populate the "odb" list when prepare_alt_odb() is run.
	103	*/
90c62155	104	char *alternate_db;
031dc927	105
d88f9fdf SB	106	/*
	107	* Objects that should be substituted by other objects
	108	* (see git-replace(1)).
	109	*/
c1274495	110	struct oidmap *replace_map;
d88f9fdf	111
85277506 JT	112	struct commit_graph *commit_graph;
	113	unsigned commit_graph_attempted : 1; /* if loading has been attempted */
	114
c4d25228 DS	115	/*
	116	* private data
	117	*
	118	* should only be accessed directly by packfile.c and midx.c
	119	*/
	120	struct multi_pack_index *multi_pack_index;
	121
a80d72db SB	122	/*
	123	* private data
	124	*
	125	* should only be accessed directly by packfile.c
	126	*/
	127
	128	struct packed_git *packed_git;
	129	/* A most-recently-used ordered version of the packed_git list. */
	130	struct list_head packed_git_mru;
5508f693	131
9a00580d SB	132	/*
	133	* A fast, rough count of the number of objects in the repository.
	134	* These two fields are not meant for direct access. Use
	135	* approximate_object_count() instead.
	136	*/
	137	unsigned long approximate_object_count;
	138	unsigned approximate_object_count_valid : 1;
	139
5508f693 SB	140	/*
	141	* Whether packed_git has already been populated with this repository's
	142	* packs.
	143	*/
	144	unsigned packed_git_initialized : 1;
90c62155 SB	145	};
	146
	147	struct raw_object_store *raw_object_store_new(void);
	148	void raw_object_store_clear(struct raw_object_store *o);
	149
cf78ae4f SB	150	/*
cf78ae4f SB	151	* Put in `buf` the name of the file in the local object database that
514c5fdd	152	* would be used to store a loose object with the specified oid.
cf78ae4f	153	*/
514c5fdd JK	154	const char loose_object_path(struct repository r, struct strbuf *buf,
514c5fdd JK	155	const struct object_id *oid);
cf78ae4f	156
514c5fdd JK	157	void map_loose_object(struct repository r, const struct object_id *oid,
514c5fdd JK	158	unsigned long *size);
e35454fa	159
55454427	160	void read_object_file_extended(struct repository r,
ad6dad09 DL	161	const struct object_id *oid,
	162	enum object_type *type,
	163	unsigned long *size, int lookup_replace);
afd69dcc SB	164	static inline void repo_read_object_file(struct repository r,
	165	const struct object_id *oid,
	166	enum object_type *type,
	167	unsigned long *size)
cbd53a21	168	{
afd69dcc	169	return read_object_file_extended(r, oid, type, size, 1);
cbd53a21	170	}
afd69dcc SB	171	#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
	172	#define read_object_file(oid, type, size) repo_read_object_file(the_repository, oid, type, size)
	173	#endif
cbd53a21 SB	174
	175	/* Read and unpack an object file into memory, write memory to an object file */
	176	int oid_object_info(struct repository r, const struct object_id , unsigned long *);
	177
55454427	178	int hash_object_file(const void *buf, unsigned long len,
ad6dad09	179	const char type, struct object_id oid);
cbd53a21	180
55454427	181	int write_object_file(const void *buf, unsigned long len,
ad6dad09	182	const char type, struct object_id oid);
cbd53a21	183
55454427	184	int hash_object_file_literally(const void *buf, unsigned long len,
ad6dad09 DL	185	const char type, struct object_id oid,
ad6dad09 DL	186	unsigned flags);
cbd53a21	187
55454427	188	int pretend_object_file(void *, unsigned long, enum object_type,
ad6dad09	189	struct object_id *oid);
cbd53a21	190
55454427	191	int force_object_loose(const struct object_id *oid, time_t mtime);
cbd53a21 SB	192
	193	/*
	194	* Open the loose object at path, check its hash, and return the contents,
	195	* type, and size. If the object is a blob, then "contents" may return NULL,
	196	* to allow streaming of large blobs.
	197	*
	198	* Returns 0 on success, negative on error (details may be written to stderr).
	199	*/
	200	int read_loose_object(const char *path,
	201	const struct object_id *expected_oid,
	202	enum object_type *type,
	203	unsigned long *size,
	204	void **contents);
	205
9b45f499 SB	206	#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
	207	#define has_sha1_file_with_flags(sha1, flags) repo_has_sha1_file_with_flags(the_repository, sha1, flags)
	208	#define has_sha1_file(sha1) repo_has_sha1_file(the_repository, sha1)
	209	#endif
	210
cbd53a21	211	/* Same as the above, except for struct object_id. */
9b45f499 SB	212	int repo_has_object_file(struct repository r, const struct object_id oid);
	213	int repo_has_object_file_with_flags(struct repository *r,
	214	const struct object_id *oid, int flags);
	215	#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
	216	#define has_object_file(oid) repo_has_object_file(the_repository, oid)
	217	#define has_object_file_with_flags(oid, flags) repo_has_object_file_with_flags(the_repository, oid, flags)
	218	#endif
cbd53a21 SB	219
	220	/*
	221	* Return true iff an alternate object database has a loose object
	222	* with the specified name. This function does not respect replace
	223	* references.
	224	*/
55454427	225	int has_loose_object_nonlocal(const struct object_id *);
cbd53a21	226
55454427	227	void assert_oid_type(const struct object_id *oid, enum object_type expect);
cbd53a21 SB	228
	229	struct object_info {
	230	/* Request */
	231	enum object_type *typep;
	232	unsigned long *sizep;
	233	off_t *disk_sizep;
	234	unsigned char *delta_base_sha1;
	235	struct strbuf *type_name;
	236	void **contentp;
	237
	238	/* Response */
	239	enum {
	240	OI_CACHED,
	241	OI_LOOSE,
	242	OI_PACKED,
	243	OI_DBCACHED
	244	} whence;
	245	union {
	246	/*
	247	* struct {
	248	* ... Nothing to expose in this case
	249	* } cached;
	250	* struct {
	251	* ... Nothing to expose in this case
	252	* } loose;
	253	*/
	254	struct {
	255	struct packed_git *pack;
	256	off_t offset;
	257	unsigned int is_delta;
	258	} packed;
	259	} u;
	260	};
	261
	262	/*
	263	* Initializer for a "struct object_info" that wants no items. You may
	264	* also memset() the memory to all-zeroes.
	265	*/
	266	#define OBJECT_INFO_INIT {NULL}
	267
	268	/* Invoke lookup_replace_object() on the given hash */
	269	#define OBJECT_INFO_LOOKUP_REPLACE 1
	270	/* Allow reading from a loose object file of unknown/bogus type */
	271	#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
	272	/* Do not check cached storage */
	273	#define OBJECT_INFO_SKIP_CACHED 4
	274	/* Do not retry packed storage after checking packed and loose storage */
	275	#define OBJECT_INFO_QUICK 8
	276	/* Do not check loose object */
	277	#define OBJECT_INFO_IGNORE_LOOSE 16
0f4a4fb1 JT	278	/*
0f4a4fb1 JT	279	* Do not attempt to fetch the object if missing (even if fetch_is_missing is
31f5256c	280	* nonzero).
0f4a4fb1	281	*/
31f5256c DS	282	#define OBJECT_INFO_SKIP_FETCH_OBJECT 32
	283	/*
	284	* This is meant for bulk prefetching of missing blobs in a partial
	285	* clone. Implies OBJECT_INFO_SKIP_FETCH_OBJECT and OBJECT_INFO_QUICK
	286	*/
	287	#define OBJECT_INFO_FOR_PREFETCH (OBJECT_INFO_SKIP_FETCH_OBJECT \| OBJECT_INFO_QUICK)
cbd53a21 SB	288
	289	int oid_object_info_extended(struct repository *r,
	290	const struct object_id *,
	291	struct object_info *, unsigned flags);
	292
0889aae1 JK	293	/*
	294	* Iterate over the files in the loose-object parts of the object
	295	* directory "path", triggering the following callbacks:
	296	*
	297	* - loose_object is called for each loose object we find.
	298	*
	299	* - loose_cruft is called for any files that do not appear to be
	300	* loose objects. Note that we only look in the loose object
	301	* directories "objects/[0-9a-f]{2}/", so we will not report
	302	* "objects/foobar" as cruft.
	303	*
	304	* - loose_subdir is called for each top-level hashed subdirectory
	305	* of the object directory (e.g., "$OBJDIR/f0"). It is called
	306	* after the objects in the directory are processed.
	307	*
	308	* Any callback that is NULL will be ignored. Callbacks returning non-zero
	309	* will end the iteration.
	310	*
	311	* In the "buf" variant, "path" is a strbuf which will also be used as a
	312	* scratch buffer, but restored to its original contents before
	313	* the function returns.
	314	*/
	315	typedef int each_loose_object_fn(const struct object_id *oid,
	316	const char *path,
	317	void *data);
	318	typedef int each_loose_cruft_fn(const char *basename,
	319	const char *path,
	320	void *data);
	321	typedef int each_loose_subdir_fn(unsigned int nr,
	322	const char *path,
	323	void *data);
	324	int for_each_file_in_obj_subdir(unsigned int subdir_nr,
	325	struct strbuf *path,
	326	each_loose_object_fn obj_cb,
	327	each_loose_cruft_fn cruft_cb,
	328	each_loose_subdir_fn subdir_cb,
	329	void *data);
	330	int for_each_loose_file_in_objdir(const char *path,
	331	each_loose_object_fn obj_cb,
	332	each_loose_cruft_fn cruft_cb,
	333	each_loose_subdir_fn subdir_cb,
	334	void *data);
	335	int for_each_loose_file_in_objdir_buf(struct strbuf *path,
	336	each_loose_object_fn obj_cb,
	337	each_loose_cruft_fn cruft_cb,
	338	each_loose_subdir_fn subdir_cb,
	339	void *data);
	340
	341	/* Flags for for_each__object() below. /
	342	enum for_each_object_flags {
	343	/* Iterate only over local objects, not alternates. */
	344	FOR_EACH_OBJECT_LOCAL_ONLY = (1<<0),
	345
	346	/* Only iterate over packs obtained from the promisor remote. */
	347	FOR_EACH_OBJECT_PROMISOR_ONLY = (1<<1),
	348
	349	/*
	350	* Visit objects within a pack in packfile order rather than .idx order
	351	*/
	352	FOR_EACH_OBJECT_PACK_ORDER = (1<<2),
	353	};
	354
	355	/*
	356	* Iterate over all accessible loose objects without respect to
357	* reachability. By default, this includes both local and alternate objects.
358	* The order in which objects are visited is unspecified.
359	*
360	* Any flags specific to packs are ignored.
361	*/
362	int for_each_loose_object(each_loose_object_fn, void *,
363	enum for_each_object_flags flags);
364
365	/*
366	* Iterate over all accessible packed objects without respect to reachability.
367	* By default, this includes both local and alternate packs.
368	*
369	* Note that some objects may appear twice if they are found in multiple packs.
370	* Each pack is visited in an unspecified order. By default, objects within a
371	* pack are visited in pack-idx order (i.e., sorted by oid).
372	*/
373	typedef int each_packed_object_fn(const struct object_id *oid,
374	struct packed_git *pack,
375	uint32_t pos,
376	void *data);
377	int for_each_object_in_pack(struct packed_git *p,
378	each_packed_object_fn, void *data,
379	enum for_each_object_flags flags);
380	int for_each_packed_object(each_packed_object_fn, void *,
381	enum for_each_object_flags flags);
382
90c62155	383	#endif /* OBJECT_STORE_H */