freshlybakedca.ke
Git fork
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
10struct commit;
11struct repository;
12struct rev_info;
13
14static const char BITMAP_IDX_SIGNATURE[] = {'B', 'I', 'T', 'M'};
15
16struct 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 BITMAP_PSEUDO_MERGE (1u<<21)
25#define NEEDS_BITMAP (1u<<22)
26
27/*
28 * The width in bytes of a single triplet in the lookup table
29 * extension:
30 * (commit_pos, offset, xor_row)
31 *
32 * whose fields ar 32-, 64-, 32- bits wide, respectively.
33 */
34#define BITMAP_LOOKUP_TABLE_TRIPLET_WIDTH (16)
35
36enum pack_bitmap_opts {
37 BITMAP_OPT_FULL_DAG = 0x1,
38 BITMAP_OPT_HASH_CACHE = 0x4,
39 BITMAP_OPT_LOOKUP_TABLE = 0x10,
40 BITMAP_OPT_PSEUDO_MERGES = 0x20,
41};
42
43enum pack_bitmap_flags {
44 BITMAP_FLAG_REUSE = 0x1
45};
46
47typedef int (*show_reachable_fn)(
48 const struct object_id *oid,
49 enum object_type type,
50 int flags,
51 uint32_t hash,
52 struct packed_git *found_pack,
53 off_t found_offset,
54 void *payload);
55
56struct bitmap_index;
57
58struct bitmapped_pack {
59 struct packed_git *p;
60
61 uint32_t bitmap_pos;
62 uint32_t bitmap_nr;
63
64 struct multi_pack_index *from_midx; /* MIDX only */
65 uint32_t pack_int_id; /* MIDX only */
66};
67
68struct bitmap_index *prepare_bitmap_git(struct repository *r);
69struct bitmap_index *prepare_midx_bitmap_git(struct multi_pack_index *midx);
70
71/*
72 * Given a bitmap index, determine whether it contains the pack either directly
73 * or via the multi-pack-index.
74 */
75int bitmap_index_contains_pack(struct bitmap_index *bitmap, struct packed_git *pack);
76
77void count_bitmap_commit_list(struct bitmap_index *, uint32_t *commits,
78 uint32_t *trees, uint32_t *blobs, uint32_t *tags);
79void traverse_bitmap_commit_list(struct bitmap_index *,
80 struct rev_info *revs,
81 show_reachable_fn show_reachable);
82void test_bitmap_walk(struct rev_info *revs);
83int test_bitmap_commits(struct repository *r);
84int test_bitmap_commits_with_offset(struct repository *r);
85int test_bitmap_hashes(struct repository *r);
86int test_bitmap_pseudo_merges(struct repository *r);
87int test_bitmap_pseudo_merge_commits(struct repository *r, uint32_t n);
88int test_bitmap_pseudo_merge_objects(struct repository *r, uint32_t n);
89
90struct list_objects_filter_options;
91
92/*
93 * Filter bitmapped objects and iterate through all resulting objects,
94 * executing `show_reach` for each of them. Returns `-1` in case the filter is
95 * not supported, `0` otherwise.
96 */
97int for_each_bitmapped_object(struct bitmap_index *bitmap_git,
98 struct list_objects_filter_options *filter,
99 show_reachable_fn show_reach,
100 void *payload);
101
102#define GIT_TEST_PACK_USE_BITMAP_BOUNDARY_TRAVERSAL \
103 "GIT_TEST_PACK_USE_BITMAP_BOUNDARY_TRAVERSAL"
104
105struct bitmap_index *prepare_bitmap_walk(struct rev_info *revs,
106 int filter_provided_objects);
107void reuse_partial_packfile_from_bitmap(struct bitmap_index *bitmap_git,
108 struct bitmapped_pack **packs_out,
109 size_t *packs_nr_out,
110 struct bitmap **reuse_out,
111 int multi_pack_reuse);
112int rebuild_existing_bitmaps(struct bitmap_index *, struct packing_data *mapping,
113 kh_oid_map_t *reused_bitmaps, int show_progress);
114void free_bitmap_index(struct bitmap_index *);
115int bitmap_walk_contains(struct bitmap_index *,
116 struct bitmap *bitmap, const struct object_id *oid);
117
118/*
119 * After a traversal has been performed by prepare_bitmap_walk(), this can be
120 * queried to see if a particular object was reachable from any of the
121 * objects flagged as UNINTERESTING.
122 */
123int bitmap_has_oid_in_uninteresting(struct bitmap_index *, const struct object_id *oid);
124
125off_t get_disk_usage_from_bitmap(struct bitmap_index *, struct rev_info *);
126
127struct bitmap_writer {
128 struct repository *repo;
129 struct ewah_bitmap *commits;
130 struct ewah_bitmap *trees;
131 struct ewah_bitmap *blobs;
132 struct ewah_bitmap *tags;
133
134 kh_oid_map_t *bitmaps;
135 struct packing_data *to_pack;
136 struct multi_pack_index *midx; /* if appending to a MIDX chain */
137
138 struct bitmapped_commit *selected;
139 unsigned int selected_nr, selected_alloc;
140
141 struct string_list pseudo_merge_groups;
142 kh_oid_map_t *pseudo_merge_commits; /* oid -> pseudo merge(s) */
143 uint32_t pseudo_merges_nr;
144
145 struct progress *progress;
146 int show_progress;
147 unsigned char pack_checksum[GIT_MAX_RAWSZ];
148};
149
150void bitmap_writer_init(struct bitmap_writer *writer, struct repository *r,
151 struct packing_data *pdata,
152 struct multi_pack_index *midx);
153void bitmap_writer_show_progress(struct bitmap_writer *writer, int show);
154void bitmap_writer_set_checksum(struct bitmap_writer *writer,
155 const unsigned char *sha1);
156void bitmap_writer_build_type_index(struct bitmap_writer *writer,
157 struct pack_idx_entry **index);
158int bitmap_writer_has_bitmapped_object_id(struct bitmap_writer *writer,
159 const struct object_id *oid);
160void bitmap_writer_push_commit(struct bitmap_writer *writer,
161 struct commit *commit, unsigned pseudo_merge);
162uint32_t *create_bitmap_mapping(struct bitmap_index *bitmap_git,
163 struct packing_data *mapping);
164int rebuild_bitmap(const uint32_t *reposition,
165 struct ewah_bitmap *source,
166 struct bitmap *dest);
167struct ewah_bitmap *bitmap_for_commit(struct bitmap_index *bitmap_git,
168 struct commit *commit);
169struct ewah_bitmap *pseudo_merge_bitmap_for_commit(struct bitmap_index *bitmap_git,
170 struct commit *commit);
171void bitmap_writer_select_commits(struct bitmap_writer *writer,
172 struct commit **indexed_commits,
173 unsigned int indexed_commits_nr);
174int bitmap_writer_build(struct bitmap_writer *writer);
175void bitmap_writer_finish(struct bitmap_writer *writer,
176 struct pack_idx_entry **index,
177 const char *filename,
178 uint16_t options);
179void bitmap_writer_free(struct bitmap_writer *writer);
180char *midx_bitmap_filename(struct multi_pack_index *midx);
181char *pack_bitmap_filename(struct packed_git *p);
182
183int bitmap_is_midx(struct bitmap_index *bitmap_git);
184
185const struct string_list *bitmap_preferred_tips(struct repository *r);
186int bitmap_is_preferred_refname(struct repository *r, const char *refname);
187
188int verify_bitmap_files(struct repository *r);
189
190struct ewah_bitmap *read_bitmap(const unsigned char *map,
191 size_t map_size, size_t *map_pos);
192#endif