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