[PATCH 0/6] Complete and add dynamic completion to umr

[PATCH 0/6] Complete and add dynamic completion to umr

[Luben Tuikov]

Complete and add dynamic completion to umr.

Some of the difficulties seen in this work were,

*) slightly different output of sysfs files depending on the system
   configuration and the number of controllers in the system.

*) Merging of the IP Discovery sysfs discovery mechanism.

*) The varied and finicky user input strings.

This work was tested on two different systems with different ASICs,
with three distinct configurations, one of which includes two
different AMD GPU controllers in the same system.

Luben Tuikov (6):
  umr: Rename "scripts/umr" --> "scripts/umr-completion.bash"
  umr: Rename completion function
  umr: Complete umr completion
  umr: Replace and reuse asic.ipblock.reg completion
  umr: Replace and reuse ipblock completion
  umr: Add FILES section to the man page

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>

 doc/umr.1                   |  13 +-
 scripts/umr                 |  83 --------
 scripts/umr-completion.bash | 402 ++++++++++++++++++++++++++++++++++++
 src/app/CMakeLists.txt      |   2 +-
 4 files changed, 414 insertions(+), 86 deletions(-)
 delete mode 100644 scripts/umr
 create mode 100644 scripts/umr-completion.bash


base-commit: d773ac6b1f529c02d8d2021d69e2dcfad736628d
-- 
2.35.1.607.gf01e51a7cf

[PATCH 1/6] umr: Rename "scripts/umr" --> "scripts/umr-completion.bash"

[Luben Tuikov]

Rename to fall in line with completion scripts from other packages,
e.g. Git, however the completion file is still installed as "umr" into
the destination directory.

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 scripts/{umr => umr-completion.bash} | 0
 src/app/CMakeLists.txt               | 2 +-
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename scripts/{umr => umr-completion.bash} (100%)

diff --git a/scripts/umr b/scripts/umr-completion.bash
similarity index 100%
rename from scripts/umr
rename to scripts/umr-completion.bash
diff --git a/src/app/CMakeLists.txt b/src/app/CMakeLists.txt
index 6d15d67e3c021b..5087467d70d6fe 100644
--- a/src/app/CMakeLists.txt
+++ b/src/app/CMakeLists.txt
@@ -77,5 +77,5 @@ endif()
 if(NOT BASH_COMPLETION_FOUND)
 	set(BASH_COMPLETION_COMPLETIONSDIR "/usr/share/bash-completion/completions")
 endif()
-install(FILES ../../scripts/umr DESTINATION ${BASH_COMPLETION_COMPLETIONSDIR})
+install(FILES ../../scripts/umr-completion.bash DESTINATION ${BASH_COMPLETION_COMPLETIONSDIR} RENAME umr)
 install(DIRECTORY ../../database/ DESTINATION ${CMAKE_INSTALL_BINDIR}/../share/umr/database/)
-- 
2.35.1.607.gf01e51a7cf

[PATCH 2/6] umr: Rename completion function

[Luben Tuikov]

Rename the completion function "_umr" to "_umr_completion" to fall in line
with similar completion functions from other packages.

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 scripts/umr-completion.bash | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/scripts/umr-completion.bash b/scripts/umr-completion.bash
index 9cd1fe1e979fb5..79972949b9861e 100644
--- a/scripts/umr-completion.bash
+++ b/scripts/umr-completion.bash
@@ -60,7 +60,7 @@ _comp_regs()
     fi
 }
 
-_umr()
+_umr_completion()
 {
     local cur prev 
 
@@ -79,5 +79,5 @@ _umr()
             ;;
     esac
 }
-complete -F _umr umr
 
+complete -F _umr_completion umr
-- 
2.35.1.607.gf01e51a7cf

[PATCH 3/6] umr: Complete umr completion

[Luben Tuikov]

Complete all commands. Complete all commands' arguments which can be
completed. Data is gathered from files in the UMR_DATABASE_PATH, from the
PCI system and from the /sys filesystem in order to complete the arguments
of commands which require non-open-value argument, i.e. an argument from a
closed set.

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 scripts/umr-completion.bash | 374 ++++++++++++++++++++++++++++++++++--
 1 file changed, 362 insertions(+), 12 deletions(-)

diff --git a/scripts/umr-completion.bash b/scripts/umr-completion.bash
index 79972949b9861e..7029264ca5f725 100644
--- a/scripts/umr-completion.bash
+++ b/scripts/umr-completion.bash
@@ -1,6 +1,22 @@
 # bash completion for umr
+# Copyright (C) Advanced Micro Devices 2022
+#
+# You should set UMR_DATABASE_PATH before sourcing this file in your
+# .bashrc. To source it, do "source <location of this file>"--to see a
+# usual location of this file, see the FILES section in umr(1).
+#
+# I recommend you "set show-all-if-ambiguous On" in your .inputrc, for
+# matches to be listed immediately (on a first TAB key press) as
+# opposed to ring the bell the first time and seeing matches on the
+# second TAB key press. To load the keymap, do "bind -f ~/.inputrc" in
+# your .bashrc, assuming your .inputrc is in your home directory.
 
-_setup()
+if [[ ! -d $UMR_DATABASE_PATH ]]; then
+    echo -n "UMR_DATABASE_PATH must be set for correct operation of umr bash completion."
+    echo " See the FILES section in umr(1)."
+fi
+
+_umr_setup_ips()
 {
     select_gpu=""
     if [ $COMP_CWORD -ge 4 ]; then
@@ -25,9 +41,9 @@ _setup()
     done
 }
 
-_comp_blocks()
+_umr_comp_blocks()
 {
-    _setup
+    _umr_setup_ips
 
     if [ -z "$cur" ]; then
         COMPREPLY=( $(compgen -W "${ips[*]}" -- "$cur") )
@@ -39,9 +55,9 @@ _comp_blocks()
     fi
 }
 
-_comp_regs()
+_umr_comp_regs()
 {
-    _setup
+    _umr_setup_ips
 
     if [[ "$cur" =~ ^[^.]*'.'[^.]*'.'[^.]*$ ]]; then
         cur_asic="${cur%%.*}"
@@ -60,24 +76,358 @@ _comp_regs()
     fi
 }
 
+_umr_comp_option_flags()
+{
+    local FLAGS=(bits bitsfull empty_log follow no_follow_ib use_pci use_colour read_smc quiet no_kernel verbose halt_waves disasm_early_term no_disasm disasm_anyways wave64 full_shader no_fold_vm_decode no_scan_waves)
+    local F G CURR_OPTIONS
+    local ACTIVE_OPTIONS=()
+    local ACTIVE_FLAGS=()
+
+    CURR_OPTIONS="`echo ${COMP_WORDS[*]} | sed -E -e 's/^.*-O[[:space:]]+(.*)$/\1/g'`"
+    CURR_OPTIONS="`echo $CURR_OPTIONS | sed -E -e 's/,/ /g'`"
+
+    # Get rid of user-input partial option string
+    for F in $CURR_OPTIONS ; do
+	if [[ $F == $cur ]] ; then
+	   continue;
+	fi
+	ACTIVE_OPTIONS+=("$F")
+    done
+
+    # Offer only options which are not already part of --option/-O
+    for F in ${FLAGS[*]} ; do
+	for G in ${ACTIVE_OPTIONS[*]} ; do
+	    if [[ $F == $G ]]; then
+		continue 2;
+	    fi
+	done
+	ACTIVE_FLAGS+=($F)
+    done
+
+    # If the user presses TAB again after full completion, as opposed
+    # to say SPACE BAR, then give them comma and the rest of the
+    # flags.
+    COMPREPLY=( $(compgen -W "${ACTIVE_FLAGS[*]}" -- "$cur") )
+    if [[ $cur == ${COMPREPLY[0]} ]] && (( ${#COMPREPLY[*]} == 1 )) && (( ${#ACTIVE_FLAGS[*]} > 1 )) ; then
+	COMPREPLY=( $(compgen -S ',' -W "${ACTIVE_FLAGS[*]}" -- "$cur") )
+    fi
+    # Complete with a space after all options entered.
+    if [[ $cur != ${COMPREPLY[0]} ]] || (( ${#COMPREPLY[*]} != 1 )) || (( ${#ACTIVE_FLAGS[*]} > 1 )) ; then
+	compopt -o nospace
+    fi
+}
+
+_umr_comp_instance()
+{
+    local INSTANCE=(`sudo \ls -1 /sys/kernel/debug/dri/`)
+
+    COMPREPLY=( $(compgen -W "${INSTANCE[*]}" -- "$cur") )
+}
+
+_umr_comp_pci()
+{
+    local PCI_LIST=(`lspci -D | grep VGA | cut -f 1 -d \   | tr '\n' ' '`)
+
+    COMPREPLY=( $(compgen -W "${PCI_LIST[*]}" -- "$cur") )
+}
+
+_umr_comp_prof()
+{
+    local PROFS=( "pixel=" "vertex=" "compute=" )
+
+    COMPREPLY=( $(compgen -W "${PROFS[*]}" -- "$cur") )
+    compopt -o nospace
+}
+
+_umr_comp_ring()
+{
+    local INSTANCE=`echo "$COMP_LINE" | sed -E -e 's/^.*(--instance|-i)[[:space:]]+([0-9]+).*$/\2/g'`
+
+    if [[ ! $INSTANCE =~ ^[0-9]+$ ]]; then
+	# The default instance in umr is 0. See umr(1) under "--instance".
+	INSTANCE=0
+    fi
+
+    local RINGS=( `sudo $(which find) /sys/kernel/debug/dri/$INSTANCE -name amdgpu_ring_* | sed -E -e "s%/sys/kernel/debug/dri/$INSTANCE/amdgpu_ring_%%g"` )
+
+    COMPREPLY=( $(compgen -W "${RINGS[*]}" -- "$cur") )
+}
+
+_umr_comp_clock_scan()
+{
+    local CLOCKS=( `sudo $(which umr) --clock-scan | grep ".*:$" | sed -E -e 's/[: ]//g'` )
+
+    COMPREPLY=( $(compgen -W "${CLOCKS[*]}" -- "$cur") )
+}
+
+_umr_comp_force()
+{
+    local ASIC_NAMES=(`awk '{ print $2; }' $UMR_DATABASE_PATH/pci.did | sed -E -e 's/.asic//g' | sort | uniq`)
+    if [[ $cur =~ ^\..* ]] ; then
+	COMPREPLY=( $(compgen -P '.' -W "${ASIC_NAMES[*]}" -- "${cur#.}") )
+    else
+	COMPREPLY=( $(compgen -W "${ASIC_NAMES[*]}" -- "$cur") )
+    fi
+}
+
+_umr_comp_gpu()
+{
+    local INSTANCE=( `sudo \ls -1 /sys/kernel/debug/dri/` )
+    local PCI_BUS_DIR_NAMES=()
+    local PCI_BUS_IDS=()
+    local -A PCI_BUS_ASIC_NAME
+    local SUGGEST=()
+    local ASIC_NAMES=()
+    local TEMP_ASIC_NAMES=()
+    local INST_ASIC_NAME=()
+    local GPU_NAME
+    local F
+
+    # We need to do it like this, so that this works
+    # when run from non-root shell.
+    for F in ${INSTANCE[*]} ; do
+	PCI_BUS_DIR_NAMES+=("/sys/kernel/debug/dri/$F/name")
+    done
+    PCI_BUS_IDS=( `sudo cat ${PCI_BUS_DIR_NAMES[*]} | sed -E -e 's/^.* (dev=(.*)) .*$/\2/g' | sort | uniq` )
+
+    for F in ${INSTANCE[*]} ; do
+	local PCI_ID=`sudo cat  "/sys/kernel/debug/dri/$F/name" | sed -E -e 's/^.* (dev=(.*)) .*$/\2/g'`
+	local DEV_ID=`cat /sys/class/pci_bus/${PCI_ID%:??.?}/device/$PCI_ID/device`
+	local DEV_ID_NAME=`grep -i $DEV_ID ${UMR_DATABASE_PATH}/pci.did | awk '{ print $2; }' | sed -E -e 's/.asic//g'`
+	TEMP_ASIC_NAMES+=($DEV_ID_NAME)
+	PCI_BUS_ASIC_NAME["$PCI_ID"]="$DEV_ID_NAME"
+	INST_ASIC_NAME["$F"]="$DEV_ID_NAME"
+    done
+    # Remove duplicates
+    ASIC_NAMES=( `(for F in ${TEMP_ASIC_NAMES[*]} ; do echo $F; done) | sort | uniq` )
+
+    if [[ ! $cur =~ .*@.* ]] && [[ ! $cur =~ .*=.* ]]; then
+	COMPREPLY=( $(compgen -W "${ASIC_NAMES[*]}" -- "$cur") )
+	if [[ ${#COMPREPLY[*]} == 1 ]]; then
+	    GPU_NAME=${COMPREPLY[0]}
+	    COMPREPLY=( $(compgen -W "${GPU_NAME}@ ${GPU_NAME}=" -- "$cur") )
+	fi
+	compopt -o nospace
+	return
+    fi
+
+    if [[ $cur =~ .*@.* ]]; then
+	# Find all instances of the selected ASIC name and offer them
+	local INST_OFFER=()
+	GPU_NAME="${cur%%@*}"
+	for F in ${INSTANCE[*]} ; do
+	    if [[ $GPU_NAME == ${INST_ASIC_NAME["$F"]} ]] ; then
+		INST_OFFER+=("$F")
+	    fi
+	done
+	SUGGEST=( $(compgen -P "${GPU_NAME}@" -W "${INST_OFFER[*]}") )
+    elif [[ $cur =~ .*=.* ]]; then
+	# Find all PCI bus IDs of the selected ASIC name and offer them
+	local PCI_ID_OFFER=()
+	GPU_NAME="${cur%%=*}"
+	for F in ${PCI_BUS_IDS[*]} ; do
+	    if [[ $GPU_NAME == ${PCI_BUS_ASIC_NAME["$F"]} ]] ; then
+		PCI_ID_OFFER+=("$F")
+	    fi
+	done
+	SUGGEST=( $(compgen -P "${GPU_NAME}=" -W "${PCI_ID_OFFER[*]}") )
+    fi
+
+    COMPREPLY=( $(compgen -W "${SUGGEST[*]}" -- $cur) )
+}
+
+# Sets GPU_NAME with the name of the GPU given on the command line by
+# --force, --gpu or --instance, or default, and sets up IP_BLOCKS an
+# array of the names of the IP blocks of GPU_NAME.
+#
+_umr_setup_gpu_ipblocks()
+{
+    # The regex we use to match an ASIC name is "[[:alnum:]_]+".
+    local FORCE=`echo "$COMP_LINE" | sed -E -e 's/^.*(--force|-f)[[:space:]]+([[:alnum:]_]+).*$/\2/g'`
+    local GPU=`echo "$COMP_LINE" | sed -E -e  's/^.*(--gpu|-g)[[:space:]]+([[:alnum:]_]+)(@|=)*.*$/\2/g'`
+    local INSTANCE=`echo "$COMP_LINE" | sed -E -e 's/^.*(--instance|-i)[[:space:]]+([0-9]+).*$/\2/g'`
+
+    # GPU_NAME is set only when given by a parameter on the command line.
+    # GPU_NAME2 is always set, even when not specified on the command line.
+    IP_BLOCKS=
+    GPU_NAME=
+    GPU_NAME2=
+    DEFAULT_GPU_NAME=
+
+    if [[ $COMP_LINE =~ (--force|-f) ]]; then
+	GPU_NAME="$FORCE"
+	IP_BLOCKS=( `sudo umr --force $GPU_NAME --list-blocks | sed -E -e "s/^[[:space:]]*${GPU_NAME}\.(.*)[[:space:]]+\(.*$/\1/g"` )
+	GPU_NAME2="$GPU_NAME"
+    elif [[ $COMP_LINE =~ (--gpu|-g) ]]; then
+	GPU_NAME="$GPU"
+	IP_BLOCKS=( `sudo umr --force $GPU_NAME --list-blocks | sed -E -e "s/^[[:space:]]*${GPU_NAME}\.(.*)[[:space:]]+\(.*$/\1/g"` )
+	GPU_NAME2="$GPU_NAME"
+    elif [[ $COMP_LINE =~ (--instance|-i) ]]; then
+	GPU_NAME=`sudo umr --instance $INSTANCE --list-blocks | head -1 | cut -f 1 -d . | sed -E -e 's/[[:space:]]+//g'`
+	IP_BLOCKS=( `sudo umr --instance $INSTANCE --list-blocks | sed -E -e "s/^[[:space:]]*${GPU_NAME}\.(.*) \(.*$/\1/g"` )
+	GPU_NAME2="$GPU_NAME"
+    else
+	GPU_NAME2=`sudo umr --list-blocks | head -1 | cut -f 1 -d . | sed -E -e 's/[[:space:]]+//g'`
+	IP_BLOCKS=( `sudo umr --list-blocks | sed -E -e "s/^[[:space:]]*.*\.(.*) \(.*$/\1/g"` )
+    fi
+
+    DEFAULT_GPU_NAME=`sudo umr --list-blocks | head -1 | cut -f 1 -d . | sed -E -e 's/[[:space:]]+//g'`
+}
+
+_umr_comp_lookup()
+{
+    # Should specify a GPU with --force or --gpu, of even --instance.
+    # The --gpu option also specifies an IP block and is thus
+    # redundant--better use --force.
+    # Specifying a GPU is optional--a default detected
+    # will be used.
+    # The format is --lookup <IP block>.<register> <value>.
+
+    _umr_setup_gpu_ipblocks
+    local REGS
+    local FINAL
+    local F
+
+    if [[ ! $cur =~ .*\. ]]; then
+	COMPREPLY=( $(compgen -S '.' -W "${IP_BLOCKS[*]}" -- $cur) )
+	compopt -o nospace
+    else
+	# Complete a register for the given IP block.
+	# See _umr_comp_asic_ipblock_registers() below.
+	F="${cur%.*}"
+	if [[ -z $GPU_NAME ]] || [[ $GPU_NAME == $DEFAULT_GPU_NAME ]] ; then
+	    REGS=( `sudo umr --list-regs ${F} | sed -E -e "s/(.*)\.(.*)\.(.*)[[:space:]]+\(.*$/\3/g"` )
+	else
+	    REGS=( `sudo umr --force $GPU_NAME --list-regs ${F%\{*} | sed -E -e "s/${GPU_NAME}\.(.*)\.(.*)[[:space:]]+\(.*$/\2/g"` )
+	    if (( ${#REGS[*]} == 0 )); then
+		REGS=( `sudo umr --force $GPU_NAME --list-regs ${F} | sed -E -e "s/${GPU_NAME}\.(.*)\.(.*)[[:space:]]+\(.*$/\2/g"` )
+	    fi
+	fi
+	FINAL=( $(compgen -P "${F}." -W "${REGS[*]}") )
+	COMPREPLY=( $(compgen -W "${FINAL[*]}" -- "$cur") )
+    fi
+
+    unset GPU_NAME GPU_NAME2 DEFAULT_GPU_NAME IP_BLOCKS
+}
+
+_umr_comp_asic_ipblock_registers()
+{
+    # The format is --writebit asic.ipblock.regname,
+    # the same as that of --write and --read.
+
+    _umr_setup_gpu_ipblocks
+    local ips=()
+    local FINAL=()
+    local REGS=()
+    local F
+
+    ips=( $(compgen -P "${GPU_NAME2}." -W "${IP_BLOCKS[*]}") )
+
+    if [[ ! $cur =~ ${GPU_NAME2}\..*\. ]]; then
+       COMPREPLY=( $(compgen -S '.' -W "${ips[*]}" -- $cur) )
+       compopt -o nospace
+    else
+	# cur = asic.ipblock.*
+	#
+	# When using --force with the default (installed in the
+	# system) ASIC and --list-regs together, --list-regs does not
+	# take instance numbers, so to pass an instance number, we
+	# need to know if the GPU was forced on the command line.
+	# First however, get rid of user hints.
+	F="${cur%.*}"
+	if [[ -z $GPU_NAME ]] || [[ $GPU_NAME == $DEFAULT_GPU_NAME ]] ; then
+	    REGS=( `sudo umr --list-regs ${F} | sed -E -e "s/(.*)\.(.*)\.(.*)[[:space:]]+\(.*$/\3/g"` )
+	else
+	    REGS=( `sudo umr --force $GPU_NAME --list-regs ${F%\{*} | sed -E -e "s/${GPU_NAME}\.(.*)\.(.*)[[:space:]]+\(.*$/\2/g"` )
+	    if (( ${#REGS[*]} == 0 )); then
+		REGS=( `sudo umr --force $GPU_NAME --list-regs ${F} | sed -E -e "s/${GPU_NAME}\.(.*)\.(.*)[[:space:]]+\(.*$/\2/g"` )
+	    fi
+	fi
+	# Cannot combine the compgen since a match is performed
+	# _before_ the prefix is applied! And if we want to match,
+	# we need to tack the prefix prior to asking for a match.
+	FINAL=( $(compgen -P "${F}." -W "${REGS[*]}") )
+	COMPREPLY=( $(compgen -W "${FINAL[*]}" -- $cur) )
+    fi
+
+    unset GPU_NAME GPU_NAME2 DEFAULT_GPU_NAME IP_BLOCKS
+}
+
+_umr_comp_ring_stream()
+{
+    _umr_comp_ring
+    compopt -o nospace
+}
+
 _umr_completion()
 {
-    local cur prev 
+    local ALL_LONG_ARGS=(--database-path --option --gpu --instance --force --pci --gfxoff --vm_partition --bank --sbank --cbank --config --enumerate --list-blocks --list-regs --dump-discovery-table --lookup --write --writebit --read --scan --logscan --top --waves --profiler --vm-decode --vm-read --vm-write --vm-write-word --vm-disasm --ring-stream --dump-ib --dump-ib-file --header-dump --power --clock-scan --clock-manual --clock-high --clock-low --clock-auto --ppt_read --gpu_metrics --power --vbios_info --test-log --test-harness --server --gui)
+
+    local cur prev
+
+    COMP_WORDBREAKS=" ,"
 
     COMPREPLY=()
-    cur=${COMP_WORDS[COMP_CWORD]}
-    prev=${COMP_WORDS[COMP_CWORD-1]}
+    cur=$2
+    prev=$3
 
     case $prev in
+	--database-path|--dbp)
+	    compopt -o default -o dirnames
+	    ;;
+	--option|-O|bits|bitsfull|empty_log|follow|no_follow_ib|use_pci|use_colour|read_smc|quiet|no_kernel|verbose|halt_waves|disasm_early_term|no_disasm|disasm_anyways|wave64|full_shader|no_fold_vm_decode|no_scan_waves|,)
+	    _umr_comp_option_flags
+	    ;;
+	--force|-f)
+	    _umr_comp_force
+	    ;;
+	--gpu|-g)
+	    _umr_comp_gpu
+	    ;;
+	--instance|-i)
+	    _umr_comp_instance
+	    ;;
+	--pci)
+	    _umr_comp_pci
+	    ;;
+	--gfxoff|-go)
+	    COMPREPLY=( $(compgen -W "0 1" -- "$cur") )
+	    ;;
         -lr|--list-regs|-s|--scan)
-            _comp_blocks
-            return 0
+            _umr_comp_blocks
             ;;
         -r|--read|-w|--write)
-            _comp_regs
-            return 0
+            _umr_comp_regs
             ;;
+	--lookup|-lu)
+	    _umr_comp_lookup
+	    ;;
+	--writebit|-wb)
+	    _umr_comp_asic_ipblock_registers
+	    ;;
+	--waves|-wa)
+	    _umr_comp_ring
+	    ;;
+	--profiler|-prof)
+	    _umr_comp_prof
+	    ;;
+	pixel=*|vertex=*|compute=*)
+	    _umr_comp_ring
+	    ;;
+	--dump-ib-file|-df|--test-log|-tl|--test-harness|-th)
+	    compopt -o default -o filenames
+	    ;;
+	--clock-scan|-cs|--clock-manual|-cm)
+	    _umr_comp_clock_scan
+	    ;;
+	--ring-stream|-RS)
+	    _umr_comp_ring_stream
+	    ;;
+	*)
+	    COMPREPLY=( $(compgen -W "${ALL_LONG_ARGS[*]}" -- $cur) )
+	    ;;
     esac
+    return 0
 }
 
 complete -F _umr_completion umr
-- 
2.35.1.607.gf01e51a7cf

[PATCH 4/6] umr: Replace and reuse asic.ipblock.reg completion

[Luben Tuikov]

Replace and reuse asic.ipblock.reg completion.

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 scripts/umr-completion.bash | 26 +-------------------------
 1 file changed, 1 insertion(+), 25 deletions(-)

diff --git a/scripts/umr-completion.bash b/scripts/umr-completion.bash
index 7029264ca5f725..ab1637a090e5d6 100644
--- a/scripts/umr-completion.bash
+++ b/scripts/umr-completion.bash
@@ -55,27 +55,6 @@ _umr_comp_blocks()
     fi
 }
 
-_umr_comp_regs()
-{
-    _umr_setup_ips
-
-    if [[ "$cur" =~ ^[^.]*'.'[^.]*'.'[^.]*$ ]]; then
-        cur_asic="${cur%%.*}"
-        substr="${cur#*.}"
-        cur_ip="${substr%.*}"
-        if [[ "${ip_names[@]}" =~ "$cur_ip" ]] && [[ $cur_asic = $asicname || $cur_asic = "*" ]]; then
-            reg_names=( $(sudo $(which umr) $select_gpu -lr $asicname.$cur_ip | grep -o "$asicname\.$cur_ip\.\w\+") )
-            COMPREPLY=( $(compgen -W "${reg_names[*]/$asicname/$cur_asic}" -- "$cur") )
-        fi
-    elif [ -n "$cur" ]; then
-        local array=( "${ips[@]}" "${ip_names[@]/#/*.}" )
-        COMPREPLY=( $(compgen -W "${array[*]/%/.}" -- "$cur") )
-        compopt -o nospace
-    else
-        COMPREPLY=( $(compgen -W "${ips[*]/%/.}" -- "$cur") )
-    fi
-}
-
 _umr_comp_option_flags()
 {
     local FLAGS=(bits bitsfull empty_log follow no_follow_ib use_pci use_colour read_smc quiet no_kernel verbose halt_waves disasm_early_term no_disasm disasm_anyways wave64 full_shader no_fold_vm_decode no_scan_waves)
@@ -396,13 +375,10 @@ _umr_completion()
         -lr|--list-regs|-s|--scan)
             _umr_comp_blocks
             ;;
-        -r|--read|-w|--write)
-            _umr_comp_regs
-            ;;
 	--lookup|-lu)
 	    _umr_comp_lookup
 	    ;;
-	--writebit|-wb)
+	-r|--read|-w|--write|--writebit|-wb)
 	    _umr_comp_asic_ipblock_registers
 	    ;;
 	--waves|-wa)
-- 
2.35.1.607.gf01e51a7cf

[PATCH 5/6] umr: Replace and reuse ipblock completion

[Luben Tuikov]

Replace and reuse ip block completion.

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 scripts/umr-completion.bash | 73 +++++++++++++++++--------------------
 1 file changed, 33 insertions(+), 40 deletions(-)

diff --git a/scripts/umr-completion.bash b/scripts/umr-completion.bash
index ab1637a090e5d6..0e1444357c82a9 100644
--- a/scripts/umr-completion.bash
+++ b/scripts/umr-completion.bash
@@ -16,45 +16,6 @@ if [[ ! -d $UMR_DATABASE_PATH ]]; then
     echo " See the FILES section in umr(1)."
 fi
 
-_umr_setup_ips()
-{
-    select_gpu=""
-    if [ $COMP_CWORD -ge 4 ]; then
-        for i in ${!COMP_WORDS[@]}; do
-            if [[ ${COMP_WORDS[$i]} = "--gpu" ]] ||
-                [[ ${COMP_WORDS[$i]} = "-g" ]] ||
-                [[ ${COMP_WORDS[$i]} = "--instance" ]] ||
-                [[ ${COMP_WORDS[$i]} = "-i" ]]; then
-                select_gpu=${COMP_WORDS[$i]}" "${COMP_WORDS[$i+1]}
-                break
-            fi
-        done
-    fi
-
-    ips=( $( sudo $(which umr) $select_gpu -lb ) )
-    asicname=${ips%%.*}
-    unset ip_names
-    for ip in ${ips[@]}
-    do
-        ipname=${ip#*.}
-        ip_names+=($ipname)
-    done
-}
-
-_umr_comp_blocks()
-{
-    _umr_setup_ips
-
-    if [ -z "$cur" ]; then
-        COMPREPLY=( $(compgen -W "${ips[*]}" -- "$cur") )
-    fi
-
-    if [ -n "$cur" ]; then
-        local array=( "${ips[@]}" "${ip_names[@]}" "${ip_names[@]/#/*.}" )
-        COMPREPLY=( $(compgen -W "${array[*]}" -- "$cur") )
-    fi
-}
-
 _umr_comp_option_flags()
 {
     local FLAGS=(bits bitsfull empty_log follow no_follow_ib use_pci use_colour read_smc quiet no_kernel verbose halt_waves disasm_early_term no_disasm disasm_anyways wave64 full_shader no_fold_vm_decode no_scan_waves)
@@ -289,6 +250,38 @@ _umr_comp_lookup()
     unset GPU_NAME GPU_NAME2 DEFAULT_GPU_NAME IP_BLOCKS
 }
 
+_umr_comp_ipblock()
+{
+    # Handle --list-regs and --scan, using the --scan model
+
+    _umr_setup_gpu_ipblocks
+
+    # If compline specifes a GPU, then complete a block of that GPU;
+    # else complete all GPUs and the current GPU's blocks in one list.
+
+    if [[ $COMP_LINE =~ (--force|-f|--gpu|-g|--instance|-i) ]] ; then
+	COMPREPLY=( $(compgen -W "${IP_BLOCKS[*]}" -- "$cur") )
+    elif [[ $cur =~ .*\..* ]] ; then
+	# The ASIC here is the default one recommended in the "else"
+	# case below.  Because of this, we don't use "--force" with
+	# "--list-block" and so also get the instance numbers of the
+	# blocks. Then we combine that with the ASIC and offer it as
+	# completion. See _umr_comp_asic_ipblock_registers() below.
+	local asic=${cur%%.*}
+	local blocks=( `sudo umr --list-blocks | sed -E -e "s/^[[:space:]]*.*\.(.*) \(.*$/\1/g"` )
+	local F=( $(compgen -P "${asic}." -W "${blocks[*]}") )
+	COMPREPLY=( $(compgen -W "${F[*]}" -- "$cur") )
+    else
+	COMPREPLY=( $(compgen -W "${DEFAULT_GPU_NAME}. ${IP_BLOCKS[*]}" -- "$cur") )
+	# This uses the zero element
+	if [[ $COMPREPLY =~ .*\. ]] ; then
+	    compopt -o nospace
+	fi
+    fi
+
+    unset GPU_NAME GPU_NAME2 DEFAULT_GPU_NAME IP_BLOCKS
+}
+
 _umr_comp_asic_ipblock_registers()
 {
     # The format is --writebit asic.ipblock.regname,
@@ -373,7 +366,7 @@ _umr_completion()
 	    COMPREPLY=( $(compgen -W "0 1" -- "$cur") )
 	    ;;
         -lr|--list-regs|-s|--scan)
-            _umr_comp_blocks
+            _umr_comp_ipblock
             ;;
 	--lookup|-lu)
 	    _umr_comp_lookup
-- 
2.35.1.607.gf01e51a7cf

[PATCH 6/6] umr: Add FILES section to the man page

[Luben Tuikov]

Add FILES section to the man page with entries the completion file and the
umr database tree root.

Reword the entry of the UMR_DATABASE_PATH to make it clearer that the user
should set this up.

Update the man page's copyright year and month.

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Signed-off-by: Luben Tuikov <luben.tuikov@amd.com>
---
 doc/umr.1 | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/doc/umr.1 b/doc/umr.1
index 575b522ad22e78..62eea7db320b88 100644
--- a/doc/umr.1
+++ b/doc/umr.1
@@ -1,4 +1,4 @@
-.TH UMR 1 "January 2020" "AMD (c) 2020" "User Manuals"
+.TH UMR 1 "February 2022" "AMD (c) 2022" "User Manuals"
 .SH NAME
 umr \- AMDGPU Userspace Register Debugger
 .SH DESCRIPTION
@@ -306,4 +306,13 @@ GPU hangs occur frequently.  When PG is enabled it will read a constant 0.
     Directory to output "umr.log" file when capturing samples with the --top command.
 
 .B UMR_DATABASE_PATH
-    Directory start of database tree used for register, ip, and asic model data.
+    Should be set to the top directory of the database tree used for register, IP, and ASIC model data.
+
+.SH FILES
+.B ${CMAKE_INSTALL_PREFIX}/share/bash-completion/completions/umr
+contains completion for bash shells. You'd normally source this file in your ~/.bashrc.
+
+.B ${CMAKE_INSTALL_PREFIX}/share/umr/database
+contains database files for ASICs, IPs, and registers.
+.B UMR_DATABASE_PATH
+is usually set to point to here.
-- 
2.35.1.607.gf01e51a7cf

Re: [PATCH 0/6] Complete and add dynamic completion to umr

[StDenis, Tom]

[AMD Official Use Only]

Thanks Luben, I've added my Rb and pushed out the series to main.

Cheers,
Tom

________________________________________
From: Tuikov, Luben <Luben.Tuikov@amd.com>
Sent: Wednesday, March 23, 2022 07:48
To: amd-gfx@lists.freedesktop.org
Cc: Tuikov, Luben; Deucher, Alexander; Pelloux-Prayer, Pierre-Eric; StDenis, Tom; Koenig, Christian
Subject: [PATCH 0/6] Complete and add dynamic completion to umr

Complete and add dynamic completion to umr.

Some of the difficulties seen in this work were,

*) slightly different output of sysfs files depending on the system
   configuration and the number of controllers in the system.

*) Merging of the IP Discovery sysfs discovery mechanism.

*) The varied and finicky user input strings.

This work was tested on two different systems with different ASICs,
with three distinct configurations, one of which includes two
different AMD GPU controllers in the same system.

Luben Tuikov (6):
  umr: Rename "scripts/umr" --> "scripts/umr-completion.bash"
  umr: Rename completion function
  umr: Complete umr completion
  umr: Replace and reuse asic.ipblock.reg completion
  umr: Replace and reuse ipblock completion
  umr: Add FILES section to the man page

Cc: Alex Deucher <Alexander.Deucher@amd.com>
Cc: Pierre-Eric Pelloux-Prayer <pierre-eric.pelloux-prayer@amd.com>
Cc: Tom StDenis <tom.stdenis@amd.com>
Cc: Christian König <christian.koenig@amd.com>

 doc/umr.1                   |  13 +-
 scripts/umr                 |  83 --------
 scripts/umr-completion.bash | 402 ++++++++++++++++++++++++++++++++++++
 src/app/CMakeLists.txt      |   2 +-
 4 files changed, 414 insertions(+), 86 deletions(-)
 delete mode 100644 scripts/umr
 create mode 100644 scripts/umr-completion.bash


base-commit: d773ac6b1f529c02d8d2021d69e2dcfad736628d
--
2.35.1.607.gf01e51a7cf