bisect.c 24.8 KB
Newer Older
1 2 3 4
#include "cache.h"
#include "commit.h"
#include "diff.h"
#include "revision.h"
5 6
#include "refs.h"
#include "list-objects.h"
7
#include "quote.h"
8
#include "sha1-lookup.h"
9
#include "run-command.h"
10
#include "log-tree.h"
11
#include "bisect.h"
12
#include "sha1-array.h"
Jeff King's avatar
Jeff King committed
13
#include "argv-array.h"
14

15
static struct sha1_array good_revs;
16
static struct sha1_array skipped_revs;
17

18
static struct object_id *current_bad_oid;
19 20 21 22

static const char *argv_checkout[] = {"checkout", "-q", NULL, "--", NULL};
static const char *argv_show_branch[] = {"show-branch", NULL, NULL};

23 24 25
static const char *term_bad;
static const char *term_good;

26
/* Remember to update object flag allocation in object.h */
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
#define COUNTED		(1u<<16)

/*
 * This is a truly stupid algorithm, but it's only
 * used for bisection, and we just don't care enough.
 *
 * We care just barely enough to avoid recursing for
 * non-merge entries.
 */
static int count_distance(struct commit_list *entry)
{
	int nr = 0;

	while (entry) {
		struct commit *commit = entry->item;
		struct commit_list *p;

		if (commit->object.flags & (UNINTERESTING | COUNTED))
			break;
		if (!(commit->object.flags & TREESAME))
			nr++;
		commit->object.flags |= COUNTED;
		p = commit->parents;
		entry = p;
		if (p) {
			p = p->next;
			while (p) {
				nr += count_distance(p);
				p = p->next;
			}
		}
	}

	return nr;
}

static void clear_distance(struct commit_list *list)
{
	while (list) {
		struct commit *commit = list->item;
		commit->object.flags &= ~COUNTED;
		list = list->next;
	}
}

#define DEBUG_BISECT 0

static inline int weight(struct commit_list *elem)
{
	return *((int*)(elem->item->util));
}

static inline void weight_set(struct commit_list *elem, int weight)
{
	*((int*)(elem->item->util)) = weight;
}

static int count_interesting_parents(struct commit *commit)
{
	struct commit_list *p;
	int count;

	for (count = 0, p = commit->parents; p; p = p->next) {
		if (p->item->object.flags & UNINTERESTING)
			continue;
		count++;
	}
	return count;
}

static inline int halfway(struct commit_list *p, int nr)
{
	/*
	 * Don't short-cut something we are not going to return!
	 */
	if (p->item->object.flags & TREESAME)
		return 0;
	if (DEBUG_BISECT)
		return 0;
	/*
	 * 2 and 3 are halfway of 5.
	 * 3 is halfway of 6 but 2 and 4 are not.
	 */
	switch (2 * weight(p) - nr) {
	case -1: case 0: case 1:
		return 1;
	default:
		return 0;
	}
}

#if !DEBUG_BISECT
#define show_list(a,b,c,d) do { ; } while (0)
#else
static void show_list(const char *debug, int counted, int nr,
		      struct commit_list *list)
{
	struct commit_list *p;

	fprintf(stderr, "%s (%d/%d)\n", debug, counted, nr);

	for (p = list; p; p = p->next) {
		struct commit_list *pp;
		struct commit *commit = p->item;
		unsigned flags = commit->object.flags;
		enum object_type type;
		unsigned long size;
		char *buf = read_sha1_file(commit->object.sha1, &type, &size);
135 136
		const char *subject_start;
		int subject_len;
137 138 139 140 141 142 143 144 145 146 147 148 149 150

		fprintf(stderr, "%c%c%c ",
			(flags & TREESAME) ? ' ' : 'T',
			(flags & UNINTERESTING) ? 'U' : ' ',
			(flags & COUNTED) ? 'C' : ' ');
		if (commit->util)
			fprintf(stderr, "%3d", weight(p));
		else
			fprintf(stderr, "---");
		fprintf(stderr, " %.*s", 8, sha1_to_hex(commit->object.sha1));
		for (pp = commit->parents; pp; pp = pp->next)
			fprintf(stderr, " %.*s", 8,
				sha1_to_hex(pp->item->object.sha1));

151 152 153
		subject_len = find_commit_subject(buf, &subject_start);
		if (subject_len)
			fprintf(stderr, " %.*s", subject_len, subject_start);
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
		fprintf(stderr, "\n");
	}
}
#endif /* DEBUG_BISECT */

static struct commit_list *best_bisection(struct commit_list *list, int nr)
{
	struct commit_list *p, *best;
	int best_distance = -1;

	best = list;
	for (p = list; p; p = p->next) {
		int distance;
		unsigned flags = p->item->object.flags;

		if (flags & TREESAME)
			continue;
		distance = weight(p);
		if (nr - distance < distance)
			distance = nr - distance;
		if (distance > best_distance) {
			best = p;
			best_distance = distance;
		}
	}

	return best;
}

struct commit_dist {
	struct commit *commit;
	int distance;
};

static int compare_commit_dist(const void *a_, const void *b_)
{
	struct commit_dist *a, *b;

	a = (struct commit_dist *)a_;
	b = (struct commit_dist *)b_;
	if (a->distance != b->distance)
		return b->distance - a->distance; /* desc sort */
	return hashcmp(a->commit->object.sha1, b->commit->object.sha1);
}

static struct commit_list *best_bisection_sorted(struct commit_list *list, int nr)
{
	struct commit_list *p;
	struct commit_dist *array = xcalloc(nr, sizeof(*array));
	int cnt, i;

	for (p = list, cnt = 0; p; p = p->next) {
		int distance;
		unsigned flags = p->item->object.flags;

		if (flags & TREESAME)
			continue;
		distance = weight(p);
		if (nr - distance < distance)
			distance = nr - distance;
		array[cnt].commit = p->item;
		array[cnt].distance = distance;
		cnt++;
	}
	qsort(array, cnt, sizeof(*array), compare_commit_dist);
	for (p = list, i = 0; i < cnt; i++) {
220
		char buf[100]; /* enough for dist=%d */
221 222
		struct object *obj = &(array[i].commit->object);

223 224 225
		snprintf(buf, sizeof(buf), "dist=%d", array[i].distance);
		add_name_decoration(DECORATION_NONE, buf, obj);

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 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
		p->item = array[i].commit;
		p = p->next;
	}
	if (p)
		p->next = NULL;
	free(array);
	return list;
}

/*
 * zero or positive weight is the number of interesting commits it can
 * reach, including itself.  Especially, weight = 0 means it does not
 * reach any tree-changing commits (e.g. just above uninteresting one
 * but traversal is with pathspec).
 *
 * weight = -1 means it has one parent and its distance is yet to
 * be computed.
 *
 * weight = -2 means it has more than one parent and its distance is
 * unknown.  After running count_distance() first, they will get zero
 * or positive distance.
 */
static struct commit_list *do_find_bisection(struct commit_list *list,
					     int nr, int *weights,
					     int find_all)
{
	int n, counted;
	struct commit_list *p;

	counted = 0;

	for (n = 0, p = list; p; p = p->next) {
		struct commit *commit = p->item;
		unsigned flags = commit->object.flags;

		p->item->util = &weights[n++];
		switch (count_interesting_parents(commit)) {
		case 0:
			if (!(flags & TREESAME)) {
				weight_set(p, 1);
				counted++;
				show_list("bisection 2 count one",
					  counted, nr, list);
			}
			/*
			 * otherwise, it is known not to reach any
			 * tree-changing commit and gets weight 0.
			 */
			break;
		case 1:
			weight_set(p, -1);
			break;
		default:
			weight_set(p, -2);
			break;
		}
	}

	show_list("bisection 2 initialize", counted, nr, list);

	/*
	 * If you have only one parent in the resulting set
	 * then you can reach one commit more than that parent
	 * can reach.  So we do not have to run the expensive
	 * count_distance() for single strand of pearls.
	 *
	 * However, if you have more than one parents, you cannot
	 * just add their distance and one for yourself, since
	 * they usually reach the same ancestor and you would
	 * end up counting them twice that way.
	 *
	 * So we will first count distance of merges the usual
	 * way, and then fill the blanks using cheaper algorithm.
	 */
	for (p = list; p; p = p->next) {
		if (p->item->object.flags & UNINTERESTING)
			continue;
		if (weight(p) != -2)
			continue;
		weight_set(p, count_distance(p));
		clear_distance(list);

		/* Does it happen to be at exactly half-way? */
		if (!find_all && halfway(p, nr))
			return p;
		counted++;
	}

	show_list("bisection 2 count_distance", counted, nr, list);

	while (counted < nr) {
		for (p = list; p; p = p->next) {
			struct commit_list *q;
			unsigned flags = p->item->object.flags;

			if (0 <= weight(p))
				continue;
			for (q = p->item->parents; q; q = q->next) {
				if (q->item->object.flags & UNINTERESTING)
					continue;
				if (0 <= weight(q))
					break;
			}
			if (!q)
				continue;

			/*
			 * weight for p is unknown but q is known.
			 * add one for p itself if p is to be counted,
			 * otherwise inherit it from q directly.
			 */
			if (!(flags & TREESAME)) {
				weight_set(p, weight(q)+1);
				counted++;
				show_list("bisection 2 count one",
					  counted, nr, list);
			}
			else
				weight_set(p, weight(q));

			/* Does it happen to be at exactly half-way? */
			if (!find_all && halfway(p, nr))
				return p;
		}
	}

	show_list("bisection 2 counted all", counted, nr, list);

	if (!find_all)
		return best_bisection(list, nr);
	else
		return best_bisection_sorted(list, nr);
}

struct commit_list *find_bisection(struct commit_list *list,
					  int *reaches, int *all,
					  int find_all)
{
	int nr, on_list;
	struct commit_list *p, *best, *next, *last;
	int *weights;

	show_list("bisection 2 entry", 0, 0, list);

	/*
	 * Count the number of total and tree-changing items on the
	 * list, while reversing the list.
	 */
	for (nr = on_list = 0, last = NULL, p = list;
	     p;
	     p = next) {
		unsigned flags = p->item->object.flags;

		next = p->next;
		if (flags & UNINTERESTING)
			continue;
		p->next = last;
		last = p;
		if (!(flags & TREESAME))
			nr++;
		on_list++;
	}
	list = last;
	show_list("bisection 2 sorted", 0, nr, list);

	*all = nr;
	weights = xcalloc(on_list, sizeof(*weights));

	/* Do the real work of finding bisection commit. */
	best = do_find_bisection(list, nr, weights, find_all);
	if (best) {
		if (!find_all)
			best->next = NULL;
		*reaches = weight(best);
	}
	free(weights);
	return best;
}

405
static int register_ref(const char *refname, const struct object_id *oid,
406 407
			int flags, void *cb_data)
{
408 409 410 411 412
	struct strbuf good_prefix = STRBUF_INIT;
	strbuf_addstr(&good_prefix, term_good);
	strbuf_addstr(&good_prefix, "-");

	if (!strcmp(refname, term_bad)) {
413
		current_bad_oid = xmalloc(sizeof(*current_bad_oid));
414
		oidcpy(current_bad_oid, oid);
415
	} else if (starts_with(refname, good_prefix.buf)) {
416
		sha1_array_append(&good_revs, oid->hash);
417
	} else if (starts_with(refname, "skip-")) {
418
		sha1_array_append(&skipped_revs, oid->hash);
419 420
	}

421 422
	strbuf_release(&good_prefix);

423 424 425 426 427
	return 0;
}

static int read_bisect_refs(void)
{
428
	return for_each_ref_in("refs/bisect/", register_ref, NULL);
429 430
}

431 432 433
static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")

434
static void read_bisect_paths(struct argv_array *array)
435 436
{
	struct strbuf str = STRBUF_INIT;
437
	const char *filename = git_path_bisect_names();
438 439 440
	FILE *fp = fopen(filename, "r");

	if (!fp)
441
		die_errno("Could not open file '%s'", filename);
442 443 444

	while (strbuf_getline(&str, fp, '\n') != EOF) {
		strbuf_trim(&str);
Jeff King's avatar
Jeff King committed
445
		if (sq_dequote_to_argv_array(str.buf, array))
446
			die("Badly quoted content in file '%s': %s",
Jeff King's avatar
Jeff King committed
447
			    filename, str.buf);
448 449 450 451 452 453
	}

	strbuf_release(&str);
	fclose(fp);
}

454 455 456 457 458
static char *join_sha1_array_hex(struct sha1_array *array, char delim)
{
	struct strbuf joined_hexs = STRBUF_INIT;
	int i;

459
	for (i = 0; i < array->nr; i++) {
460
		strbuf_addstr(&joined_hexs, sha1_to_hex(array->sha1[i]));
461
		if (i + 1 < array->nr)
462 463 464 465 466 467
			strbuf_addch(&joined_hexs, delim);
	}

	return strbuf_detach(&joined_hexs, NULL);
}

468 469 470 471 472 473 474 475 476 477 478 479 480
/*
 * In this function, passing a not NULL skipped_first is very special.
 * It means that we want to know if the first commit in the list is
 * skipped because we will want to test a commit away from it if it is
 * indeed skipped.
 * So if the first commit is skipped, we cannot take the shortcut to
 * just "return list" when we find the first non skipped commit, we
 * have to return a fully filtered list.
 *
 * We use (*skipped_first == -1) to mean "it has been found that the
 * first commit is not skipped". In this case *skipped_first is set back
 * to 0 just before the function returns.
 */
481 482
struct commit_list *filter_skipped(struct commit_list *list,
				   struct commit_list **tried,
483 484 485
				   int show_all,
				   int *count,
				   int *skipped_first)
486 487 488 489 490
{
	struct commit_list *filtered = NULL, **f = &filtered;

	*tried = NULL;

491 492 493 494 495
	if (skipped_first)
		*skipped_first = 0;
	if (count)
		*count = 0;

496
	if (!skipped_revs.nr)
497 498 499 500 501
		return list;

	while (list) {
		struct commit_list *next = list->next;
		list->next = NULL;
502
		if (0 <= sha1_array_lookup(&skipped_revs,
503
					   get_object_hash(list->item->object))) {
504 505
			if (skipped_first && !*skipped_first)
				*skipped_first = 1;
506 507 508 509
			/* Move current to tried list */
			*tried = list;
			tried = &list->next;
		} else {
510 511 512 513 514 515 516
			if (!show_all) {
				if (!skipped_first || !*skipped_first)
					return list;
			} else if (skipped_first && !*skipped_first) {
				/* This means we know it's not skipped */
				*skipped_first = -1;
			}
517 518 519
			/* Move current to filtered list */
			*f = list;
			f = &list->next;
520 521
			if (count)
				(*count)++;
522 523 524 525
		}
		list = next;
	}

526 527 528
	if (skipped_first && *skipped_first == -1)
		*skipped_first = 0;

529 530
	return filtered;
}
531

532 533 534 535 536 537 538 539
#define PRN_MODULO 32768

/*
 * This is a pseudo random number generator based on "man 3 rand".
 * It is not used properly because the seed is the argument and it
 * is increased by one between each call, but that should not matter
 * for this application.
 */
540
static unsigned get_prn(unsigned count) {
541
	count = count * 1103515245 + 12345;
542
	return (count/65536) % PRN_MODULO;
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
}

/*
 * Custom integer square root from
 * http://en.wikipedia.org/wiki/Integer_square_root
 */
static int sqrti(int val)
{
	float d, x = val;

	if (val == 0)
		return 0;

	do {
		float y = (x + (float)val / x) / 2;
		d = (y > x) ? y - x : x - y;
		x = y;
	} while (d >= 0.5);

	return (int)x;
}

static struct commit_list *skip_away(struct commit_list *list, int count)
566 567
{
	struct commit_list *cur, *previous;
568 569 570 571
	int prn, index, i;

	prn = get_prn(count);
	index = (count * prn / PRN_MODULO) * sqrti(prn) / sqrti(PRN_MODULO);
572 573 574 575 576 577

	cur = list;
	previous = NULL;

	for (i = 0; cur; cur = cur->next, i++) {
		if (i == index) {
578
			if (hashcmp(cur->item->object.sha1, current_bad_oid->hash))
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
				return cur;
			if (previous)
				return previous;
			return list;
		}
		previous = cur;
	}

	return list;
}

static struct commit_list *managed_skipped(struct commit_list *list,
					   struct commit_list **tried)
{
	int count, skipped_first;

	*tried = NULL;

597
	if (!skipped_revs.nr)
598 599 600 601 602 603 604
		return list;

	list = filter_skipped(list, tried, 0, &count, &skipped_first);

	if (!skipped_first)
		return list;

605
	return skip_away(list, count);
606 607
}

608 609 610
static void bisect_rev_setup(struct rev_info *revs, const char *prefix,
			     const char *bad_format, const char *good_format,
			     int read_paths)
611
{
Jeff King's avatar
Jeff King committed
612
	struct argv_array rev_argv = ARGV_ARRAY_INIT;
613 614
	int i;

615 616 617
	init_revisions(revs, prefix);
	revs->abbrev = 0;
	revs->commit_format = CMIT_FMT_UNSPECIFIED;
618

619
	/* rev_argv.argv[0] will be ignored by setup_revisions */
Jeff King's avatar
Jeff King committed
620
	argv_array_push(&rev_argv, "bisect_rev_setup");
621
	argv_array_pushf(&rev_argv, bad_format, oid_to_hex(current_bad_oid));
622
	for (i = 0; i < good_revs.nr; i++)
Jeff King's avatar
Jeff King committed
623 624 625
		argv_array_pushf(&rev_argv, good_format,
				 sha1_to_hex(good_revs.sha1[i]));
	argv_array_push(&rev_argv, "--");
626 627
	if (read_paths)
		read_bisect_paths(&rev_argv);
628

Jeff King's avatar
Jeff King committed
629 630
	setup_revisions(rev_argv.argc, rev_argv.argv, revs, NULL);
	/* XXX leak rev_argv, as "revs" may still be pointing to it */
631 632
}

633
static void bisect_common(struct rev_info *revs)
634 635 636 637
{
	if (prepare_revision_walk(revs))
		die("revision walk setup failed");
	if (revs->tree_objects)
638
		mark_edges_uninteresting(revs, NULL);
639 640
}

641
static void exit_if_skipped_commits(struct commit_list *tried,
642
				    const struct object_id *bad)
643 644 645 646 647
{
	if (!tried)
		return;

	printf("There are only 'skip'ped commits left to test.\n"
648
	       "The first %s commit could be any of:\n", term_bad);
649 650
	print_commit_list(tried, "%s\n", "%s\n");
	if (bad)
651
		printf("%s\n", oid_to_hex(bad));
652 653 654 655
	printf("We cannot bisect more!\n");
	exit(2);
}

656
static int is_expected_rev(const struct object_id *oid)
657
{
658
	const char *filename = git_path_bisect_expected_rev();
659 660 661 662 663 664 665 666 667 668 669 670 671
	struct stat st;
	struct strbuf str = STRBUF_INIT;
	FILE *fp;
	int res = 0;

	if (stat(filename, &st) || !S_ISREG(st.st_mode))
		return 0;

	fp = fopen(filename, "r");
	if (!fp)
		return 0;

	if (strbuf_getline(&str, fp, '\n') != EOF)
672
		res = !strcmp(str.buf, oid_to_hex(oid));
673 674 675 676 677 678 679

	strbuf_release(&str);
	fclose(fp);

	return res;
}

David Turner's avatar
David Turner committed
680
static int bisect_checkout(const unsigned char *bisect_rev, int no_checkout)
681
{
David Turner's avatar
David Turner committed
682
	char bisect_rev_hex[GIT_SHA1_HEXSZ + 1];
683

David Turner's avatar
David Turner committed
684 685
	memcpy(bisect_rev_hex, sha1_to_hex(bisect_rev), GIT_SHA1_HEXSZ + 1);
	update_ref(NULL, "BISECT_EXPECTED_REV", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
686 687

	argv_checkout[2] = bisect_rev_hex;
688
	if (no_checkout) {
David Turner's avatar
David Turner committed
689
		update_ref(NULL, "BISECT_HEAD", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
690
	} else {
691
		int res;
692 693 694 695
		res = run_command_v_opt(argv_checkout, RUN_GIT_CMD);
		if (res)
			exit(res);
	}
696 697 698 699 700

	argv_show_branch[1] = bisect_rev_hex;
	return run_command_v_opt(argv_show_branch, RUN_GIT_CMD);
}

701 702 703 704 705 706 707 708 709 710
static struct commit *get_commit_reference(const unsigned char *sha1)
{
	struct commit *r = lookup_commit_reference(sha1);
	if (!r)
		die("Not a valid commit name %s", sha1_to_hex(sha1));
	return r;
}

static struct commit **get_bad_and_good_commits(int *rev_nr)
{
711
	int len = 1 + good_revs.nr;
712 713 714
	struct commit **rev = xmalloc(len * sizeof(*rev));
	int i, n = 0;

715
	rev[n++] = get_commit_reference(current_bad_oid->hash);
716
	for (i = 0; i < good_revs.nr; i++)
717 718 719 720 721 722 723 724
		rev[n++] = get_commit_reference(good_revs.sha1[i]);
	*rev_nr = n;

	return rev;
}

static void handle_bad_merge_base(void)
{
725 726
	if (is_expected_rev(current_bad_oid)) {
		char *bad_hex = oid_to_hex(current_bad_oid);
727
		char *good_hex = join_sha1_array_hex(&good_revs, ' ');
728 729 730 731 732
		if (!strcmp(term_bad, "bad") && !strcmp(term_good, "good")) {
			fprintf(stderr, "The merge base %s is bad.\n"
				"This means the bug has been fixed "
				"between %s and [%s].\n",
				bad_hex, bad_hex, good_hex);
733 734 735 736 737
		} else if (!strcmp(term_bad, "new") && !strcmp(term_good, "old")) {
			fprintf(stderr, "The merge base %s is new.\n"
				"The property has changed "
				"between %s and [%s].\n",
				bad_hex, bad_hex, good_hex);
738 739 740 741 742 743
		} else {
			fprintf(stderr, "The merge base %s is %s.\n"
				"This means the first '%s' commit is "
				"between %s and [%s].\n",
				bad_hex, term_bad, term_good, bad_hex, good_hex);
		}
744 745 746
		exit(3);
	}

747
	fprintf(stderr, "Some %s revs are not ancestor of the %s rev.\n"
748
		"git bisect cannot work properly in this case.\n"
749 750
		"Maybe you mistook %s and %s revs?\n",
		term_good, term_bad, term_good, term_bad);
751 752 753
	exit(1);
}

754
static void handle_skipped_merge_base(const unsigned char *mb)
755 756
{
	char *mb_hex = sha1_to_hex(mb);
757
	char *bad_hex = sha1_to_hex(current_bad_oid->hash);
758 759
	char *good_hex = join_sha1_array_hex(&good_revs, ' ');

760
	warning("the merge base between %s and [%s] "
761
		"must be skipped.\n"
762
		"So we cannot be sure the first %s commit is "
763
		"between %s and %s.\n"
764
		"We continue anyway.",
765
		bad_hex, good_hex, term_bad, mb_hex, bad_hex);
766 767 768 769
	free(good_hex);
}

/*
770
 * "check_merge_bases" checks that merge bases are not "bad" (or "new").
771
 *
772
 * - If one is "bad" (or "new"), it means the user assumed something wrong
773
 * and we must exit with a non 0 error code.
774
 * - If one is "good" (or "old"), that's good, we have nothing to do.
775 776 777
 * - If one is "skipped", we can't know but we should warn.
 * - If we don't know, we should check it out and ask the user to test.
 */
778
static void check_merge_bases(int no_checkout)
779 780 781 782 783
{
	struct commit_list *result;
	int rev_nr;
	struct commit **rev = get_bad_and_good_commits(&rev_nr);

784
	result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1);
785 786

	for (; result; result = result->next) {
787
		const unsigned char *mb = get_object_hash(result->item->object);
788
		if (!hashcmp(mb, current_bad_oid->hash)) {
789
			handle_bad_merge_base();
790
		} else if (0 <= sha1_array_lookup(&good_revs, mb)) {
791
			continue;
792
		} else if (0 <= sha1_array_lookup(&skipped_revs, mb)) {
793 794 795
			handle_skipped_merge_base(mb);
		} else {
			printf("Bisecting: a merge base must be tested\n");
David Turner's avatar
David Turner committed
796
			exit(bisect_checkout(mb, no_checkout));
797 798 799 800 801 802 803
		}
	}

	free(rev);
	free_commit_list(result);
}

804
static int check_ancestors(const char *prefix)
805
{
806 807
	struct rev_info revs;
	struct object_array pending_copy;
808
	int res;
809

810
	bisect_rev_setup(&revs, prefix, "^%s", "%s", 0);
811

812
	/* Save pending objects, so they can be cleaned up later. */
813 814
	pending_copy = revs.pending;
	revs.leak_pending = 1;
815

816 817 818 819 820
	/*
	 * bisect_common calls prepare_revision_walk right away, which
	 * (together with .leak_pending = 1) makes us the sole owner of
	 * the list of pending objects.
	 */
821 822 823 824
	bisect_common(&revs);
	res = (revs.commits != NULL);

	/* Clean up objects used, as they will be reused. */
825
	clear_commit_marks_for_object_array(&pending_copy, ALL_REV_FLAGS);
826
	free(pending_copy.objects);
827

828
	return res;
829 830 831 832 833 834 835 836 837 838
}

/*
 * "check_good_are_ancestors_of_bad" checks that all "good" revs are
 * ancestor of the "bad" rev.
 *
 * If that's not the case, we need to check the merge bases.
 * If a merge base must be tested by the user, its source code will be
 * checked out to be tested by the user and we will exit.
 */
839
static void check_good_are_ancestors_of_bad(const char *prefix, int no_checkout)
840
{
841
	char *filename = git_pathdup("BISECT_ANCESTORS_OK");
842 843 844
	struct stat st;
	int fd;

845
	if (!current_bad_oid)
846
		die("a %s revision is needed", term_bad);
847 848 849

	/* Check if file BISECT_ANCESTORS_OK exists. */
	if (!stat(filename, &st) && S_ISREG(st.st_mode))
850
		goto done;
851 852

	/* Bisecting with no good rev is ok. */
853
	if (good_revs.nr == 0)
854
		goto done;
855

856 857
	/* Check if all good revs are ancestor of the bad rev. */
	if (check_ancestors(prefix))
858
		check_merge_bases(no_checkout);
859 860 861 862 863 864 865 866

	/* Create file BISECT_ANCESTORS_OK. */
	fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
	if (fd < 0)
		warning("could not create file '%s': %s",
			filename, strerror(errno));
	else
		close(fd);
867 868
 done:
	free(filename);
869 870
}

871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
/*
 * This does "git diff-tree --pretty COMMIT" without one fork+exec.
 */
static void show_diff_tree(const char *prefix, struct commit *commit)
{
	struct rev_info opt;

	/* diff-tree init */
	init_revisions(&opt, prefix);
	git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
	opt.abbrev = 0;
	opt.diff = 1;

	/* This is what "--pretty" does */
	opt.verbose_header = 1;
	opt.use_terminator = 0;
	opt.commit_format = CMIT_FMT_DEFAULT;

	/* diff-tree init */
	if (!opt.diffopt.output_format)
		opt.diffopt.output_format = DIFF_FORMAT_RAW;

	log_tree_commit(&opt, commit);
}

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
/*
 * The terms used for this bisect session are stored in BISECT_TERMS.
 * We read them and store them to adapt the messages accordingly.
 * Default is bad/good.
 */
void read_bisect_terms(const char **read_bad, const char **read_good)
{
	struct strbuf str = STRBUF_INIT;
	const char *filename = git_path("BISECT_TERMS");
	FILE *fp = fopen(filename, "r");

	if (!fp) {
		if (errno == ENOENT) {
			*read_bad = "bad";
			*read_good = "good";
			return;
		} else {
			die("could not read file '%s': %s", filename,
				strerror(errno));
		}
	} else {
		strbuf_getline(&str, fp, '\n');
		*read_bad = strbuf_detach(&str, NULL);
		strbuf_getline(&str, fp, '\n');
		*read_good = strbuf_detach(&str, NULL);
	}
	strbuf_release(&str);
	fclose(fp);
}

926 927 928 929
/*
 * We use the convention that exiting with an exit code 10 means that
 * the bisection process finished successfully.
 * In this case the calling shell script should exit 0.
930 931 932
 *
 * If no_checkout is non-zero, the bisection process does not
 * checkout the trial commit but instead simply updates BISECT_HEAD.
933
 */
934
int bisect_next_all(const char *prefix, int no_checkout)
935 936 937
{
	struct rev_info revs;
	struct commit_list *tried;
938
	int reaches = 0, all = 0, nr, steps;
939 940
	const unsigned char *bisect_rev;

941
	read_bisect_terms(&term_bad, &term_good);
942 943 944
	if (read_bisect_refs())
		die("reading bisect refs failed");

945
	check_good_are_ancestors_of_bad(prefix, no_checkout);
946

947 948
	bisect_rev_setup(&revs, prefix, "%s", "^%s", 1);
	revs.limited = 1;
949

950
	bisect_common(&revs);
951

952
	revs.commits = find_bisection(revs.commits, &reaches, &all,
953
				       !!skipped_revs.nr);
954
	revs.commits = managed_skipped(revs.commits, &tried);
955 956 957 958 959 960 961 962

	if (!revs.commits) {
		/*
		 * We should exit here only if the "bad"
		 * commit is also a "skip" commit.
		 */
		exit_if_skipped_commits(tried, NULL);

963 964 965 966
		printf("%s was both %s and %s\n",
		       oid_to_hex(current_bad_oid),
		       term_good,
		       term_bad);
967 968 969
		exit(1);
	}

970 971 972 973 974 975
	if (!all) {
		fprintf(stderr, "No testable commit found.\n"
			"Maybe you started with bad path parameters?\n");
		exit(4);
	}

976
	bisect_rev = get_object_hash(revs.commits->item->object);
977

978 979
	if (!hashcmp(bisect_rev, current_bad_oid->hash)) {
		exit_if_skipped_commits(tried, current_bad_oid);
980
		printf("%s is the first %s commit\n", sha1_to_hex(bisect_rev),
981
			term_bad);
982
		show_diff_tree(prefix, revs.commits->item);
983 984 985 986 987
		/* This means the bisection process succeeded. */
		exit(10);
	}

	nr = all - reaches - 1;
988 989 990 991
	steps = estimate_bisect_steps(all);
	printf("Bisecting: %d revision%s left to test after this "
	       "(roughly %d step%s)\n", nr, (nr == 1 ? "" : "s"),
	       steps, (steps == 1 ? "" : "s"));
992

David Turner's avatar
David Turner committed
993
	return bisect_checkout(bisect_rev, no_checkout);
994 995
}

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
static inline int log2i(int n)
{
	int log2 = 0;

	for (; n > 1; n >>= 1)
		log2++;

	return log2;
}

static inline int exp2i(int n)
{
	return 1 << n;
}

/*
 * Estimate the number of bisect steps left (after the current step)
 *
 * For any x between 0 included and 2^n excluded, the probability for
 * n - 1 steps left looks like:
 *
 * P(2^n + x) == (2^n - x) / (2^n + x)
 *
 * and P(2^n + x) < 0.5 means 2^n < 3x
 */
int estimate_bisect_steps(int all)
{
	int n, x, e;

	if (all < 3)
		return 0;

	n = log2i(all);
	e = exp2i(n);
	x = all - e;

	return (e < 3 * x) ? n : n - 1;
}