twrp_bench.sh

#!/bin/bash -
###############################################################################################################
#
# Copyright: 2016-2022 steadfasterX <steadfasterX | at - gmail DOT com>
#
# Licensed under the LGPL v3 or later:
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################################################
#
# Description:
#       simple TWRP benchmark tester for the LG G4
#       Use it with any other device if you like ! Just adjust the topics:
#           "# set readahead" and "# set IO scheduler"
#
#
VERSION=20161130
###############################################################################################################

BAKNAME=benchmarktest
LOG=${0/.sh/.log}

echo "Starting $0 (version: $VERSION)"
echo "Starting $0 (version: $VERSION)" > $LOG

# usage info
F_USAGE(){
    cat <<EOHELP
    
    
    Usage info
    ============================================================
    
    -help                       => this output
    
    
    required args:
        -rhsize <kilobytes>     => read_ahead_kb
        -gov <name>             => cpu governor
        -isch <name>            => I/O scheduler
        -mode [SDRBCO]          => backup args
                                    # S = System partition
                                    # D = Data partition
                                    # R = Recovery partition
                                    # B = Boot partition
                                    # C = Cache partition
                                    # O = Activate compression
        
    optional args:
        -key <decrypt-pw>       => decryption password when using this script
                                    in a loop (e.g. for i in 1 2 3 ;do ...)
                                    May not work always 'cause sometimes you have
                                    to reconnect the usb cable after a reboot
                                    
                                    
EOHELP
}


[ -z "$1" ] &&echo -e "\naborted! Missing args\n\n" && F_USAGE && exit

# check for help first
echo "$@" |grep -q "-help" && F_USAGE && exit

while [ ! -z "$1" ] ;do
    case "$1" in 
        -rhsize)
        RHSIZE=$2
        shift 2
        ;;
        -gov)
        CGOV=$2
        shift 2
        ;;
        -isch)
        ISCH=$2
        shift 2
        ;;
        -mode)
        BAKARGS="$2"
        shift 2
        ;;
        -key)
        KEY=$2
        shift 2
        ;;
        *)
        echo "ERROR unknown arg <$1>"
        exit
        ;;
    esac
done

# precheck for req args
if [ -z "$RHSIZE" ]||[ -z "$CGOV" ]||[ -z "$ISCH" ]||[ -z "$BAKARGS" ];then
    echo -e "\n\nmissing a required arg! ABORTED!\n\n"
    F_USAGE
    exit
fi

# ensure we have a decrypted device if suggested
[ ! -z "$KEY" ] && echo "decrypt key set. Trying to decrypt now..." && adb shell "twrp decrypt $KEY" >> $LOG
ERR=$?
[ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
echo "device decrypted or no decryption needed (ended with >$ERR<)" >> $LOG

# when we decrypted we need to take a breath because adb will reload then
[ ! -z "$KEY" ] && echo "done. Now taking a deep breath before proceeding (adb needs that..)" && sleep 5

# ensure we use the external storage
adb shell 'twrp set tw_storage_path /external_sd' >> $LOG
ERR=$?
[ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
echo "tw_storage_path set to /external_sd (ended with >$ERR<)" >> $LOG

# ensure we have no old backups in place
echo "deleting any previous >$BAKNAME< backup"
adb shell "rm -vRf /external_sd/TWRP/BACKUPS/*/$BAKNAME/; rm -vRf /sdcard/TWRP/BACKUPS/*/$BAKNAME/" >> $LOG
ERR=$?
[ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
echo "deleting any previous >$BAKNAME< backup finished (ended with >$ERR<)" >> $LOG

# set cpu governor
adb shell "for i in \$(find /sys/devices/ -type f -name scaling_governor);do echo $CGOV > \$i;cat \$i;done" >> $LOG
ERR=$?
[ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
echo "governor set (ended with >$ERR<)" >> $LOG

# set IO scheduler
adb shell "for a in \$(find /sys/devices/soc.0/ -type f -name scheduler|grep mmc);do echo $ISCH > \$a; cat \$a;done" >> $LOG
ERR=$?
[ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
echo "scheduler set (ended with >$ERR<)" >> $LOG

# set readahead
for b in /sys/devices/virtual/bdi/179\\:0/read_ahead_kb /sys/devices/virtual/bdi/254\\:0/read_ahead_kb /sys/devices/virtual/bdi/179\\:32/read_ahead_kb /sys/devices/virtual/bdi/179\\:64/read_ahead_kb;do
    adb shell "echo $RHSIZE >> $b; cat $b"
    ERR=$?
    [ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
done >> $LOG
echo "readahead set (ended with >$ERR<)" >> $LOG

# grep results and reboot
echo "Ok.. now lean back: we start the backup! This can take a fucking long time!"
echo "using: readahead=$RHSIZE, governor=$CGOV, scheduler=$ISCH, backup-args=$BAKARGS"
echo "Backup starting! using: readahead=$RHSIZE, governor=$CGOV, scheduler=$ISCH, backup-args=$BAKARGS" >> $LOG
# delete any existing previously pulled log
rm -f recovery.log
unset REMLOG
# do the magic
adb shell "twrp backup $BAKARGS $BAKNAME" >> $LOG \
    && adb pull /tmp/recovery.log \
    && egrep -i '(seconds|backup rate)' recovery.log \
    && adb shell "rm -Rf /external_sd/TWRP/BACKUPS/*/$BAKNAME/" \
    && adb reboot recovery && sleep 10 && echo "waiting for recovered device (if encrypted just click CANCEL on decryption page to get recovered)" \
    && adb wait-for-recovery
ERR=$?
[ $ERR -ne 0 ] && echo -e "\n\nERROR <$ERR> occured!!!\n ABORTED!!\nHere comes the LOG:\n $(less $LOG)" && exit
echo "Backup ended with >$ERR<" >> $LOG

echo -e "finished\n\n"