3 #include "parse-options.h"
8 #include "run-command.h"
12 static GIT_PATH_FUNC(git_path_bisect_terms
, "BISECT_TERMS")
13 static GIT_PATH_FUNC(git_path_bisect_expected_rev
, "BISECT_EXPECTED_REV")
14 static GIT_PATH_FUNC(git_path_bisect_ancestors_ok
, "BISECT_ANCESTORS_OK")
15 static GIT_PATH_FUNC(git_path_bisect_start
, "BISECT_START")
16 static GIT_PATH_FUNC(git_path_bisect_log
, "BISECT_LOG")
17 static GIT_PATH_FUNC(git_path_head_name
, "head-name")
18 static GIT_PATH_FUNC(git_path_bisect_names
, "BISECT_NAMES")
19 static GIT_PATH_FUNC(git_path_bisect_first_parent
, "BISECT_FIRST_PARENT")
21 static const char * const git_bisect_helper_usage
[] = {
22 N_("git bisect--helper --next-all"),
23 N_("git bisect--helper --write-terms <bad_term> <good_term>"),
24 N_("git bisect--helper --bisect-clean-state"),
25 N_("git bisect--helper --bisect-reset [<commit>]"),
26 N_("git bisect--helper --bisect-write [--no-log] <state> <revision> <good_term> <bad_term>"),
27 N_("git bisect--helper --bisect-check-and-set-terms <command> <good_term> <bad_term>"),
28 N_("git bisect--helper --bisect-next-check <good_term> <bad_term> [<term>]"),
29 N_("git bisect--helper --bisect-terms [--term-good | --term-old | --term-bad | --term-new]"),
30 N_("git bisect--helper --bisect-start [--term-{new,bad}=<term> --term-{old,good}=<term>]"
31 " [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]"),
40 static void free_terms(struct bisect_terms
*terms
)
42 FREE_AND_NULL(terms
->term_good
);
43 FREE_AND_NULL(terms
->term_bad
);
46 static void set_terms(struct bisect_terms
*terms
, const char *bad
,
49 free((void *)terms
->term_good
);
50 terms
->term_good
= xstrdup(good
);
51 free((void *)terms
->term_bad
);
52 terms
->term_bad
= xstrdup(bad
);
55 static const char vocab_bad
[] = "bad|new";
56 static const char vocab_good
[] = "good|old";
59 * Check whether the string `term` belongs to the set of strings
60 * included in the variable arguments.
63 static int one_of(const char *term
, ...)
69 va_start(matches
, term
);
70 while (!res
&& (match
= va_arg(matches
, const char *)))
71 res
= !strcmp(term
, match
);
77 static int check_term_format(const char *term
, const char *orig_term
)
80 char *new_term
= xstrfmt("refs/bisect/%s", term
);
82 res
= check_refname_format(new_term
, 0);
86 return error(_("'%s' is not a valid term"), term
);
88 if (one_of(term
, "help", "start", "skip", "next", "reset",
89 "visualize", "view", "replay", "log", "run", "terms", NULL
))
90 return error(_("can't use the builtin command '%s' as a term"), term
);
93 * In theory, nothing prevents swapping completely good and bad,
94 * but this situation could be confusing and hasn't been tested
95 * enough. Forbid it for now.
98 if ((strcmp(orig_term
, "bad") && one_of(term
, "bad", "new", NULL
)) ||
99 (strcmp(orig_term
, "good") && one_of(term
, "good", "old", NULL
)))
100 return error(_("can't change the meaning of the term '%s'"), term
);
105 static int write_terms(const char *bad
, const char *good
)
110 if (!strcmp(bad
, good
))
111 return error(_("please use two different terms"));
113 if (check_term_format(bad
, "bad") || check_term_format(good
, "good"))
116 fp
= fopen(git_path_bisect_terms(), "w");
118 return error_errno(_("could not open the file BISECT_TERMS"));
120 res
= fprintf(fp
, "%s\n%s\n", bad
, good
);
122 return (res
< 0) ? -1 : 0;
125 static int is_expected_rev(const char *expected_hex
)
127 struct strbuf actual_hex
= STRBUF_INIT
;
129 if (strbuf_read_file(&actual_hex
, git_path_bisect_expected_rev(), 0) >= 40) {
130 strbuf_trim(&actual_hex
);
131 res
= !strcmp(actual_hex
.buf
, expected_hex
);
133 strbuf_release(&actual_hex
);
137 static void check_expected_revs(const char **revs
, int rev_nr
)
141 for (i
= 0; i
< rev_nr
; i
++) {
142 if (!is_expected_rev(revs
[i
])) {
143 unlink_or_warn(git_path_bisect_ancestors_ok());
144 unlink_or_warn(git_path_bisect_expected_rev());
149 static int bisect_reset(const char *commit
)
151 struct strbuf branch
= STRBUF_INIT
;
154 if (strbuf_read_file(&branch
, git_path_bisect_start(), 0) < 1) {
155 printf(_("We are not bisecting.\n"));
158 strbuf_rtrim(&branch
);
160 struct object_id oid
;
162 if (get_oid_commit(commit
, &oid
))
163 return error(_("'%s' is not a valid commit"), commit
);
164 strbuf_addstr(&branch
, commit
);
167 if (!ref_exists("BISECT_HEAD")) {
168 struct strvec argv
= STRVEC_INIT
;
170 strvec_pushl(&argv
, "checkout", branch
.buf
, "--", NULL
);
171 if (run_command_v_opt(argv
.v
, RUN_GIT_CMD
)) {
172 error(_("could not check out original"
173 " HEAD '%s'. Try 'git bisect"
174 " reset <commit>'."), branch
.buf
);
175 strbuf_release(&branch
);
182 strbuf_release(&branch
);
183 return bisect_clean_state();
186 static void log_commit(FILE *fp
, char *fmt
, const char *state
,
187 struct commit
*commit
)
189 struct pretty_print_context pp
= {0};
190 struct strbuf commit_msg
= STRBUF_INIT
;
191 char *label
= xstrfmt(fmt
, state
);
193 format_commit_message(commit
, "%s", &commit_msg
, &pp
);
195 fprintf(fp
, "# %s: [%s] %s\n", label
, oid_to_hex(&commit
->object
.oid
),
198 strbuf_release(&commit_msg
);
202 static int bisect_write(const char *state
, const char *rev
,
203 const struct bisect_terms
*terms
, int nolog
)
205 struct strbuf tag
= STRBUF_INIT
;
206 struct object_id oid
;
207 struct commit
*commit
;
211 if (!strcmp(state
, terms
->term_bad
)) {
212 strbuf_addf(&tag
, "refs/bisect/%s", state
);
213 } else if (one_of(state
, terms
->term_good
, "skip", NULL
)) {
214 strbuf_addf(&tag
, "refs/bisect/%s-%s", state
, rev
);
216 res
= error(_("Bad bisect_write argument: %s"), state
);
220 if (get_oid(rev
, &oid
)) {
221 res
= error(_("couldn't get the oid of the rev '%s'"), rev
);
225 if (update_ref(NULL
, tag
.buf
, &oid
, NULL
, 0,
226 UPDATE_REFS_MSG_ON_ERR
)) {
231 fp
= fopen(git_path_bisect_log(), "a");
233 res
= error_errno(_("couldn't open the file '%s'"), git_path_bisect_log());
237 commit
= lookup_commit_reference(the_repository
, &oid
);
238 log_commit(fp
, "%s", state
, commit
);
241 fprintf(fp
, "git bisect %s %s\n", state
, rev
);
246 strbuf_release(&tag
);
250 static int check_and_set_terms(struct bisect_terms
*terms
, const char *cmd
)
252 int has_term_file
= !is_empty_or_missing_file(git_path_bisect_terms());
254 if (one_of(cmd
, "skip", "start", "terms", NULL
))
257 if (has_term_file
&& strcmp(cmd
, terms
->term_bad
) &&
258 strcmp(cmd
, terms
->term_good
))
259 return error(_("Invalid command: you're currently in a "
260 "%s/%s bisect"), terms
->term_bad
,
263 if (!has_term_file
) {
264 if (one_of(cmd
, "bad", "good", NULL
)) {
265 set_terms(terms
, "bad", "good");
266 return write_terms(terms
->term_bad
, terms
->term_good
);
268 if (one_of(cmd
, "new", "old", NULL
)) {
269 set_terms(terms
, "new", "old");
270 return write_terms(terms
->term_bad
, terms
->term_good
);
277 static int mark_good(const char *refname
, const struct object_id
*oid
,
278 int flag
, void *cb_data
)
280 int *m_good
= (int *)cb_data
;
285 static const char need_bad_and_good_revision_warning
[] =
286 N_("You need to give me at least one %s and %s revision.\n"
287 "You can use \"git bisect %s\" and \"git bisect %s\" for that.");
289 static const char need_bisect_start_warning
[] =
290 N_("You need to start by \"git bisect start\".\n"
291 "You then need to give me at least one %s and %s revision.\n"
292 "You can use \"git bisect %s\" and \"git bisect %s\" for that.");
294 static int decide_next(const struct bisect_terms
*terms
,
295 const char *current_term
, int missing_good
,
298 if (!missing_good
&& !missing_bad
)
303 if (missing_good
&& !missing_bad
&&
304 !strcmp(current_term
, terms
->term_good
)) {
307 * have bad (or new) but not good (or old). We could bisect
308 * although this is less optimum.
310 warning(_("bisecting only with a %s commit"), terms
->term_bad
);
314 * TRANSLATORS: Make sure to include [Y] and [n] in your
315 * translation. The program will only accept English input
318 yesno
= git_prompt(_("Are you sure [Y/n]? "), PROMPT_ECHO
);
319 if (starts_with(yesno
, "N") || starts_with(yesno
, "n"))
324 if (!is_empty_or_missing_file(git_path_bisect_start()))
325 return error(_(need_bad_and_good_revision_warning
),
326 vocab_bad
, vocab_good
, vocab_bad
, vocab_good
);
328 return error(_(need_bisect_start_warning
),
329 vocab_good
, vocab_bad
, vocab_good
, vocab_bad
);
332 static int bisect_next_check(const struct bisect_terms
*terms
,
333 const char *current_term
)
335 int missing_good
= 1, missing_bad
= 1;
336 char *bad_ref
= xstrfmt("refs/bisect/%s", terms
->term_bad
);
337 char *good_glob
= xstrfmt("%s-*", terms
->term_good
);
339 if (ref_exists(bad_ref
))
342 for_each_glob_ref_in(mark_good
, good_glob
, "refs/bisect/",
343 (void *) &missing_good
);
348 return decide_next(terms
, current_term
, missing_good
, missing_bad
);
351 static int get_terms(struct bisect_terms
*terms
)
353 struct strbuf str
= STRBUF_INIT
;
357 fp
= fopen(git_path_bisect_terms(), "r");
364 strbuf_getline_lf(&str
, fp
);
365 terms
->term_bad
= strbuf_detach(&str
, NULL
);
366 strbuf_getline_lf(&str
, fp
);
367 terms
->term_good
= strbuf_detach(&str
, NULL
);
372 strbuf_release(&str
);
376 static int bisect_terms(struct bisect_terms
*terms
, const char *option
)
378 if (get_terms(terms
))
379 return error(_("no terms defined"));
381 if (option
== NULL
) {
382 printf(_("Your current terms are %s for the old state\n"
383 "and %s for the new state.\n"),
384 terms
->term_good
, terms
->term_bad
);
387 if (one_of(option
, "--term-good", "--term-old", NULL
))
388 printf("%s\n", terms
->term_good
);
389 else if (one_of(option
, "--term-bad", "--term-new", NULL
))
390 printf("%s\n", terms
->term_bad
);
392 return error(_("invalid argument %s for 'git bisect terms'.\n"
393 "Supported options are: "
394 "--term-good|--term-old and "
395 "--term-bad|--term-new."), option
);
400 static int bisect_append_log_quoted(const char **argv
)
403 FILE *fp
= fopen(git_path_bisect_log(), "a");
404 struct strbuf orig_args
= STRBUF_INIT
;
409 if (fprintf(fp
, "git bisect start") < 1) {
414 sq_quote_argv(&orig_args
, argv
);
415 if (fprintf(fp
, "%s\n", orig_args
.buf
) < 1)
420 strbuf_release(&orig_args
);
424 static int bisect_start(struct bisect_terms
*terms
, const char **argv
, int argc
)
427 int first_parent_only
= 0;
428 int i
, has_double_dash
= 0, must_write_terms
= 0, bad_seen
= 0;
429 int flags
, pathspec_pos
, res
= 0;
430 struct string_list revs
= STRING_LIST_INIT_DUP
;
431 struct string_list states
= STRING_LIST_INIT_DUP
;
432 struct strbuf start_head
= STRBUF_INIT
;
433 struct strbuf bisect_names
= STRBUF_INIT
;
434 struct object_id head_oid
;
435 struct object_id oid
;
438 if (is_bare_repository())
442 * Check for one bad and then some good revisions
444 for (i
= 0; i
< argc
; i
++) {
445 if (!strcmp(argv
[i
], "--")) {
451 for (i
= 0; i
< argc
; i
++) {
452 const char *arg
= argv
[i
];
453 if (!strcmp(argv
[i
], "--")) {
455 } else if (!strcmp(arg
, "--no-checkout")) {
457 } else if (!strcmp(arg
, "--first-parent")) {
458 first_parent_only
= 1;
459 } else if (!strcmp(arg
, "--term-good") ||
460 !strcmp(arg
, "--term-old")) {
463 return error(_("'' is not a valid term"));
464 must_write_terms
= 1;
465 free((void *) terms
->term_good
);
466 terms
->term_good
= xstrdup(argv
[i
]);
467 } else if (skip_prefix(arg
, "--term-good=", &arg
) ||
468 skip_prefix(arg
, "--term-old=", &arg
)) {
469 must_write_terms
= 1;
470 free((void *) terms
->term_good
);
471 terms
->term_good
= xstrdup(arg
);
472 } else if (!strcmp(arg
, "--term-bad") ||
473 !strcmp(arg
, "--term-new")) {
476 return error(_("'' is not a valid term"));
477 must_write_terms
= 1;
478 free((void *) terms
->term_bad
);
479 terms
->term_bad
= xstrdup(argv
[i
]);
480 } else if (skip_prefix(arg
, "--term-bad=", &arg
) ||
481 skip_prefix(arg
, "--term-new=", &arg
)) {
482 must_write_terms
= 1;
483 free((void *) terms
->term_bad
);
484 terms
->term_bad
= xstrdup(arg
);
485 } else if (starts_with(arg
, "--")) {
486 return error(_("unrecognized option: '%s'"), arg
);
488 char *commit_id
= xstrfmt("%s^{commit}", arg
);
489 if (get_oid(commit_id
, &oid
) && has_double_dash
)
490 die(_("'%s' does not appear to be a valid "
493 string_list_append(&revs
, oid_to_hex(&oid
));
500 * The user ran "git bisect start <sha1> <sha1>", hence did not
501 * explicitly specify the terms, but we are already starting to
502 * set references named with the default terms, and won't be able
503 * to change afterwards.
506 must_write_terms
= 1;
507 for (i
= 0; i
< revs
.nr
; i
++) {
509 string_list_append(&states
, terms
->term_good
);
512 string_list_append(&states
, terms
->term_bad
);
519 head
= resolve_ref_unsafe("HEAD", 0, &head_oid
, &flags
);
521 if (get_oid("HEAD", &head_oid
))
522 return error(_("bad HEAD - I need a HEAD"));
525 * Check if we are bisecting
527 if (!is_empty_or_missing_file(git_path_bisect_start())) {
528 /* Reset to the rev from where we started */
529 strbuf_read_file(&start_head
, git_path_bisect_start(), 0);
530 strbuf_trim(&start_head
);
532 struct strvec argv
= STRVEC_INIT
;
534 strvec_pushl(&argv
, "checkout", start_head
.buf
,
536 if (run_command_v_opt(argv
.v
, RUN_GIT_CMD
)) {
537 res
= error(_("checking out '%s' failed."
538 " Try 'git bisect start "
545 /* Get the rev from where we start. */
546 if (!get_oid(head
, &head_oid
) &&
547 !starts_with(head
, "refs/heads/")) {
548 strbuf_reset(&start_head
);
549 strbuf_addstr(&start_head
, oid_to_hex(&head_oid
));
550 } else if (!get_oid(head
, &head_oid
) &&
551 skip_prefix(head
, "refs/heads/", &head
)) {
553 * This error message should only be triggered by
554 * cogito usage, and cogito users should understand
555 * it relates to cg-seek.
557 if (!is_empty_or_missing_file(git_path_head_name()))
558 return error(_("won't bisect on cg-seek'ed tree"));
559 strbuf_addstr(&start_head
, head
);
561 return error(_("bad HEAD - strange symbolic ref"));
566 * Get rid of any old bisect state.
568 if (bisect_clean_state())
572 * In case of mistaken revs or checkout error, or signals received,
573 * "bisect_auto_next" below may exit or misbehave.
574 * We have to trap this to be able to clean up using
575 * "bisect_clean_state".
579 * Write new start state
581 write_file(git_path_bisect_start(), "%s\n", start_head
.buf
);
583 if (first_parent_only
)
584 write_file(git_path_bisect_first_parent(), "\n");
587 if (get_oid(start_head
.buf
, &oid
) < 0) {
588 res
= error(_("invalid ref: '%s'"), start_head
.buf
);
591 if (update_ref(NULL
, "BISECT_HEAD", &oid
, NULL
, 0,
592 UPDATE_REFS_MSG_ON_ERR
)) {
598 if (pathspec_pos
< argc
- 1)
599 sq_quote_argv(&bisect_names
, argv
+ pathspec_pos
);
600 write_file(git_path_bisect_names(), "%s\n", bisect_names
.buf
);
602 for (i
= 0; i
< states
.nr
; i
++)
603 if (bisect_write(states
.items
[i
].string
,
604 revs
.items
[i
].string
, terms
, 1)) {
609 if (must_write_terms
&& write_terms(terms
->term_bad
,
615 res
= bisect_append_log_quoted(argv
);
620 string_list_clear(&revs
, 0);
621 string_list_clear(&states
, 0);
622 strbuf_release(&start_head
);
623 strbuf_release(&bisect_names
);
627 int cmd_bisect__helper(int argc
, const char **argv
, const char *prefix
)
641 int res
= 0, nolog
= 0;
642 struct option options
[] = {
643 OPT_CMDMODE(0, "next-all", &cmdmode
,
644 N_("perform 'git bisect next'"), NEXT_ALL
),
645 OPT_CMDMODE(0, "write-terms", &cmdmode
,
646 N_("write the terms to .git/BISECT_TERMS"), WRITE_TERMS
),
647 OPT_CMDMODE(0, "bisect-clean-state", &cmdmode
,
648 N_("cleanup the bisection state"), BISECT_CLEAN_STATE
),
649 OPT_CMDMODE(0, "check-expected-revs", &cmdmode
,
650 N_("check for expected revs"), CHECK_EXPECTED_REVS
),
651 OPT_CMDMODE(0, "bisect-reset", &cmdmode
,
652 N_("reset the bisection state"), BISECT_RESET
),
653 OPT_CMDMODE(0, "bisect-write", &cmdmode
,
654 N_("write out the bisection state in BISECT_LOG"), BISECT_WRITE
),
655 OPT_CMDMODE(0, "check-and-set-terms", &cmdmode
,
656 N_("check and set terms in a bisection state"), CHECK_AND_SET_TERMS
),
657 OPT_CMDMODE(0, "bisect-next-check", &cmdmode
,
658 N_("check whether bad or good terms exist"), BISECT_NEXT_CHECK
),
659 OPT_CMDMODE(0, "bisect-terms", &cmdmode
,
660 N_("print out the bisect terms"), BISECT_TERMS
),
661 OPT_CMDMODE(0, "bisect-start", &cmdmode
,
662 N_("start the bisect session"), BISECT_START
),
663 OPT_BOOL(0, "no-log", &nolog
,
664 N_("no log for BISECT_WRITE")),
667 struct bisect_terms terms
= { .term_good
= NULL
, .term_bad
= NULL
};
669 argc
= parse_options(argc
, argv
, prefix
, options
,
670 git_bisect_helper_usage
,
671 PARSE_OPT_KEEP_DASHDASH
| PARSE_OPT_KEEP_UNKNOWN
);
674 usage_with_options(git_bisect_helper_usage
, options
);
678 res
= bisect_next_all(the_repository
, prefix
);
682 return error(_("--write-terms requires two arguments"));
683 return write_terms(argv
[0], argv
[1]);
684 case BISECT_CLEAN_STATE
:
686 return error(_("--bisect-clean-state requires no arguments"));
687 return bisect_clean_state();
688 case CHECK_EXPECTED_REVS
:
689 check_expected_revs(argv
, argc
);
693 return error(_("--bisect-reset requires either no argument or a commit"));
694 return !!bisect_reset(argc
? argv
[0] : NULL
);
696 if (argc
!= 4 && argc
!= 5)
697 return error(_("--bisect-write requires either 4 or 5 arguments"));
698 set_terms(&terms
, argv
[3], argv
[2]);
699 res
= bisect_write(argv
[0], argv
[1], &terms
, nolog
);
701 case CHECK_AND_SET_TERMS
:
703 return error(_("--check-and-set-terms requires 3 arguments"));
704 set_terms(&terms
, argv
[2], argv
[1]);
705 res
= check_and_set_terms(&terms
, argv
[0]);
707 case BISECT_NEXT_CHECK
:
708 if (argc
!= 2 && argc
!= 3)
709 return error(_("--bisect-next-check requires 2 or 3 arguments"));
710 set_terms(&terms
, argv
[1], argv
[0]);
711 res
= bisect_next_check(&terms
, argc
== 3 ? argv
[2] : NULL
);
715 return error(_("--bisect-terms requires 0 or 1 argument"));
716 res
= bisect_terms(&terms
, argc
== 1 ? argv
[0] : NULL
);
719 set_terms(&terms
, "bad", "good");
720 res
= bisect_start(&terms
, argv
, argc
);
723 return error("BUG: unknown subcommand '%d'", cmdmode
);
728 * Handle early success
729 * From check_merge_bases > check_good_are_ancestors_of_bad > bisect_next_all
731 if (res
== BISECT_INTERNAL_SUCCESS_MERGE_BASE
)