commit-graph: document commit-graph chains
[git/git.git] / commit-graph.h
CommitLineData
08fd81c9
DS
1#ifndef COMMIT_GRAPH_H
2#define COMMIT_GRAPH_H
3
2a2e32bd 4#include "git-compat-util.h"
283e68c7 5#include "repository.h"
d88b14b3 6#include "string-list.h"
ef3ca954 7#include "cache.h"
2a2e32bd 8
859fdc0c 9#define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH"
43d35618 10#define GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD "GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD"
859fdc0c 11
e5c5ca27
JT
12struct commit;
13
2a2e32bd 14char *get_commit_graph_filename(const char *obj_dir);
61df89c8 15int open_commit_graph(const char *graph_file, int *fd, struct stat *st);
2a2e32bd 16
177722b3
DS
17/*
18 * Given a commit struct, try to fill the commit struct info, including:
19 * 1. tree object
20 * 2. date
21 * 3. parents.
22 *
23 * Returns 1 if and only if the commit was found in the packed graph.
24 *
25 * See parse_commit_buffer() for the fallback after this call.
26 */
dade47c0 27int parse_commit_in_graph(struct repository *r, struct commit *item);
177722b3 28
e2838d85
DS
29/*
30 * It is possible that we loaded commit contents from the commit buffer,
31 * but we also want to ensure the commit-graph content is correctly
32 * checked and filled. Fill the graph_pos and generation members of
33 * the given commit.
34 */
dade47c0 35void load_commit_graph_info(struct repository *r, struct commit *item);
e2838d85 36
dade47c0
JT
37struct tree *get_commit_tree_in_graph(struct repository *r,
38 const struct commit *c);
7b8a21db 39
2a2e32bd
DS
40struct commit_graph {
41 int graph_fd;
42
43 const unsigned char *data;
44 size_t data_len;
45
46 unsigned char hash_len;
47 unsigned char num_chunks;
48 uint32_t num_commits;
49 struct object_id oid;
50
51 const uint32_t *chunk_oid_fanout;
52 const unsigned char *chunk_oid_lookup;
53 const unsigned char *chunk_commit_data;
5af7417b 54 const unsigned char *chunk_extra_edges;
2a2e32bd
DS
55};
56
67a530fa 57struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st);
2a2e32bd 58
aa658574
JS
59struct commit_graph *parse_commit_graph(void *graph_map, int fd,
60 size_t graph_size);
61
6cc01743
DS
62/*
63 * Return 1 if and only if the repository has a commit-graph
64 * file and generation numbers are computed in that file.
65 */
66int generation_numbers_enabled(struct repository *r);
67
5af80394
DS
68#define COMMIT_GRAPH_APPEND (1 << 0)
69#define COMMIT_GRAPH_PROGRESS (1 << 1)
70
e103f727
DS
71/*
72 * The write_commit_graph* methods return zero on success
73 * and a negative value on failure. Note that if the repository
74 * is not compatible with the commit-graph feature, then the
75 * methods will return 0 without writing a commit-graph.
76 */
5af80394 77int write_commit_graph_reachable(const char *obj_dir, unsigned int flags);
e103f727
DS
78int write_commit_graph(const char *obj_dir,
79 struct string_list *pack_indexes,
80 struct string_list *commit_hex,
5af80394 81 unsigned int flags);
08fd81c9 82
283e68c7
DS
83int verify_commit_graph(struct repository *r, struct commit_graph *g);
84
c3a3a964 85void close_commit_graph(struct raw_object_store *);
c3756d5b
JT
86void free_commit_graph(struct commit_graph *);
87
08fd81c9 88#endif