1#!/bin/sh 2 3USAGE='[help|start|bad|good|skip|next|reset|visualize|replay|log|run]' 4LONG_USAGE='git bisect help 5 print this long help message. 6git bisect start [<bad> [<good>...]] [--] [<pathspec>...] 7 reset bisect state and start bisection. 8git bisect bad [<rev>] 9 mark <rev> a known-bad revision. 10git bisect good [<rev>...] 11 mark <rev>... known-good revisions. 12git bisect skip [(<rev>|<range>)...] 13 mark <rev>... untestable revisions. 14git bisect next 15 find next bisection to test and check it out. 16git bisect reset [<branch>] 17 finish bisection search and go back to branch. 18git bisect visualize 19 show bisect status in gitk. 20git bisect replay <logfile> 21 replay bisection log. 22git bisect log 23 show bisect log. 24git bisect run <cmd>... 25 use <cmd>... to automatically bisect. 26 27Please use "git help bisect" to get the full man page.' 28 29OPTIONS_SPEC= 30. git-sh-setup 31require_work_tree 32 33_x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]' 34_x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40" 35 36sq() { 37 @@PERL@@ -e' 38 for (@ARGV) { 39 s/'\''/'\'\\\\\'\''/g; 40 print " '\''$_'\''"; 41 } 42 print "\n"; 43 '"$@" 44} 45 46bisect_autostart() { 47test -s"$GIT_DIR/BISECT_START"|| { 48echo>&2'You need to start by "git bisect start"' 49iftest -t0 50then 51echo>&2-n'Do you want me to do it for you [Y/n]? ' 52read yesno 53case"$yesno"in 54[Nn]*) 55exit;; 56esac 57 bisect_start 58else 59exit1 60fi 61} 62} 63 64bisect_start() { 65# 66# Verify HEAD. 67# 68head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD)|| 69head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD)|| 70 die "Bad HEAD - I need a HEAD" 71 72# 73# Check if we are bisecting. 74# 75 start_head='' 76iftest -s"$GIT_DIR/BISECT_START" 77then 78# Reset to the rev from where we started. 79 start_head=$(cat "$GIT_DIR/BISECT_START") 80 git checkout "$start_head"||exit 81else 82# Get rev from where we start. 83case"$head"in 84 refs/heads/*|$_x40) 85# This error message should only be triggered by 86# cogito usage, and cogito users should understand 87# it relates to cg-seek. 88[-s"$GIT_DIR/head-name"] && 89 die "won't bisect on seeked tree" 90 start_head="${head#refs/heads/}" 91;; 92*) 93 die "Bad HEAD - strange symbolic ref" 94;; 95esac 96fi 97 98# 99# Get rid of any old bisect state. 100# 101 bisect_clean_state ||exit 102 103# 104# Check for one bad and then some good revisions. 105# 106 has_double_dash=0 107for arg;do 108case"$arg"in--) has_double_dash=1;break;;esac 109done 110 orig_args=$(sq "$@") 111 bad_seen=0 112eval='' 113while[$#-gt0];do 114 arg="$1" 115case"$arg"in 116--) 117shift 118break 119;; 120*) 121rev=$(git rev-parse -q --verify "$arg^{commit}")|| { 122test$has_double_dash-eq1&& 123 die "'$arg' does not appear to be a valid revision" 124break 125} 126case$bad_seenin 1270) state='bad'; bad_seen=1;; 128*) state='good';; 129esac 130eval="$evalbisect_write '$state' '$rev' 'nolog'; " 131shift 132;; 133esac 134done 135 136# 137# Change state. 138# In case of mistaken revs or checkout error, or signals received, 139# "bisect_auto_next" below may exit or misbehave. 140# We have to trap this to be able to clean up using 141# "bisect_clean_state". 142# 143trap'bisect_clean_state'0 144trap'exit 255'1 2 3 15 145 146# 147# Write new start state. 148# 149echo"$start_head">"$GIT_DIR/BISECT_START"&& 150sq"$@">"$GIT_DIR/BISECT_NAMES"&& 151eval"$eval"&& 152echo"git bisect start$orig_args">>"$GIT_DIR/BISECT_LOG"||exit 153# 154# Check if we can proceed to the next bisect state. 155# 156 bisect_auto_next 157 158trap'-'0 159} 160 161bisect_write() { 162 state="$1" 163rev="$2" 164 nolog="$3" 165case"$state"in 166 bad) tag="$state";; 167 good|skip) tag="$state"-"$rev";; 168*) die "Bad bisect_write argument:$state";; 169esac 170 git update-ref"refs/bisect/$tag""$rev"||exit 171echo"#$state:$(git show-branch $rev)">>"$GIT_DIR/BISECT_LOG" 172test -n"$nolog"||echo"git bisect$state$rev">>"$GIT_DIR/BISECT_LOG" 173} 174 175is_expected_rev() { 176test -f"$GIT_DIR/BISECT_EXPECTED_REV"&& 177test"$1"=$(cat "$GIT_DIR/BISECT_EXPECTED_REV") 178} 179 180mark_expected_rev() { 181echo"$1">"$GIT_DIR/BISECT_EXPECTED_REV" 182} 183 184check_expected_revs() { 185for _rev in"$@";do 186if! is_expected_rev "$_rev";then 187rm-f"$GIT_DIR/BISECT_ANCESTORS_OK" 188rm-f"$GIT_DIR/BISECT_EXPECTED_REV" 189return 190fi 191done 192} 193 194bisect_skip() { 195 all='' 196for arg in"$@" 197do 198case"$arg"in 199*..*) 200 revs=$(git rev-list "$arg")|| die "Bad rev input:$arg";; 201*) 202 revs=$(sq "$arg");; 203esac 204 all="$all$revs" 205done 206eval bisect_state 'skip'$all 207} 208 209bisect_state() { 210 bisect_autostart 211 state=$1 212case"$#,$state"in 2130,*) 214 die "Please call 'bisect_state' with at least one argument.";; 2151,bad|1,good|1,skip) 216rev=$(git rev-parse --verify HEAD)|| 217 die "Bad rev input: HEAD" 218 bisect_write "$state""$rev" 219 check_expected_revs "$rev";; 2202,bad|*,good|*,skip) 221shift 222eval='' 223forrevin"$@" 224do 225 sha=$(git rev-parse --verify "$rev^{commit}")|| 226 die "Bad rev input:$rev" 227eval="$evalbisect_write '$state' '$sha'; " 228done 229eval"$eval" 230 check_expected_revs "$@";; 231*,bad) 232 die "'git bisect bad' can take only one argument.";; 233*) 234 usage ;; 235esac 236 bisect_auto_next 237} 238 239bisect_next_check() { 240 missing_good= missing_bad= 241 git show-ref -q --verify refs/bisect/bad || missing_bad=t 242test -n"$(git for-each-ref "refs/bisect/good-*")"|| missing_good=t 243 244case"$missing_good,$missing_bad,$1"in 245,,*) 246: have both good and bad - ok 247;; 248*,) 249# do not have both but not asked to fail - just report. 250 false 251;; 252 t,,good) 253# have bad but not good. we could bisect although 254# this is less optimum. 255echo>&2'Warning: bisecting only with a bad commit.' 256iftest -t0 257then 258printf>&2'Are you sure [Y/n]? ' 259read yesno 260case"$yesno"in[Nn]*)exit1;;esac 261fi 262: bisect without good... 263;; 264*) 265 THEN='' 266test -s"$GIT_DIR/BISECT_START"|| { 267echo>&2'You need to start by "git bisect start".' 268 THEN='then ' 269} 270echo>&2'You '$THEN'need to give me at least one good' \ 271'and one bad revisions.' 272echo>&2'(You can use "git bisect bad" and' \ 273'"git bisect good" for that.)' 274exit1;; 275esac 276} 277 278bisect_auto_next() { 279 bisect_next_check && bisect_next || : 280} 281 282filter_skipped() { 283 _eval="$1" 284 _skip="$2" 285 286if[-z"$_skip"];then 287eval"$_eval"| { 288whileread line 289do 290echo"$line&&" 291done 292echo':' 293} 294return 295fi 296 297# Let's parse the output of: 298# "git rev-list --bisect-vars --bisect-all ..." 299eval"$_eval"| { 300 VARS= FOUND= TRIED= 301whileread hash line 302do 303case"$VARS,$FOUND,$TRIED,$hash"in 3041,*,*,*) 305# "bisect_foo=bar" read from rev-list output. 306echo"$hash&&" 307;; 308,*,*,---*) 309# Separator 310;; 311,,,bisect_rev*) 312# We had nothing to search. 313echo"bisect_rev= &&" 314 VARS=1 315;; 316,,*,bisect_rev*) 317# We did not find a good bisect rev. 318# This should happen only if the "bad" 319# commit is also a "skip" commit. 320echo"bisect_rev='$TRIED' &&" 321 VARS=1 322;; 323,,*,*) 324# We are searching. 325 TRIED="${TRIED:+$TRIED|}$hash" 326case"$_skip"in 327*$hash*) ;; 328*) 329echo"bisect_rev=$hash&&" 330echo"bisect_tried='$TRIED' &&" 331 FOUND=1 332;; 333esac 334;; 335,1,*,bisect_rev*) 336# We have already found a rev to be tested. 337 VARS=1 338;; 339,1,*,*) 340;; 341*) 342# Unexpected input 343echo"die 'filter_skipped error'" 344 die "filter_skipped error " \ 345"VARS: '$VARS' " \ 346"FOUND: '$FOUND' " \ 347"TRIED: '$TRIED' " \ 348"hash: '$hash' " \ 349"line: '$line'" 350;; 351esac 352done 353echo':' 354} 355} 356 357exit_if_skipped_commits () { 358 _tried=$1 359ifexpr"$_tried":".*[|].*"> /dev/null ;then 360echo"There are only 'skip'ped commit left to test." 361echo"The first bad commit could be any of:" 362echo"$_tried"|tr'[|]''[\012]' 363echo"We cannot bisect more!" 364exit2 365fi 366} 367 368bisect_checkout() { 369 _rev="$1" 370 _msg="$2" 371echo"Bisecting:$_msg" 372 mark_expected_rev "$_rev" 373 git checkout -q"$_rev"||exit 374 git show-branch"$_rev" 375} 376 377is_among() { 378 _rev="$1" 379 _list="$2" 380case"$_list"in*$_rev*)return0;;esac 381return1 382} 383 384handle_bad_merge_base() { 385 _badmb="$1" 386 _good="$2" 387if is_expected_rev "$_badmb";then 388cat>&2<<EOF 389The merge base$_badmbis bad. 390This means the bug has been fixed between$_badmband [$_good]. 391EOF 392exit3 393else 394cat>&2<<EOF 395Some good revs are not ancestor of the bad rev. 396git bisect cannot work properly in this case. 397Maybe you mistake good and bad revs? 398EOF 399exit1 400fi 401} 402 403handle_skipped_merge_base() { 404 _mb="$1" 405 _bad="$2" 406 _good="$3" 407cat>&2<<EOF 408Warning: the merge base between$_badand [$_good] must be skipped. 409So we cannot be sure the first bad commit is between$_mband$_bad. 410We continue anyway. 411EOF 412} 413 414# 415# "check_merge_bases" checks that merge bases are not "bad". 416# 417# - If one is "good", that's good, we have nothing to do. 418# - If one is "bad", it means the user assumed something wrong 419# and we must exit. 420# - If one is "skipped", we can't know but we should warn. 421# - If we don't know, we should check it out and ask the user to test. 422# 423# In the last case we will return 1, and otherwise 0. 424# 425check_merge_bases() { 426 _bad="$1" 427 _good="$2" 428 _skip="$3" 429for _mb in$(git merge-base --all $_bad $_good) 430do 431if is_among "$_mb""$_good";then 432continue 433eliftest"$_mb"="$_bad";then 434 handle_bad_merge_base "$_bad""$_good" 435elif is_among "$_mb""$_skip";then 436 handle_skipped_merge_base "$_mb""$_bad""$_good" 437else 438 bisect_checkout "$_mb""a merge base must be tested" 439return1 440fi 441done 442return0 443} 444 445# 446# "check_good_are_ancestors_of_bad" checks that all "good" revs are 447# ancestor of the "bad" rev. 448# 449# If that's not the case, we need to check the merge bases. 450# If a merge base must be tested by the user we return 1 and 451# otherwise 0. 452# 453check_good_are_ancestors_of_bad() { 454test -f"$GIT_DIR/BISECT_ANCESTORS_OK"&& 455return 456 457 _bad="$1" 458 _good=$(echo $2 | sed -e 's/\^//g') 459 _skip="$3" 460 461# Bisecting with no good rev is ok 462test -z"$_good"&&return 463 464 _side=$(git rev-list $_good ^$_bad) 465iftest -n"$_side";then 466# Return if a checkout was done 467 check_merge_bases "$_bad""$_good""$_skip"||return 468fi 469 470: >"$GIT_DIR/BISECT_ANCESTORS_OK" 471 472return0 473} 474 475bisect_next() { 476case"$#"in0) ;; *) usage ;;esac 477 bisect_autostart 478 bisect_next_check good 479 480# Get bad, good and skipped revs 481 bad=$(git rev-parse --verify refs/bisect/bad)&& 482 good=$(git for-each-ref --format='^%(objectname)' \ 483 "refs/bisect/good-*" | tr '\012' '') && 484 skip=$(git for-each-ref --format='%(objectname)' \ 485"refs/bisect/skip-*"|tr'\012'' ') ||exit 486 487# Maybe some merge bases must be tested first 488 check_good_are_ancestors_of_bad "$bad""$good""$skip" 489# Return now if a checkout has already been done 490test"$?"-eq"1"&&return 491 492# Get bisection information 493 BISECT_OPT='' 494test -n"$skip"&& BISECT_OPT='--bisect-all' 495eval="git rev-list --bisect-vars$BISECT_OPT$good$bad--"&& 496eval="$eval$(cat "$GIT_DIR/BISECT_NAMES")"&& 497eval=$(filter_skipped "$eval" "$skip")&& 498eval"$eval"||exit 499 500if[-z"$bisect_rev"];then 501echo"$badwas both good and bad" 502exit1 503fi 504if["$bisect_rev"="$bad"];then 505 exit_if_skipped_commits "$bisect_tried" 506echo"$bisect_revis first bad commit" 507 git diff-tree --pretty$bisect_rev 508exit0 509fi 510 511# We should exit here only if the "bad" 512# commit is also a "skip" commit (see above). 513 exit_if_skipped_commits "$bisect_rev" 514 515 bisect_checkout "$bisect_rev""$bisect_nrrevisions left to test after this" 516} 517 518bisect_visualize() { 519 bisect_next_check fail 520 521iftest$#=0 522then 523case"${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}"in 524'')set git log ;; 525set*)set gitk ;; 526esac 527else 528case"$1"in 529 git*|tig) ;; 530-*)set git log "$@";; 531*)set git "$@";; 532esac 533fi 534 535 not=$(git for-each-ref --format='%(refname)' "refs/bisect/good-*") 536 eval '"$@"' refs/bisect/bad --not$not--$(cat "$GIT_DIR/BISECT_NAMES") 537} 538 539bisect_reset() { 540 test -s "$GIT_DIR/BISECT_START" || { 541 echo "We are not bisecting." 542 return 543 } 544 case "$#" in 545 0) branch=$(cat "$GIT_DIR/BISECT_START");; 546 1) git show-ref --verify --quiet -- "refs/heads/$1" || 547 die "$1does not seem to be a valid branch" 548 branch="$1" ;; 549 *) 550 usage ;; 551 esac 552 git checkout "$branch" && bisect_clean_state 553} 554 555bisect_clean_state() { 556 # There may be some refs packed during bisection. 557 git for-each-ref --format='%(refname) %(objectname)' refs/bisect/\* | 558 while read ref hash 559 do 560 git update-ref -d$ref$hash|| exit 561 done 562 rm -f "$GIT_DIR/BISECT_EXPECTED_REV" && 563 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" && 564 rm -f "$GIT_DIR/BISECT_LOG" && 565 rm -f "$GIT_DIR/BISECT_NAMES" && 566 rm -f "$GIT_DIR/BISECT_RUN" && 567 # Cleanup head-name if it got left by an old version of git-bisect 568 rm -f "$GIT_DIR/head-name" && 569 570 rm -f "$GIT_DIR/BISECT_START" 571} 572 573bisect_replay () { 574 test -r "$1" || die "cannot read$1for replaying" 575 bisect_reset 576 while read git bisect command rev 577 do 578 test "$git$bisect" = "git bisect" -o "$git" = "git-bisect" || continue 579 if test "$git" = "git-bisect"; then 580 rev="$command" 581 command="$bisect" 582 fi 583 case "$command" in 584 start) 585 cmd="bisect_start$rev" 586 eval "$cmd" ;; 587 good|bad|skip) 588 bisect_write "$command" "$rev" ;; 589 *) 590 die "?? what are you talking about?" ;; 591 esac 592 done <"$1" 593 bisect_auto_next 594} 595 596bisect_run () { 597 bisect_next_check fail 598 599 while true 600 do 601 echo "running $@" 602 "$@" 603 res=$? 604 605 # Check for really bad run error. 606 if [$res-lt 0 -o$res-ge 128 ]; then 607 echo >&2 "bisect run failed:" 608 echo >&2 "exit code$resfrom '$@' is < 0 or >= 128" 609 exit$res 610 fi 611 612 # Find current state depending on run success or failure. 613 # A special exit code of 125 means cannot test. 614 if [$res-eq 125 ]; then 615 state='skip' 616 elif [$res-gt 0 ]; then 617 state='bad' 618 else 619 state='good' 620 fi 621 622 # We have to use a subshell because "bisect_state" can exit. 623 ( bisect_state$state> "$GIT_DIR/BISECT_RUN" ) 624 res=$? 625 626 cat "$GIT_DIR/BISECT_RUN" 627 628 if grep "first bad commit could be any of" "$GIT_DIR/BISECT_RUN" \ 629 > /dev/null; then 630 echo >&2 "bisect run cannot continue any more" 631 exit$res 632 fi 633 634 if [$res-ne 0 ]; then 635 echo >&2 "bisect run failed:" 636 echo >&2 "'bisect_state $state' exited with error code$res" 637 exit$res 638 fi 639 640 if grep "is first bad commit" "$GIT_DIR/BISECT_RUN" > /dev/null; then 641 echo "bisect run success" 642 exit 0; 643 fi 644 645 done 646} 647 648 649case "$#" in 6500) 651 usage ;; 652*) 653 cmd="$1" 654 shift 655 case "$cmd" in 656 help) 657 git bisect -h ;; 658 start) 659 bisect_start "$@" ;; 660 bad|good) 661 bisect_state "$cmd" "$@" ;; 662 skip) 663 bisect_skip "$@" ;; 664 next) 665 # Not sure we want "next" at the UI level anymore. 666 bisect_next "$@" ;; 667 visualize|view) 668 bisect_visualize "$@" ;; 669 reset) 670 bisect_reset "$@" ;; 671 replay) 672 bisect_replay "$@" ;; 673 log) 674 cat "$GIT_DIR/BISECT_LOG" ;; 675 run) 676 bisect_run "$@" ;; 677 *) 678 usage ;; 679 esac 680esac