builtin/bisect.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "hex.h"
   4 #include "parse-options.h"
   5 #include "bisect.h"
   6 #include "refs.h"
   7 #include "dir.h"
   8 #include "strvec.h"
   9 #include "run-command.h"
  10 #include "prompt.h"
  11 #include "quote.h"
  12 #include "revision.h"
  13
  14 static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS")
  15 static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
  16 static GIT_PATH_FUNC(git_path_bisect_ancestors_ok, "BISECT_ANCESTORS_OK")
  17 static GIT_PATH_FUNC(git_path_bisect_start, "BISECT_START")
  18 static GIT_PATH_FUNC(git_path_bisect_log, "BISECT_LOG")
  19 static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
  20 static GIT_PATH_FUNC(git_path_bisect_first_parent, "BISECT_FIRST_PARENT")
  21 static GIT_PATH_FUNC(git_path_bisect_run, "BISECT_RUN")
  22
  23 #define BUILTIN_GIT_BISECT_START_USAGE \
  24         N_("git bisect start [--term-{new,bad}=<term> --term-{old,good}=<term>]" \
  25            "    [--no-checkout] [--first-parent] [<bad> [<good>...]] [--]" \
  26            "    [<pathspec>...]")
  27 #define BUILTIN_GIT_BISECT_STATE_USAGE \
  28         N_("git bisect (good|bad) [<rev>...]")
  29 #define BUILTIN_GIT_BISECT_TERMS_USAGE \
  30         "git bisect terms [--term-good | --term-bad]"
  31 #define BUILTIN_GIT_BISECT_SKIP_USAGE \
  32         N_("git bisect skip [(<rev>|<range>)...]")
  33 #define BUILTIN_GIT_BISECT_NEXT_USAGE \
  34         "git bisect next"
  35 #define BUILTIN_GIT_BISECT_RESET_USAGE \
  36         N_("git bisect reset [<commit>]")
  37 #define BUILTIN_GIT_BISECT_VISUALIZE_USAGE \
  38         "git bisect visualize"
  39 #define BUILTIN_GIT_BISECT_REPLAY_USAGE \
  40         N_("git bisect replay <logfile>")
  41 #define BUILTIN_GIT_BISECT_LOG_USAGE \
  42         "git bisect log"
  43 #define BUILTIN_GIT_BISECT_RUN_USAGE \
  44         N_("git bisect run <cmd>...")
  45
  46 static const char * const git_bisect_usage[] = {
  47         BUILTIN_GIT_BISECT_START_USAGE,
  48         BUILTIN_GIT_BISECT_STATE_USAGE,
  49         BUILTIN_GIT_BISECT_TERMS_USAGE,
  50         BUILTIN_GIT_BISECT_SKIP_USAGE,
  51         BUILTIN_GIT_BISECT_NEXT_USAGE,
  52         BUILTIN_GIT_BISECT_RESET_USAGE,
  53         BUILTIN_GIT_BISECT_VISUALIZE_USAGE,
  54         BUILTIN_GIT_BISECT_REPLAY_USAGE,
  55         BUILTIN_GIT_BISECT_LOG_USAGE,
  56         BUILTIN_GIT_BISECT_RUN_USAGE,
  57         NULL
  58 };
  59
  60 struct add_bisect_ref_data {
  61         struct rev_info *revs;
  62         unsigned int object_flags;
  63 };
  64
  65 struct bisect_terms {
  66         char *term_good;
  67         char *term_bad;
  68 };
  69
  70 static void free_terms(struct bisect_terms *terms)
  71 {
  72         FREE_AND_NULL(terms->term_good);
  73         FREE_AND_NULL(terms->term_bad);
  74 }
  75
  76 static void set_terms(struct bisect_terms *terms, const char *bad,
  77                       const char *good)
  78 {
  79         free((void *)terms->term_good);
  80         terms->term_good = xstrdup(good);
  81         free((void *)terms->term_bad);
  82         terms->term_bad = xstrdup(bad);
  83 }
  84
  85 static const char vocab_bad[] = "bad|new";
  86 static const char vocab_good[] = "good|old";
  87
  88 static int bisect_autostart(struct bisect_terms *terms);
  89
  90 /*
  91  * Check whether the string `term` belongs to the set of strings
  92  * included in the variable arguments.
  93  */
  94 LAST_ARG_MUST_BE_NULL
  95 static int one_of(const char *term, ...)
  96 {
  97         int res = 0;
  98         va_list matches;
  99         const char *match;
 100
 101         va_start(matches, term);
 102         while (!res && (match = va_arg(matches, const char *)))
 103                 res = !strcmp(term, match);
 104         va_end(matches);
 105
 106         return res;
 107 }
 108
 109 /*
 110  * return code BISECT_INTERNAL_SUCCESS_MERGE_BASE
 111  * and BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND are codes
 112  * that indicate special success.
 113  */
 114
 115 static int is_bisect_success(enum bisect_error res)
 116 {
 117         return !res ||
 118                 res == BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND ||
 119                 res == BISECT_INTERNAL_SUCCESS_MERGE_BASE;
 120 }
 121
 122 static int write_in_file(const char *path, const char *mode, const char *format, va_list args)
 123 {
 124         FILE *fp = NULL;
 125         int res = 0;
 126
 127         if (strcmp(mode, "w") && strcmp(mode, "a"))
 128                 BUG("write-in-file does not support '%s' mode", mode);
 129         fp = fopen(path, mode);
 130         if (!fp)
 131                 return error_errno(_("cannot open file '%s' in mode '%s'"), path, mode);
 132         res = vfprintf(fp, format, args);
 133
 134         if (res < 0) {
 135                 int saved_errno = errno;
 136                 fclose(fp);
 137                 errno = saved_errno;
 138                 return error_errno(_("could not write to file '%s'"), path);
 139         }
 140
 141         return fclose(fp);
 142 }
 143
 144 __attribute__((format (printf, 2, 3)))
 145 static int write_to_file(const char *path, const char *format, ...)
 146 {
 147         int res;
 148         va_list args;
 149
 150         va_start(args, format);
 151         res = write_in_file(path, "w", format, args);
 152         va_end(args);
 153
 154         return res;
 155 }
 156
 157 __attribute__((format (printf, 2, 3)))
 158 static int append_to_file(const char *path, const char *format, ...)
 159 {
 160         int res;
 161         va_list args;
 162
 163         va_start(args, format);
 164         res = write_in_file(path, "a", format, args);
 165         va_end(args);
 166
 167         return res;
 168 }
 169
 170 static int print_file_to_stdout(const char *path)
 171 {
 172         int fd = open(path, O_RDONLY);
 173         int ret = 0;
 174
 175         if (fd < 0)
 176                 return error_errno(_("cannot open file '%s' for reading"), path);
 177         if (copy_fd(fd, 1) < 0)
 178                 ret = error_errno(_("failed to read '%s'"), path);
 179         close(fd);
 180         return ret;
 181 }
 182
 183 static int check_term_format(const char *term, const char *orig_term)
 184 {
 185         int res;
 186         char *new_term = xstrfmt("refs/bisect/%s", term);
 187
 188         res = check_refname_format(new_term, 0);
 189         free(new_term);
 190
 191         if (res)
 192                 return error(_("'%s' is not a valid term"), term);
 193
 194         if (one_of(term, "help", "start", "skip", "next", "reset",
 195                         "visualize", "view", "replay", "log", "run", "terms", NULL))
 196                 return error(_("can't use the builtin command '%s' as a term"), term);
 197
 198         /*
 199          * In theory, nothing prevents swapping completely good and bad,
 200          * but this situation could be confusing and hasn't been tested
 201          * enough. Forbid it for now.
 202          */
 203
 204         if ((strcmp(orig_term, "bad") && one_of(term, "bad", "new", NULL)) ||
 205                  (strcmp(orig_term, "good") && one_of(term, "good", "old", NULL)))
 206                 return error(_("can't change the meaning of the term '%s'"), term);
 207
 208         return 0;
 209 }
 210
 211 static int write_terms(const char *bad, const char *good)
 212 {
 213         int res;
 214
 215         if (!strcmp(bad, good))
 216                 return error(_("please use two different terms"));
 217
 218         if (check_term_format(bad, "bad") || check_term_format(good, "good"))
 219                 return -1;
 220
 221         res = write_to_file(git_path_bisect_terms(), "%s\n%s\n", bad, good);
 222
 223         return res;
 224 }
 225
 226 static int bisect_reset(const char *commit)
 227 {
 228         struct strbuf branch = STRBUF_INIT;
 229
 230         if (!commit) {
 231                 if (strbuf_read_file(&branch, git_path_bisect_start(), 0) < 1) {
 232                         printf(_("We are not bisecting.\n"));
 233                         return 0;
 234                 }
 235                 strbuf_rtrim(&branch);
 236         } else {
 237                 struct object_id oid;
 238
 239                 if (get_oid_commit(commit, &oid))
 240                         return error(_("'%s' is not a valid commit"), commit);
 241                 strbuf_addstr(&branch, commit);
 242         }
 243
 244         if (!ref_exists("BISECT_HEAD")) {
 245                 struct child_process cmd = CHILD_PROCESS_INIT;
 246
 247                 cmd.git_cmd = 1;
 248                 strvec_pushl(&cmd.args, "checkout", "--ignore-other-worktrees",
 249                                 branch.buf, "--", NULL);
 250                 if (run_command(&cmd)) {
 251                         error(_("could not check out original"
 252                                 " HEAD '%s'. Try 'git bisect"
 253                                 " reset <commit>'."), branch.buf);
 254                         strbuf_release(&branch);
 255                         return -1;
 256                 }
 257         }
 258
 259         strbuf_release(&branch);
 260         return bisect_clean_state();
 261 }
 262
 263 static void log_commit(FILE *fp, char *fmt, const char *state,
 264                        struct commit *commit)
 265 {
 266         struct pretty_print_context pp = {0};
 267         struct strbuf commit_msg = STRBUF_INIT;
 268         char *label = xstrfmt(fmt, state);
 269
 270         format_commit_message(commit, "%s", &commit_msg, &pp);
 271
 272         fprintf(fp, "# %s: [%s] %s\n", label, oid_to_hex(&commit->object.oid),
 273                 commit_msg.buf);
 274
 275         strbuf_release(&commit_msg);
 276         free(label);
 277 }
 278
 279 static int bisect_write(const char *state, const char *rev,
 280                         const struct bisect_terms *terms, int nolog)
 281 {
 282         struct strbuf tag = STRBUF_INIT;
 283         struct object_id oid;
 284         struct commit *commit;
 285         FILE *fp = NULL;
 286         int res = 0;
 287
 288         if (!strcmp(state, terms->term_bad)) {
 289                 strbuf_addf(&tag, "refs/bisect/%s", state);
 290         } else if (one_of(state, terms->term_good, "skip", NULL)) {
 291                 strbuf_addf(&tag, "refs/bisect/%s-%s", state, rev);
 292         } else {
 293                 res = error(_("Bad bisect_write argument: %s"), state);
 294                 goto finish;
 295         }
 296
 297         if (get_oid(rev, &oid)) {
 298                 res = error(_("couldn't get the oid of the rev '%s'"), rev);
 299                 goto finish;
 300         }
 301
 302         if (update_ref(NULL, tag.buf, &oid, NULL, 0,
 303                        UPDATE_REFS_MSG_ON_ERR)) {
 304                 res = -1;
 305                 goto finish;
 306         }
 307
 308         fp = fopen(git_path_bisect_log(), "a");
 309         if (!fp) {
 310                 res = error_errno(_("couldn't open the file '%s'"), git_path_bisect_log());
 311                 goto finish;
 312         }
 313
 314         commit = lookup_commit_reference(the_repository, &oid);
 315         log_commit(fp, "%s", state, commit);
 316
 317         if (!nolog)
 318                 fprintf(fp, "git bisect %s %s\n", state, rev);
 319
 320 finish:
 321         if (fp)
 322                 fclose(fp);
 323         strbuf_release(&tag);
 324         return res;
 325 }
 326
 327 static int check_and_set_terms(struct bisect_terms *terms, const char *cmd)
 328 {
 329         int has_term_file = !is_empty_or_missing_file(git_path_bisect_terms());
 330
 331         if (one_of(cmd, "skip", "start", "terms", NULL))
 332                 return 0;
 333
 334         if (has_term_file && strcmp(cmd, terms->term_bad) &&
 335             strcmp(cmd, terms->term_good))
 336                 return error(_("Invalid command: you're currently in a "
 337                                 "%s/%s bisect"), terms->term_bad,
 338                                 terms->term_good);
 339
 340         if (!has_term_file) {
 341                 if (one_of(cmd, "bad", "good", NULL)) {
 342                         set_terms(terms, "bad", "good");
 343                         return write_terms(terms->term_bad, terms->term_good);
 344                 }
 345                 if (one_of(cmd, "new", "old", NULL)) {
 346                         set_terms(terms, "new", "old");
 347                         return write_terms(terms->term_bad, terms->term_good);
 348                 }
 349         }
 350
 351         return 0;
 352 }
 353
 354 static int inc_nr(const char *refname UNUSED,
 355                   const struct object_id *oid UNUSED,
 356                   int flag UNUSED, void *cb_data)
 357 {
 358         unsigned int *nr = (unsigned int *)cb_data;
 359         (*nr)++;
 360         return 0;
 361 }
 362
 363 static const char need_bad_and_good_revision_warning[] =
 364         N_("You need to give me at least one %s and %s revision.\n"
 365            "You can use \"git bisect %s\" and \"git bisect %s\" for that.");
 366
 367 static const char need_bisect_start_warning[] =
 368         N_("You need to start by \"git bisect start\".\n"
 369            "You then need to give me at least one %s and %s revision.\n"
 370            "You can use \"git bisect %s\" and \"git bisect %s\" for that.");
 371
 372 static int decide_next(const struct bisect_terms *terms,
 373                        const char *current_term, int missing_good,
 374                        int missing_bad)
 375 {
 376         if (!missing_good && !missing_bad)
 377                 return 0;
 378         if (!current_term)
 379                 return -1;
 380
 381         if (missing_good && !missing_bad &&
 382             !strcmp(current_term, terms->term_good)) {
 383                 char *yesno;
 384                 /*
 385                  * have bad (or new) but not good (or old). We could bisect
 386                  * although this is less optimum.
 387                  */
 388                 warning(_("bisecting only with a %s commit"), terms->term_bad);
 389                 if (!isatty(0))
 390                         return 0;
 391                 /*
 392                  * TRANSLATORS: Make sure to include [Y] and [n] in your
 393                  * translation. The program will only accept English input
 394                  * at this point.
 395                  */
 396                 yesno = git_prompt(_("Are you sure [Y/n]? "), PROMPT_ECHO);
 397                 if (starts_with(yesno, "N") || starts_with(yesno, "n"))
 398                         return -1;
 399                 return 0;
 400         }
 401
 402         if (!is_empty_or_missing_file(git_path_bisect_start()))
 403                 return error(_(need_bad_and_good_revision_warning),
 404                              vocab_bad, vocab_good, vocab_bad, vocab_good);
 405         else
 406                 return error(_(need_bisect_start_warning),
 407                              vocab_good, vocab_bad, vocab_good, vocab_bad);
 408 }
 409
 410 static void bisect_status(struct bisect_state *state,
 411                           const struct bisect_terms *terms)
 412 {
 413         char *bad_ref = xstrfmt("refs/bisect/%s", terms->term_bad);
 414         char *good_glob = xstrfmt("%s-*", terms->term_good);
 415
 416         if (ref_exists(bad_ref))
 417                 state->nr_bad = 1;
 418
 419         for_each_glob_ref_in(inc_nr, good_glob, "refs/bisect/",
 420                              (void *) &state->nr_good);
 421
 422         free(good_glob);
 423         free(bad_ref);
 424 }
 425
 426 __attribute__((format (printf, 1, 2)))
 427 static void bisect_log_printf(const char *fmt, ...)
 428 {
 429         struct strbuf buf = STRBUF_INIT;
 430         va_list ap;
 431
 432         va_start(ap, fmt);
 433         strbuf_vaddf(&buf, fmt, ap);
 434         va_end(ap);
 435
 436         printf("%s", buf.buf);
 437         append_to_file(git_path_bisect_log(), "# %s", buf.buf);
 438
 439         strbuf_release(&buf);
 440 }
 441
 442 static void bisect_print_status(const struct bisect_terms *terms)
 443 {
 444         struct bisect_state state = { 0 };
 445
 446         bisect_status(&state, terms);
 447
 448         /* If we had both, we'd already be started, and shouldn't get here. */
 449         if (state.nr_good && state.nr_bad)
 450                 return;
 451
 452         if (!state.nr_good && !state.nr_bad)
 453                 bisect_log_printf(_("status: waiting for both good and bad commits\n"));
 454         else if (state.nr_good)
 455                 bisect_log_printf(Q_("status: waiting for bad commit, %d good commit known\n",
 456                                      "status: waiting for bad commit, %d good commits known\n",
 457                                      state.nr_good), state.nr_good);
 458         else
 459                 bisect_log_printf(_("status: waiting for good commit(s), bad commit known\n"));
 460 }
 461
 462 static int bisect_next_check(const struct bisect_terms *terms,
 463                              const char *current_term)
 464 {
 465         struct bisect_state state = { 0 };
 466         bisect_status(&state, terms);
 467         return decide_next(terms, current_term, !state.nr_good, !state.nr_bad);
 468 }
 469
 470 static int get_terms(struct bisect_terms *terms)
 471 {
 472         struct strbuf str = STRBUF_INIT;
 473         FILE *fp = NULL;
 474         int res = 0;
 475
 476         fp = fopen(git_path_bisect_terms(), "r");
 477         if (!fp) {
 478                 res = -1;
 479                 goto finish;
 480         }
 481
 482         free_terms(terms);
 483         strbuf_getline_lf(&str, fp);
 484         terms->term_bad = strbuf_detach(&str, NULL);
 485         strbuf_getline_lf(&str, fp);
 486         terms->term_good = strbuf_detach(&str, NULL);
 487
 488 finish:
 489         if (fp)
 490                 fclose(fp);
 491         strbuf_release(&str);
 492         return res;
 493 }
 494
 495 static int bisect_terms(struct bisect_terms *terms, const char *option)
 496 {
 497         if (get_terms(terms))
 498                 return error(_("no terms defined"));
 499
 500         if (!option) {
 501                 printf(_("Your current terms are %s for the old state\n"
 502                          "and %s for the new state.\n"),
 503                        terms->term_good, terms->term_bad);
 504                 return 0;
 505         }
 506         if (one_of(option, "--term-good", "--term-old", NULL))
 507                 printf("%s\n", terms->term_good);
 508         else if (one_of(option, "--term-bad", "--term-new", NULL))
 509                 printf("%s\n", terms->term_bad);
 510         else
 511                 return error(_("invalid argument %s for 'git bisect terms'.\n"
 512                                "Supported options are: "
 513                                "--term-good|--term-old and "
 514                                "--term-bad|--term-new."), option);
 515
 516         return 0;
 517 }
 518
 519 static int bisect_append_log_quoted(const char **argv)
 520 {
 521         int res = 0;
 522         FILE *fp = fopen(git_path_bisect_log(), "a");
 523         struct strbuf orig_args = STRBUF_INIT;
 524
 525         if (!fp)
 526                 return -1;
 527
 528         if (fprintf(fp, "git bisect start") < 1) {
 529                 res = -1;
 530                 goto finish;
 531         }
 532
 533         sq_quote_argv(&orig_args, argv);
 534         if (fprintf(fp, "%s\n", orig_args.buf) < 1)
 535                 res = -1;
 536
 537 finish:
 538         fclose(fp);
 539         strbuf_release(&orig_args);
 540         return res;
 541 }
 542
 543 static int add_bisect_ref(const char *refname, const struct object_id *oid,
 544                           int flags UNUSED, void *cb)
 545 {
 546         struct add_bisect_ref_data *data = cb;
 547
 548         add_pending_oid(data->revs, refname, oid, data->object_flags);
 549
 550         return 0;
 551 }
 552
 553 static int prepare_revs(struct bisect_terms *terms, struct rev_info *revs)
 554 {
 555         int res = 0;
 556         struct add_bisect_ref_data cb = { revs };
 557         char *good = xstrfmt("%s-*", terms->term_good);
 558
 559         /*
 560          * We cannot use terms->term_bad directly in
 561          * for_each_glob_ref_in() and we have to append a '*' to it,
 562          * otherwise for_each_glob_ref_in() will append '/' and '*'.
 563          */
 564         char *bad = xstrfmt("%s*", terms->term_bad);
 565
 566         /*
 567          * It is important to reset the flags used by revision walks
 568          * as the previous call to bisect_next_all() in turn
 569          * sets up a revision walk.
 570          */
 571         reset_revision_walk();
 572         init_revisions(revs, NULL);
 573         setup_revisions(0, NULL, revs, NULL);
 574         for_each_glob_ref_in(add_bisect_ref, bad, "refs/bisect/", &cb);
 575         cb.object_flags = UNINTERESTING;
 576         for_each_glob_ref_in(add_bisect_ref, good, "refs/bisect/", &cb);
 577         if (prepare_revision_walk(revs))
 578                 res = error(_("revision walk setup failed\n"));
 579
 580         free(good);
 581         free(bad);
 582         return res;
 583 }
 584
 585 static int bisect_skipped_commits(struct bisect_terms *terms)
 586 {
 587         int res;
 588         FILE *fp = NULL;
 589         struct rev_info revs;
 590         struct commit *commit;
 591         struct pretty_print_context pp = {0};
 592         struct strbuf commit_name = STRBUF_INIT;
 593
 594         res = prepare_revs(terms, &revs);
 595         if (res)
 596                 return res;
 597
 598         fp = fopen(git_path_bisect_log(), "a");
 599         if (!fp)
 600                 return error_errno(_("could not open '%s' for appending"),
 601                                   git_path_bisect_log());
 602
 603         if (fprintf(fp, "# only skipped commits left to test\n") < 0)
 604                 return error_errno(_("failed to write to '%s'"), git_path_bisect_log());
 605
 606         while ((commit = get_revision(&revs)) != NULL) {
 607                 strbuf_reset(&commit_name);
 608                 format_commit_message(commit, "%s",
 609                                       &commit_name, &pp);
 610                 fprintf(fp, "# possible first %s commit: [%s] %s\n",
 611                         terms->term_bad, oid_to_hex(&commit->object.oid),
 612                         commit_name.buf);
 613         }
 614
 615         /*
 616          * Reset the flags used by revision walks in case
 617          * there is another revision walk after this one.
 618          */
 619         reset_revision_walk();
 620
 621         strbuf_release(&commit_name);
 622         release_revisions(&revs);
 623         fclose(fp);
 624         return 0;
 625 }
 626
 627 static int bisect_successful(struct bisect_terms *terms)
 628 {
 629         struct object_id oid;
 630         struct commit *commit;
 631         struct pretty_print_context pp = {0};
 632         struct strbuf commit_name = STRBUF_INIT;
 633         char *bad_ref = xstrfmt("refs/bisect/%s",terms->term_bad);
 634         int res;
 635
 636         read_ref(bad_ref, &oid);
 637         commit = lookup_commit_reference_by_name(bad_ref);
 638         format_commit_message(commit, "%s", &commit_name, &pp);
 639
 640         res = append_to_file(git_path_bisect_log(), "# first %s commit: [%s] %s\n",
 641                             terms->term_bad, oid_to_hex(&commit->object.oid),
 642                             commit_name.buf);
 643
 644         strbuf_release(&commit_name);
 645         free(bad_ref);
 646         return res;
 647 }
 648
 649 static enum bisect_error bisect_next(struct bisect_terms *terms, const char *prefix)
 650 {
 651         enum bisect_error res;
 652
 653         if (bisect_autostart(terms))
 654                 return BISECT_FAILED;
 655
 656         if (bisect_next_check(terms, terms->term_good))
 657                 return BISECT_FAILED;
 658
 659         /* Perform all bisection computation */
 660         res = bisect_next_all(the_repository, prefix);
 661
 662         if (res == BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND) {
 663                 res = bisect_successful(terms);
 664                 return res ? res : BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND;
 665         } else if (res == BISECT_ONLY_SKIPPED_LEFT) {
 666                 res = bisect_skipped_commits(terms);
 667                 return res ? res : BISECT_ONLY_SKIPPED_LEFT;
 668         }
 669         return res;
 670 }
 671
 672 static enum bisect_error bisect_auto_next(struct bisect_terms *terms, const char *prefix)
 673 {
 674         if (bisect_next_check(terms, NULL)) {
 675                 bisect_print_status(terms);
 676                 return BISECT_OK;
 677         }
 678
 679         return bisect_next(terms, prefix);
 680 }
 681
 682 static enum bisect_error bisect_start(struct bisect_terms *terms, int argc,
 683                                       const char **argv)
 684 {
 685         int no_checkout = 0;
 686         int first_parent_only = 0;
 687         int i, has_double_dash = 0, must_write_terms = 0, bad_seen = 0;
 688         int flags, pathspec_pos;
 689         enum bisect_error res = BISECT_OK;
 690         struct string_list revs = STRING_LIST_INIT_DUP;
 691         struct string_list states = STRING_LIST_INIT_DUP;
 692         struct strbuf start_head = STRBUF_INIT;
 693         struct strbuf bisect_names = STRBUF_INIT;
 694         struct object_id head_oid;
 695         struct object_id oid;
 696         const char *head;
 697
 698         if (is_bare_repository())
 699                 no_checkout = 1;
 700
 701         /*
 702          * Check for one bad and then some good revisions
 703          */
 704         for (i = 0; i < argc; i++) {
 705                 if (!strcmp(argv[i], "--")) {
 706                         has_double_dash = 1;
 707                         break;
 708                 }
 709         }
 710
 711         for (i = 0; i < argc; i++) {
 712                 const char *arg = argv[i];
 713                 if (!strcmp(argv[i], "--")) {
 714                         break;
 715                 } else if (!strcmp(arg, "--no-checkout")) {
 716                         no_checkout = 1;
 717                 } else if (!strcmp(arg, "--first-parent")) {
 718                         first_parent_only = 1;
 719                 } else if (!strcmp(arg, "--term-good") ||
 720                          !strcmp(arg, "--term-old")) {
 721                         i++;
 722                         if (argc <= i)
 723                                 return error(_("'' is not a valid term"));
 724                         must_write_terms = 1;
 725                         free((void *) terms->term_good);
 726                         terms->term_good = xstrdup(argv[i]);
 727                 } else if (skip_prefix(arg, "--term-good=", &arg) ||
 728                            skip_prefix(arg, "--term-old=", &arg)) {
 729                         must_write_terms = 1;
 730                         free((void *) terms->term_good);
 731                         terms->term_good = xstrdup(arg);
 732                 } else if (!strcmp(arg, "--term-bad") ||
 733                          !strcmp(arg, "--term-new")) {
 734                         i++;
 735                         if (argc <= i)
 736                                 return error(_("'' is not a valid term"));
 737                         must_write_terms = 1;
 738                         free((void *) terms->term_bad);
 739                         terms->term_bad = xstrdup(argv[i]);
 740                 } else if (skip_prefix(arg, "--term-bad=", &arg) ||
 741                            skip_prefix(arg, "--term-new=", &arg)) {
 742                         must_write_terms = 1;
 743                         free((void *) terms->term_bad);
 744                         terms->term_bad = xstrdup(arg);
 745                 } else if (starts_with(arg, "--")) {
 746                         return error(_("unrecognized option: '%s'"), arg);
 747                 } else if (!get_oidf(&oid, "%s^{commit}", arg)) {
 748                         string_list_append(&revs, oid_to_hex(&oid));
 749                 } else if (has_double_dash) {
 750                         die(_("'%s' does not appear to be a valid "
 751                               "revision"), arg);
 752                 } else {
 753                         break;
 754                 }
 755         }
 756         pathspec_pos = i;
 757
 758         /*
 759          * The user ran "git bisect start <sha1> <sha1>", hence did not
 760          * explicitly specify the terms, but we are already starting to
 761          * set references named with the default terms, and won't be able
 762          * to change afterwards.
 763          */
 764         if (revs.nr)
 765                 must_write_terms = 1;
 766         for (i = 0; i < revs.nr; i++) {
 767                 if (bad_seen) {
 768                         string_list_append(&states, terms->term_good);
 769                 } else {
 770                         bad_seen = 1;
 771                         string_list_append(&states, terms->term_bad);
 772                 }
 773         }
 774
 775         /*
 776          * Verify HEAD
 777          */
 778         head = resolve_ref_unsafe("HEAD", 0, &head_oid, &flags);
 779         if (!head)
 780                 if (get_oid("HEAD", &head_oid))
 781                         return error(_("bad HEAD - I need a HEAD"));
 782
 783         /*
 784          * Check if we are bisecting
 785          */
 786         if (!is_empty_or_missing_file(git_path_bisect_start())) {
 787                 /* Reset to the rev from where we started */
 788                 strbuf_read_file(&start_head, git_path_bisect_start(), 0);
 789                 strbuf_trim(&start_head);
 790                 if (!no_checkout) {
 791                         struct child_process cmd = CHILD_PROCESS_INIT;
 792
 793                         cmd.git_cmd = 1;
 794                         strvec_pushl(&cmd.args, "checkout", start_head.buf,
 795                                      "--", NULL);
 796                         if (run_command(&cmd)) {
 797                                 res = error(_("checking out '%s' failed."
 798                                                  " Try 'git bisect start "
 799                                                  "<valid-branch>'."),
 800                                                start_head.buf);
 801                                 goto finish;
 802                         }
 803                 }
 804         } else {
 805                 /* Get the rev from where we start. */
 806                 if (!get_oid(head, &head_oid) &&
 807                     !starts_with(head, "refs/heads/")) {
 808                         strbuf_reset(&start_head);
 809                         strbuf_addstr(&start_head, oid_to_hex(&head_oid));
 810                 } else if (!get_oid(head, &head_oid) &&
 811                            skip_prefix(head, "refs/heads/", &head)) {
 812                         strbuf_addstr(&start_head, head);
 813                 } else {
 814                         return error(_("bad HEAD - strange symbolic ref"));
 815                 }
 816         }
 817
 818         /*
 819          * Get rid of any old bisect state.
 820          */
 821         if (bisect_clean_state())
 822                 return BISECT_FAILED;
 823
 824         /*
 825          * Write new start state
 826          */
 827         write_file(git_path_bisect_start(), "%s\n", start_head.buf);
 828
 829         if (first_parent_only)
 830                 write_file(git_path_bisect_first_parent(), "\n");
 831
 832         if (no_checkout) {
 833                 if (get_oid(start_head.buf, &oid) < 0) {
 834                         res = error(_("invalid ref: '%s'"), start_head.buf);
 835                         goto finish;
 836                 }
 837                 if (update_ref(NULL, "BISECT_HEAD", &oid, NULL, 0,
 838                                UPDATE_REFS_MSG_ON_ERR)) {
 839                         res = BISECT_FAILED;
 840                         goto finish;
 841                 }
 842         }
 843
 844         if (pathspec_pos < argc - 1)
 845                 sq_quote_argv(&bisect_names, argv + pathspec_pos);
 846         write_file(git_path_bisect_names(), "%s\n", bisect_names.buf);
 847
 848         for (i = 0; i < states.nr; i++)
 849                 if (bisect_write(states.items[i].string,
 850                                  revs.items[i].string, terms, 1)) {
 851                         res = BISECT_FAILED;
 852                         goto finish;
 853                 }
 854
 855         if (must_write_terms && write_terms(terms->term_bad,
 856                                             terms->term_good)) {
 857                 res = BISECT_FAILED;
 858                 goto finish;
 859         }
 860
 861         res = bisect_append_log_quoted(argv);
 862         if (res)
 863                 res = BISECT_FAILED;
 864
 865 finish:
 866         string_list_clear(&revs, 0);
 867         string_list_clear(&states, 0);
 868         strbuf_release(&start_head);
 869         strbuf_release(&bisect_names);
 870         if (res)
 871                 return res;
 872
 873         res = bisect_auto_next(terms, NULL);
 874         if (!is_bisect_success(res))
 875                 bisect_clean_state();
 876         return res;
 877 }
 878
 879 static inline int file_is_not_empty(const char *path)
 880 {
 881         return !is_empty_or_missing_file(path);
 882 }
 883
 884 static int bisect_autostart(struct bisect_terms *terms)
 885 {
 886         int res;
 887         const char *yesno;
 888
 889         if (file_is_not_empty(git_path_bisect_start()))
 890                 return 0;
 891
 892         fprintf_ln(stderr, _("You need to start by \"git bisect "
 893                           "start\"\n"));
 894
 895         if (!isatty(STDIN_FILENO))
 896                 return -1;
 897
 898         /*
 899          * TRANSLATORS: Make sure to include [Y] and [n] in your
 900          * translation. The program will only accept English input
 901          * at this point.
 902          */
 903         yesno = git_prompt(_("Do you want me to do it for you "
 904                              "[Y/n]? "), PROMPT_ECHO);
 905         res = tolower(*yesno) == 'n' ?
 906                 -1 : bisect_start(terms, 0, empty_strvec);
 907
 908         return res;
 909 }
 910
 911 static enum bisect_error bisect_state(struct bisect_terms *terms, int argc,
 912                                       const char **argv)
 913 {
 914         const char *state;
 915         int i, verify_expected = 1;
 916         struct object_id oid, expected;
 917         struct strbuf buf = STRBUF_INIT;
 918         struct oid_array revs = OID_ARRAY_INIT;
 919
 920         if (!argc)
 921                 return error(_("Please call `--bisect-state` with at least one argument"));
 922
 923         if (bisect_autostart(terms))
 924                 return BISECT_FAILED;
 925
 926         state = argv[0];
 927         if (check_and_set_terms(terms, state) ||
 928             !one_of(state, terms->term_good, terms->term_bad, "skip", NULL))
 929                 return BISECT_FAILED;
 930
 931         argv++;
 932         argc--;
 933         if (argc > 1 && !strcmp(state, terms->term_bad))
 934                 return error(_("'git bisect %s' can take only one argument."), terms->term_bad);
 935
 936         if (argc == 0) {
 937                 const char *head = "BISECT_HEAD";
 938                 enum get_oid_result res_head = get_oid(head, &oid);
 939
 940                 if (res_head == MISSING_OBJECT) {
 941                         head = "HEAD";
 942                         res_head = get_oid(head, &oid);
 943                 }
 944
 945                 if (res_head)
 946                         error(_("Bad rev input: %s"), head);
 947                 oid_array_append(&revs, &oid);
 948         }
 949
 950         /*
 951          * All input revs must be checked before executing bisect_write()
 952          * to discard junk revs.
 953          */
 954
 955         for (; argc; argc--, argv++) {
 956                 struct commit *commit;
 957
 958                 if (get_oid(*argv, &oid)){
 959                         error(_("Bad rev input: %s"), *argv);
 960                         oid_array_clear(&revs);
 961                         return BISECT_FAILED;
 962                 }
 963
 964                 commit = lookup_commit_reference(the_repository, &oid);
 965                 if (!commit)
 966                         die(_("Bad rev input (not a commit): %s"), *argv);
 967
 968                 oid_array_append(&revs, &commit->object.oid);
 969         }
 970
 971         if (strbuf_read_file(&buf, git_path_bisect_expected_rev(), 0) < the_hash_algo->hexsz ||
 972             get_oid_hex(buf.buf, &expected) < 0)
 973                 verify_expected = 0; /* Ignore invalid file contents */
 974         strbuf_release(&buf);
 975
 976         for (i = 0; i < revs.nr; i++) {
 977                 if (bisect_write(state, oid_to_hex(&revs.oid[i]), terms, 0)) {
 978                         oid_array_clear(&revs);
 979                         return BISECT_FAILED;
 980                 }
 981                 if (verify_expected && !oideq(&revs.oid[i], &expected)) {
 982                         unlink_or_warn(git_path_bisect_ancestors_ok());
 983                         unlink_or_warn(git_path_bisect_expected_rev());
 984                         verify_expected = 0;
 985                 }
 986         }
 987
 988         oid_array_clear(&revs);
 989         return bisect_auto_next(terms, NULL);
 990 }
 991
 992 static enum bisect_error bisect_log(void)
 993 {
 994         int fd, status;
 995         const char* filename = git_path_bisect_log();
 996
 997         if (is_empty_or_missing_file(filename))
 998                 return error(_("We are not bisecting."));
 999
1000         fd = open(filename, O_RDONLY);
1001         if (fd < 0)
1002                 return BISECT_FAILED;
1003
1004         status = copy_fd(fd, STDOUT_FILENO);
1005         close(fd);
1006         return status ? BISECT_FAILED : BISECT_OK;
1007 }
1008
1009 static int process_replay_line(struct bisect_terms *terms, struct strbuf *line)
1010 {
1011         const char *p = line->buf + strspn(line->buf, " \t");
1012         char *word_end, *rev;
1013
1014         if ((!skip_prefix(p, "git bisect", &p) &&
1015         !skip_prefix(p, "git-bisect", &p)) || !isspace(*p))
1016                 return 0;
1017         p += strspn(p, " \t");
1018
1019         word_end = (char *)p + strcspn(p, " \t");
1020         rev = word_end + strspn(word_end, " \t");
1021         *word_end = '\0'; /* NUL-terminate the word */
1022
1023         get_terms(terms);
1024         if (check_and_set_terms(terms, p))
1025                 return -1;
1026
1027         if (!strcmp(p, "start")) {
1028                 struct strvec argv = STRVEC_INIT;
1029                 int res;
1030                 sq_dequote_to_strvec(rev, &argv);
1031                 res = bisect_start(terms, argv.nr, argv.v);
1032                 strvec_clear(&argv);
1033                 return res;
1034         }
1035
1036         if (one_of(p, terms->term_good,
1037            terms->term_bad, "skip", NULL))
1038                 return bisect_write(p, rev, terms, 0);
1039
1040         if (!strcmp(p, "terms")) {
1041                 struct strvec argv = STRVEC_INIT;
1042                 int res;
1043                 sq_dequote_to_strvec(rev, &argv);
1044                 res = bisect_terms(terms, argv.nr == 1 ? argv.v[0] : NULL);
1045                 strvec_clear(&argv);
1046                 return res;
1047         }
1048         error(_("'%s'?? what are you talking about?"), p);
1049
1050         return -1;
1051 }
1052
1053 static enum bisect_error bisect_replay(struct bisect_terms *terms, const char *filename)
1054 {
1055         FILE *fp = NULL;
1056         enum bisect_error res = BISECT_OK;
1057         struct strbuf line = STRBUF_INIT;
1058
1059         if (is_empty_or_missing_file(filename))
1060                 return error(_("cannot read file '%s' for replaying"), filename);
1061
1062         if (bisect_reset(NULL))
1063                 return BISECT_FAILED;
1064
1065         fp = fopen(filename, "r");
1066         if (!fp)
1067                 return BISECT_FAILED;
1068
1069         while ((strbuf_getline(&line, fp) != EOF) && !res)
1070                 res = process_replay_line(terms, &line);
1071
1072         strbuf_release(&line);
1073         fclose(fp);
1074
1075         if (res)
1076                 return BISECT_FAILED;
1077
1078         return bisect_auto_next(terms, NULL);
1079 }
1080
1081 static enum bisect_error bisect_skip(struct bisect_terms *terms, int argc,
1082                                      const char **argv)
1083 {
1084         int i;
1085         enum bisect_error res;
1086         struct strvec argv_state = STRVEC_INIT;
1087
1088         strvec_push(&argv_state, "skip");
1089
1090         for (i = 0; i < argc; i++) {
1091                 const char *dotdot = strstr(argv[i], "..");
1092
1093                 if (dotdot) {
1094                         struct rev_info revs;
1095                         struct commit *commit;
1096
1097                         init_revisions(&revs, NULL);
1098                         setup_revisions(2, argv + i - 1, &revs, NULL);
1099
1100                         if (prepare_revision_walk(&revs))
1101                                 die(_("revision walk setup failed\n"));
1102                         while ((commit = get_revision(&revs)) != NULL)
1103                                 strvec_push(&argv_state,
1104                                                 oid_to_hex(&commit->object.oid));
1105
1106                         reset_revision_walk();
1107                         release_revisions(&revs);
1108                 } else {
1109                         strvec_push(&argv_state, argv[i]);
1110                 }
1111         }
1112         res = bisect_state(terms, argv_state.nr, argv_state.v);
1113
1114         strvec_clear(&argv_state);
1115         return res;
1116 }
1117
1118 static int bisect_visualize(struct bisect_terms *terms, int argc,
1119                             const char **argv)
1120 {
1121         struct child_process cmd = CHILD_PROCESS_INIT;
1122         struct strbuf sb = STRBUF_INIT;
1123
1124         if (bisect_next_check(terms, NULL) != 0)
1125                 return BISECT_FAILED;
1126
1127         cmd.no_stdin = 1;
1128         if (!argc) {
1129                 if ((getenv("DISPLAY") || getenv("SESSIONNAME") || getenv("MSYSTEM") ||
1130                      getenv("SECURITYSESSIONID")) && exists_in_PATH("gitk")) {
1131                         strvec_push(&cmd.args, "gitk");
1132                 } else {
1133                         strvec_push(&cmd.args, "log");
1134                         cmd.git_cmd = 1;
1135                 }
1136         } else {
1137                 if (argv[0][0] == '-') {
1138                         strvec_push(&cmd.args, "log");
1139                         cmd.git_cmd = 1;
1140                 } else if (strcmp(argv[0], "tig") && !starts_with(argv[0], "git"))
1141                         cmd.git_cmd = 1;
1142
1143                 strvec_pushv(&cmd.args, argv);
1144         }
1145
1146         strvec_pushl(&cmd.args, "--bisect", "--", NULL);
1147
1148         strbuf_read_file(&sb, git_path_bisect_names(), 0);
1149         sq_dequote_to_strvec(sb.buf, &cmd.args);
1150         strbuf_release(&sb);
1151
1152         return run_command(&cmd);
1153 }
1154
1155 static int get_first_good(const char *refname UNUSED,
1156                           const struct object_id *oid,
1157                           int flag UNUSED, void *cb_data)
1158 {
1159         oidcpy(cb_data, oid);
1160         return 1;
1161 }
1162
1163 static int do_bisect_run(const char *command)
1164 {
1165         struct child_process cmd = CHILD_PROCESS_INIT;
1166
1167         printf(_("running %s\n"), command);
1168         cmd.use_shell = 1;
1169         strvec_push(&cmd.args, command);
1170         return run_command(&cmd);
1171 }
1172
1173 static int verify_good(const struct bisect_terms *terms, const char *command)
1174 {
1175         int rc;
1176         enum bisect_error res;
1177         struct object_id good_rev;
1178         struct object_id current_rev;
1179         char *good_glob = xstrfmt("%s-*", terms->term_good);
1180         int no_checkout = ref_exists("BISECT_HEAD");
1181
1182         for_each_glob_ref_in(get_first_good, good_glob, "refs/bisect/",
1183                              &good_rev);
1184         free(good_glob);
1185
1186         if (read_ref(no_checkout ? "BISECT_HEAD" : "HEAD", &current_rev))
1187                 return -1;
1188
1189         res = bisect_checkout(&good_rev, no_checkout);
1190         if (res != BISECT_OK)
1191                 return -1;
1192
1193         rc = do_bisect_run(command);
1194
1195         res = bisect_checkout(&current_rev, no_checkout);
1196         if (res != BISECT_OK)
1197                 return -1;
1198
1199         return rc;
1200 }
1201
1202 static int bisect_run(struct bisect_terms *terms, int argc, const char **argv)
1203 {
1204         int res = BISECT_OK;
1205         struct strbuf command = STRBUF_INIT;
1206         const char *new_state;
1207         int temporary_stdout_fd, saved_stdout;
1208         int is_first_run = 1;
1209
1210         if (bisect_next_check(terms, NULL))
1211                 return BISECT_FAILED;
1212
1213         if (!argc) {
1214                 error(_("bisect run failed: no command provided."));
1215                 return BISECT_FAILED;
1216         }
1217
1218         sq_quote_argv(&command, argv);
1219         strbuf_ltrim(&command);
1220         while (1) {
1221                 res = do_bisect_run(command.buf);
1222
1223                 /*
1224                  * Exit code 126 and 127 can either come from the shell
1225                  * if it was unable to execute or even find the script,
1226                  * or from the script itself.  Check with a known-good
1227                  * revision to avoid trashing the bisect run due to a
1228                  * missing or non-executable script.
1229                  */
1230                 if (is_first_run && (res == 126 || res == 127)) {
1231                         int rc = verify_good(terms, command.buf);
1232                         is_first_run = 0;
1233                         if (rc < 0 || 128 <= rc) {
1234                                 error(_("unable to verify %s on good"
1235                                         " revision"), command.buf);
1236                                 res = BISECT_FAILED;
1237                                 break;
1238                         }
1239                         if (rc == res) {
1240                                 error(_("bogus exit code %d for good revision"),
1241                                       rc);
1242                                 res = BISECT_FAILED;
1243                                 break;
1244                         }
1245                 }
1246
1247                 if (res < 0 || 128 <= res) {
1248                         error(_("bisect run failed: exit code %d from"
1249                                 " %s is < 0 or >= 128"), res, command.buf);
1250                         break;
1251                 }
1252
1253                 if (res == 125)
1254                         new_state = "skip";
1255                 else if (!res)
1256                         new_state = terms->term_good;
1257                 else
1258                         new_state = terms->term_bad;
1259
1260                 temporary_stdout_fd = open(git_path_bisect_run(), O_CREAT | O_WRONLY | O_TRUNC, 0666);
1261
1262                 if (temporary_stdout_fd < 0) {
1263                         res = error_errno(_("cannot open file '%s' for writing"), git_path_bisect_run());
1264                         break;
1265                 }
1266
1267                 fflush(stdout);
1268                 saved_stdout = dup(1);
1269                 dup2(temporary_stdout_fd, 1);
1270
1271                 res = bisect_state(terms, 1, &new_state);
1272
1273                 fflush(stdout);
1274                 dup2(saved_stdout, 1);
1275                 close(saved_stdout);
1276                 close(temporary_stdout_fd);
1277
1278                 print_file_to_stdout(git_path_bisect_run());
1279
1280                 if (res == BISECT_ONLY_SKIPPED_LEFT)
1281                         error(_("bisect run cannot continue any more"));
1282                 else if (res == BISECT_INTERNAL_SUCCESS_MERGE_BASE) {
1283                         puts(_("bisect run success"));
1284                         res = BISECT_OK;
1285                 } else if (res == BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND) {
1286                         puts(_("bisect found first bad commit"));
1287                         res = BISECT_OK;
1288                 } else if (res) {
1289                         error(_("bisect run failed: 'git bisect %s'"
1290                                 " exited with error code %d"), new_state, res);
1291                 } else {
1292                         continue;
1293                 }
1294                 break;
1295         }
1296
1297         strbuf_release(&command);
1298         return res;
1299 }
1300
1301 static int cmd_bisect__reset(int argc, const char **argv, const char *prefix UNUSED)
1302 {
1303         if (argc > 1)
1304                 return error(_("'%s' requires either no argument or a commit"),
1305                              "git bisect reset");
1306         return bisect_reset(argc ? argv[0] : NULL);
1307 }
1308
1309 static int cmd_bisect__terms(int argc, const char **argv, const char *prefix UNUSED)
1310 {
1311         int res;
1312         struct bisect_terms terms = { 0 };
1313
1314         if (argc > 1)
1315                 return error(_("'%s' requires 0 or 1 argument"),
1316                              "git bisect terms");
1317         res = bisect_terms(&terms, argc == 1 ? argv[0] : NULL);
1318         free_terms(&terms);
1319         return res;
1320 }
1321
1322 static int cmd_bisect__start(int argc, const char **argv, const char *prefix UNUSED)
1323 {
1324         int res;
1325         struct bisect_terms terms = { 0 };
1326
1327         set_terms(&terms, "bad", "good");
1328         res = bisect_start(&terms, argc, argv);
1329         free_terms(&terms);
1330         return res;
1331 }
1332
1333 static int cmd_bisect__next(int argc, const char **argv UNUSED, const char *prefix)
1334 {
1335         int res;
1336         struct bisect_terms terms = { 0 };
1337
1338         if (argc)
1339                 return error(_("'%s' requires 0 arguments"),
1340                              "git bisect next");
1341         get_terms(&terms);
1342         res = bisect_next(&terms, prefix);
1343         free_terms(&terms);
1344         return res;
1345 }
1346
1347 static int cmd_bisect__log(int argc UNUSED, const char **argv UNUSED, const char *prefix UNUSED)
1348 {
1349         return bisect_log();
1350 }
1351
1352 static int cmd_bisect__replay(int argc, const char **argv, const char *prefix UNUSED)
1353 {
1354         int res;
1355         struct bisect_terms terms = { 0 };
1356
1357         if (argc != 1)
1358                 return error(_("no logfile given"));
1359         set_terms(&terms, "bad", "good");
1360         res = bisect_replay(&terms, argv[0]);
1361         free_terms(&terms);
1362         return res;
1363 }
1364
1365 static int cmd_bisect__skip(int argc, const char **argv, const char *prefix UNUSED)
1366 {
1367         int res;
1368         struct bisect_terms terms = { 0 };
1369
1370         set_terms(&terms, "bad", "good");
1371         get_terms(&terms);
1372         res = bisect_skip(&terms, argc, argv);
1373         free_terms(&terms);
1374         return res;
1375 }
1376
1377 static int cmd_bisect__visualize(int argc, const char **argv, const char *prefix UNUSED)
1378 {
1379         int res;
1380         struct bisect_terms terms = { 0 };
1381
1382         get_terms(&terms);
1383         res = bisect_visualize(&terms, argc, argv);
1384         free_terms(&terms);
1385         return res;
1386 }
1387
1388 static int cmd_bisect__run(int argc, const char **argv, const char *prefix UNUSED)
1389 {
1390         int res;
1391         struct bisect_terms terms = { 0 };
1392
1393         if (!argc)
1394                 return error(_("'%s' failed: no command provided."), "git bisect run");
1395         get_terms(&terms);
1396         res = bisect_run(&terms, argc, argv);
1397         free_terms(&terms);
1398         return res;
1399 }
1400
1401 int cmd_bisect(int argc, const char **argv, const char *prefix)
1402 {
1403         int res = 0;
1404         parse_opt_subcommand_fn *fn = NULL;
1405         struct option options[] = {
1406                 OPT_SUBCOMMAND("reset", &fn, cmd_bisect__reset),
1407                 OPT_SUBCOMMAND("terms", &fn, cmd_bisect__terms),
1408                 OPT_SUBCOMMAND("start", &fn, cmd_bisect__start),
1409                 OPT_SUBCOMMAND("next", &fn, cmd_bisect__next),
1410                 OPT_SUBCOMMAND("log", &fn, cmd_bisect__log),
1411                 OPT_SUBCOMMAND("replay", &fn, cmd_bisect__replay),
1412                 OPT_SUBCOMMAND("skip", &fn, cmd_bisect__skip),
1413                 OPT_SUBCOMMAND("visualize", &fn, cmd_bisect__visualize),
1414                 OPT_SUBCOMMAND("view", &fn, cmd_bisect__visualize),
1415                 OPT_SUBCOMMAND("run", &fn, cmd_bisect__run),
1416                 OPT_END()
1417         };
1418         argc = parse_options(argc, argv, prefix, options, git_bisect_usage,
1419                              PARSE_OPT_SUBCOMMAND_OPTIONAL);
1420
1421         if (!fn) {
1422                 struct bisect_terms terms = { 0 };
1423
1424                 if (!argc)
1425                         usage_msg_opt(_("need a command"), git_bisect_usage, options);
1426
1427                 set_terms(&terms, "bad", "good");
1428                 get_terms(&terms);
1429                 if (check_and_set_terms(&terms, argv[0]))
1430                         usage_msg_optf(_("unknown command: '%s'"), git_bisect_usage,
1431                                        options, argv[0]);
1432                 res = bisect_state(&terms, argc, argv);
1433                 free_terms(&terms);
1434         } else {
1435                 argc--;
1436                 argv++;
1437                 res = fn(argc, argv, prefix);
1438         }
1439
1440         return is_bisect_success(res) ? 0 : -res;
1441 }