blob: ec7487e6836c7ec5819f0b22cc7b08bce0e59fa0 [file] [log] [blame]
Christian Coudera2ad79c2009-03-26 05:55:24 +01001#include "cache.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -07002#include "config.h"
Christian Coudera2ad79c2009-03-26 05:55:24 +01003#include "commit.h"
4#include "diff.h"
5#include "revision.h"
Christian Couder1bf072e2009-03-26 05:55:54 +01006#include "refs.h"
7#include "list-objects.h"
Christian Couder3b437b02009-03-26 05:55:59 +01008#include "quote.h"
Martin Ågrenbc626922020-12-31 12:56:23 +01009#include "hash-lookup.h"
Christian Couderef24c7c2009-04-19 11:56:07 +020010#include "run-command.h"
Christian Coudere22278c2009-05-28 23:21:16 +020011#include "log-tree.h"
Christian Coudera2ad79c2009-03-26 05:55:24 +010012#include "bisect.h"
Jeff Kingfe299ec2020-03-30 10:03:46 -040013#include "oid-array.h"
Jeff Kingdbbcd442020-07-28 16:23:39 -040014#include "strvec.h"
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +020015#include "commit-slab.h"
Derrick Stolee64043552018-07-20 16:33:04 +000016#include "commit-reach.h"
Nguyễn Thái Ngọc Duyb0eb92b2018-09-02 09:42:50 +020017#include "object-store.h"
Aaron Lipmane8861ff2020-08-07 17:58:37 -040018#include "dir.h"
Christian Couder6212b1a2009-05-09 17:55:38 +020019
brian m. carlson910650d2017-03-31 01:40:00 +000020static struct oid_array good_revs;
21static struct oid_array skipped_revs;
Christian Couder1bf072e2009-03-26 05:55:54 +010022
brian m. carlson3c5ff992015-03-13 23:39:29 +000023static struct object_id *current_bad_oid;
Christian Couderef24c7c2009-04-19 11:56:07 +020024
Antoine Delaite43f9d9f2015-06-29 17:40:29 +020025static const char *term_bad;
26static const char *term_good;
27
Nguyễn Thái Ngọc Duy208acbf2014-03-25 20:23:26 +070028/* Remember to update object flag allocation in object.h */
Christian Coudera2ad79c2009-03-26 05:55:24 +010029#define COUNTED (1u<<16)
30
31/*
32 * This is a truly stupid algorithm, but it's only
33 * used for bisection, and we just don't care enough.
34 *
35 * We care just barely enough to avoid recursing for
36 * non-merge entries.
37 */
38static int count_distance(struct commit_list *entry)
39{
40 int nr = 0;
41
42 while (entry) {
43 struct commit *commit = entry->item;
44 struct commit_list *p;
45
46 if (commit->object.flags & (UNINTERESTING | COUNTED))
47 break;
48 if (!(commit->object.flags & TREESAME))
49 nr++;
50 commit->object.flags |= COUNTED;
51 p = commit->parents;
52 entry = p;
53 if (p) {
54 p = p->next;
55 while (p) {
56 nr += count_distance(p);
57 p = p->next;
58 }
59 }
60 }
61
62 return nr;
63}
64
65static void clear_distance(struct commit_list *list)
66{
67 while (list) {
68 struct commit *commit = list->item;
69 commit->object.flags &= ~COUNTED;
70 list = list->next;
71 }
72}
73
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +020074define_commit_slab(commit_weight, int *);
75static struct commit_weight commit_weight;
76
Christian Coudera2ad79c2009-03-26 05:55:24 +010077#define DEBUG_BISECT 0
78
79static inline int weight(struct commit_list *elem)
80{
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +020081 return **commit_weight_at(&commit_weight, elem->item);
Christian Coudera2ad79c2009-03-26 05:55:24 +010082}
83
84static inline void weight_set(struct commit_list *elem, int weight)
85{
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +020086 **commit_weight_at(&commit_weight, elem->item) = weight;
Christian Coudera2ad79c2009-03-26 05:55:24 +010087}
88
Aaron Lipmanad464a42020-08-07 17:58:38 -040089static int count_interesting_parents(struct commit *commit, unsigned bisect_flags)
Christian Coudera2ad79c2009-03-26 05:55:24 +010090{
91 struct commit_list *p;
92 int count;
93
94 for (count = 0, p = commit->parents; p; p = p->next) {
Aaron Lipman0fe305a2020-08-07 17:58:35 -040095 if (!(p->item->object.flags & UNINTERESTING))
96 count++;
Aaron Lipmanad464a42020-08-07 17:58:38 -040097 if (bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY)
Aaron Lipman0fe305a2020-08-07 17:58:35 -040098 break;
Christian Coudera2ad79c2009-03-26 05:55:24 +010099 }
100 return count;
101}
102
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100103static inline int approx_halfway(struct commit_list *p, int nr)
Christian Coudera2ad79c2009-03-26 05:55:24 +0100104{
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100105 int diff;
106
Christian Coudera2ad79c2009-03-26 05:55:24 +0100107 /*
108 * Don't short-cut something we are not going to return!
109 */
110 if (p->item->object.flags & TREESAME)
111 return 0;
112 if (DEBUG_BISECT)
113 return 0;
114 /*
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100115 * For small number of commits 2 and 3 are halfway of 5, and
Christian Coudera2ad79c2009-03-26 05:55:24 +0100116 * 3 is halfway of 6 but 2 and 4 are not.
117 */
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100118 diff = 2 * weight(p) - nr;
119 switch (diff) {
Christian Coudera2ad79c2009-03-26 05:55:24 +0100120 case -1: case 0: case 1:
121 return 1;
122 default:
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100123 /*
124 * For large number of commits we are not so strict, it's
125 * good enough if it's within ~0.1% of the halfway point,
126 * e.g. 5000 is exactly halfway of 10000, but we consider
127 * the values [4996, 5004] as halfway as well.
128 */
129 if (abs(diff) < nr / 1024)
130 return 1;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100131 return 0;
132 }
133}
134
Christian Coudera2ad79c2009-03-26 05:55:24 +0100135static void show_list(const char *debug, int counted, int nr,
136 struct commit_list *list)
137{
138 struct commit_list *p;
139
Nguyễn Thái Ngọc Duyb0eb92b2018-09-02 09:42:50 +0200140 if (!DEBUG_BISECT)
141 return;
142
Christian Coudera2ad79c2009-03-26 05:55:24 +0100143 fprintf(stderr, "%s (%d/%d)\n", debug, counted, nr);
144
145 for (p = list; p; p = p->next) {
146 struct commit_list *pp;
147 struct commit *commit = p->item;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400148 unsigned commit_flags = commit->object.flags;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100149 enum object_type type;
150 unsigned long size;
brian m. carlsonb4f5aca2018-03-12 02:27:53 +0000151 char *buf = read_object_file(&commit->object.oid, &type,
152 &size);
Christian Couder56ff3792010-07-22 15:18:33 +0200153 const char *subject_start;
154 int subject_len;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100155
156 fprintf(stderr, "%c%c%c ",
Aaron Lipmanad464a42020-08-07 17:58:38 -0400157 (commit_flags & TREESAME) ? ' ' : 'T',
158 (commit_flags & UNINTERESTING) ? 'U' : ' ',
159 (commit_flags & COUNTED) ? 'C' : ' ');
Nguyễn Thái Ngọc Duyb0eb92b2018-09-02 09:42:50 +0200160 if (*commit_weight_at(&commit_weight, p->item))
Christian Coudera2ad79c2009-03-26 05:55:24 +0100161 fprintf(stderr, "%3d", weight(p));
162 else
163 fprintf(stderr, "---");
René Scharfe14ced552018-03-25 12:57:36 +0200164 fprintf(stderr, " %.*s", 8, oid_to_hex(&commit->object.oid));
Christian Coudera2ad79c2009-03-26 05:55:24 +0100165 for (pp = commit->parents; pp; pp = pp->next)
166 fprintf(stderr, " %.*s", 8,
René Scharfe14ced552018-03-25 12:57:36 +0200167 oid_to_hex(&pp->item->object.oid));
Christian Coudera2ad79c2009-03-26 05:55:24 +0100168
Christian Couder56ff3792010-07-22 15:18:33 +0200169 subject_len = find_commit_subject(buf, &subject_start);
170 if (subject_len)
171 fprintf(stderr, " %.*s", subject_len, subject_start);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100172 fprintf(stderr, "\n");
173 }
174}
Christian Coudera2ad79c2009-03-26 05:55:24 +0100175
176static struct commit_list *best_bisection(struct commit_list *list, int nr)
177{
178 struct commit_list *p, *best;
179 int best_distance = -1;
180
181 best = list;
182 for (p = list; p; p = p->next) {
183 int distance;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400184 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100185
Aaron Lipmanad464a42020-08-07 17:58:38 -0400186 if (commit_flags & TREESAME)
Christian Coudera2ad79c2009-03-26 05:55:24 +0100187 continue;
188 distance = weight(p);
189 if (nr - distance < distance)
190 distance = nr - distance;
191 if (distance > best_distance) {
192 best = p;
193 best_distance = distance;
194 }
195 }
196
197 return best;
198}
199
200struct commit_dist {
201 struct commit *commit;
202 int distance;
203};
204
205static int compare_commit_dist(const void *a_, const void *b_)
206{
207 struct commit_dist *a, *b;
208
209 a = (struct commit_dist *)a_;
210 b = (struct commit_dist *)b_;
211 if (a->distance != b->distance)
212 return b->distance - a->distance; /* desc sort */
brian m. carlsonf2fd0762015-11-10 02:22:28 +0000213 return oidcmp(&a->commit->object.oid, &b->commit->object.oid);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100214}
215
216static struct commit_list *best_bisection_sorted(struct commit_list *list, int nr)
217{
218 struct commit_list *p;
219 struct commit_dist *array = xcalloc(nr, sizeof(*array));
Jeff King5b1ef2c2017-03-28 15:46:50 -0400220 struct strbuf buf = STRBUF_INIT;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100221 int cnt, i;
222
223 for (p = list, cnt = 0; p; p = p->next) {
224 int distance;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400225 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100226
Aaron Lipmanad464a42020-08-07 17:58:38 -0400227 if (commit_flags & TREESAME)
Christian Coudera2ad79c2009-03-26 05:55:24 +0100228 continue;
229 distance = weight(p);
230 if (nr - distance < distance)
231 distance = nr - distance;
232 array[cnt].commit = p->item;
233 array[cnt].distance = distance;
234 cnt++;
235 }
René Scharfe9ed0d8d2016-09-29 17:27:31 +0200236 QSORT(array, cnt, compare_commit_dist);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100237 for (p = list, i = 0; i < cnt; i++) {
Christian Coudera2ad79c2009-03-26 05:55:24 +0100238 struct object *obj = &(array[i].commit->object);
239
Jeff King5b1ef2c2017-03-28 15:46:50 -0400240 strbuf_reset(&buf);
241 strbuf_addf(&buf, "dist=%d", array[i].distance);
242 add_name_decoration(DECORATION_NONE, buf.buf, obj);
Jeff King662174d2014-08-26 06:23:36 -0400243
Christian Coudera2ad79c2009-03-26 05:55:24 +0100244 p->item = array[i].commit;
Martin Ågren7c117182017-11-05 21:24:30 +0100245 if (i < cnt - 1)
246 p = p->next;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100247 }
Ævar Arnfjörð Bjarmason2e9fdc72018-01-03 18:48:52 +0000248 if (p) {
249 free_commit_list(p->next);
250 p->next = NULL;
251 }
Jeff King5b1ef2c2017-03-28 15:46:50 -0400252 strbuf_release(&buf);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100253 free(array);
254 return list;
255}
256
257/*
258 * zero or positive weight is the number of interesting commits it can
259 * reach, including itself. Especially, weight = 0 means it does not
260 * reach any tree-changing commits (e.g. just above uninteresting one
261 * but traversal is with pathspec).
262 *
263 * weight = -1 means it has one parent and its distance is yet to
264 * be computed.
265 *
266 * weight = -2 means it has more than one parent and its distance is
267 * unknown. After running count_distance() first, they will get zero
268 * or positive distance.
269 */
270static struct commit_list *do_find_bisection(struct commit_list *list,
271 int nr, int *weights,
Aaron Lipmanad464a42020-08-07 17:58:38 -0400272 unsigned bisect_flags)
Christian Coudera2ad79c2009-03-26 05:55:24 +0100273{
274 int n, counted;
275 struct commit_list *p;
276
277 counted = 0;
278
279 for (n = 0, p = list; p; p = p->next) {
280 struct commit *commit = p->item;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400281 unsigned commit_flags = commit->object.flags;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100282
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +0200283 *commit_weight_at(&commit_weight, p->item) = &weights[n++];
Aaron Lipmanad464a42020-08-07 17:58:38 -0400284 switch (count_interesting_parents(commit, bisect_flags)) {
Christian Coudera2ad79c2009-03-26 05:55:24 +0100285 case 0:
Aaron Lipmanad464a42020-08-07 17:58:38 -0400286 if (!(commit_flags & TREESAME)) {
Christian Coudera2ad79c2009-03-26 05:55:24 +0100287 weight_set(p, 1);
288 counted++;
289 show_list("bisection 2 count one",
290 counted, nr, list);
291 }
292 /*
293 * otherwise, it is known not to reach any
294 * tree-changing commit and gets weight 0.
295 */
296 break;
297 case 1:
298 weight_set(p, -1);
299 break;
300 default:
301 weight_set(p, -2);
302 break;
303 }
304 }
305
306 show_list("bisection 2 initialize", counted, nr, list);
307
308 /*
309 * If you have only one parent in the resulting set
310 * then you can reach one commit more than that parent
311 * can reach. So we do not have to run the expensive
312 * count_distance() for single strand of pearls.
313 *
314 * However, if you have more than one parents, you cannot
315 * just add their distance and one for yourself, since
316 * they usually reach the same ancestor and you would
317 * end up counting them twice that way.
318 *
319 * So we will first count distance of merges the usual
320 * way, and then fill the blanks using cheaper algorithm.
321 */
322 for (p = list; p; p = p->next) {
323 if (p->item->object.flags & UNINTERESTING)
324 continue;
325 if (weight(p) != -2)
326 continue;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400327 if (bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY)
Aaron Lipman0fe305a2020-08-07 17:58:35 -0400328 BUG("shouldn't be calling count-distance in fp mode");
Christian Coudera2ad79c2009-03-26 05:55:24 +0100329 weight_set(p, count_distance(p));
330 clear_distance(list);
331
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100332 /* Does it happen to be at half-way? */
333 if (!(bisect_flags & FIND_BISECTION_ALL) &&
334 approx_halfway(p, nr))
Christian Coudera2ad79c2009-03-26 05:55:24 +0100335 return p;
336 counted++;
337 }
338
339 show_list("bisection 2 count_distance", counted, nr, list);
340
341 while (counted < nr) {
342 for (p = list; p; p = p->next) {
343 struct commit_list *q;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400344 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100345
346 if (0 <= weight(p))
347 continue;
Aaron Lipman0fe305a2020-08-07 17:58:35 -0400348
349 for (q = p->item->parents;
350 q;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400351 q = bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY ? NULL : q->next) {
Christian Coudera2ad79c2009-03-26 05:55:24 +0100352 if (q->item->object.flags & UNINTERESTING)
353 continue;
354 if (0 <= weight(q))
355 break;
356 }
357 if (!q)
358 continue;
359
360 /*
361 * weight for p is unknown but q is known.
362 * add one for p itself if p is to be counted,
363 * otherwise inherit it from q directly.
364 */
Aaron Lipmanad464a42020-08-07 17:58:38 -0400365 if (!(commit_flags & TREESAME)) {
Christian Coudera2ad79c2009-03-26 05:55:24 +0100366 weight_set(p, weight(q)+1);
367 counted++;
368 show_list("bisection 2 count one",
369 counted, nr, list);
370 }
371 else
372 weight_set(p, weight(q));
373
SZEDER Gábor0afcea72020-11-12 17:19:38 +0100374 /* Does it happen to be at half-way? */
375 if (!(bisect_flags & FIND_BISECTION_ALL) &&
376 approx_halfway(p, nr))
Christian Coudera2ad79c2009-03-26 05:55:24 +0100377 return p;
378 }
379 }
380
381 show_list("bisection 2 counted all", counted, nr, list);
382
Aaron Lipmanad464a42020-08-07 17:58:38 -0400383 if (!(bisect_flags & FIND_BISECTION_ALL))
Christian Coudera2ad79c2009-03-26 05:55:24 +0100384 return best_bisection(list, nr);
385 else
386 return best_bisection_sorted(list, nr);
387}
388
Martin Ågren24d707f2017-11-05 21:24:28 +0100389void find_bisection(struct commit_list **commit_list, int *reaches,
Aaron Lipmanad464a42020-08-07 17:58:38 -0400390 int *all, unsigned bisect_flags)
Christian Coudera2ad79c2009-03-26 05:55:24 +0100391{
392 int nr, on_list;
Martin Ågren24d707f2017-11-05 21:24:28 +0100393 struct commit_list *list, *p, *best, *next, *last;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100394 int *weights;
395
Martin Ågren24d707f2017-11-05 21:24:28 +0100396 show_list("bisection 2 entry", 0, 0, *commit_list);
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +0200397 init_commit_weight(&commit_weight);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100398
399 /*
400 * Count the number of total and tree-changing items on the
401 * list, while reversing the list.
402 */
Martin Ågren24d707f2017-11-05 21:24:28 +0100403 for (nr = on_list = 0, last = NULL, p = *commit_list;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100404 p;
405 p = next) {
Aaron Lipmanad464a42020-08-07 17:58:38 -0400406 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100407
408 next = p->next;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400409 if (commit_flags & UNINTERESTING) {
Martin Ågrenfc5c40b2017-11-05 21:24:29 +0100410 free(p);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100411 continue;
Martin Ågrenfc5c40b2017-11-05 21:24:29 +0100412 }
Christian Coudera2ad79c2009-03-26 05:55:24 +0100413 p->next = last;
414 last = p;
Aaron Lipmanad464a42020-08-07 17:58:38 -0400415 if (!(commit_flags & TREESAME))
Christian Coudera2ad79c2009-03-26 05:55:24 +0100416 nr++;
417 on_list++;
418 }
419 list = last;
420 show_list("bisection 2 sorted", 0, nr, list);
421
422 *all = nr;
René Scharfeca56dad2021-03-13 17:17:22 +0100423 CALLOC_ARRAY(weights, on_list);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100424
425 /* Do the real work of finding bisection commit. */
Aaron Lipmanad464a42020-08-07 17:58:38 -0400426 best = do_find_bisection(list, nr, weights, bisect_flags);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100427 if (best) {
Aaron Lipmanad464a42020-08-07 17:58:38 -0400428 if (!(bisect_flags & FIND_BISECTION_ALL)) {
Martin Ågrenf4e45cb2017-11-05 21:24:31 +0100429 list->item = best->item;
430 free_commit_list(list->next);
431 best = list;
Christian Coudera2ad79c2009-03-26 05:55:24 +0100432 best->next = NULL;
Martin Ågrenf4e45cb2017-11-05 21:24:31 +0100433 }
Christian Coudera2ad79c2009-03-26 05:55:24 +0100434 *reaches = weight(best);
435 }
436 free(weights);
Martin Ågren24d707f2017-11-05 21:24:28 +0100437 *commit_list = best;
Nguyễn Thái Ngọc Duybb408ac2018-05-19 07:28:25 +0200438 clear_commit_weight(&commit_weight);
Christian Coudera2ad79c2009-03-26 05:55:24 +0100439}
440
Michael Haggertyeed25142015-05-25 18:38:31 +0000441static int register_ref(const char *refname, const struct object_id *oid,
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +0200442 int flags UNUSED, void *cb_data UNUSED)
Christian Couder1bf072e2009-03-26 05:55:54 +0100443{
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200444 struct strbuf good_prefix = STRBUF_INIT;
445 strbuf_addstr(&good_prefix, term_good);
446 strbuf_addstr(&good_prefix, "-");
447
448 if (!strcmp(refname, term_bad)) {
brian m. carlson3c5ff992015-03-13 23:39:29 +0000449 current_bad_oid = xmalloc(sizeof(*current_bad_oid));
Michael Haggertyeed25142015-05-25 18:38:31 +0000450 oidcpy(current_bad_oid, oid);
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200451 } else if (starts_with(refname, good_prefix.buf)) {
brian m. carlson910650d2017-03-31 01:40:00 +0000452 oid_array_append(&good_revs, oid);
Christian Couder59556542013-11-30 21:55:40 +0100453 } else if (starts_with(refname, "skip-")) {
brian m. carlson910650d2017-03-31 01:40:00 +0000454 oid_array_append(&skipped_revs, oid);
Christian Couder1bf072e2009-03-26 05:55:54 +0100455 }
456
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200457 strbuf_release(&good_prefix);
458
Christian Couder1bf072e2009-03-26 05:55:54 +0100459 return 0;
460}
461
462static int read_bisect_refs(void)
463{
Michael Haggertyeed25142015-05-25 18:38:31 +0000464 return for_each_ref_in("refs/bisect/", register_ref, NULL);
Christian Couder1bf072e2009-03-26 05:55:54 +0100465}
466
Jeff Kingf9327292015-08-10 05:38:57 -0400467static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
468static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
Pranit Bauvafb71a322017-09-29 06:49:39 +0000469static GIT_PATH_FUNC(git_path_bisect_ancestors_ok, "BISECT_ANCESTORS_OK")
470static GIT_PATH_FUNC(git_path_bisect_run, "BISECT_RUN")
471static GIT_PATH_FUNC(git_path_bisect_start, "BISECT_START")
472static GIT_PATH_FUNC(git_path_bisect_log, "BISECT_LOG")
Jeff Kingf5d284f2017-04-20 17:08:25 -0400473static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS")
Aaron Lipmane8861ff2020-08-07 17:58:37 -0400474static GIT_PATH_FUNC(git_path_bisect_first_parent, "BISECT_FIRST_PARENT")
Pranit Bauvafb71a322017-09-29 06:49:39 +0000475static GIT_PATH_FUNC(git_path_head_name, "head-name")
Jeff Kingf9327292015-08-10 05:38:57 -0400476
Jeff Kingef8d7ac2020-07-28 16:24:53 -0400477static void read_bisect_paths(struct strvec *array)
Christian Couder3b437b02009-03-26 05:55:59 +0100478{
479 struct strbuf str = STRBUF_INIT;
Jeff Kingf9327292015-08-10 05:38:57 -0400480 const char *filename = git_path_bisect_names();
Nguyễn Thái Ngọc Duy23a9e072017-05-03 17:16:46 +0700481 FILE *fp = xfopen(filename, "r");
Christian Couder3b437b02009-03-26 05:55:59 +0100482
Junio C Hamano8f309ae2016-01-13 15:31:17 -0800483 while (strbuf_getline_lf(&str, fp) != EOF) {
Christian Couder3b437b02009-03-26 05:55:59 +0100484 strbuf_trim(&str);
Jeff King2745b6b2020-07-28 16:24:02 -0400485 if (sq_dequote_to_strvec(str.buf, array))
Vasco Almeida14dc4892016-06-17 20:21:12 +0000486 die(_("Badly quoted content in file '%s': %s"),
Jeff King8a534b62011-09-13 17:58:14 -0400487 filename, str.buf);
Christian Couder3b437b02009-03-26 05:55:59 +0100488 }
489
490 strbuf_release(&str);
491 fclose(fp);
492}
493
Jeff King7383b252020-03-30 10:04:06 -0400494static char *join_oid_array_hex(struct oid_array *array, char delim)
Christian Couderc0537662009-05-09 17:55:45 +0200495{
496 struct strbuf joined_hexs = STRBUF_INIT;
497 int i;
498
Jeff King902bb362011-05-19 17:34:33 -0400499 for (i = 0; i < array->nr; i++) {
brian m. carlsonee3051b2017-03-26 16:01:37 +0000500 strbuf_addstr(&joined_hexs, oid_to_hex(array->oid + i));
Jeff King902bb362011-05-19 17:34:33 -0400501 if (i + 1 < array->nr)
Christian Couderc0537662009-05-09 17:55:45 +0200502 strbuf_addch(&joined_hexs, delim);
503 }
504
505 return strbuf_detach(&joined_hexs, NULL);
506}
507
Christian Couder9af35892009-06-06 06:41:33 +0200508/*
509 * In this function, passing a not NULL skipped_first is very special.
510 * It means that we want to know if the first commit in the list is
511 * skipped because we will want to test a commit away from it if it is
512 * indeed skipped.
513 * So if the first commit is skipped, we cannot take the shortcut to
514 * just "return list" when we find the first non skipped commit, we
515 * have to return a fully filtered list.
516 *
517 * We use (*skipped_first == -1) to mean "it has been found that the
518 * first commit is not skipped". In this case *skipped_first is set back
519 * to 0 just before the function returns.
520 */
Christian Couder95188642009-03-26 05:55:49 +0100521struct commit_list *filter_skipped(struct commit_list *list,
522 struct commit_list **tried,
Christian Couder9af35892009-06-06 06:41:33 +0200523 int show_all,
524 int *count,
525 int *skipped_first)
Christian Couder95188642009-03-26 05:55:49 +0100526{
527 struct commit_list *filtered = NULL, **f = &filtered;
528
529 *tried = NULL;
530
Christian Couder9af35892009-06-06 06:41:33 +0200531 if (skipped_first)
532 *skipped_first = 0;
533 if (count)
534 *count = 0;
535
Jeff King902bb362011-05-19 17:34:33 -0400536 if (!skipped_revs.nr)
Christian Couder95188642009-03-26 05:55:49 +0100537 return list;
538
Christian Couder95188642009-03-26 05:55:49 +0100539 while (list) {
540 struct commit_list *next = list->next;
541 list->next = NULL;
brian m. carlson910650d2017-03-31 01:40:00 +0000542 if (0 <= oid_array_lookup(&skipped_revs, &list->item->object.oid)) {
Christian Couder9af35892009-06-06 06:41:33 +0200543 if (skipped_first && !*skipped_first)
544 *skipped_first = 1;
Christian Couder95188642009-03-26 05:55:49 +0100545 /* Move current to tried list */
546 *tried = list;
547 tried = &list->next;
548 } else {
Christian Couder9af35892009-06-06 06:41:33 +0200549 if (!show_all) {
550 if (!skipped_first || !*skipped_first)
551 return list;
552 } else if (skipped_first && !*skipped_first) {
553 /* This means we know it's not skipped */
554 *skipped_first = -1;
555 }
Christian Couder95188642009-03-26 05:55:49 +0100556 /* Move current to filtered list */
557 *f = list;
558 f = &list->next;
Christian Couder9af35892009-06-06 06:41:33 +0200559 if (count)
560 (*count)++;
Christian Couder95188642009-03-26 05:55:49 +0100561 }
562 list = next;
563 }
564
Christian Couder9af35892009-06-06 06:41:33 +0200565 if (skipped_first && *skipped_first == -1)
566 *skipped_first = 0;
567
Christian Couder95188642009-03-26 05:55:49 +0100568 return filtered;
569}
Christian Couder1bf072e2009-03-26 05:55:54 +0100570
Christian Couderebc95292009-06-13 07:21:06 +0200571#define PRN_MODULO 32768
572
573/*
574 * This is a pseudo random number generator based on "man 3 rand".
575 * It is not used properly because the seed is the argument and it
576 * is increased by one between each call, but that should not matter
577 * for this application.
578 */
Nguyễn Thái Ngọc Duy3b335762018-12-09 11:25:21 +0100579static unsigned get_prn(unsigned count)
580{
Christian Couderebc95292009-06-13 07:21:06 +0200581 count = count * 1103515245 + 12345;
John Keeping7b96d882013-04-03 20:17:55 +0100582 return (count/65536) % PRN_MODULO;
Christian Couderebc95292009-06-13 07:21:06 +0200583}
584
585/*
586 * Custom integer square root from
Sven Strickroth5e687292017-05-13 11:54:51 +0200587 * https://en.wikipedia.org/wiki/Integer_square_root
Christian Couderebc95292009-06-13 07:21:06 +0200588 */
589static int sqrti(int val)
Christian Couder62d0b0d2009-06-06 06:41:34 +0200590{
Christian Couderebc95292009-06-13 07:21:06 +0200591 float d, x = val;
592
Miriam Rubiob8e3b2f2020-02-17 09:40:30 +0100593 if (!val)
Christian Couderebc95292009-06-13 07:21:06 +0200594 return 0;
595
596 do {
597 float y = (x + (float)val / x) / 2;
598 d = (y > x) ? y - x : x - y;
599 x = y;
600 } while (d >= 0.5);
601
602 return (int)x;
603}
604
605static struct commit_list *skip_away(struct commit_list *list, int count)
606{
Christian Couder62d0b0d2009-06-06 06:41:34 +0200607 struct commit_list *cur, *previous;
Christian Couderebc95292009-06-13 07:21:06 +0200608 int prn, index, i;
609
610 prn = get_prn(count);
611 index = (count * prn / PRN_MODULO) * sqrti(prn) / sqrti(PRN_MODULO);
Christian Couder62d0b0d2009-06-06 06:41:34 +0200612
613 cur = list;
614 previous = NULL;
Christian Couder62d0b0d2009-06-06 06:41:34 +0200615
616 for (i = 0; cur; cur = cur->next, i++) {
617 if (i == index) {
Jeff King9001dc22018-08-28 17:22:48 -0400618 if (!oideq(&cur->item->object.oid, current_bad_oid))
Christian Couder62d0b0d2009-06-06 06:41:34 +0200619 return cur;
620 if (previous)
621 return previous;
622 return list;
623 }
624 previous = cur;
625 }
626
627 return list;
628}
629
630static struct commit_list *managed_skipped(struct commit_list *list,
631 struct commit_list **tried)
632{
633 int count, skipped_first;
Christian Couder62d0b0d2009-06-06 06:41:34 +0200634
635 *tried = NULL;
636
Jeff King902bb362011-05-19 17:34:33 -0400637 if (!skipped_revs.nr)
Christian Couder62d0b0d2009-06-06 06:41:34 +0200638 return list;
639
640 list = filter_skipped(list, tried, 0, &count, &skipped_first);
641
642 if (!skipped_first)
643 return list;
644
Christian Couderebc95292009-06-13 07:21:06 +0200645 return skip_away(list, count);
Christian Couder62d0b0d2009-06-06 06:41:34 +0200646}
647
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100648static void bisect_rev_setup(struct repository *r, struct rev_info *revs,
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200649 struct strvec *rev_argv,
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100650 const char *prefix,
Christian Coudera22347c2009-05-17 17:36:44 +0200651 const char *bad_format, const char *good_format,
652 int read_paths)
Christian Couder1bf072e2009-03-26 05:55:54 +0100653{
Ævar Arnfjörð Bjarmasonf92dbdb2022-08-02 17:33:16 +0200654 struct setup_revision_opt opt = {
655 .free_removed_argv_elements = 1,
656 };
Christian Couderfad2d312009-05-09 17:55:40 +0200657 int i;
658
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100659 repo_init_revisions(r, revs, prefix);
Christian Couder3b437b02009-03-26 05:55:59 +0100660 revs->abbrev = 0;
661 revs->commit_format = CMIT_FMT_UNSPECIFIED;
Christian Couder1bf072e2009-03-26 05:55:54 +0100662
Christian Couder1c953a12009-05-09 17:55:41 +0200663 /* rev_argv.argv[0] will be ignored by setup_revisions */
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200664 strvec_push(rev_argv, "bisect_rev_setup");
665 strvec_pushf(rev_argv, bad_format, oid_to_hex(current_bad_oid));
Jeff King902bb362011-05-19 17:34:33 -0400666 for (i = 0; i < good_revs.nr; i++)
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200667 strvec_pushf(rev_argv, good_format,
Jeff Kingf6d89422020-07-28 16:26:31 -0400668 oid_to_hex(good_revs.oid + i));
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200669 strvec_push(rev_argv, "--");
Christian Coudera22347c2009-05-17 17:36:44 +0200670 if (read_paths)
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200671 read_bisect_paths(rev_argv);
Christian Couder1bf072e2009-03-26 05:55:54 +0100672
Ævar Arnfjörð Bjarmasonf92dbdb2022-08-02 17:33:16 +0200673 setup_revisions(rev_argv->nr, rev_argv->v, revs, &opt);
Christian Couder3b437b02009-03-26 05:55:59 +0100674}
675
Christian Coudera22347c2009-05-17 17:36:44 +0200676static void bisect_common(struct rev_info *revs)
Christian Couder2ace9722009-04-19 11:55:57 +0200677{
Christian Couder2ace9722009-04-19 11:55:57 +0200678 if (prepare_revision_walk(revs))
679 die("revision walk setup failed");
680 if (revs->tree_objects)
Derrick Stolee4f6d26b2019-01-16 10:25:58 -0800681 mark_edges_uninteresting(revs, NULL, 0);
Christian Couder2ace9722009-04-19 11:55:57 +0200682}
683
Pranit Bauvace58b5d2020-02-17 09:40:34 +0100684static enum bisect_error error_if_skipped_commits(struct commit_list *tried,
brian m. carlson3c5ff992015-03-13 23:39:29 +0000685 const struct object_id *bad)
Christian Couderef24c7c2009-04-19 11:56:07 +0200686{
687 if (!tried)
Pranit Bauvace58b5d2020-02-17 09:40:34 +0100688 return BISECT_OK;
Christian Couderef24c7c2009-04-19 11:56:07 +0200689
690 printf("There are only 'skip'ped commits left to test.\n"
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200691 "The first %s commit could be any of:\n", term_bad);
Junio C Hamano54307ea2016-07-08 10:09:28 -0700692
693 for ( ; tried; tried = tried->next)
694 printf("%s\n", oid_to_hex(&tried->item->object.oid));
695
Christian Couderef24c7c2009-04-19 11:56:07 +0200696 if (bad)
brian m. carlson3c5ff992015-03-13 23:39:29 +0000697 printf("%s\n", oid_to_hex(bad));
Vasco Almeida14dc4892016-06-17 20:21:12 +0000698 printf(_("We cannot bisect more!\n"));
Pranit Bauvace58b5d2020-02-17 09:40:34 +0100699
700 return BISECT_ONLY_SKIPPED_LEFT;
Christian Couderef24c7c2009-04-19 11:56:07 +0200701}
702
brian m. carlson3c5ff992015-03-13 23:39:29 +0000703static int is_expected_rev(const struct object_id *oid)
Christian Couderc0537662009-05-09 17:55:45 +0200704{
Jeff Kingf9327292015-08-10 05:38:57 -0400705 const char *filename = git_path_bisect_expected_rev();
Christian Couderc0537662009-05-09 17:55:45 +0200706 struct stat st;
707 struct strbuf str = STRBUF_INIT;
708 FILE *fp;
709 int res = 0;
710
711 if (stat(filename, &st) || !S_ISREG(st.st_mode))
712 return 0;
713
Nguyễn Thái Ngọc Duye9d983f2017-05-03 17:16:50 +0700714 fp = fopen_or_warn(filename, "r");
Christian Couderc0537662009-05-09 17:55:45 +0200715 if (!fp)
716 return 0;
717
Junio C Hamano8f309ae2016-01-13 15:31:17 -0800718 if (strbuf_getline_lf(&str, fp) != EOF)
brian m. carlson3c5ff992015-03-13 23:39:29 +0000719 res = !strcmp(str.buf, oid_to_hex(oid));
Christian Couderc0537662009-05-09 17:55:45 +0200720
721 strbuf_release(&str);
722 fclose(fp);
723
724 return res;
725}
726
René Scharfe48af1fd2022-01-18 13:46:32 +0100727enum bisect_error bisect_checkout(const struct object_id *bisect_rev,
728 int no_checkout)
Christian Couderef24c7c2009-04-19 11:56:07 +0200729{
Junio C Hamanoffcb4e92021-07-27 11:22:18 -0700730 struct commit *commit;
731 struct pretty_print_context pp = {0};
732 struct strbuf commit_msg = STRBUF_INIT;
Christian Couderef24c7c2009-04-19 11:56:07 +0200733
brian m. carlsonae077772017-10-15 22:06:51 +0000734 update_ref(NULL, "BISECT_EXPECTED_REV", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
Christian Couderef24c7c2009-04-19 11:56:07 +0200735
Jon Seymourfee92fc2011-08-04 22:01:00 +1000736 if (no_checkout) {
brian m. carlsonae077772017-10-15 22:06:51 +0000737 update_ref(NULL, "BISECT_HEAD", bisect_rev, NULL, 0,
738 UPDATE_REFS_DIE_ON_ERR);
Jon Seymourfee92fc2011-08-04 22:01:00 +1000739 } else {
René Scharfeddbb47f2022-10-30 12:55:06 +0100740 struct child_process cmd = CHILD_PROCESS_INIT;
René Scharfe48750b22022-10-30 12:47:02 +0100741
René Scharfeddbb47f2022-10-30 12:55:06 +0100742 cmd.git_cmd = 1;
743 strvec_pushl(&cmd.args, "checkout", "-q",
744 oid_to_hex(bisect_rev), "--", NULL);
745 if (run_command(&cmd))
Pranit Bauvae8e3ce62020-02-17 09:40:35 +0100746 /*
747 * Errors in `run_command()` itself, signaled by res < 0,
748 * and errors in the child process, signaled by res > 0
Junio C Hamano1fcc40c2021-07-28 10:07:02 -0700749 * can both be treated as regular BISECT_FAILED (-1).
Pranit Bauvae8e3ce62020-02-17 09:40:35 +0100750 */
Junio C Hamano1fcc40c2021-07-28 10:07:02 -0700751 return BISECT_FAILED;
Jon Seymourfee92fc2011-08-04 22:01:00 +1000752 }
Christian Couderef24c7c2009-04-19 11:56:07 +0200753
Junio C Hamanoffcb4e92021-07-27 11:22:18 -0700754 commit = lookup_commit_reference(the_repository, bisect_rev);
755 format_commit_message(commit, "[%H] %s%n", &commit_msg, &pp);
756 fputs(commit_msg.buf, stdout);
757 strbuf_release(&commit_msg);
758
Junio C Hamano1fcc40c2021-07-28 10:07:02 -0700759 return BISECT_OK;
Christian Couderef24c7c2009-04-19 11:56:07 +0200760}
761
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100762static struct commit *get_commit_reference(struct repository *r,
763 const struct object_id *oid)
Christian Couderc0537662009-05-09 17:55:45 +0200764{
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100765 struct commit *c = lookup_commit_reference(r, oid);
766 if (!c)
brian m. carlsonee3051b2017-03-26 16:01:37 +0000767 die(_("Not a valid commit name %s"), oid_to_hex(oid));
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100768 return c;
Christian Couderc0537662009-05-09 17:55:45 +0200769}
770
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100771static struct commit **get_bad_and_good_commits(struct repository *r,
772 int *rev_nr)
Christian Couderc0537662009-05-09 17:55:45 +0200773{
Jeff Kingb32fa952016-02-22 17:44:25 -0500774 struct commit **rev;
Christian Couderc0537662009-05-09 17:55:45 +0200775 int i, n = 0;
776
Jeff Kingb32fa952016-02-22 17:44:25 -0500777 ALLOC_ARRAY(rev, 1 + good_revs.nr);
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100778 rev[n++] = get_commit_reference(r, current_bad_oid);
Jeff King902bb362011-05-19 17:34:33 -0400779 for (i = 0; i < good_revs.nr; i++)
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100780 rev[n++] = get_commit_reference(r, good_revs.oid + i);
Christian Couderc0537662009-05-09 17:55:45 +0200781 *rev_nr = n;
782
783 return rev;
784}
785
Pranit Bauva9ec598e2020-02-17 09:40:38 +0100786static enum bisect_error handle_bad_merge_base(void)
Christian Couderc0537662009-05-09 17:55:45 +0200787{
brian m. carlson3c5ff992015-03-13 23:39:29 +0000788 if (is_expected_rev(current_bad_oid)) {
789 char *bad_hex = oid_to_hex(current_bad_oid);
Jeff King7383b252020-03-30 10:04:06 -0400790 char *good_hex = join_oid_array_hex(&good_revs, ' ');
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200791 if (!strcmp(term_bad, "bad") && !strcmp(term_good, "good")) {
Vasco Almeida14dc4892016-06-17 20:21:12 +0000792 fprintf(stderr, _("The merge base %s is bad.\n"
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200793 "This means the bug has been fixed "
Vasco Almeida14dc4892016-06-17 20:21:12 +0000794 "between %s and [%s].\n"),
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200795 bad_hex, bad_hex, good_hex);
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200796 } else if (!strcmp(term_bad, "new") && !strcmp(term_good, "old")) {
Vasco Almeida14dc4892016-06-17 20:21:12 +0000797 fprintf(stderr, _("The merge base %s is new.\n"
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200798 "The property has changed "
Vasco Almeida14dc4892016-06-17 20:21:12 +0000799 "between %s and [%s].\n"),
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200800 bad_hex, bad_hex, good_hex);
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200801 } else {
Vasco Almeida14dc4892016-06-17 20:21:12 +0000802 fprintf(stderr, _("The merge base %s is %s.\n"
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200803 "This means the first '%s' commit is "
Vasco Almeida14dc4892016-06-17 20:21:12 +0000804 "between %s and [%s].\n"),
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200805 bad_hex, term_bad, term_good, bad_hex, good_hex);
806 }
Pranit Bauva9ec598e2020-02-17 09:40:38 +0100807 return BISECT_MERGE_BASE_CHECK;
Christian Couderc0537662009-05-09 17:55:45 +0200808 }
809
Alex Henrie3f407b72016-12-04 15:04:23 -0700810 fprintf(stderr, _("Some %s revs are not ancestors of the %s rev.\n"
Christian Couderc0537662009-05-09 17:55:45 +0200811 "git bisect cannot work properly in this case.\n"
Vasco Almeida14dc4892016-06-17 20:21:12 +0000812 "Maybe you mistook %s and %s revs?\n"),
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200813 term_good, term_bad, term_good, term_bad);
Pranit Bauva9ec598e2020-02-17 09:40:38 +0100814 return BISECT_FAILED;
Christian Couderc0537662009-05-09 17:55:45 +0200815}
816
brian m. carlson4ce36212017-03-31 01:39:57 +0000817static void handle_skipped_merge_base(const struct object_id *mb)
Christian Couderc0537662009-05-09 17:55:45 +0200818{
brian m. carlson4ce36212017-03-31 01:39:57 +0000819 char *mb_hex = oid_to_hex(mb);
brian m. carlsonc368dde2016-06-24 23:09:22 +0000820 char *bad_hex = oid_to_hex(current_bad_oid);
Jeff King7383b252020-03-30 10:04:06 -0400821 char *good_hex = join_oid_array_hex(&good_revs, ' ');
Christian Couderc0537662009-05-09 17:55:45 +0200822
Vasco Almeida14dc4892016-06-17 20:21:12 +0000823 warning(_("the merge base between %s and [%s] "
Christian Couderc0537662009-05-09 17:55:45 +0200824 "must be skipped.\n"
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200825 "So we cannot be sure the first %s commit is "
Christian Couderc0537662009-05-09 17:55:45 +0200826 "between %s and %s.\n"
Vasco Almeida14dc4892016-06-17 20:21:12 +0000827 "We continue anyway."),
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200828 bad_hex, good_hex, term_bad, mb_hex, bad_hex);
Christian Couderc0537662009-05-09 17:55:45 +0200829 free(good_hex);
830}
831
832/*
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200833 * "check_merge_bases" checks that merge bases are not "bad" (or "new").
Christian Couderc0537662009-05-09 17:55:45 +0200834 *
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200835 * - If one is "bad" (or "new"), it means the user assumed something wrong
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100836 * and we must return error with a non 0 error code.
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200837 * - If one is "good" (or "old"), that's good, we have nothing to do.
Christian Couderc0537662009-05-09 17:55:45 +0200838 * - If one is "skipped", we can't know but we should warn.
839 * - If we don't know, we should check it out and ask the user to test.
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100840 * - If a merge base must be tested, on success return
841 * BISECT_INTERNAL_SUCCESS_MERGE_BASE (-11) a special condition
842 * for early success, this will be converted back to 0 in
843 * check_good_are_ancestors_of_bad().
Christian Couderc0537662009-05-09 17:55:45 +0200844 */
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100845static enum bisect_error check_merge_bases(int rev_nr, struct commit **rev, int no_checkout)
Christian Couderc0537662009-05-09 17:55:45 +0200846{
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100847 enum bisect_error res = BISECT_OK;
Christian Couderc0537662009-05-09 17:55:45 +0200848 struct commit_list *result;
Christian Couderc0537662009-05-09 17:55:45 +0200849
Junio C Hamano2ce406c2014-10-30 12:20:44 -0700850 result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1);
Christian Couderc0537662009-05-09 17:55:45 +0200851
852 for (; result; result = result->next) {
brian m. carlson4ce36212017-03-31 01:39:57 +0000853 const struct object_id *mb = &result->item->object.oid;
Jeff King4a7e27e2018-08-28 17:22:40 -0400854 if (oideq(mb, current_bad_oid)) {
Pranit Bauva9ec598e2020-02-17 09:40:38 +0100855 res = handle_bad_merge_base();
856 break;
brian m. carlson910650d2017-03-31 01:40:00 +0000857 } else if (0 <= oid_array_lookup(&good_revs, mb)) {
Christian Couderc0537662009-05-09 17:55:45 +0200858 continue;
brian m. carlson910650d2017-03-31 01:40:00 +0000859 } else if (0 <= oid_array_lookup(&skipped_revs, mb)) {
Christian Couderc0537662009-05-09 17:55:45 +0200860 handle_skipped_merge_base(mb);
861 } else {
Vasco Almeida14dc4892016-06-17 20:21:12 +0000862 printf(_("Bisecting: a merge base must be tested\n"));
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100863 res = bisect_checkout(mb, no_checkout);
864 if (!res)
865 /* indicate early success */
866 res = BISECT_INTERNAL_SUCCESS_MERGE_BASE;
867 break;
Christian Couderc0537662009-05-09 17:55:45 +0200868 }
869 }
870
Christian Couderc0537662009-05-09 17:55:45 +0200871 free_commit_list(result);
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100872 return res;
Christian Couderc0537662009-05-09 17:55:45 +0200873}
874
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100875static int check_ancestors(struct repository *r, int rev_nr,
876 struct commit **rev, const char *prefix)
Christian Couderd937d4a2009-05-09 17:55:46 +0200877{
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200878 struct strvec rev_argv = STRVEC_INIT;
Christian Couder2d938fc2009-05-17 17:36:46 +0200879 struct rev_info revs;
René Scharfe86a0a402011-10-01 18:16:08 +0200880 int res;
Christian Couderd937d4a2009-05-09 17:55:46 +0200881
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200882 bisect_rev_setup(r, &revs, &rev_argv, prefix, "^%s", "%s", 0);
Christian Couderd937d4a2009-05-09 17:55:46 +0200883
Christian Couder2d938fc2009-05-17 17:36:46 +0200884 bisect_common(&revs);
885 res = (revs.commits != NULL);
886
887 /* Clean up objects used, as they will be reused. */
René Scharfe148f14a2017-12-25 18:45:36 +0100888 clear_commit_marks_many(rev_nr, rev, ALL_REV_FLAGS);
Christian Couderd937d4a2009-05-09 17:55:46 +0200889
Ævar Arnfjörð Bjarmason2108fe42022-04-13 22:01:36 +0200890 release_revisions(&revs);
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +0200891 strvec_clear(&rev_argv);
Christian Couder2d938fc2009-05-17 17:36:46 +0200892 return res;
Christian Couderd937d4a2009-05-09 17:55:46 +0200893}
894
895/*
896 * "check_good_are_ancestors_of_bad" checks that all "good" revs are
897 * ancestor of the "bad" rev.
898 *
899 * If that's not the case, we need to check the merge bases.
900 * If a merge base must be tested by the user, its source code will be
Pranit Bauva45b63702020-02-17 09:40:37 +0100901 * checked out to be tested by the user and we will return.
Christian Couderd937d4a2009-05-09 17:55:46 +0200902 */
Pranit Bauva45b63702020-02-17 09:40:37 +0100903
904static enum bisect_error check_good_are_ancestors_of_bad(struct repository *r,
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100905 const char *prefix,
906 int no_checkout)
Christian Couderd937d4a2009-05-09 17:55:46 +0200907{
Pranit Bauva45b63702020-02-17 09:40:37 +0100908 char *filename;
Christian Couderd937d4a2009-05-09 17:55:46 +0200909 struct stat st;
René Scharfe148f14a2017-12-25 18:45:36 +0100910 int fd, rev_nr;
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100911 enum bisect_error res = BISECT_OK;
René Scharfe148f14a2017-12-25 18:45:36 +0100912 struct commit **rev;
Christian Couderd937d4a2009-05-09 17:55:46 +0200913
brian m. carlson3c5ff992015-03-13 23:39:29 +0000914 if (!current_bad_oid)
Pranit Bauva45b63702020-02-17 09:40:37 +0100915 return error(_("a %s revision is needed"), term_bad);
916
917 filename = git_pathdup("BISECT_ANCESTORS_OK");
Christian Couderd937d4a2009-05-09 17:55:46 +0200918
919 /* Check if file BISECT_ANCESTORS_OK exists. */
920 if (!stat(filename, &st) && S_ISREG(st.st_mode))
Michael Haggerty144e7092012-04-27 00:26:59 +0200921 goto done;
Christian Couderd937d4a2009-05-09 17:55:46 +0200922
923 /* Bisecting with no good rev is ok. */
Miriam Rubiob8e3b2f2020-02-17 09:40:30 +0100924 if (!good_revs.nr)
Michael Haggerty144e7092012-04-27 00:26:59 +0200925 goto done;
Christian Couderd937d4a2009-05-09 17:55:46 +0200926
Christian Couder2d938fc2009-05-17 17:36:46 +0200927 /* Check if all good revs are ancestor of the bad rev. */
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100928
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100929 rev = get_bad_and_good_commits(r, &rev_nr);
930 if (check_ancestors(r, rev_nr, rev, prefix))
Pranit Bauvacdd4dc22020-02-17 09:40:36 +0100931 res = check_merge_bases(rev_nr, rev, no_checkout);
René Scharfe148f14a2017-12-25 18:45:36 +0100932 free(rev);
Christian Couderd937d4a2009-05-09 17:55:46 +0200933
Pranit Bauva45b63702020-02-17 09:40:37 +0100934 if (!res) {
935 /* Create file BISECT_ANCESTORS_OK. */
936 fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
937 if (fd < 0)
938 /*
939 * BISECT_ANCESTORS_OK file is not absolutely necessary,
940 * the bisection process will continue at the next
941 * bisection step.
942 * So, just signal with a warning that something
943 * might be wrong.
944 */
945 warning_errno(_("could not create file '%s'"),
946 filename);
947 else
948 close(fd);
949 }
Michael Haggerty144e7092012-04-27 00:26:59 +0200950 done:
951 free(filename);
Pranit Bauva45b63702020-02-17 09:40:37 +0100952 return res;
Christian Couderd937d4a2009-05-09 17:55:46 +0200953}
954
955/*
Christian Coudere22278c2009-05-28 23:21:16 +0200956 * This does "git diff-tree --pretty COMMIT" without one fork+exec.
957 */
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +0100958static void show_diff_tree(struct repository *r,
959 const char *prefix,
960 struct commit *commit)
Christian Coudere22278c2009-05-28 23:21:16 +0200961{
Jeff King2008f292019-02-22 01:20:37 -0500962 const char *argv[] = {
Jeff Kingb02be8b2019-02-22 01:23:28 -0500963 "diff-tree", "--pretty", "--stat", "--summary", "--cc", NULL
Jeff King2008f292019-02-22 01:20:37 -0500964 };
Christian Coudere22278c2009-05-28 23:21:16 +0200965 struct rev_info opt;
966
Jeff Kingb02be8b2019-02-22 01:23:28 -0500967 git_config(git_diff_ui_config, NULL);
Jeff King40ae3d32019-02-22 01:21:33 -0500968 repo_init_revisions(r, &opt, prefix);
Christian Coudere22278c2009-05-28 23:21:16 +0200969
Jeff King2008f292019-02-22 01:20:37 -0500970 setup_revisions(ARRAY_SIZE(argv) - 1, argv, &opt, NULL);
Christian Coudere22278c2009-05-28 23:21:16 +0200971 log_tree_commit(&opt, commit);
Ævar Arnfjörð Bjarmason2108fe42022-04-13 22:01:36 +0200972 release_revisions(&opt);
Christian Coudere22278c2009-05-28 23:21:16 +0200973}
974
975/*
Antoine Delaitecb46d632015-06-29 17:40:30 +0200976 * The terms used for this bisect session are stored in BISECT_TERMS.
977 * We read them and store them to adapt the messages accordingly.
978 * Default is bad/good.
979 */
980void read_bisect_terms(const char **read_bad, const char **read_good)
981{
982 struct strbuf str = STRBUF_INIT;
Jeff Kingf5d284f2017-04-20 17:08:25 -0400983 const char *filename = git_path_bisect_terms();
Antoine Delaitecb46d632015-06-29 17:40:30 +0200984 FILE *fp = fopen(filename, "r");
985
986 if (!fp) {
987 if (errno == ENOENT) {
988 *read_bad = "bad";
989 *read_good = "good";
990 return;
991 } else {
Vasco Almeida14dc4892016-06-17 20:21:12 +0000992 die_errno(_("could not read file '%s'"), filename);
Antoine Delaitecb46d632015-06-29 17:40:30 +0200993 }
994 } else {
Junio C Hamano8f309ae2016-01-13 15:31:17 -0800995 strbuf_getline_lf(&str, fp);
Antoine Delaitecb46d632015-06-29 17:40:30 +0200996 *read_bad = strbuf_detach(&str, NULL);
Junio C Hamano8f309ae2016-01-13 15:31:17 -0800997 strbuf_getline_lf(&str, fp);
Antoine Delaitecb46d632015-06-29 17:40:30 +0200998 *read_good = strbuf_detach(&str, NULL);
999 }
1000 strbuf_release(&str);
1001 fclose(fp);
1002}
1003
1004/*
Pranit Bauva6c69f222020-02-17 09:40:39 +01001005 * We use the convention that return BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND (-10) means
Christian Couderef24c7c2009-04-19 11:56:07 +02001006 * the bisection process finished successfully.
Pranit Bauva6c69f222020-02-17 09:40:39 +01001007 * In this case the calling function or command should not turn a
1008 * BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND return code into an error or a non zero exit code.
Pranit Bauva517ecb32020-09-24 14:33:40 +02001009 *
1010 * Checking BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND
1011 * in bisect_helper::bisect_next() and only transforming it to 0 at
1012 * the end of bisect_helper::cmd_bisect__helper() helps bypassing
1013 * all the code related to finding a commit to test.
Christian Couderef24c7c2009-04-19 11:56:07 +02001014 */
Aaron Lipmanbe5fe202020-08-07 17:58:36 -04001015enum bisect_error bisect_next_all(struct repository *r, const char *prefix)
Christian Couderef24c7c2009-04-19 11:56:07 +02001016{
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +02001017 struct strvec rev_argv = STRVEC_INIT;
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001018 struct rev_info revs = REV_INFO_INIT;
Christian Couderef24c7c2009-04-19 11:56:07 +02001019 struct commit_list *tried;
David Ripton6329bad2010-01-19 07:13:33 -08001020 int reaches = 0, all = 0, nr, steps;
Pranit Bauvace58b5d2020-02-17 09:40:34 +01001021 enum bisect_error res = BISECT_OK;
brian m. carlson4be0dee2017-07-13 23:49:24 +00001022 struct object_id *bisect_rev;
Maxim Moseychuk2cfa8352017-02-16 20:07:12 +03001023 char *steps_msg;
Pranit Bauva517ecb32020-09-24 14:33:40 +02001024 /*
1025 * If no_checkout is non-zero, the bisection process does not
1026 * checkout the trial commit but instead simply updates BISECT_HEAD.
1027 */
Aaron Lipmanbe5fe202020-08-07 17:58:36 -04001028 int no_checkout = ref_exists("BISECT_HEAD");
Aaron Lipmanad464a42020-08-07 17:58:38 -04001029 unsigned bisect_flags = 0;
Christian Couderef24c7c2009-04-19 11:56:07 +02001030
Antoine Delaitecb46d632015-06-29 17:40:30 +02001031 read_bisect_terms(&term_bad, &term_good);
Christian Couder2b020692009-05-09 17:55:42 +02001032 if (read_bisect_refs())
Vasco Almeida14dc4892016-06-17 20:21:12 +00001033 die(_("reading bisect refs failed"));
Christian Couder2b020692009-05-09 17:55:42 +02001034
Aaron Lipmanad464a42020-08-07 17:58:38 -04001035 if (file_exists(git_path_bisect_first_parent()))
1036 bisect_flags |= FIND_BISECTION_FIRST_PARENT_ONLY;
1037
1038 if (skipped_revs.nr)
1039 bisect_flags |= FIND_BISECTION_ALL;
1040
Pranit Bauva45b63702020-02-17 09:40:37 +01001041 res = check_good_are_ancestors_of_bad(r, prefix, no_checkout);
1042 if (res)
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001043 goto cleanup;
Christian Couder08719842009-05-09 17:55:47 +02001044
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +02001045 bisect_rev_setup(r, &revs, &rev_argv, prefix, "%s", "^%s", 1);
Aaron Lipmanad464a42020-08-07 17:58:38 -04001046
1047 revs.first_parent_only = !!(bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY);
Christian Coudera22347c2009-05-17 17:36:44 +02001048 revs.limited = 1;
Christian Couder2b020692009-05-09 17:55:42 +02001049
Christian Coudera22347c2009-05-17 17:36:44 +02001050 bisect_common(&revs);
Christian Couderef24c7c2009-04-19 11:56:07 +02001051
Aaron Lipmanad464a42020-08-07 17:58:38 -04001052 find_bisection(&revs.commits, &reaches, &all, bisect_flags);
Christian Couder62d0b0d2009-06-06 06:41:34 +02001053 revs.commits = managed_skipped(revs.commits, &tried);
Christian Couderef24c7c2009-04-19 11:56:07 +02001054
1055 if (!revs.commits) {
1056 /*
Pranit Bauva6c69f222020-02-17 09:40:39 +01001057 * We should return error here only if the "bad"
Christian Couderef24c7c2009-04-19 11:56:07 +02001058 * commit is also a "skip" commit.
1059 */
Pranit Bauvace58b5d2020-02-17 09:40:34 +01001060 res = error_if_skipped_commits(tried, NULL);
1061 if (res < 0)
Ævar Arnfjörð Bjarmasonc5365e92022-08-02 17:33:11 +02001062 goto cleanup;
Vasco Almeida14dc4892016-06-17 20:21:12 +00001063 printf(_("%s was both %s and %s\n"),
Antoine Delaite43f9d9f2015-06-29 17:40:29 +02001064 oid_to_hex(current_bad_oid),
1065 term_good,
1066 term_bad);
Pranit Bauva6c69f222020-02-17 09:40:39 +01001067
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001068 res = BISECT_FAILED;
1069 goto cleanup;
Christian Couderef24c7c2009-04-19 11:56:07 +02001070 }
1071
Christian Couder8f69f722010-02-28 23:19:09 +01001072 if (!all) {
Vasco Almeida14dc4892016-06-17 20:21:12 +00001073 fprintf(stderr, _("No testable commit found.\n"
Johannes Sixtb8657342021-02-23 22:11:32 +01001074 "Maybe you started with bad path arguments?\n"));
Pranit Bauva6c69f222020-02-17 09:40:39 +01001075
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001076 res = BISECT_NO_TESTABLE_COMMIT;
1077 goto cleanup;
Christian Couder8f69f722010-02-28 23:19:09 +01001078 }
1079
brian m. carlson4be0dee2017-07-13 23:49:24 +00001080 bisect_rev = &revs.commits->item->object.oid;
Christian Couderef24c7c2009-04-19 11:56:07 +02001081
Jeff King4a7e27e2018-08-28 17:22:40 -04001082 if (oideq(bisect_rev, current_bad_oid)) {
Pranit Bauvace58b5d2020-02-17 09:40:34 +01001083 res = error_if_skipped_commits(tried, current_bad_oid);
1084 if (res)
Pranit Bauva6c69f222020-02-17 09:40:39 +01001085 return res;
brian m. carlson4be0dee2017-07-13 23:49:24 +00001086 printf("%s is the first %s commit\n", oid_to_hex(bisect_rev),
Antoine Delaite43f9d9f2015-06-29 17:40:29 +02001087 term_bad);
Pranit Bauva6c69f222020-02-17 09:40:39 +01001088
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 06:48:59 +01001089 show_diff_tree(r, prefix, revs.commits->item);
Pranit Bauva6c69f222020-02-17 09:40:39 +01001090 /*
1091 * This means the bisection process succeeded.
1092 * Using BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND (-10)
1093 * so that the call chain can simply check
1094 * for negative return values for early returns up
1095 * until the cmd_bisect__helper() caller.
1096 */
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001097 res = BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND;
1098 goto cleanup;
Christian Couderef24c7c2009-04-19 11:56:07 +02001099 }
1100
1101 nr = all - reaches - 1;
David Ripton6329bad2010-01-19 07:13:33 -08001102 steps = estimate_bisect_steps(all);
Maxim Moseychuk2cfa8352017-02-16 20:07:12 +03001103
1104 steps_msg = xstrfmt(Q_("(roughly %d step)", "(roughly %d steps)",
1105 steps), steps);
Ævar Arnfjörð Bjarmason66f5f6d2017-05-11 21:20:12 +00001106 /*
1107 * TRANSLATORS: the last %s will be replaced with "(roughly %d
1108 * steps)" translation.
1109 */
Vasco Almeida14dc4892016-06-17 20:21:12 +00001110 printf(Q_("Bisecting: %d revision left to test after this %s\n",
1111 "Bisecting: %d revisions left to test after this %s\n",
1112 nr), nr, steps_msg);
Maxim Moseychuk2cfa8352017-02-16 20:07:12 +03001113 free(steps_msg);
Miriam Rubioc7a7f482020-09-24 14:33:39 +02001114 /* Clean up objects used, as they will be reused. */
René Scharfe0795df42020-10-31 13:47:58 +01001115 repo_clear_commit_marks(r, ALL_REV_FLAGS);
Christian Couderef24c7c2009-04-19 11:56:07 +02001116
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001117 res = bisect_checkout(bisect_rev, no_checkout);
1118cleanup:
1119 release_revisions(&revs);
Ævar Arnfjörð Bjarmason57efebb2022-08-02 17:33:15 +02001120 strvec_clear(&rev_argv);
Ævar Arnfjörð Bjarmasonf196c1e2022-04-13 22:01:38 +02001121 return res;
Christian Couderef24c7c2009-04-19 11:56:07 +02001122}
1123
Nguyễn Thái Ngọc Duyc43cb382012-10-26 22:53:50 +07001124static inline int log2i(int n)
1125{
1126 int log2 = 0;
1127
1128 for (; n > 1; n >>= 1)
1129 log2++;
1130
1131 return log2;
1132}
1133
1134static inline int exp2i(int n)
1135{
1136 return 1 << n;
1137}
1138
1139/*
1140 * Estimate the number of bisect steps left (after the current step)
1141 *
1142 * For any x between 0 included and 2^n excluded, the probability for
1143 * n - 1 steps left looks like:
1144 *
1145 * P(2^n + x) == (2^n - x) / (2^n + x)
1146 *
1147 * and P(2^n + x) < 0.5 means 2^n < 3x
1148 */
1149int estimate_bisect_steps(int all)
1150{
1151 int n, x, e;
1152
1153 if (all < 3)
1154 return 0;
1155
1156 n = log2i(all);
1157 e = exp2i(n);
1158 x = all - e;
1159
1160 return (e < 3 * x) ? n : n - 1;
1161}
Pranit Bauvafb71a322017-09-29 06:49:39 +00001162
Jeff King63e14ee2022-08-19 06:08:32 -04001163static int mark_for_removal(const char *refname,
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +02001164 const struct object_id *oid UNUSED,
1165 int flag UNUSED, void *cb_data)
Pranit Bauvafb71a322017-09-29 06:49:39 +00001166{
1167 struct string_list *refs = cb_data;
1168 char *ref = xstrfmt("refs/bisect%s", refname);
1169 string_list_append(refs, ref);
1170 return 0;
1171}
1172
1173int bisect_clean_state(void)
1174{
1175 int result = 0;
1176
1177 /* There may be some refs packed during bisection */
1178 struct string_list refs_for_removal = STRING_LIST_INIT_NODUP;
1179 for_each_ref_in("refs/bisect", mark_for_removal, (void *) &refs_for_removal);
1180 string_list_append(&refs_for_removal, xstrdup("BISECT_HEAD"));
Junio C Hamanoa9722292017-11-15 12:14:29 +09001181 result = delete_refs("bisect: remove", &refs_for_removal, REF_NO_DEREF);
Pranit Bauvafb71a322017-09-29 06:49:39 +00001182 refs_for_removal.strdup_strings = 1;
1183 string_list_clear(&refs_for_removal, 0);
1184 unlink_or_warn(git_path_bisect_expected_rev());
1185 unlink_or_warn(git_path_bisect_ancestors_ok());
1186 unlink_or_warn(git_path_bisect_log());
1187 unlink_or_warn(git_path_bisect_names());
1188 unlink_or_warn(git_path_bisect_run());
1189 unlink_or_warn(git_path_bisect_terms());
Aaron Lipmane8861ff2020-08-07 17:58:37 -04001190 unlink_or_warn(git_path_bisect_first_parent());
Pranit Bauvafb71a322017-09-29 06:49:39 +00001191 /* Cleanup head-name if it got left by an old version of git-bisect */
1192 unlink_or_warn(git_path_head_name());
1193 /*
1194 * Cleanup BISECT_START last to support the --no-checkout option
1195 * introduced in the commit 4796e823a.
1196 */
1197 unlink_or_warn(git_path_bisect_start());
1198
1199 return result;
1200}