Skip to content

Commit

Permalink
scripts: Add new parameters to retdec-decompiler.sh: --max-memory and…
Browse files Browse the repository at this point in the history 
… --no-memory-limit.

The first parameter can be used to set the maximal memory limit of fileinfo,
bin2llvmir, and llvmir2hll.

The second parameter can be used to skip the newly added limit of half of
system RAM in fileinfo, bin2llvmir, llvmir2hll. By default, we want to limit
the memory of these tools into half of system RAM to prevent potential black
screens on Windows.
  • Loading branch information
@s3rvac
s3rvac committed Apr 10, 2018
1 parent 349c595 commit 23434fa
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion scripts/retdec-decompiler.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,12 @@ print_help()
echo " --static-code-sigfile path Adds additional signature file for static code detection."
echo " --static-code-archive path Adds additional signature file for static code detection from given archive."
echo " --no-default-static-signatures No default signatures for statically linked code analysis are loaded (options static-code-sigfile/archive are still available)."
echo " --max-memory bytes Limits the maximal memory of fileinfo, bin2llvmir, and llvmir2hll into the given number of bytes."
echo " --no-memory-limit Disables the default memory limit (half of system RAM) of fileinfo, bin2llvmir, and llvmir2hll."
}
SCRIPT_NAME=$0
GETOPT_SHORTOPT="a:e:hkl:m:o:p:"
GETOPT_LONGOPT="arch:,help,keep-unreachable-funcs,target-language:,mode:,output:,pdb:,backend-aggressive-opts,backend-arithm-expr-evaluator:,backend-call-info-obtainer:,backend-cfg-test,backend-disabled-opts:,backend-emit-cfg,backend-emit-cg,backend-cg-conversion:,backend-cfg-conversion:,backend-enabled-opts:,backend-find-patterns:,backend-force-module-name:,backend-keep-all-brackets,backend-keep-library-funcs,backend-llvmir2bir-converter:,backend-no-compound-operators,backend-no-debug,backend-no-debug-comments,backend-no-opts,backend-no-symbolic-names,backend-no-time-varying-info,backend-no-var-renaming,backend-semantics,backend-strict-fpu-semantics,backend-var-renamer:,cleanup,graph-format:,raw-entry-point:,raw-section-vma:,endian:,select-decode-only,select-functions:,select-ranges:,fileinfo-verbose,fileinfo-use-all-external-patterns,config:,color-for-ida,no-config,stop-after:,static-code-sigfile:,static-code-archive:,no-default-static-signatures,ar-name:,ar-index:"
GETOPT_LONGOPT="arch:,help,keep-unreachable-funcs,target-language:,mode:,output:,pdb:,backend-aggressive-opts,backend-arithm-expr-evaluator:,backend-call-info-obtainer:,backend-cfg-test,backend-disabled-opts:,backend-emit-cfg,backend-emit-cg,backend-cg-conversion:,backend-cfg-conversion:,backend-enabled-opts:,backend-find-patterns:,backend-force-module-name:,backend-keep-all-brackets,backend-keep-library-funcs,backend-llvmir2bir-converter:,backend-no-compound-operators,backend-no-debug,backend-no-debug-comments,backend-no-opts,backend-no-symbolic-names,backend-no-time-varying-info,backend-no-var-renaming,backend-semantics,backend-strict-fpu-semantics,backend-var-renamer:,cleanup,graph-format:,raw-entry-point:,raw-section-vma:,endian:,select-decode-only,select-functions:,select-ranges:,fileinfo-verbose,fileinfo-use-all-external-patterns,config:,color-for-ida,no-config,stop-after:,static-code-sigfile:,static-code-archive:,no-default-static-signatures,ar-name:,ar-index:,max-memory:,no-memory-limit"

#
# Check proper combination of input arguments.
Expand Down Expand Up @@ -476,6 +478,19 @@ while true; do
[ "$AR_INDEX" ] && print_error_and_die "Duplicate option: --ar-index"
AR_INDEX="$2"
shift 2;;
--max-memory)
[ "$MAX_MEMORY" ] && print_error_and_die "Duplicate option: --max-memory"
[ "$NO_MEMORY_LIMIT" ] && print_error_and_die "Clashing options: --max-memory and --no-memory-limit"
MAX_MEMORY="$2"
if [[ ! "$MAX_MEMORY" =~ ^[0-9]+$ ]]; then
print_error_and_die "Invalid value for --max-memory: $MAX_MEMORY (expected a positive integer)"
fi
shift 2;;
--no-memory-limit)
[ "$NO_MEMORY_LIMIT" ] && print_error_and_die "Duplicate option: --no-memory-limit"
[ "$MAX_MEMORY" ] && print_error_and_die "Clashing options: --max-memory and --no-memory-limit"
NO_MEMORY_LIMIT=1
shift;;
--) # Input file.
if [ $# -eq 2 ]; then
IN="$2"
Expand Down Expand Up @@ -652,6 +667,13 @@ if [ "$MODE" = "bin" ] || [ "$MODE" = "raw" ]; then
FILEINFO_PARAMS+=(--crypto "$par")
done
fi
if [ ! -z "$MAX_MEMORY" ]; then
FILEINFO_PARAMS+=(--max-memory "$MAX_MEMORY")
elif [ -z "$NO_MEMORY_LIMIT" ]; then
# By default, we want to limit the memory of fileinfo into half of
# system RAM to prevent potential black screens on Windows (#270).
FILEINFO_PARAMS+=(--max-memory-half-ram)
fi
echo ""
echo "##### Gathering file information..."
echo "RUN: $FILEINFO ${FILEINFO_PARAMS[@]}"
Expand Down Expand Up @@ -695,6 +717,13 @@ if [ "$MODE" = "bin" ] || [ "$MODE" = "raw" ]; then
FILEINFO_PARAMS+=(--crypto "$par")
done
fi
if [ ! -z "$MAX_MEMORY" ]; then
FILEINFO_PARAMS+=(--max-memory "$MAX_MEMORY")
elif [ -z "$NO_MEMORY_LIMIT" ]; then
# By default, we want to limit the memory of fileinfo into half of
# system RAM to prevent potential black screens on Windows (#270).
FILEINFO_PARAMS+=(--max-memory-half-ram)
fi

echo ""
echo "##### Gathering file information after unpacking..."
Expand Down Expand Up @@ -872,6 +901,14 @@ if [ "$MODE" = "bin" ] || [ "$MODE" = "raw" ]; then

BIN2LLVMIR_PARAMS=(-provider-init -config-path "$CONFIG" -decoder $BIN2LLVMIR_PARAMS)

if [ ! -z "$MAX_MEMORY" ]; then
BIN2LLVMIR_PARAMS+=(-max-memory "$MAX_MEMORY")
elif [ -z "$NO_MEMORY_LIMIT" ]; then
# By default, we want to limit the memory of bin2llvmir into half of
# system RAM to prevent potential black screens on Windows (#270).
BIN2LLVMIR_PARAMS+=(-max-memory-half-ram)
fi

echo ""
echo "##### Decompiling $IN into $OUT_BACKEND_BC..."
echo "RUN: $BIN2LLVMIR ${BIN2LLVMIR_PARAMS[@]} -o $OUT_BACKEND_BC"
Expand Down Expand Up @@ -924,6 +961,13 @@ if [ "$BACKEND_EMIT_CFG" ]; then
LLVMIR2HLL_PARAMS+=(-emit-cfgs)
[ "$BACKEND_CFG_TEST" ] && LLVMIR2HLL_PARAMS+=(--backend-cfg-test)
fi
if [ ! -z "$MAX_MEMORY" ]; then
LLVMIR2HLL_PARAMS+=(-max-memory "$MAX_MEMORY")
elif [ -z "$NO_MEMORY_LIMIT" ]; then
# By default, we want to limit the memory of llvmir2hll into half of system
# RAM to prevent potential black screens on Windows (#270).
LLVMIR2HLL_PARAMS+=(-max-memory-half-ram)
fi

# Decompile the optimized IR code.
echo ""
Expand Down

0 comments on commit 23434fa

Please sign in to comment.