]>
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 | 228 | p->item = array[i].commit; |
7c117184 MÅ |
229 | if (i < cnt - 1) |
230 | p = p->next; | |
a2ad79ce | 231 | } |
7c117184 MÅ |
232 | free_commit_list(p->next); |
233 | p->next = NULL; | |
5b1ef2ce | 234 | strbuf_release(&buf); |
a2ad79ce CC |
235 | free(array); |
236 | return list; | |
237 | } | |
238 | ||
239 | /* | |
240 | * zero or positive weight is the number of interesting commits it can | |
241 | * reach, including itself. Especially, weight = 0 means it does not | |
242 | * reach any tree-changing commits (e.g. just above uninteresting one | |
243 | * but traversal is with pathspec). | |
244 | * | |
245 | * weight = -1 means it has one parent and its distance is yet to | |
246 | * be computed. | |
247 | * | |
248 | * weight = -2 means it has more than one parent and its distance is | |
249 | * unknown. After running count_distance() first, they will get zero | |
250 | * or positive distance. | |
251 | */ | |
252 | static struct commit_list *do_find_bisection(struct commit_list *list, | |
253 | int nr, int *weights, | |
254 | int find_all) | |
255 | { | |
256 | int n, counted; | |
257 | struct commit_list *p; | |
258 | ||
259 | counted = 0; | |
260 | ||
261 | for (n = 0, p = list; p; p = p->next) { | |
262 | struct commit *commit = p->item; | |
263 | unsigned flags = commit->object.flags; | |
264 | ||
265 | p->item->util = &weights[n++]; | |
266 | switch (count_interesting_parents(commit)) { | |
267 | case 0: | |
268 | if (!(flags & TREESAME)) { | |
269 | weight_set(p, 1); | |
270 | counted++; | |
271 | show_list("bisection 2 count one", | |
272 | counted, nr, list); | |
273 | } | |
274 | /* | |
275 | * otherwise, it is known not to reach any | |
276 | * tree-changing commit and gets weight 0. | |
277 | */ | |
278 | break; | |
279 | case 1: | |
280 | weight_set(p, -1); | |
281 | break; | |
282 | default: | |
283 | weight_set(p, -2); | |
284 | break; | |
285 | } | |
286 | } | |
287 | ||
288 | show_list("bisection 2 initialize", counted, nr, list); | |
289 | ||
290 | /* | |
291 | * If you have only one parent in the resulting set | |
292 | * then you can reach one commit more than that parent | |
293 | * can reach. So we do not have to run the expensive | |
294 | * count_distance() for single strand of pearls. | |
295 | * | |
296 | * However, if you have more than one parents, you cannot | |
297 | * just add their distance and one for yourself, since | |
298 | * they usually reach the same ancestor and you would | |
299 | * end up counting them twice that way. | |
300 | * | |
301 | * So we will first count distance of merges the usual | |
302 | * way, and then fill the blanks using cheaper algorithm. | |
303 | */ | |
304 | for (p = list; p; p = p->next) { | |
305 | if (p->item->object.flags & UNINTERESTING) | |
306 | continue; | |
307 | if (weight(p) != -2) | |
308 | continue; | |
309 | weight_set(p, count_distance(p)); | |
310 | clear_distance(list); | |
311 | ||
312 | /* Does it happen to be at exactly half-way? */ | |
313 | if (!find_all && halfway(p, nr)) | |
314 | return p; | |
315 | counted++; | |
316 | } | |
317 | ||
318 | show_list("bisection 2 count_distance", counted, nr, list); | |
319 | ||
320 | while (counted < nr) { | |
321 | for (p = list; p; p = p->next) { | |
322 | struct commit_list *q; | |
323 | unsigned flags = p->item->object.flags; | |
324 | ||
325 | if (0 <= weight(p)) | |
326 | continue; | |
327 | for (q = p->item->parents; q; q = q->next) { | |
328 | if (q->item->object.flags & UNINTERESTING) | |
329 | continue; | |
330 | if (0 <= weight(q)) | |
331 | break; | |
332 | } | |
333 | if (!q) | |
334 | continue; | |
335 | ||
336 | /* | |
337 | * weight for p is unknown but q is known. | |
338 | * add one for p itself if p is to be counted, | |
339 | * otherwise inherit it from q directly. | |
340 | */ | |
341 | if (!(flags & TREESAME)) { | |
342 | weight_set(p, weight(q)+1); | |
343 | counted++; | |
344 | show_list("bisection 2 count one", | |
345 | counted, nr, list); | |
346 | } | |
347 | else | |
348 | weight_set(p, weight(q)); | |
349 | ||
350 | /* Does it happen to be at exactly half-way? */ | |
351 | if (!find_all && halfway(p, nr)) | |
352 | return p; | |
353 | } | |
354 | } | |
355 | ||
356 | show_list("bisection 2 counted all", counted, nr, list); | |
357 | ||
358 | if (!find_all) | |
359 | return best_bisection(list, nr); | |
360 | else | |
361 | return best_bisection_sorted(list, nr); | |
362 | } | |
363 | ||
24d707f6 MÅ |
364 | void find_bisection(struct commit_list **commit_list, int *reaches, |
365 | int *all, int find_all) | |
a2ad79ce CC |
366 | { |
367 | int nr, on_list; | |
24d707f6 | 368 | struct commit_list *list, *p, *best, *next, *last; |
a2ad79ce CC |
369 | int *weights; |
370 | ||
24d707f6 | 371 | show_list("bisection 2 entry", 0, 0, *commit_list); |
a2ad79ce CC |
372 | |
373 | /* | |
374 | * Count the number of total and tree-changing items on the | |
375 | * list, while reversing the list. | |
376 | */ | |
24d707f6 | 377 | for (nr = on_list = 0, last = NULL, p = *commit_list; |
a2ad79ce CC |
378 | p; |
379 | p = next) { | |
380 | unsigned flags = p->item->object.flags; | |
381 | ||
382 | next = p->next; | |
fc5c40bb MÅ |
383 | if (flags & UNINTERESTING) { |
384 | free(p); | |
a2ad79ce | 385 | continue; |
fc5c40bb | 386 | } |
a2ad79ce CC |
387 | p->next = last; |
388 | last = p; | |
389 | if (!(flags & TREESAME)) | |
390 | nr++; | |
391 | on_list++; | |
392 | } | |
393 | list = last; | |
394 | show_list("bisection 2 sorted", 0, nr, list); | |
395 | ||
396 | *all = nr; | |
397 | weights = xcalloc(on_list, sizeof(*weights)); | |
398 | ||
399 | /* Do the real work of finding bisection commit. */ | |
400 | best = do_find_bisection(list, nr, weights, find_all); | |
401 | if (best) { | |
f4e45cb3 MÅ |
402 | if (!find_all) { |
403 | list->item = best->item; | |
404 | free_commit_list(list->next); | |
405 | best = list; | |
a2ad79ce | 406 | best->next = NULL; |
f4e45cb3 | 407 | } |
a2ad79ce CC |
408 | *reaches = weight(best); |
409 | } | |
410 | free(weights); | |
24d707f6 | 411 | *commit_list = best; |
a2ad79ce CC |
412 | } |
413 | ||
eed25148 | 414 | static int register_ref(const char *refname, const struct object_id *oid, |
1bf072e3 CC |
415 | int flags, void *cb_data) |
416 | { | |
43f9d9f3 AD |
417 | struct strbuf good_prefix = STRBUF_INIT; |
418 | strbuf_addstr(&good_prefix, term_good); | |
419 | strbuf_addstr(&good_prefix, "-"); | |
420 | ||
421 | if (!strcmp(refname, term_bad)) { | |
3c5ff995 | 422 | current_bad_oid = xmalloc(sizeof(*current_bad_oid)); |
eed25148 | 423 | oidcpy(current_bad_oid, oid); |
43f9d9f3 | 424 | } else if (starts_with(refname, good_prefix.buf)) { |
910650d2 | 425 | oid_array_append(&good_revs, oid); |
59556548 | 426 | } else if (starts_with(refname, "skip-")) { |
910650d2 | 427 | oid_array_append(&skipped_revs, oid); |
1bf072e3 CC |
428 | } |
429 | ||
43f9d9f3 AD |
430 | strbuf_release(&good_prefix); |
431 | ||
1bf072e3 CC |
432 | return 0; |
433 | } | |
434 | ||
435 | static int read_bisect_refs(void) | |
436 | { | |
eed25148 | 437 | return for_each_ref_in("refs/bisect/", register_ref, NULL); |
1bf072e3 CC |
438 | } |
439 | ||
f932729c JK |
440 | static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES") |
441 | static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV") | |
f5d284f6 | 442 | static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS") |
f932729c | 443 | |
2af202be | 444 | static void read_bisect_paths(struct argv_array *array) |
3b437b0d CC |
445 | { |
446 | struct strbuf str = STRBUF_INIT; | |
f932729c | 447 | const char *filename = git_path_bisect_names(); |
23a9e071 | 448 | FILE *fp = xfopen(filename, "r"); |
3b437b0d | 449 | |
8f309aeb | 450 | while (strbuf_getline_lf(&str, fp) != EOF) { |
3b437b0d | 451 | strbuf_trim(&str); |
8a534b61 | 452 | if (sq_dequote_to_argv_array(str.buf, array)) |
14dc4899 | 453 | die(_("Badly quoted content in file '%s': %s"), |
8a534b61 | 454 | filename, str.buf); |
3b437b0d CC |
455 | } |
456 | ||
457 | strbuf_release(&str); | |
458 | fclose(fp); | |
459 | } | |
460 | ||
910650d2 | 461 | static char *join_sha1_array_hex(struct oid_array *array, char delim) |
c0537662 CC |
462 | { |
463 | struct strbuf joined_hexs = STRBUF_INIT; | |
464 | int i; | |
465 | ||
902bb364 | 466 | for (i = 0; i < array->nr; i++) { |
ee3051bd | 467 | strbuf_addstr(&joined_hexs, oid_to_hex(array->oid + i)); |
902bb364 | 468 | if (i + 1 < array->nr) |
c0537662 CC |
469 | strbuf_addch(&joined_hexs, delim); |
470 | } | |
471 | ||
472 | return strbuf_detach(&joined_hexs, NULL); | |
473 | } | |
474 | ||
9af3589e CC |
475 | /* |
476 | * In this function, passing a not NULL skipped_first is very special. | |
477 | * It means that we want to know if the first commit in the list is | |
478 | * skipped because we will want to test a commit away from it if it is | |
479 | * indeed skipped. | |
480 | * So if the first commit is skipped, we cannot take the shortcut to | |
481 | * just "return list" when we find the first non skipped commit, we | |
482 | * have to return a fully filtered list. | |
483 | * | |
484 | * We use (*skipped_first == -1) to mean "it has been found that the | |
485 | * first commit is not skipped". In this case *skipped_first is set back | |
486 | * to 0 just before the function returns. | |
487 | */ | |
95188648 CC |
488 | struct commit_list *filter_skipped(struct commit_list *list, |
489 | struct commit_list **tried, | |
9af3589e CC |
490 | int show_all, |
491 | int *count, | |
492 | int *skipped_first) | |
95188648 CC |
493 | { |
494 | struct commit_list *filtered = NULL, **f = &filtered; | |
495 | ||
496 | *tried = NULL; | |
497 | ||
9af3589e CC |
498 | if (skipped_first) |
499 | *skipped_first = 0; | |
500 | if (count) | |
501 | *count = 0; | |
502 | ||
902bb364 | 503 | if (!skipped_revs.nr) |
95188648 CC |
504 | return list; |
505 | ||
95188648 CC |
506 | while (list) { |
507 | struct commit_list *next = list->next; | |
508 | list->next = NULL; | |
910650d2 | 509 | if (0 <= oid_array_lookup(&skipped_revs, &list->item->object.oid)) { |
9af3589e CC |
510 | if (skipped_first && !*skipped_first) |
511 | *skipped_first = 1; | |
95188648 CC |
512 | /* Move current to tried list */ |
513 | *tried = list; | |
514 | tried = &list->next; | |
515 | } else { | |
9af3589e CC |
516 | if (!show_all) { |
517 | if (!skipped_first || !*skipped_first) | |
518 | return list; | |
519 | } else if (skipped_first && !*skipped_first) { | |
520 | /* This means we know it's not skipped */ | |
521 | *skipped_first = -1; | |
522 | } | |
95188648 CC |
523 | /* Move current to filtered list */ |
524 | *f = list; | |
525 | f = &list->next; | |
9af3589e CC |
526 | if (count) |
527 | (*count)++; | |
95188648 CC |
528 | } |
529 | list = next; | |
530 | } | |
531 | ||
9af3589e CC |
532 | if (skipped_first && *skipped_first == -1) |
533 | *skipped_first = 0; | |
534 | ||
95188648 CC |
535 | return filtered; |
536 | } | |
1bf072e3 | 537 | |
ebc9529f CC |
538 | #define PRN_MODULO 32768 |
539 | ||
540 | /* | |
541 | * This is a pseudo random number generator based on "man 3 rand". | |
542 | * It is not used properly because the seed is the argument and it | |
543 | * is increased by one between each call, but that should not matter | |
544 | * for this application. | |
545 | */ | |
7b96d888 | 546 | static unsigned get_prn(unsigned count) { |
ebc9529f | 547 | count = count * 1103515245 + 12345; |
7b96d888 | 548 | return (count/65536) % PRN_MODULO; |
ebc9529f CC |
549 | } |
550 | ||
551 | /* | |
552 | * Custom integer square root from | |
5e68729f | 553 | * https://en.wikipedia.org/wiki/Integer_square_root |
ebc9529f CC |
554 | */ |
555 | static int sqrti(int val) | |
556 | { | |
557 | float d, x = val; | |
558 | ||
559 | if (val == 0) | |
560 | return 0; | |
561 | ||
562 | do { | |
563 | float y = (x + (float)val / x) / 2; | |
564 | d = (y > x) ? y - x : x - y; | |
565 | x = y; | |
566 | } while (d >= 0.5); | |
567 | ||
568 | return (int)x; | |
569 | } | |
570 | ||
571 | static struct commit_list *skip_away(struct commit_list *list, int count) | |
62d0b0da | 572 | { |
62d0b0da | 573 | struct commit_list *cur, *previous; |
ebc9529f CC |
574 | int prn, index, i; |
575 | ||
576 | prn = get_prn(count); | |
577 | index = (count * prn / PRN_MODULO) * sqrti(prn) / sqrti(PRN_MODULO); | |
62d0b0da CC |
578 | |
579 | cur = list; | |
580 | previous = NULL; | |
62d0b0da CC |
581 | |
582 | for (i = 0; cur; cur = cur->next, i++) { | |
583 | if (i == index) { | |
f2fd0760 | 584 | if (oidcmp(&cur->item->object.oid, current_bad_oid)) |
62d0b0da CC |
585 | return cur; |
586 | if (previous) | |
587 | return previous; | |
588 | return list; | |
589 | } | |
590 | previous = cur; | |
591 | } | |
592 | ||
593 | return list; | |
594 | } | |
595 | ||
596 | static struct commit_list *managed_skipped(struct commit_list *list, | |
597 | struct commit_list **tried) | |
598 | { | |
599 | int count, skipped_first; | |
62d0b0da CC |
600 | |
601 | *tried = NULL; | |
602 | ||
902bb364 | 603 | if (!skipped_revs.nr) |
62d0b0da CC |
604 | return list; |
605 | ||
606 | list = filter_skipped(list, tried, 0, &count, &skipped_first); | |
607 | ||
608 | if (!skipped_first) | |
609 | return list; | |
610 | ||
ebc9529f | 611 | return skip_away(list, count); |
62d0b0da CC |
612 | } |
613 | ||
a22347c6 CC |
614 | static void bisect_rev_setup(struct rev_info *revs, const char *prefix, |
615 | const char *bad_format, const char *good_format, | |
616 | int read_paths) | |
1bf072e3 | 617 | { |
8a534b61 | 618 | struct argv_array rev_argv = ARGV_ARRAY_INIT; |
fad2d31d CC |
619 | int i; |
620 | ||
3b437b0d CC |
621 | init_revisions(revs, prefix); |
622 | revs->abbrev = 0; | |
623 | revs->commit_format = CMIT_FMT_UNSPECIFIED; | |
1bf072e3 | 624 | |
1c953a1f | 625 | /* rev_argv.argv[0] will be ignored by setup_revisions */ |
8a534b61 | 626 | argv_array_push(&rev_argv, "bisect_rev_setup"); |
3c5ff995 | 627 | argv_array_pushf(&rev_argv, bad_format, oid_to_hex(current_bad_oid)); |
902bb364 | 628 | for (i = 0; i < good_revs.nr; i++) |
8a534b61 | 629 | argv_array_pushf(&rev_argv, good_format, |
ee3051bd | 630 | oid_to_hex(good_revs.oid + i)); |
8a534b61 | 631 | argv_array_push(&rev_argv, "--"); |
a22347c6 CC |
632 | if (read_paths) |
633 | read_bisect_paths(&rev_argv); | |
3b437b0d | 634 | |
8a534b61 JK |
635 | setup_revisions(rev_argv.argc, rev_argv.argv, revs, NULL); |
636 | /* XXX leak rev_argv, as "revs" may still be pointing to it */ | |
3b437b0d CC |
637 | } |
638 | ||
a22347c6 | 639 | static void bisect_common(struct rev_info *revs) |
2ace9727 | 640 | { |
2ace9727 CC |
641 | if (prepare_revision_walk(revs)) |
642 | die("revision walk setup failed"); | |
643 | if (revs->tree_objects) | |
e76a5fb4 | 644 | mark_edges_uninteresting(revs, NULL); |
2ace9727 CC |
645 | } |
646 | ||
ef24c7ca | 647 | static void exit_if_skipped_commits(struct commit_list *tried, |
3c5ff995 | 648 | const struct object_id *bad) |
ef24c7ca CC |
649 | { |
650 | if (!tried) | |
651 | return; | |
652 | ||
653 | printf("There are only 'skip'ped commits left to test.\n" | |
43f9d9f3 | 654 | "The first %s commit could be any of:\n", term_bad); |
54307ea7 JH |
655 | |
656 | for ( ; tried; tried = tried->next) | |
657 | printf("%s\n", oid_to_hex(&tried->item->object.oid)); | |
658 | ||
ef24c7ca | 659 | if (bad) |
3c5ff995 | 660 | printf("%s\n", oid_to_hex(bad)); |
14dc4899 | 661 | printf(_("We cannot bisect more!\n")); |
ef24c7ca CC |
662 | exit(2); |
663 | } | |
664 | ||
3c5ff995 | 665 | static int is_expected_rev(const struct object_id *oid) |
c0537662 | 666 | { |
f932729c | 667 | const char *filename = git_path_bisect_expected_rev(); |
c0537662 CC |
668 | struct stat st; |
669 | struct strbuf str = STRBUF_INIT; | |
670 | FILE *fp; | |
671 | int res = 0; | |
672 | ||
673 | if (stat(filename, &st) || !S_ISREG(st.st_mode)) | |
674 | return 0; | |
675 | ||
e9d983f1 | 676 | fp = fopen_or_warn(filename, "r"); |
c0537662 CC |
677 | if (!fp) |
678 | return 0; | |
679 | ||
8f309aeb | 680 | if (strbuf_getline_lf(&str, fp) != EOF) |
3c5ff995 | 681 | res = !strcmp(str.buf, oid_to_hex(oid)); |
c0537662 CC |
682 | |
683 | strbuf_release(&str); | |
684 | fclose(fp); | |
685 | ||
686 | return res; | |
687 | } | |
688 | ||
4be0deec | 689 | static int bisect_checkout(const struct object_id *bisect_rev, int no_checkout) |
ef24c7ca | 690 | { |
dc01505f | 691 | char bisect_rev_hex[GIT_MAX_HEXSZ + 1]; |
ef24c7ca | 692 | |
4be0deec | 693 | memcpy(bisect_rev_hex, oid_to_hex(bisect_rev), GIT_SHA1_HEXSZ + 1); |
694 | update_ref(NULL, "BISECT_EXPECTED_REV", bisect_rev->hash, NULL, 0, UPDATE_REFS_DIE_ON_ERR); | |
ef24c7ca CC |
695 | |
696 | argv_checkout[2] = bisect_rev_hex; | |
fee92fc1 | 697 | if (no_checkout) { |
4be0deec | 698 | update_ref(NULL, "BISECT_HEAD", bisect_rev->hash, NULL, 0, UPDATE_REFS_DIE_ON_ERR); |
fee92fc1 | 699 | } else { |
4824d1b8 | 700 | int res; |
fee92fc1 JS |
701 | res = run_command_v_opt(argv_checkout, RUN_GIT_CMD); |
702 | if (res) | |
703 | exit(res); | |
704 | } | |
ef24c7ca CC |
705 | |
706 | argv_show_branch[1] = bisect_rev_hex; | |
707 | return run_command_v_opt(argv_show_branch, RUN_GIT_CMD); | |
708 | } | |
709 | ||
ee3051bd | 710 | static struct commit *get_commit_reference(const struct object_id *oid) |
c0537662 | 711 | { |
bc83266a | 712 | struct commit *r = lookup_commit_reference(oid); |
c0537662 | 713 | if (!r) |
ee3051bd | 714 | die(_("Not a valid commit name %s"), oid_to_hex(oid)); |
c0537662 CC |
715 | return r; |
716 | } | |
717 | ||
718 | static struct commit **get_bad_and_good_commits(int *rev_nr) | |
719 | { | |
b32fa95f | 720 | struct commit **rev; |
c0537662 CC |
721 | int i, n = 0; |
722 | ||
b32fa95f | 723 | ALLOC_ARRAY(rev, 1 + good_revs.nr); |
ee3051bd | 724 | rev[n++] = get_commit_reference(current_bad_oid); |
902bb364 | 725 | for (i = 0; i < good_revs.nr; i++) |
ee3051bd | 726 | rev[n++] = get_commit_reference(good_revs.oid + i); |
c0537662 CC |
727 | *rev_nr = n; |
728 | ||
729 | return rev; | |
730 | } | |
731 | ||
732 | static void handle_bad_merge_base(void) | |
733 | { | |
3c5ff995 | 734 | if (is_expected_rev(current_bad_oid)) { |
735 | char *bad_hex = oid_to_hex(current_bad_oid); | |
c0537662 | 736 | char *good_hex = join_sha1_array_hex(&good_revs, ' '); |
43f9d9f3 | 737 | if (!strcmp(term_bad, "bad") && !strcmp(term_good, "good")) { |
14dc4899 | 738 | fprintf(stderr, _("The merge base %s is bad.\n" |
43f9d9f3 | 739 | "This means the bug has been fixed " |
14dc4899 | 740 | "between %s and [%s].\n"), |
43f9d9f3 | 741 | bad_hex, bad_hex, good_hex); |
21e5cfd8 | 742 | } else if (!strcmp(term_bad, "new") && !strcmp(term_good, "old")) { |
14dc4899 | 743 | fprintf(stderr, _("The merge base %s is new.\n" |
21e5cfd8 | 744 | "The property has changed " |
14dc4899 | 745 | "between %s and [%s].\n"), |
21e5cfd8 | 746 | bad_hex, bad_hex, good_hex); |
43f9d9f3 | 747 | } else { |
14dc4899 | 748 | fprintf(stderr, _("The merge base %s is %s.\n" |
43f9d9f3 | 749 | "This means the first '%s' commit is " |
14dc4899 | 750 | "between %s and [%s].\n"), |
43f9d9f3 AD |
751 | bad_hex, term_bad, term_good, bad_hex, good_hex); |
752 | } | |
c0537662 CC |
753 | exit(3); |
754 | } | |
755 | ||
3f407b76 | 756 | fprintf(stderr, _("Some %s revs are not ancestors of the %s rev.\n" |
c0537662 | 757 | "git bisect cannot work properly in this case.\n" |
14dc4899 | 758 | "Maybe you mistook %s and %s revs?\n"), |
43f9d9f3 | 759 | term_good, term_bad, term_good, term_bad); |
c0537662 CC |
760 | exit(1); |
761 | } | |
762 | ||
4ce3621a | 763 | static void handle_skipped_merge_base(const struct object_id *mb) |
c0537662 | 764 | { |
4ce3621a | 765 | char *mb_hex = oid_to_hex(mb); |
c368dde9 | 766 | char *bad_hex = oid_to_hex(current_bad_oid); |
c0537662 CC |
767 | char *good_hex = join_sha1_array_hex(&good_revs, ' '); |
768 | ||
14dc4899 | 769 | warning(_("the merge base between %s and [%s] " |
c0537662 | 770 | "must be skipped.\n" |
43f9d9f3 | 771 | "So we cannot be sure the first %s commit is " |
c0537662 | 772 | "between %s and %s.\n" |
14dc4899 | 773 | "We continue anyway."), |
43f9d9f3 | 774 | bad_hex, good_hex, term_bad, mb_hex, bad_hex); |
c0537662 CC |
775 | free(good_hex); |
776 | } | |
777 | ||
778 | /* | |
21e5cfd8 | 779 | * "check_merge_bases" checks that merge bases are not "bad" (or "new"). |
c0537662 | 780 | * |
21e5cfd8 | 781 | * - If one is "bad" (or "new"), it means the user assumed something wrong |
c0537662 | 782 | * and we must exit with a non 0 error code. |
21e5cfd8 | 783 | * - If one is "good" (or "old"), that's good, we have nothing to do. |
c0537662 CC |
784 | * - If one is "skipped", we can't know but we should warn. |
785 | * - If we don't know, we should check it out and ask the user to test. | |
786 | */ | |
fee92fc1 | 787 | static void check_merge_bases(int no_checkout) |
c0537662 CC |
788 | { |
789 | struct commit_list *result; | |
790 | int rev_nr; | |
791 | struct commit **rev = get_bad_and_good_commits(&rev_nr); | |
792 | ||
2ce406cc | 793 | result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1); |
c0537662 CC |
794 | |
795 | for (; result; result = result->next) { | |
4ce3621a | 796 | const struct object_id *mb = &result->item->object.oid; |
797 | if (!oidcmp(mb, current_bad_oid)) { | |
c0537662 | 798 | handle_bad_merge_base(); |
910650d2 | 799 | } else if (0 <= oid_array_lookup(&good_revs, mb)) { |
c0537662 | 800 | continue; |
910650d2 | 801 | } else if (0 <= oid_array_lookup(&skipped_revs, mb)) { |
c0537662 CC |
802 | handle_skipped_merge_base(mb); |
803 | } else { | |
14dc4899 | 804 | printf(_("Bisecting: a merge base must be tested\n")); |
4be0deec | 805 | exit(bisect_checkout(mb, no_checkout)); |
c0537662 CC |
806 | } |
807 | } | |
808 | ||
809 | free(rev); | |
810 | free_commit_list(result); | |
811 | } | |
812 | ||
2d938fc7 | 813 | static int check_ancestors(const char *prefix) |
d937d4ac | 814 | { |
2d938fc7 CC |
815 | struct rev_info revs; |
816 | struct object_array pending_copy; | |
86a0a408 | 817 | int res; |
d937d4ac | 818 | |
2d938fc7 | 819 | bisect_rev_setup(&revs, prefix, "^%s", "%s", 0); |
d937d4ac | 820 | |
2d938fc7 | 821 | /* Save pending objects, so they can be cleaned up later. */ |
353f5657 RS |
822 | pending_copy = revs.pending; |
823 | revs.leak_pending = 1; | |
2d938fc7 | 824 | |
353f5657 RS |
825 | /* |
826 | * bisect_common calls prepare_revision_walk right away, which | |
827 | * (together with .leak_pending = 1) makes us the sole owner of | |
828 | * the list of pending objects. | |
829 | */ | |
2d938fc7 CC |
830 | bisect_common(&revs); |
831 | res = (revs.commits != NULL); | |
832 | ||
833 | /* Clean up objects used, as they will be reused. */ | |
86a0a408 | 834 | clear_commit_marks_for_object_array(&pending_copy, ALL_REV_FLAGS); |
b2ccdf7f MÅ |
835 | |
836 | object_array_clear(&pending_copy); | |
d937d4ac | 837 | |
2d938fc7 | 838 | return res; |
d937d4ac CC |
839 | } |
840 | ||
841 | /* | |
842 | * "check_good_are_ancestors_of_bad" checks that all "good" revs are | |
843 | * ancestor of the "bad" rev. | |
844 | * | |
845 | * If that's not the case, we need to check the merge bases. | |
846 | * If a merge base must be tested by the user, its source code will be | |
847 | * checked out to be tested by the user and we will exit. | |
848 | */ | |
fee92fc1 | 849 | static void check_good_are_ancestors_of_bad(const char *prefix, int no_checkout) |
d937d4ac | 850 | { |
d292bfaf | 851 | char *filename = git_pathdup("BISECT_ANCESTORS_OK"); |
d937d4ac CC |
852 | struct stat st; |
853 | int fd; | |
854 | ||
3c5ff995 | 855 | if (!current_bad_oid) |
14dc4899 | 856 | die(_("a %s revision is needed"), term_bad); |
d937d4ac CC |
857 | |
858 | /* Check if file BISECT_ANCESTORS_OK exists. */ | |
859 | if (!stat(filename, &st) && S_ISREG(st.st_mode)) | |
144e7090 | 860 | goto done; |
d937d4ac CC |
861 | |
862 | /* Bisecting with no good rev is ok. */ | |
902bb364 | 863 | if (good_revs.nr == 0) |
144e7090 | 864 | goto done; |
d937d4ac | 865 | |
2d938fc7 CC |
866 | /* Check if all good revs are ancestor of the bad rev. */ |
867 | if (check_ancestors(prefix)) | |
fee92fc1 | 868 | check_merge_bases(no_checkout); |
d937d4ac CC |
869 | |
870 | /* Create file BISECT_ANCESTORS_OK. */ | |
871 | fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600); | |
872 | if (fd < 0) | |
14dc4899 | 873 | warning_errno(_("could not create file '%s'"), |
23e7a312 | 874 | filename); |
d937d4ac CC |
875 | else |
876 | close(fd); | |
144e7090 MH |
877 | done: |
878 | free(filename); | |
d937d4ac CC |
879 | } |
880 | ||
e22278c0 CC |
881 | /* |
882 | * This does "git diff-tree --pretty COMMIT" without one fork+exec. | |
883 | */ | |
884 | static void show_diff_tree(const char *prefix, struct commit *commit) | |
885 | { | |
886 | struct rev_info opt; | |
887 | ||
888 | /* diff-tree init */ | |
889 | init_revisions(&opt, prefix); | |
890 | git_config(git_diff_basic_config, NULL); /* no "diff" UI options */ | |
891 | opt.abbrev = 0; | |
892 | opt.diff = 1; | |
893 | ||
894 | /* This is what "--pretty" does */ | |
895 | opt.verbose_header = 1; | |
896 | opt.use_terminator = 0; | |
897 | opt.commit_format = CMIT_FMT_DEFAULT; | |
898 | ||
899 | /* diff-tree init */ | |
900 | if (!opt.diffopt.output_format) | |
901 | opt.diffopt.output_format = DIFF_FORMAT_RAW; | |
902 | ||
43ec5509 | 903 | setup_revisions(0, NULL, &opt, NULL); |
e22278c0 CC |
904 | log_tree_commit(&opt, commit); |
905 | } | |
906 | ||
cb46d630 AD |
907 | /* |
908 | * The terms used for this bisect session are stored in BISECT_TERMS. | |
909 | * We read them and store them to adapt the messages accordingly. | |
910 | * Default is bad/good. | |
911 | */ | |
912 | void read_bisect_terms(const char **read_bad, const char **read_good) | |
913 | { | |
914 | struct strbuf str = STRBUF_INIT; | |
f5d284f6 | 915 | const char *filename = git_path_bisect_terms(); |
cb46d630 AD |
916 | FILE *fp = fopen(filename, "r"); |
917 | ||
918 | if (!fp) { | |
919 | if (errno == ENOENT) { | |
920 | *read_bad = "bad"; | |
921 | *read_good = "good"; | |
922 | return; | |
923 | } else { | |
14dc4899 | 924 | die_errno(_("could not read file '%s'"), filename); |
cb46d630 AD |
925 | } |
926 | } else { | |
8f309aeb | 927 | strbuf_getline_lf(&str, fp); |
cb46d630 | 928 | *read_bad = strbuf_detach(&str, NULL); |
8f309aeb | 929 | strbuf_getline_lf(&str, fp); |
cb46d630 AD |
930 | *read_good = strbuf_detach(&str, NULL); |
931 | } | |
932 | strbuf_release(&str); | |
933 | fclose(fp); | |
934 | } | |
935 | ||
ef24c7ca CC |
936 | /* |
937 | * We use the convention that exiting with an exit code 10 means that | |
938 | * the bisection process finished successfully. | |
939 | * In this case the calling shell script should exit 0. | |
fee92fc1 JS |
940 | * |
941 | * If no_checkout is non-zero, the bisection process does not | |
942 | * checkout the trial commit but instead simply updates BISECT_HEAD. | |
ef24c7ca | 943 | */ |
fee92fc1 | 944 | int bisect_next_all(const char *prefix, int no_checkout) |
ef24c7ca CC |
945 | { |
946 | struct rev_info revs; | |
947 | struct commit_list *tried; | |
6329bade | 948 | int reaches = 0, all = 0, nr, steps; |
4be0deec | 949 | struct object_id *bisect_rev; |
2cfa8357 | 950 | char *steps_msg; |
ef24c7ca | 951 | |
cb46d630 | 952 | read_bisect_terms(&term_bad, &term_good); |
2b020695 | 953 | if (read_bisect_refs()) |
14dc4899 | 954 | die(_("reading bisect refs failed")); |
2b020695 | 955 | |
fee92fc1 | 956 | check_good_are_ancestors_of_bad(prefix, no_checkout); |
0871984d | 957 | |
a22347c6 CC |
958 | bisect_rev_setup(&revs, prefix, "%s", "^%s", 1); |
959 | revs.limited = 1; | |
2b020695 | 960 | |
a22347c6 | 961 | bisect_common(&revs); |
ef24c7ca | 962 | |
24d707f6 | 963 | find_bisection(&revs.commits, &reaches, &all, !!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 | } |