Add shellcheck beyond perf/tests
Ian Rogers
reviewercover Add shellcheck beyond perf/tests
Add shellcheck to other locations of shell scripts, not just tools/perf/tests. Fix issues detected by shellcheck.
Ian Rogers (4):
perf build: Add shellcheck to tools/perf scripts perf arch x86: Add shellcheck to build perf util: Add shellcheck to generate-cmdlist.sh perf trace beauty: Add shellcheck to scripts
tools/perf/Build | 14 +++++++++++ tools/perf/arch/x86/Build | 14 +++++++++++ tools/perf/arch/x86/tests/Build | 14 +++++++++++ tools/perf/arch/x86/tests/gen-insn-x86-dat.sh | 2 +- tools/perf/perf-archive.sh | 2 +- tools/perf/perf-completion.sh | 23 +++++++++++++------ tools/perf/trace/beauty/Build | 14 +++++++++++ tools/perf/trace/beauty/arch_errno_names.sh | 8 ++++--- tools/perf/util/Build | 14 +++++++++++ 9 files changed, 93 insertions(+), 12 deletions(-)
Signature · 1 line
2.44.0.478.gd926399ef9-goog
Ian Rogers
reviewerPATCH 1/4 perf build: Add shellcheck to tools/perf scripts
Address shell check errors/warnings in perf-archive.sh and perf-completion.sh.
--- tools/perf/Build | 14 ++++++++++++++ tools/perf/perf-archive.sh | 2 +- tools/perf/perf-completion.sh | 23 ++++++++++++++++------- 3 files changed, 31 insertions(+), 8 deletions(-)
tools/perf/Build +14 -0
@@ -59,3 +59,17 @@ perf-y += ui/ perf-y += scripts/ gtk-y += ui/gtk/ + +ifdef SHELLCHECK + SHELL_TESTS := $(wildcard *.sh) + TEST_LOGS := $(SHELL_TESTS:%=%.shellcheck_log) +else + SHELL_TESTS := + TEST_LOGS := +endif + +$(OUTPUT)%.shellcheck_log: % + $(call rule_mkdir) + $(Q)$(call echo-cmd,test)shellcheck -s bash -a -S warning "$<" > $@ || (cat $@ && rm $@ && false) + +perf-y += $(TEST_LOGS)
tools/perf/perf-archive.sh +1 -1
@@ -34,7 +34,7 @@ if [ $UNPACK -eq 1 ]; then TARGET=`find . -regex "\./perf.*\.tar\.bz2"` TARGET_NUM=`echo -n "$TARGET" | grep -c '^'` - if [ -z "$TARGET" -o $TARGET_NUM -gt 1 ]; then + if [ -z "$TARGET" ] || [ $TARGET_NUM -gt 1 ]; then echo -e "Error: $TARGET_NUM files found for unpacking:\n$TARGET" echo "Provide the requested file as an argument" exit 1
tools/perf/perf-completion.sh +16 -7
@@ -108,6 +108,8 @@ __perf__ltrim_colon_completions() __perfcomp () { + # Expansion of spaces to array is deliberate. + # shellcheck disable=SC2207 COMPREPLY=( $( compgen -W "$1" -- "$2" ) ) }
@@ -127,13 +129,13 @@ __perf_prev_skip_opts () let i=cword-1 cmds_=$($cmd $1 --list-cmds) - prev_skip_opts=() + prev_skip_opts="" while [ $i -ge 0 ]; do - if [[ ${words[i]} == $1 ]]; then + if [[ ${words[i]} == "$1" ]]; then return fi for cmd_ in $cmds_; do - if [[ ${words[i]} == $cmd_ ]]; then + if [[ ${words[i]} == "$cmd_" ]]; then prev_skip_opts=${words[i]} return fi
@@ -164,9 +166,10 @@ __perf_main () $prev_skip_opts == @(record|stat|top) ]]; then local cur1=${COMP_WORDS[COMP_CWORD]} - local raw_evts=$($cmd list --raw-dump hw sw cache tracepoint pmu sdt) + local raw_evts local arr s tmp result cpu_evts + raw_evts=$($cmd list --raw-dump hw sw cache tracepoint pmu sdt) # aarch64 doesn't have /sys/bus/event_source/devices/cpu/events if [[ `uname -m` != aarch64 ]]; then cpu_evts=$(ls /sys/bus/event_source/devices/cpu/events)
@@ -175,10 +178,12 @@ __perf_main () if [[ "$cur1" == */* && ${cur1#*/} =~ ^[A-Z] ]]; then OLD_IFS="$IFS" IFS=" " + # Expansion of spaces to array is deliberate. + # shellcheck disable=SC2206 arr=($raw_evts) IFS="$OLD_IFS" - for s in ${arr[@]} + for s in "${arr[@]}" do if [[ "$s" == *cpu/* ]]; then tmp=${s#*cpu/}
@@ -200,11 +205,13 @@ __perf_main () fi elif [[ $prev == @("--pfm-events") && $prev_skip_opts == @(record|stat|top) ]]; then - local evts=$($cmd list --raw-dump pfm) + local evts + evts=$($cmd list --raw-dump pfm) __perfcomp "$evts" "$cur" elif [[ $prev == @("-M"|"--metrics") && $prev_skip_opts == @(stat) ]]; then - local metrics=$($cmd list --raw-dump metric metricgroup) + local metrics + metrics=$($cmd list --raw-dump metric metricgroup) __perfcomp "$metrics" "$cur" else # List subcommands for perf commands
@@ -278,6 +285,8 @@ if [[ -n ${ZSH_VERSION-} ]]; then let cword=CURRENT-1 emulate ksh -c __perf_main let _ret && _default && _ret=0 + # _ret is only assigned 0 or 1, disable inaccurate analysis. + # shellcheck disable=SC2152 return _ret }
Signature · 1 line
2.44.0.478.gd926399ef9-goog
Ian Rogers
reviewerPATCH 2/4 perf arch x86: Add shellcheck to build
In reply to Ian RogersAdd shellcheck for:tools/perf/arch/x86/tests/gen-insn-x86-dat.shtools/perf/arch/x86/entry/syscalls/syscalltbl.sh
Address a minor quoting issue.
--- tools/perf/arch/x86/Build | 14 ++++++++++++++ tools/perf/arch/x86/tests/Build | 14 ++++++++++++++ tools/perf/arch/x86/tests/gen-insn-x86-dat.sh | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-)
tools/perf/arch/x86/Build +14 -0
@@ -1,2 +1,16 @@ perf-y += util/ perf-y += tests/ + +ifdef SHELLCHECK + SHELL_TESTS := entry/syscalls/syscalltbl.sh + TEST_LOGS := $(SHELL_TESTS:%=%.shellcheck_log) +else + SHELL_TESTS := + TEST_LOGS := +endif + +$(OUTPUT)%.shellcheck_log: % + $(call rule_mkdir) + $(Q)$(call echo-cmd,test)shellcheck -a -S warning "$<" > $@ || (cat $@ && rm $@ && false) + +perf-y += $(TEST_LOGS)
tools/perf/arch/x86/tests/Build +14 -0
@@ -10,3 +10,17 @@ perf-$(CONFIG_AUXTRACE) += insn-x86.o endif perf-$(CONFIG_X86_64) += bp-modify.o perf-y += amd-ibs-via-core-pmu.o + +ifdef SHELLCHECK + SHELL_TESTS := gen-insn-x86-dat.sh + TEST_LOGS := $(SHELL_TESTS:%=%.shellcheck_log) +else + SHELL_TESTS := + TEST_LOGS := +endif + +$(OUTPUT)%.shellcheck_log: % + $(call rule_mkdir) + $(Q)$(call echo-cmd,test)shellcheck -a -S warning "$<" > $@ || (cat $@ && rm $@ && false) + +perf-y += $(TEST_LOGS)
tools/perf/arch/x86/tests/gen-insn-x86-dat.sh +1 -1
@@ -11,7 +11,7 @@ if [ "$(uname -m)" != "x86_64" ]; then exit 1 fi -cd $(dirname $0) +cd "$(dirname $0)" trap 'echo "Might need a more recent version of binutils"' EXIT
Signature · 1 line
2.44.0.478.gd926399ef9-goog
Ian Rogers
reviewerPATCH 3/4 perf util: Add shellcheck to generate-cmdlist.sh
In reply to Ian RogersAdd shellcheck to generate-cmdlist.sh to avoid basic shell script mistakes.
--- tools/perf/util/Build | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
tools/perf/util/Build +14 -0
@@ -389,3 +389,17 @@ $(OUTPUT)util/vsprintf.o: ../lib/vsprintf.c FORCE $(OUTPUT)util/list_sort.o: ../lib/list_sort.c FORCE $(call rule_mkdir) $(call if_changed_dep,cc_o_c) + +ifdef SHELLCHECK + SHELL_TESTS := generate-cmdlist.sh + TEST_LOGS := $(SHELL_TESTS:%=%.shellcheck_log) +else + SHELL_TESTS := + TEST_LOGS := +endif + +$(OUTPUT)%.shellcheck_log: % + $(call rule_mkdir) + $(Q)$(call echo-cmd,test)shellcheck -a -S warning "$<" > $@ || (cat $@ && rm $@ && false) + +perf-y += $(TEST_LOGS)
Signature · 1 line
2.44.0.478.gd926399ef9-goog
Ian Rogers
reviewerPATCH 4/4 perf trace beauty: Add shellcheck to scripts
In reply to Ian RogersAdd shell check to scripts generating perf trace lookup tables. Fix quoting issue in arch_errno_names.sh.
--- tools/perf/trace/beauty/Build | 14 ++++++++++++++ tools/perf/trace/beauty/arch_errno_names.sh | 8 +++++--- 2 files changed, 19 insertions(+), 3 deletions(-)
tools/perf/trace/beauty/Build +14 -0
@@ -20,3 +20,17 @@ perf-y += statx.o perf-y += sync_file_range.o perf-y += timespec.o perf-y += tracepoints/ + +ifdef SHELLCHECK + SHELL_TESTS := $(wildcard trace/beauty/*.sh) + TEST_LOGS := $(SHELL_TESTS:trace/beauty/%=%.shellcheck_log) +else + SHELL_TESTS := + TEST_LOGS := +endif + +$(OUTPUT)%.shellcheck_log: % + $(call rule_mkdir) + $(Q)$(call echo-cmd,test)shellcheck -s bash -a -S warning "$<" > $@ || (cat $@ && rm $@ && false) + +perf-y += $(TEST_LOGS)
tools/perf/trace/beauty/arch_errno_names.sh +5 -3
@@ -60,10 +60,12 @@ create_arch_errno_table_func() printf 'arch_syscalls__strerrno_t *arch_syscalls__strerrno_function(const char *arch)\n' printf '{\n' for arch in $archlist; do - printf '\tif (!strcmp(arch, "%s"))\n' $(arch_string "$arch") - printf '\t\treturn errno_to_name__%s;\n' $(arch_string "$arch") + arch_str=$(arch_string "$arch") + printf '\tif (!strcmp(arch, "%s"))\n' "$arch_str" + printf '\t\treturn errno_to_name__%s;\n' "$arch_str" done - printf '\treturn errno_to_name__%s;\n' $(arch_string "$default") + arch_str=$(arch_string "$default") + printf '\treturn errno_to_name__%s;\n' "$arch_str" printf '}\n' }
Signature · 1 line
2.44.0.478.gd926399ef9-goog
Quoted 9 lines · Ian Rogers
Add shellcheck to other locations of shell scripts, not just
tools/perf/tests. Fix issues detected by shellcheck.Ian Rogers (4):
perf build: Add shellcheck totools/perfscripts perf arch x86: Add shellcheck to build perf util: Add shellcheck togenerate-cmdlist.shperf trace beauty: Add shellcheck to scripts
Quoted 11 lines
tools/perf/Build | 14 +++++++++++ tools/perf/arch/x86/Build | 14 +++++++++++ tools/perf/arch/x86/tests/Build | 14 +++++++++++ tools/perf/arch/x86/tests/gen-insn-x86-dat.sh | 2 +- tools/perf/perf-archive.sh | 2 +- tools/perf/perf-completion.sh | 23 +++++++++++++------ tools/perf/trace/beauty/Build | 14 +++++++++++ tools/perf/trace/beauty/arch_errno_names.sh | 8 ++++--- tools/perf/util/Build | 14 +++++++++++ 9 files changed, 93 insertions(+), 12 deletions(-)
Quoted 24 lines · James Clark
Quoted 9 lines · Ian Rogers
Add shellcheck to other locations of shell scripts, not just
tools/perf/tests. Fix issues detected by shellcheck.Ian Rogers (4):
perf build: Add shellcheck totools/perfscripts perf arch x86: Add shellcheck to build perf util: Add shellcheck togenerate-cmdlist.shperf trace beauty: Add shellcheck to scriptsQuoted 11 lines
tools/perf/Build | 14 +++++++++++ tools/perf/arch/x86/Build | 14 +++++++++++ tools/perf/arch/x86/tests/Build | 14 +++++++++++ tools/perf/arch/x86/tests/gen-insn-x86-dat.sh | 2 +- tools/perf/perf-archive.sh | 2 +- tools/perf/perf-completion.sh | 23 +++++++++++++------ tools/perf/trace/beauty/Build | 14 +++++++++++ tools/perf/trace/beauty/arch_errno_names.sh | 8 ++++--- tools/perf/util/Build | 14 +++++++++++ 9 files changed, 93 insertions(+), 12 deletions(-)
Quoted 1 line
Reviewed-by James Clark <[email protected]>
Thanks, applied to perf-tools-next.
- Arnaldo