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

#ifndef OBJECT_STORE_H
#define OBJECT_STORE_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;

	char path[FLEX_ARRAY];
};
void prepare_alt_odb(void);
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;

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

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

#endif /* OBJECT_STORE_H */
Commit	Line	Data
90c62155 SB	1	#ifndef OBJECT_STORE_H
	2	#define OBJECT_STORE_H
	3
031dc927	4	struct alternate_object_database {
0d4a1321 SB	5	struct alternate_object_database *next;
	6
	7	/* see alt_scratch_buf() */
	8	struct strbuf scratch;
	9	size_t base_len;
	10
	11	/*
	12	* Used to store the results of readdir(3) calls when searching
	13	* for unique abbreviated hashes. This cache is never
	14	* invalidated, thus it's racy and not necessarily accurate.
	15	* That's fine for its purpose; don't use it for tasks requiring
	16	* greater accuracy!
	17	*/
	18	char loose_objects_subdir_seen[256];
	19	struct oid_array loose_objects_cache;
	20
	21	char path[FLEX_ARRAY];
031dc927	22	};
0d4a1321 SB	23	void prepare_alt_odb(void);
	24	char compute_alternate_path(const char path, struct strbuf *err);
	25	typedef int alt_odb_fn(struct alternate_object_database , void );
	26	int foreach_alt_odb(alt_odb_fn, void*);
	27
	28	/*
	29	* Allocate a "struct alternate_object_database" but do _not_ actually
	30	* add it to the list of alternates.
	31	*/
	32	struct alternate_object_database alloc_alt_odb(const char dir);
	33
	34	/*
	35	* Add the directory to the on-disk alternates file; the new entry will also
	36	* take effect in the current process.
	37	*/
	38	void add_to_alternates_file(const char *dir);
	39
	40	/*
	41	* Add the directory to the in-memory list of alternates (along with any
	42	* recursive alternates it points to), but do not modify the on-disk alternates
	43	* file.
	44	*/
	45	void add_to_alternates_memory(const char *dir);
	46
	47	/*
	48	* Returns a scratch strbuf pre-filled with the alternate object directory,
	49	* including a trailing slash, which can be used to access paths in the
	50	* alternate. Always use this over direct access to alt->scratch, as it
	51	* cleans up any previous use of the scratch buffer.
	52	*/
	53	struct strbuf alt_scratch_buf(struct alternate_object_database alt);
	54
a80d72db SB	55	struct packed_git {
	56	struct packed_git *next;
	57	struct list_head mru;
	58	struct pack_window *windows;
	59	off_t pack_size;
	60	const void *index_data;
	61	size_t index_size;
	62	uint32_t num_objects;
	63	uint32_t num_bad_objects;
	64	unsigned char *bad_object_sha1;
	65	int index_version;
	66	time_t mtime;
	67	int pack_fd;
	68	unsigned pack_local:1,
	69	pack_keep:1,
	70	freshened:1,
	71	do_not_close:1,
	72	pack_promisor:1;
	73	unsigned char sha1[20];
	74	struct revindex_entry *revindex;
	75	/* something like ".git/objects/pack/xxxxx.pack" */
	76	char pack_name[FLEX_ARRAY]; /* more */
	77	};
	78
90c62155 SB	79	struct raw_object_store {
	80	/*
	81	* Path to the repository's object store.
	82	* Cannot be NULL after initialization.
	83	*/
	84	char *objectdir;
	85
	86	/* Path to extra alternate object database if not NULL */
	87	char *alternate_db;
031dc927 SB	88
	89	struct alternate_object_database *alt_odb_list;
	90	struct alternate_object_database **alt_odb_tail;
a80d72db SB	91
	92	/*
	93	* private data
	94	*
	95	* should only be accessed directly by packfile.c
	96	*/
	97
	98	struct packed_git *packed_git;
	99	/* A most-recently-used ordered version of the packed_git list. */
	100	struct list_head packed_git_mru;
90c62155 SB	101	};
	102
	103	struct raw_object_store *raw_object_store_new(void);
	104	void raw_object_store_clear(struct raw_object_store *o);
	105
	106	#endif /* OBJECT_STORE_H */