[thirdparty/git.git] / midx.h

#ifndef MIDX_H
#define MIDX_H

#include "string-list.h"

struct object_id;
struct pack_entry;
struct repository;
struct bitmapped_pack;

#define MIDX_SIGNATURE 0x4d494458 /* "MIDX" */
#define MIDX_VERSION 1
#define MIDX_BYTE_FILE_VERSION 4
#define MIDX_BYTE_HASH_VERSION 5
#define MIDX_BYTE_NUM_CHUNKS 6
#define MIDX_BYTE_NUM_PACKS 8
#define MIDX_HEADER_SIZE 12

#define MIDX_CHUNK_ALIGNMENT 4
#define MIDX_CHUNKID_PACKNAMES 0x504e414d /* "PNAM" */
#define MIDX_CHUNKID_BITMAPPEDPACKS 0x42544d50 /* "BTMP" */
#define MIDX_CHUNKID_OIDFANOUT 0x4f494446 /* "OIDF" */
#define MIDX_CHUNKID_OIDLOOKUP 0x4f49444c /* "OIDL" */
#define MIDX_CHUNKID_OBJECTOFFSETS 0x4f4f4646 /* "OOFF" */
#define MIDX_CHUNKID_LARGEOFFSETS 0x4c4f4646 /* "LOFF" */
#define MIDX_CHUNKID_REVINDEX 0x52494458 /* "RIDX" */
#define MIDX_CHUNK_OFFSET_WIDTH (2 * sizeof(uint32_t))
#define MIDX_LARGE_OFFSET_NEEDED 0x80000000

#define GIT_TEST_MULTI_PACK_INDEX "GIT_TEST_MULTI_PACK_INDEX"
#define GIT_TEST_MULTI_PACK_INDEX_WRITE_BITMAP \
	"GIT_TEST_MULTI_PACK_INDEX_WRITE_BITMAP"

struct multi_pack_index {
	struct multi_pack_index *next;

	const unsigned char *data;
	size_t data_len;

	const uint32_t *revindex_data;
	const uint32_t *revindex_map;
	size_t revindex_len;

	uint32_t signature;
	unsigned char version;
	unsigned char hash_len;
	unsigned char num_chunks;
	uint32_t num_packs;
	uint32_t num_objects;
	int preferred_pack_idx;

	int local;

	const unsigned char *chunk_pack_names;
	size_t chunk_pack_names_len;
	const uint32_t *chunk_bitmapped_packs;
	size_t chunk_bitmapped_packs_len;
	const uint32_t *chunk_oid_fanout;
	const unsigned char *chunk_oid_lookup;
	const unsigned char *chunk_object_offsets;
	const unsigned char *chunk_large_offsets;
	size_t chunk_large_offsets_len;
	const unsigned char *chunk_revindex;
	size_t chunk_revindex_len;

	const char **pack_names;
	struct packed_git **packs;
	char object_dir[FLEX_ARRAY];
};

#define MIDX_PROGRESS     (1 << 0)
#define MIDX_WRITE_REV_INDEX (1 << 1)
#define MIDX_WRITE_BITMAP (1 << 2)
#define MIDX_WRITE_BITMAP_HASH_CACHE (1 << 3)
#define MIDX_WRITE_BITMAP_LOOKUP_TABLE (1 << 4)

const unsigned char *get_midx_checksum(struct multi_pack_index *m);
void get_midx_filename(struct strbuf *out, const char *object_dir);
void get_midx_rev_filename(struct strbuf *out, struct multi_pack_index *m);

struct multi_pack_index *load_multi_pack_index(const char *object_dir, int local);
int prepare_midx_pack(struct repository *r, struct multi_pack_index *m, uint32_t pack_int_id);
int nth_bitmapped_pack(struct repository *r, struct multi_pack_index *m,
		       struct bitmapped_pack *bp, uint32_t pack_int_id);
int bsearch_midx(const struct object_id *oid, struct multi_pack_index *m, uint32_t *result);
off_t nth_midxed_offset(struct multi_pack_index *m, uint32_t pos);
uint32_t nth_midxed_pack_int_id(struct multi_pack_index *m, uint32_t pos);
struct object_id *nth_midxed_object_oid(struct object_id *oid,
					struct multi_pack_index *m,
					uint32_t n);
int fill_midx_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e, struct multi_pack_index *m);
int midx_contains_pack(struct multi_pack_index *m,
		       const char *idx_or_pack_name);
int midx_locate_pack(struct multi_pack_index *m, const char *idx_or_pack_name,
		     uint32_t *pos);
int midx_preferred_pack(struct multi_pack_index *m, uint32_t *pack_int_id);
int prepare_multi_pack_index_one(struct repository *r, const char *object_dir, int local);

/*
 * Variant of write_midx_file which writes a MIDX containing only the packs
 * specified in packs_to_include.
 */
int write_midx_file(const char *object_dir,
		    const char *preferred_pack_name,
		    const char *refs_snapshot,
		    unsigned flags);
int write_midx_file_only(const char *object_dir,
			 struct string_list *packs_to_include,
			 const char *preferred_pack_name,
			 const char *refs_snapshot,
			 unsigned flags);
void clear_midx_file(struct repository *r);
int verify_midx_file(struct repository *r, const char *object_dir, unsigned flags);
int expire_midx_packs(struct repository *r, const char *object_dir, unsigned flags);
int midx_repack(struct repository *r, const char *object_dir, size_t batch_size, unsigned flags);

void close_midx(struct multi_pack_index *m);

#endif
Commit	Line	Data
0009d350 RJ	1	#ifndef MIDX_H
0009d350 RJ	2	#define MIDX_H
a3407730	3
56d863e9	4	#include "string-list.h"
c4d25228	5
642e5703 RJ	6	struct object_id;
642e5703 RJ	7	struct pack_entry;
64404a24	8	struct repository;
5f5ccd95	9	struct bitmapped_pack;
642e5703	10
748b88a0 TB	11	#define MIDX_SIGNATURE 0x4d494458 /* "MIDX" */
	12	#define MIDX_VERSION 1
	13	#define MIDX_BYTE_FILE_VERSION 4
	14	#define MIDX_BYTE_HASH_VERSION 5
	15	#define MIDX_BYTE_NUM_CHUNKS 6
	16	#define MIDX_BYTE_NUM_PACKS 8
	17	#define MIDX_HEADER_SIZE 12
	18
	19	#define MIDX_CHUNK_ALIGNMENT 4
	20	#define MIDX_CHUNKID_PACKNAMES 0x504e414d /* "PNAM" */
	21	#define MIDX_CHUNKID_BITMAPPEDPACKS 0x42544d50 /* "BTMP" */
	22	#define MIDX_CHUNKID_OIDFANOUT 0x4f494446 /* "OIDF" */
	23	#define MIDX_CHUNKID_OIDLOOKUP 0x4f49444c /* "OIDL" */
	24	#define MIDX_CHUNKID_OBJECTOFFSETS 0x4f4f4646 /* "OOFF" */
	25	#define MIDX_CHUNKID_LARGEOFFSETS 0x4c4f4646 /* "LOFF" */
	26	#define MIDX_CHUNKID_REVINDEX 0x52494458 /* "RIDX" */
	27	#define MIDX_CHUNK_OFFSET_WIDTH (2 * sizeof(uint32_t))
	28	#define MIDX_LARGE_OFFSET_NEEDED 0x80000000
	29
0465a505	30	#define GIT_TEST_MULTI_PACK_INDEX "GIT_TEST_MULTI_PACK_INDEX"
ff1e653c TB	31	#define GIT_TEST_MULTI_PACK_INDEX_WRITE_BITMAP \
ff1e653c TB	32	"GIT_TEST_MULTI_PACK_INDEX_WRITE_BITMAP"
0465a505	33
4d80560c	34	struct multi_pack_index {
c4d25228 DS	35	struct multi_pack_index *next;
c4d25228 DS	36
4d80560c DS	37	const unsigned char *data;
	38	size_t data_len;
	39
f894081d TB	40	const uint32_t *revindex_data;
	41	const uint32_t *revindex_map;
	42	size_t revindex_len;
	43
4d80560c DS	44	uint32_t signature;
	45	unsigned char version;
	46	unsigned char hash_len;
	47	unsigned char num_chunks;
	48	uint32_t num_packs;
	49	uint32_t num_objects;
b1e33330	50	int preferred_pack_idx;
4d80560c	51
2cf489a3 DS	52	int local;
2cf489a3 DS	53
32f3c541	54	const unsigned char *chunk_pack_names;
72a9a082	55	size_t chunk_pack_names_len;
5f5ccd95 TB	56	const uint32_t *chunk_bitmapped_packs;
5f5ccd95 TB	57	size_t chunk_bitmapped_packs_len;
d7cacf29	58	const uint32_t *chunk_oid_fanout;
0d5b3a5e	59	const unsigned char *chunk_oid_lookup;
662148c4 DS	60	const unsigned char *chunk_object_offsets;
662148c4 DS	61	const unsigned char *chunk_large_offsets;
2abd56e9	62	size_t chunk_large_offsets_len;
7f514b7a	63	const unsigned char *chunk_revindex;
c0fe9b2d	64	size_t chunk_revindex_len;
32f3c541	65
3227565c	66	const char **pack_names;
3715a633	67	struct packed_git **packs;
4d80560c DS	68	char object_dir[FLEX_ARRAY];
	69	};
	70
efbc3aee	71	#define MIDX_PROGRESS (1 << 0)
38ff7cab	72	#define MIDX_WRITE_REV_INDEX (1 << 1)
c528e179	73	#define MIDX_WRITE_BITMAP (1 << 2)
caca3c9f	74	#define MIDX_WRITE_BITMAP_HASH_CACHE (1 << 3)
76f14b77	75	#define MIDX_WRITE_BITMAP_LOOKUP_TABLE (1 << 4)
efbc3aee	76
0f533c72	77	const unsigned char get_midx_checksum(struct multi_pack_index m);
60980aed TB	78	void get_midx_filename(struct strbuf out, const char object_dir);
60980aed TB	79	void get_midx_rev_filename(struct strbuf out, struct multi_pack_index m);
f894081d	80
2cf489a3	81	struct multi_pack_index load_multi_pack_index(const char object_dir, int local);
64404a24	82	int prepare_midx_pack(struct repository r, struct multi_pack_index m, uint32_t pack_int_id);
5f5ccd95 TB	83	int nth_bitmapped_pack(struct repository r, struct multi_pack_index m,
5f5ccd95 TB	84	struct bitmapped_pack *bp, uint32_t pack_int_id);
3715a633	85	int bsearch_midx(const struct object_id oid, struct multi_pack_index m, uint32_t *result);
62f2c1b5 TB	86	off_t nth_midxed_offset(struct multi_pack_index *m, uint32_t pos);
62f2c1b5 TB	87	uint32_t nth_midxed_pack_int_id(struct multi_pack_index *m, uint32_t pos);
8aac67a1 DS	88	struct object_id nth_midxed_object_oid(struct object_id oid,
	89	struct multi_pack_index *m,
	90	uint32_t n);
64404a24	91	int fill_midx_entry(struct repository r, const struct object_id oid, struct pack_entry e, struct multi_pack_index m);
307d75bb TB	92	int midx_contains_pack(struct multi_pack_index *m,
	93	const char *idx_or_pack_name);
	94	int midx_locate_pack(struct multi_pack_index m, const char idx_or_pack_name,
	95	uint32_t *pos);
b1e33330	96	int midx_preferred_pack(struct multi_pack_index m, uint32_t pack_int_id);
2cf489a3	97	int prepare_multi_pack_index_one(struct repository r, const char object_dir, int local);
4d80560c	98
56d863e9 TB	99	/*
	100	* Variant of write_midx_file which writes a MIDX containing only the packs
	101	* specified in packs_to_include.
	102	*/
08944d1c TB	103	int write_midx_file(const char *object_dir,
	104	const char *preferred_pack_name,
	105	const char *refs_snapshot,
	106	unsigned flags);
56d863e9 TB	107	int write_midx_file_only(const char *object_dir,
	108	struct string_list *packs_to_include,
	109	const char *preferred_pack_name,
08944d1c	110	const char *refs_snapshot,
56d863e9	111	unsigned flags);
1dcd9f20	112	void clear_midx_file(struct repository *r);
efbc3aee WB	113	int verify_midx_file(struct repository r, const char object_dir, unsigned flags);
	114	int expire_midx_packs(struct repository r, const char object_dir, unsigned flags);
	115	int midx_repack(struct repository r, const char object_dir, size_t batch_size, unsigned flags);
a3407730	116
1dcd9f20	117	void close_midx(struct multi_pack_index *m);
a3407730 DS	118
a3407730 DS	119	#endif