🌐 AI搜索 & 代理 主页
blob: 6f512c20638718df91ed4a29aae3518f985c0d30 [file] [log] [blame]
Christian Coudera2ad79c2009-03-26 04:55:241#include "cache.h"
2#include "commit.h"
3#include "diff.h"
4#include "revision.h"
Christian Couder1bf072e2009-03-26 04:55:545#include "refs.h"
6#include "list-objects.h"
Christian Couder3b437b02009-03-26 04:55:597#include "quote.h"
Christian Couder4eb5b642009-04-04 20:59:368#include "sha1-lookup.h"
Christian Couderef24c7c2009-04-19 09:56:079#include "run-command.h"
Christian Coudere22278c2009-05-28 21:21:1610#include "log-tree.h"
Christian Coudera2ad79c2009-03-26 04:55:2411#include "bisect.h"
Jeff King902bb362011-05-19 21:34:3312#include "sha1-array.h"
Jeff King8a534b62011-09-13 21:58:1413#include "argv-array.h"
Christian Couder6212b1a2009-05-09 15:55:3814
Christian Couderfad2d312009-05-09 15:55:4015static struct sha1_array good_revs;
Christian Couder6212b1a2009-05-09 15:55:3816static struct sha1_array skipped_revs;
Christian Couder1bf072e2009-03-26 04:55:5417
brian m. carlson3c5ff992015-03-13 23:39:2918static struct object_id *current_bad_oid;
Christian Couderef24c7c2009-04-19 09:56:0719
Christian Couderef24c7c2009-04-19 09:56:0720static const char *argv_checkout[] = {"checkout", "-q", NULL, "--", NULL};
21static const char *argv_show_branch[] = {"show-branch", NULL, NULL};
22
Antoine Delaite43f9d9f2015-06-29 15:40:2923static const char *term_bad;
24static const char *term_good;
25
Nguyễn Thái Ngọc Duy208acbf2014-03-25 13:23:2626/* Remember to update object flag allocation in object.h */
Christian Coudera2ad79c2009-03-26 04:55:2427#define COUNTED (1u<<16)
28
29/*
30 * This is a truly stupid algorithm, but it's only
31 * used for bisection, and we just don't care enough.
32 *
33 * We care just barely enough to avoid recursing for
34 * non-merge entries.
35 */
36static int count_distance(struct commit_list *entry)
37{
38 int nr = 0;
39
40 while (entry) {
41 struct commit *commit = entry->item;
42 struct commit_list *p;
43
44 if (commit->object.flags & (UNINTERESTING | COUNTED))
45 break;
46 if (!(commit->object.flags & TREESAME))
47 nr++;
48 commit->object.flags |= COUNTED;
49 p = commit->parents;
50 entry = p;
51 if (p) {
52 p = p->next;
53 while (p) {
54 nr += count_distance(p);
55 p = p->next;
56 }
57 }
58 }
59
60 return nr;
61}
62
63static void clear_distance(struct commit_list *list)
64{
65 while (list) {
66 struct commit *commit = list->item;
67 commit->object.flags &= ~COUNTED;
68 list = list->next;
69 }
70}
71
72#define DEBUG_BISECT 0
73
74static inline int weight(struct commit_list *elem)
75{
76 return *((int*)(elem->item->util));
77}
78
79static inline void weight_set(struct commit_list *elem, int weight)
80{
81 *((int*)(elem->item->util)) = weight;
82}
83
84static int count_interesting_parents(struct commit *commit)
85{
86 struct commit_list *p;
87 int count;
88
89 for (count = 0, p = commit->parents; p; p = p->next) {
90 if (p->item->object.flags & UNINTERESTING)
91 continue;
92 count++;
93 }
94 return count;
95}
96
97static inline int halfway(struct commit_list *p, int nr)
98{
99 /*
100 * Don't short-cut something we are not going to return!
101 */
102 if (p->item->object.flags & TREESAME)
103 return 0;
104 if (DEBUG_BISECT)
105 return 0;
106 /*
107 * 2 and 3 are halfway of 5.
108 * 3 is halfway of 6 but 2 and 4 are not.
109 */
110 switch (2 * weight(p) - nr) {
111 case -1: case 0: case 1:
112 return 1;
113 default:
114 return 0;
115 }
116}
117
118#if !DEBUG_BISECT
119#define show_list(a,b,c,d) do { ; } while (0)
120#else
121static void show_list(const char *debug, int counted, int nr,
122 struct commit_list *list)
123{
124 struct commit_list *p;
125
126 fprintf(stderr, "%s (%d/%d)\n", debug, counted, nr);
127
128 for (p = list; p; p = p->next) {
129 struct commit_list *pp;
130 struct commit *commit = p->item;
131 unsigned flags = commit->object.flags;
132 enum object_type type;
133 unsigned long size;
134 char *buf = read_sha1_file(commit->object.sha1, &type, &size);
Christian Couder56ff3792010-07-22 13:18:33135 const char *subject_start;
136 int subject_len;
Christian Coudera2ad79c2009-03-26 04:55:24137
138 fprintf(stderr, "%c%c%c ",
139 (flags & TREESAME) ? ' ' : 'T',
140 (flags & UNINTERESTING) ? 'U' : ' ',
141 (flags & COUNTED) ? 'C' : ' ');
142 if (commit->util)
143 fprintf(stderr, "%3d", weight(p));
144 else
145 fprintf(stderr, "---");
146 fprintf(stderr, " %.*s", 8, sha1_to_hex(commit->object.sha1));
147 for (pp = commit->parents; pp; pp = pp->next)
148 fprintf(stderr, " %.*s", 8,
149 sha1_to_hex(pp->item->object.sha1));
150
Christian Couder56ff3792010-07-22 13:18:33151 subject_len = find_commit_subject(buf, &subject_start);
152 if (subject_len)
153 fprintf(stderr, " %.*s", subject_len, subject_start);
Christian Coudera2ad79c2009-03-26 04:55:24154 fprintf(stderr, "\n");
155 }
156}
157#endif /* DEBUG_BISECT */
158
159static struct commit_list *best_bisection(struct commit_list *list, int nr)
160{
161 struct commit_list *p, *best;
162 int best_distance = -1;
163
164 best = list;
165 for (p = list; p; p = p->next) {
166 int distance;
167 unsigned flags = p->item->object.flags;
168
169 if (flags & TREESAME)
170 continue;
171 distance = weight(p);
172 if (nr - distance < distance)
173 distance = nr - distance;
174 if (distance > best_distance) {
175 best = p;
176 best_distance = distance;
177 }
178 }
179
180 return best;
181}
182
183struct commit_dist {
184 struct commit *commit;
185 int distance;
186};
187
188static int compare_commit_dist(const void *a_, const void *b_)
189{
190 struct commit_dist *a, *b;
191
192 a = (struct commit_dist *)a_;
193 b = (struct commit_dist *)b_;
194 if (a->distance != b->distance)
195 return b->distance - a->distance; /* desc sort */
brian m. carlsonf2fd0762015-11-10 02:22:28196 return oidcmp(&a->commit->object.oid, &b->commit->object.oid);
Christian Coudera2ad79c2009-03-26 04:55:24197}
198
199static struct commit_list *best_bisection_sorted(struct commit_list *list, int nr)
200{
201 struct commit_list *p;
202 struct commit_dist *array = xcalloc(nr, sizeof(*array));
203 int cnt, i;
204
205 for (p = list, cnt = 0; p; p = p->next) {
206 int distance;
207 unsigned flags = p->item->object.flags;
208
209 if (flags & TREESAME)
210 continue;
211 distance = weight(p);
212 if (nr - distance < distance)
213 distance = nr - distance;
214 array[cnt].commit = p->item;
215 array[cnt].distance = distance;
216 cnt++;
217 }
218 qsort(array, cnt, sizeof(*array), compare_commit_dist);
219 for (p = list, i = 0; i < cnt; i++) {
Jeff King662174d2014-08-26 10:23:36220 char buf[100]; /* enough for dist=%d */
Christian Coudera2ad79c2009-03-26 04:55:24221 struct object *obj = &(array[i].commit->object);
222
Jeff King662174d2014-08-26 10:23:36223 snprintf(buf, sizeof(buf), "dist=%d", array[i].distance);
224 add_name_decoration(DECORATION_NONE, buf, obj);
225
Christian Coudera2ad79c2009-03-26 04:55:24226 p->item = array[i].commit;
227 p = p->next;
228 }
229 if (p)
230 p->next = NULL;
231 free(array);
232 return list;
233}
234
235/*
236 * zero or positive weight is the number of interesting commits it can
237 * reach, including itself. Especially, weight = 0 means it does not
238 * reach any tree-changing commits (e.g. just above uninteresting one
239 * but traversal is with pathspec).
240 *
241 * weight = -1 means it has one parent and its distance is yet to
242 * be computed.
243 *
244 * weight = -2 means it has more than one parent and its distance is
245 * unknown. After running count_distance() first, they will get zero
246 * or positive distance.
247 */
248static struct commit_list *do_find_bisection(struct commit_list *list,
249 int nr, int *weights,
250 int find_all)
251{
252 int n, counted;
253 struct commit_list *p;
254
255 counted = 0;
256
257 for (n = 0, p = list; p; p = p->next) {
258 struct commit *commit = p->item;
259 unsigned flags = commit->object.flags;
260
261 p->item->util = &weights[n++];
262 switch (count_interesting_parents(commit)) {
263 case 0:
264 if (!(flags & TREESAME)) {
265 weight_set(p, 1);
266 counted++;
267 show_list("bisection 2 count one",
268 counted, nr, list);
269 }
270 /*
271 * otherwise, it is known not to reach any
272 * tree-changing commit and gets weight 0.
273 */
274 break;
275 case 1:
276 weight_set(p, -1);
277 break;
278 default:
279 weight_set(p, -2);
280 break;
281 }
282 }
283
284 show_list("bisection 2 initialize", counted, nr, list);
285
286 /*
287 * If you have only one parent in the resulting set
288 * then you can reach one commit more than that parent
289 * can reach. So we do not have to run the expensive
290 * count_distance() for single strand of pearls.
291 *
292 * However, if you have more than one parents, you cannot
293 * just add their distance and one for yourself, since
294 * they usually reach the same ancestor and you would
295 * end up counting them twice that way.
296 *
297 * So we will first count distance of merges the usual
298 * way, and then fill the blanks using cheaper algorithm.
299 */
300 for (p = list; p; p = p->next) {
301 if (p->item->object.flags & UNINTERESTING)
302 continue;
303 if (weight(p) != -2)
304 continue;
305 weight_set(p, count_distance(p));
306 clear_distance(list);
307
308 /* Does it happen to be at exactly half-way? */
309 if (!find_all && halfway(p, nr))
310 return p;
311 counted++;
312 }
313
314 show_list("bisection 2 count_distance", counted, nr, list);
315
316 while (counted < nr) {
317 for (p = list; p; p = p->next) {
318 struct commit_list *q;
319 unsigned flags = p->item->object.flags;
320
321 if (0 <= weight(p))
322 continue;
323 for (q = p->item->parents; q; q = q->next) {
324 if (q->item->object.flags & UNINTERESTING)
325 continue;
326 if (0 <= weight(q))
327 break;
328 }
329 if (!q)
330 continue;
331
332 /*
333 * weight for p is unknown but q is known.
334 * add one for p itself if p is to be counted,
335 * otherwise inherit it from q directly.
336 */
337 if (!(flags & TREESAME)) {
338 weight_set(p, weight(q)+1);
339 counted++;
340 show_list("bisection 2 count one",
341 counted, nr, list);
342 }
343 else
344 weight_set(p, weight(q));
345
346 /* Does it happen to be at exactly half-way? */
347 if (!find_all && halfway(p, nr))
348 return p;
349 }
350 }
351
352 show_list("bisection 2 counted all", counted, nr, list);
353
354 if (!find_all)
355 return best_bisection(list, nr);
356 else
357 return best_bisection_sorted(list, nr);
358}
359
360struct commit_list *find_bisection(struct commit_list *list,
361 int *reaches, int *all,
362 int find_all)
363{
364 int nr, on_list;
365 struct commit_list *p, *best, *next, *last;
366 int *weights;
367
368 show_list("bisection 2 entry", 0, 0, list);
369
370 /*
371 * Count the number of total and tree-changing items on the
372 * list, while reversing the list.
373 */
374 for (nr = on_list = 0, last = NULL, p = list;
375 p;
376 p = next) {
377 unsigned flags = p->item->object.flags;
378
379 next = p->next;
380 if (flags & UNINTERESTING)
381 continue;
382 p->next = last;
383 last = p;
384 if (!(flags & TREESAME))
385 nr++;
386 on_list++;
387 }
388 list = last;
389 show_list("bisection 2 sorted", 0, nr, list);
390
391 *all = nr;
392 weights = xcalloc(on_list, sizeof(*weights));
393
394 /* Do the real work of finding bisection commit. */
395 best = do_find_bisection(list, nr, weights, find_all);
396 if (best) {
397 if (!find_all)
398 best->next = NULL;
399 *reaches = weight(best);
400 }
401 free(weights);
402 return best;
403}
404
Michael Haggertyeed25142015-05-25 18:38:31405static int register_ref(const char *refname, const struct object_id *oid,
Christian Couder1bf072e2009-03-26 04:55:54406 int flags, void *cb_data)
407{
Antoine Delaite43f9d9f2015-06-29 15:40:29408 struct strbuf good_prefix = STRBUF_INIT;
409 strbuf_addstr(&good_prefix, term_good);
410 strbuf_addstr(&good_prefix, "-");
411
412 if (!strcmp(refname, term_bad)) {
brian m. carlson3c5ff992015-03-13 23:39:29413 current_bad_oid = xmalloc(sizeof(*current_bad_oid));
Michael Haggertyeed25142015-05-25 18:38:31414 oidcpy(current_bad_oid, oid);
Antoine Delaite43f9d9f2015-06-29 15:40:29415 } else if (starts_with(refname, good_prefix.buf)) {
Michael Haggertyeed25142015-05-25 18:38:31416 sha1_array_append(&good_revs, oid->hash);
Christian Couder59556542013-11-30 20:55:40417 } else if (starts_with(refname, "skip-")) {
Michael Haggertyeed25142015-05-25 18:38:31418 sha1_array_append(&skipped_revs, oid->hash);
Christian Couder1bf072e2009-03-26 04:55:54419 }
420
Antoine Delaite43f9d9f2015-06-29 15:40:29421 strbuf_release(&good_prefix);
422
Christian Couder1bf072e2009-03-26 04:55:54423 return 0;
424}
425
426static int read_bisect_refs(void)
427{
Michael Haggertyeed25142015-05-25 18:38:31428 return for_each_ref_in("refs/bisect/", register_ref, NULL);
Christian Couder1bf072e2009-03-26 04:55:54429}
430
Jeff Kingf9327292015-08-10 09:38:57431static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
432static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
433
Linus Torvalds2af202b2009-06-18 17:28:43434static void read_bisect_paths(struct argv_array *array)
Christian Couder3b437b02009-03-26 04:55:59435{
436 struct strbuf str = STRBUF_INIT;
Jeff Kingf9327292015-08-10 09:38:57437 const char *filename = git_path_bisect_names();
Christian Couder3b437b02009-03-26 04:55:59438 FILE *fp = fopen(filename, "r");
439
440 if (!fp)
Vasco Almeida14dc4892016-06-17 20:21:12441 die_errno(_("Could not open file '%s'"), filename);
Christian Couder3b437b02009-03-26 04:55:59442
Junio C Hamano8f309ae2016-01-13 23:31:17443 while (strbuf_getline_lf(&str, fp) != EOF) {
Christian Couder3b437b02009-03-26 04:55:59444 strbuf_trim(&str);
Jeff King8a534b62011-09-13 21:58:14445 if (sq_dequote_to_argv_array(str.buf, array))
Vasco Almeida14dc4892016-06-17 20:21:12446 die(_("Badly quoted content in file '%s': %s"),
Jeff King8a534b62011-09-13 21:58:14447 filename, str.buf);
Christian Couder3b437b02009-03-26 04:55:59448 }
449
450 strbuf_release(&str);
451 fclose(fp);
452}
453
Christian Couderc0537662009-05-09 15:55:45454static char *join_sha1_array_hex(struct sha1_array *array, char delim)
455{
456 struct strbuf joined_hexs = STRBUF_INIT;
457 int i;
458
Jeff King902bb362011-05-19 21:34:33459 for (i = 0; i < array->nr; i++) {
Christian Couderc0537662009-05-09 15:55:45460 strbuf_addstr(&joined_hexs, sha1_to_hex(array->sha1[i]));
Jeff King902bb362011-05-19 21:34:33461 if (i + 1 < array->nr)
Christian Couderc0537662009-05-09 15:55:45462 strbuf_addch(&joined_hexs, delim);
463 }
464
465 return strbuf_detach(&joined_hexs, NULL);
466}
467
Christian Couder9af35892009-06-06 04:41:33468/*
469 * In this function, passing a not NULL skipped_first is very special.
470 * It means that we want to know if the first commit in the list is
471 * skipped because we will want to test a commit away from it if it is
472 * indeed skipped.
473 * So if the first commit is skipped, we cannot take the shortcut to
474 * just "return list" when we find the first non skipped commit, we
475 * have to return a fully filtered list.
476 *
477 * We use (*skipped_first == -1) to mean "it has been found that the
478 * first commit is not skipped". In this case *skipped_first is set back
479 * to 0 just before the function returns.
480 */
Christian Couder95188642009-03-26 04:55:49481struct commit_list *filter_skipped(struct commit_list *list,
482 struct commit_list **tried,
Christian Couder9af35892009-06-06 04:41:33483 int show_all,
484 int *count,
485 int *skipped_first)
Christian Couder95188642009-03-26 04:55:49486{
487 struct commit_list *filtered = NULL, **f = &filtered;
488
489 *tried = NULL;
490
Christian Couder9af35892009-06-06 04:41:33491 if (skipped_first)
492 *skipped_first = 0;
493 if (count)
494 *count = 0;
495
Jeff King902bb362011-05-19 21:34:33496 if (!skipped_revs.nr)
Christian Couder95188642009-03-26 04:55:49497 return list;
498
Christian Couder95188642009-03-26 04:55:49499 while (list) {
500 struct commit_list *next = list->next;
501 list->next = NULL;
Jeff King902bb362011-05-19 21:34:33502 if (0 <= sha1_array_lookup(&skipped_revs,
brian m. carlsoned1c9972015-11-10 02:22:29503 list->item->object.oid.hash)) {
Christian Couder9af35892009-06-06 04:41:33504 if (skipped_first && !*skipped_first)
505 *skipped_first = 1;
Christian Couder95188642009-03-26 04:55:49506 /* Move current to tried list */
507 *tried = list;
508 tried = &list->next;
509 } else {
Christian Couder9af35892009-06-06 04:41:33510 if (!show_all) {
511 if (!skipped_first || !*skipped_first)
512 return list;
513 } else if (skipped_first && !*skipped_first) {
514 /* This means we know it's not skipped */
515 *skipped_first = -1;
516 }
Christian Couder95188642009-03-26 04:55:49517 /* Move current to filtered list */
518 *f = list;
519 f = &list->next;
Christian Couder9af35892009-06-06 04:41:33520 if (count)
521 (*count)++;
Christian Couder95188642009-03-26 04:55:49522 }
523 list = next;
524 }
525
Christian Couder9af35892009-06-06 04:41:33526 if (skipped_first && *skipped_first == -1)
527 *skipped_first = 0;
528
Christian Couder95188642009-03-26 04:55:49529 return filtered;
530}
Christian Couder1bf072e2009-03-26 04:55:54531
Christian Couderebc95292009-06-13 05:21:06532#define PRN_MODULO 32768
533
534/*
535 * This is a pseudo random number generator based on "man 3 rand".
536 * It is not used properly because the seed is the argument and it
537 * is increased by one between each call, but that should not matter
538 * for this application.
539 */
John Keeping7b96d882013-04-03 19:17:55540static unsigned get_prn(unsigned count) {
Christian Couderebc95292009-06-13 05:21:06541 count = count * 1103515245 + 12345;
John Keeping7b96d882013-04-03 19:17:55542 return (count/65536) % PRN_MODULO;
Christian Couderebc95292009-06-13 05:21:06543}
544
545/*
546 * Custom integer square root from
547 * http://en.wikipedia.org/wiki/Integer_square_root
548 */
549static int sqrti(int val)
Christian Couder62d0b0d2009-06-06 04:41:34550{
Christian Couderebc95292009-06-13 05:21:06551 float d, x = val;
552
553 if (val == 0)
554 return 0;
555
556 do {
557 float y = (x + (float)val / x) / 2;
558 d = (y > x) ? y - x : x - y;
559 x = y;
560 } while (d >= 0.5);
561
562 return (int)x;
563}
564
565static struct commit_list *skip_away(struct commit_list *list, int count)
566{
Christian Couder62d0b0d2009-06-06 04:41:34567 struct commit_list *cur, *previous;
Christian Couderebc95292009-06-13 05:21:06568 int prn, index, i;
569
570 prn = get_prn(count);
571 index = (count * prn / PRN_MODULO) * sqrti(prn) / sqrti(PRN_MODULO);
Christian Couder62d0b0d2009-06-06 04:41:34572
573 cur = list;
574 previous = NULL;
Christian Couder62d0b0d2009-06-06 04:41:34575
576 for (i = 0; cur; cur = cur->next, i++) {
577 if (i == index) {
brian m. carlsonf2fd0762015-11-10 02:22:28578 if (oidcmp(&cur->item->object.oid, current_bad_oid))
Christian Couder62d0b0d2009-06-06 04:41:34579 return cur;
580 if (previous)
581 return previous;
582 return list;
583 }
584 previous = cur;
585 }
586
587 return list;
588}
589
590static struct commit_list *managed_skipped(struct commit_list *list,
591 struct commit_list **tried)
592{
593 int count, skipped_first;
Christian Couder62d0b0d2009-06-06 04:41:34594
595 *tried = NULL;
596
Jeff King902bb362011-05-19 21:34:33597 if (!skipped_revs.nr)
Christian Couder62d0b0d2009-06-06 04:41:34598 return list;
599
600 list = filter_skipped(list, tried, 0, &count, &skipped_first);
601
602 if (!skipped_first)
603 return list;
604
Christian Couderebc95292009-06-13 05:21:06605 return skip_away(list, count);
Christian Couder62d0b0d2009-06-06 04:41:34606}
607
Christian Coudera22347c2009-05-17 15:36:44608static void bisect_rev_setup(struct rev_info *revs, const char *prefix,
609 const char *bad_format, const char *good_format,
610 int read_paths)
Christian Couder1bf072e2009-03-26 04:55:54611{
Jeff King8a534b62011-09-13 21:58:14612 struct argv_array rev_argv = ARGV_ARRAY_INIT;
Christian Couderfad2d312009-05-09 15:55:40613 int i;
614
Christian Couder3b437b02009-03-26 04:55:59615 init_revisions(revs, prefix);
616 revs->abbrev = 0;
617 revs->commit_format = CMIT_FMT_UNSPECIFIED;
Christian Couder1bf072e2009-03-26 04:55:54618
Christian Couder1c953a12009-05-09 15:55:41619 /* rev_argv.argv[0] will be ignored by setup_revisions */
Jeff King8a534b62011-09-13 21:58:14620 argv_array_push(&rev_argv, "bisect_rev_setup");
brian m. carlson3c5ff992015-03-13 23:39:29621 argv_array_pushf(&rev_argv, bad_format, oid_to_hex(current_bad_oid));
Jeff King902bb362011-05-19 21:34:33622 for (i = 0; i < good_revs.nr; i++)
Jeff King8a534b62011-09-13 21:58:14623 argv_array_pushf(&rev_argv, good_format,
624 sha1_to_hex(good_revs.sha1[i]));
625 argv_array_push(&rev_argv, "--");
Christian Coudera22347c2009-05-17 15:36:44626 if (read_paths)
627 read_bisect_paths(&rev_argv);
Christian Couder1bf072e2009-03-26 04:55:54628
Jeff King8a534b62011-09-13 21:58:14629 setup_revisions(rev_argv.argc, rev_argv.argv, revs, NULL);
630 /* XXX leak rev_argv, as "revs" may still be pointing to it */
Christian Couder3b437b02009-03-26 04:55:59631}
632
Christian Coudera22347c2009-05-17 15:36:44633static void bisect_common(struct rev_info *revs)
Christian Couder2ace9722009-04-19 09:55:57634{
Christian Couder2ace9722009-04-19 09:55:57635 if (prepare_revision_walk(revs))
636 die("revision walk setup failed");
637 if (revs->tree_objects)
Nguyễn Thái Ngọc Duye76a5fb2013-08-16 09:52:06638 mark_edges_uninteresting(revs, NULL);
Christian Couder2ace9722009-04-19 09:55:57639}
640
Christian Couderef24c7c2009-04-19 09:56:07641static void exit_if_skipped_commits(struct commit_list *tried,
brian m. carlson3c5ff992015-03-13 23:39:29642 const struct object_id *bad)
Christian Couderef24c7c2009-04-19 09:56:07643{
644 if (!tried)
645 return;
646
647 printf("There are only 'skip'ped commits left to test.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29648 "The first %s commit could be any of:\n", term_bad);
Junio C Hamano54307ea2016-07-08 17:09:28649
650 for ( ; tried; tried = tried->next)
651 printf("%s\n", oid_to_hex(&tried->item->object.oid));
652
Christian Couderef24c7c2009-04-19 09:56:07653 if (bad)
brian m. carlson3c5ff992015-03-13 23:39:29654 printf("%s\n", oid_to_hex(bad));
Vasco Almeida14dc4892016-06-17 20:21:12655 printf(_("We cannot bisect more!\n"));
Christian Couderef24c7c2009-04-19 09:56:07656 exit(2);
657}
658
brian m. carlson3c5ff992015-03-13 23:39:29659static int is_expected_rev(const struct object_id *oid)
Christian Couderc0537662009-05-09 15:55:45660{
Jeff Kingf9327292015-08-10 09:38:57661 const char *filename = git_path_bisect_expected_rev();
Christian Couderc0537662009-05-09 15:55:45662 struct stat st;
663 struct strbuf str = STRBUF_INIT;
664 FILE *fp;
665 int res = 0;
666
667 if (stat(filename, &st) || !S_ISREG(st.st_mode))
668 return 0;
669
670 fp = fopen(filename, "r");
671 if (!fp)
672 return 0;
673
Junio C Hamano8f309ae2016-01-13 23:31:17674 if (strbuf_getline_lf(&str, fp) != EOF)
brian m. carlson3c5ff992015-03-13 23:39:29675 res = !strcmp(str.buf, oid_to_hex(oid));
Christian Couderc0537662009-05-09 15:55:45676
677 strbuf_release(&str);
678 fclose(fp);
679
680 return res;
681}
682
David Turnerf3a97712015-07-31 06:06:20683static int bisect_checkout(const unsigned char *bisect_rev, int no_checkout)
Christian Couderef24c7c2009-04-19 09:56:07684{
David Turnerf3a97712015-07-31 06:06:20685 char bisect_rev_hex[GIT_SHA1_HEXSZ + 1];
Christian Couderef24c7c2009-04-19 09:56:07686
David Turnerf3a97712015-07-31 06:06:20687 memcpy(bisect_rev_hex, sha1_to_hex(bisect_rev), GIT_SHA1_HEXSZ + 1);
688 update_ref(NULL, "BISECT_EXPECTED_REV", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
Christian Couderef24c7c2009-04-19 09:56:07689
690 argv_checkout[2] = bisect_rev_hex;
Jon Seymourfee92fc2011-08-04 12:01:00691 if (no_checkout) {
David Turnerf3a97712015-07-31 06:06:20692 update_ref(NULL, "BISECT_HEAD", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
Jon Seymourfee92fc2011-08-04 12:01:00693 } else {
Elia Pinto4824d1b2014-01-29 13:25:00694 int res;
Jon Seymourfee92fc2011-08-04 12:01:00695 res = run_command_v_opt(argv_checkout, RUN_GIT_CMD);
696 if (res)
697 exit(res);
698 }
Christian Couderef24c7c2009-04-19 09:56:07699
700 argv_show_branch[1] = bisect_rev_hex;
701 return run_command_v_opt(argv_show_branch, RUN_GIT_CMD);
702}
703
Christian Couderc0537662009-05-09 15:55:45704static struct commit *get_commit_reference(const unsigned char *sha1)
705{
706 struct commit *r = lookup_commit_reference(sha1);
707 if (!r)
Vasco Almeida14dc4892016-06-17 20:21:12708 die(_("Not a valid commit name %s"), sha1_to_hex(sha1));
Christian Couderc0537662009-05-09 15:55:45709 return r;
710}
711
712static struct commit **get_bad_and_good_commits(int *rev_nr)
713{
Jeff Kingb32fa952016-02-22 22:44:25714 struct commit **rev;
Christian Couderc0537662009-05-09 15:55:45715 int i, n = 0;
716
Jeff Kingb32fa952016-02-22 22:44:25717 ALLOC_ARRAY(rev, 1 + good_revs.nr);
brian m. carlson3c5ff992015-03-13 23:39:29718 rev[n++] = get_commit_reference(current_bad_oid->hash);
Jeff King902bb362011-05-19 21:34:33719 for (i = 0; i < good_revs.nr; i++)
Christian Couderc0537662009-05-09 15:55:45720 rev[n++] = get_commit_reference(good_revs.sha1[i]);
721 *rev_nr = n;
722
723 return rev;
724}
725
726static void handle_bad_merge_base(void)
727{
brian m. carlson3c5ff992015-03-13 23:39:29728 if (is_expected_rev(current_bad_oid)) {
729 char *bad_hex = oid_to_hex(current_bad_oid);
Christian Couderc0537662009-05-09 15:55:45730 char *good_hex = join_sha1_array_hex(&good_revs, ' ');
Antoine Delaite43f9d9f2015-06-29 15:40:29731 if (!strcmp(term_bad, "bad") && !strcmp(term_good, "good")) {
Vasco Almeida14dc4892016-06-17 20:21:12732 fprintf(stderr, _("The merge base %s is bad.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29733 "This means the bug has been fixed "
Vasco Almeida14dc4892016-06-17 20:21:12734 "between %s and [%s].\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29735 bad_hex, bad_hex, good_hex);
Antoine Delaite21e5cfd2015-06-29 15:40:33736 } else if (!strcmp(term_bad, "new") && !strcmp(term_good, "old")) {
Vasco Almeida14dc4892016-06-17 20:21:12737 fprintf(stderr, _("The merge base %s is new.\n"
Antoine Delaite21e5cfd2015-06-29 15:40:33738 "The property has changed "
Vasco Almeida14dc4892016-06-17 20:21:12739 "between %s and [%s].\n"),
Antoine Delaite21e5cfd2015-06-29 15:40:33740 bad_hex, bad_hex, good_hex);
Antoine Delaite43f9d9f2015-06-29 15:40:29741 } else {
Vasco Almeida14dc4892016-06-17 20:21:12742 fprintf(stderr, _("The merge base %s is %s.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29743 "This means the first '%s' commit is "
Vasco Almeida14dc4892016-06-17 20:21:12744 "between %s and [%s].\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29745 bad_hex, term_bad, term_good, bad_hex, good_hex);
746 }
Christian Couderc0537662009-05-09 15:55:45747 exit(3);
748 }
749
Vasco Almeida14dc4892016-06-17 20:21:12750 fprintf(stderr, _("Some %s revs are not ancestor of the %s rev.\n"
Christian Couderc0537662009-05-09 15:55:45751 "git bisect cannot work properly in this case.\n"
Vasco Almeida14dc4892016-06-17 20:21:12752 "Maybe you mistook %s and %s revs?\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29753 term_good, term_bad, term_good, term_bad);
Christian Couderc0537662009-05-09 15:55:45754 exit(1);
755}
756
Linus Torvalds2af202b2009-06-18 17:28:43757static void handle_skipped_merge_base(const unsigned char *mb)
Christian Couderc0537662009-05-09 15:55:45758{
759 char *mb_hex = sha1_to_hex(mb);
brian m. carlsonc368dde2016-06-24 23:09:22760 char *bad_hex = oid_to_hex(current_bad_oid);
Christian Couderc0537662009-05-09 15:55:45761 char *good_hex = join_sha1_array_hex(&good_revs, ' ');
762
Vasco Almeida14dc4892016-06-17 20:21:12763 warning(_("the merge base between %s and [%s] "
Christian Couderc0537662009-05-09 15:55:45764 "must be skipped.\n"
Antoine Delaite43f9d9f2015-06-29 15:40:29765 "So we cannot be sure the first %s commit is "
Christian Couderc0537662009-05-09 15:55:45766 "between %s and %s.\n"
Vasco Almeida14dc4892016-06-17 20:21:12767 "We continue anyway."),
Antoine Delaite43f9d9f2015-06-29 15:40:29768 bad_hex, good_hex, term_bad, mb_hex, bad_hex);
Christian Couderc0537662009-05-09 15:55:45769 free(good_hex);
770}
771
772/*
Antoine Delaite21e5cfd2015-06-29 15:40:33773 * "check_merge_bases" checks that merge bases are not "bad" (or "new").
Christian Couderc0537662009-05-09 15:55:45774 *
Antoine Delaite21e5cfd2015-06-29 15:40:33775 * - If one is "bad" (or "new"), it means the user assumed something wrong
Christian Couderc0537662009-05-09 15:55:45776 * and we must exit with a non 0 error code.
Antoine Delaite21e5cfd2015-06-29 15:40:33777 * - If one is "good" (or "old"), that's good, we have nothing to do.
Christian Couderc0537662009-05-09 15:55:45778 * - If one is "skipped", we can't know but we should warn.
779 * - If we don't know, we should check it out and ask the user to test.
780 */
Jon Seymourfee92fc2011-08-04 12:01:00781static void check_merge_bases(int no_checkout)
Christian Couderc0537662009-05-09 15:55:45782{
783 struct commit_list *result;
784 int rev_nr;
785 struct commit **rev = get_bad_and_good_commits(&rev_nr);
786
Junio C Hamano2ce406c2014-10-30 19:20:44787 result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1);
Christian Couderc0537662009-05-09 15:55:45788
789 for (; result; result = result->next) {
brian m. carlsoned1c9972015-11-10 02:22:29790 const unsigned char *mb = result->item->object.oid.hash;
brian m. carlson3c5ff992015-03-13 23:39:29791 if (!hashcmp(mb, current_bad_oid->hash)) {
Christian Couderc0537662009-05-09 15:55:45792 handle_bad_merge_base();
Jeff King902bb362011-05-19 21:34:33793 } else if (0 <= sha1_array_lookup(&good_revs, mb)) {
Christian Couderc0537662009-05-09 15:55:45794 continue;
Jeff King902bb362011-05-19 21:34:33795 } else if (0 <= sha1_array_lookup(&skipped_revs, mb)) {
Christian Couderc0537662009-05-09 15:55:45796 handle_skipped_merge_base(mb);
797 } else {
Vasco Almeida14dc4892016-06-17 20:21:12798 printf(_("Bisecting: a merge base must be tested\n"));
David Turnerf3a97712015-07-31 06:06:20799 exit(bisect_checkout(mb, no_checkout));
Christian Couderc0537662009-05-09 15:55:45800 }
801 }
802
803 free(rev);
804 free_commit_list(result);
805}
806
Christian Couder2d938fc2009-05-17 15:36:46807static int check_ancestors(const char *prefix)
Christian Couderd937d4a2009-05-09 15:55:46808{
Christian Couder2d938fc2009-05-17 15:36:46809 struct rev_info revs;
810 struct object_array pending_copy;
René Scharfe86a0a402011-10-01 16:16:08811 int res;
Christian Couderd937d4a2009-05-09 15:55:46812
Christian Couder2d938fc2009-05-17 15:36:46813 bisect_rev_setup(&revs, prefix, "^%s", "%s", 0);
Christian Couderd937d4a2009-05-09 15:55:46814
Christian Couder2d938fc2009-05-17 15:36:46815 /* Save pending objects, so they can be cleaned up later. */
René Scharfe353f5652011-10-01 16:01:12816 pending_copy = revs.pending;
817 revs.leak_pending = 1;
Christian Couder2d938fc2009-05-17 15:36:46818
René Scharfe353f5652011-10-01 16:01:12819 /*
820 * bisect_common calls prepare_revision_walk right away, which
821 * (together with .leak_pending = 1) makes us the sole owner of
822 * the list of pending objects.
823 */
Christian Couder2d938fc2009-05-17 15:36:46824 bisect_common(&revs);
825 res = (revs.commits != NULL);
826
827 /* Clean up objects used, as they will be reused. */
René Scharfe86a0a402011-10-01 16:16:08828 clear_commit_marks_for_object_array(&pending_copy, ALL_REV_FLAGS);
René Scharfe353f5652011-10-01 16:01:12829 free(pending_copy.objects);
Christian Couderd937d4a2009-05-09 15:55:46830
Christian Couder2d938fc2009-05-17 15:36:46831 return res;
Christian Couderd937d4a2009-05-09 15:55:46832}
833
834/*
835 * "check_good_are_ancestors_of_bad" checks that all "good" revs are
836 * ancestor of the "bad" rev.
837 *
838 * If that's not the case, we need to check the merge bases.
839 * If a merge base must be tested by the user, its source code will be
840 * checked out to be tested by the user and we will exit.
841 */
Jon Seymourfee92fc2011-08-04 12:01:00842static void check_good_are_ancestors_of_bad(const char *prefix, int no_checkout)
Christian Couderd937d4a2009-05-09 15:55:46843{
Ramsay Jonesd292bfa2012-09-04 17:30:21844 char *filename = git_pathdup("BISECT_ANCESTORS_OK");
Christian Couderd937d4a2009-05-09 15:55:46845 struct stat st;
846 int fd;
847
brian m. carlson3c5ff992015-03-13 23:39:29848 if (!current_bad_oid)
Vasco Almeida14dc4892016-06-17 20:21:12849 die(_("a %s revision is needed"), term_bad);
Christian Couderd937d4a2009-05-09 15:55:46850
851 /* Check if file BISECT_ANCESTORS_OK exists. */
852 if (!stat(filename, &st) && S_ISREG(st.st_mode))
Michael Haggerty144e7092012-04-26 22:26:59853 goto done;
Christian Couderd937d4a2009-05-09 15:55:46854
855 /* Bisecting with no good rev is ok. */
Jeff King902bb362011-05-19 21:34:33856 if (good_revs.nr == 0)
Michael Haggerty144e7092012-04-26 22:26:59857 goto done;
Christian Couderd937d4a2009-05-09 15:55:46858
Christian Couder2d938fc2009-05-17 15:36:46859 /* Check if all good revs are ancestor of the bad rev. */
860 if (check_ancestors(prefix))
Jon Seymourfee92fc2011-08-04 12:01:00861 check_merge_bases(no_checkout);
Christian Couderd937d4a2009-05-09 15:55:46862
863 /* Create file BISECT_ANCESTORS_OK. */
864 fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
865 if (fd < 0)
Vasco Almeida14dc4892016-06-17 20:21:12866 warning_errno(_("could not create file '%s'"),
Nguyễn Thái Ngọc Duy23e7a312016-05-08 09:47:23867 filename);
Christian Couderd937d4a2009-05-09 15:55:46868 else
869 close(fd);
Michael Haggerty144e7092012-04-26 22:26:59870 done:
871 free(filename);
Christian Couderd937d4a2009-05-09 15:55:46872}
873
874/*
Christian Coudere22278c2009-05-28 21:21:16875 * This does "git diff-tree --pretty COMMIT" without one fork+exec.
876 */
877static void show_diff_tree(const char *prefix, struct commit *commit)
878{
879 struct rev_info opt;
880
881 /* diff-tree init */
882 init_revisions(&opt, prefix);
883 git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
884 opt.abbrev = 0;
885 opt.diff = 1;
886
887 /* This is what "--pretty" does */
888 opt.verbose_header = 1;
889 opt.use_terminator = 0;
890 opt.commit_format = CMIT_FMT_DEFAULT;
891
892 /* diff-tree init */
893 if (!opt.diffopt.output_format)
894 opt.diffopt.output_format = DIFF_FORMAT_RAW;
895
Jeff King43ec5502016-06-16 23:37:20896 setup_revisions(0, NULL, &opt, NULL);
Christian Coudere22278c2009-05-28 21:21:16897 log_tree_commit(&opt, commit);
898}
899
900/*
Antoine Delaitecb46d632015-06-29 15:40:30901 * The terms used for this bisect session are stored in BISECT_TERMS.
902 * We read them and store them to adapt the messages accordingly.
903 * Default is bad/good.
904 */
905void read_bisect_terms(const char **read_bad, const char **read_good)
906{
907 struct strbuf str = STRBUF_INIT;
908 const char *filename = git_path("BISECT_TERMS");
909 FILE *fp = fopen(filename, "r");
910
911 if (!fp) {
912 if (errno == ENOENT) {
913 *read_bad = "bad";
914 *read_good = "good";
915 return;
916 } else {
Vasco Almeida14dc4892016-06-17 20:21:12917 die_errno(_("could not read file '%s'"), filename);
Antoine Delaitecb46d632015-06-29 15:40:30918 }
919 } else {
Junio C Hamano8f309ae2016-01-13 23:31:17920 strbuf_getline_lf(&str, fp);
Antoine Delaitecb46d632015-06-29 15:40:30921 *read_bad = strbuf_detach(&str, NULL);
Junio C Hamano8f309ae2016-01-13 23:31:17922 strbuf_getline_lf(&str, fp);
Antoine Delaitecb46d632015-06-29 15:40:30923 *read_good = strbuf_detach(&str, NULL);
924 }
925 strbuf_release(&str);
926 fclose(fp);
927}
928
929/*
Christian Couderef24c7c2009-04-19 09:56:07930 * We use the convention that exiting with an exit code 10 means that
931 * the bisection process finished successfully.
932 * In this case the calling shell script should exit 0.
Jon Seymourfee92fc2011-08-04 12:01:00933 *
934 * If no_checkout is non-zero, the bisection process does not
935 * checkout the trial commit but instead simply updates BISECT_HEAD.
Christian Couderef24c7c2009-04-19 09:56:07936 */
Jon Seymourfee92fc2011-08-04 12:01:00937int bisect_next_all(const char *prefix, int no_checkout)
Christian Couderef24c7c2009-04-19 09:56:07938{
939 struct rev_info revs;
940 struct commit_list *tried;
David Ripton6329bad2010-01-19 15:13:33941 int reaches = 0, all = 0, nr, steps;
Christian Couderef24c7c2009-04-19 09:56:07942 const unsigned char *bisect_rev;
Vasco Almeida14dc4892016-06-17 20:21:12943 char steps_msg[32];
Christian Couderef24c7c2009-04-19 09:56:07944
Antoine Delaitecb46d632015-06-29 15:40:30945 read_bisect_terms(&term_bad, &term_good);
Christian Couder2b020692009-05-09 15:55:42946 if (read_bisect_refs())
Vasco Almeida14dc4892016-06-17 20:21:12947 die(_("reading bisect refs failed"));
Christian Couder2b020692009-05-09 15:55:42948
Jon Seymourfee92fc2011-08-04 12:01:00949 check_good_are_ancestors_of_bad(prefix, no_checkout);
Christian Couder08719842009-05-09 15:55:47950
Christian Coudera22347c2009-05-17 15:36:44951 bisect_rev_setup(&revs, prefix, "%s", "^%s", 1);
952 revs.limited = 1;
Christian Couder2b020692009-05-09 15:55:42953
Christian Coudera22347c2009-05-17 15:36:44954 bisect_common(&revs);
Christian Couderef24c7c2009-04-19 09:56:07955
Christian Coudera22347c2009-05-17 15:36:44956 revs.commits = find_bisection(revs.commits, &reaches, &all,
Jeff King902bb362011-05-19 21:34:33957 !!skipped_revs.nr);
Christian Couder62d0b0d2009-06-06 04:41:34958 revs.commits = managed_skipped(revs.commits, &tried);
Christian Couderef24c7c2009-04-19 09:56:07959
960 if (!revs.commits) {
961 /*
962 * We should exit here only if the "bad"
963 * commit is also a "skip" commit.
964 */
965 exit_if_skipped_commits(tried, NULL);
966
Vasco Almeida14dc4892016-06-17 20:21:12967 printf(_("%s was both %s and %s\n"),
Antoine Delaite43f9d9f2015-06-29 15:40:29968 oid_to_hex(current_bad_oid),
969 term_good,
970 term_bad);
Christian Couderef24c7c2009-04-19 09:56:07971 exit(1);
972 }
973
Christian Couder8f69f722010-02-28 22:19:09974 if (!all) {
Vasco Almeida14dc4892016-06-17 20:21:12975 fprintf(stderr, _("No testable commit found.\n"
976 "Maybe you started with bad path parameters?\n"));
Christian Couder8f69f722010-02-28 22:19:09977 exit(4);
978 }
979
brian m. carlsoned1c9972015-11-10 02:22:29980 bisect_rev = revs.commits->item->object.oid.hash;
Christian Couderef24c7c2009-04-19 09:56:07981
brian m. carlson3c5ff992015-03-13 23:39:29982 if (!hashcmp(bisect_rev, current_bad_oid->hash)) {
983 exit_if_skipped_commits(tried, current_bad_oid);
Junio C Hamano080cc642015-08-25 21:57:08984 printf("%s is the first %s commit\n", sha1_to_hex(bisect_rev),
Antoine Delaite43f9d9f2015-06-29 15:40:29985 term_bad);
Christian Coudere22278c2009-05-28 21:21:16986 show_diff_tree(prefix, revs.commits->item);
Christian Couderef24c7c2009-04-19 09:56:07987 /* This means the bisection process succeeded. */
988 exit(10);
989 }
990
991 nr = all - reaches - 1;
David Ripton6329bad2010-01-19 15:13:33992 steps = estimate_bisect_steps(all);
Vasco Almeida14dc4892016-06-17 20:21:12993 xsnprintf(steps_msg, sizeof(steps_msg),
994 Q_("(roughly %d step)", "(roughly %d steps)", steps),
995 steps);
996 /* TRANSLATORS: the last %s will be replaced with
997 "(roughly %d steps)" translation */
998 printf(Q_("Bisecting: %d revision left to test after this %s\n",
999 "Bisecting: %d revisions left to test after this %s\n",
1000 nr), nr, steps_msg);
Christian Couderef24c7c2009-04-19 09:56:071001
David Turnerf3a97712015-07-31 06:06:201002 return bisect_checkout(bisect_rev, no_checkout);
Christian Couderef24c7c2009-04-19 09:56:071003}
1004
Nguyễn Thái Ngọc Duyc43cb382012-10-26 15:53:501005static inline int log2i(int n)
1006{
1007 int log2 = 0;
1008
1009 for (; n > 1; n >>= 1)
1010 log2++;
1011
1012 return log2;
1013}
1014
1015static inline int exp2i(int n)
1016{
1017 return 1 << n;
1018}
1019
1020/*
1021 * Estimate the number of bisect steps left (after the current step)
1022 *
1023 * For any x between 0 included and 2^n excluded, the probability for
1024 * n - 1 steps left looks like:
1025 *
1026 * P(2^n + x) == (2^n - x) / (2^n + x)
1027 *
1028 * and P(2^n + x) < 0.5 means 2^n < 3x
1029 */
1030int estimate_bisect_steps(int all)
1031{
1032 int n, x, e;
1033
1034 if (all < 3)
1035 return 0;
1036
1037 n = log2i(all);
1038 e = exp2i(n);
1039 x = all - e;
1040
1041 return (e < 3 * x) ? n : n - 1;
1042}