cairo/perf/cairo-perf-diff
Carl Worth d9b697c46c cairo-perf-diff: Allow incremental refinement of performance results
cairo-perf-diff now accepts a -f command-line option to force it to
re-generate performance results even if something exists in the cache
already. It also now uses raw mode and appends to the cached file
rather than rewriting the results.

Finally, it also now allows a -- option on the command line and passes
all the subsequent command-line options to cairo-perf. This is handy for
limiting cairo-perf to run only on a subset of the tests of interest.
2006-11-10 10:34:35 -08:00

148 lines
4.2 KiB
Bash
Executable file

#!/bin/sh
set -e
usage() {
argv0=$(basename $0)
echo "Usage:" >&2
echo "For comparing files created my cairo-perf:" >&2
echo "" >&2
echo " $argv0 old.perf new.perf" >&2
echo "" >&2
echo "For comparing (cached) performance of revisions:" >&2
echo "" >&2
echo " $argv0 [-f] <revision> [-- cairo-perf options]" >&2
echo " $argv0 [-f] <rev1> <rev2> [-- cairo-perf-options]" >&2
echo "" >&2
echo "If given a single revision, compares its results to that of its" >&2
echo "(first-parent) predecessor. Otherwise compares the two given revisions." >&2
echo "The revisions can be any revision accepted by git. For example:" >&2
echo "" >&2
echo " $argv0 HEAD # Show impact of latest commit" >&2
echo " $argv0 1.2.0 1.2.4 # Compare performance of 1.2.0 to 1.2.4" >&2
echo "" >&2
echo "The -f option forces cairo-perf-diff to re-run performance tests even" >&2
echo "if cached performance data is available." >&2
echo "" >&2
echo "Additional options can be passed the child cairo-perf process" >&2
echo "by separating them with a double hyphen (--). For example, to" >&2
echo "examine what the impact of the latest change is on the stroke" >&2
echo "test you might use:" >&2
echo "" >&2
echo " $argv0 HEAD -- stroke" >&2
echo "" >&2
echo "The performance results are cached in .perf next to the .git directory." >&2
exit 1
}
# Yes, this ugly ad-hoc option parsing could be cleaned up
if [ $# -eq 0 ] || [ "$1" = "--" ]; then
usage
fi
if [ "$1" = "-f" ]; then
force_cairo_perf="true"
shift 1
fi
if [ $# -eq 1 ] || [ "$2" = "--" ]; then
old="$1^"
new="$1"
shift 1
else
old="$1"
new="$2"
shift 2
fi
CAIRO_PERF_OPTIONS="-r -i 10"
if [ $# -gt 0 ]; then
if [ "$1" = "--" ]; then
shift 1
CAIRO_PERF_OPTIONS="$CAIRO_PERF_OPTIONS $@"
else
usage
fi
fi
git_setup() {
SUBDIRECTORY_OK='Yes'
. git-sh-setup
CAIRO_DIR=$(dirname $GIT_DIR)
if [ "$CAIRO_DIR" = "." ]; then
CAIRO_DIR=$(pwd)
fi
CAIRO_PERF_DIR=$CAIRO_DIR/.perf
}
rev2sha() {
rev=$1
git rev-parse --verify $rev || ( echo "Cannot resolve $rev as a git object" && exit 1 )
}
# We cache performance output based on a two-part name capturing the
# current performance test suite and the library being tested. We
# capture these as the tree object of the perf directory in HEAD and
# the tree object of the src directory of the revision being tested.
#
# This way, whenever the performance suite is updated, cached output
# from old versions of the suite are automatically invalidated. Also,
# if a commit just changes things outside of the src tree, (say it
# changes the "test" test suite, or README or configure.in, or
# whatever), cairo-perf-diff will be smart enough to still use cached
# results from a run with an equivalent src tree.
rev2perf() {
rev=$1
src_tree_sha=$(rev2sha $rev:src)
perf_tree_sha=$(rev2sha HEAD:perf)
echo "$CAIRO_PERF_DIR/${perf_tree_sha}-${src_tree_sha}.perf"
}
# Usage: run_cairo_perf_if_not_cached <rev>
run_cairo_perf_if_not_cached() {
rev=$1
owd=$(pwd)
sha=$(rev2sha $rev)
perf=$(rev2perf $rev)
if [ -e $perf ] && [ "$force_cairo_perf" != "true" ]; then
return 0
fi
if [ ! -d $CAIRO_PERF_DIR ]; then
echo "Creating new perf cache in $CAIRO_PERF_DIR"
mkdir $CAIRO_PERF_DIR
fi
cd $CAIRO_PERF_DIR
if [ ! -d build ]; then
git clone -s $CAIRO_DIR build
(cd build; git checkout -b tmp-cairo-perf-diff $sha; CFLAGS="-O2" ./autogen.sh)
fi
cd build
git checkout tmp-cairo-perf-diff
git reset --hard $sha
make CFLAGS="-O2" || (rm config.cache && make CFLAGS="-O2")
cp -a $CAIRO_DIR/boilerplate .
(cd boilerplate; make)
cp -a $CAIRO_DIR/perf .
cd perf;
make || exit 1
echo "Running \"cairo-perf $CAIRO_PERF_OPTIONS\" against $rev. Results will be cached in:"
echo "$perf"
(./cairo-perf $CAIRO_PERF_OPTIONS || echo "*** Performance test crashed") >> $perf
cd $owd
}
if [ ! -e $old ]; then
git_setup
run_cairo_perf_if_not_cached $old
old=$(rev2perf $old)
fi
if [ ! -e $new ]; then
git_setup
run_cairo_perf_if_not_cached $new
new=$(rev2perf $new)
fi
$CAIRO_DIR/perf/cairo-perf-diff-files $old $new