git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
blob d1d12f2c07dae8f876d2bd8c0694f3d6bd5290a5 9281 bytes (raw)
name: builtin/bisect--helper.c 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
#include "builtin.h"
#include "cache.h"
#include "parse-options.h"
#include "bisect.h"
#include "refs.h"
#include "dir.h"
#include "argv-array.h"
#include "run-command.h"

static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS")
static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
static GIT_PATH_FUNC(git_path_bisect_ancestors_ok, "BISECT_ANCESTORS_OK")
static GIT_PATH_FUNC(git_path_bisect_log, "BISECT_LOG")
static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
static GIT_PATH_FUNC(git_path_bisect_run, "BISECT_RUN")
static GIT_PATH_FUNC(git_path_head_name, "head-name")
static GIT_PATH_FUNC(git_path_bisect_start, "BISECT_START")
static GIT_PATH_FUNC(git_path_bisect_head, "BISECT_HEAD")

static const char * const git_bisect_helper_usage[] = {
	N_("git bisect--helper --next-all [--no-checkout]"),
	N_("git bisect--helper --write-terms <bad_term> <good_term>"),
	N_("git bisect--helper --bisect-clean-state"),
	N_("git bisect--helper --bisect-reset [<commit>]"),
	N_("git bisect--helper --bisect-write <state> <revision> <TERM_GOOD> <TERM_BAD> [<nolog>]"),
	NULL
};

struct bisect_terms {
	struct strbuf term_good;
	struct strbuf term_bad;
};

static void bisect_terms_init(struct bisect_terms *terms)
{
	strbuf_init(&terms->term_good, 0);
	strbuf_init(&terms->term_bad, 0);
}

static void bisect_terms_release(struct bisect_terms *terms)
{
	strbuf_release(&terms->term_good);
	strbuf_release(&terms->term_bad);
}

/*
 * Check whether the string `term` belongs to the set of strings
 * included in the variable arguments.
 */
static int one_of(const char *term, ...)
{
	int res = 0;
	va_list matches;
	const char *match;

	va_start(matches, term);
	while (!res && (match = va_arg(matches, const char *)))
		res = !strcmp(term, match);
	va_end(matches);

	return res;
}

static int check_term_format(const char *term, const char *orig_term)
{
	int res;
	char *new_term = xstrfmt("refs/bisect/%s", term);

	res = check_refname_format(new_term, 0);
	free(new_term);

	if (res)
		return error(_("'%s' is not a valid term"), term);

	if (one_of(term, "help", "start", "skip", "next", "reset",
			"visualize", "replay", "log", "run", NULL))
		return error(_("can't use the builtin command '%s' as a term"), term);

	/*
	 * In theory, nothing prevents swapping completely good and bad,
	 * but this situation could be confusing and hasn't been tested
	 * enough. Forbid it for now.
	 */

	if ((strcmp(orig_term, "bad") && one_of(term, "bad", "new", NULL)) ||
		 (strcmp(orig_term, "good") && one_of(term, "good", "old", NULL)))
		return error(_("can't change the meaning of the term '%s'"), term);

	return 0;
}

static int write_terms(const char *bad, const char *good)
{
	FILE *fp;
	int res;

	if (!strcmp(bad, good))
		return error(_("please use two different terms"));

	if (check_term_format(bad, "bad") || check_term_format(good, "good"))
		return -1;

	fp = fopen(git_path_bisect_terms(), "w");
	if (!fp)
		return error_errno(_("could not open the file BISECT_TERMS"));

	res = fprintf(fp, "%s\n%s\n", bad, good);
	fclose(fp);
	return (res < 0) ? -1 : 0;
}

static int mark_for_removal(const char *refname, const struct object_id *oid,
			    int flag, void *cb_data)
{
	struct string_list *refs = cb_data;
	char *ref = xstrfmt("refs/bisect/%s", refname);
	string_list_append(refs, ref);
	return 0;
}

static int bisect_clean_state(void)
{
	int result = 0;

	/* There may be some refs packed during bisection */
	struct string_list refs_for_removal = STRING_LIST_INIT_NODUP;
	for_each_ref_in("refs/bisect/", mark_for_removal, (void *) &refs_for_removal);
	string_list_append(&refs_for_removal, xstrdup("BISECT_HEAD"));
	result = delete_refs(&refs_for_removal);
	refs_for_removal.strdup_strings = 1;
	string_list_clear(&refs_for_removal, 0);
	remove_path(git_path_bisect_expected_rev());
	remove_path(git_path_bisect_ancestors_ok());
	remove_path(git_path_bisect_log());
	remove_path(git_path_bisect_names());
	remove_path(git_path_bisect_run());
	remove_path(git_path_bisect_terms());
	/* Cleanup head-name if it got left by an old version of git-bisect */
	remove_path(git_path_head_name());
	/*
	 * Cleanup BISECT_START last to support the --no-checkout option
	 * introduced in the commit 4796e823a.
	 */
	remove_path(git_path_bisect_start());

	return result;
}

static int bisect_reset(const char *commit)
{
	struct strbuf branch = STRBUF_INIT;

	if (!commit) {
		if (strbuf_read_file(&branch, git_path_bisect_start(), 0) < 1) {
			printf("We are not bisecting.\n");
			return 0;
		}
		strbuf_rtrim(&branch);
	} else {
		struct object_id oid;
		if (get_oid(commit, &oid))
			return error(_("'%s' is not a valid commit"), commit);
		strbuf_addstr(&branch, commit);
	}

	if (!file_exists(git_path_bisect_head())) {
		struct argv_array argv = ARGV_ARRAY_INIT;
		argv_array_pushl(&argv, "checkout", branch.buf, "--", NULL);
		if (run_command_v_opt(argv.argv, RUN_GIT_CMD)) {
			error(_("Could not check out original HEAD '%s'. Try"
				"'git bisect reset <commit>'."), branch.buf);
			strbuf_release(&branch);
			argv_array_clear(&argv);
			return -1;
		}
		argv_array_clear(&argv);
	}

	strbuf_release(&branch);
	return bisect_clean_state();
}

static int is_expected_rev(const char *expected_hex)
{
	struct strbuf actual_hex = STRBUF_INIT;
	int res = 0;
	if (strbuf_read_file(&actual_hex, git_path_bisect_expected_rev(), 0) >= 0) {
		strbuf_trim(&actual_hex);
		res = !strcmp(actual_hex.buf, expected_hex);
	}
	strbuf_release(&actual_hex);
	return res;
}

static int check_expected_revs(const char **revs, int rev_nr)
{
	int i;

	for (i = 0; i < rev_nr; i++) {
		if (!is_expected_rev(revs[i])) {
			remove_path(git_path_bisect_ancestors_ok());
			remove_path(git_path_bisect_expected_rev());
			return 0;
		}
	}
	return 0;
}

static int bisect_write(const char *state, const char *rev,
			const struct bisect_terms *terms, int nolog)
{
	struct strbuf tag = STRBUF_INIT;
	struct strbuf commit_name = STRBUF_INIT;
	struct object_id oid;
	struct commit *commit;
	struct pretty_print_context pp = {0};
	FILE *fp;

	if (!strcmp(state, terms->term_bad.buf))
		strbuf_addf(&tag, "refs/bisect/%s", state);
	else if (one_of(state, terms->term_good.buf, "skip", NULL))
		strbuf_addf(&tag, "refs/bisect/%s-%s", state, rev);
	else
		return error(_("Bad bisect_write argument: %s"), state);

	if (get_oid(rev, &oid)) {
		strbuf_release(&tag);
		return error(_("couldn't get the oid of the rev '%s'"), rev);
	}

	if (update_ref(NULL, tag.buf, oid.hash, NULL, 0,
		       UPDATE_REFS_MSG_ON_ERR)) {
		strbuf_release(&tag);
		return -1;
	}
	strbuf_release(&tag);

	fp = fopen(git_path_bisect_log(), "a");
	if (!fp)
		return error_errno(_("couldn't open the file '%s'"), git_path_bisect_log());

	commit = lookup_commit_reference(oid.hash);
	format_commit_message(commit, "%s", &commit_name, &pp);
	fprintf(fp, "# %s: [%s] %s\n", state, sha1_to_hex(oid.hash),
		commit_name.buf);
	strbuf_release(&commit_name);

	if (!nolog)
		fprintf(fp, "git bisect %s %s\n", state, rev);

	fclose(fp);
	return 0;
}

int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
{
	enum {
		NEXT_ALL = 1,
		WRITE_TERMS,
		BISECT_CLEAN_STATE,
		BISECT_RESET,
		CHECK_EXPECTED_REVS,
		BISECT_WRITE
	} cmdmode = 0;
	int no_checkout = 0, res = 0;
	struct option options[] = {
		OPT_CMDMODE(0, "next-all", &cmdmode,
			 N_("perform 'git bisect next'"), NEXT_ALL),
		OPT_CMDMODE(0, "write-terms", &cmdmode,
			 N_("write the terms to .git/BISECT_TERMS"), WRITE_TERMS),
		OPT_CMDMODE(0, "bisect-clean-state", &cmdmode,
			 N_("cleanup the bisection state"), BISECT_CLEAN_STATE),
		OPT_CMDMODE(0, "bisect-reset", &cmdmode,
			 N_("reset the bisection state"), BISECT_RESET),
		OPT_CMDMODE(0, "check-expected-revs", &cmdmode,
			 N_("check for expected revs"), CHECK_EXPECTED_REVS),
		OPT_CMDMODE(0, "bisect-write", &cmdmode,
			 N_("write out the bisection state in BISECT_LOG"), BISECT_WRITE),
		OPT_BOOL(0, "no-checkout", &no_checkout,
			 N_("update BISECT_HEAD instead of checking out the current commit")),
		OPT_END()
	};
	struct bisect_terms terms;
	bisect_terms_init(&terms);

	argc = parse_options(argc, argv, prefix, options,
			     git_bisect_helper_usage, 0);

	if (!cmdmode)
		usage_with_options(git_bisect_helper_usage, options);

	switch (cmdmode) {
	int nolog;
	case NEXT_ALL:
		return bisect_next_all(prefix, no_checkout);
	case WRITE_TERMS:
		if (argc != 2)
			die(_("--write-terms requires two arguments"));
		res = write_terms(argv[0], argv[1]);
		break;
	case BISECT_CLEAN_STATE:
		if (argc != 0)
			die(_("--bisect-clean-state requires no arguments"));
		res = bisect_clean_state();
		break;
	case BISECT_RESET:
		if (argc > 1)
			die(_("--bisect-reset requires either zero or one arguments"));
		res = bisect_reset(argc ? argv[0] : NULL);
		break;
	case CHECK_EXPECTED_REVS:
		res = check_expected_revs(argv, argc);
		break;
	case BISECT_WRITE:
		if (argc != 4 && argc != 5)
			die(_("--bisect-write requires either 4 or 5 arguments"));
		nolog = (argc == 5) && !strcmp(argv[4], "nolog");
		strbuf_addstr(&terms.term_good, argv[2]);
		strbuf_addstr(&terms.term_bad, argv[3]);
		res = bisect_write(argv[0], argv[1], &terms, nolog);
		break;
	default:
		die("BUG: unknown subcommand '%d'", cmdmode);
	}
	bisect_terms_release(&terms);
	return res;
}

debug log:

solving d1d12f2 ...
found d1d12f2 in https://public-inbox.org/git/010201560a4782ac-5add737e-3648-4ed6-a8a2-e451378a1782-000000@eu-west-1.amazonses.com/
found 86bb334 in https://public-inbox.org/git/010201560a47828f-ff30359f-fd6c-4a21-b054-209f5f8946f7-000000@eu-west-1.amazonses.com/
found d125fd3 in https://public-inbox.org/git/010201560a478295-723db87e-2c2c-49c1-bf5e-c9d7997b873a-000000@eu-west-1.amazonses.com/
found ad67a97 in https://public-inbox.org/git/010201560a478269-d2b7864c-e177-43ed-87a8-05ccdff24367-000000@eu-west-1.amazonses.com/
found ef87c82 in https://public-inbox.org/git/010201560a478266-7d8dd795-2bb9-4dc9-95f3-97ca265834b1-000000@eu-west-1.amazonses.com/
found 48285d4 in https://public-inbox.org/git/0102015640423cc5-691952fa-3726-4132-bcc1-dfa55d4c0895-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/010201560a47824b-eac46132-eaa5-4ccc-a0ac-2121e74d5547-000000@eu-west-1.amazonses.com/
found 8111c91 in https://public-inbox.org/git/010201567675adc1-17e27495-6b36-40d1-836d-814da029fcc4-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/01020157c38b19e0-81123fa5-5d9d-4f64-8f1b-ff336e83ebe4-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/01020156b73fe5b4-5dc768ab-b73b-4a21-ab92-018e2a7aa6f7-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/01020156a48144f8-c0e127c1-8cd9-4295-ac16-449a54315cac-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/0102015640423c26-2060fd70-c90d-4de3-ae8c-1801ad160b1c-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/010201560a4781be-e8418d6a-5996-45cd-b11b-ca25894ad7f2-000000@eu-west-1.amazonses.com/ ||
	https://public-inbox.org/git/20160712223538.28508-2-pranit.bauva@gmail.com/ ||
	https://public-inbox.org/git/1464014928-31548-2-git-send-email-pranit.bauva@gmail.com/ ||
	https://public-inbox.org/git/20160524072124.2945-2-pranit.bauva@gmail.com/ ||
	https://public-inbox.org/git/1463031127-17718-2-git-send-email-pranit.bauva@gmail.com/ ||
	https://public-inbox.org/git/20160524184242.7518-2-pranit.bauva@gmail.com/
found 3324229 in https://80x24.org/mirrors/git.git
preparing index
index prepared:
100644 3324229025300f7d7de600753c03af3ac22e2152	builtin/bisect--helper.c

applying [1/7] https://public-inbox.org/git/010201567675adc1-17e27495-6b36-40d1-836d-814da029fcc4-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index 3324229..8111c91 100644

Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.

skipping https://public-inbox.org/git/01020157c38b19e0-81123fa5-5d9d-4f64-8f1b-ff336e83ebe4-000000@eu-west-1.amazonses.com/ for 8111c91
skipping https://public-inbox.org/git/01020156b73fe5b4-5dc768ab-b73b-4a21-ab92-018e2a7aa6f7-000000@eu-west-1.amazonses.com/ for 8111c91
skipping https://public-inbox.org/git/01020156a48144f8-c0e127c1-8cd9-4295-ac16-449a54315cac-000000@eu-west-1.amazonses.com/ for 8111c91
skipping https://public-inbox.org/git/0102015640423c26-2060fd70-c90d-4de3-ae8c-1801ad160b1c-000000@eu-west-1.amazonses.com/ for 8111c91
skipping https://public-inbox.org/git/010201560a4781be-e8418d6a-5996-45cd-b11b-ca25894ad7f2-000000@eu-west-1.amazonses.com/ for 8111c91
skipping https://public-inbox.org/git/20160712223538.28508-2-pranit.bauva@gmail.com/ for 8111c91
skipping https://public-inbox.org/git/1464014928-31548-2-git-send-email-pranit.bauva@gmail.com/ for 8111c91
skipping https://public-inbox.org/git/20160524072124.2945-2-pranit.bauva@gmail.com/ for 8111c91
skipping https://public-inbox.org/git/1463031127-17718-2-git-send-email-pranit.bauva@gmail.com/ for 8111c91
skipping https://public-inbox.org/git/20160524184242.7518-2-pranit.bauva@gmail.com/ for 8111c91
index at:
100644 8111c9149f5b95234f7144b1310f3d2bd5f6310e	builtin/bisect--helper.c

applying [2/7] https://public-inbox.org/git/0102015640423cc5-691952fa-3726-4132-bcc1-dfa55d4c0895-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index 8111c91..48285d4 100644

Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.

skipping https://public-inbox.org/git/010201560a47824b-eac46132-eaa5-4ccc-a0ac-2121e74d5547-000000@eu-west-1.amazonses.com/ for 48285d4
index at:
100644 48285d4924ae3633f46873983338d356fce6a6b5	builtin/bisect--helper.c

applying [3/7] https://public-inbox.org/git/010201560a478266-7d8dd795-2bb9-4dc9-95f3-97ca265834b1-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index 48285d4..ef87c82 100644


applying [4/7] https://public-inbox.org/git/010201560a478269-d2b7864c-e177-43ed-87a8-05ccdff24367-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index ef87c82..ad67a97 100644


applying [5/7] https://public-inbox.org/git/010201560a478295-723db87e-2c2c-49c1-bf5e-c9d7997b873a-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index ad67a97..d125fd3 100644


applying [6/7] https://public-inbox.org/git/010201560a47828f-ff30359f-fd6c-4a21-b054-209f5f8946f7-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index d125fd3..86bb334 100644


applying [7/7] https://public-inbox.org/git/010201560a4782ac-5add737e-3648-4ed6-a8a2-e451378a1782-000000@eu-west-1.amazonses.com/
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index 86bb334..d1d12f2 100644

Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.
Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.
Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.
Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.
Checking patch builtin/bisect--helper.c...
Applied patch builtin/bisect--helper.c cleanly.

index at:
100644 d1d12f2c07dae8f876d2bd8c0694f3d6bd5290a5	builtin/bisect--helper.c

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).