]>
Commit | Line | Data |
---|---|---|
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 | #include "object-store.h" | |
9 | #include "oidset.h" | |
10 | ||
11 | #define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH" | |
12 | #define GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD "GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD" | |
13 | #define GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS "GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS" | |
14 | ||
15 | /* | |
16 | * This method is only used to enhance coverage of the commit-graph | |
17 | * feature in the test suite with the GIT_TEST_COMMIT_GRAPH and | |
18 | * GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS environment variables. Do not | |
19 | * call this method oustide of a builtin, and only if you know what | |
20 | * you are doing! | |
21 | */ | |
22 | void git_test_write_commit_graph_or_die(void); | |
23 | ||
24 | struct commit; | |
25 | struct bloom_filter_settings; | |
26 | ||
27 | char *get_commit_graph_filename(struct object_directory *odb); | |
28 | int open_commit_graph(const char *graph_file, int *fd, struct stat *st); | |
29 | ||
30 | /* | |
31 | * Given a commit struct, try to fill the commit struct info, including: | |
32 | * 1. tree object | |
33 | * 2. date | |
34 | * 3. parents. | |
35 | * | |
36 | * Returns 1 if and only if the commit was found in the packed graph. | |
37 | * | |
38 | * See parse_commit_buffer() for the fallback after this call. | |
39 | */ | |
40 | int parse_commit_in_graph(struct repository *r, struct commit *item); | |
41 | ||
42 | /* | |
43 | * It is possible that we loaded commit contents from the commit buffer, | |
44 | * but we also want to ensure the commit-graph content is correctly | |
45 | * checked and filled. Fill the graph_pos and generation members of | |
46 | * the given commit. | |
47 | */ | |
48 | void load_commit_graph_info(struct repository *r, struct commit *item); | |
49 | ||
50 | struct tree *get_commit_tree_in_graph(struct repository *r, | |
51 | const struct commit *c); | |
52 | ||
53 | struct commit_graph { | |
54 | const unsigned char *data; | |
55 | size_t data_len; | |
56 | ||
57 | unsigned char hash_len; | |
58 | unsigned char num_chunks; | |
59 | uint32_t num_commits; | |
60 | struct object_id oid; | |
61 | char *filename; | |
62 | struct object_directory *odb; | |
63 | ||
64 | uint32_t num_commits_in_base; | |
65 | struct commit_graph *base_graph; | |
66 | ||
67 | const uint32_t *chunk_oid_fanout; | |
68 | const unsigned char *chunk_oid_lookup; | |
69 | const unsigned char *chunk_commit_data; | |
70 | const unsigned char *chunk_extra_edges; | |
71 | const unsigned char *chunk_base_graphs; | |
72 | const unsigned char *chunk_bloom_indexes; | |
73 | const unsigned char *chunk_bloom_data; | |
74 | ||
75 | struct bloom_filter_settings *bloom_filter_settings; | |
76 | }; | |
77 | ||
78 | struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st, | |
79 | struct object_directory *odb); | |
80 | struct commit_graph *read_commit_graph_one(struct repository *r, | |
81 | struct object_directory *odb); | |
82 | struct commit_graph *parse_commit_graph(void *graph_map, size_t graph_size); | |
83 | ||
84 | /* | |
85 | * Return 1 if and only if the repository has a commit-graph | |
86 | * file and generation numbers are computed in that file. | |
87 | */ | |
88 | int generation_numbers_enabled(struct repository *r); | |
89 | ||
90 | enum commit_graph_write_flags { | |
91 | COMMIT_GRAPH_WRITE_APPEND = (1 << 0), | |
92 | COMMIT_GRAPH_WRITE_PROGRESS = (1 << 1), | |
93 | COMMIT_GRAPH_WRITE_SPLIT = (1 << 2), | |
94 | /* Make sure that each OID in the input is a valid commit OID. */ | |
95 | COMMIT_GRAPH_WRITE_CHECK_OIDS = (1 << 3), | |
96 | COMMIT_GRAPH_WRITE_BLOOM_FILTERS = (1 << 4), | |
97 | }; | |
98 | ||
99 | enum commit_graph_split_flags { | |
100 | COMMIT_GRAPH_SPLIT_UNSPECIFIED = 0, | |
101 | COMMIT_GRAPH_SPLIT_MERGE_PROHIBITED = 1, | |
102 | COMMIT_GRAPH_SPLIT_REPLACE = 2 | |
103 | }; | |
104 | ||
105 | struct split_commit_graph_opts { | |
106 | int size_multiple; | |
107 | int max_commits; | |
108 | timestamp_t expire_time; | |
109 | enum commit_graph_split_flags flags; | |
110 | }; | |
111 | ||
112 | /* | |
113 | * The write_commit_graph* methods return zero on success | |
114 | * and a negative value on failure. Note that if the repository | |
115 | * is not compatible with the commit-graph feature, then the | |
116 | * methods will return 0 without writing a commit-graph. | |
117 | */ | |
118 | int write_commit_graph_reachable(struct object_directory *odb, | |
119 | enum commit_graph_write_flags flags, | |
120 | const struct split_commit_graph_opts *split_opts); | |
121 | int write_commit_graph(struct object_directory *odb, | |
122 | struct string_list *pack_indexes, | |
123 | struct oidset *commits, | |
124 | enum commit_graph_write_flags flags, | |
125 | const struct split_commit_graph_opts *split_opts); | |
126 | ||
127 | #define COMMIT_GRAPH_VERIFY_SHALLOW (1 << 0) | |
128 | ||
129 | int verify_commit_graph(struct repository *r, struct commit_graph *g, int flags); | |
130 | ||
131 | void close_commit_graph(struct raw_object_store *); | |
132 | void free_commit_graph(struct commit_graph *); | |
133 | ||
134 | /* | |
135 | * Disable further use of the commit graph in this process when parsing a | |
136 | * "struct commit". | |
137 | */ | |
138 | void disable_commit_graph(struct repository *r); | |
139 | ||
140 | #endif |