rev-list: move bisect related code into its own file
[git/git.git] / builtin-rev-list.c
CommitLineData
64745109
LT
1#include "cache.h"
2#include "commit.h"
c4e05b1a 3#include "diff.h"
ae563542 4#include "revision.h"
c64ed70d 5#include "list-objects.h"
5fb61b8d 6#include "builtin.h"
50e62a8e 7#include "log-tree.h"
7fefda5c 8#include "graph.h"
a2ad79ce 9#include "bisect.h"
8906300f 10
a6f68d47 11static const char rev_list_usage[] =
1b1dd23f 12"git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
69e0c256
JH
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"
93b74bca 19" --remove-empty\n"
69e0c256 20" --all\n"
a5aa930d
UKK
21" --branches\n"
22" --tags\n"
23" --remotes\n"
42cabc34 24" --stdin\n"
27350891 25" --quiet\n"
69e0c256 26" ordering output:\n"
69e0c256 27" --topo-order\n"
4c8725f1 28" --date-order\n"
7ccd3667 29" --reverse\n"
69e0c256
JH
30" formatting output:\n"
31" --parents\n"
72276a3e 32" --children\n"
c6496575 33" --objects | --objects-edge\n"
69e0c256
JH
34" --unpacked\n"
35" --header | --pretty\n"
9da5c2f0 36" --abbrev=nr | --no-abbrev\n"
5c51c985 37" --abbrev-commit\n"
b24bace5 38" --left-right\n"
69e0c256 39" special purpose:\n"
457f08a0 40" --bisect\n"
50e62a8e
CC
41" --bisect-vars\n"
42" --bisect-all"
69e0c256 43;
a6f68d47 44
5fb61b8d 45static struct rev_info revs;
ae563542 46
96f1e58f
DR
47static int show_timestamp;
48static int hdr_termination;
91539833 49static const char *header_prefix;
e646de0d 50
27350891 51static void finish_commit(struct commit *commit);
81f2bb1f
LT
52static void show_commit(struct commit *commit)
53{
7fefda5c
AS
54 graph_show_commit(revs.graph);
55
dc68c4ff
JH
56 if (show_timestamp)
57 printf("%lu ", commit->date);
91539833
LT
58 if (header_prefix)
59 fputs(header_prefix, stdout);
7528f27d
AS
60
61 if (!revs.graph) {
62 if (commit->object.flags & BOUNDARY)
63 putchar('-');
64 else if (commit->object.flags & UNINTERESTING)
65 putchar('^');
66 else if (revs.left_right) {
67 if (commit->object.flags & SYMMETRIC_LEFT)
68 putchar('<');
69 else
70 putchar('>');
71 }
577ed5c2 72 }
7594c4b2
JH
73 if (revs.abbrev_commit && revs.abbrev)
74 fputs(find_unique_abbrev(commit->object.sha1, revs.abbrev),
75 stdout);
5c51c985
JH
76 else
77 fputs(sha1_to_hex(commit->object.sha1), stdout);
885cf808 78 if (revs.print_parents) {
81f2bb1f
LT
79 struct commit_list *parents = commit->parents;
80 while (parents) {
1ed84157 81 printf(" %s", sha1_to_hex(parents->item->object.sha1));
81f2bb1f
LT
82 parents = parents->next;
83 }
84 }
72276a3e
JH
85 if (revs.children.name) {
86 struct commit_list *children;
87
88 children = lookup_decoration(&revs.children, &commit->object);
89 while (children) {
90 printf(" %s", sha1_to_hex(children->item->object.sha1));
91 children = children->next;
92 }
93 }
0f3a290b 94 show_decorations(&revs, commit);
7594c4b2 95 if (revs.commit_format == CMIT_FMT_ONELINE)
d87449c5
JH
96 putchar(' ');
97 else
98 putchar('\n');
99
3131b713 100 if (revs.verbose_header && commit->buffer) {
f285a2d7 101 struct strbuf buf = STRBUF_INIT;
674d1727 102 pretty_print_commit(revs.commit_format, commit,
4593fb84
JH
103 &buf, revs.abbrev, NULL, NULL,
104 revs.date_mode, 0);
7fefda5c
AS
105 if (revs.graph) {
106 if (buf.len) {
107 if (revs.commit_format != CMIT_FMT_ONELINE)
108 graph_show_oneline(revs.graph);
109
110 graph_show_commit_msg(revs.graph, &buf);
111
112 /*
113 * Add a newline after the commit message.
114 *
115 * Usually, this newline produces a blank
116 * padding line between entries, in which case
117 * we need to add graph padding on this line.
118 *
119 * However, the commit message may not end in a
120 * newline. In this case the newline simply
121 * ends the last line of the commit message,
122 * and we don't need any graph output. (This
123 * always happens with CMIT_FMT_ONELINE, and it
124 * happens with CMIT_FMT_USERFORMAT when the
125 * format doesn't explicitly end in a newline.)
126 */
127 if (buf.len && buf.buf[buf.len - 1] == '\n')
128 graph_show_padding(revs.graph);
129 putchar('\n');
130 } else {
131 /*
132 * If the message buffer is empty, just show
133 * the rest of the graph output for this
134 * commit.
135 */
136 if (graph_show_remainder(revs.graph))
137 putchar('\n');
138 }
139 } else {
140 if (buf.len)
141 printf("%s%c", buf.buf, hdr_termination);
142 }
674d1727 143 strbuf_release(&buf);
7fefda5c
AS
144 } else {
145 if (graph_show_remainder(revs.graph))
146 putchar('\n');
7620d39f 147 }
06f59e9f 148 maybe_flush_or_die(stdout, "stdout");
27350891
SP
149 finish_commit(commit);
150}
151
152static void finish_commit(struct commit *commit)
153{
cb115748
LT
154 if (commit->parents) {
155 free_commit_list(commit->parents);
156 commit->parents = NULL;
157 }
4cac42b1
JH
158 free(commit->buffer);
159 commit->buffer = NULL;
a3437b8c
JS
160}
161
27350891
SP
162static void finish_object(struct object_array_entry *p)
163{
164 if (p->item->type == OBJ_BLOB && !has_sha1_file(p->item->sha1))
165 die("missing blob object '%s'", sha1_to_hex(p->item->sha1));
166}
167
c64ed70d 168static void show_object(struct object_array_entry *p)
9de48752 169{
c64ed70d 170 /* An object with name "foo\n0000000..." can be used to
f18d244a 171 * confuse downstream "git pack-objects" very badly.
c64ed70d
JH
172 */
173 const char *ep = strchr(p->name, '\n');
b9849a1a 174
27350891 175 finish_object(p);
c64ed70d
JH
176 if (ep) {
177 printf("%s %.*s\n", sha1_to_hex(p->item->sha1),
178 (int) (ep - p->name),
179 p->name);
9de48752 180 }
c64ed70d
JH
181 else
182 printf("%s %s\n", sha1_to_hex(p->item->sha1), p->name);
9de48752
LT
183}
184
8d1d8f83
JH
185static void show_edge(struct commit *commit)
186{
187 printf("-%s\n", sha1_to_hex(commit->object.sha1));
188}
189
9f199b15
CC
190static inline int log2i(int n)
191{
192 int log2 = 0;
193
194 for (; n > 1; n >>= 1)
195 log2++;
196
197 return log2;
198}
199
200static inline int exp2i(int n)
201{
202 return 1 << n;
203}
204
205/*
206 * Estimate the number of bisect steps left (after the current step)
207 *
208 * For any x between 0 included and 2^n excluded, the probability for
209 * n - 1 steps left looks like:
210 *
211 * P(2^n + x) == (2^n - x) / (2^n + x)
212 *
213 * and P(2^n + x) < 0.5 means 2^n < 3x
214 */
215static int estimate_bisect_steps(int all)
216{
217 int n, x, e;
218
219 if (all < 3)
220 return 0;
221
222 n = log2i(all);
223 e = exp2i(n);
224 x = all - e;
225
226 return (e < 3 * x) ? n : n - 1;
227}
228
a633fca0 229int cmd_rev_list(int argc, const char **argv, const char *prefix)
64745109 230{
ae563542 231 struct commit_list *list;
d9a83684 232 int i;
42cabc34 233 int read_from_stdin = 0;
ff62d732 234 int bisect_list = 0;
457f08a0 235 int bisect_show_vars = 0;
50e62a8e 236 int bisect_find_all = 0;
27350891 237 int quiet = 0;
64745109 238
ef90d6d4 239 git_config(git_default_config, NULL);
a633fca0 240 init_revisions(&revs, prefix);
7594c4b2
JH
241 revs.abbrev = 0;
242 revs.commit_format = CMIT_FMT_UNSPECIFIED;
a4a88b2b 243 argc = setup_revisions(argc, argv, &revs, NULL);
ae563542 244
d85fe389 245 quiet = DIFF_OPT_TST(&revs.diffopt, QUIET);
fcfda02b 246 for (i = 1 ; i < argc; i++) {
cf484544 247 const char *arg = argv[i];
fcfda02b 248
a6f68d47 249 if (!strcmp(arg, "--header")) {
7594c4b2 250 revs.verbose_header = 1;
9d97aa64
LT
251 continue;
252 }
dc68c4ff
JH
253 if (!strcmp(arg, "--timestamp")) {
254 show_timestamp = 1;
255 continue;
256 }
8b3a1e05
LT
257 if (!strcmp(arg, "--bisect")) {
258 bisect_list = 1;
259 continue;
260 }
50e62a8e
CC
261 if (!strcmp(arg, "--bisect-all")) {
262 bisect_list = 1;
263 bisect_find_all = 1;
6e46cc0d 264 revs.show_decorations = 1;
50e62a8e
CC
265 continue;
266 }
457f08a0
JH
267 if (!strcmp(arg, "--bisect-vars")) {
268 bisect_list = 1;
269 bisect_show_vars = 1;
270 continue;
271 }
42cabc34
JH
272 if (!strcmp(arg, "--stdin")) {
273 if (read_from_stdin++)
274 die("--stdin given twice?");
275 read_revisions_from_stdin(&revs);
276 continue;
277 }
ae563542 278 usage(rev_list_usage);
a6f68d47 279
fcfda02b 280 }
7594c4b2
JH
281 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
282 /* The command line has a --pretty */
283 hdr_termination = '\n';
284 if (revs.commit_format == CMIT_FMT_ONELINE)
91539833 285 header_prefix = "";
7594c4b2 286 else
91539833 287 header_prefix = "commit ";
7594c4b2 288 }
db89665f
JH
289 else if (revs.verbose_header)
290 /* Only --header was specified */
291 revs.commit_format = CMIT_FMT_RAW;
fcfda02b 292
ae563542 293 list = revs.commits;
ae563542 294
8c1f0b44
JH
295 if ((!list &&
296 (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
1f1e895f 297 !revs.pending.nr)) ||
8c1f0b44 298 revs.diff)
7b34c2fa
LT
299 usage(rev_list_usage);
300
0843acfd
JK
301 save_commit_buffer = revs.verbose_header ||
302 revs.grep_filter.pattern_list;
4e1dc640
JH
303 if (bisect_list)
304 revs.limited = 1;
9181ca2c 305
3d51e1b5
MK
306 if (prepare_revision_walk(&revs))
307 die("revision walk setup failed");
a4a88b2b 308 if (revs.tree_objects)
8d1d8f83 309 mark_edges_uninteresting(revs.commits, &revs, show_edge);
a4a88b2b 310
457f08a0
JH
311 if (bisect_list) {
312 int reaches = reaches, all = all;
313
50e62a8e
CC
314 revs.commits = find_bisection(revs.commits, &reaches, &all,
315 bisect_find_all);
457f08a0
JH
316 if (bisect_show_vars) {
317 int cnt;
50e62a8e 318 char hex[41];
457f08a0
JH
319 if (!revs.commits)
320 return 1;
321 /*
322 * revs.commits can reach "reaches" commits among
323 * "all" commits. If it is good, then there are
324 * (all-reaches) commits left to be bisected.
325 * On the other hand, if it is bad, then the set
326 * to bisect is "reaches".
327 * A bisect set of size N has (N-1) commits further
328 * to test, as we already know one bad one.
329 */
50e62a8e 330 cnt = all - reaches;
457f08a0
JH
331 if (cnt < reaches)
332 cnt = reaches;
50e62a8e
CC
333 strcpy(hex, sha1_to_hex(revs.commits->item->object.sha1));
334
335 if (bisect_find_all) {
336 traverse_commit_list(&revs, show_commit, show_object);
337 printf("------\n");
338 }
339
457f08a0
JH
340 printf("bisect_rev=%s\n"
341 "bisect_nr=%d\n"
342 "bisect_good=%d\n"
343 "bisect_bad=%d\n"
9f199b15
CC
344 "bisect_all=%d\n"
345 "bisect_steps=%d\n",
50e62a8e 346 hex,
457f08a0
JH
347 cnt - 1,
348 all - reaches - 1,
349 reaches - 1,
9f199b15
CC
350 all,
351 estimate_bisect_steps(all));
457f08a0
JH
352 return 0;
353 }
354 }
7b34c2fa 355
27350891
SP
356 traverse_commit_list(&revs,
357 quiet ? finish_commit : show_commit,
358 quiet ? finish_object : show_object);
8906300f 359
64745109
LT
360 return 0;
361}