worktree: teach `list` to annotate prunable worktree
[git] / 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
9 struct commit;
10 struct repository;
11 struct rev_info;
12 struct list_objects_filter_options;
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 enum pack_bitmap_opts {
27         BITMAP_OPT_FULL_DAG = 1,
28         BITMAP_OPT_HASH_CACHE = 4,
29 };
30
31 enum pack_bitmap_flags {
32         BITMAP_FLAG_REUSE = 0x1
33 };
34
35 typedef int (*show_reachable_fn)(
36         const struct object_id *oid,
37         enum object_type type,
38         int flags,
39         uint32_t hash,
40         struct packed_git *found_pack,
41         off_t found_offset);
42
43 struct bitmap_index;
44
45 struct bitmap_index *prepare_bitmap_git(struct repository *r);
46 void count_bitmap_commit_list(struct bitmap_index *, uint32_t *commits,
47                               uint32_t *trees, uint32_t *blobs, uint32_t *tags);
48 void traverse_bitmap_commit_list(struct bitmap_index *,
49                                  struct rev_info *revs,
50                                  show_reachable_fn show_reachable);
51 void test_bitmap_walk(struct rev_info *revs);
52 struct bitmap_index *prepare_bitmap_walk(struct rev_info *revs,
53                                          struct list_objects_filter_options *filter);
54 int reuse_partial_packfile_from_bitmap(struct bitmap_index *,
55                                        struct packed_git **packfile,
56                                        uint32_t *entries,
57                                        struct bitmap **reuse_out);
58 int rebuild_existing_bitmaps(struct bitmap_index *, struct packing_data *mapping,
59                              kh_oid_map_t *reused_bitmaps, int show_progress);
60 void free_bitmap_index(struct bitmap_index *);
61 int bitmap_walk_contains(struct bitmap_index *,
62                          struct bitmap *bitmap, const struct object_id *oid);
63
64 /*
65  * After a traversal has been performed by prepare_bitmap_walk(), this can be
66  * queried to see if a particular object was reachable from any of the
67  * objects flagged as UNINTERESTING.
68  */
69 int bitmap_has_oid_in_uninteresting(struct bitmap_index *, const struct object_id *oid);
70
71 void bitmap_writer_show_progress(int show);
72 void bitmap_writer_set_checksum(unsigned char *sha1);
73 void bitmap_writer_build_type_index(struct packing_data *to_pack,
74                                     struct pack_idx_entry **index,
75                                     uint32_t index_nr);
76 uint32_t *create_bitmap_mapping(struct bitmap_index *bitmap_git,
77                                 struct packing_data *mapping);
78 int rebuild_bitmap(const uint32_t *reposition,
79                    struct ewah_bitmap *source,
80                    struct bitmap *dest);
81 struct ewah_bitmap *bitmap_for_commit(struct bitmap_index *bitmap_git,
82                                       struct commit *commit);
83 void bitmap_writer_select_commits(struct commit **indexed_commits,
84                 unsigned int indexed_commits_nr, int max_bitmaps);
85 void bitmap_writer_build(struct packing_data *to_pack);
86 void bitmap_writer_finish(struct pack_idx_entry **index,
87                           uint32_t index_nr,
88                           const char *filename,
89                           uint16_t options);
90
91 #endif