Merge branch 'ds/test-multi-pack-index'
[git] / commit-graph.h
1 #ifndef COMMIT_GRAPH_H
2 #define COMMIT_GRAPH_H
3
4 #include "git-compat-util.h"
5 #include "repository.h"
6 #include "string-list.h"
7 #include "cache.h"
8
9 #define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH"
10
11 struct commit;
12
13 char *get_commit_graph_filename(const char *obj_dir);
14
15 /*
16  * Given a commit struct, try to fill the commit struct info, including:
17  *  1. tree object
18  *  2. date
19  *  3. parents.
20  *
21  * Returns 1 if and only if the commit was found in the packed graph.
22  *
23  * See parse_commit_buffer() for the fallback after this call.
24  */
25 int parse_commit_in_graph(struct repository *r, struct commit *item);
26
27 /*
28  * It is possible that we loaded commit contents from the commit buffer,
29  * but we also want to ensure the commit-graph content is correctly
30  * checked and filled. Fill the graph_pos and generation members of
31  * the given commit.
32  */
33 void load_commit_graph_info(struct repository *r, struct commit *item);
34
35 struct tree *get_commit_tree_in_graph(struct repository *r,
36                                       const struct commit *c);
37
38 struct commit_graph {
39         int graph_fd;
40
41         const unsigned char *data;
42         size_t data_len;
43
44         unsigned char hash_len;
45         unsigned char num_chunks;
46         uint32_t num_commits;
47         struct object_id oid;
48
49         const uint32_t *chunk_oid_fanout;
50         const unsigned char *chunk_oid_lookup;
51         const unsigned char *chunk_commit_data;
52         const unsigned char *chunk_large_edges;
53 };
54
55 struct commit_graph *load_commit_graph_one(const char *graph_file);
56
57 /*
58  * Return 1 if and only if the repository has a commit-graph
59  * file and generation numbers are computed in that file.
60  */
61 int generation_numbers_enabled(struct repository *r);
62
63 void write_commit_graph_reachable(const char *obj_dir, int append,
64                                   int report_progress);
65 void write_commit_graph(const char *obj_dir,
66                         struct string_list *pack_indexes,
67                         struct string_list *commit_hex,
68                         int append, int report_progress);
69
70 int verify_commit_graph(struct repository *r, struct commit_graph *g);
71
72 void close_commit_graph(struct repository *);
73 void free_commit_graph(struct commit_graph *);
74
75 #endif