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