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

#ifndef OBJECT_STORE_H
#define OBJECT_STORE_H

#include "oidmap.h"

struct alternate_object_database {
	struct alternate_object_database *next;

	/* see alt_scratch_buf() */
	struct strbuf scratch;
	size_t base_len;

	/*
	 * Used to store the results of readdir(3) calls when searching
	 * for unique abbreviated hashes.  This cache is never
	 * invalidated, thus it's racy and not necessarily accurate.
	 * That's fine for its purpose; don't use it for tasks requiring
	 * greater accuracy!
	 */
	char loose_objects_subdir_seen[256];
	struct oid_array loose_objects_cache;

	/*
	 * Path to the alternative object store. If this is a relative path,
	 * it is relative to the current working directory.
	 */
	char path[FLEX_ARRAY];
};
void prepare_alt_odb(struct repository *r);
char *compute_alternate_path(const char *path, struct strbuf *err);
typedef int alt_odb_fn(struct alternate_object_database *, void *);
int foreach_alt_odb(alt_odb_fn, void*);

/*
 * Allocate a "struct alternate_object_database" but do _not_ actually
 * add it to the list of alternates.
 */
struct alternate_object_database *alloc_alt_odb(const char *dir);

/*
 * 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);

/*
 * Returns a scratch strbuf pre-filled with the alternate object directory,
 * including a trailing slash, which can be used to access paths in the
 * alternate. Always use this over direct access to alt->scratch, as it
 * cleans up any previous use of the scratch buffer.
 */
struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);

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;
	unsigned pack_local:1,
		 pack_keep:1,
		 freshened:1,
		 do_not_close:1,
		 pack_promisor:1;
	unsigned char sha1[20];
	struct revindex_entry *revindex;
	/* something like ".git/objects/pack/xxxxx.pack" */
	char pack_name[FLEX_ARRAY]; /* more */
};

struct raw_object_store {
	/*
	 * Path to the repository's object store.
	 * Cannot be NULL after initialization.
	 */
	char *objectdir;

	/* Path to extra alternate object database if not NULL */
	char *alternate_db;

	struct alternate_object_database *alt_odb_list;
	struct alternate_object_database **alt_odb_tail;

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

	/*
	 * 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 sha1.
 */
void sha1_file_name(struct repository *r, struct strbuf *buf, const unsigned char *sha1);

void *map_sha1_file(struct repository *r, const unsigned char *sha1, unsigned long *size);

#endif /* OBJECT_STORE_H */
Commit	Line	Data
90c62155 SB	1	#ifndef OBJECT_STORE_H
	2	#define OBJECT_STORE_H
	3
d88f9fdf SB	4	#include "oidmap.h"
d88f9fdf SB	5
031dc927	6	struct alternate_object_database {
0d4a1321 SB	7	struct alternate_object_database *next;
	8
	9	/* see alt_scratch_buf() */
	10	struct strbuf scratch;
	11	size_t base_len;
	12
	13	/*
	14	* Used to store the results of readdir(3) calls when searching
	15	* for unique abbreviated hashes. This cache is never
	16	* invalidated, thus it's racy and not necessarily accurate.
	17	* That's fine for its purpose; don't use it for tasks requiring
	18	* greater accuracy!
	19	*/
	20	char loose_objects_subdir_seen[256];
	21	struct oid_array loose_objects_cache;
	22
77f012e8 SB	23	/*
	24	* Path to the alternative object store. If this is a relative path,
	25	* it is relative to the current working directory.
	26	*/
0d4a1321	27	char path[FLEX_ARRAY];
031dc927	28	};
13068bf0	29	void prepare_alt_odb(struct repository *r);
0d4a1321 SB	30	char compute_alternate_path(const char path, struct strbuf *err);
	31	typedef int alt_odb_fn(struct alternate_object_database , void );
	32	int foreach_alt_odb(alt_odb_fn, void*);
	33
	34	/*
	35	* Allocate a "struct alternate_object_database" but do _not_ actually
	36	* add it to the list of alternates.
	37	*/
	38	struct alternate_object_database alloc_alt_odb(const char dir);
	39
	40	/*
	41	* Add the directory to the on-disk alternates file; the new entry will also
	42	* take effect in the current process.
	43	*/
	44	void add_to_alternates_file(const char *dir);
	45
	46	/*
	47	* Add the directory to the in-memory list of alternates (along with any
	48	* recursive alternates it points to), but do not modify the on-disk alternates
	49	* file.
	50	*/
	51	void add_to_alternates_memory(const char *dir);
	52
	53	/*
	54	* Returns a scratch strbuf pre-filled with the alternate object directory,
	55	* including a trailing slash, which can be used to access paths in the
	56	* alternate. Always use this over direct access to alt->scratch, as it
	57	* cleans up any previous use of the scratch buffer.
	58	*/
	59	struct strbuf alt_scratch_buf(struct alternate_object_database alt);
	60
a80d72db SB	61	struct packed_git {
	62	struct packed_git *next;
	63	struct list_head mru;
	64	struct pack_window *windows;
	65	off_t pack_size;
	66	const void *index_data;
	67	size_t index_size;
	68	uint32_t num_objects;
	69	uint32_t num_bad_objects;
	70	unsigned char *bad_object_sha1;
	71	int index_version;
	72	time_t mtime;
	73	int pack_fd;
	74	unsigned pack_local:1,
	75	pack_keep:1,
	76	freshened:1,
	77	do_not_close:1,
	78	pack_promisor:1;
	79	unsigned char sha1[20];
	80	struct revindex_entry *revindex;
	81	/* something like ".git/objects/pack/xxxxx.pack" */
	82	char pack_name[FLEX_ARRAY]; /* more */
	83	};
	84
90c62155 SB	85	struct raw_object_store {
	86	/*
	87	* Path to the repository's object store.
	88	* Cannot be NULL after initialization.
	89	*/
	90	char *objectdir;
	91
	92	/* Path to extra alternate object database if not NULL */
	93	char *alternate_db;
031dc927 SB	94
	95	struct alternate_object_database *alt_odb_list;
	96	struct alternate_object_database **alt_odb_tail;
a80d72db	97
d88f9fdf SB	98	/*
	99	* Objects that should be substituted by other objects
	100	* (see git-replace(1)).
	101	*/
	102	struct oidmap replace_map;
	103
a80d72db SB	104	/*
	105	* private data
	106	*
	107	* should only be accessed directly by packfile.c
	108	*/
	109
	110	struct packed_git *packed_git;
	111	/* A most-recently-used ordered version of the packed_git list. */
	112	struct list_head packed_git_mru;
5508f693	113
9a00580d SB	114	/*
	115	* A fast, rough count of the number of objects in the repository.
	116	* These two fields are not meant for direct access. Use
	117	* approximate_object_count() instead.
	118	*/
	119	unsigned long approximate_object_count;
	120	unsigned approximate_object_count_valid : 1;
	121
5508f693 SB	122	/*
	123	* Whether packed_git has already been populated with this repository's
	124	* packs.
	125	*/
	126	unsigned packed_git_initialized : 1;
90c62155 SB	127	};
	128
	129	struct raw_object_store *raw_object_store_new(void);
	130	void raw_object_store_clear(struct raw_object_store *o);
	131
cf78ae4f SB	132	/*
	133	* Put in `buf` the name of the file in the local object database that
	134	* would be used to store a loose object with the specified sha1.
	135	*/
a68377b5	136	void sha1_file_name(struct repository r, struct strbuf buf, const unsigned char *sha1);
cf78ae4f	137
bd27f50c	138	void map_sha1_file(struct repository r, const unsigned char sha1, unsigned long size);
e35454fa	139
90c62155	140	#endif /* OBJECT_STORE_H */