midx.h

   1 #ifndef MIDX_H
   2 #define MIDX_H
   3
   4 #include "string-list.h"
   5
   6 struct object_id;
   7 struct pack_entry;
   8 struct repository;
   9 struct bitmapped_pack;
  10 struct git_hash_algo;
  11
  12 #define MIDX_SIGNATURE 0x4d494458 /* "MIDX" */
  13 #define MIDX_VERSION 1
  14 #define MIDX_BYTE_FILE_VERSION 4
  15 #define MIDX_BYTE_HASH_VERSION 5
  16 #define MIDX_BYTE_NUM_CHUNKS 6
  17 #define MIDX_BYTE_NUM_PACKS 8
  18 #define MIDX_HEADER_SIZE 12
  19
  20 #define MIDX_CHUNK_ALIGNMENT 4
  21 #define MIDX_CHUNKID_PACKNAMES 0x504e414d /* "PNAM" */
  22 #define MIDX_CHUNKID_BITMAPPEDPACKS 0x42544d50 /* "BTMP" */
  23 #define MIDX_CHUNKID_OIDFANOUT 0x4f494446 /* "OIDF" */
  24 #define MIDX_CHUNKID_OIDLOOKUP 0x4f49444c /* "OIDL" */
  25 #define MIDX_CHUNKID_OBJECTOFFSETS 0x4f4f4646 /* "OOFF" */
  26 #define MIDX_CHUNKID_LARGEOFFSETS 0x4c4f4646 /* "LOFF" */
  27 #define MIDX_CHUNKID_REVINDEX 0x52494458 /* "RIDX" */
  28 #define MIDX_CHUNKID_BASE 0x42415345 /* "BASE" */
  29 #define MIDX_CHUNK_OFFSET_WIDTH (2 * sizeof(uint32_t))
  30 #define MIDX_LARGE_OFFSET_NEEDED 0x80000000
  31
  32 #define GIT_TEST_MULTI_PACK_INDEX "GIT_TEST_MULTI_PACK_INDEX"
  33 #define GIT_TEST_MULTI_PACK_INDEX_WRITE_INCREMENTAL \
  34         "GIT_TEST_MULTI_PACK_INDEX_WRITE_INCREMENTAL"
  35
  36 struct multi_pack_index {
  37         struct multi_pack_index *next;
  38
  39         const unsigned char *data;
  40         size_t data_len;
  41
  42         const uint32_t *revindex_data;
  43         const uint32_t *revindex_map;
  44         size_t revindex_len;
  45
  46         uint32_t signature;
  47         unsigned char version;
  48         unsigned char hash_len;
  49         unsigned char num_chunks;
  50         uint32_t num_packs;
  51         uint32_t num_objects;
  52         int preferred_pack_idx;
  53
  54         int local;
  55         int has_chain;
  56
  57         const unsigned char *chunk_pack_names;
  58         size_t chunk_pack_names_len;
  59         const uint32_t *chunk_bitmapped_packs;
  60         size_t chunk_bitmapped_packs_len;
  61         const uint32_t *chunk_oid_fanout;
  62         const unsigned char *chunk_oid_lookup;
  63         const unsigned char *chunk_object_offsets;
  64         const unsigned char *chunk_large_offsets;
  65         size_t chunk_large_offsets_len;
  66         const unsigned char *chunk_revindex;
  67         size_t chunk_revindex_len;
  68
  69         struct multi_pack_index *base_midx;
  70         uint32_t num_objects_in_base;
  71         uint32_t num_packs_in_base;
  72
  73         const char **pack_names;
  74         struct packed_git **packs;
  75
  76         struct repository *repo;
  77
  78         char object_dir[FLEX_ARRAY];
  79 };
  80
  81 #define MIDX_PROGRESS     (1 << 0)
  82 #define MIDX_WRITE_REV_INDEX (1 << 1)
  83 #define MIDX_WRITE_BITMAP (1 << 2)
  84 #define MIDX_WRITE_BITMAP_HASH_CACHE (1 << 3)
  85 #define MIDX_WRITE_BITMAP_LOOKUP_TABLE (1 << 4)
  86 #define MIDX_WRITE_INCREMENTAL (1 << 5)
  87
  88 #define MIDX_EXT_REV "rev"
  89 #define MIDX_EXT_BITMAP "bitmap"
  90 #define MIDX_EXT_MIDX "midx"
  91
  92 const unsigned char *get_midx_checksum(struct multi_pack_index *m);
  93 void get_midx_filename(const struct git_hash_algo *hash_algo,
  94                        struct strbuf *out, const char *object_dir);
  95 void get_midx_filename_ext(const struct git_hash_algo *hash_algo,
  96                            struct strbuf *out, const char *object_dir,
  97                            const unsigned char *hash, const char *ext);
  98 void get_midx_chain_dirname(struct strbuf *buf, const char *object_dir);
  99 void get_midx_chain_filename(struct strbuf *buf, const char *object_dir);
 100 void get_split_midx_filename_ext(const struct git_hash_algo *hash_algo,
 101                                  struct strbuf *buf, const char *object_dir,
 102                                  const unsigned char *hash, const char *ext);
 103
 104 struct multi_pack_index *load_multi_pack_index(struct repository *r,
 105                                                const char *object_dir,
 106                                                int local);
 107 int prepare_midx_pack(struct repository *r, struct multi_pack_index *m, uint32_t pack_int_id);
 108 struct packed_git *nth_midxed_pack(struct multi_pack_index *m,
 109                                    uint32_t pack_int_id);
 110 int nth_bitmapped_pack(struct repository *r, struct multi_pack_index *m,
 111                        struct bitmapped_pack *bp, uint32_t pack_int_id);
 112 int bsearch_one_midx(const struct object_id *oid, struct multi_pack_index *m,
 113                      uint32_t *result);
 114 int bsearch_midx(const struct object_id *oid, struct multi_pack_index *m,
 115                  uint32_t *result);
 116 int midx_has_oid(struct multi_pack_index *m, const struct object_id *oid);
 117 off_t nth_midxed_offset(struct multi_pack_index *m, uint32_t pos);
 118 uint32_t nth_midxed_pack_int_id(struct multi_pack_index *m, uint32_t pos);
 119 struct object_id *nth_midxed_object_oid(struct object_id *oid,
 120                                         struct multi_pack_index *m,
 121                                         uint32_t n);
 122 int fill_midx_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e, struct multi_pack_index *m);
 123 int midx_contains_pack(struct multi_pack_index *m,
 124                        const char *idx_or_pack_name);
 125 int midx_preferred_pack(struct multi_pack_index *m, uint32_t *pack_int_id);
 126 int prepare_multi_pack_index_one(struct repository *r, const char *object_dir, int local);
 127
 128 /*
 129  * Variant of write_midx_file which writes a MIDX containing only the packs
 130  * specified in packs_to_include.
 131  */
 132 int write_midx_file(struct repository *r, const char *object_dir,
 133                     const char *preferred_pack_name, const char *refs_snapshot,
 134                     unsigned flags);
 135 int write_midx_file_only(struct repository *r, const char *object_dir,
 136                          struct string_list *packs_to_include,
 137                          const char *preferred_pack_name,
 138                          const char *refs_snapshot, unsigned flags);
 139 void clear_midx_file(struct repository *r);
 140 int verify_midx_file(struct repository *r, const char *object_dir, unsigned flags);
 141 int expire_midx_packs(struct repository *r, const char *object_dir, unsigned flags);
 142 int midx_repack(struct repository *r, const char *object_dir, size_t batch_size, unsigned flags);
 143
 144 void close_midx(struct multi_pack_index *m);
 145
 146 #endif