]> git.ipfire.org Git - thirdparty/git.git/blame - bisect.c
handle_one_ref(): rewrite to take an object_id argument
[thirdparty/git.git] / bisect.c
CommitLineData
a2ad79ce
CC
1#include "cache.h"
2#include "commit.h"
3#include "diff.h"
4#include "revision.h"
1bf072e3
CC
5#include "refs.h"
6#include "list-objects.h"
3b437b0d 7#include "quote.h"
4eb5b646 8#include "sha1-lookup.h"
ef24c7ca 9#include "run-command.h"
e22278c0 10#include "log-tree.h"
a2ad79ce 11#include "bisect.h"
902bb364 12#include "sha1-array.h"
8a534b61 13#include "argv-array.h"
6212b1aa 14
fad2d31d 15static struct sha1_array good_revs;
6212b1aa 16static struct sha1_array skipped_revs;
1bf072e3 17
3c5ff995 18static struct object_id *current_bad_oid;
ef24c7ca 19
ef24c7ca
CC
20static const char *argv_checkout[] = {"checkout", "-q", NULL, "--", NULL};
21static const char *argv_show_branch[] = {"show-branch", NULL, NULL};
fee92fc1 22static const char *argv_update_ref[] = {"update-ref", "--no-deref", "BISECT_HEAD", NULL, NULL};
ef24c7ca 23
208acbfb 24/* Remember to update object flag allocation in object.h */
a2ad79ce
CC
25#define COUNTED (1u<<16)
26
27/*
28 * This is a truly stupid algorithm, but it's only
29 * used for bisection, and we just don't care enough.
30 *
31 * We care just barely enough to avoid recursing for
32 * non-merge entries.
33 */
34static int count_distance(struct commit_list *entry)
35{
36 int nr = 0;
37
38 while (entry) {
39 struct commit *commit = entry->item;
40 struct commit_list *p;
41
42 if (commit->object.flags & (UNINTERESTING | COUNTED))
43 break;
44 if (!(commit->object.flags & TREESAME))
45 nr++;
46 commit->object.flags |= COUNTED;
47 p = commit->parents;
48 entry = p;
49 if (p) {
50 p = p->next;
51 while (p) {
52 nr += count_distance(p);
53 p = p->next;
54 }
55 }
56 }
57
58 return nr;
59}
60
61static void clear_distance(struct commit_list *list)
62{
63 while (list) {
64 struct commit *commit = list->item;
65 commit->object.flags &= ~COUNTED;
66 list = list->next;
67 }
68}
69
70#define DEBUG_BISECT 0
71
72static inline int weight(struct commit_list *elem)
73{
74 return *((int*)(elem->item->util));
75}
76
77static inline void weight_set(struct commit_list *elem, int weight)
78{
79 *((int*)(elem->item->util)) = weight;
80}
81
82static int count_interesting_parents(struct commit *commit)
83{
84 struct commit_list *p;
85 int count;
86
87 for (count = 0, p = commit->parents; p; p = p->next) {
88 if (p->item->object.flags & UNINTERESTING)
89 continue;
90 count++;
91 }
92 return count;
93}
94
95static inline int halfway(struct commit_list *p, int nr)
96{
97 /*
98 * Don't short-cut something we are not going to return!
99 */
100 if (p->item->object.flags & TREESAME)
101 return 0;
102 if (DEBUG_BISECT)
103 return 0;
104 /*
105 * 2 and 3 are halfway of 5.
106 * 3 is halfway of 6 but 2 and 4 are not.
107 */
108 switch (2 * weight(p) - nr) {
109 case -1: case 0: case 1:
110 return 1;
111 default:
112 return 0;
113 }
114}
115
116#if !DEBUG_BISECT
117#define show_list(a,b,c,d) do { ; } while (0)
118#else
119static void show_list(const char *debug, int counted, int nr,
120 struct commit_list *list)
121{
122 struct commit_list *p;
123
124 fprintf(stderr, "%s (%d/%d)\n", debug, counted, nr);
125
126 for (p = list; p; p = p->next) {
127 struct commit_list *pp;
128 struct commit *commit = p->item;
129 unsigned flags = commit->object.flags;
130 enum object_type type;
131 unsigned long size;
132 char *buf = read_sha1_file(commit->object.sha1, &type, &size);
56ff3794
CC
133 const char *subject_start;
134 int subject_len;
a2ad79ce
CC
135
136 fprintf(stderr, "%c%c%c ",
137 (flags & TREESAME) ? ' ' : 'T',
138 (flags & UNINTERESTING) ? 'U' : ' ',
139 (flags & COUNTED) ? 'C' : ' ');
140 if (commit->util)
141 fprintf(stderr, "%3d", weight(p));
142 else
143 fprintf(stderr, "---");
144 fprintf(stderr, " %.*s", 8, sha1_to_hex(commit->object.sha1));
145 for (pp = commit->parents; pp; pp = pp->next)
146 fprintf(stderr, " %.*s", 8,
147 sha1_to_hex(pp->item->object.sha1));
148
56ff3794
CC
149 subject_len = find_commit_subject(buf, &subject_start);
150 if (subject_len)
151 fprintf(stderr, " %.*s", subject_len, subject_start);
a2ad79ce
CC
152 fprintf(stderr, "\n");
153 }
154}
155#endif /* DEBUG_BISECT */
156
157static struct commit_list *best_bisection(struct commit_list *list, int nr)
158{
159 struct commit_list *p, *best;
160 int best_distance = -1;
161
162 best = list;
163 for (p = list; p; p = p->next) {
164 int distance;
165 unsigned flags = p->item->object.flags;
166
167 if (flags & TREESAME)
168 continue;
169 distance = weight(p);
170 if (nr - distance < distance)
171 distance = nr - distance;
172 if (distance > best_distance) {
173 best = p;
174 best_distance = distance;
175 }
176 }
177
178 return best;
179}
180
181struct commit_dist {
182 struct commit *commit;
183 int distance;
184};
185
186static int compare_commit_dist(const void *a_, const void *b_)
187{
188 struct commit_dist *a, *b;
189
190 a = (struct commit_dist *)a_;
191 b = (struct commit_dist *)b_;
192 if (a->distance != b->distance)
193 return b->distance - a->distance; /* desc sort */
194 return hashcmp(a->commit->object.sha1, b->commit->object.sha1);
195}
196
197static struct commit_list *best_bisection_sorted(struct commit_list *list, int nr)
198{
199 struct commit_list *p;
200 struct commit_dist *array = xcalloc(nr, sizeof(*array));
201 int cnt, i;
202
203 for (p = list, cnt = 0; p; p = p->next) {
204 int distance;
205 unsigned flags = p->item->object.flags;
206
207 if (flags & TREESAME)
208 continue;
209 distance = weight(p);
210 if (nr - distance < distance)
211 distance = nr - distance;
212 array[cnt].commit = p->item;
213 array[cnt].distance = distance;
214 cnt++;
215 }
216 qsort(array, cnt, sizeof(*array), compare_commit_dist);
217 for (p = list, i = 0; i < cnt; i++) {
662174d2 218 char buf[100]; /* enough for dist=%d */
a2ad79ce
CC
219 struct object *obj = &(array[i].commit->object);
220
662174d2
JK
221 snprintf(buf, sizeof(buf), "dist=%d", array[i].distance);
222 add_name_decoration(DECORATION_NONE, buf, obj);
223
a2ad79ce
CC
224 p->item = array[i].commit;
225 p = p->next;
226 }
227 if (p)
228 p->next = NULL;
229 free(array);
230 return list;
231}
232
233/*
234 * zero or positive weight is the number of interesting commits it can
235 * reach, including itself. Especially, weight = 0 means it does not
236 * reach any tree-changing commits (e.g. just above uninteresting one
237 * but traversal is with pathspec).
238 *
239 * weight = -1 means it has one parent and its distance is yet to
240 * be computed.
241 *
242 * weight = -2 means it has more than one parent and its distance is
243 * unknown. After running count_distance() first, they will get zero
244 * or positive distance.
245 */
246static struct commit_list *do_find_bisection(struct commit_list *list,
247 int nr, int *weights,
248 int find_all)
249{
250 int n, counted;
251 struct commit_list *p;
252
253 counted = 0;
254
255 for (n = 0, p = list; p; p = p->next) {
256 struct commit *commit = p->item;
257 unsigned flags = commit->object.flags;
258
259 p->item->util = &weights[n++];
260 switch (count_interesting_parents(commit)) {
261 case 0:
262 if (!(flags & TREESAME)) {
263 weight_set(p, 1);
264 counted++;
265 show_list("bisection 2 count one",
266 counted, nr, list);
267 }
268 /*
269 * otherwise, it is known not to reach any
270 * tree-changing commit and gets weight 0.
271 */
272 break;
273 case 1:
274 weight_set(p, -1);
275 break;
276 default:
277 weight_set(p, -2);
278 break;
279 }
280 }
281
282 show_list("bisection 2 initialize", counted, nr, list);
283
284 /*
285 * If you have only one parent in the resulting set
286 * then you can reach one commit more than that parent
287 * can reach. So we do not have to run the expensive
288 * count_distance() for single strand of pearls.
289 *
290 * However, if you have more than one parents, you cannot
291 * just add their distance and one for yourself, since
292 * they usually reach the same ancestor and you would
293 * end up counting them twice that way.
294 *
295 * So we will first count distance of merges the usual
296 * way, and then fill the blanks using cheaper algorithm.
297 */
298 for (p = list; p; p = p->next) {
299 if (p->item->object.flags & UNINTERESTING)
300 continue;
301 if (weight(p) != -2)
302 continue;
303 weight_set(p, count_distance(p));
304 clear_distance(list);
305
306 /* Does it happen to be at exactly half-way? */
307 if (!find_all && halfway(p, nr))
308 return p;
309 counted++;
310 }
311
312 show_list("bisection 2 count_distance", counted, nr, list);
313
314 while (counted < nr) {
315 for (p = list; p; p = p->next) {
316 struct commit_list *q;
317 unsigned flags = p->item->object.flags;
318
319 if (0 <= weight(p))
320 continue;
321 for (q = p->item->parents; q; q = q->next) {
322 if (q->item->object.flags & UNINTERESTING)
323 continue;
324 if (0 <= weight(q))
325 break;
326 }
327 if (!q)
328 continue;
329
330 /*
331 * weight for p is unknown but q is known.
332 * add one for p itself if p is to be counted,
333 * otherwise inherit it from q directly.
334 */
335 if (!(flags & TREESAME)) {
336 weight_set(p, weight(q)+1);
337 counted++;
338 show_list("bisection 2 count one",
339 counted, nr, list);
340 }
341 else
342 weight_set(p, weight(q));
343
344 /* Does it happen to be at exactly half-way? */
345 if (!find_all && halfway(p, nr))
346 return p;
347 }
348 }
349
350 show_list("bisection 2 counted all", counted, nr, list);
351
352 if (!find_all)
353 return best_bisection(list, nr);
354 else
355 return best_bisection_sorted(list, nr);
356}
357
358struct commit_list *find_bisection(struct commit_list *list,
359 int *reaches, int *all,
360 int find_all)
361{
362 int nr, on_list;
363 struct commit_list *p, *best, *next, *last;
364 int *weights;
365
366 show_list("bisection 2 entry", 0, 0, list);
367
368 /*
369 * Count the number of total and tree-changing items on the
370 * list, while reversing the list.
371 */
372 for (nr = on_list = 0, last = NULL, p = list;
373 p;
374 p = next) {
375 unsigned flags = p->item->object.flags;
376
377 next = p->next;
378 if (flags & UNINTERESTING)
379 continue;
380 p->next = last;
381 last = p;
382 if (!(flags & TREESAME))
383 nr++;
384 on_list++;
385 }
386 list = last;
387 show_list("bisection 2 sorted", 0, nr, list);
388
389 *all = nr;
390 weights = xcalloc(on_list, sizeof(*weights));
391
392 /* Do the real work of finding bisection commit. */
393 best = do_find_bisection(list, nr, weights, find_all);
394 if (best) {
395 if (!find_all)
396 best->next = NULL;
397 *reaches = weight(best);
398 }
399 free(weights);
400 return best;
401}
402
1bf072e3
CC
403static int register_ref(const char *refname, const unsigned char *sha1,
404 int flags, void *cb_data)
405{
406 if (!strcmp(refname, "bad")) {
3c5ff995 407 current_bad_oid = xmalloc(sizeof(*current_bad_oid));
408 hashcpy(current_bad_oid->hash, sha1);
59556548 409 } else if (starts_with(refname, "good-")) {
902bb364 410 sha1_array_append(&good_revs, sha1);
59556548 411 } else if (starts_with(refname, "skip-")) {
902bb364 412 sha1_array_append(&skipped_revs, sha1);
1bf072e3
CC
413 }
414
415 return 0;
416}
417
418static int read_bisect_refs(void)
419{
2b2a5be3
MH
420 struct each_ref_fn_sha1_adapter wrapped_register_ref =
421 {register_ref, NULL};
422
423 return for_each_ref_in("refs/bisect/", each_ref_fn_adapter, &wrapped_register_ref);
1bf072e3
CC
424}
425
2af202be 426static void read_bisect_paths(struct argv_array *array)
3b437b0d
CC
427{
428 struct strbuf str = STRBUF_INIT;
429 const char *filename = git_path("BISECT_NAMES");
430 FILE *fp = fopen(filename, "r");
431
432 if (!fp)
d824cbba 433 die_errno("Could not open file '%s'", filename);
3b437b0d
CC
434
435 while (strbuf_getline(&str, fp, '\n') != EOF) {
3b437b0d 436 strbuf_trim(&str);
8a534b61 437 if (sq_dequote_to_argv_array(str.buf, array))
3b437b0d 438 die("Badly quoted content in file '%s': %s",
8a534b61 439 filename, str.buf);
3b437b0d
CC
440 }
441
442 strbuf_release(&str);
443 fclose(fp);
444}
445
c0537662
CC
446static char *join_sha1_array_hex(struct sha1_array *array, char delim)
447{
448 struct strbuf joined_hexs = STRBUF_INIT;
449 int i;
450
902bb364 451 for (i = 0; i < array->nr; i++) {
c0537662 452 strbuf_addstr(&joined_hexs, sha1_to_hex(array->sha1[i]));
902bb364 453 if (i + 1 < array->nr)
c0537662
CC
454 strbuf_addch(&joined_hexs, delim);
455 }
456
457 return strbuf_detach(&joined_hexs, NULL);
458}
459
9af3589e
CC
460/*
461 * In this function, passing a not NULL skipped_first is very special.
462 * It means that we want to know if the first commit in the list is
463 * skipped because we will want to test a commit away from it if it is
464 * indeed skipped.
465 * So if the first commit is skipped, we cannot take the shortcut to
466 * just "return list" when we find the first non skipped commit, we
467 * have to return a fully filtered list.
468 *
469 * We use (*skipped_first == -1) to mean "it has been found that the
470 * first commit is not skipped". In this case *skipped_first is set back
471 * to 0 just before the function returns.
472 */
95188648
CC
473struct commit_list *filter_skipped(struct commit_list *list,
474 struct commit_list **tried,
9af3589e
CC
475 int show_all,
476 int *count,
477 int *skipped_first)
95188648
CC
478{
479 struct commit_list *filtered = NULL, **f = &filtered;
480
481 *tried = NULL;
482
9af3589e
CC
483 if (skipped_first)
484 *skipped_first = 0;
485 if (count)
486 *count = 0;
487
902bb364 488 if (!skipped_revs.nr)
95188648
CC
489 return list;
490
95188648
CC
491 while (list) {
492 struct commit_list *next = list->next;
493 list->next = NULL;
902bb364 494 if (0 <= sha1_array_lookup(&skipped_revs,
aaaff9e2 495 list->item->object.sha1)) {
9af3589e
CC
496 if (skipped_first && !*skipped_first)
497 *skipped_first = 1;
95188648
CC
498 /* Move current to tried list */
499 *tried = list;
500 tried = &list->next;
501 } else {
9af3589e
CC
502 if (!show_all) {
503 if (!skipped_first || !*skipped_first)
504 return list;
505 } else if (skipped_first && !*skipped_first) {
506 /* This means we know it's not skipped */
507 *skipped_first = -1;
508 }
95188648
CC
509 /* Move current to filtered list */
510 *f = list;
511 f = &list->next;
9af3589e
CC
512 if (count)
513 (*count)++;
95188648
CC
514 }
515 list = next;
516 }
517
9af3589e
CC
518 if (skipped_first && *skipped_first == -1)
519 *skipped_first = 0;
520
95188648
CC
521 return filtered;
522}
1bf072e3 523
ebc9529f
CC
524#define PRN_MODULO 32768
525
526/*
527 * This is a pseudo random number generator based on "man 3 rand".
528 * It is not used properly because the seed is the argument and it
529 * is increased by one between each call, but that should not matter
530 * for this application.
531 */
7b96d888 532static unsigned get_prn(unsigned count) {
ebc9529f 533 count = count * 1103515245 + 12345;
7b96d888 534 return (count/65536) % PRN_MODULO;
ebc9529f
CC
535}
536
537/*
538 * Custom integer square root from
539 * http://en.wikipedia.org/wiki/Integer_square_root
540 */
541static int sqrti(int val)
542{
543 float d, x = val;
544
545 if (val == 0)
546 return 0;
547
548 do {
549 float y = (x + (float)val / x) / 2;
550 d = (y > x) ? y - x : x - y;
551 x = y;
552 } while (d >= 0.5);
553
554 return (int)x;
555}
556
557static struct commit_list *skip_away(struct commit_list *list, int count)
62d0b0da 558{
62d0b0da 559 struct commit_list *cur, *previous;
ebc9529f
CC
560 int prn, index, i;
561
562 prn = get_prn(count);
563 index = (count * prn / PRN_MODULO) * sqrti(prn) / sqrti(PRN_MODULO);
62d0b0da
CC
564
565 cur = list;
566 previous = NULL;
62d0b0da
CC
567
568 for (i = 0; cur; cur = cur->next, i++) {
569 if (i == index) {
3c5ff995 570 if (hashcmp(cur->item->object.sha1, current_bad_oid->hash))
62d0b0da
CC
571 return cur;
572 if (previous)
573 return previous;
574 return list;
575 }
576 previous = cur;
577 }
578
579 return list;
580}
581
582static struct commit_list *managed_skipped(struct commit_list *list,
583 struct commit_list **tried)
584{
585 int count, skipped_first;
62d0b0da
CC
586
587 *tried = NULL;
588
902bb364 589 if (!skipped_revs.nr)
62d0b0da
CC
590 return list;
591
592 list = filter_skipped(list, tried, 0, &count, &skipped_first);
593
594 if (!skipped_first)
595 return list;
596
ebc9529f 597 return skip_away(list, count);
62d0b0da
CC
598}
599
a22347c6
CC
600static void bisect_rev_setup(struct rev_info *revs, const char *prefix,
601 const char *bad_format, const char *good_format,
602 int read_paths)
1bf072e3 603{
8a534b61 604 struct argv_array rev_argv = ARGV_ARRAY_INIT;
fad2d31d
CC
605 int i;
606
3b437b0d
CC
607 init_revisions(revs, prefix);
608 revs->abbrev = 0;
609 revs->commit_format = CMIT_FMT_UNSPECIFIED;
1bf072e3 610
1c953a1f 611 /* rev_argv.argv[0] will be ignored by setup_revisions */
8a534b61 612 argv_array_push(&rev_argv, "bisect_rev_setup");
3c5ff995 613 argv_array_pushf(&rev_argv, bad_format, oid_to_hex(current_bad_oid));
902bb364 614 for (i = 0; i < good_revs.nr; i++)
8a534b61
JK
615 argv_array_pushf(&rev_argv, good_format,
616 sha1_to_hex(good_revs.sha1[i]));
617 argv_array_push(&rev_argv, "--");
a22347c6
CC
618 if (read_paths)
619 read_bisect_paths(&rev_argv);
3b437b0d 620
8a534b61
JK
621 setup_revisions(rev_argv.argc, rev_argv.argv, revs, NULL);
622 /* XXX leak rev_argv, as "revs" may still be pointing to it */
3b437b0d
CC
623}
624
a22347c6 625static void bisect_common(struct rev_info *revs)
2ace9727 626{
2ace9727
CC
627 if (prepare_revision_walk(revs))
628 die("revision walk setup failed");
629 if (revs->tree_objects)
e76a5fb4 630 mark_edges_uninteresting(revs, NULL);
2ace9727
CC
631}
632
ef24c7ca 633static void exit_if_skipped_commits(struct commit_list *tried,
3c5ff995 634 const struct object_id *bad)
ef24c7ca
CC
635{
636 if (!tried)
637 return;
638
639 printf("There are only 'skip'ped commits left to test.\n"
640 "The first bad commit could be any of:\n");
641 print_commit_list(tried, "%s\n", "%s\n");
642 if (bad)
3c5ff995 643 printf("%s\n", oid_to_hex(bad));
ef24c7ca
CC
644 printf("We cannot bisect more!\n");
645 exit(2);
646}
647
3c5ff995 648static int is_expected_rev(const struct object_id *oid)
c0537662
CC
649{
650 const char *filename = git_path("BISECT_EXPECTED_REV");
651 struct stat st;
652 struct strbuf str = STRBUF_INIT;
653 FILE *fp;
654 int res = 0;
655
656 if (stat(filename, &st) || !S_ISREG(st.st_mode))
657 return 0;
658
659 fp = fopen(filename, "r");
660 if (!fp)
661 return 0;
662
663 if (strbuf_getline(&str, fp, '\n') != EOF)
3c5ff995 664 res = !strcmp(str.buf, oid_to_hex(oid));
c0537662
CC
665
666 strbuf_release(&str);
667 fclose(fp);
668
669 return res;
670}
671
ef24c7ca
CC
672static void mark_expected_rev(char *bisect_rev_hex)
673{
674 int len = strlen(bisect_rev_hex);
675 const char *filename = git_path("BISECT_EXPECTED_REV");
676 int fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
677
678 if (fd < 0)
d824cbba 679 die_errno("could not create file '%s'", filename);
ef24c7ca
CC
680
681 bisect_rev_hex[len] = '\n';
682 write_or_die(fd, bisect_rev_hex, len + 1);
683 bisect_rev_hex[len] = '\0';
684
685 if (close(fd) < 0)
686 die("closing file %s: %s", filename, strerror(errno));
687}
688
fee92fc1 689static int bisect_checkout(char *bisect_rev_hex, int no_checkout)
ef24c7ca 690{
ef24c7ca
CC
691
692 mark_expected_rev(bisect_rev_hex);
693
694 argv_checkout[2] = bisect_rev_hex;
fee92fc1
JS
695 if (no_checkout) {
696 argv_update_ref[3] = bisect_rev_hex;
697 if (run_command_v_opt(argv_update_ref, RUN_GIT_CMD))
698 die("update-ref --no-deref HEAD failed on %s",
699 bisect_rev_hex);
700 } else {
4824d1b8 701 int res;
fee92fc1
JS
702 res = run_command_v_opt(argv_checkout, RUN_GIT_CMD);
703 if (res)
704 exit(res);
705 }
ef24c7ca
CC
706
707 argv_show_branch[1] = bisect_rev_hex;
708 return run_command_v_opt(argv_show_branch, RUN_GIT_CMD);
709}
710
c0537662
CC
711static struct commit *get_commit_reference(const unsigned char *sha1)
712{
713 struct commit *r = lookup_commit_reference(sha1);
714 if (!r)
715 die("Not a valid commit name %s", sha1_to_hex(sha1));
716 return r;
717}
718
719static struct commit **get_bad_and_good_commits(int *rev_nr)
720{
902bb364 721 int len = 1 + good_revs.nr;
c0537662
CC
722 struct commit **rev = xmalloc(len * sizeof(*rev));
723 int i, n = 0;
724
3c5ff995 725 rev[n++] = get_commit_reference(current_bad_oid->hash);
902bb364 726 for (i = 0; i < good_revs.nr; i++)
c0537662
CC
727 rev[n++] = get_commit_reference(good_revs.sha1[i]);
728 *rev_nr = n;
729
730 return rev;
731}
732
733static void handle_bad_merge_base(void)
734{
3c5ff995 735 if (is_expected_rev(current_bad_oid)) {
736 char *bad_hex = oid_to_hex(current_bad_oid);
c0537662
CC
737 char *good_hex = join_sha1_array_hex(&good_revs, ' ');
738
739 fprintf(stderr, "The merge base %s is bad.\n"
740 "This means the bug has been fixed "
741 "between %s and [%s].\n",
742 bad_hex, bad_hex, good_hex);
743
744 exit(3);
745 }
746
747 fprintf(stderr, "Some good revs are not ancestor of the bad rev.\n"
748 "git bisect cannot work properly in this case.\n"
749 "Maybe you mistake good and bad revs?\n");
750 exit(1);
751}
752
2af202be 753static void handle_skipped_merge_base(const unsigned char *mb)
c0537662
CC
754{
755 char *mb_hex = sha1_to_hex(mb);
3c5ff995 756 char *bad_hex = sha1_to_hex(current_bad_oid->hash);
c0537662
CC
757 char *good_hex = join_sha1_array_hex(&good_revs, ' ');
758
bd757c18 759 warning("the merge base between %s and [%s] "
c0537662
CC
760 "must be skipped.\n"
761 "So we cannot be sure the first bad commit is "
762 "between %s and %s.\n"
bd757c18 763 "We continue anyway.",
c0537662
CC
764 bad_hex, good_hex, mb_hex, bad_hex);
765 free(good_hex);
766}
767
768/*
769 * "check_merge_bases" checks that merge bases are not "bad".
770 *
771 * - If one is "bad", it means the user assumed something wrong
772 * and we must exit with a non 0 error code.
773 * - If one is "good", that's good, we have nothing to do.
774 * - If one is "skipped", we can't know but we should warn.
775 * - If we don't know, we should check it out and ask the user to test.
776 */
fee92fc1 777static void check_merge_bases(int no_checkout)
c0537662
CC
778{
779 struct commit_list *result;
780 int rev_nr;
781 struct commit **rev = get_bad_and_good_commits(&rev_nr);
782
2ce406cc 783 result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1);
c0537662
CC
784
785 for (; result; result = result->next) {
786 const unsigned char *mb = result->item->object.sha1;
3c5ff995 787 if (!hashcmp(mb, current_bad_oid->hash)) {
c0537662 788 handle_bad_merge_base();
902bb364 789 } else if (0 <= sha1_array_lookup(&good_revs, mb)) {
c0537662 790 continue;
902bb364 791 } else if (0 <= sha1_array_lookup(&skipped_revs, mb)) {
c0537662
CC
792 handle_skipped_merge_base(mb);
793 } else {
794 printf("Bisecting: a merge base must be tested\n");
fee92fc1 795 exit(bisect_checkout(sha1_to_hex(mb), no_checkout));
c0537662
CC
796 }
797 }
798
799 free(rev);
800 free_commit_list(result);
801}
802
2d938fc7 803static int check_ancestors(const char *prefix)
d937d4ac 804{
2d938fc7
CC
805 struct rev_info revs;
806 struct object_array pending_copy;
86a0a408 807 int res;
d937d4ac 808
2d938fc7 809 bisect_rev_setup(&revs, prefix, "^%s", "%s", 0);
d937d4ac 810
2d938fc7 811 /* Save pending objects, so they can be cleaned up later. */
353f5657
RS
812 pending_copy = revs.pending;
813 revs.leak_pending = 1;
2d938fc7 814
353f5657
RS
815 /*
816 * bisect_common calls prepare_revision_walk right away, which
817 * (together with .leak_pending = 1) makes us the sole owner of
818 * the list of pending objects.
819 */
2d938fc7
CC
820 bisect_common(&revs);
821 res = (revs.commits != NULL);
822
823 /* Clean up objects used, as they will be reused. */
86a0a408 824 clear_commit_marks_for_object_array(&pending_copy, ALL_REV_FLAGS);
353f5657 825 free(pending_copy.objects);
d937d4ac 826
2d938fc7 827 return res;
d937d4ac
CC
828}
829
830/*
831 * "check_good_are_ancestors_of_bad" checks that all "good" revs are
832 * ancestor of the "bad" rev.
833 *
834 * If that's not the case, we need to check the merge bases.
835 * If a merge base must be tested by the user, its source code will be
836 * checked out to be tested by the user and we will exit.
837 */
fee92fc1 838static void check_good_are_ancestors_of_bad(const char *prefix, int no_checkout)
d937d4ac 839{
d292bfaf 840 char *filename = git_pathdup("BISECT_ANCESTORS_OK");
d937d4ac
CC
841 struct stat st;
842 int fd;
843
3c5ff995 844 if (!current_bad_oid)
d937d4ac
CC
845 die("a bad revision is needed");
846
847 /* Check if file BISECT_ANCESTORS_OK exists. */
848 if (!stat(filename, &st) && S_ISREG(st.st_mode))
144e7090 849 goto done;
d937d4ac
CC
850
851 /* Bisecting with no good rev is ok. */
902bb364 852 if (good_revs.nr == 0)
144e7090 853 goto done;
d937d4ac 854
2d938fc7
CC
855 /* Check if all good revs are ancestor of the bad rev. */
856 if (check_ancestors(prefix))
fee92fc1 857 check_merge_bases(no_checkout);
d937d4ac
CC
858
859 /* Create file BISECT_ANCESTORS_OK. */
860 fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
861 if (fd < 0)
862 warning("could not create file '%s': %s",
863 filename, strerror(errno));
864 else
865 close(fd);
144e7090
MH
866 done:
867 free(filename);
d937d4ac
CC
868}
869
e22278c0
CC
870/*
871 * This does "git diff-tree --pretty COMMIT" without one fork+exec.
872 */
873static void show_diff_tree(const char *prefix, struct commit *commit)
874{
875 struct rev_info opt;
876
877 /* diff-tree init */
878 init_revisions(&opt, prefix);
879 git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
880 opt.abbrev = 0;
881 opt.diff = 1;
882
883 /* This is what "--pretty" does */
884 opt.verbose_header = 1;
885 opt.use_terminator = 0;
886 opt.commit_format = CMIT_FMT_DEFAULT;
887
888 /* diff-tree init */
889 if (!opt.diffopt.output_format)
890 opt.diffopt.output_format = DIFF_FORMAT_RAW;
891
892 log_tree_commit(&opt, commit);
893}
894
ef24c7ca
CC
895/*
896 * We use the convention that exiting with an exit code 10 means that
897 * the bisection process finished successfully.
898 * In this case the calling shell script should exit 0.
fee92fc1
JS
899 *
900 * If no_checkout is non-zero, the bisection process does not
901 * checkout the trial commit but instead simply updates BISECT_HEAD.
ef24c7ca 902 */
fee92fc1 903int bisect_next_all(const char *prefix, int no_checkout)
ef24c7ca
CC
904{
905 struct rev_info revs;
906 struct commit_list *tried;
6329bade 907 int reaches = 0, all = 0, nr, steps;
ef24c7ca 908 const unsigned char *bisect_rev;
3c5ff995 909 char bisect_rev_hex[GIT_SHA1_HEXSZ + 1];
ef24c7ca 910
2b020695
CC
911 if (read_bisect_refs())
912 die("reading bisect refs failed");
913
fee92fc1 914 check_good_are_ancestors_of_bad(prefix, no_checkout);
0871984d 915
a22347c6
CC
916 bisect_rev_setup(&revs, prefix, "%s", "^%s", 1);
917 revs.limited = 1;
2b020695 918
a22347c6 919 bisect_common(&revs);
ef24c7ca 920
a22347c6 921 revs.commits = find_bisection(revs.commits, &reaches, &all,
902bb364 922 !!skipped_revs.nr);
62d0b0da 923 revs.commits = managed_skipped(revs.commits, &tried);
ef24c7ca
CC
924
925 if (!revs.commits) {
926 /*
927 * We should exit here only if the "bad"
928 * commit is also a "skip" commit.
929 */
930 exit_if_skipped_commits(tried, NULL);
931
932 printf("%s was both good and bad\n",
3c5ff995 933 oid_to_hex(current_bad_oid));
ef24c7ca
CC
934 exit(1);
935 }
936
8f69f72f
CC
937 if (!all) {
938 fprintf(stderr, "No testable commit found.\n"
939 "Maybe you started with bad path parameters?\n");
940 exit(4);
941 }
942
ef24c7ca 943 bisect_rev = revs.commits->item->object.sha1;
3c5ff995 944 memcpy(bisect_rev_hex, sha1_to_hex(bisect_rev), GIT_SHA1_HEXSZ + 1);
ef24c7ca 945
3c5ff995 946 if (!hashcmp(bisect_rev, current_bad_oid->hash)) {
947 exit_if_skipped_commits(tried, current_bad_oid);
21d0bc2f 948 printf("%s is the first bad commit\n", bisect_rev_hex);
e22278c0 949 show_diff_tree(prefix, revs.commits->item);
ef24c7ca
CC
950 /* This means the bisection process succeeded. */
951 exit(10);
952 }
953
954 nr = all - reaches - 1;
6329bade
DR
955 steps = estimate_bisect_steps(all);
956 printf("Bisecting: %d revision%s left to test after this "
957 "(roughly %d step%s)\n", nr, (nr == 1 ? "" : "s"),
958 steps, (steps == 1 ? "" : "s"));
ef24c7ca 959
fee92fc1 960 return bisect_checkout(bisect_rev_hex, no_checkout);
ef24c7ca
CC
961}
962
c43cb386
NTND
963static inline int log2i(int n)
964{
965 int log2 = 0;
966
967 for (; n > 1; n >>= 1)
968 log2++;
969
970 return log2;
971}
972
973static inline int exp2i(int n)
974{
975 return 1 << n;
976}
977
978/*
979 * Estimate the number of bisect steps left (after the current step)
980 *
981 * For any x between 0 included and 2^n excluded, the probability for
982 * n - 1 steps left looks like:
983 *
984 * P(2^n + x) == (2^n - x) / (2^n + x)
985 *
986 * and P(2^n + x) < 0.5 means 2^n < 3x
987 */
988int estimate_bisect_steps(int all)
989{
990 int n, x, e;
991
992 if (all < 3)
993 return 0;
994
995 n = log2i(all);
996 e = exp2i(n);
997 x = all - e;
998
999 return (e < 3 * x) ? n : n - 1;
1000}