evaluate_benchmarks.sh

#!/bin/env bash

set -e

if [[ ! -f "frequencies.config" ]]; then
    echo "Error: frequencies.config does not exist!"
    echo "frequencies.config must be a file with all frequencies"
    echo "to evaluate on the first line (separated by space)"
    echo "See frequencies.config.example for an example file."
    echo ""
    echo "You can get access to all available frequencies with:"
    echo "        $CPUPOWER frequency-info"
    exit 1
fi

if [ "$EUID" -ne 0 ]; then 
    echo "Please run this command as root!"
    exit 1
fi

if [ -z $BENCHMARK_OUTPUT_DIRECTORY ]; then
    BENCHMARK_OUTPUT_DIRECTORY="results/new"
fi

POSITIONAL=()
while [[ $# -gt 0 ]]; do
    key="$1"

    case $key in
        --output)
                BENCHMARK_OUTPUT_DIRECTORY="$2"
                shift # past argument
                shift # past value
                ;;
        --help)
                echo "./evaluate_benchmarks.sh --output <directory> [workloads...]"
                exit 0
                ;;
        *) # unknown option
                POSITIONAL+=("$1") # save it in an array for later
                shift # past argument
                ;;
    esac
done
set -- "${POSITIONAL[@]}" # restore positional parameters

if [ -z $CPUPOWER ]; then
    CPUPOWER=cpupower
fi

GOVERNOR=$($CPUPOWER frequency-info -p | awk '/^.+The governor/ { gsub(/"/,""); print $3 }')

for workload in "$@"
do
    echo "####### Running workload $workload ##########"

    workload_name=$(basename "$workload")
    OUTPUT_DIRECTORY="$BENCHMARK_OUTPUT_DIRECTORY/$workload_name"
    mkdir -p "$OUTPUT_DIRECTORY"
    export OUTPUT_DIRECTORY="$OUTPUT_DIRECTORY"
    set -x

    $CPUPOWER frequency-set -g memutil
    log_output_directory="$OUTPUT_DIRECTORY/memutil-log"
    mkdir -p "$log_output_directory"
    # Copying the current log will clear it, so we start with a fresh log
    cp /sys/kernel/debug/memutil/log /dev/null
    # Start the copy-log, as well as pinpoint-stats commands in the background
    # and terminate both, if one of them exits.
    # See: https://unix.stackexchange.com/questions/231676/given-two-background-commands-terminate-the-remaining-one-when-either-exits
    ../kernel-module/copy-log.sh -c -i 8 "$log_output_directory" $(nproc) &
    # Start logging a short period before running the workload
    sleep 0.1s
    utils/pinpoint-stats.sh "$workload_name-memutil" "$workload" &
    wait -n
    pkill -P $$
    wait -n # Wait to assure all logs have been copied

    $CPUPOWER frequency-set -g schedutil
    utils/pinpoint-stats.sh "$workload_name-schedutil" "$workload"

    utils/pinpoint-frequencies.sh "$workload" $(head -1 frequencies.config)
    set +x
done

echo "Restoring frequency governor to: $GOVERNOR"
$CPUPOWER frequency-set -g "$GOVERNOR"