commit-graph: update design document
[git.git] / commit-graph.h
blob506cb45fb1178256b2d6c9752c28e300fc0791b2
1 #ifndef COMMIT_GRAPH_H
2 #define COMMIT_GRAPH_H
4 #include "git-compat-util.h"
5 #include "repository.h"
6 #include "string-list.h"
8 char *get_commit_graph_filename(const char *obj_dir);
11 * Given a commit struct, try to fill the commit struct info, including:
12 * 1. tree object
13 * 2. date
14 * 3. parents.
16 * Returns 1 if and only if the commit was found in the packed graph.
18 * See parse_commit_buffer() for the fallback after this call.
20 int parse_commit_in_graph(struct commit *item);
23 * It is possible that we loaded commit contents from the commit buffer,
24 * but we also want to ensure the commit-graph content is correctly
25 * checked and filled. Fill the graph_pos and generation members of
26 * the given commit.
28 void load_commit_graph_info(struct commit *item);
30 struct tree *get_commit_tree_in_graph(const struct commit *c);
32 struct commit_graph {
33 int graph_fd;
35 const unsigned char *data;
36 size_t data_len;
38 unsigned char hash_len;
39 unsigned char num_chunks;
40 uint32_t num_commits;
41 struct object_id oid;
43 const uint32_t *chunk_oid_fanout;
44 const unsigned char *chunk_oid_lookup;
45 const unsigned char *chunk_commit_data;
46 const unsigned char *chunk_large_edges;
49 struct commit_graph *load_commit_graph_one(const char *graph_file);
51 void write_commit_graph_reachable(const char *obj_dir, int append);
52 void write_commit_graph(const char *obj_dir,
53 struct string_list *pack_indexes,
54 struct string_list *commit_hex,
55 int append);
57 int verify_commit_graph(struct repository *r, struct commit_graph *g);
59 #endif