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