user-manual.txt: render ASCII art correctly under Asciidoctor
[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;
6c622f9f 50 char *filename;
c523035c 51 const char *obj_dir;
2a2e32bd 52
d4f4d60f
DS
53 uint32_t num_commits_in_base;
54 struct commit_graph *base_graph;
55
2a2e32bd
DS
56 const uint32_t *chunk_oid_fanout;
57 const unsigned char *chunk_oid_lookup;
58 const unsigned char *chunk_commit_data;
5af7417b 59 const unsigned char *chunk_extra_edges;
118bd570 60 const unsigned char *chunk_base_graphs;
2a2e32bd
DS
61};
62
67a530fa 63struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st);
3da4b609 64struct commit_graph *read_commit_graph_one(struct repository *r, const char *obj_dir);
aa658574
JS
65struct commit_graph *parse_commit_graph(void *graph_map, int fd,
66 size_t graph_size);
67
6cc01743
DS
68/*
69 * Return 1 if and only if the repository has a commit-graph
70 * file and generation numbers are computed in that file.
71 */
72int generation_numbers_enabled(struct repository *r);
73
5af80394
DS
74#define COMMIT_GRAPH_APPEND (1 << 0)
75#define COMMIT_GRAPH_PROGRESS (1 << 1)
6c622f9f 76#define COMMIT_GRAPH_SPLIT (1 << 2)
5af80394 77
c2bc6e6a
DS
78struct split_commit_graph_opts {
79 int size_multiple;
80 int max_commits;
81 timestamp_t expire_time;
82};
83
e103f727
DS
84/*
85 * The write_commit_graph* methods return zero on success
86 * and a negative value on failure. Note that if the repository
87 * is not compatible with the commit-graph feature, then the
88 * methods will return 0 without writing a commit-graph.
89 */
c2bc6e6a
DS
90int write_commit_graph_reachable(const char *obj_dir, unsigned int flags,
91 const struct split_commit_graph_opts *split_opts);
e103f727
DS
92int write_commit_graph(const char *obj_dir,
93 struct string_list *pack_indexes,
94 struct string_list *commit_hex,
c2bc6e6a
DS
95 unsigned int flags,
96 const struct split_commit_graph_opts *split_opts);
08fd81c9 97
3da4b609
DS
98#define COMMIT_GRAPH_VERIFY_SHALLOW (1 << 0)
99
100int verify_commit_graph(struct repository *r, struct commit_graph *g, int flags);
283e68c7 101
c3a3a964 102void close_commit_graph(struct raw_object_store *);
c3756d5b
JT
103void free_commit_graph(struct commit_graph *);
104
08fd81c9 105#endif