git-bisect.sh

   1 #!/bin/sh
   2
   3 USAGE='[help|start|bad|good|skip|next|reset|visualize|replay|log|run]'
   4 LONG_USAGE='git bisect help
   5         print this long help message.
   6 git bisect start [<bad> [<good>...]] [--] [<pathspec>...]
   7         reset bisect state and start bisection.
   8 git bisect bad [<rev>]
   9         mark <rev> a known-bad revision.
  10 git bisect good [<rev>...]
  11         mark <rev>... known-good revisions.
  12 git bisect skip [<rev>...]
  13         mark <rev>... untestable revisions.
  14 git bisect next
  15         find next bisection to test and check it out.
  16 git bisect reset [<branch>]
  17         finish bisection search and go back to branch.
  18 git bisect visualize
  19         show bisect status in gitk.
  20 git bisect replay <logfile>
  21         replay bisection log.
  22 git bisect log
  23         show bisect log.
  24 git bisect run <cmd>...
  25         use <cmd>... to automatically bisect.
  26
  27 Please use "git help bisect" to get the full man page.'
  28
  29 OPTIONS_SPEC=
  30 . git-sh-setup
  31 require_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
  36 sq() {
  37         @@PERL@@ -e '
  38                 for (@ARGV) {
  39                         s/'\''/'\'\\\\\'\''/g;
  40                         print " '\''$_'\''";
  41                 }
  42                 print "\n";
  43         ' "$@"
  44 }
  45
  46 bisect_autostart() {
  47         test -f "$GIT_DIR/BISECT_NAMES" || {
  48                 echo >&2 'You need to start by "git bisect start"'
  49                 if test -t 0
  50                 then
  51                         echo >&2 -n 'Do you want me to do it for you [Y/n]? '
  52                         read yesno
  53                         case "$yesno" in
  54                         [Nn]*)
  55                                 exit ;;
  56                         esac
  57                         bisect_start
  58                 else
  59                         exit 1
  60                 fi
  61         }
  62 }
  63
  64 bisect_start() {
  65         #
  66         # Verify HEAD. If we were bisecting before this, reset to the
  67         # top-of-line master first!
  68         #
  69         head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD) ||
  70         head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD) ||
  71         die "Bad HEAD - I need a HEAD"
  72         #
  73         # Check that we either already have BISECT_START, or that the
  74         # branches bisect, new-bisect don't exist, to not override them.
  75         #
  76         test -s "$GIT_DIR/BISECT_START" ||
  77                 if git show-ref --verify -q refs/heads/bisect ||
  78                     git show-ref --verify -q refs/heads/new-bisect; then
  79                         die 'The branches "bisect" and "new-bisect" must not exist.'
  80                 fi
  81         start_head=''
  82         case "$head" in
  83         refs/heads/bisect)
  84                 branch=`cat "$GIT_DIR/BISECT_START"`
  85                 git checkout $branch || exit
  86                 ;;
  87         refs/heads/*|$_x40)
  88                 # This error message should only be triggered by cogito usage,
  89                 # and cogito users should understand it relates to cg-seek.
  90                 [ -s "$GIT_DIR/head-name" ] && die "won't bisect on seeked tree"
  91                 start_head="${head#refs/heads/}"
  92                 ;;
  93         *)
  94                 die "Bad HEAD - strange symbolic ref"
  95                 ;;
  96         esac
  97
  98         #
  99         # Get rid of any old bisect state
 100         #
 101         bisect_clean_state
 102
 103         #
 104         # Check for one bad and then some good revisions.
 105         #
 106         has_double_dash=0
 107         for arg; do
 108             case "$arg" in --) has_double_dash=1; break ;; esac
 109         done
 110         orig_args=$(sq "$@")
 111         bad_seen=0
 112         eval=''
 113         while [ $# -gt 0 ]; do
 114             arg="$1"
 115             case "$arg" in
 116             --)
 117                 shift
 118                 break
 119                 ;;
 120             *)
 121                 rev=$(git rev-parse --verify "$arg^{commit}" 2>/dev/null) || {
 122                     test $has_double_dash -eq 1 &&
 123                         die "'$arg' does not appear to be a valid revision"
 124                     break
 125                 }
 126                 case $bad_seen in
 127                 0) state='bad' ; bad_seen=1 ;;
 128                 *) state='good' ;;
 129                 esac
 130                 eval="$eval bisect_write '$state' '$rev' 'nolog'; "
 131                 shift
 132                 ;;
 133             esac
 134         done
 135
 136         sq "$@" >"$GIT_DIR/BISECT_NAMES"
 137         test -n "$start_head" && echo "$start_head" >"$GIT_DIR/BISECT_START"
 138         eval "$eval"
 139         echo "git-bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG"
 140         bisect_auto_next
 141 }
 142
 143 bisect_write() {
 144         state="$1"
 145         rev="$2"
 146         nolog="$3"
 147         case "$state" in
 148                 bad)            tag="$state" ;;
 149                 good|skip)      tag="$state"-"$rev" ;;
 150                 *)              die "Bad bisect_write argument: $state" ;;
 151         esac
 152         git update-ref "refs/bisect/$tag" "$rev"
 153         echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG"
 154         test -z "$nolog" && echo "git-bisect $state $rev" >>"$GIT_DIR/BISECT_LOG"
 155 }
 156
 157 bisect_state() {
 158         bisect_autostart
 159         state=$1
 160         case "$#,$state" in
 161         0,*)
 162                 die "Please call 'bisect_state' with at least one argument." ;;
 163         1,bad|1,good|1,skip)
 164                 rev=$(git rev-parse --verify HEAD) ||
 165                         die "Bad rev input: HEAD"
 166                 bisect_write "$state" "$rev" ;;
 167         2,bad|*,good|*,skip)
 168                 shift
 169                 eval=''
 170                 for rev in "$@"
 171                 do
 172                         sha=$(git rev-parse --verify "$rev^{commit}") ||
 173                                 die "Bad rev input: $rev"
 174                         eval="$eval bisect_write '$state' '$sha'; "
 175                 done
 176                 eval "$eval" ;;
 177         *,bad)
 178                 die "'git bisect bad' can take only one argument." ;;
 179         *)
 180                 usage ;;
 181         esac
 182         bisect_auto_next
 183 }
 184
 185 bisect_next_check() {
 186         missing_good= missing_bad=
 187         git show-ref -q --verify refs/bisect/bad || missing_bad=t
 188         test -n "$(git for-each-ref "refs/bisect/good-*")" || missing_good=t
 189
 190         case "$missing_good,$missing_bad,$1" in
 191         ,,*)
 192                 : have both good and bad - ok
 193                 ;;
 194         *,)
 195                 # do not have both but not asked to fail - just report.
 196                 false
 197                 ;;
 198         t,,good)
 199                 # have bad but not good.  we could bisect although
 200                 # this is less optimum.
 201                 echo >&2 'Warning: bisecting only with a bad commit.'
 202                 if test -t 0
 203                 then
 204                         printf >&2 'Are you sure [Y/n]? '
 205                         case "$(read yesno)" in [Nn]*) exit 1 ;; esac
 206                 fi
 207                 : bisect without good...
 208                 ;;
 209         *)
 210                 THEN=''
 211                 test -f "$GIT_DIR/BISECT_NAMES" || {
 212                         echo >&2 'You need to start by "git bisect start".'
 213                         THEN='then '
 214                 }
 215                 echo >&2 'You '$THEN'need to give me at least one good' \
 216                         'and one bad revisions.'
 217                 echo >&2 '(You can use "git bisect bad" and' \
 218                         '"git bisect good" for that.)'
 219                 exit 1 ;;
 220         esac
 221 }
 222
 223 bisect_auto_next() {
 224         bisect_next_check && bisect_next || :
 225 }
 226
 227 eval_rev_list() {
 228         _eval="$1"
 229
 230         eval $_eval
 231         res=$?
 232
 233         if [ $res -ne 0 ]; then
 234                 echo >&2 "'git rev-list --bisect-vars' failed:"
 235                 echo >&2 "maybe you mistake good and bad revs?"
 236                 exit $res
 237         fi
 238
 239         return $res
 240 }
 241
 242 filter_skipped() {
 243         _eval="$1"
 244         _skip="$2"
 245
 246         if [ -z "$_skip" ]; then
 247                 eval_rev_list "$_eval"
 248                 return
 249         fi
 250
 251         # Let's parse the output of:
 252         # "git rev-list --bisect-vars --bisect-all ..."
 253         eval_rev_list "$_eval" | while read hash line
 254         do
 255                 case "$VARS,$FOUND,$TRIED,$hash" in
 256                         # We display some vars.
 257                         1,*,*,*) echo "$hash $line" ;;
 258
 259                         # Split line.
 260                         ,*,*,---*) ;;
 261
 262                         # We had nothing to search.
 263                         ,,,bisect_rev*)
 264                                 echo "bisect_rev="
 265                                 VARS=1
 266                                 ;;
 267
 268                         # We did not find a good bisect rev.
 269                         # This should happen only if the "bad"
 270                         # commit is also a "skip" commit.
 271                         ,,*,bisect_rev*)
 272                                 echo "bisect_rev=$TRIED"
 273                                 VARS=1
 274                                 ;;
 275
 276                         # We are searching.
 277                         ,,*,*)
 278                                 TRIED="${TRIED:+$TRIED|}$hash"
 279                                 case "$_skip" in
 280                                 *$hash*) ;;
 281                                 *)
 282                                         echo "bisect_rev=$hash"
 283                                         echo "bisect_tried=\"$TRIED\""
 284                                         FOUND=1
 285                                         ;;
 286                                 esac
 287                                 ;;
 288
 289                         # We have already found a rev to be tested.
 290                         ,1,*,bisect_rev*) VARS=1 ;;
 291                         ,1,*,*) ;;
 292
 293                         # ???
 294                         *) die "filter_skipped error " \
 295                             "VARS: '$VARS' " \
 296                             "FOUND: '$FOUND' " \
 297                             "TRIED: '$TRIED' " \
 298                             "hash: '$hash' " \
 299                             "line: '$line'"
 300                         ;;
 301                 esac
 302         done
 303 }
 304
 305 exit_if_skipped_commits () {
 306         _tried=$1
 307         if expr "$_tried" : ".*[|].*" > /dev/null ; then
 308                 echo "There are only 'skip'ped commit left to test."
 309                 echo "The first bad commit could be any of:"
 310                 echo "$_tried" | tr '[|]' '[\012]'
 311                 echo "We cannot bisect more!"
 312                 exit 2
 313         fi
 314 }
 315
 316 bisect_next() {
 317         case "$#" in 0) ;; *) usage ;; esac
 318         bisect_autostart
 319         bisect_next_check good
 320
 321         skip=$(git for-each-ref --format='%(objectname)' \
 322                 "refs/bisect/skip-*" | tr '\012' ' ') || exit
 323
 324         BISECT_OPT=''
 325         test -n "$skip" && BISECT_OPT='--bisect-all'
 326
 327         bad=$(git rev-parse --verify refs/bisect/bad) &&
 328         good=$(git for-each-ref --format='^%(objectname)' \
 329                 "refs/bisect/good-*" | tr '\012' ' ') &&
 330         eval="git rev-list --bisect-vars $BISECT_OPT $good $bad --" &&
 331         eval="$eval $(cat "$GIT_DIR/BISECT_NAMES")" &&
 332         eval=$(filter_skipped "$eval" "$skip") &&
 333         eval "$eval" || exit
 334
 335         if [ -z "$bisect_rev" ]; then
 336                 echo "$bad was both good and bad"
 337                 exit 1
 338         fi
 339         if [ "$bisect_rev" = "$bad" ]; then
 340                 exit_if_skipped_commits "$bisect_tried"
 341                 echo "$bisect_rev is first bad commit"
 342                 git diff-tree --pretty $bisect_rev
 343                 exit 0
 344         fi
 345
 346         # We should exit here only if the "bad"
 347         # commit is also a "skip" commit (see above).
 348         exit_if_skipped_commits "$bisect_rev"
 349
 350         echo "Bisecting: $bisect_nr revisions left to test after this"
 351         git branch -D new-bisect 2> /dev/null
 352         git checkout -q -b new-bisect "$bisect_rev" || exit
 353         git branch -M new-bisect bisect
 354         git show-branch "$bisect_rev"
 355 }
 356
 357 bisect_visualize() {
 358         bisect_next_check fail
 359
 360         if test $# = 0
 361         then
 362                 case "${DISPLAY+set}${MSYSTEM+set}${SECURITYSESSIONID+set}" in
 363                 '')     set git log ;;
 364                 set*)   set gitk ;;
 365                 esac
 366         else
 367                 case "$1" in
 368                 git*|tig) ;;
 369                 -*)     set git log "$@" ;;
 370                 *)      set git "$@" ;;
 371                 esac
 372         fi
 373
 374         not=$(git for-each-ref --format='%(refname)' "refs/bisect/good-*")
 375         eval '"$@"' refs/bisect/bad --not $not -- $(cat "$GIT_DIR/BISECT_NAMES")
 376 }
 377
 378 bisect_reset() {
 379         test -f "$GIT_DIR/BISECT_NAMES" || {
 380                 echo "We are not bisecting."
 381                 return
 382         }
 383         case "$#" in
 384         0) if [ -s "$GIT_DIR/BISECT_START" ]; then
 385                branch=`cat "$GIT_DIR/BISECT_START"`
 386            else
 387                branch=master
 388            fi ;;
 389         1) git show-ref --verify --quiet -- "refs/heads/$1" ||
 390                die "$1 does not seem to be a valid branch"
 391            branch="$1" ;;
 392         *)
 393             usage ;;
 394         esac
 395         if git checkout "$branch"; then
 396                 # Cleanup head-name if it got left by an old version of git-bisect
 397                 rm -f "$GIT_DIR/head-name"
 398                 rm -f "$GIT_DIR/BISECT_START"
 399                 bisect_clean_state
 400         fi
 401 }
 402
 403 bisect_clean_state() {
 404         # There may be some refs packed during bisection.
 405         git for-each-ref --format='%(refname) %(objectname)' refs/bisect/\* refs/heads/bisect |
 406         while read ref hash
 407         do
 408                 git update-ref -d $ref $hash
 409         done
 410         rm -f "$GIT_DIR/BISECT_LOG"
 411         rm -f "$GIT_DIR/BISECT_NAMES"
 412         rm -f "$GIT_DIR/BISECT_RUN"
 413 }
 414
 415 bisect_replay () {
 416         test -r "$1" || die "cannot read $1 for replaying"
 417         bisect_reset
 418         while read bisect command rev
 419         do
 420                 test "$bisect" = "git-bisect" || continue
 421                 case "$command" in
 422                 start)
 423                         cmd="bisect_start $rev"
 424                         eval "$cmd" ;;
 425                 good|bad|skip)
 426                         bisect_write "$command" "$rev" ;;
 427                 *)
 428                         die "?? what are you talking about?" ;;
 429                 esac
 430         done <"$1"
 431         bisect_auto_next
 432 }
 433
 434 bisect_run () {
 435     bisect_next_check fail
 436
 437     while true
 438     do
 439       echo "running $@"
 440       "$@"
 441       res=$?
 442
 443       # Check for really bad run error.
 444       if [ $res -lt 0 -o $res -ge 128 ]; then
 445           echo >&2 "bisect run failed:"
 446           echo >&2 "exit code $res from '$@' is < 0 or >= 128"
 447           exit $res
 448       fi
 449
 450       # Find current state depending on run success or failure.
 451       # A special exit code of 125 means cannot test.
 452       if [ $res -eq 125 ]; then
 453           state='skip'
 454       elif [ $res -gt 0 ]; then
 455           state='bad'
 456       else
 457           state='good'
 458       fi
 459
 460       # We have to use a subshell because "bisect_state" can exit.
 461       ( bisect_state $state > "$GIT_DIR/BISECT_RUN" )
 462       res=$?
 463
 464       cat "$GIT_DIR/BISECT_RUN"
 465
 466       if grep "first bad commit could be any of" "$GIT_DIR/BISECT_RUN" \
 467                 > /dev/null; then
 468           echo >&2 "bisect run cannot continue any more"
 469           exit $res
 470       fi
 471
 472       if [ $res -ne 0 ]; then
 473           echo >&2 "bisect run failed:"
 474           echo >&2 "'bisect_state $state' exited with error code $res"
 475           exit $res
 476       fi
 477
 478       if grep "is first bad commit" "$GIT_DIR/BISECT_RUN" > /dev/null; then
 479           echo "bisect run success"
 480           exit 0;
 481       fi
 482
 483     done
 484 }
 485
 486
 487 case "$#" in
 488 0)
 489     usage ;;
 490 *)
 491     cmd="$1"
 492     shift
 493     case "$cmd" in
 494     help)
 495         git bisect -h ;;
 496     start)
 497         bisect_start "$@" ;;
 498     bad|good|skip)
 499         bisect_state "$cmd" "$@" ;;
 500     next)
 501         # Not sure we want "next" at the UI level anymore.
 502         bisect_next "$@" ;;
 503     visualize|view)
 504         bisect_visualize "$@" ;;
 505     reset)
 506         bisect_reset "$@" ;;
 507     replay)
 508         bisect_replay "$@" ;;
 509     log)
 510         cat "$GIT_DIR/BISECT_LOG" ;;
 511     run)
 512         bisect_run "$@" ;;
 513     *)
 514         usage ;;
 515     esac
 516 esac