pack-bitmap.h

   1 #ifndef PACK_BITMAP_H
   2 #define PACK_BITMAP_H
   3
   4 #include "ewah/ewok.h"
   5 #include "khash.h"
   6 #include "pack.h"
   7 #include "pack-objects.h"
   8 #include "string-list.h"
   9
  10 struct commit;
  11 struct repository;
  12 struct rev_info;
  13
  14 static const char BITMAP_IDX_SIGNATURE[] = {'B', 'I', 'T', 'M'};
  15
  16 struct bitmap_disk_header {
  17         char magic[ARRAY_SIZE(BITMAP_IDX_SIGNATURE)];
  18         uint16_t version;
  19         uint16_t options;
  20         uint32_t entry_count;
  21         unsigned char checksum[GIT_MAX_RAWSZ];
  22 };
  23
  24 #define NEEDS_BITMAP (1u<<22)
  25
  26 /*
  27  * The width in bytes of a single triplet in the lookup table
  28  * extension:
  29  *     (commit_pos, offset, xor_row)
  30  *
  31  * whose fields ar 32-, 64-, 32- bits wide, respectively.
  32  */
  33 #define BITMAP_LOOKUP_TABLE_TRIPLET_WIDTH (16)
  34
  35 enum pack_bitmap_opts {
  36         BITMAP_OPT_FULL_DAG = 0x1,
  37         BITMAP_OPT_HASH_CACHE = 0x4,
  38         BITMAP_OPT_LOOKUP_TABLE = 0x10,
  39 };
  40
  41 enum pack_bitmap_flags {
  42         BITMAP_FLAG_REUSE = 0x1
  43 };
  44
  45 typedef int (*show_reachable_fn)(
  46         const struct object_id *oid,
  47         enum object_type type,
  48         int flags,
  49         uint32_t hash,
  50         struct packed_git *found_pack,
  51         off_t found_offset);
  52
  53 struct bitmap_index;
  54
  55 struct bitmap_index *prepare_bitmap_git(struct repository *r);
  56 struct bitmap_index *prepare_midx_bitmap_git(struct multi_pack_index *midx);
  57 void count_bitmap_commit_list(struct bitmap_index *, uint32_t *commits,
  58                               uint32_t *trees, uint32_t *blobs, uint32_t *tags);
  59 void traverse_bitmap_commit_list(struct bitmap_index *,
  60                                  struct rev_info *revs,
  61                                  show_reachable_fn show_reachable);
  62 void test_bitmap_walk(struct rev_info *revs);
  63 int test_bitmap_commits(struct repository *r);
  64 int test_bitmap_hashes(struct repository *r);
  65
  66 #define GIT_TEST_PACK_USE_BITMAP_BOUNDARY_TRAVERSAL \
  67         "GIT_TEST_PACK_USE_BITMAP_BOUNDARY_TRAVERSAL"
  68
  69 struct bitmap_index *prepare_bitmap_walk(struct rev_info *revs,
  70                                          int filter_provided_objects);
  71 uint32_t midx_preferred_pack(struct bitmap_index *bitmap_git);
  72 int reuse_partial_packfile_from_bitmap(struct bitmap_index *,
  73                                        struct packed_git **packfile,
  74                                        uint32_t *entries,
  75                                        struct bitmap **reuse_out);
  76 int rebuild_existing_bitmaps(struct bitmap_index *, struct packing_data *mapping,
  77                              kh_oid_map_t *reused_bitmaps, int show_progress);
  78 void free_bitmap_index(struct bitmap_index *);
  79 int bitmap_walk_contains(struct bitmap_index *,
  80                          struct bitmap *bitmap, const struct object_id *oid);
  81
  82 /*
  83  * After a traversal has been performed by prepare_bitmap_walk(), this can be
  84  * queried to see if a particular object was reachable from any of the
  85  * objects flagged as UNINTERESTING.
  86  */
  87 int bitmap_has_oid_in_uninteresting(struct bitmap_index *, const struct object_id *oid);
  88
  89 off_t get_disk_usage_from_bitmap(struct bitmap_index *, struct rev_info *);
  90
  91 void bitmap_writer_show_progress(int show);
  92 void bitmap_writer_set_checksum(const unsigned char *sha1);
  93 void bitmap_writer_build_type_index(struct packing_data *to_pack,
  94                                     struct pack_idx_entry **index,
  95                                     uint32_t index_nr);
  96 uint32_t *create_bitmap_mapping(struct bitmap_index *bitmap_git,
  97                                 struct packing_data *mapping);
  98 int rebuild_bitmap(const uint32_t *reposition,
  99                    struct ewah_bitmap *source,
 100                    struct bitmap *dest);
 101 struct ewah_bitmap *bitmap_for_commit(struct bitmap_index *bitmap_git,
 102                                       struct commit *commit);
 103 void bitmap_writer_select_commits(struct commit **indexed_commits,
 104                 unsigned int indexed_commits_nr, int max_bitmaps);
 105 int bitmap_writer_build(struct packing_data *to_pack);
 106 void bitmap_writer_finish(struct pack_idx_entry **index,
 107                           uint32_t index_nr,
 108                           const char *filename,
 109                           uint16_t options);
 110 char *midx_bitmap_filename(struct multi_pack_index *midx);
 111 char *pack_bitmap_filename(struct packed_git *p);
 112
 113 int bitmap_is_midx(struct bitmap_index *bitmap_git);
 114
 115 const struct string_list *bitmap_preferred_tips(struct repository *r);
 116 int bitmap_is_preferred_refname(struct repository *r, const char *refname);
 117
 118 int verify_bitmap_files(struct repository *r);
 119
 120 #endif