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