]>
Commit | Line | Data |
---|---|---|
08fd81c9 DS |
1 | #ifndef COMMIT_GRAPH_H |
2 | #define COMMIT_GRAPH_H | |
3 | ||
a034e910 | 4 | #include "object-store-ll.h" |
6830c360 | 5 | #include "oidset.h" |
2a2e32bd | 6 | |
859fdc0c | 7 | #define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH" |
7b671f8c | 8 | #define GIT_TEST_COMMIT_GRAPH_DIE_ON_PARSE "GIT_TEST_COMMIT_GRAPH_DIE_ON_PARSE" |
d5b873c8 | 9 | #define GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS "GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS" |
859fdc0c | 10 | |
b23ea979 DS |
11 | /* |
12 | * This method is only used to enhance coverage of the commit-graph | |
13 | * feature in the test suite with the GIT_TEST_COMMIT_GRAPH and | |
14 | * GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS environment variables. Do not | |
15 | * call this method oustide of a builtin, and only if you know what | |
16 | * you are doing! | |
17 | */ | |
18 | void git_test_write_commit_graph_or_die(void); | |
19 | ||
e5c5ca27 | 20 | struct commit; |
76ffbca7 | 21 | struct bloom_filter_settings; |
fa796530 SG |
22 | struct repository; |
23 | struct raw_object_store; | |
24 | struct string_list; | |
e5c5ca27 | 25 | |
ad2dd5bb | 26 | char *get_commit_graph_filename(struct object_directory *odb); |
663b2b1b | 27 | char *get_commit_graph_chain_filename(struct object_directory *odb); |
61df89c8 | 28 | int open_commit_graph(const char *graph_file, int *fd, struct stat *st); |
7ed76b4e | 29 | int open_commit_graph_chain(const char *chain_file, int *fd, struct stat *st); |
2a2e32bd | 30 | |
177722b3 DS |
31 | /* |
32 | * Given a commit struct, try to fill the commit struct info, including: | |
33 | * 1. tree object | |
34 | * 2. date | |
35 | * 3. parents. | |
36 | * | |
37 | * Returns 1 if and only if the commit was found in the packed graph. | |
38 | * | |
39 | * See parse_commit_buffer() for the fallback after this call. | |
40 | */ | |
dade47c0 | 41 | int parse_commit_in_graph(struct repository *r, struct commit *item); |
177722b3 | 42 | |
7805360b TB |
43 | /* |
44 | * Fills `*pos` with the graph position of `c`, and returns 1 if `c` is | |
45 | * found in the commit-graph belonging to `r`, or 0 otherwise. | |
46 | * Initializes the commit-graph belonging to `r` if it hasn't been | |
47 | * already. | |
48 | * | |
49 | * Note: this is a low-level helper that does not alter any slab data | |
50 | * associated with `c`. Useful in circumstances where the slab data is | |
51 | * already being modified (e.g., writing the commit-graph itself). | |
52 | * | |
53 | * In most cases, callers should use `parse_commit_in_graph()` instead. | |
54 | */ | |
55 | int repo_find_commit_pos_in_graph(struct repository *r, struct commit *c, | |
56 | uint32_t *pos); | |
57 | ||
f559d6d4 PS |
58 | /* |
59 | * Look up the given commit ID in the commit-graph. This will only return a | |
60 | * commit if the ID exists both in the graph and in the object database such | |
61 | * that we don't return commits whose object has been pruned. Otherwise, this | |
62 | * function returns `NULL`. | |
63 | */ | |
64 | struct commit *lookup_commit_in_graph(struct repository *repo, const struct object_id *id); | |
65 | ||
e2838d85 DS |
66 | /* |
67 | * It is possible that we loaded commit contents from the commit buffer, | |
68 | * but we also want to ensure the commit-graph content is correctly | |
69 | * checked and filled. Fill the graph_pos and generation members of | |
70 | * the given commit. | |
71 | */ | |
dade47c0 | 72 | void load_commit_graph_info(struct repository *r, struct commit *item); |
e2838d85 | 73 | |
dade47c0 JT |
74 | struct tree *get_commit_tree_in_graph(struct repository *r, |
75 | const struct commit *c); | |
7b8a21db | 76 | |
2a2e32bd | 77 | struct commit_graph { |
2a2e32bd DS |
78 | const unsigned char *data; |
79 | size_t data_len; | |
80 | ||
81 | unsigned char hash_len; | |
82 | unsigned char num_chunks; | |
83 | uint32_t num_commits; | |
84 | struct object_id oid; | |
6c622f9f | 85 | char *filename; |
13c24992 | 86 | struct object_directory *odb; |
2a2e32bd | 87 | |
d4f4d60f | 88 | uint32_t num_commits_in_base; |
1fdc383c | 89 | unsigned int read_generation_data; |
d4f4d60f DS |
90 | struct commit_graph *base_graph; |
91 | ||
2a2e32bd DS |
92 | const uint32_t *chunk_oid_fanout; |
93 | const unsigned char *chunk_oid_lookup; | |
94 | const unsigned char *chunk_commit_data; | |
e8b63005 AK |
95 | const unsigned char *chunk_generation_data; |
96 | const unsigned char *chunk_generation_data_overflow; | |
ee6a7924 | 97 | size_t chunk_generation_data_overflow_size; |
5af7417b | 98 | const unsigned char *chunk_extra_edges; |
9622610e | 99 | size_t chunk_extra_edges_size; |
118bd570 | 100 | const unsigned char *chunk_base_graphs; |
6cf61d0d | 101 | size_t chunk_base_graphs_size; |
76ffbca7 GS |
102 | const unsigned char *chunk_bloom_indexes; |
103 | const unsigned char *chunk_bloom_data; | |
104 | ||
72a2bfca | 105 | struct topo_level_slab *topo_levels; |
76ffbca7 | 106 | struct bloom_filter_settings *bloom_filter_settings; |
2a2e32bd DS |
107 | }; |
108 | ||
ab14d067 TB |
109 | struct commit_graph *load_commit_graph_one_fd_st(struct repository *r, |
110 | int fd, struct stat *st, | |
a7df60ca | 111 | struct object_directory *odb); |
7ed76b4e | 112 | struct commit_graph *load_commit_graph_chain_fd_st(struct repository *r, |
5f259197 JK |
113 | int fd, struct stat *st, |
114 | int *incomplete_chain); | |
13c24992 TB |
115 | struct commit_graph *read_commit_graph_one(struct repository *r, |
116 | struct object_directory *odb); | |
a92d8523 TB |
117 | |
118 | /* | |
119 | * Callers should initialize the repo_settings with prepare_repo_settings() | |
120 | * prior to calling parse_commit_graph(). | |
121 | */ | |
122 | struct commit_graph *parse_commit_graph(struct repo_settings *s, | |
ab14d067 | 123 | void *graph_map, size_t graph_size); |
aa658574 | 124 | |
6cc01743 DS |
125 | /* |
126 | * Return 1 if and only if the repository has a commit-graph | |
127 | * file and generation numbers are computed in that file. | |
128 | */ | |
129 | int generation_numbers_enabled(struct repository *r); | |
130 | ||
8d00d7c3 AK |
131 | /* |
132 | * Return 1 if and only if the repository has a commit-graph | |
133 | * file and generation data chunk has been written for the file. | |
134 | */ | |
135 | int corrected_commit_dates_enabled(struct repository *r); | |
136 | ||
4f364405 TB |
137 | struct bloom_filter_settings *get_bloom_filter_settings(struct repository *r); |
138 | ||
39d88318 SG |
139 | enum commit_graph_write_flags { |
140 | COMMIT_GRAPH_WRITE_APPEND = (1 << 0), | |
141 | COMMIT_GRAPH_WRITE_PROGRESS = (1 << 1), | |
7c5c9b9c | 142 | COMMIT_GRAPH_WRITE_SPLIT = (1 << 2), |
2f00c355 | 143 | COMMIT_GRAPH_WRITE_BLOOM_FILTERS = (1 << 3), |
70cdbbe3 | 144 | COMMIT_GRAPH_NO_WRITE_BLOOM_FILTERS = (1 << 4), |
39d88318 | 145 | }; |
5af80394 | 146 | |
4f027355 | 147 | enum commit_graph_split_flags { |
fdbde82f | 148 | COMMIT_GRAPH_SPLIT_UNSPECIFIED = 0, |
8a6ac287 TB |
149 | COMMIT_GRAPH_SPLIT_MERGE_PROHIBITED = 1, |
150 | COMMIT_GRAPH_SPLIT_REPLACE = 2 | |
4f027355 TB |
151 | }; |
152 | ||
98bb7961 | 153 | struct commit_graph_opts { |
c2bc6e6a DS |
154 | int size_multiple; |
155 | int max_commits; | |
156 | timestamp_t expire_time; | |
98bb7961 | 157 | enum commit_graph_split_flags split_flags; |
809e0327 | 158 | int max_new_filters; |
c2bc6e6a DS |
159 | }; |
160 | ||
e103f727 DS |
161 | /* |
162 | * The write_commit_graph* methods return zero on success | |
163 | * and a negative value on failure. Note that if the repository | |
164 | * is not compatible with the commit-graph feature, then the | |
165 | * methods will return 0 without writing a commit-graph. | |
166 | */ | |
0bd52e27 | 167 | int write_commit_graph_reachable(struct object_directory *odb, |
39d88318 | 168 | enum commit_graph_write_flags flags, |
98bb7961 | 169 | const struct commit_graph_opts *opts); |
0bd52e27 | 170 | int write_commit_graph(struct object_directory *odb, |
4a047908 | 171 | const struct string_list *pack_indexes, |
6830c360 | 172 | struct oidset *commits, |
39d88318 | 173 | enum commit_graph_write_flags flags, |
98bb7961 | 174 | const struct commit_graph_opts *opts); |
08fd81c9 | 175 | |
3da4b609 DS |
176 | #define COMMIT_GRAPH_VERIFY_SHALLOW (1 << 0) |
177 | ||
178 | int verify_commit_graph(struct repository *r, struct commit_graph *g, int flags); | |
283e68c7 | 179 | |
c3a3a964 | 180 | void close_commit_graph(struct raw_object_store *); |
c3756d5b JT |
181 | void free_commit_graph(struct commit_graph *); |
182 | ||
6abada18 JK |
183 | /* |
184 | * Disable further use of the commit graph in this process when parsing a | |
185 | * "struct commit". | |
186 | */ | |
187 | void disable_commit_graph(struct repository *r); | |
188 | ||
4844812b AK |
189 | struct commit_graph_data { |
190 | uint32_t graph_pos; | |
d7f92784 | 191 | timestamp_t generation; |
4844812b AK |
192 | }; |
193 | ||
194 | /* | |
195 | * Commits should be parsed before accessing generation, graph positions. | |
196 | */ | |
d7f92784 | 197 | timestamp_t commit_graph_generation(const struct commit *); |
4844812b | 198 | uint32_t commit_graph_position(const struct commit *); |
c08645b3 TB |
199 | |
200 | /* | |
201 | * After this method, all commits reachable from those in the given | |
202 | * list will have non-zero, non-infinite generation numbers. | |
203 | */ | |
204 | void ensure_generations_valid(struct repository *r, | |
205 | struct commit **commits, size_t nr); | |
206 | ||
08fd81c9 | 207 | #endif |