commit-graph: add --[no-]progress to write and verify
[git/git.git] / builtin / commit-graph.c
1 #include "builtin.h"
2 #include "config.h"
3 #include "dir.h"
4 #include "lockfile.h"
5 #include "parse-options.h"
6 #include "repository.h"
7 #include "commit-graph.h"
8 #include "object-store.h"
9
10 static char const * const builtin_commit_graph_usage[] = {
11 N_("git commit-graph [--object-dir <objdir>]"),
12 N_("git commit-graph read [--object-dir <objdir>]"),
13 N_("git commit-graph verify [--object-dir <objdir>] [--shallow] [--[no-]progress]"),
14 N_("git commit-graph write [--object-dir <objdir>] [--append|--split] [--reachable|--stdin-packs|--stdin-commits] [--[no-]progress] <split options>"),
15 NULL
16 };
17
18 static const char * const builtin_commit_graph_verify_usage[] = {
19 N_("git commit-graph verify [--object-dir <objdir>] [--shallow] [--[no-]progress]"),
20 NULL
21 };
22
23 static const char * const builtin_commit_graph_read_usage[] = {
24 N_("git commit-graph read [--object-dir <objdir>]"),
25 NULL
26 };
27
28 static const char * const builtin_commit_graph_write_usage[] = {
29 N_("git commit-graph write [--object-dir <objdir>] [--append|--split] [--reachable|--stdin-packs|--stdin-commits] [--[no-]progress] <split options>"),
30 NULL
31 };
32
33 static struct opts_commit_graph {
34 const char *obj_dir;
35 int reachable;
36 int stdin_packs;
37 int stdin_commits;
38 int append;
39 int split;
40 int shallow;
41 int progress;
42 } opts;
43
44 static int graph_verify(int argc, const char **argv)
45 {
46 struct commit_graph *graph = NULL;
47 char *graph_name;
48 int open_ok;
49 int fd;
50 struct stat st;
51 int flags = 0;
52
53 static struct option builtin_commit_graph_verify_options[] = {
54 OPT_STRING(0, "object-dir", &opts.obj_dir,
55 N_("dir"),
56 N_("The object directory to store the graph")),
57 OPT_BOOL(0, "shallow", &opts.shallow,
58 N_("if the commit-graph is split, only verify the tip file")),
59 OPT_BOOL(0, "progress", &opts.progress, N_("force progress reporting")),
60 OPT_END(),
61 };
62
63 opts.progress = isatty(2);
64 argc = parse_options(argc, argv, NULL,
65 builtin_commit_graph_verify_options,
66 builtin_commit_graph_verify_usage, 0);
67
68 if (!opts.obj_dir)
69 opts.obj_dir = get_object_directory();
70 if (opts.shallow)
71 flags |= COMMIT_GRAPH_VERIFY_SHALLOW;
72 if (opts.progress)
73 flags |= COMMIT_GRAPH_WRITE_PROGRESS;
74
75 graph_name = get_commit_graph_filename(opts.obj_dir);
76 open_ok = open_commit_graph(graph_name, &fd, &st);
77 if (!open_ok && errno != ENOENT)
78 die_errno(_("Could not open commit-graph '%s'"), graph_name);
79
80 FREE_AND_NULL(graph_name);
81
82 if (open_ok)
83 graph = load_commit_graph_one_fd_st(fd, &st);
84 else
85 graph = read_commit_graph_one(the_repository, opts.obj_dir);
86
87 /* Return failure if open_ok predicted success */
88 if (!graph)
89 return !!open_ok;
90
91 UNLEAK(graph);
92 return verify_commit_graph(the_repository, graph, flags);
93 }
94
95 static int graph_read(int argc, const char **argv)
96 {
97 struct commit_graph *graph = NULL;
98 char *graph_name;
99 int open_ok;
100 int fd;
101 struct stat st;
102
103 static struct option builtin_commit_graph_read_options[] = {
104 OPT_STRING(0, "object-dir", &opts.obj_dir,
105 N_("dir"),
106 N_("The object directory to store the graph")),
107 OPT_END(),
108 };
109
110 argc = parse_options(argc, argv, NULL,
111 builtin_commit_graph_read_options,
112 builtin_commit_graph_read_usage, 0);
113
114 if (!opts.obj_dir)
115 opts.obj_dir = get_object_directory();
116
117 graph_name = get_commit_graph_filename(opts.obj_dir);
118
119 open_ok = open_commit_graph(graph_name, &fd, &st);
120 if (!open_ok)
121 die_errno(_("Could not open commit-graph '%s'"), graph_name);
122
123 graph = load_commit_graph_one_fd_st(fd, &st);
124 if (!graph)
125 return 1;
126
127 FREE_AND_NULL(graph_name);
128
129 printf("header: %08x %d %d %d %d\n",
130 ntohl(*(uint32_t*)graph->data),
131 *(unsigned char*)(graph->data + 4),
132 *(unsigned char*)(graph->data + 5),
133 *(unsigned char*)(graph->data + 6),
134 *(unsigned char*)(graph->data + 7));
135 printf("num_commits: %u\n", graph->num_commits);
136 printf("chunks:");
137
138 if (graph->chunk_oid_fanout)
139 printf(" oid_fanout");
140 if (graph->chunk_oid_lookup)
141 printf(" oid_lookup");
142 if (graph->chunk_commit_data)
143 printf(" commit_metadata");
144 if (graph->chunk_extra_edges)
145 printf(" extra_edges");
146 printf("\n");
147
148 UNLEAK(graph);
149
150 return 0;
151 }
152
153 extern int read_replace_refs;
154 static struct split_commit_graph_opts split_opts;
155
156 static int graph_write(int argc, const char **argv)
157 {
158 struct string_list *pack_indexes = NULL;
159 struct string_list *commit_hex = NULL;
160 struct string_list lines;
161 int result = 0;
162 enum commit_graph_write_flags flags = 0;
163
164 static struct option builtin_commit_graph_write_options[] = {
165 OPT_STRING(0, "object-dir", &opts.obj_dir,
166 N_("dir"),
167 N_("The object directory to store the graph")),
168 OPT_BOOL(0, "reachable", &opts.reachable,
169 N_("start walk at all refs")),
170 OPT_BOOL(0, "stdin-packs", &opts.stdin_packs,
171 N_("scan pack-indexes listed by stdin for commits")),
172 OPT_BOOL(0, "stdin-commits", &opts.stdin_commits,
173 N_("start walk at commits listed by stdin")),
174 OPT_BOOL(0, "append", &opts.append,
175 N_("include all commits already in the commit-graph file")),
176 OPT_BOOL(0, "progress", &opts.progress, N_("force progress reporting")),
177 OPT_BOOL(0, "split", &opts.split,
178 N_("allow writing an incremental commit-graph file")),
179 OPT_INTEGER(0, "max-commits", &split_opts.max_commits,
180 N_("maximum number of commits in a non-base split commit-graph")),
181 OPT_INTEGER(0, "size-multiple", &split_opts.size_multiple,
182 N_("maximum ratio between two levels of a split commit-graph")),
183 OPT_EXPIRY_DATE(0, "expire-time", &split_opts.expire_time,
184 N_("maximum number of commits in a non-base split commit-graph")),
185 OPT_END(),
186 };
187
188 opts.progress = isatty(2);
189 split_opts.size_multiple = 2;
190 split_opts.max_commits = 0;
191 split_opts.expire_time = 0;
192
193 argc = parse_options(argc, argv, NULL,
194 builtin_commit_graph_write_options,
195 builtin_commit_graph_write_usage, 0);
196
197 if (opts.reachable + opts.stdin_packs + opts.stdin_commits > 1)
198 die(_("use at most one of --reachable, --stdin-commits, or --stdin-packs"));
199 if (!opts.obj_dir)
200 opts.obj_dir = get_object_directory();
201 if (opts.append)
202 flags |= COMMIT_GRAPH_WRITE_APPEND;
203 if (opts.split)
204 flags |= COMMIT_GRAPH_WRITE_SPLIT;
205 if (opts.progress)
206 flags |= COMMIT_GRAPH_WRITE_PROGRESS;
207
208 read_replace_refs = 0;
209
210 if (opts.reachable) {
211 if (write_commit_graph_reachable(opts.obj_dir, flags, &split_opts))
212 return 1;
213 return 0;
214 }
215
216 string_list_init(&lines, 0);
217 if (opts.stdin_packs || opts.stdin_commits) {
218 struct strbuf buf = STRBUF_INIT;
219
220 while (strbuf_getline(&buf, stdin) != EOF)
221 string_list_append(&lines, strbuf_detach(&buf, NULL));
222
223 if (opts.stdin_packs)
224 pack_indexes = &lines;
225 if (opts.stdin_commits) {
226 commit_hex = &lines;
227 flags |= COMMIT_GRAPH_WRITE_CHECK_OIDS;
228 }
229
230 UNLEAK(buf);
231 }
232
233 if (write_commit_graph(opts.obj_dir,
234 pack_indexes,
235 commit_hex,
236 flags,
237 &split_opts))
238 result = 1;
239
240 UNLEAK(lines);
241 return result;
242 }
243
244 int cmd_commit_graph(int argc, const char **argv, const char *prefix)
245 {
246 static struct option builtin_commit_graph_options[] = {
247 OPT_STRING(0, "object-dir", &opts.obj_dir,
248 N_("dir"),
249 N_("The object directory to store the graph")),
250 OPT_END(),
251 };
252
253 if (argc == 2 && !strcmp(argv[1], "-h"))
254 usage_with_options(builtin_commit_graph_usage,
255 builtin_commit_graph_options);
256
257 git_config(git_default_config, NULL);
258 argc = parse_options(argc, argv, prefix,
259 builtin_commit_graph_options,
260 builtin_commit_graph_usage,
261 PARSE_OPT_STOP_AT_NON_OPTION);
262
263 if (argc > 0) {
264 if (!strcmp(argv[0], "read"))
265 return graph_read(argc, argv);
266 if (!strcmp(argv[0], "verify"))
267 return graph_verify(argc, argv);
268 if (!strcmp(argv[0], "write"))
269 return graph_write(argc, argv);
270 }
271
272 usage_with_options(builtin_commit_graph_usage,
273 builtin_commit_graph_options);
274 }