collect.sh

#!/usr/bin/env bash
#
# Shell script that runs 'auniter verify ${board} MemoryBenchmark.ino',
# and collects the flash memory and static RAM usage for each of
# the FEATURE (0..13).
#
# Usage: collect.sh {board} {result_file}
#
# Creates a ${board}.out file containing:
#
#  FEATURE flash max_flash ram max_ram
#  0  aa bb cc dd
#  ...
#  13 aa bb cc dd

set -eu

PROGRAM_NAME='MemoryBenchmark.ino'
NUM_FEATURES=2 # excluding Baseline

# Assume that https://github.com/bxparks/AUniter is installed as a
# sibling project to AceCommon.
AUNITER_CMD='../../../AUniter/tools/auniter.sh'
auniter_out_file=

function usage() {
    echo 'Usage: collect.sh {board} {result_file}'
    exit 1
}

function cleanup() {
    # Remove any temporary file
    if [[ "$auniter_out_file" != '' ]]; then
        rm -f $auniter_out_file
    fi

    # Restore the 'FEATURE' line
    sed -i -e "s/#define FEATURE [0-9]*/#define FEATURE 0/" $PROGRAM_NAME
}

function create_temp_file() {
    auniter_out_file=
    auniter_out_file=$(mktemp /tmp/memory_benchmark.auniter.XXXXXX)
}

# Usage: collect_for_board $cli_flag $board $result_file
# Sends output to $result_file.
function collect_for_board() {
    local cli_flag="$1"
    local board=$2
    local result_file=$3

    for feature in $(seq 0 $NUM_FEATURES); do
        echo "Collecting flash and ram usage for FEATURE $feature"
        sed -i -e "s/#define FEATURE [0-9]*/#define FEATURE $feature/" \
            $PROGRAM_NAME

        if ($AUNITER_CMD "$cli_flag" verify $board $PROGRAM_NAME 2>&1) > \
                $auniter_out_file; then
            extract_memory "$feature" "$result_file"

        elif grep -q 'Sketch too big' $auniter_out_file; then
            # Ignore 'Sketch too big' condition, since we just want to
            # collect the flash and ram usage numbers.
            extract_memory "$feature" "$result_file"

        elif grep -q 'region.*overflowed by' $auniter_out_file; then
            # When STM32duino overflows, it does not print any useful info.
            # Print special markers to tell generate_table.awk about the
            # overflow.
            echo $feature -1 -1 -1 -1 >> $result_file

        else
            # Can't handle the error, so echo the output and exit the script.
            cat $auniter_out_file
            exit 1
        fi
    done
}

function extract_memory() {
    local feature=$1
    local result_file=$2

    local flash=$(grep 'Sketch uses' $auniter_out_file |
        awk '{print $3, $12}')
    local memory=$(grep 'Global variables' $auniter_out_file |
        awk '{print $4, $18}')
    echo $feature $flash $memory >> $result_file
}

trap "cleanup" EXIT

# Parse flags.
cli_flag='--cli'
while [[ $# -gt 0 ]]; do
    case $1 in
        --cli) cli_flag='--cli' ;;
        --ide) cli_flag='--ide' ;;
        --help|-h) usage ;;
        --) shift; break ;;
        -*) echo "Unknown flag '$1'" 1>&2; usage 1>&2 ;;
        *) break ;;
    esac
    shift
done
if [[ $# < 2 ]]; then
    usage
fi

rm -f $2
create_temp_file
echo "==== Collecting for board: $1"
collect_for_board "$cli_flag" "$@"