🌐 AI搜索 & 代理 主页
blob: f5b13681288cc4a677e6531cc57ab0f3ee04b7ac [file] [log] [blame]
Christian Coudera2ad79c2009-03-26 04:55:241#include "cache.h"
Brandon Williamsb2141fc2017-06-14 18:07:362#include "config.h"
Christian Coudera2ad79c2009-03-26 04:55:243#include "commit.h"
4#include "diff.h"
5#include "revision.h"
Christian Couder1bf072e2009-03-26 04:55:546#include "refs.h"
7#include "list-objects.h"
Christian Couder3b437b02009-03-26 04:55:598#include "quote.h"
Christian Couder4eb5b642009-04-04 20:59:369#include "sha1-lookup.h"
Christian Couderef24c7c2009-04-19 09:56:0710#include "run-command.h"
Christian Coudere22278c2009-05-28 21:21:1611#include "log-tree.h"
Christian Coudera2ad79c2009-03-26 04:55:2412#include "bisect.h"
Jeff Kingfe299ec2020-03-30 14:03:4613#include "oid-array.h"
Jeff Kingdbbcd442020-07-28 20:23:3914#include "strvec.h"
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:2515#include "commit-slab.h"
Derrick Stolee64043552018-07-20 16:33:0416#include "commit-reach.h"
Nguyễn Thái Ngọc Duyb0eb92b2018-09-02 07:42:5017#include "object-store.h"
Aaron Lipmane8861ff2020-08-07 21:58:3718#include "dir.h"
Christian Couder6212b1a2009-05-09 15:55:3819
brian m. carlson910650d2017-03-31 01:40:0020static struct oid_array good_revs;
21static struct oid_array skipped_revs;
Christian Couder1bf072e2009-03-26 04:55:5422
brian m. carlson3c5ff992015-03-13 23:39:2923static struct object_id *current_bad_oid;
Christian Couderef24c7c2009-04-19 09:56:0724
Christian Couderef24c7c2009-04-19 09:56:0725static const char *argv_checkout[] = {"checkout", "-q", NULL, "--", NULL};
26static const char *argv_show_branch[] = {"show-branch", NULL, NULL};
27
Antoine Delaite43f9d9f2015-06-29 15:40:2928static const char *term_bad;
29static const char *term_good;
30
Nguyễn Thái Ngọc Duy208acbf2014-03-25 13:23:2631/* Remember to update object flag allocation in object.h */
Christian Coudera2ad79c2009-03-26 04:55:2432#define COUNTED (1u<<16)
33
34/*
35 * This is a truly stupid algorithm, but it's only
36 * used for bisection, and we just don't care enough.
37 *
38 * We care just barely enough to avoid recursing for
39 * non-merge entries.
40 */
41static int count_distance(struct commit_list *entry)
42{
43 int nr = 0;
44
45 while (entry) {
46 struct commit *commit = entry->item;
47 struct commit_list *p;
48
49 if (commit->object.flags & (UNINTERESTING | COUNTED))
50 break;
51 if (!(commit->object.flags & TREESAME))
52 nr++;
53 commit->object.flags |= COUNTED;
54 p = commit->parents;
55 entry = p;
56 if (p) {
57 p = p->next;
58 while (p) {
59 nr += count_distance(p);
60 p = p->next;
61 }
62 }
63 }
64
65 return nr;
66}
67
68static void clear_distance(struct commit_list *list)
69{
70 while (list) {
71 struct commit *commit = list->item;
72 commit->object.flags &= ~COUNTED;
73 list = list->next;
74 }
75}
76
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:2577define_commit_slab(commit_weight, int *);
78static struct commit_weight commit_weight;
79
Christian Coudera2ad79c2009-03-26 04:55:2480#define DEBUG_BISECT 0
81
82static inline int weight(struct commit_list *elem)
83{
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:2584 return **commit_weight_at(&commit_weight, elem->item);
Christian Coudera2ad79c2009-03-26 04:55:2485}
86
87static inline void weight_set(struct commit_list *elem, int weight)
88{
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:2589 **commit_weight_at(&commit_weight, elem->item) = weight;
Christian Coudera2ad79c2009-03-26 04:55:2490}
91
Aaron Lipmanad464a42020-08-07 21:58:3892static int count_interesting_parents(struct commit *commit, unsigned bisect_flags)
Christian Coudera2ad79c2009-03-26 04:55:2493{
94 struct commit_list *p;
95 int count;
96
97 for (count = 0, p = commit->parents; p; p = p->next) {
Aaron Lipman0fe305a2020-08-07 21:58:3598 if (!(p->item->object.flags & UNINTERESTING))
99 count++;
Aaron Lipmanad464a42020-08-07 21:58:38100 if (bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY)
Aaron Lipman0fe305a2020-08-07 21:58:35101 break;
Christian Coudera2ad79c2009-03-26 04:55:24102 }
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
Christian Coudera2ad79c2009-03-26 04:55:24127static void show_list(const char *debug, int counted, int nr,
128 struct commit_list *list)
129{
130 struct commit_list *p;
131
Nguyễn Thái Ngọc Duyb0eb92b2018-09-02 07:42:50132 if (!DEBUG_BISECT)
133 return;
134
Christian Coudera2ad79c2009-03-26 04:55:24135 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;
Aaron Lipmanad464a42020-08-07 21:58:38140 unsigned commit_flags = commit->object.flags;
Christian Coudera2ad79c2009-03-26 04:55:24141 enum object_type type;
142 unsigned long size;
brian m. carlsonb4f5aca2018-03-12 02:27:53143 char *buf = read_object_file(&commit->object.oid, &type,
144 &size);
Christian Couder56ff3792010-07-22 13:18:33145 const char *subject_start;
146 int subject_len;
Christian Coudera2ad79c2009-03-26 04:55:24147
148 fprintf(stderr, "%c%c%c ",
Aaron Lipmanad464a42020-08-07 21:58:38149 (commit_flags & TREESAME) ? ' ' : 'T',
150 (commit_flags & UNINTERESTING) ? 'U' : ' ',
151 (commit_flags & COUNTED) ? 'C' : ' ');
Nguyễn Thái Ngọc Duyb0eb92b2018-09-02 07:42:50152 if (*commit_weight_at(&commit_weight, p->item))
Christian Coudera2ad79c2009-03-26 04:55:24153 fprintf(stderr, "%3d", weight(p));
154 else
155 fprintf(stderr, "---");
René Scharfe14ced552018-03-25 10:57:36156 fprintf(stderr, " %.*s", 8, oid_to_hex(&commit->object.oid));
Christian Coudera2ad79c2009-03-26 04:55:24157 for (pp = commit->parents; pp; pp = pp->next)
158 fprintf(stderr, " %.*s", 8,
René Scharfe14ced552018-03-25 10:57:36159 oid_to_hex(&pp->item->object.oid));
Christian Coudera2ad79c2009-03-26 04:55:24160
Christian Couder56ff3792010-07-22 13:18:33161 subject_len = find_commit_subject(buf, &subject_start);
162 if (subject_len)
163 fprintf(stderr, " %.*s", subject_len, subject_start);
Christian Coudera2ad79c2009-03-26 04:55:24164 fprintf(stderr, "\n");
165 }
166}
Christian Coudera2ad79c2009-03-26 04:55:24167
168static struct commit_list *best_bisection(struct commit_list *list, int nr)
169{
170 struct commit_list *p, *best;
171 int best_distance = -1;
172
173 best = list;
174 for (p = list; p; p = p->next) {
175 int distance;
Aaron Lipmanad464a42020-08-07 21:58:38176 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 04:55:24177
Aaron Lipmanad464a42020-08-07 21:58:38178 if (commit_flags & TREESAME)
Christian Coudera2ad79c2009-03-26 04:55:24179 continue;
180 distance = weight(p);
181 if (nr - distance < distance)
182 distance = nr - distance;
183 if (distance > best_distance) {
184 best = p;
185 best_distance = distance;
186 }
187 }
188
189 return best;
190}
191
192struct commit_dist {
193 struct commit *commit;
194 int distance;
195};
196
197static int compare_commit_dist(const void *a_, const void *b_)
198{
199 struct commit_dist *a, *b;
200
201 a = (struct commit_dist *)a_;
202 b = (struct commit_dist *)b_;
203 if (a->distance != b->distance)
204 return b->distance - a->distance; /* desc sort */
brian m. carlsonf2fd0762015-11-10 02:22:28205 return oidcmp(&a->commit->object.oid, &b->commit->object.oid);
Christian Coudera2ad79c2009-03-26 04:55:24206}
207
208static struct commit_list *best_bisection_sorted(struct commit_list *list, int nr)
209{
210 struct commit_list *p;
211 struct commit_dist *array = xcalloc(nr, sizeof(*array));
Jeff King5b1ef2c2017-03-28 19:46:50212 struct strbuf buf = STRBUF_INIT;
Christian Coudera2ad79c2009-03-26 04:55:24213 int cnt, i;
214
215 for (p = list, cnt = 0; p; p = p->next) {
216 int distance;
Aaron Lipmanad464a42020-08-07 21:58:38217 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 04:55:24218
Aaron Lipmanad464a42020-08-07 21:58:38219 if (commit_flags & TREESAME)
Christian Coudera2ad79c2009-03-26 04:55:24220 continue;
221 distance = weight(p);
222 if (nr - distance < distance)
223 distance = nr - distance;
224 array[cnt].commit = p->item;
225 array[cnt].distance = distance;
226 cnt++;
227 }
René Scharfe9ed0d8d2016-09-29 15:27:31228 QSORT(array, cnt, compare_commit_dist);
Christian Coudera2ad79c2009-03-26 04:55:24229 for (p = list, i = 0; i < cnt; i++) {
Christian Coudera2ad79c2009-03-26 04:55:24230 struct object *obj = &(array[i].commit->object);
231
Jeff King5b1ef2c2017-03-28 19:46:50232 strbuf_reset(&buf);
233 strbuf_addf(&buf, "dist=%d", array[i].distance);
234 add_name_decoration(DECORATION_NONE, buf.buf, obj);
Jeff King662174d2014-08-26 10:23:36235
Christian Coudera2ad79c2009-03-26 04:55:24236 p->item = array[i].commit;
Martin Ågren7c117182017-11-05 20:24:30237 if (i < cnt - 1)
238 p = p->next;
Christian Coudera2ad79c2009-03-26 04:55:24239 }
Ævar Arnfjörð Bjarmason2e9fdc72018-01-03 18:48:52240 if (p) {
241 free_commit_list(p->next);
242 p->next = NULL;
243 }
Jeff King5b1ef2c2017-03-28 19:46:50244 strbuf_release(&buf);
Christian Coudera2ad79c2009-03-26 04:55:24245 free(array);
246 return list;
247}
248
249/*
250 * zero or positive weight is the number of interesting commits it can
251 * reach, including itself. Especially, weight = 0 means it does not
252 * reach any tree-changing commits (e.g. just above uninteresting one
253 * but traversal is with pathspec).
254 *
255 * weight = -1 means it has one parent and its distance is yet to
256 * be computed.
257 *
258 * weight = -2 means it has more than one parent and its distance is
259 * unknown. After running count_distance() first, they will get zero
260 * or positive distance.
261 */
262static struct commit_list *do_find_bisection(struct commit_list *list,
263 int nr, int *weights,
Aaron Lipmanad464a42020-08-07 21:58:38264 unsigned bisect_flags)
Christian Coudera2ad79c2009-03-26 04:55:24265{
266 int n, counted;
267 struct commit_list *p;
268
269 counted = 0;
270
271 for (n = 0, p = list; p; p = p->next) {
272 struct commit *commit = p->item;
Aaron Lipmanad464a42020-08-07 21:58:38273 unsigned commit_flags = commit->object.flags;
Christian Coudera2ad79c2009-03-26 04:55:24274
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:25275 *commit_weight_at(&commit_weight, p->item) = &weights[n++];
Aaron Lipmanad464a42020-08-07 21:58:38276 switch (count_interesting_parents(commit, bisect_flags)) {
Christian Coudera2ad79c2009-03-26 04:55:24277 case 0:
Aaron Lipmanad464a42020-08-07 21:58:38278 if (!(commit_flags & TREESAME)) {
Christian Coudera2ad79c2009-03-26 04:55:24279 weight_set(p, 1);
280 counted++;
281 show_list("bisection 2 count one",
282 counted, nr, list);
283 }
284 /*
285 * otherwise, it is known not to reach any
286 * tree-changing commit and gets weight 0.
287 */
288 break;
289 case 1:
290 weight_set(p, -1);
291 break;
292 default:
293 weight_set(p, -2);
294 break;
295 }
296 }
297
298 show_list("bisection 2 initialize", counted, nr, list);
299
300 /*
301 * If you have only one parent in the resulting set
302 * then you can reach one commit more than that parent
303 * can reach. So we do not have to run the expensive
304 * count_distance() for single strand of pearls.
305 *
306 * However, if you have more than one parents, you cannot
307 * just add their distance and one for yourself, since
308 * they usually reach the same ancestor and you would
309 * end up counting them twice that way.
310 *
311 * So we will first count distance of merges the usual
312 * way, and then fill the blanks using cheaper algorithm.
313 */
314 for (p = list; p; p = p->next) {
315 if (p->item->object.flags & UNINTERESTING)
316 continue;
317 if (weight(p) != -2)
318 continue;
Aaron Lipmanad464a42020-08-07 21:58:38319 if (bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY)
Aaron Lipman0fe305a2020-08-07 21:58:35320 BUG("shouldn't be calling count-distance in fp mode");
Christian Coudera2ad79c2009-03-26 04:55:24321 weight_set(p, count_distance(p));
322 clear_distance(list);
323
324 /* Does it happen to be at exactly half-way? */
Aaron Lipmanad464a42020-08-07 21:58:38325 if (!(bisect_flags & FIND_BISECTION_ALL) && halfway(p, nr))
Christian Coudera2ad79c2009-03-26 04:55:24326 return p;
327 counted++;
328 }
329
330 show_list("bisection 2 count_distance", counted, nr, list);
331
332 while (counted < nr) {
333 for (p = list; p; p = p->next) {
334 struct commit_list *q;
Aaron Lipmanad464a42020-08-07 21:58:38335 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 04:55:24336
337 if (0 <= weight(p))
338 continue;
Aaron Lipman0fe305a2020-08-07 21:58:35339
340 for (q = p->item->parents;
341 q;
Aaron Lipmanad464a42020-08-07 21:58:38342 q = bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY ? NULL : q->next) {
Christian Coudera2ad79c2009-03-26 04:55:24343 if (q->item->object.flags & UNINTERESTING)
344 continue;
345 if (0 <= weight(q))
346 break;
347 }
348 if (!q)
349 continue;
350
351 /*
352 * weight for p is unknown but q is known.
353 * add one for p itself if p is to be counted,
354 * otherwise inherit it from q directly.
355 */
Aaron Lipmanad464a42020-08-07 21:58:38356 if (!(commit_flags & TREESAME)) {
Christian Coudera2ad79c2009-03-26 04:55:24357 weight_set(p, weight(q)+1);
358 counted++;
359 show_list("bisection 2 count one",
360 counted, nr, list);
361 }
362 else
363 weight_set(p, weight(q));
364
365 /* Does it happen to be at exactly half-way? */
Aaron Lipmanad464a42020-08-07 21:58:38366 if (!(bisect_flags & FIND_BISECTION_ALL) && halfway(p, nr))
Christian Coudera2ad79c2009-03-26 04:55:24367 return p;
368 }
369 }
370
371 show_list("bisection 2 counted all", counted, nr, list);
372
Aaron Lipmanad464a42020-08-07 21:58:38373 if (!(bisect_flags & FIND_BISECTION_ALL))
Christian Coudera2ad79c2009-03-26 04:55:24374 return best_bisection(list, nr);
375 else
376 return best_bisection_sorted(list, nr);
377}
378
Martin Ågren24d707f2017-11-05 20:24:28379void find_bisection(struct commit_list **commit_list, int *reaches,
Aaron Lipmanad464a42020-08-07 21:58:38380 int *all, unsigned bisect_flags)
Christian Coudera2ad79c2009-03-26 04:55:24381{
382 int nr, on_list;
Martin Ågren24d707f2017-11-05 20:24:28383 struct commit_list *list, *p, *best, *next, *last;
Christian Coudera2ad79c2009-03-26 04:55:24384 int *weights;
385
Martin Ågren24d707f2017-11-05 20:24:28386 show_list("bisection 2 entry", 0, 0, *commit_list);
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:25387 init_commit_weight(&commit_weight);
Christian Coudera2ad79c2009-03-26 04:55:24388
389 /*
390 * Count the number of total and tree-changing items on the
391 * list, while reversing the list.
392 */
Martin Ågren24d707f2017-11-05 20:24:28393 for (nr = on_list = 0, last = NULL, p = *commit_list;
Christian Coudera2ad79c2009-03-26 04:55:24394 p;
395 p = next) {
Aaron Lipmanad464a42020-08-07 21:58:38396 unsigned commit_flags = p->item->object.flags;
Christian Coudera2ad79c2009-03-26 04:55:24397
398 next = p->next;
Aaron Lipmanad464a42020-08-07 21:58:38399 if (commit_flags & UNINTERESTING) {
Martin Ågrenfc5c40b2017-11-05 20:24:29400 free(p);
Christian Coudera2ad79c2009-03-26 04:55:24401 continue;
Martin Ågrenfc5c40b2017-11-05 20:24:29402 }
Christian Coudera2ad79c2009-03-26 04:55:24403 p->next = last;
404 last = p;
Aaron Lipmanad464a42020-08-07 21:58:38405 if (!(commit_flags & TREESAME))
Christian Coudera2ad79c2009-03-26 04:55:24406 nr++;
407 on_list++;
408 }
409 list = last;
410 show_list("bisection 2 sorted", 0, nr, list);
411
412 *all = nr;
413 weights = xcalloc(on_list, sizeof(*weights));
414
415 /* Do the real work of finding bisection commit. */
Aaron Lipmanad464a42020-08-07 21:58:38416 best = do_find_bisection(list, nr, weights, bisect_flags);
Christian Coudera2ad79c2009-03-26 04:55:24417 if (best) {
Aaron Lipmanad464a42020-08-07 21:58:38418 if (!(bisect_flags & FIND_BISECTION_ALL)) {
Martin Ågrenf4e45cb2017-11-05 20:24:31419 list->item = best->item;
420 free_commit_list(list->next);
421 best = list;
Christian Coudera2ad79c2009-03-26 04:55:24422 best->next = NULL;
Martin Ågrenf4e45cb2017-11-05 20:24:31423 }
Christian Coudera2ad79c2009-03-26 04:55:24424 *reaches = weight(best);
425 }
426 free(weights);
Martin Ågren24d707f2017-11-05 20:24:28427 *commit_list = best;
Nguyễn Thái Ngọc Duybb408ac2018-05-19 05:28:25428 clear_commit_weight(&commit_weight);
Christian Coudera2ad79c2009-03-26 04:55:24429}
430
Michael Haggertyeed25142015-05-25 18:38:31431static int register_ref(const char *refname, const struct object_id *oid,
Christian Couder1bf072e2009-03-26 04:55:54432 int flags, void *cb_data)
433{
Antoine Delaite43f9d9f2015-06-29 15:40:29434 struct strbuf good_prefix = STRBUF_INIT;
435 strbuf_addstr(&good_prefix, term_good);
436 strbuf_addstr(&good_prefix, "-");
437
438 if (!strcmp(refname, term_bad)) {
brian m. carlson3c5ff992015-03-13 23:39:29439 current_bad_oid = xmalloc(sizeof(*current_bad_oid));
Michael Haggertyeed25142015-05-25 18:38:31440 oidcpy(current_bad_oid, oid);
Antoine Delaite43f9d9f2015-06-29 15:40:29441 } else if (starts_with(refname, good_prefix.buf)) {
brian m. carlson910650d2017-03-31 01:40:00442 oid_array_append(&good_revs, oid);
Christian Couder59556542013-11-30 20:55:40443 } else if (starts_with(refname, "skip-")) {
brian m. carlson910650d2017-03-31 01:40:00444 oid_array_append(&skipped_revs, oid);
Christian Couder1bf072e2009-03-26 04:55:54445 }
446
Antoine Delaite43f9d9f2015-06-29 15:40:29447 strbuf_release(&good_prefix);
448
Christian Couder1bf072e2009-03-26 04:55:54449 return 0;
450}
451
452static int read_bisect_refs(void)
453{
Michael Haggertyeed25142015-05-25 18:38:31454 return for_each_ref_in("refs/bisect/", register_ref, NULL);
Christian Couder1bf072e2009-03-26 04:55:54455}
456
Jeff Kingf9327292015-08-10 09:38:57457static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
458static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
Pranit Bauvafb71a322017-09-29 06:49:39459static GIT_PATH_FUNC(git_path_bisect_ancestors_ok, "BISECT_ANCESTORS_OK")
460static GIT_PATH_FUNC(git_path_bisect_run, "BISECT_RUN")
461static GIT_PATH_FUNC(git_path_bisect_start, "BISECT_START")
462static GIT_PATH_FUNC(git_path_bisect_log, "BISECT_LOG")
Jeff Kingf5d284f2017-04-20 21:08:25463static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS")
Aaron Lipmane8861ff2020-08-07 21:58:37464static GIT_PATH_FUNC(git_path_bisect_first_parent, "BISECT_FIRST_PARENT")
Pranit Bauvafb71a322017-09-29 06:49:39465static GIT_PATH_FUNC(git_path_head_name, "head-name")
Jeff Kingf9327292015-08-10 09:38:57466
Jeff Kingef8d7ac2020-07-28 20:24:53467static void read_bisect_paths(struct strvec *array)
Christian Couder3b437b02009-03-26 04:55:59468{
469 struct strbuf str = STRBUF_INIT;
Jeff Kingf9327292015-08-10 09:38:57470 const char *filename = git_path_bisect_names();
Nguyễn Thái Ngọc Duy23a9e072017-05-03 10:16:46471 FILE *fp = xfopen(filename, "r");
Christian Couder3b437b02009-03-26 04:55:59472
Junio C Hamano8f309ae2016-01-13 23:31:17473 while (strbuf_getline_lf(&str, fp) != EOF) {
Christian Couder3b437b02009-03-26 04:55:59474 strbuf_trim(&str);
Jeff King2745b6b2020-07-28 20:24:02475 if (sq_dequote_to_strvec(str.buf, array))
Vasco Almeida14dc4892016-06-17 20:21:12476 die(_("Badly quoted content in file '%s': %s"),
Jeff King8a534b62011-09-13 21:58:14477 filename, str.buf);
Christian Couder3b437b02009-03-26 04:55:59478 }
479
480 strbuf_release(&str);
481 fclose(fp);
482}
483
Jeff King7383b252020-03-30 14:04:06484static char *join_oid_array_hex(struct oid_array *array, char delim)
Christian Couderc0537662009-05-09 15:55:45485{
486 struct strbuf joined_hexs = STRBUF_INIT;
487 int i;
488
Jeff King902bb362011-05-19 21:34:33489 for (i = 0; i < array->nr; i++) {
brian m. carlsonee3051b2017-03-26 16:01:37490 strbuf_addstr(&joined_hexs, oid_to_hex(array->oid + i));
Jeff King902bb362011-05-19 21:34:33491 if (i + 1 < array->nr)
Christian Couderc0537662009-05-09 15:55:45492 strbuf_addch(&joined_hexs, delim);
493 }
494
495 return strbuf_detach(&joined_hexs, NULL);
496}
497
Christian Couder9af35892009-06-06 04:41:33498/*
499 * In this function, passing a not NULL skipped_first is very special.
500 * It means that we want to know if the first commit in the list is
501 * skipped because we will want to test a commit away from it if it is
502 * indeed skipped.
503 * So if the first commit is skipped, we cannot take the shortcut to
504 * just "return list" when we find the first non skipped commit, we
505 * have to return a fully filtered list.
506 *
507 * We use (*skipped_first == -1) to mean "it has been found that the
508 * first commit is not skipped". In this case *skipped_first is set back
509 * to 0 just before the function returns.
510 */
Christian Couder95188642009-03-26 04:55:49511struct commit_list *filter_skipped(struct commit_list *list,
512 struct commit_list **tried,
Christian Couder9af35892009-06-06 04:41:33513 int show_all,
514 int *count,
515 int *skipped_first)
Christian Couder95188642009-03-26 04:55:49516{
517 struct commit_list *filtered = NULL, **f = &filtered;
518
519 *tried = NULL;
520
Christian Couder9af35892009-06-06 04:41:33521 if (skipped_first)
522 *skipped_first = 0;
523 if (count)
524 *count = 0;
525
Jeff King902bb362011-05-19 21:34:33526 if (!skipped_revs.nr)
Christian Couder95188642009-03-26 04:55:49527 return list;
528
Christian Couder95188642009-03-26 04:55:49529 while (list) {
530 struct commit_list *next = list->next;
531 list->next = NULL;
brian m. carlson910650d2017-03-31 01:40:00532 if (0 <= oid_array_lookup(&skipped_revs, &list->item->object.oid)) {
Christian Couder9af35892009-06-06 04:41:33533 if (skipped_first && !*skipped_first)
534 *skipped_first = 1;
Christian Couder95188642009-03-26 04:55:49535 /* Move current to tried list */
536 *tried = list;
537 tried = &list->next;
538 } else {
Christian Couder9af35892009-06-06 04:41:33539 if (!show_all) {
540 if (!skipped_first || !*skipped_first)
541 return list;
542 } else if (skipped_first && !*skipped_first) {
543 /* This means we know it's not skipped */
544 *skipped_first = -1;
545 }
Christian Couder95188642009-03-26 04:55:49546 /* Move current to filtered list */
547 *f = list;
548 f = &list->next;
Christian Couder9af35892009-06-06 04:41:33549 if (count)
550 (*count)++;
Christian Couder95188642009-03-26 04:55:49551 }
552 list = next;
553 }
554
Christian Couder9af35892009-06-06 04:41:33555 if (skipped_first && *skipped_first == -1)
556 *skipped_first = 0;
557
Christian Couder95188642009-03-26 04:55:49558 return filtered;
559}
Christian Couder1bf072e2009-03-26 04:55:54560
Christian Couderebc95292009-06-13 05:21:06561#define PRN_MODULO 32768
562
563/*
564 * This is a pseudo random number generator based on "man 3 rand".
565 * It is not used properly because the seed is the argument and it
566 * is increased by one between each call, but that should not matter
567 * for this application.
568 */
Nguyễn Thái Ngọc Duy3b335762018-12-09 10:25:21569static unsigned get_prn(unsigned count)
570{
Christian Couderebc95292009-06-13 05:21:06571 count = count * 1103515245 + 12345;
John Keeping7b96d882013-04-03 19:17:55572 return (count/65536) % PRN_MODULO;
Christian Couderebc95292009-06-13 05:21:06573}
574
575/*
576 * Custom integer square root from
Sven Strickroth5e687292017-05-13 09:54:51577 * https://en.wikipedia.org/wiki/Integer_square_root
Christian Couderebc95292009-06-13 05:21:06578 */
579static int sqrti(int val)
Christian Couder62d0b0d2009-06-06 04:41:34580{
Christian Couderebc95292009-06-13 05:21:06581 float d, x = val;
582
Miriam Rubiob8e3b2f2020-02-17 08:40:30583 if (!val)
Christian Couderebc95292009-06-13 05:21:06584 return 0;
585
586 do {
587 float y = (x + (float)val / x) / 2;
588 d = (y > x) ? y - x : x - y;
589 x = y;
590 } while (d >= 0.5);
591
592 return (int)x;
593}
594
595static struct commit_list *skip_away(struct commit_list *list, int count)
596{
Christian Couder62d0b0d2009-06-06 04:41:34597 struct commit_list *cur, *previous;
Christian Couderebc95292009-06-13 05:21:06598 int prn, index, i;
599
600 prn = get_prn(count);
601 index = (count * prn / PRN_MODULO) * sqrti(prn) / sqrti(PRN_MODULO);
Christian Couder62d0b0d2009-06-06 04:41:34602
603 cur = list;
604 previous = NULL;
Christian Couder62d0b0d2009-06-06 04:41:34605
606 for (i = 0; cur; cur = cur->next, i++) {
607 if (i == index) {
Jeff King9001dc22018-08-28 21:22:48608 if (!oideq(&cur->item->object.oid, current_bad_oid))
Christian Couder62d0b0d2009-06-06 04:41:34609 return cur;
610 if (previous)
611 return previous;
612 return list;
613 }
614 previous = cur;
615 }
616
617 return list;
618}
619
620static struct commit_list *managed_skipped(struct commit_list *list,
621 struct commit_list **tried)
622{
623 int count, skipped_first;
Christian Couder62d0b0d2009-06-06 04:41:34624
625 *tried = NULL;
626
Jeff King902bb362011-05-19 21:34:33627 if (!skipped_revs.nr)
Christian Couder62d0b0d2009-06-06 04:41:34628 return list;
629
630 list = filter_skipped(list, tried, 0, &count, &skipped_first);
631
632 if (!skipped_first)
633 return list;
634
Christian Couderebc95292009-06-13 05:21:06635 return skip_away(list, count);
Christian Couder62d0b0d2009-06-06 04:41:34636}
637
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59638static void bisect_rev_setup(struct repository *r, struct rev_info *revs,
639 const char *prefix,
Christian Coudera22347c2009-05-17 15:36:44640 const char *bad_format, const char *good_format,
641 int read_paths)
Christian Couder1bf072e2009-03-26 04:55:54642{
Jeff Kingef8d7ac2020-07-28 20:24:53643 struct strvec rev_argv = STRVEC_INIT;
Christian Couderfad2d312009-05-09 15:55:40644 int i;
645
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59646 repo_init_revisions(r, revs, prefix);
Christian Couder3b437b02009-03-26 04:55:59647 revs->abbrev = 0;
648 revs->commit_format = CMIT_FMT_UNSPECIFIED;
Christian Couder1bf072e2009-03-26 04:55:54649
Christian Couder1c953a12009-05-09 15:55:41650 /* rev_argv.argv[0] will be ignored by setup_revisions */
Jeff Kingef8d7ac2020-07-28 20:24:53651 strvec_push(&rev_argv, "bisect_rev_setup");
652 strvec_pushf(&rev_argv, bad_format, oid_to_hex(current_bad_oid));
Jeff King902bb362011-05-19 21:34:33653 for (i = 0; i < good_revs.nr; i++)
Jeff Kingef8d7ac2020-07-28 20:24:53654 strvec_pushf(&rev_argv, good_format,
Jeff Kingf6d89422020-07-28 20:26:31655 oid_to_hex(good_revs.oid + i));
Jeff Kingef8d7ac2020-07-28 20:24:53656 strvec_push(&rev_argv, "--");
Christian Coudera22347c2009-05-17 15:36:44657 if (read_paths)
658 read_bisect_paths(&rev_argv);
Christian Couder1bf072e2009-03-26 04:55:54659
Jeff Kingd70a9eb2020-07-29 00:37:20660 setup_revisions(rev_argv.nr, rev_argv.v, revs, NULL);
Jeff King8a534b62011-09-13 21:58:14661 /* XXX leak rev_argv, as "revs" may still be pointing to it */
Christian Couder3b437b02009-03-26 04:55:59662}
663
Christian Coudera22347c2009-05-17 15:36:44664static void bisect_common(struct rev_info *revs)
Christian Couder2ace9722009-04-19 09:55:57665{
Christian Couder2ace9722009-04-19 09:55:57666 if (prepare_revision_walk(revs))
667 die("revision walk setup failed");
668 if (revs->tree_objects)
Derrick Stolee4f6d26b2019-01-16 18:25:58669 mark_edges_uninteresting(revs, NULL, 0);
Christian Couder2ace9722009-04-19 09:55:57670}
671
Pranit Bauvace58b5d2020-02-17 08:40:34672static enum bisect_error error_if_skipped_commits(struct commit_list *tried,
brian m. carlson3c5ff992015-03-13 23:39:29673 const struct object_id *bad)
Christian Couderef24c7c2009-04-19 09:56:07674{
675 if (!tried)
Pranit Bauvace58b5d2020-02-17 08:40:34676 return BISECT_OK;
Christian Couderef24c7c2009-04-19 09:56:07677
678 printf("There are only 'skip'ped commits left to test.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29679 "The first %s commit could be any of:\n", term_bad);
Junio C Hamano54307ea2016-07-08 17:09:28680
681 for ( ; tried; tried = tried->next)
682 printf("%s\n", oid_to_hex(&tried->item->object.oid));
683
Christian Couderef24c7c2009-04-19 09:56:07684 if (bad)
brian m. carlson3c5ff992015-03-13 23:39:29685 printf("%s\n", oid_to_hex(bad));
Vasco Almeida14dc4892016-06-17 20:21:12686 printf(_("We cannot bisect more!\n"));
Pranit Bauvace58b5d2020-02-17 08:40:34687
688 return BISECT_ONLY_SKIPPED_LEFT;
Christian Couderef24c7c2009-04-19 09:56:07689}
690
brian m. carlson3c5ff992015-03-13 23:39:29691static int is_expected_rev(const struct object_id *oid)
Christian Couderc0537662009-05-09 15:55:45692{
Jeff Kingf9327292015-08-10 09:38:57693 const char *filename = git_path_bisect_expected_rev();
Christian Couderc0537662009-05-09 15:55:45694 struct stat st;
695 struct strbuf str = STRBUF_INIT;
696 FILE *fp;
697 int res = 0;
698
699 if (stat(filename, &st) || !S_ISREG(st.st_mode))
700 return 0;
701
Nguyễn Thái Ngọc Duye9d983f2017-05-03 10:16:50702 fp = fopen_or_warn(filename, "r");
Christian Couderc0537662009-05-09 15:55:45703 if (!fp)
704 return 0;
705
Junio C Hamano8f309ae2016-01-13 23:31:17706 if (strbuf_getline_lf(&str, fp) != EOF)
brian m. carlson3c5ff992015-03-13 23:39:29707 res = !strcmp(str.buf, oid_to_hex(oid));
Christian Couderc0537662009-05-09 15:55:45708
709 strbuf_release(&str);
710 fclose(fp);
711
712 return res;
713}
714
Pranit Bauvae8e3ce62020-02-17 08:40:35715static enum bisect_error bisect_checkout(const struct object_id *bisect_rev, int no_checkout)
Christian Couderef24c7c2009-04-19 09:56:07716{
brian m. carlsondc015052017-03-26 16:01:24717 char bisect_rev_hex[GIT_MAX_HEXSZ + 1];
Pranit Bauvae8e3ce62020-02-17 08:40:35718 enum bisect_error res = BISECT_OK;
Christian Couderef24c7c2009-04-19 09:56:07719
René Scharfe7d23ff82020-08-02 14:36:50720 oid_to_hex_r(bisect_rev_hex, bisect_rev);
brian m. carlsonae077772017-10-15 22:06:51721 update_ref(NULL, "BISECT_EXPECTED_REV", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
Christian Couderef24c7c2009-04-19 09:56:07722
723 argv_checkout[2] = bisect_rev_hex;
Jon Seymourfee92fc2011-08-04 12:01:00724 if (no_checkout) {
brian m. carlsonae077772017-10-15 22:06:51725 update_ref(NULL, "BISECT_HEAD", bisect_rev, NULL, 0,
726 UPDATE_REFS_DIE_ON_ERR);
Jon Seymourfee92fc2011-08-04 12:01:00727 } else {
Jon Seymourfee92fc2011-08-04 12:01:00728 res = run_command_v_opt(argv_checkout, RUN_GIT_CMD);
729 if (res)
Pranit Bauvae8e3ce62020-02-17 08:40:35730 /*
731 * Errors in `run_command()` itself, signaled by res < 0,
732 * and errors in the child process, signaled by res > 0
733 * can both be treated as regular BISECT_FAILURE (-1).
734 */
735 return -abs(res);
Jon Seymourfee92fc2011-08-04 12:01:00736 }
Christian Couderef24c7c2009-04-19 09:56:07737
738 argv_show_branch[1] = bisect_rev_hex;
Pranit Bauvae8e3ce62020-02-17 08:40:35739 res = run_command_v_opt(argv_show_branch, RUN_GIT_CMD);
740 /*
741 * Errors in `run_command()` itself, signaled by res < 0,
742 * and errors in the child process, signaled by res > 0
743 * can both be treated as regular BISECT_FAILURE (-1).
744 */
745 return -abs(res);
Christian Couderef24c7c2009-04-19 09:56:07746}
747
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59748static struct commit *get_commit_reference(struct repository *r,
749 const struct object_id *oid)
Christian Couderc0537662009-05-09 15:55:45750{
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59751 struct commit *c = lookup_commit_reference(r, oid);
752 if (!c)
brian m. carlsonee3051b2017-03-26 16:01:37753 die(_("Not a valid commit name %s"), oid_to_hex(oid));
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59754 return c;
Christian Couderc0537662009-05-09 15:55:45755}
756
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59757static struct commit **get_bad_and_good_commits(struct repository *r,
758 int *rev_nr)
Christian Couderc0537662009-05-09 15:55:45759{
Jeff Kingb32fa952016-02-22 22:44:25760 struct commit **rev;
Christian Couderc0537662009-05-09 15:55:45761 int i, n = 0;
762
Jeff Kingb32fa952016-02-22 22:44:25763 ALLOC_ARRAY(rev, 1 + good_revs.nr);
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59764 rev[n++] = get_commit_reference(r, current_bad_oid);
Jeff King902bb362011-05-19 21:34:33765 for (i = 0; i < good_revs.nr; i++)
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59766 rev[n++] = get_commit_reference(r, good_revs.oid + i);
Christian Couderc0537662009-05-09 15:55:45767 *rev_nr = n;
768
769 return rev;
770}
771
Pranit Bauva9ec598e2020-02-17 08:40:38772static enum bisect_error handle_bad_merge_base(void)
Christian Couderc0537662009-05-09 15:55:45773{
brian m. carlson3c5ff992015-03-13 23:39:29774 if (is_expected_rev(current_bad_oid)) {
775 char *bad_hex = oid_to_hex(current_bad_oid);
Jeff King7383b252020-03-30 14:04:06776 char *good_hex = join_oid_array_hex(&good_revs, ' ');
Antoine Delaite43f9d9f2015-06-29 15:40:29777 if (!strcmp(term_bad, "bad") && !strcmp(term_good, "good")) {
Vasco Almeida14dc4892016-06-17 20:21:12778 fprintf(stderr, _("The merge base %s is bad.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29779 "This means the bug has been fixed "
Vasco Almeida14dc4892016-06-17 20:21:12780 "between %s and [%s].\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29781 bad_hex, bad_hex, good_hex);
Antoine Delaite21e5cfd2015-06-29 15:40:33782 } else if (!strcmp(term_bad, "new") && !strcmp(term_good, "old")) {
Vasco Almeida14dc4892016-06-17 20:21:12783 fprintf(stderr, _("The merge base %s is new.\n"
Antoine Delaite21e5cfd2015-06-29 15:40:33784 "The property has changed "
Vasco Almeida14dc4892016-06-17 20:21:12785 "between %s and [%s].\n"),
Antoine Delaite21e5cfd2015-06-29 15:40:33786 bad_hex, bad_hex, good_hex);
Antoine Delaite43f9d9f2015-06-29 15:40:29787 } else {
Vasco Almeida14dc4892016-06-17 20:21:12788 fprintf(stderr, _("The merge base %s is %s.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29789 "This means the first '%s' commit is "
Vasco Almeida14dc4892016-06-17 20:21:12790 "between %s and [%s].\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29791 bad_hex, term_bad, term_good, bad_hex, good_hex);
792 }
Pranit Bauva9ec598e2020-02-17 08:40:38793 return BISECT_MERGE_BASE_CHECK;
Christian Couderc0537662009-05-09 15:55:45794 }
795
Alex Henrie3f407b72016-12-04 22:04:23796 fprintf(stderr, _("Some %s revs are not ancestors of the %s rev.\n"
Christian Couderc0537662009-05-09 15:55:45797 "git bisect cannot work properly in this case.\n"
Vasco Almeida14dc4892016-06-17 20:21:12798 "Maybe you mistook %s and %s revs?\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29799 term_good, term_bad, term_good, term_bad);
Pranit Bauva9ec598e2020-02-17 08:40:38800 return BISECT_FAILED;
Christian Couderc0537662009-05-09 15:55:45801}
802
brian m. carlson4ce36212017-03-31 01:39:57803static void handle_skipped_merge_base(const struct object_id *mb)
Christian Couderc0537662009-05-09 15:55:45804{
brian m. carlson4ce36212017-03-31 01:39:57805 char *mb_hex = oid_to_hex(mb);
brian m. carlsonc368dde2016-06-24 23:09:22806 char *bad_hex = oid_to_hex(current_bad_oid);
Jeff King7383b252020-03-30 14:04:06807 char *good_hex = join_oid_array_hex(&good_revs, ' ');
Christian Couderc0537662009-05-09 15:55:45808
Vasco Almeida14dc4892016-06-17 20:21:12809 warning(_("the merge base between %s and [%s] "
Christian Couderc0537662009-05-09 15:55:45810 "must be skipped.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29811 "So we cannot be sure the first %s commit is "
Christian Couderc0537662009-05-09 15:55:45812 "between %s and %s.\n"
Vasco Almeida14dc4892016-06-17 20:21:12813 "We continue anyway."),
Antoine Delaite43f9d9f2015-06-29 15:40:29814 bad_hex, good_hex, term_bad, mb_hex, bad_hex);
Christian Couderc0537662009-05-09 15:55:45815 free(good_hex);
816}
817
818/*
Antoine Delaite21e5cfd2015-06-29 15:40:33819 * "check_merge_bases" checks that merge bases are not "bad" (or "new").
Christian Couderc0537662009-05-09 15:55:45820 *
Antoine Delaite21e5cfd2015-06-29 15:40:33821 * - If one is "bad" (or "new"), it means the user assumed something wrong
Pranit Bauvacdd4dc22020-02-17 08:40:36822 * and we must return error with a non 0 error code.
Antoine Delaite21e5cfd2015-06-29 15:40:33823 * - If one is "good" (or "old"), that's good, we have nothing to do.
Christian Couderc0537662009-05-09 15:55:45824 * - If one is "skipped", we can't know but we should warn.
825 * - If we don't know, we should check it out and ask the user to test.
Pranit Bauvacdd4dc22020-02-17 08:40:36826 * - If a merge base must be tested, on success return
827 * BISECT_INTERNAL_SUCCESS_MERGE_BASE (-11) a special condition
828 * for early success, this will be converted back to 0 in
829 * check_good_are_ancestors_of_bad().
Christian Couderc0537662009-05-09 15:55:45830 */
Pranit Bauvacdd4dc22020-02-17 08:40:36831static enum bisect_error check_merge_bases(int rev_nr, struct commit **rev, int no_checkout)
Christian Couderc0537662009-05-09 15:55:45832{
Pranit Bauvacdd4dc22020-02-17 08:40:36833 enum bisect_error res = BISECT_OK;
Christian Couderc0537662009-05-09 15:55:45834 struct commit_list *result;
Christian Couderc0537662009-05-09 15:55:45835
Junio C Hamano2ce406c2014-10-30 19:20:44836 result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1);
Christian Couderc0537662009-05-09 15:55:45837
838 for (; result; result = result->next) {
brian m. carlson4ce36212017-03-31 01:39:57839 const struct object_id *mb = &result->item->object.oid;
Jeff King4a7e27e2018-08-28 21:22:40840 if (oideq(mb, current_bad_oid)) {
Pranit Bauva9ec598e2020-02-17 08:40:38841 res = handle_bad_merge_base();
842 break;
brian m. carlson910650d2017-03-31 01:40:00843 } else if (0 <= oid_array_lookup(&good_revs, mb)) {
Christian Couderc0537662009-05-09 15:55:45844 continue;
brian m. carlson910650d2017-03-31 01:40:00845 } else if (0 <= oid_array_lookup(&skipped_revs, mb)) {
Christian Couderc0537662009-05-09 15:55:45846 handle_skipped_merge_base(mb);
847 } else {
Vasco Almeida14dc4892016-06-17 20:21:12848 printf(_("Bisecting: a merge base must be tested\n"));
Pranit Bauvacdd4dc22020-02-17 08:40:36849 res = bisect_checkout(mb, no_checkout);
850 if (!res)
851 /* indicate early success */
852 res = BISECT_INTERNAL_SUCCESS_MERGE_BASE;
853 break;
Christian Couderc0537662009-05-09 15:55:45854 }
855 }
856
Christian Couderc0537662009-05-09 15:55:45857 free_commit_list(result);
Pranit Bauvacdd4dc22020-02-17 08:40:36858 return res;
Christian Couderc0537662009-05-09 15:55:45859}
860
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59861static int check_ancestors(struct repository *r, int rev_nr,
862 struct commit **rev, const char *prefix)
Christian Couderd937d4a2009-05-09 15:55:46863{
Christian Couder2d938fc2009-05-17 15:36:46864 struct rev_info revs;
René Scharfe86a0a402011-10-01 16:16:08865 int res;
Christian Couderd937d4a2009-05-09 15:55:46866
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59867 bisect_rev_setup(r, &revs, prefix, "^%s", "%s", 0);
Christian Couderd937d4a2009-05-09 15:55:46868
Christian Couder2d938fc2009-05-17 15:36:46869 bisect_common(&revs);
870 res = (revs.commits != NULL);
871
872 /* Clean up objects used, as they will be reused. */
René Scharfe148f14a2017-12-25 17:45:36873 clear_commit_marks_many(rev_nr, rev, ALL_REV_FLAGS);
Christian Couderd937d4a2009-05-09 15:55:46874
Christian Couder2d938fc2009-05-17 15:36:46875 return res;
Christian Couderd937d4a2009-05-09 15:55:46876}
877
878/*
879 * "check_good_are_ancestors_of_bad" checks that all "good" revs are
880 * ancestor of the "bad" rev.
881 *
882 * If that's not the case, we need to check the merge bases.
883 * If a merge base must be tested by the user, its source code will be
Pranit Bauva45b63702020-02-17 08:40:37884 * checked out to be tested by the user and we will return.
Christian Couderd937d4a2009-05-09 15:55:46885 */
Pranit Bauva45b63702020-02-17 08:40:37886
887static enum bisect_error check_good_are_ancestors_of_bad(struct repository *r,
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59888 const char *prefix,
889 int no_checkout)
Christian Couderd937d4a2009-05-09 15:55:46890{
Pranit Bauva45b63702020-02-17 08:40:37891 char *filename;
Christian Couderd937d4a2009-05-09 15:55:46892 struct stat st;
René Scharfe148f14a2017-12-25 17:45:36893 int fd, rev_nr;
Pranit Bauvacdd4dc22020-02-17 08:40:36894 enum bisect_error res = BISECT_OK;
René Scharfe148f14a2017-12-25 17:45:36895 struct commit **rev;
Christian Couderd937d4a2009-05-09 15:55:46896
brian m. carlson3c5ff992015-03-13 23:39:29897 if (!current_bad_oid)
Pranit Bauva45b63702020-02-17 08:40:37898 return error(_("a %s revision is needed"), term_bad);
899
900 filename = git_pathdup("BISECT_ANCESTORS_OK");
Christian Couderd937d4a2009-05-09 15:55:46901
902 /* Check if file BISECT_ANCESTORS_OK exists. */
903 if (!stat(filename, &st) && S_ISREG(st.st_mode))
Michael Haggerty144e7092012-04-26 22:26:59904 goto done;
Christian Couderd937d4a2009-05-09 15:55:46905
906 /* Bisecting with no good rev is ok. */
Miriam Rubiob8e3b2f2020-02-17 08:40:30907 if (!good_revs.nr)
Michael Haggerty144e7092012-04-26 22:26:59908 goto done;
Christian Couderd937d4a2009-05-09 15:55:46909
Christian Couder2d938fc2009-05-17 15:36:46910 /* Check if all good revs are ancestor of the bad rev. */
Pranit Bauvacdd4dc22020-02-17 08:40:36911
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59912 rev = get_bad_and_good_commits(r, &rev_nr);
913 if (check_ancestors(r, rev_nr, rev, prefix))
Pranit Bauvacdd4dc22020-02-17 08:40:36914 res = check_merge_bases(rev_nr, rev, no_checkout);
René Scharfe148f14a2017-12-25 17:45:36915 free(rev);
Christian Couderd937d4a2009-05-09 15:55:46916
Pranit Bauva45b63702020-02-17 08:40:37917 if (!res) {
918 /* Create file BISECT_ANCESTORS_OK. */
919 fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
920 if (fd < 0)
921 /*
922 * BISECT_ANCESTORS_OK file is not absolutely necessary,
923 * the bisection process will continue at the next
924 * bisection step.
925 * So, just signal with a warning that something
926 * might be wrong.
927 */
928 warning_errno(_("could not create file '%s'"),
929 filename);
930 else
931 close(fd);
932 }
Michael Haggerty144e7092012-04-26 22:26:59933 done:
934 free(filename);
Pranit Bauva45b63702020-02-17 08:40:37935 return res;
Christian Couderd937d4a2009-05-09 15:55:46936}
937
938/*
Christian Coudere22278c2009-05-28 21:21:16939 * This does "git diff-tree --pretty COMMIT" without one fork+exec.
940 */
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:59941static void show_diff_tree(struct repository *r,
942 const char *prefix,
943 struct commit *commit)
Christian Coudere22278c2009-05-28 21:21:16944{
Jeff King2008f292019-02-22 06:20:37945 const char *argv[] = {
Jeff Kingb02be8b2019-02-22 06:23:28946 "diff-tree", "--pretty", "--stat", "--summary", "--cc", NULL
Jeff King2008f292019-02-22 06:20:37947 };
Christian Coudere22278c2009-05-28 21:21:16948 struct rev_info opt;
949
Jeff Kingb02be8b2019-02-22 06:23:28950 git_config(git_diff_ui_config, NULL);
Jeff King40ae3d32019-02-22 06:21:33951 repo_init_revisions(r, &opt, prefix);
Christian Coudere22278c2009-05-28 21:21:16952
Jeff King2008f292019-02-22 06:20:37953 setup_revisions(ARRAY_SIZE(argv) - 1, argv, &opt, NULL);
Christian Coudere22278c2009-05-28 21:21:16954 log_tree_commit(&opt, commit);
955}
956
957/*
Antoine Delaitecb46d632015-06-29 15:40:30958 * The terms used for this bisect session are stored in BISECT_TERMS.
959 * We read them and store them to adapt the messages accordingly.
960 * Default is bad/good.
961 */
962void read_bisect_terms(const char **read_bad, const char **read_good)
963{
964 struct strbuf str = STRBUF_INIT;
Jeff Kingf5d284f2017-04-20 21:08:25965 const char *filename = git_path_bisect_terms();
Antoine Delaitecb46d632015-06-29 15:40:30966 FILE *fp = fopen(filename, "r");
967
968 if (!fp) {
969 if (errno == ENOENT) {
970 *read_bad = "bad";
971 *read_good = "good";
972 return;
973 } else {
Vasco Almeida14dc4892016-06-17 20:21:12974 die_errno(_("could not read file '%s'"), filename);
Antoine Delaitecb46d632015-06-29 15:40:30975 }
976 } else {
Junio C Hamano8f309ae2016-01-13 23:31:17977 strbuf_getline_lf(&str, fp);
Antoine Delaitecb46d632015-06-29 15:40:30978 *read_bad = strbuf_detach(&str, NULL);
Junio C Hamano8f309ae2016-01-13 23:31:17979 strbuf_getline_lf(&str, fp);
Antoine Delaitecb46d632015-06-29 15:40:30980 *read_good = strbuf_detach(&str, NULL);
981 }
982 strbuf_release(&str);
983 fclose(fp);
984}
985
986/*
Pranit Bauva6c69f222020-02-17 08:40:39987 * We use the convention that return BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND (-10) means
Christian Couderef24c7c2009-04-19 09:56:07988 * the bisection process finished successfully.
Pranit Bauva6c69f222020-02-17 08:40:39989 * In this case the calling function or command should not turn a
990 * BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND return code into an error or a non zero exit code.
Pranit Bauva517ecb32020-09-24 12:33:40991 *
992 * Checking BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND
993 * in bisect_helper::bisect_next() and only transforming it to 0 at
994 * the end of bisect_helper::cmd_bisect__helper() helps bypassing
995 * all the code related to finding a commit to test.
Christian Couderef24c7c2009-04-19 09:56:07996 */
Aaron Lipmanbe5fe202020-08-07 21:58:36997enum bisect_error bisect_next_all(struct repository *r, const char *prefix)
Christian Couderef24c7c2009-04-19 09:56:07998{
999 struct rev_info revs;
1000 struct commit_list *tried;
David Ripton6329bad2010-01-19 15:13:331001 int reaches = 0, all = 0, nr, steps;
Pranit Bauvace58b5d2020-02-17 08:40:341002 enum bisect_error res = BISECT_OK;
brian m. carlson4be0dee2017-07-13 23:49:241003 struct object_id *bisect_rev;
Maxim Moseychuk2cfa8352017-02-16 17:07:121004 char *steps_msg;
Pranit Bauva517ecb32020-09-24 12:33:401005 /*
1006 * If no_checkout is non-zero, the bisection process does not
1007 * checkout the trial commit but instead simply updates BISECT_HEAD.
1008 */
Aaron Lipmanbe5fe202020-08-07 21:58:361009 int no_checkout = ref_exists("BISECT_HEAD");
Aaron Lipmanad464a42020-08-07 21:58:381010 unsigned bisect_flags = 0;
Christian Couderef24c7c2009-04-19 09:56:071011
Antoine Delaitecb46d632015-06-29 15:40:301012 read_bisect_terms(&term_bad, &term_good);
Christian Couder2b020692009-05-09 15:55:421013 if (read_bisect_refs())
Vasco Almeida14dc4892016-06-17 20:21:121014 die(_("reading bisect refs failed"));
Christian Couder2b020692009-05-09 15:55:421015
Aaron Lipmanad464a42020-08-07 21:58:381016 if (file_exists(git_path_bisect_first_parent()))
1017 bisect_flags |= FIND_BISECTION_FIRST_PARENT_ONLY;
1018
1019 if (skipped_revs.nr)
1020 bisect_flags |= FIND_BISECTION_ALL;
1021
Pranit Bauva45b63702020-02-17 08:40:371022 res = check_good_are_ancestors_of_bad(r, prefix, no_checkout);
1023 if (res)
1024 return res;
Christian Couder08719842009-05-09 15:55:471025
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:591026 bisect_rev_setup(r, &revs, prefix, "%s", "^%s", 1);
Aaron Lipmanad464a42020-08-07 21:58:381027
1028 revs.first_parent_only = !!(bisect_flags & FIND_BISECTION_FIRST_PARENT_ONLY);
Christian Coudera22347c2009-05-17 15:36:441029 revs.limited = 1;
Christian Couder2b020692009-05-09 15:55:421030
Christian Coudera22347c2009-05-17 15:36:441031 bisect_common(&revs);
Christian Couderef24c7c2009-04-19 09:56:071032
Aaron Lipmanad464a42020-08-07 21:58:381033 find_bisection(&revs.commits, &reaches, &all, bisect_flags);
Christian Couder62d0b0d2009-06-06 04:41:341034 revs.commits = managed_skipped(revs.commits, &tried);
Christian Couderef24c7c2009-04-19 09:56:071035
1036 if (!revs.commits) {
1037 /*
Pranit Bauva6c69f222020-02-17 08:40:391038 * We should return error here only if the "bad"
Christian Couderef24c7c2009-04-19 09:56:071039 * commit is also a "skip" commit.
1040 */
Pranit Bauvace58b5d2020-02-17 08:40:341041 res = error_if_skipped_commits(tried, NULL);
1042 if (res < 0)
Pranit Bauva6c69f222020-02-17 08:40:391043 return res;
Vasco Almeida14dc4892016-06-17 20:21:121044 printf(_("%s was both %s and %s\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:291045 oid_to_hex(current_bad_oid),
1046 term_good,
1047 term_bad);
Pranit Bauva6c69f222020-02-17 08:40:391048
1049 return BISECT_FAILED;
Christian Couderef24c7c2009-04-19 09:56:071050 }
1051
Christian Couder8f69f722010-02-28 22:19:091052 if (!all) {
Vasco Almeida14dc4892016-06-17 20:21:121053 fprintf(stderr, _("No testable commit found.\n"
1054 "Maybe you started with bad path parameters?\n"));
Pranit Bauva6c69f222020-02-17 08:40:391055
1056 return BISECT_NO_TESTABLE_COMMIT;
Christian Couder8f69f722010-02-28 22:19:091057 }
1058
brian m. carlson4be0dee2017-07-13 23:49:241059 bisect_rev = &revs.commits->item->object.oid;
Christian Couderef24c7c2009-04-19 09:56:071060
Jeff King4a7e27e2018-08-28 21:22:401061 if (oideq(bisect_rev, current_bad_oid)) {
Pranit Bauvace58b5d2020-02-17 08:40:341062 res = error_if_skipped_commits(tried, current_bad_oid);
1063 if (res)
Pranit Bauva6c69f222020-02-17 08:40:391064 return res;
brian m. carlson4be0dee2017-07-13 23:49:241065 printf("%s is the first %s commit\n", oid_to_hex(bisect_rev),
Antoine Delaite43f9d9f2015-06-29 15:40:291066 term_bad);
Pranit Bauva6c69f222020-02-17 08:40:391067
Nguyễn Thái Ngọc Duy69d2cfe2018-11-10 05:48:591068 show_diff_tree(r, prefix, revs.commits->item);
Pranit Bauva6c69f222020-02-17 08:40:391069 /*
1070 * This means the bisection process succeeded.
1071 * Using BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND (-10)
1072 * so that the call chain can simply check
1073 * for negative return values for early returns up
1074 * until the cmd_bisect__helper() caller.
1075 */
1076 return BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND;
Christian Couderef24c7c2009-04-19 09:56:071077 }
1078
1079 nr = all - reaches - 1;
David Ripton6329bad2010-01-19 15:13:331080 steps = estimate_bisect_steps(all);
Maxim Moseychuk2cfa8352017-02-16 17:07:121081
1082 steps_msg = xstrfmt(Q_("(roughly %d step)", "(roughly %d steps)",
1083 steps), steps);
Ævar Arnfjörð Bjarmason66f5f6d2017-05-11 21:20:121084 /*
1085 * TRANSLATORS: the last %s will be replaced with "(roughly %d
1086 * steps)" translation.
1087 */
Vasco Almeida14dc4892016-06-17 20:21:121088 printf(Q_("Bisecting: %d revision left to test after this %s\n",
1089 "Bisecting: %d revisions left to test after this %s\n",
1090 nr), nr, steps_msg);
Maxim Moseychuk2cfa8352017-02-16 17:07:121091 free(steps_msg);
Miriam Rubioc7a7f482020-09-24 12:33:391092 /* Clean up objects used, as they will be reused. */
1093 clear_commit_marks_all(ALL_REV_FLAGS);
Christian Couderef24c7c2009-04-19 09:56:071094
David Turnerf3a97712015-07-31 06:06:201095 return bisect_checkout(bisect_rev, no_checkout);
Christian Couderef24c7c2009-04-19 09:56:071096}
1097
Nguyễn Thái Ngọc Duyc43cb382012-10-26 15:53:501098static inline int log2i(int n)
1099{
1100 int log2 = 0;
1101
1102 for (; n > 1; n >>= 1)
1103 log2++;
1104
1105 return log2;
1106}
1107
1108static inline int exp2i(int n)
1109{
1110 return 1 << n;
1111}
1112
1113/*
1114 * Estimate the number of bisect steps left (after the current step)
1115 *
1116 * For any x between 0 included and 2^n excluded, the probability for
1117 * n - 1 steps left looks like:
1118 *
1119 * P(2^n + x) == (2^n - x) / (2^n + x)
1120 *
1121 * and P(2^n + x) < 0.5 means 2^n < 3x
1122 */
1123int estimate_bisect_steps(int all)
1124{
1125 int n, x, e;
1126
1127 if (all < 3)
1128 return 0;
1129
1130 n = log2i(all);
1131 e = exp2i(n);
1132 x = all - e;
1133
1134 return (e < 3 * x) ? n : n - 1;
1135}
Pranit Bauvafb71a322017-09-29 06:49:391136
1137static int mark_for_removal(const char *refname, const struct object_id *oid,
1138 int flag, void *cb_data)
1139{
1140 struct string_list *refs = cb_data;
1141 char *ref = xstrfmt("refs/bisect%s", refname);
1142 string_list_append(refs, ref);
1143 return 0;
1144}
1145
1146int bisect_clean_state(void)
1147{
1148 int result = 0;
1149
1150 /* There may be some refs packed during bisection */
1151 struct string_list refs_for_removal = STRING_LIST_INIT_NODUP;
1152 for_each_ref_in("refs/bisect", mark_for_removal, (void *) &refs_for_removal);
1153 string_list_append(&refs_for_removal, xstrdup("BISECT_HEAD"));
Junio C Hamanoa9722292017-11-15 03:14:291154 result = delete_refs("bisect: remove", &refs_for_removal, REF_NO_DEREF);
Pranit Bauvafb71a322017-09-29 06:49:391155 refs_for_removal.strdup_strings = 1;
1156 string_list_clear(&refs_for_removal, 0);
1157 unlink_or_warn(git_path_bisect_expected_rev());
1158 unlink_or_warn(git_path_bisect_ancestors_ok());
1159 unlink_or_warn(git_path_bisect_log());
1160 unlink_or_warn(git_path_bisect_names());
1161 unlink_or_warn(git_path_bisect_run());
1162 unlink_or_warn(git_path_bisect_terms());
Aaron Lipmane8861ff2020-08-07 21:58:371163 unlink_or_warn(git_path_bisect_first_parent());
Pranit Bauvafb71a322017-09-29 06:49:391164 /* Cleanup head-name if it got left by an old version of git-bisect */
1165 unlink_or_warn(git_path_head_name());
1166 /*
1167 * Cleanup BISECT_START last to support the --no-checkout option
1168 * introduced in the commit 4796e823a.
1169 */
1170 unlink_or_warn(git_path_bisect_start());
1171
1172 return result;
1173}