1#include "cache.h"
2#include "commit.h"
3#include "diff.h"
4#include "revision.h"
5#include "list-objects.h"
6#include "builtin.h"
7#include "log-tree.h"
8#include "graph.h"
9#include "bisect.h"
10
11static const char rev_list_usage[] =
12"git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
13" limiting output:\n"
14" --max-count=nr\n"
15" --max-age=epoch\n"
16" --min-age=epoch\n"
17" --sparse\n"
18" --no-merges\n"
19" --remove-empty\n"
20" --all\n"
21" --branches\n"
22" --tags\n"
23" --remotes\n"
24" --stdin\n"
25" --quiet\n"
26" ordering output:\n"
27" --topo-order\n"
28" --date-order\n"
29" --reverse\n"
30" formatting output:\n"
31" --parents\n"
32" --children\n"
33" --objects | --objects-edge\n"
34" --unpacked\n"
35" --header | --pretty\n"
36" --abbrev=nr | --no-abbrev\n"
37" --abbrev-commit\n"
38" --left-right\n"
39" special purpose:\n"
40" --bisect\n"
41" --bisect-vars\n"
42" --bisect-all"
43;
44
45static void finish_commit(struct commit *commit, void *data);
46static void show_commit(struct commit *commit, void *data)
47{
48 struct rev_list_info *info = data;
49 struct rev_info *revs = info->revs;
50
51 graph_show_commit(revs->graph);
52
53 if (info->show_timestamp)
54 printf("%lu ", commit->date);
55 if (info->header_prefix)
56 fputs(info->header_prefix, stdout);
57
58 if (!revs->graph) {
59 if (commit->object.flags & BOUNDARY)
60 putchar('-');
61 else if (commit->object.flags & UNINTERESTING)
62 putchar('^');
63 else if (revs->left_right) {
64 if (commit->object.flags & SYMMETRIC_LEFT)
65 putchar('<');
66 else
67 putchar('>');
68 }
69 }
70 if (revs->abbrev_commit && revs->abbrev)
71 fputs(find_unique_abbrev(commit->object.sha1, revs->abbrev),
72 stdout);
73 else
74 fputs(sha1_to_hex(commit->object.sha1), stdout);
75 if (revs->print_parents) {
76 struct commit_list *parents = commit->parents;
77 while (parents) {
78 printf(" %s", sha1_to_hex(parents->item->object.sha1));
79 parents = parents->next;
80 }
81 }
82 if (revs->children.name) {
83 struct commit_list *children;
84
85 children = lookup_decoration(&revs->children, &commit->object);
86 while (children) {
87 printf(" %s", sha1_to_hex(children->item->object.sha1));
88 children = children->next;
89 }
90 }
91 show_decorations(revs, commit);
92 if (revs->commit_format == CMIT_FMT_ONELINE)
93 putchar(' ');
94 else
95 putchar('\n');
96
97 if (revs->verbose_header && commit->buffer) {
98 struct strbuf buf = STRBUF_INIT;
99 struct pretty_print_context ctx = {0};
100 ctx.abbrev = revs->abbrev;
101 ctx.date_mode = revs->date_mode;
102 pretty_print_commit(revs->commit_format, commit, &buf, &ctx);
103 if (revs->graph) {
104 if (buf.len) {
105 if (revs->commit_format != CMIT_FMT_ONELINE)
106 graph_show_oneline(revs->graph);
107
108 graph_show_commit_msg(revs->graph, &buf);
109
110 /*
111 * Add a newline after the commit message.
112 *
113 * Usually, this newline produces a blank
114 * padding line between entries, in which case
115 * we need to add graph padding on this line.
116 *
117 * However, the commit message may not end in a
118 * newline. In this case the newline simply
119 * ends the last line of the commit message,
120 * and we don't need any graph output. (This
121 * always happens with CMIT_FMT_ONELINE, and it
122 * happens with CMIT_FMT_USERFORMAT when the
123 * format doesn't explicitly end in a newline.)
124 */
125 if (buf.len && buf.buf[buf.len - 1] == '\n')
126 graph_show_padding(revs->graph);
127 putchar('\n');
128 } else {
129 /*
130 * If the message buffer is empty, just show
131 * the rest of the graph output for this
132 * commit.
133 */
134 if (graph_show_remainder(revs->graph))
135 putchar('\n');
136 if (revs->commit_format == CMIT_FMT_ONELINE)
137 putchar('\n');
138 }
139 } else {
140 if (revs->commit_format != CMIT_FMT_USERFORMAT ||
141 buf.len)
142 printf("%s%c", buf.buf, info->hdr_termination);
143 }
144 strbuf_release(&buf);
145 } else {
146 if (graph_show_remainder(revs->graph))
147 putchar('\n');
148 }
149 maybe_flush_or_die(stdout, "stdout");
150 finish_commit(commit, data);
151}
152
153static void finish_commit(struct commit *commit, void *data)
154{
155 if (commit->parents) {
156 free_commit_list(commit->parents);
157 commit->parents = NULL;
158 }
159 free(commit->buffer);
160 commit->buffer = NULL;
161}
162
163static void finish_object(struct object *obj, const struct name_path *path, const char *name)
164{
165 if (obj->type == OBJ_BLOB && !has_sha1_file(obj->sha1))
166 die("missing blob object '%s'", sha1_to_hex(obj->sha1));
167}
168
169static void show_object(struct object *obj, const struct name_path *path, const char *component)
170{
171 char *name = path_name(path, component);
172 /* An object with name "foo\n0000000..." can be used to
173 * confuse downstream "git pack-objects" very badly.
174 */
175 const char *ep = strchr(name, '\n');
176
177 finish_object(obj, path, name);
178 if (ep) {
179 printf("%s %.*s\n", sha1_to_hex(obj->sha1),
180 (int) (ep - name),
181 name);
182 }
183 else
184 printf("%s %s\n", sha1_to_hex(obj->sha1), name);
185 free(name);
186}
187
188static void show_edge(struct commit *commit)
189{
190 printf("-%s\n", sha1_to_hex(commit->object.sha1));
191}
192
193static inline int log2i(int n)
194{
195 int log2 = 0;
196
197 for (; n > 1; n >>= 1)
198 log2++;
199
200 return log2;
201}
202
203static inline int exp2i(int n)
204{
205 return 1 << n;
206}
207
208/*
209 * Estimate the number of bisect steps left (after the current step)
210 *
211 * For any x between 0 included and 2^n excluded, the probability for
212 * n - 1 steps left looks like:
213 *
214 * P(2^n + x) == (2^n - x) / (2^n + x)
215 *
216 * and P(2^n + x) < 0.5 means 2^n < 3x
217 */
218int estimate_bisect_steps(int all)
219{
220 int n, x, e;
221
222 if (all < 3)
223 return 0;
224
225 n = log2i(all);
226 e = exp2i(n);
227 x = all - e;
228
229 return (e < 3 * x) ? n : n - 1;
230}
231
232void print_commit_list(struct commit_list *list,
233 const char *format_cur,
234 const char *format_last)
235{
236 for ( ; list; list = list->next) {
237 const char *format = list->next ? format_cur : format_last;
238 printf(format, sha1_to_hex(list->item->object.sha1));
239 }
240}
241
242static void show_tried_revs(struct commit_list *tried)
243{
244 printf("bisect_tried='");
245 print_commit_list(tried, "%s|", "%s");
246 printf("'\n");
247}
248
249static void print_var_str(const char *var, const char *val)
250{
251 printf("%s='%s'\n", var, val);
252}
253
254static void print_var_int(const char *var, int val)
255{
256 printf("%s=%d\n", var, val);
257}
258
259static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
260{
261 int cnt, flags = info->bisect_show_flags;
262 char hex[41] = "";
263 struct commit_list *tried;
264 struct rev_info *revs = info->revs;
265
266 if (!revs->commits && !(flags & BISECT_SHOW_TRIED))
267 return 1;
268
269 revs->commits = filter_skipped(revs->commits, &tried,
270 flags & BISECT_SHOW_ALL,
271 NULL, NULL);
272
273 /*
274 * revs->commits can reach "reaches" commits among
275 * "all" commits. If it is good, then there are
276 * (all-reaches) commits left to be bisected.
277 * On the other hand, if it is bad, then the set
278 * to bisect is "reaches".
279 * A bisect set of size N has (N-1) commits further
280 * to test, as we already know one bad one.
281 */
282 cnt = all - reaches;
283 if (cnt < reaches)
284 cnt = reaches;
285
286 if (revs->commits)
287 strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
288
289 if (flags & BISECT_SHOW_ALL) {
290 traverse_commit_list(revs, show_commit, show_object, info);
291 printf("------\n");
292 }
293
294 if (flags & BISECT_SHOW_TRIED)
295 show_tried_revs(tried);
296
297 print_var_str("bisect_rev", hex);
298 print_var_int("bisect_nr", cnt - 1);
299 print_var_int("bisect_good", all - reaches - 1);
300 print_var_int("bisect_bad", reaches - 1);
301 print_var_int("bisect_all", all);
302 print_var_int("bisect_steps", estimate_bisect_steps(all));
303
304 return 0;
305}
306
307int cmd_rev_list(int argc, const char **argv, const char *prefix)
308{
309 struct rev_info revs;
310 struct rev_list_info info;
311 int i;
312 int bisect_list = 0;
313 int bisect_show_vars = 0;
314 int bisect_find_all = 0;
315 int quiet = 0;
316
317 git_config(git_default_config, NULL);
318 init_revisions(&revs, prefix);
319 revs.abbrev = 0;
320 revs.commit_format = CMIT_FMT_UNSPECIFIED;
321 argc = setup_revisions(argc, argv, &revs, NULL);
322
323 memset(&info, 0, sizeof(info));
324 info.revs = &revs;
325 if (revs.bisect)
326 bisect_list = 1;
327
328 quiet = DIFF_OPT_TST(&revs.diffopt, QUICK);
329 for (i = 1 ; i < argc; i++) {
330 const char *arg = argv[i];
331
332 if (!strcmp(arg, "--header")) {
333 revs.verbose_header = 1;
334 continue;
335 }
336 if (!strcmp(arg, "--timestamp")) {
337 info.show_timestamp = 1;
338 continue;
339 }
340 if (!strcmp(arg, "--bisect")) {
341 bisect_list = 1;
342 continue;
343 }
344 if (!strcmp(arg, "--bisect-all")) {
345 bisect_list = 1;
346 bisect_find_all = 1;
347 info.bisect_show_flags = BISECT_SHOW_ALL;
348 revs.show_decorations = 1;
349 continue;
350 }
351 if (!strcmp(arg, "--bisect-vars")) {
352 bisect_list = 1;
353 bisect_show_vars = 1;
354 continue;
355 }
356 usage(rev_list_usage);
357
358 }
359 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
360 /* The command line has a --pretty */
361 info.hdr_termination = '\n';
362 if (revs.commit_format == CMIT_FMT_ONELINE)
363 info.header_prefix = "";
364 else
365 info.header_prefix = "commit ";
366 }
367 else if (revs.verbose_header)
368 /* Only --header was specified */
369 revs.commit_format = CMIT_FMT_RAW;
370
371 if ((!revs.commits &&
372 (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
373 !revs.pending.nr)) ||
374 revs.diff)
375 usage(rev_list_usage);
376
377 save_commit_buffer = (revs.verbose_header ||
378 revs.grep_filter.pattern_list ||
379 revs.grep_filter.header_list);
380 if (bisect_list)
381 revs.limited = 1;
382
383 if (prepare_revision_walk(&revs))
384 die("revision walk setup failed");
385 if (revs.tree_objects)
386 mark_edges_uninteresting(revs.commits, &revs, show_edge);
387
388 if (bisect_list) {
389 int reaches = reaches, all = all;
390
391 revs.commits = find_bisection(revs.commits, &reaches, &all,
392 bisect_find_all);
393
394 if (bisect_show_vars)
395 return show_bisect_vars(&info, reaches, all);
396 }
397
398 traverse_commit_list(&revs,
399 quiet ? finish_commit : show_commit,
400 quiet ? finish_object : show_object,
401 &info);
402
403 return 0;
404}