valgrind.sh

#!/bin/bash

if [[ "$1" == "-h" || "$1" == "--help" ]]; then
    echo "Welcome in valgrind.sh help !"
    echo -e "\tThis script aims to ease valgrind usage."
    echo -ne "\tIt runs valgrind with the most important flags."
    echo -e "\n\"$0 <binary> <arguments>\""
    echo -e "\t<binary> : binary name (either 'asm' or 'corewar' here)"
    echo -e "\t<arguments> : arguments that are given to the binary."
    echo -e "\n\"$0 a b c\" ==> \"./binary a b c\""
    echo  "The binary name is automatically read from the Makefile using this command :"
    echo -e "\"cat Makefile | grep NAME | head -1 | awk '{ print $NF }'\""
    echo "If no binary in Makefile, the fallback is ./a.out"
    echo -e "\nSee also \"$0 --cmd\" to have more details about valgrind command line."
    exit 0
fi

if [[ "$1" == "--cmd" ]]; then
    echo "Full valgrind command :"
    echo -e "valgrind --leak-check=full --track-origins=yes -s --malloc-fill=0x42 --free-fill=0x84 --log-file=valgrind.log\n"
    echo -e "\t--leak-check=full : complete check of memory leaks for an optimal efficiency"
    echo -e "\t--track-origins=yes : tells valgrind to display where was allocated each leaked memory"
    echo -e "\t-s : display all errors"
    echo -e "\t--malloc-fill=0x42 : fills any malloc'd memory with the byte 0x42"
    echo -e "\t\t- prevents compiler behaviour (often initializes memory with 0) to make secure code"
    echo -e "\t\t- helps detecting mistakes by looking for this byte in valgrind's log"
    echo -e "\t--free-fill=0x48 : same as above, except that it's freed memory which is filled with 0x84"
    echo -e "\t--log-file=valgrind.log : saves all the log into valgrind.log file"
    exit 0
fi

binary=$(cat Makefile | grep NAME | head -1 | awk '{ print $NF }')
if [[ "$binary" == "" ]]; then
    binary="./a.out"
fi

make --no-print-directory redebug
echo "-----PROGRAM OUTPUT-------"
valgrind --leak-check=full --show-leak-kinds=all --track-origins=yes -s --malloc-fill=0x42 --free-fill=0x84 --log-file=valgrind.log ./$binary ${@:1}
echo "--------------------------"
echo "Open ./valgrind.log to see valgrind's output !"