* [PATCH v9 01/39] selftests/dyndbg: Add kselftest script to verify dynamic-debug
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
@ 2026-09-09 0:54 ` Jim Cromie via B4 Relay
2026-09-09 0:54 ` [PATCH v9 02/39] vmlinux.lds.h: refactor BOUNDED_SECTION_* macros into bounded_sections.lds.h Jim Cromie via B4 Relay
` (37 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:54 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Add a kselftest script to attempt full validation of dynamic-debug
behavior. The script tests query grammar as documented, responses to
bad input, and proper/expected effects on both the control-file
display of current state, and on pr_debug logging behavior.
NOTE: This script was finished last, then rebased to front; It gives
an easy functional test thru the series, not just a does-it-boot. It
preserves but disables some tests to pass as a baseline; there are 3
Basics: FT_grammar_ok(), FT_grammar_errs(), FT_basic_queries().
The Canonical Test:
A naive dyndbg test might look like:
echo "module main +mfp" > /proc/dynamic_debug/control
local ct=$(grep -c " =pmf " /proc/dynamic_debug/control)
(( $ct == $expected)) || FAIL
But you'll find that you've changed 4 different modules, and your
count is off. Ad-hoc testing is hard, and fundamentally trades
test clarity against thoroughness, precision and brittleness.
Here, the canonical test tries harder:
1. Observe the prior dyndbg state-of-interest.
2. Send $cmd to change state-of-interest.
a: echo $cmd > control
b: echo 1 > "/sys/module/test_dynamic_debug/parameters/do_classes"
3. Observe the results, in control-file or dmesg
The key here is 'observe' means `md5sum $state-of-interest`. This
gives us total "checksum" precision, and with a little care,
$state-of-interest mostly solves the brittleness.
If a test should cause logging:
1. Sends a unique 'START_of_label' message directly to syslog/dmesg.
2. Sends the command or parameter configuration, as in b: above.
3. Sends a unique 'END_of_label' message directly to syslog/dmesg.
4. read dmesg, extract START..END
This bookended logging allows the script to isolate and reliably
extract the precise dmesg/syslog slice between the markers, and
fingerprint the state-of-interest cryptographically. Its not truly
isolated from busy-kernel messages, unless its a test-vm.
Comprehensive Feature Test (FT_*) Script Mapping:
The Feature Test (FT_*) functions test major aspects of dynamic-debug,
they're in 3 categories:
1: Zero-Dependency Grammar & Core Parser Tests
These tests throw legal & illegal commands at the >control file, but
don't attempt to select any real pr_debug callsite.
* FT_grammar_ok:
Verifies successful query grammar parses (exact line, open line
range, closed line range, and colon-delimited file:line/file:func
syntax) using side-effect-free empty placeholder flags ('+_').
* FT_grammar_errs:
Verifies core query parser error-handling and EINVAL paths across
multiple verbosity levels (0..3), catching even minor message drift.
2: Built-in Feature & Name Equivalence Tests (Kernel Core)
These tests verify the core features compiled directly into the kernel
image. They validate "[main]" vs "[init/main]" resolution added recently.
* FT_basic_queries:
Verifies basic, direct queries (module, func, format, and clear flags
'=_') targeting the builtin kernel/params engine.
These tests are disabled until KBUILD_MODFILE:
* FT_path_module_queries: Verifies path-based and wildcard module
query controls (such as module 'init/main', module '*/main')
targeting builtin startup callsites. This specifically validates the
back-compat resolution of the old 'module main' ambiguity (which
selects 5-6 different built-in modules).
* FT_hyphen_underscore:
Verifies literal name versus kbasename hyphen/underscore equivalence
(e.g., kvm_intel vs. kvm-intel), proving that both queries select
identical ranges-of-interest. This validates recent kernel fixes
establishing name-normalization equivalence inside the query engine,
ensuring that character substitutions work as they do in modprobe.
3: Tests which require test_dynamic_debug
These tests verify complex classmap configurations, multi-module
setups, and load-time/runtime parameter callback equivalence.
* FT_test_classes:
Verifies classmap-based query enablers and class configurations on a
modular target, proving dynamic runtime class configurations via
/proc/dynamic_debug/control.
* FT_classmap_inheritance:
Verifies multi-module classmap propagation and class inheritance
checks between a parent and submodule sharing a classmap. This
actively demonstrates a key systems distinction: one-time bare class
queries (dyndbg=class...) do NOT inherit at load-time, whereas
classmap module parameters (p_disjoint_bits, p_level_num) are
persistent and successfully propagate state to submodules upon loading.
These tests recapitulate the scenario where classmaps-v1 [1] hit
regressions and was marked BROKEN.
* FT_modprobe_w_param:
Verifies load-time parameter callback initialization (via modprobe
$param=$val) and subsequent runtime sysfs-write unsetting callbacks
sequentially, by looping over verbose levels, and varying
(p_disjoint_bits, p_level_num) and (do_classes, do_bulk).
NB: within each FT_, tests are numbered and cataloged. This isolates
each FT_* test's sequence numbers from each other.
Main Test Runner (dyndbg_selftest.sh) Support Functions:
* ddcmd("$query", ["$range"], ["$action"]):
The core test primitive. Writes a query string to the control file.
- ["$range"]: Optional slice filter pattern (triggers transition
verification R1 on non-empty values).
- ["$action"]: Expected outcome action ('pass' default, 'fail' asserts
return code 1 and logs dmesg, 'log' asserts 0 and logs dmesg).
* ddcmd_err("$query"):
Semantic error query wrapper. Invokes ddcmd expected to fail.
* ddcmd_load("$query", "$range", "$param_path", "$val"):
Workload-driven syslog verification helper.
- "$param_path": Sysfs parameter path of workload trigger.
- "$val": Integer trigger value written to workload param.
* verify_modprobe_param_logging("$param", "$val", "$tag"):
Dynamic parameter test primitive. Coordinates load-time modprobe and
runtime sysfs unsetting in a single sequence.
- "$param": Module parameter name to configure at load-time.
- "$val": Initial value or composite bitmask/level integer.
- "$tag": Suffix used to construct the dmesg golden record label.
* slice_and_hash_ddctrl("$grep_pattern"):
Local control-file wrapper.
* ifrmmod("$module"):
Defensive module unloader.
* handle_exit_code("$lineno", "$func", "$exit_code", ["$expected_code"]):
Core exit code verifier.
- "$lineno": Caller line number ($BASH_LINENO).
- "$func": Caller function name ($FUNCNAME).
- ["$expected_code"]: Expected exit code, default 0.
Verification Library (syslog_hash_validation.sh) Support Functions:
* log_start() / log_stop():
Slicing syslog capture bookends. Marks the start and end of a
stimulus-triggered test execution by writing tags to /dev/kmsg.
* rdi_resolve_label():
Active sequence resolver. Leverages Bash call-stack reflection
(FUNCNAME) to determine active FT_ test functions and automatically
re-index sequence numbers.
* slice_by_grep("$pattern", ["$file"]):
Text slice extractor. Narrows the scope of a captured log or file.
- <pattern>: Regex pattern to narrow the capture scope.
- [file_path]: Target file path to slice (defaults to dmesg).
* verify_file_slice(<slice_pattern>, [file_path], [extra_args]):
Standard file transition verifier. Captures a state slice, auto-
resolves the label, and verifies its cryptographic hash.
- <slice_pattern>: Regex pattern defining the capture scope.
- [file_path]: Target file to slice, defaulting to control-file.
- [extra_args]: Optional tag appended to the golden record.
* verify_dmesg_slice(<label>, ["$start"], ["$end"], ["$filter"],
["$extra_args"]):
Active dmesg syslog slice verifier.
- ["$start"]: Starting bookend marker, defaulting to START_of_label.
- ["$end"]: Ending bookend marker, defaulting to END_of_label.
- ["$filter"]: Optional filter grep regex to isolate target prints.
- ["$extra_args"]: Suffix tag, defaulting to "dmesg".
* capture_before("$range_pattern", ["$file"]):
Pre-stimulus snapshot helper. Saves a snapshot of a target slice.
- ["$file"]: Target file to snapshot, defaulting to control-file.
* verify_after_change(["$extra_args"]):
Post-stimulus delta verifier. Compares post-state slices to pre-state
snapshots, generating a portable, line-number-free unified diff.
- ["$extra_args"]: Optional tag, defaulting to the pre-state pattern.
* verify_fingerprint("$label", "$extra_args", "$computed_hash", "$desc"):
Exact-label cryptographic matching engine.
- "$desc": Human-readable trace description type (e.g. "Dmesg Log").
* audit_golden_records():
Self-auditing reporting utility. Called at the end of the script, it
identifies fingerprint/result entries that weren't encountered in the
run, and which are probably stale entries.
What happens when tests fail/drift ?
The script tests against kernel/params (params module) for several reasons;
it is stable, it is always built-in, since a kernel can't read boot-options
without it, and modprobes cause it to run enabled pr_debugs.
Those tests left it enabled for the modprobe tests, which exposed a
pr_debug("%p"...) latent in kernel/params.
-----------------------------------
: DRIFT for 'FT_basic_queries.6'
Range: "\[kernel/params\]"
Stimulus: module params =_ # clear params
module params +ml # set flags
module params func parse_args +fs # other flags
Expected: 'baea1247680e' (baea1247680e8151c121539f4b90a6d8)
Got: '4b4d46577a1c' (4b4d46577a1cd930c7a6d5298f6ca24c)
Add or replace this line in GOLDEN_RECORDS():
#K= 4b4d46577a1cd930c7a6d5298f6ca24c FT_basic_queries.6 \
"\[kernel/params\]"
--- Captured Invariant File Change Diff Output ---
@@
-kernel/params.c:139 [kernel/params]parse_one =_ "handling %s with %p\n"
-kernel/params.c:152 [kernel/params]parse_one =_ "doing %s: %s='%s'\n"
-kernel/params.c:156 [kernel/params]parse_one =_ "Unknown argument '%s'\n"
-kernel/params.c:175 [kernel/params]parse_args =_ "doing %s, parsing ARGS: '%s'\n"
+kernel/params.c:139 [kernel/params]parse_one =ml "handling %s with %p\n"
+kernel/params.c:152 [kernel/params]parse_one =ml "doing %s: %s='%s'\n"
+kernel/params.c:156 [kernel/params]parse_one =ml "Unknown argument '%s'\n"
+kernel/params.c:175 [kernel/params]parse_args =mfsl "doing %s, parsing ARGS: '%s'\n"
-----------------------------------
Similarly, the engine catches dmesg syslog format drifts under the
load-time and runtime parameter interfaces (R2 capturing):
: DRIFT for 'FT_modprobe_w_param.7'
Range: dmesg
Stimulus: modprobe test_dynamic_debug p_level_num=3
Expected: '6e811e3b169a' (6e811e3b169acf94410fbda0747b4e78)
Got: '36c4f8b6363b' (36c4f8b6363b79ead3ab5a25e1795525)
Add or replace this line in GOLDEN_RECORDS():
#K= 36c4f8b6363b79ead3ab5a25e1795525 FT_modprobe_w_param.7 dmesg
--- Captured Invariant Dmesg Log Output ---
dyndbg: 34 debug prints in module test_dynamic_debug
kernel/params:parse_args: doing test_dynamic_debug, parsing ARGS: 'p_level_num=3'
kernel/params:parse_one: handling p_level_num with 000000005c252bc5
dyndbg: p_level_num: total matches: 2
test_dd: V1 msg
test_dd: V2 msg
-----------------------------------
NOTES:
By default script runs with V=0 envar, and runs silently on success.
With V=1, script runs show status, like:
# BASIC_TESTS
✔ Verified 'FT_basic_queries.1' (24d85e3b86f3) [via: 'module params +mf']
✔ Verified 'FT_basic_queries.2' (958898bcd973) [via: 'module params +l']
✔ Verified 'FT_basic_queries.3' (130118da5a29) [via: 'module params -m']
✔ Verified 'FT_basic_queries.4' (da6bd1c6a299) [via: 'module params =_']
✔ Verified 'FT_basic_queries.5' (82572e8d20c4) [via: 'module params +mf @ module params func parse_args +sl']
✔ Verified 'FT_basic_queries.6' (baea1247680e) [via: 'module params =_ # clear params
module params +ml # set flags
module params func parse_args +fs # other flags']
With V=2, script runs show full context, like:
✔ Verified 'FT_grammar_errs.44' (2d3af67031a3) [via: 'module foobar +x']
--- Captured Invariant Dmesg Log Output (FT_grammar_errs.44) ---
dyndbg: read 17 bytes from userspace
dyndbg: query 0: "module foobar +x"
dyndbg: split into words: "module" "foobar" "+x"
dyndbg: unknown flag 'x'
dyndbg: flags parse failed
dyndbg: query parse failed
dyndbg: processed 1 queries, with 0 matches, 1 errs
-----------------------------------
# BASIC_TESTS
✔ Verified 'FT_basic_queries.1' (24d85e3b86f3) [via: 'module params +mf']
--- Captured Invariant File Change Diff Output (FT_basic_queries.1) ---
@@
-kernel/params.c:139 [kernel/params]parse_one =_ "handling %s with value '%s'\n"
-kernel/params.c:152 [kernel/params]parse_one =_ "doing %s: %s='%s'\n"
-kernel/params.c:156 [kernel/params]parse_one =_ "Unknown argument '%s'\n"
-kernel/params.c:175 [kernel/params]parse_args =_ "doing %s, parsing ARGS: '%s'\n"
+kernel/params.c:139 [kernel/params]parse_one =mf "handling %s with value '%s'\n"
+kernel/params.c:152 [kernel/params]parse_one =mf "doing %s: %s='%s'\n"
+kernel/params.c:156 [kernel/params]parse_one =mf "Unknown argument '%s'\n"
+kernel/params.c:175 [kernel/params]parse_args =mf "doing %s, parsing ARGS: '%s'\n"
-----------------------------------
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v9:
. sanitize "$K" integer input alongside "$V".
. drop duplicate ifrmmod function declaration.
. replace undeclared "$error_msg" with "$output" in handle_exit_code().
. rework LACK_DD_BUILTIN record filtering to check label column ($3).
. truncate temp files (: > "$SEEN_HASHES_FILE") instead of rm -f under mktemp.
. add handling for K=2 (silent soft-pass mode) to suppress DRIFT/UNREG blocks.
- selftests/dyndbg: drop builtin enablements in FT_modprobe_w_param()
- selftests/dyndbg: V=2 output needs #K=$fingerprint too
-----------------------------------
✔ Proven Runtime Unset: echo 0 > p_disjoint_bits successfully cleared callsites
✔ Verified 'FT_modprobe_w_param.42' (146a1294f452) [via: 'modprobe test_dynamic_debug p_level_num=3; echo 1 > /sys/module/test_dynamic_debug/parameters/do_prints']
--- Captured Invariant Dmesg Log Output (FT_modprobe_w_param.42) ---
#K= 146a1294f452e51c12837bbd3ea723fa FT_modprobe_w_param.42
kernel/params:parse_args: doing test_dynamic_debug, parsing ARGS: 'p_level_num=3'
kernel/params:parse_one: handling p_level_num with value '3'
test_dd: V1 msg
test_dd: V2 msg
test_dd: V1 msg
test_dd: V2 msg
-----------------------------------
The new element/line above is the #K= record, which is the format used
in the GOLDEN-RECORDS. Having this captured output, with the #K=rec,
saved off to a reference file somewhere, should help when dealing with
a drift report:
-----------------------------------
: DRIFT for 'FT_modprobe_w_param.42'
Range: dmesg
Stimulus: modprobe test_dynamic_debug p_level_num=3; echo 1 > /sys/module/test_dynamic_debug/parameters/do_prints
Expected: '146a1294f452' (146a1294f452e51c12837bbd3ea723fa)
Got: '14cf091423c6' (14cf091423c69a188ba45cc39414c1b9)
Add or replace this line in GOLDEN_RECORDS():
#K= 14cf091423c69a188ba45cc39414c1b9 FT_modprobe_w_param.42 dmesg
--- Captured Invariant Dmesg Log Output ---
test_dd: V1 msg
test_dd: V2 msg
test_dd: V1 msg
test_dd: V2 msg
-----------------------------------
NB: this drift report came from a CONFIG_DYNAMIC_DEBUG_CORE=y only
build, where the GOLDEN_RECORDS were done on a CONFIG_DYNAMIC_DEBUG=y
build, which had the builtin pr-debugs present and enabled. This
resulted in a commit to remove the enablement of those builtin
pr_debugs.
Signed-off-by Jim Cromie <jim.cromie@gmail.com>
---
v8: sashiko prompted cleanups
. dont-skip-nomod-config - sashiko complaint vs some comment/statement somewhere
. mktmp-in-test-script
. fn-renames/cleanups: log_ddcmd, my_modname, set_param, verify_control_slice
---
MAINTAINERS | 1 +
tools/testing/selftests/dynamic_debug/Makefile | 10 +
tools/testing/selftests/dynamic_debug/config | 8 +
.../selftests/dynamic_debug/dyndbg_selftest.sh | 775 +++++++++++++++++++++
.../dynamic_debug/syslog_hash_validation.sh | 393 +++++++++++
5 files changed, 1187 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index c72453974dd7..74790be45d06 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9260,6 +9260,7 @@ S: Maintained
F: include/linux/dynamic_debug.h
F: lib/dynamic_debug.c
F: lib/test_dynamic_debug.c
+F: tools/testing/selftests/dynamic_debug/
DYNAMIC INTERRUPT MODERATION
M: Tal Gilboa <talgi@nvidia.com>
diff --git a/tools/testing/selftests/dynamic_debug/Makefile b/tools/testing/selftests/dynamic_debug/Makefile
new file mode 100644
index 000000000000..d998f485a9bc
--- /dev/null
+++ b/tools/testing/selftests/dynamic_debug/Makefile
@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# borrowed from Makefile for user memory selftests
+
+# No binaries, but make sure arg-less "make" doesn't trigger "run_tests"
+all:
+
+TEST_PROGS := dyndbg_selftest.sh
+TEST_FILES := syslog_hash_validation.sh
+
+include ../lib.mk
diff --git a/tools/testing/selftests/dynamic_debug/config b/tools/testing/selftests/dynamic_debug/config
new file mode 100644
index 000000000000..ec478b17873d
--- /dev/null
+++ b/tools/testing/selftests/dynamic_debug/config
@@ -0,0 +1,8 @@
+
+# basic tests ref the builtin params module
+CONFIG_DYNAMIC_DEBUG=y
+
+# more testing is possible with these,
+# but insisting on them here skips testing entirely for such configs
+# CONFIG_TEST_DYNAMIC_DEBUG=m
+# CONFIG_TEST_DYNAMIC_DEBUG_SUBMOD=m
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
new file mode 100755
index 000000000000..49dd85adb36c
--- /dev/null
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -0,0 +1,775 @@
+#!/bin/bash
+# SPDX-License-Identifier: GPL-2.0-only
+
+# Standard kselftest exit codes
+ksft_pass=0
+ksft_fail=1
+ksft_skip=4
+
+ESC=$'\033'
+RED="${ESC}[0;31m"
+GREEN="${ESC}[0;32m"
+YELLOW="${ESC}[0;33m"
+BLUE="${ESC}[0;34m"
+MAGENTA="${ESC}[0;35m"
+CYAN="${ESC}[0;36m"
+NC="${ESC}[0;0m"
+# Environment Controls:
+# V=0,1,2 : Verbosity (0=concise summary, 1=verified assertions, 2=full captured outputs)
+# K=0 : Strict mode (fails with exit 1 on checksum drift or stale records)
+# K=1 : Soft-pass mode (prints DRIFT/STALE diffs, exits 0 with 'fake success')
+# K=2 : Silent soft-pass mode (suppresses DRIFT/STALE diffs, exits 0 with 'fake success')
+V=${V:=0}
+K=${K:=0}
+
+# Sanitize V and K to ensure they are valid integers
+if [[ ! "$V" =~ ^[0-9]+$ ]]; then
+ V=0
+fi
+if [[ ! "$K" =~ ^[0-9]+$ ]]; then
+ K=0
+fi
+
+function v_echo {
+ [ "${V:-0}" -ge 1 ] && echo -e "$@"
+}
+
+[ -e /proc/dynamic_debug/control ] || {
+ echo -e "${RED}: this test requires CONFIG_DYNAMIC_DEBUG=y ${NC}"
+ exit $ksft_skip # nothing to test here, no good reason to fail.
+}
+
+lsmod >/dev/null 2>&1 || {
+ echo -e "${RED}: lsmod requires /proc/modules ${NC}"
+ # exit $ksft_skip # maybe later we can do more
+}
+
+# need info to avoid failures due to untestable configs
+
+[ -f "$KCONFIG_CONFIG" ] || KCONFIG_CONFIG=".config"
+if [ -f "$KCONFIG_CONFIG" ]; then
+ v_echo "# consulting KCONFIG_CONFIG: $KCONFIG_CONFIG"
+ grep -q "CONFIG_DYNAMIC_DEBUG=y" $KCONFIG_CONFIG ; LACK_DD_BUILTIN=$?
+ grep -q "CONFIG_TEST_DYNAMIC_DEBUG=m" $KCONFIG_CONFIG ; LACK_TMOD=$?
+else
+ # if no config, try runtime probes
+ modprobe -n test_dynamic_debug 2>/dev/null ; LACK_TMOD=$?
+ # assume builtin dyndbg if control exists (checked above)
+ LACK_DD_BUILTIN=0
+fi
+
+function ifrmmod {
+ [ "${LACK_TMOD:-0}" -eq 1 ] && return
+ grep -q "^$1 " /proc/modules 2>/dev/null && rmmod $1
+}
+
+# Clean up any leftover loaded test modules at initialization
+ifrmmod test_dynamic_debug_submod
+ifrmmod test_dynamic_debug
+
+# ===========================================================================
+# TESTING STRATEGY 1.
+# Change and observe control-file settings:
+# ddcmd: ie echo $dd_query_cmd > /proc/dynamic_debug/control
+# read back control, count changes due to query_cmd
+# ===========================================================================
+DDCMD_LOG="" # accumulate
+
+function log_ddcmd {
+ local cmd="$1"
+ if [ "${IN_BOOKEND:-0}" -eq 1 ] && [ -n "$DDCMD_LOG" ]; then
+ DDCMD_LOG="${DDCMD_LOG}; $cmd"
+ else
+ DDCMD_LOG="$cmd"
+ fi
+}
+
+function my_modprobe {
+ log_ddcmd "modprobe $*"
+ modprobe "$@"
+}
+
+function set_param {
+ local val="$1"
+ local path="$2"
+ log_ddcmd "echo $val > $path"
+ echo "$val" > "$path"
+}
+
+function ddcmd () {
+ # ddcmd <query_args> [range_pattern] [pass|fail|log]
+ local args="$1"
+ local range="$2"
+ local action="${3:-pass}"
+ local exp_exit=0
+
+ [ "$action" = "fail" ] && exp_exit=1
+ log_ddcmd "$args"
+
+ # Update cumulative state-machine lineage
+ if [[ "$args" == *"=_"* ]]; then
+ CUMULATIVE_DDCMDS="$args"
+ else
+ CUMULATIVE_DDCMDS="${CUMULATIVE_DDCMDS}; $args"
+ fi
+
+ [ "$action" != "pass" ] && log_start
+ [ -n "$range" ] && capture_before "$range"
+
+ output=$( (echo "$args" > /proc/dynamic_debug/control) 2>&1 )
+ handle_exit_code $BASH_LINENO $FUNCNAME $? $exp_exit
+
+ [ "$action" != "pass" ] && log_stop
+ [ -n "$range" ] && verify_after_change
+}
+
+function ddcmd_err () {
+ # ddcmd_err <query_args>
+ # Semantic wrapper for parser syntax & error validation
+ ddcmd "$1" "" fail
+}
+
+function ddcmd_load () {
+ # ddcmd_load <query_args> <range_pattern> <workload_param_path> <workload_val>
+ # Semantic wrapper for end-to-end filter setup and live workload logging
+ local query="$1"
+ local range="$2"
+ local param_path="$3"
+ local val="$4"
+
+ # 1. Setup the control filters (using positional ddcmd range-check)
+ echo "$query" "$range"
+ ddcmd "$query" "$range"
+
+ # 2. Execute the workload and capture syslog prints
+ log_start
+ echo "$val" > "$param_path"
+ log_stop
+}
+
+function handle_exit_code() {
+ local exp_exit_code=0
+ [ $# == 4 ] && exp_exit_code=$4
+ if [ "$3" -ne $exp_exit_code ]; then
+ echo -e "${RED}: $BASH_SOURCE:$1 $2() " \
+ "expected to exit with code $exp_exit_code, got $3${NC}"
+ [ "$3" == 1 ] && echo "Error: '$output'"
+ exit $ksft_fail
+ fi
+}
+
+# ==============================================================================
+# TESTING STRATEGY 2.
+# do 1 to setup test expectations.
+# run logging-workload
+# capture output
+# hash-validate it against GOLDEN_SAMPLE db (at file end)
+#
+# ==============================================================================
+# Source hash-based validation and state verification helper library
+DIR="$(dirname "$(readlink -f "$0")")"
+. "$DIR/syslog_hash_validation.sh"
+
+# Define target validation file path
+CONTROL_FILE="/proc/dynamic_debug/control"
+
+# App-specific wrappers mapping to generic library helpers
+function verify_control_slice {
+ # $1 - pattern to slice
+ # $2 - optional extra args
+ verify_file_slice "$1" $CONTROL_FILE "$2"
+}
+
+function slice_and_hash_ddctrl {
+ local slice=$(slice_by_grep "$1" "$CONTROL_FILE" | strip_control_linenos)
+ echo "$slice" | tr -d '\r' | md5sum | cut -d' ' -f1
+}
+
+# ==============================================================================
+
+function verify_modprobe_param_logging {
+ # $1 - parameter name (e.g. do_classes)
+ # $2 - parameter value (e.g. 1)
+ local param="$1"
+ local val="$2"
+
+ # Make sure both modules are completely unloaded to trigger a fresh load
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+
+ # Capture and verify the load-time (modprobe) dmesg logs
+ log_start
+ my_modprobe test_dynamic_debug "${param}=${val}"
+ my_modprobe test_dynamic_debug_submod
+
+ # If it is a state-controlling parameter, trigger the
+ # print-workload 'do_prints=1' inside the same syslog dmesg
+ # capture bookends to verify their actual pr_debug logging!
+
+ if [ "$param" = "p_disjoint_bits" ] || [ "$param" = "p_level_num" ]; then
+ set_param 1 /sys/module/test_dynamic_debug/parameters/do_prints
+ fi
+
+ log_stop
+
+ # Verify param write by direct readback
+ if [ "$param" = "p_disjoint_bits" ] || [ "$param" = "p_level_num" ]; then
+ local readback=$(cat "/sys/module/test_dynamic_debug/parameters/${param}")
+ if (( readback != val )); then
+ echo -e "${RED}: param readback failed: ${param} ${val} != ${readback}${NC}"
+ exit $ksft_fail
+ else
+ [ "$V" -ge 1 ] && \
+ echo -e "${GREEN}✔ Parameter Readback Verified: ${param}=${readback}${NC}"
+ fi
+ fi
+
+ # verify runtime unsetting
+ if [ "$param" = "p_disjoint_bits" ] || [ "$param" = "p_level_num" ]; then
+
+ set_param 0 "/sys/module/test_dynamic_debug/parameters/${param}"
+ verify_control_slice '\[test_dynamic_debug\]'
+
+ fi
+}
+
+# ==============================================================================
+# FEATURE TESTS (FT_*)
+#
+# test legal queries which should execute and return 0 (success)
+# so we dont look for errors in dmesg
+function FT_grammar_ok {
+ v_echo "${GREEN}# GRAMMAR_OK_TESTS ${NC}"
+ ddcmd "+_"
+ ddcmd "-_"
+
+ # use 4 keywords (max 9 words inc flags)
+ ddcmd "module foo file bar.c func buz class D2_CORE +_" # 4 keywords
+ #ddcmd "module foo file bar.c func buz class D2 line 100 +_" # 5 keywords
+
+ # 3. Dedicated lineno range grammar assertions (side-effect-free proofs)
+ ddcmd "line 42 +_" # test exact line syntax
+ ddcmd "line 10- +_" # test open-ended line range (starting at 10)
+ ddcmd "line -100 +_" # test open-ended line range (ending at 100)
+ ddcmd "line 10-100 +_" # test closed-interval line range
+
+ # 4. Dedicated colon-delimited file:line and file:func assertions
+ ddcmd "file a_file.c:1-100 +_" # test file:linerange syntax
+ ddcmd "file b_file.c:30 +_" # test file:exact_line syntax
+ ddcmd "file c_file.c:c_func +_" # test file:function_name syntax
+ ddcmd "file c_file.c:start_* +_" # test file:wildcard_function syntax
+
+ # 5. Advanced formatting and separator checks (side-effect-free proofs)
+ ddcmd "format \"space\\040here\" +_" # test format query with octal escape
+ #ddcmd "module,foo +_" # test comma token separator syntax
+ ddcmd "func *my_func* +_" # test wildcard func syntax
+ ddcmd "file drivers/usb/* +_" # test wildcard file path syntax
+}
+
+# test grammar, no actual sites chosen/changed
+# use dyndbg's embedded comments in queries
+function FT_grammar_errs {
+ v_echo "${GREEN}# GRAMMAR_ERROR_TESTS ${NC}"
+ ddcmd =_
+ local verbose
+
+ # Reset before loop
+ echo 0 > /sys/module/dynamic_debug/parameters/verbose
+
+ # Sequence verbose level 0..3 to verify error diagnostics across all verbosity states!
+ for verbose in 1 2 3; do
+ echo $verbose > /sys/module/dynamic_debug/parameters/verbose
+
+ ddcmd_err 'module foo format "parse +p' # unclosed double quote
+
+ # comments in queries tell the error in the logs
+ ddcmd_err "module foo unknown_keyword value # no flag err"
+ ddcmd_err "module foo %pm # bad flag-op "
+ ddcmd_err "module foo +pfmHKDD # bad flags after good "
+
+ ddcmd_err "w1 w2 w3 w4 w5 w6 w7 w8 w9 w10 w11 w12 w13 w 14 w15 w16 # too many tokens"
+ ddcmd_err "func w2 w3 w4 w5 w6 w7 w8 w9 w10 w11 w12 +p # bad keyword w3"
+ ddcmd_err "module foo line =_ # no line val"
+
+ #
+ ddcmd_err "func foo func bar =_ # func used 2x"
+ ddcmd_err "module foo module baz =_ # module used 2x"
+ ddcmd_err "class D2_CORE class D2_KMS +p # class used 2x"
+ ddcmd_err "module foo +x # unrecognized flag character"
+
+ # line value errs
+ ddcmd_err "line 10 line 20 +l # line used 2x"
+ ddcmd_err "line 10a +pl # line value trailing garbage"
+ ddcmd_err "line 100-10 +pf # line range error (last < 1st)"
+ done
+
+ # Reset to default verbose level 0 at the end of basic errors
+ echo 0 > /sys/module/dynamic_debug/parameters/verbose
+ ddcmd =_
+}
+
+# these queries run against the builtin module: params, and change
+# flags. The control file state-of-interest is found by path,
+# kernel/params.c, to avoid module keyword entirely
+function FT_basic_queries {
+ v_echo "${GREEN}# BASIC_TESTS ${NC}"
+ if [ $LACK_DD_BUILTIN -eq 1 ]; then
+ echo "SKIP - test requires params, which is a builtin module"
+ return
+ fi
+ ddcmd =_ # zero everything
+
+ ddcmd "module params +mf" 'kernel/params.c'
+ ddcmd "module params +l" 'kernel/params.c'
+ ddcmd "module params -m" 'kernel/params.c'
+ ddcmd "module params =_" 'kernel/params.c'
+
+ # multi-query commands split on ; on a single line
+ ddcmd "module params +mf ; module params func parse_args +sl" 'kernel/params.c'
+
+ # verify multi-cmd input, newline separated, with embedded comments
+ ddcmd =_ # reset before multiline query to capture full transition
+ ddcmd "module params =_ # clear params
+ module params +ml # set flags
+ module params func parse_args +fs # set other flags" \
+ 'kernel/params.c'
+
+ # clear flags and verify
+ ddcmd "module params =_" 'kernel/params.c'
+}
+
+function FT_path_module_queries {
+ v_echo "${GREEN}# TEST_PATH_MODULE_QUERIES ${NC}"
+ ddcmd =_
+
+ # Find how many 'main' modules we have in total (by basename)
+ # Use a precise OR pattern to match exactly [main] or [*/main] and avoid irqdomain
+ local total_main=$(grep -c "\[main\]\|\[[^]]*/main\]" /proc/dynamic_debug/control)
+ v_echo "# found $total_main total 'main' modules"
+
+ if [ $total_main -eq 0 ]; then
+ echo "SKIP - no 'main' modules found to test slashes"
+ return
+ fi
+
+ # Verify a robust, cross-query state-interaction handshake between
+ # narrow path and wide wildcard/basename queries. This dynamically
+ # proves they interact with the exact same underlying callsites!
+
+ # 1. Turn ON specific path, verified under '[init/main]' range
+ ddcmd "module 'init/main' +p" "init/main.c"
+
+ # 2. Turn OFF using wide wildcard query,
+ ddcmd "module '*/main' =_" "init/main.c"
+
+ # 3. Turn ON using wide unscoped basename,
+ ddcmd "module 'main' +p" "init/main.c"
+
+ # 4. Turn OFF using specific narrow path,
+ ddcmd "module 'init/main' =_" "init/main.c"
+}
+
+function FT_hyphen_underscore {
+ v_echo "${GREEN}# TEST_HYPHEN_UNDERSCORE ${NC}"
+ ddcmd =_
+
+ # Find a module with a hyphen in its name (e.g., from the control file)
+ local mod_with_hyphen
+ mod_with_hyphen=$(awk -F'[][]' \
+ '/^[^#:]+:[0-9]+/ { if ($2 ~ /-/) { print $2; exit } }' \
+ /proc/dynamic_debug/control)
+
+ if [ -z "$mod_with_hyphen" ]; then
+ echo "SKIP - no module with hyphen found in /proc/dynamic_debug/control"
+ return
+ fi
+
+ v_echo "# testing hyphen/underscore equivalence for module: $mod_with_hyphen"
+ local mod_with_underscore=$(echo "$mod_with_hyphen" | tr '-' '_')
+ local base_hyphen=$(basename "$mod_with_hyphen")
+ local slice_pattern="\[[^]]*$base_hyphen\]"
+
+ # 1. Enable using literal hyphen name, and record the state fingerprint
+ v_echo "# trying hyphen name: $mod_with_hyphen"
+ ddcmd "module $mod_with_hyphen +p"
+ # verify_control_slice "$slice_pattern"
+ local hash_hyphen=$(slice_and_hash_ddctrl "$slice_pattern")
+
+ # 2. Disable and enable using underscore name, record the state fingerprint
+ ddcmd =_
+ v_echo "# trying underscore name: $mod_with_underscore"
+ ddcmd "module $mod_with_underscore +p"
+ # verify_control_slice "$slice_pattern"
+ local hash_underscore=$(slice_and_hash_ddctrl "$slice_pattern")
+
+ # Real-time mathematical proof of hyphen/underscore name equivalence!
+ if [ "$hash_hyphen" != "$hash_underscore" ]; then
+ echo -e "${RED}: Hyphen/Underscore equivalence check failed! " \
+ "Fingerprints do not match.${NC}"
+ echo -e "Hyphen name state hash: $hash_hyphen"
+ echo -e "Underscore name state hash: $hash_underscore"
+ exit $ksft_fail
+ else
+ v_echo "${GREEN}: Proven: Hyphen/Underscore literal name equivalence matches!${NC}"
+ fi
+
+ # Try kbasename with hyphen (if it has a path)
+ if [ "$base_hyphen" != "$mod_with_hyphen" ]; then
+ ddcmd =_
+ v_echo "# trying hyphen kbasename: $base_hyphen"
+ ddcmd "module $base_hyphen +pmf"
+ # verify_control_slice "$slice_pattern" # omitted: slice contains dynamic
+ # module info which drifts across different targets
+ local hash_base_hyphen=$(slice_and_hash_ddctrl "$slice_pattern")
+
+ # Prove kbasename hyphen name matches literal path hyphen name (with different flags)!
+ v_echo "# trying full path hyphen with pmf flags"
+ ddcmd =_
+ ddcmd "module $mod_with_hyphen +pmf"
+ local hash_path_pmf=$(slice_and_hash_ddctrl "$slice_pattern")
+ if [ "$hash_path_pmf" != "$hash_base_hyphen" ]; then
+ echo -e "${RED}: Hyphen kbasename check failed! " \
+ "Fingerprints do not match full-path hyphen enablement.${NC}"
+ exit $ksft_fail
+ else
+ v_echo "${GREEN}: Proven: Hyphen kbasename matches " \
+ "full-path hyphen enablement!${NC}"
+ fi
+ fi
+
+ # 4. Try kbasename with underscore
+ local base_underscore=$(echo "$base_hyphen" | tr '-' '_')
+ ddcmd =_
+ v_echo "# trying underscore kbasename: $base_underscore"
+ ddcmd "module $base_underscore +pmf"
+ # verify_control_slice "$slice_pattern" # omitted: slice contains dynamic
+ # module info which drifts across different targets
+ local hash_base_underscore=$(slice_and_hash_ddctrl "$slice_pattern")
+
+ # Real-time mathematical proof of hyphen/underscore kbasename equivalence!
+ if [ "$hash_base_hyphen" != "$hash_base_underscore" ] && \
+ [ -n "$hash_base_hyphen" ]; then
+ echo -e "${RED}: Hyphen/Underscore kbasename equivalence check " \
+ "failed! Fingerprints do not match.${NC}"
+ exit $ksft_fail
+ elif [ -n "$hash_base_hyphen" ]; then
+ v_echo "${GREEN}: Proven: Hyphen/Underscore kbasename " \
+ "equivalence matches!${NC}"
+ fi
+
+ ddcmd =_
+}
+
+
+# testing classmap-based query enablers and class configurations
+function FT_test_classes {
+ v_echo "${GREEN}# TEST_CLASSES - classmap-based query enablers and class configs ${NC}"
+
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+ ddcmd =_
+
+ # 1. Verify initial multi-query enablement state via file slice
+ my_modprobe test_dynamic_debug \
+ dyndbg="class,D2_CORE,+pf;class,D2_KMS,+ps;class,D2_ATOMIC,+pm"
+ verify_control_slice '\[test_dynamic_debug\]'
+
+ # 2. Verify state transition and live-printing end-to-end via ddcmd_load!
+ ddcmd_load "class,D2_CORE,+pmf@class,D2_KMS,+pls@class,D2_ATOMIC,+pml" \
+ '\[test_dynamic_debug\]' \
+ "/sys/module/test_dynamic_debug/parameters/do_classes" "1"
+
+ ifrmmod test_dynamic_debug
+}
+
+function FT_classmap_inheritance {
+ v_echo "${GREEN}# TEST_MOD_SUBMOD ${NC}"
+
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+
+ # modprobe with plain-old +p & 3 class enablements
+ my_modprobe test_dynamic_debug \
+ "dyndbg=+p;class D2_CORE +pf;class D2_KMS +pt;class D2_ATOMIC +pm"
+ verify_control_slice '\[test_dynamic_debug\]'
+
+ # fresh start, to clear all above flags (test-fn limits)
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+
+ # act on submod, which loads supermod
+ my_modprobe test_dynamic_debug_submod \
+ "dyndbg=+p;class D2_CORE +pfs;class D2_KMS +pts;class D2_ATOMIC +pmf"
+
+ set_param 0x57 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
+ set_param 4 /sys/module/test_dynamic_debug/parameters/p_level_num
+ verify_control_slice 'test_dynamic_debug'
+
+ set_param 3 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
+ set_param 0 /sys/module/test_dynamic_debug/parameters/p_level_num
+ verify_control_slice 'test_dynamic_debug'
+
+ set_param 0x16 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
+ set_param 0 /sys/module/test_dynamic_debug/parameters/p_level_num
+ verify_control_slice 'test_dynamic_debug'
+
+ # recap DRM_USE_DYNAMIC_DEBUG regression
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+
+ # set super-mod params at load-time
+ my_modprobe test_dynamic_debug p_disjoint_bits=0x16 p_level_num=5
+ verify_control_slice '\[test_dynamic_debug\]'
+
+ # see them picked up by submod
+ my_modprobe test_dynamic_debug_submod
+ verify_control_slice 'test_dynamic_debug'
+
+ # Real-time mathematical proof that load-time (modprobe) parameter parsing
+ # and runtime (sysfs write) parameter configurations are perfectly equivalent!
+ local hash_modprobe=$(slice_and_hash_ddctrl '\[test_dynamic_debug\]')
+
+ # Fresh load with default parameters, then configure them dynamically at runtime
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+ my_modprobe test_dynamic_debug
+ my_modprobe test_dynamic_debug_submod
+ echo 0x16 > /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
+ echo 5 > /sys/module/test_dynamic_debug/parameters/p_level_num
+
+ local hash_sysfs=$(slice_and_hash_ddctrl '\[test_dynamic_debug\]')
+ if [ "$hash_modprobe" != "$hash_sysfs" ]; then
+ echo -e "${RED}: Load-time vs runtime parameter equivalence check failed!${NC}"
+ exit $ksft_fail
+ else
+ v_echo "${GREEN}: Proven: parameter load-time (modprobe) " \
+ "and runtime (sysfs write) are equivalent!${NC}"
+ fi
+
+ # --- Live Content Fingerprinting Phase ---
+ log_start
+ echo 1 > /sys/module/test_dynamic_debug/parameters/do_classes
+ echo 1 > /sys/module/test_dynamic_debug_submod/parameters/do_classes
+ log_stop
+
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+}
+
+function FT_modprobe_w_param {
+ v_echo "${GREEN}# TEST_MODPROBES ${NC}"
+ local verbose
+
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+
+ for verbose in 1 2; do # 3 4 0; do
+ echo $verbose > /sys/module/dynamic_debug/parameters/verbose
+
+ # Verify each parameter load sequence with 100% DRY modularity
+ verify_modprobe_param_logging "do_prints" "1"
+
+ #verify_modprobe_param_logging "do_classes" "1"
+ #verify_modprobe_param_logging "do_bulk" "1"
+
+ # Sequence composite bitmasks to verify disjoint bit transitions
+ for mask in "0x05" "0x12" "0x1f" "0x00"; do
+ verify_modprobe_param_logging "p_disjoint_bits" "$mask"
+ done
+
+ # Sequence levels to verify both growing and shrinking verbose transitions
+ for lvl in "3" "5" "4" "0"; do
+ verify_modprobe_param_logging "p_level_num" "$lvl"
+ done
+ done
+ ddcmd =_
+}
+
+# Built-in Feature Tests (Can run on any CONFIG_DYNAMIC_DEBUG kernel, modular or monolithic)
+builtin_tests=(
+ FT_grammar_ok
+ FT_grammar_errs
+ FT_basic_queries
+ #FT_path_module_queries
+ #FT_hyphen_underscore
+)
+
+# Modular Feature Tests (Require CONFIG_MODULES=y and test_dynamic_debug*.ko available)
+modular_tests=(
+ #FT_test_classes
+ #FT_classmap_inheritance
+ #FT_modprobe_w_param
+)
+
+# ==============================================================================
+# GOLDEN_RECORDS (MD5 Fingerprint Verification Database)
+#
+# This database stores the expected invariant log content hashes for our tests.
+# Since the key has the line-number of the callsite, we dont yet
+# support looping over a test-call, maybe we'll need to address that
+# later.
+#
+# NB: records have lineno of the test in code above. table at bottom
+# means inserts dont shift test-lines.
+#
+# ==============================================================================
+function GOLDEN_RECORDS {
+ cat << 'EOF' | {
+#K= bb85d28739876b0fdf1eb426baae8ef7 FT_grammar_errs.1
+#K= 9c405e06fcea50284df82d1ae9692403 FT_grammar_errs.2
+#K= 0b0d9b0e6f4c45c7d75d699fd3b6aa93 FT_grammar_errs.3
+#K= e008644e159c2a9d99a8d0806c06e71e FT_grammar_errs.4
+#K= 11833e6cf8fe8b03869aa4f669b63398 FT_grammar_errs.5
+#K= e85a4b665f5ef141e3f4d4505dec1da1 FT_grammar_errs.6
+#K= 3e1eba65bd936e1276c7e1d76b399595 FT_grammar_errs.7
+#K= e3ac86676e309d4e72ff3da287736c29 FT_grammar_errs.8
+#K= 466d325c23519119f754fa7860bae7c6 FT_grammar_errs.9
+#K= 51c489366cd86c16280858b95adf34ac FT_grammar_errs.10
+#K= dfc632c6c0cd6206b6141dbc5fb989db FT_grammar_errs.11
+#K= 69650fc26e97a78082bd851eb4a5c83b FT_grammar_errs.12
+#K= 5cfe5665962a482f416836793067f2a2 FT_grammar_errs.13
+#K= 661cc9a2d8d3c381bfeae41392432575 FT_grammar_errs.14
+#K= 5dd0accf9be37ce2f4bf697e9bdebe30 FT_grammar_errs.15
+#K= bd8d9cf661c9aca54dac93c74cfc1501 FT_grammar_errs.16
+#K= e991391048f2fdffaaed99ba36b787ed FT_grammar_errs.17
+#K= 82d99278f471ebfbf47eeb19898525cf FT_grammar_errs.18
+#K= 3c8d268c94b0bf97e64999654cd840c4 FT_grammar_errs.19
+#K= 1a448ff3f1df9155cc3acf1e124f24f5 FT_grammar_errs.20
+#K= 76c8a33c585d414fcc3f1c8b5ea5b4b3 FT_grammar_errs.21
+#K= 90cfc66e9d61f5c448353b97baa99145 FT_grammar_errs.22
+#K= 37a51dfd6e84cb64b69d3a0e23e68ceb FT_grammar_errs.23
+#K= 3aefa325b63742710b45e4531152c9d8 FT_grammar_errs.24
+#K= bc8d2c23282cd6834879bc1f1b303d05 FT_grammar_errs.25
+#K= 092ec5530d875be1dc96ad4202fc7dc3 FT_grammar_errs.26
+#K= 98caa2677e9070953a852b27ab57861e FT_grammar_errs.27
+#K= 8d755baa707c7b3b67491bf84708ef08 FT_grammar_errs.28
+#K= 5dd0accf9be37ce2f4bf697e9bdebe30 FT_grammar_errs.29
+#K= 2e37642dc8aee3d04b8a54a76b3b891c FT_grammar_errs.30
+#K= 593c8b4c41932e3bde564a0008627ced FT_grammar_errs.31
+#K= 85a2a0bee8d0cd10f883aa5477d62efb FT_grammar_errs.32
+#K= 3c8d268c94b0bf97e64999654cd840c4 FT_grammar_errs.33
+#K= 1a448ff3f1df9155cc3acf1e124f24f5 FT_grammar_errs.34
+#K= d9f0cffb0898c54690735a71b0d4f3bf FT_grammar_errs.35
+#K= 4cf728b6a32043ea5336a14d0c435312 FT_grammar_errs.36
+#K= a11ae3f86f4e5f539fd6168d318f74b4 FT_grammar_errs.37
+#K= c7d3830b0391f6a773205066b64e15f9 FT_grammar_errs.38
+#K= 5c506ea2bfd050439b580b91543e9be7 FT_grammar_errs.39
+#K= a257660007408f7bb0cb43c99b1c7bb8 FT_grammar_errs.40
+#K= 0082939f100300a7b327b143cf40cb43 FT_grammar_errs.41
+#K= 657ac4360f978687ad25a705b2bb89f1 FT_grammar_errs.42
+#K= 6e8599556a312200fb6d484565b6c52f FT_basic_queries.1
+#K= db17180b59444e5e34a8fc20c40e4530 FT_basic_queries.2
+#K= f7bd56bd407ff255ef2e3b5fb093ae6a FT_basic_queries.3
+#K= 4ce44468b3b5f80ae42ade1f261b952f FT_basic_queries.4
+#K= 02e4fd94602e108cb89bfc70d47a5dad FT_basic_queries.5
+#K= f03a7ca7316e8db4c0e16523dc41e75d FT_basic_queries.6
+#K= c518a50ba30ba8099d0dc874a27ecf16 FT_basic_queries.7
+EOF
+ # Read the K-recs and skip those for tests that can't run
+ while read -r line; do
+ # Filter built-in if needed
+ if [ "${LACK_DD_BUILTIN:-0}" -eq 1 ]; then
+ # Extract label (3rd field) from #K= line
+ local label=$(echo "$line" | awk '{print $3}')
+ if [[ "$label" == FT_basic_queries* \
+ || "$label" == FT_path_module_queries* \
+ || "$label" == FT_comma_terminators* \
+ || "$label" == FT_multi_query* ]]; then
+ continue
+ fi
+ fi
+ # Filter modular if needed
+ if [ "${LACK_TMOD:-0}" -eq 1 ]; then
+ # Extract label (3rd field) from #K= line
+ local label=$(echo "$line" | awk '{print $3}')
+ if [[ "$label" == FT_test_classes* \
+ || "$label" == FT_classmap_inheritance* \
+ || "$label" == FT_modprobe_w_param* ]]; then
+ continue
+ fi
+ fi
+ echo "$line"
+ done
+ }
+}
+
+# ==============================================================================
+# Run tests
+
+# Clear any stale seen/unregistered/drifted hashes from previous runs
+: > "$SEEN_HASHES_FILE"
+: > "$UNREG_HASHES_FILE"
+: > "$DRIFT_HASHES_FILE"
+
+ifrmmod test_dynamic_debug
+
+# Check if loadable module support or our test modules are missing/builtin
+LACK_TMOD=0
+if [ -d "/sys/module/test_dynamic_debug" ]; then
+ # If module is present but not in /proc/modules,
+ # it is a builtin module (cannot unload/reload)
+ if ! grep -q "^test_dynamic_debug " /proc/modules 2>/dev/null; then
+ LACK_TMOD=1
+ fi
+else
+ # Check if we can modprobe it from disk
+ modprobe -q -n test_dynamic_debug || LACK_TMOD=1
+fi
+
+# 1. Run all Built-in Feature Tests
+v_echo "${GREEN}# RUNNING BUILT-IN FEATURE TESTS ${NC}"
+for test_func in "${builtin_tests[@]}"; do
+ $test_func
+ v_echo ""
+done
+
+# 2. Run Modular Feature Tests only if test modules are available
+if [ $LACK_TMOD -eq 0 ]; then
+ v_echo "${GREEN}# RUNNING MODULAR FEATURE TESTS ${NC}"
+ for test_func in "${modular_tests[@]}"; do
+ $test_func
+ v_echo ""
+ done
+else
+ v_echo "${YELLOW}# SKIPPING MODULAR TESTS: test_dynamic_debug.ko not available ${NC}"
+fi
+
+if [ "$V" -ge 1 ]; then
+ echo -en "${GREEN}# Done on: "
+ date
+ echo -en "${NC}"
+fi
+
+audit_golden_records
+
+# Output consolidated blocks of unregistered and drifted fingerprints
+failed=0
+
+if [ -s "$UNREG_HASHES_FILE" ]; then
+ if [ "$K" -ne 2 ]; then
+ echo -e "${YELLOW}\n# --- Unregistered Baselines ---"
+ cat "$UNREG_HASHES_FILE"
+ echo -e "# ------------------------------${NC}"
+ fi
+ : > "$UNREG_HASHES_FILE"
+ failed=1
+fi
+
+if [ -s "$DRIFT_HASHES_FILE" ]; then
+ if [ "$K" -ne 2 ]; then
+ echo -e "${RED}\n# --- Drifted Baselines ---"
+ cat "$DRIFT_HASHES_FILE"
+ echo -e "# -------------------------${NC}"
+ fi
+ : > "$DRIFT_HASHES_FILE"
+ failed=1
+fi
+
+if [ $failed -eq 1 ]; then
+ [ "$K" -eq 1 ] && echo "fake success" && exit $ksft_pass
+ [ "$K" -eq 2 ] && exit $ksft_pass
+ exit $ksft_fail
+fi
+
+exit $ksft_pass
+
diff --git a/tools/testing/selftests/dynamic_debug/syslog_hash_validation.sh b/tools/testing/selftests/dynamic_debug/syslog_hash_validation.sh
new file mode 100644
index 000000000000..8c6e91f5d9c2
--- /dev/null
+++ b/tools/testing/selftests/dynamic_debug/syslog_hash_validation.sh
@@ -0,0 +1,393 @@
+#!/bin/bash
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# Generic, zero-dependency syslog and file-slicing verification helper library.
+#
+# Provides 2 validation mechanisms:
+# 1. Spatial Control-File Slicing (State Checks & Transitions):
+# - verify_file_slice: Hashes module state in /proc/.../control.
+# - capture_before / verify_after_change: Hashes normalized diff between
+# pre- and post-stimulus states. Strips line numbers and hunk headers,
+# making the hash immune to upstream line churn in C source files.
+# 2. Temporal Syslog Slicing (Workload Logging Checks):
+# - log_start / log_stop / verify_dmesg_slice: Emits bookend markers to
+# /dev/kmsg, slicing exact dmesg prints produced during a workload while
+# stripping multi-bracket timestamp/CPU/PID headers.
+
+# Default APP to DYNDBG if not already set
+APP="${APP:-DYNDBG}"
+APP_LOWER=$(echo "$APP" | tr '[:upper:]' '[:lower:]')
+
+# Global files for tracking seen, unregistered, and drifted hashes securely via mktemp
+SEEN_HASHES_FILE=$(mktemp -t "${APP_LOWER}_seen_hashes.XXXXXX")
+UNREG_HASHES_FILE=$(mktemp -t "${APP_LOWER}_unreg_hashes.XXXXXX")
+DRIFT_HASHES_FILE=$(mktemp -t "${APP_LOWER}_drift_hashes.XXXXXX")
+
+# Secure trap handler to clean up temp files on exit or interrupt
+trap 'rm -f "$SEEN_HASHES_FILE" "$UNREG_HASHES_FILE" "$DRIFT_HASHES_FILE"' EXIT INT TERM HUP
+
+# Global variables for tracking active function transitions and sequence resets
+LAST_FT_FUNC=""
+TEST_SEQ_CTR=0
+ACTIVE_RESOLVED_LABEL=""
+
+# Global variables for bookending state transitions and local stimulus tracking
+IN_BOOKEND=0
+DDCMD_LOG=""
+
+# Global variable to track the active dmesg block label
+ACTIVE_LOG_LABEL=""
+
+# Helper function to auto-resolve active FT_ test and sequence label
+function rdi_resolve_label {
+ local caller_fn=""
+ # Traverse the call stack to find the active Feature Test function (FT_*)
+ for fn in "${FUNCNAME[@]}"; do
+ if [[ "$fn" == FT_* ]]; then
+ caller_fn="$fn"
+ break
+ fi
+ done
+
+ # Fallback to the immediate caller if no FT_ is in the stack
+ if [ -z "$caller_fn" ]; then
+ caller_fn="${FUNCNAME[1]:-}"
+ fi
+
+ # Automatically reset sequence counter if the executing function has transitioned
+ if [ -n "$caller_fn" ] && [ "$caller_fn" != "$LAST_FT_FUNC" ]; then
+ TEST_SEQ_CTR=1
+ LAST_FT_FUNC="$caller_fn"
+ fi
+
+ if [ -n "$caller_fn" ]; then
+ ACTIVE_RESOLVED_LABEL="${caller_fn}.${TEST_SEQ_CTR}"
+ else
+ ACTIVE_RESOLVED_LABEL="${TEST_SEQ_CTR}"
+ fi
+}
+
+function log_start {
+ ((TEST_SEQ_CTR++))
+
+ rdi_resolve_label
+ ACTIVE_LOG_LABEL="$ACTIVE_RESOLVED_LABEL"
+
+ IN_BOOKEND=1
+
+ echo "${APP}_START_${ACTIVE_LOG_LABEL}_$$" > /dev/kmsg
+}
+
+function log_stop {
+ # Ends the dmesg capture block and verifies the slice
+ if [ -z "$ACTIVE_LOG_LABEL" ]; then
+ echo "Error: log_stop called without a matching log_start!" >&2
+ return 1
+ fi
+
+ echo "${APP}_END_${ACTIVE_LOG_LABEL}_$$" > /dev/kmsg
+
+ # Verify the dmesg slice
+ verify_dmesg_slice "$ACTIVE_LOG_LABEL"
+
+ # Reset active state, bookend flag, and command tracker at teardown
+ ACTIVE_LOG_LABEL=""
+ IN_BOOKEND=0
+ DDCMD_LOG=""
+}
+
+function verify_fingerprint {
+ # Verifies a calculated fingerprint against the GOLDEN_RECORDS database
+ # $1 - unique test key (e.g. normal_513)
+ # $2 - the calculated fingerprint hash to verify
+ # $3 - description of what was captured (e.g. "Dmesg Log" or "File Slice")
+ # $4 - the raw captured text block (to display in case of mismatch)
+
+ local label="$1"
+ local fingerprint="$2"
+ local capture_desc="$3"
+ local raw_capture="$4"
+
+ # Require GOLDEN_RECORDS to be defined in the caller script
+ if ! declare -f GOLDEN_RECORDS >/dev/null; then
+ echo "Error: GOLDEN_RECORDS() is not defined in the caller script." >&2
+ return 1
+ fi
+
+ # Resolve the expected hash specifically for this label
+ local expected_hash_field
+ expected_hash_field=$(GOLDEN_RECORDS | \
+ grep -E "[[:space:]]${label}([[:space:]]|$)" | head -n1 | awk '{print $2}')
+
+ local matched=0
+ local h
+ local OLD_IFS="$IFS"
+ IFS=","
+ for h in $expected_hash_field; do
+ if [ "$h" = "$fingerprint" ]; then
+ matched=1
+ break
+ fi
+ done
+ IFS="$OLD_IFS"
+
+ # Strictly verify that the computed fingerprint matches any
+ # expected hash for this label
+ if [ -n "$expected_hash_field" ] && [ $matched -eq 1 ]; then
+ local short_hash="${fingerprint:0:12}"
+ [ "$V" -ge 1 ] && echo -e "${GREEN}✔ Verified '${label}' " \
+ "(${short_hash}) [via: '${DDCMD_LOG}']${NC}"
+
+ if [ "$V" -ge 2 ]; then
+ echo -e "${CYAN}--- Captured Invariant ${capture_desc} Output ($label) ---"
+ printf "#K= %-32s %-24s\n" "${fingerprint}" "${label}"
+ echo "$raw_capture"
+ echo -e "-----------------------------------${NC}"
+ fi
+ echo "$fingerprint" >> "$SEEN_HASHES_FILE"
+ else
+ # Failure path: display mismatch and append to corrections
+ local status_str="UNREGISTERED"
+ local stimulus="${DDCMD_LOG:-direct write to control}"
+ if [ -n "$expected_hash_field" ]; then
+ local short_expected="${expected_hash_field:0:12}"
+ local short_got="${fingerprint:0:12}"
+ if [ "${K:-0}" -ne 2 ]; then
+ echo -e "${RED}: DRIFT for '${label}'${NC}"
+ echo -e " Stimulus: ${stimulus}"
+ echo -e " Expected: '${short_expected}' (${expected_hash_field})"
+ echo -e " Got: '${short_got}' (${fingerprint})${NC}"
+ fi
+ status_str="DRIFTED"
+ else
+ if [ "${K:-0}" -ne 2 ]; then
+ echo -e "${YELLOW}: NO RECORD for '${label}'${NC}"
+ echo -e " Stimulus: ${stimulus}${NC}"
+ fi
+ fi
+
+ if [ "${K:-0}" -ne 2 ]; then
+ echo -e "\nAdd or replace this line in GOLDEN_RECORDS():"
+ printf "#K= %-32s %-24s\n" "${fingerprint}" "${label}"
+ echo -e "\n--- Captured Invariant ${capture_desc} Output ---"
+ if [ "$capture_desc" = "File Slice" ]; then
+ echo "$raw_capture" | \
+ sed -E "s/ =([_a-z]*[a-z][_a-z]*) / ${YELLOW}=\1${NC} /g"
+ else
+ echo "$raw_capture"
+ fi
+ echo -e "-----------------------------------${NC}"
+ fi
+
+ if [ "$status_str" = "DRIFTED" ]; then
+ printf "#K= %-32s %s\n" \
+ "${fingerprint}" "${label}" \
+ >> "$DRIFT_HASHES_FILE"
+ else
+ printf "#K= %-32s %s\n" \
+ "${fingerprint}" "${label}" \
+ >> "$UNREG_HASHES_FILE"
+ fi
+ fi
+}
+
+function verify_dmesg_slice {
+ # Slices dmesg, computes its hash, and verifies it against the database.
+ # $1 - unique test key (e.g. normal_513)
+ # $2 - optional start marker (defaults to ${APP}_START_${label})
+ # $3 - optional end marker (defaults to ${APP}_END_${label})
+
+ local label="$1"
+ local app="${APP:-DYNDBG}"
+ local start_marker="${2:-${app}_START_${label}_$$}"
+ local end_marker="${3:-${app}_END_${label}_$$}"
+
+ # 1. Capture the log slice (exactly once!)
+ local log_slice=$(dmesg | sed -n "/$start_marker/,/$end_marker/p" | \
+ grep -E -v "$start_marker|$end_marker" | \
+ sed -E -e 's/^(\[[^]]*\][[:space:]]*)+//' )
+
+ # 2. Compute its fingerprint
+ local fingerprint=$(echo "$log_slice" | tr -d '\r' | md5sum | cut -d' ' -f1)
+
+ # 3. Verify
+ verify_fingerprint "$label" "$fingerprint" "Dmesg Log" "$log_slice"
+}
+
+function strip_control_linenos {
+ # Normalizes 'filename:123' to 'filename:0' for /proc/dynamic_debug/control output
+ sed -E 's/^([^:]+):[0-9]+/\1:0/'
+}
+
+function slice_by_grep {
+ # Isolate lines matching a pattern from a file
+ # $1 - pattern to grep (returns entire file if empty or "*")
+ # $2 - file path (reads $CONTROL_FILE if not provided)
+ local pattern="$1"
+ local file_path="${2:-$CONTROL_FILE}"
+
+ if [ -z "$pattern" ] || [ "$pattern" = "*" ]; then
+ cat "$file_path"
+ else
+ grep "$pattern" "$file_path"
+ fi
+}
+
+function verify_file_slice {
+ # Captures a file slice by pattern, computes its hash,
+ # and verifies it against the database.
+ # $1 - pattern to slice
+ # $2 - optional file path (defaults to $CONTROL_FILE)
+
+ local pattern="$1"
+ local file="${2:-$CONTROL_FILE}"
+
+ # Always auto-resolve label via call stack sequence resets!
+ ((TEST_SEQ_CTR++))
+ rdi_resolve_label
+ local label="$ACTIVE_RESOLVED_LABEL"
+
+ # 1. Capture the file slice (exactly once!)
+ local slice=$(slice_by_grep "$pattern" "$file")
+ if [ "$file" = "$CONTROL_FILE" ]; then
+ slice=$(echo "$slice" | strip_control_linenos)
+ fi
+
+ # 2. Compute its fingerprint
+ local fingerprint=$(echo "$slice" | tr -d '\r' | md5sum | cut -d' ' -f1)
+
+ # 3. Verify
+ verify_fingerprint "$label" "$fingerprint" "File Slice" "$slice"
+
+ # Reset state, bookend flag, and command tracker at teardown
+ IN_BOOKEND=0
+ DDCMD_LOG=""
+}
+
+# Global variables for bookending state transitions
+BEFORE_CAPTURE_SLICE=""
+BEFORE_CAPTURE_PATTERN=""
+BEFORE_CAPTURE_FILE=""
+
+function capture_before {
+ # Captures and stores the 'before' state for a file slice transition
+ # $1 - pattern to slice
+ # $2 - optional file path (defaults to $CONTROL_FILE)
+
+ BEFORE_CAPTURE_PATTERN="$1"
+ BEFORE_CAPTURE_FILE="${2:-$CONTROL_FILE}"
+ BEFORE_CAPTURE_SLICE=$(slice_by_grep "$BEFORE_CAPTURE_PATTERN" "$BEFORE_CAPTURE_FILE")
+ if [ "$BEFORE_CAPTURE_FILE" = "$CONTROL_FILE" ]; then
+ BEFORE_CAPTURE_SLICE=$(echo "$BEFORE_CAPTURE_SLICE" | strip_control_linenos)
+ fi
+
+ IN_BOOKEND=1
+}
+
+function verify_after_change {
+ # Verifies the transition between the stored 'before' state and the current state
+ # $1 - optional unique test key (resolved via stack if empty)
+
+ local label="$1"
+
+ if [ -z "$label" ]; then
+ ((TEST_SEQ_CTR++))
+ rdi_resolve_label
+ label="$ACTIVE_RESOLVED_LABEL"
+ fi
+
+ if [ -z "$BEFORE_CAPTURE_PATTERN" ]; then
+ echo "Error: verify_after_change called without a matching capture_before!" >&2
+ return 1
+ fi
+
+ # 1. Capture the 'after' state (exactly once!)
+ local after_slice=$(slice_by_grep "$BEFORE_CAPTURE_PATTERN" "$BEFORE_CAPTURE_FILE")
+ if [ "$BEFORE_CAPTURE_FILE" = "$CONTROL_FILE" ]; then
+ after_slice=$(echo "$after_slice" | strip_control_linenos)
+ fi
+
+ # 2. Generate the unified diff, stripped of volatile diff headers AND hunk line-numbers
+ local transition_diff=$(diff -u <(echo "$BEFORE_CAPTURE_SLICE") <(echo "$after_slice") | \
+ tail -n +3 | \
+ sed -E 's/^@@ -[0-9]+.* \+[0-9]+.* @@/@@/g')
+
+ # 3. Compute its fingerprint
+ local fingerprint=$(echo "$transition_diff" | tr -d '\r' | md5sum | cut -d' ' -f1)
+
+ # 4. Verify the diff as the captured text block
+ verify_fingerprint "$label" "$fingerprint" "File Change Diff" "$transition_diff"
+
+ # Reset state, bookend flag, and command tracker at teardown
+ BEFORE_CAPTURE_SLICE=""
+ BEFORE_CAPTURE_PATTERN=""
+ BEFORE_CAPTURE_FILE=""
+ IN_BOOKEND=0
+ DDCMD_LOG=""
+}
+
+function audit_golden_records {
+ local seen_file="$SEEN_HASHES_FILE"
+
+ if [ ! -f "$seen_file" ]; then
+ return
+ fi
+
+ # Require GOLDEN_RECORDS to be defined in the caller script
+ if ! declare -f GOLDEN_RECORDS >/dev/null; then
+ return
+ fi
+
+ [ "${V:-0}" -ge 1 ] && echo -e "${YELLOW}# --- GOLDEN_RECORDS Audit ---${NC}"
+ local stale_found=0
+ local total_records=$(GOLDEN_RECORDS | grep -c "^#K=")
+
+ # Read each active record line from GOLDEN_RECORDS
+ while read -r line; do
+ # Extract the hash/hashes (second word) from the #K= line
+ local hash_field=$(echo "$line" | awk '{print $2}')
+
+ # Check if at least one of the comma-separated hashes was seen
+ local hash_seen=0
+ local h
+ local OLD_IFS="$IFS"
+ IFS=","
+ for h in $hash_field; do
+ if grep -q "$h" "$seen_file" 2>/dev/null; then
+ hash_seen=1
+ break
+ fi
+ done
+ IFS="$OLD_IFS"
+
+ # Check if this hash field was seen during the run
+ if [ $hash_seen -eq 0 ]; then
+ if [ "${K:-0}" -ne 2 ]; then
+ if [ $stale_found -eq 0 ]; then
+ # On first failure, print header if not already printed
+ [ "${V:-0}" -eq 0 ] && \
+ echo -e "${YELLOW}# --- GOLDEN_RECORDS Audit ---${NC}"
+ echo -e "${YELLOW}# The following GOLDEN_RECORDS entries " \
+ "were never hit and may be stale:${NC}"
+ fi
+ echo -e "${YELLOW}#K_STALE= $line${NC}"
+ fi
+ stale_found=1
+ fi
+ done < <(GOLDEN_RECORDS | grep "^#K=" | grep -v "<md5_hash>")
+
+ if [ $stale_found -eq 0 ] && [ "${V:-0}" -ge 1 ]; then
+ echo -e "${GREEN}# All $total_records GOLDEN_RECORDS entries " \
+ "were successfully hit!${NC}"
+ fi
+
+ # Detect duplicate labels in the database
+ local dupes=$(GOLDEN_RECORDS | grep "^#K=" | awk '{print $3}' | sort | uniq -d)
+ if [ -n "$dupes" ]; then
+ echo -e "\n${RED}# WARNING: Duplicate labels detected in GOLDEN_RECORDS():${NC}"
+ echo "$dupes" | sed 's/^/# /'
+ fi
+
+ # Clean up
+ rm -f "$seen_file"
+}
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 02/39] vmlinux.lds.h: refactor BOUNDED_SECTION_* macros into bounded_sections.lds.h
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
2026-09-09 0:54 ` [PATCH v9 01/39] selftests/dyndbg: Add kselftest script to verify dynamic-debug Jim Cromie via B4 Relay
@ 2026-09-09 0:54 ` Jim Cromie via B4 Relay
2026-09-09 0:54 ` [PATCH v9 03/39] vmlinux.lds.h: drop unused HEADERED_SECTION* macros Jim Cromie via B4 Relay
` (36 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:54 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Move BOUNDED_SECTION_* macros to a new helper file:
include/asm-generic/bounded_sections.lds.h and include it back into
vmlinux.lds.h. This allows its reuse later to fix a failure to keep
dyndbg sections in some circumstances.
NOTES:
These macros are only for use in vmlinux.lds.h, where the _start &
_end symbols are needed. Modules keep sections separate in ELF
sections, with their boundaries known, so the _start and _end are not
useful, and may confuse tools not expecting them.
This patch ignores a checkpatch warning, because new file is covered
by "GENERIC INCLUDE/ASM HEADER FILES" in MAINTAINERS
CC: Arnd Bergmann <arnd@arndb.de>
CC: linux-arch@vger.kernel.org
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v3: move include to top
---
include/asm-generic/bounded_sections.lds.h | 36 ++++++++++++++++++++++++++++++
include/asm-generic/vmlinux.lds.h | 31 +------------------------
2 files changed, 37 insertions(+), 30 deletions(-)
diff --git a/include/asm-generic/bounded_sections.lds.h b/include/asm-generic/bounded_sections.lds.h
new file mode 100644
index 000000000000..8c29293ca7fb
--- /dev/null
+++ b/include/asm-generic/bounded_sections.lds.h
@@ -0,0 +1,36 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef _ASM_GENERIC_BOUNDED_SECTIONS_H
+#define _ASM_GENERIC_BOUNDED_SECTIONS_H
+
+#define BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_) \
+ _BEGIN_##_label_ = .; \
+ KEEP(*(_sec_)) \
+ _END_##_label_ = .;
+
+#define BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_) \
+ _label_##_BEGIN_ = .; \
+ KEEP(*(_sec_)) \
+ _label_##_END_ = .;
+
+#define BOUNDED_SECTION_BY(_sec_, _label_) \
+ BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, __start, __stop)
+
+#define BOUNDED_SECTION(_sec) BOUNDED_SECTION_BY(_sec, _sec)
+
+#define HEADERED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_, _HDR_) \
+ _HDR_##_label_ = .; \
+ KEEP(*(.gnu.linkonce.##_sec_)) \
+ BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_)
+
+#define HEADERED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_, _HDR_) \
+ _label_##_HDR_ = .; \
+ KEEP(*(.gnu.linkonce.##_sec_)) \
+ BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_)
+
+#define HEADERED_SECTION_BY(_sec_, _label_) \
+ HEADERED_SECTION_PRE_LABEL(_sec_, _label_, __start, __stop)
+
+#define HEADERED_SECTION(_sec) HEADERED_SECTION_BY(_sec, _sec)
+
+#endif /* _ASM_GENERIC_BOUNDED_SECTIONS_H */
diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
index b2988aa12f66..b4ece391f7b1 100644
--- a/include/asm-generic/vmlinux.lds.h
+++ b/include/asm-generic/vmlinux.lds.h
@@ -50,6 +50,7 @@
* [__nosave_begin, __nosave_end] for the nosave data
*/
+#include <asm-generic/bounded_sections.lds.h>
#include <asm-generic/codetag.lds.h>
#ifndef LOAD_OFFSET
@@ -211,36 +212,6 @@
# endif
#endif
-#define BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_) \
- _BEGIN_##_label_ = .; \
- KEEP(*(_sec_)) \
- _END_##_label_ = .;
-
-#define BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_) \
- _label_##_BEGIN_ = .; \
- KEEP(*(_sec_)) \
- _label_##_END_ = .;
-
-#define BOUNDED_SECTION_BY(_sec_, _label_) \
- BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, __start, __stop)
-
-#define BOUNDED_SECTION(_sec) BOUNDED_SECTION_BY(_sec, _sec)
-
-#define HEADERED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_, _HDR_) \
- _HDR_##_label_ = .; \
- KEEP(*(.gnu.linkonce.##_sec_)) \
- BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_)
-
-#define HEADERED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_, _HDR_) \
- _label_##_HDR_ = .; \
- KEEP(*(.gnu.linkonce.##_sec_)) \
- BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_)
-
-#define HEADERED_SECTION_BY(_sec_, _label_) \
- HEADERED_SECTION_PRE_LABEL(_sec_, _label_, __start, __stop)
-
-#define HEADERED_SECTION(_sec) HEADERED_SECTION_BY(_sec, _sec)
-
#ifdef CONFIG_TRACE_BRANCH_PROFILING
#define LIKELY_PROFILE() \
BOUNDED_SECTION_BY(_ftrace_annotated_branch, _annotated_branch_profile)
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 03/39] vmlinux.lds.h: drop unused HEADERED_SECTION* macros
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
2026-09-09 0:54 ` [PATCH v9 01/39] selftests/dyndbg: Add kselftest script to verify dynamic-debug Jim Cromie via B4 Relay
2026-09-09 0:54 ` [PATCH v9 02/39] vmlinux.lds.h: refactor BOUNDED_SECTION_* macros into bounded_sections.lds.h Jim Cromie via B4 Relay
@ 2026-09-09 0:54 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 04/39] vmlinux.lds.h: Fix ALIGN(8) omission causing NULL ptr on i386 Jim Cromie via B4 Relay
` (35 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:54 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
These macros are unused, no point in carrying them any more.
NB: these macros were just moved to bounded_sections.lds.h, from
vmlinux.lds.h, which is the known entity, and therefore more
meaningful in the 1-line summary, so thats what I used as the topic.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
include/asm-generic/bounded_sections.lds.h | 15 ---------------
1 file changed, 15 deletions(-)
diff --git a/include/asm-generic/bounded_sections.lds.h b/include/asm-generic/bounded_sections.lds.h
index 8c29293ca7fb..268cdc34389b 100644
--- a/include/asm-generic/bounded_sections.lds.h
+++ b/include/asm-generic/bounded_sections.lds.h
@@ -18,19 +18,4 @@
#define BOUNDED_SECTION(_sec) BOUNDED_SECTION_BY(_sec, _sec)
-#define HEADERED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_, _HDR_) \
- _HDR_##_label_ = .; \
- KEEP(*(.gnu.linkonce.##_sec_)) \
- BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_)
-
-#define HEADERED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_, _HDR_) \
- _label_##_HDR_ = .; \
- KEEP(*(.gnu.linkonce.##_sec_)) \
- BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_)
-
-#define HEADERED_SECTION_BY(_sec_, _label_) \
- HEADERED_SECTION_PRE_LABEL(_sec_, _label_, __start, __stop)
-
-#define HEADERED_SECTION(_sec) HEADERED_SECTION_BY(_sec, _sec)
-
#endif /* _ASM_GENERIC_BOUNDED_SECTIONS_H */
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 04/39] vmlinux.lds.h: Fix ALIGN(8) omission causing NULL ptr on i386
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (2 preceding siblings ...)
2026-09-09 0:54 ` [PATCH v9 03/39] vmlinux.lds.h: drop unused HEADERED_SECTION* macros Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 05/39] vmlinux.lds.h: remove redundant ALIGN(8) directives Jim Cromie via B4 Relay
` (34 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
Almost all uses of the BOUNDED_SECTION macros are ALIGN(8), either
explicitly, or by being below an aligned section containing x*8 byte
objects. The noteworthy exception is BOUNDED_SECTION(__dyndbg), which
immediately follows BOUNDED_SECTION(__dyndbg_classes).
On i386, struct _ddebug_classmap is 28 bytes, so without an explicit
ALIGN(8) in the macro, the following __dyndbg section gets misaligned,
causing a NULL ptr deref in dynamic_debug_init().
So fix this with an explicit ALIGN(8) in the existing BOUNDED_SECTION
macros, and introduce _ALIGNED variants to handle the cases with an
explicit . = ALIGN(x)
Also add explicit alignments for: EXCEPTION_TABLE, ORC_UNWIND_TABLE,
TRACEDATA, INIT_SETUP, and NOTES.
update BOUNDED_SECTION uses inside . = ALIGN(x) stanzas to use
_ALIGNED variants, but keep the outer ALIGNs so the symbols between
them are not "re-aligned".
In particular, scripts/sorttable.c does not tolerate sloppy padding.
At the top of ORC_UNWIND_TABLE, add . = ALIGN(4) to match the struct
orc_header __align() call in the code:
commit b9f174c811e3 ("x86/unwind/orc: Add ELF section with ORC version identifier")
Suggested-by: Louis Chauvet <louis.chauvet@bootlin.com> # _ALIGNED variants.
Link: https://lore.kernel.org/lkml/177402491426.6181.12855763650074831089.b4-review@b4/
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v3:
sashiko complained about NOTES and .BTF_ids.
gemini asserts that NOTES are natively 4-byte aligned, add comment repeating it.
.BTF_ids doesnt use BOUNDED_BY, since start/end isnt needed;
sashiko evidently got confused by immediately preceding usage.
v2:
sashiko picked up 2 cases, added to the explicit list above
https://sashiko.dev/#/patchset/20260515-asm-generic-1-v3-0-680b273666d4%40gmail.com
---
include/asm-generic/bounded_sections.lds.h | 17 ++++++++++++++---
include/asm-generic/vmlinux.lds.h | 18 ++++++++++--------
2 files changed, 24 insertions(+), 11 deletions(-)
diff --git a/include/asm-generic/bounded_sections.lds.h b/include/asm-generic/bounded_sections.lds.h
index 268cdc34389b..8ff3e3420f60 100644
--- a/include/asm-generic/bounded_sections.lds.h
+++ b/include/asm-generic/bounded_sections.lds.h
@@ -3,19 +3,30 @@
#ifndef _ASM_GENERIC_BOUNDED_SECTIONS_H
#define _ASM_GENERIC_BOUNDED_SECTIONS_H
-#define BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_) \
+#define BOUNDED_SECTION_PRE_LABEL_ALIGNED(_sec_, _label_, _BEGIN_, _END_, _ALIGNED_) \
+ . = ALIGN(_ALIGNED_); \
_BEGIN_##_label_ = .; \
KEEP(*(_sec_)) \
_END_##_label_ = .;
-#define BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_) \
+#define BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, _BEGIN_, _END_) \
+ BOUNDED_SECTION_PRE_LABEL_ALIGNED(_sec_, _label_, _BEGIN_, _END_, 8)
+
+#define BOUNDED_SECTION_POST_LABEL_ALIGNED(_sec_, _label_, _BEGIN_, _END_, _ALIGNED_) \
+ . = ALIGN(_ALIGNED_); \
_label_##_BEGIN_ = .; \
KEEP(*(_sec_)) \
_label_##_END_ = .;
+#define BOUNDED_SECTION_POST_LABEL(_sec_, _label_, _BEGIN_, _END_) \
+ BOUNDED_SECTION_POST_LABEL_ALIGNED(_sec_, _label_, _BEGIN_, _END_, 8)
+
#define BOUNDED_SECTION_BY(_sec_, _label_) \
BOUNDED_SECTION_PRE_LABEL(_sec_, _label_, __start, __stop)
-#define BOUNDED_SECTION(_sec) BOUNDED_SECTION_BY(_sec, _sec)
+#define BOUNDED_SECTION_BY_ALIGNED(_sec_, _label_, _ALIGNED_) \
+ BOUNDED_SECTION_PRE_LABEL_ALIGNED(_sec_, _label_, __start, __stop, _ALIGNED_)
+
+#define BOUNDED_SECTION(_sec) BOUNDED_SECTION_BY(_sec, _sec)
#endif /* _ASM_GENERIC_BOUNDED_SECTIONS_H */
diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
index b4ece391f7b1..b1a69f8af6d2 100644
--- a/include/asm-generic/vmlinux.lds.h
+++ b/include/asm-generic/vmlinux.lds.h
@@ -640,7 +640,7 @@
#define EXCEPTION_TABLE(align) \
. = ALIGN(align); \
__ex_table : AT(ADDR(__ex_table) - LOAD_OFFSET) { \
- BOUNDED_SECTION_BY(__ex_table, ___ex_table) \
+ BOUNDED_SECTION_BY_ALIGNED(__ex_table, ___ex_table, align) \
}
/*
@@ -650,7 +650,7 @@
#define BTF \
. = ALIGN(PAGE_SIZE); \
.BTF : AT(ADDR(.BTF) - LOAD_OFFSET) { \
- BOUNDED_SECTION_BY(.BTF, _BTF) \
+ BOUNDED_SECTION_BY_ALIGNED(.BTF, _BTF, PAGE_SIZE) \
} \
. = ALIGN(PAGE_SIZE); \
.BTF_ids : AT(ADDR(.BTF_ids) - LOAD_OFFSET) { \
@@ -840,16 +840,17 @@
#ifdef CONFIG_UNWINDER_ORC
#define ORC_UNWIND_TABLE \
+ . = ALIGN(4); \
.orc_header : AT(ADDR(.orc_header) - LOAD_OFFSET) { \
- BOUNDED_SECTION_BY(.orc_header, _orc_header) \
+ BOUNDED_SECTION_BY_ALIGNED(.orc_header, _orc_header, 4) \
} \
. = ALIGN(4); \
.orc_unwind_ip : AT(ADDR(.orc_unwind_ip) - LOAD_OFFSET) { \
- BOUNDED_SECTION_BY(.orc_unwind_ip, _orc_unwind_ip) \
+ BOUNDED_SECTION_BY_ALIGNED(.orc_unwind_ip, _orc_unwind_ip, 4)\
} \
. = ALIGN(2); \
.orc_unwind : AT(ADDR(.orc_unwind) - LOAD_OFFSET) { \
- BOUNDED_SECTION_BY(.orc_unwind, _orc_unwind) \
+ BOUNDED_SECTION_BY_ALIGNED(.orc_unwind, _orc_unwind, 2) \
} \
text_size = _etext - _stext; \
. = ALIGN(4); \
@@ -877,7 +878,7 @@
#define TRACEDATA \
. = ALIGN(4); \
.tracedata : AT(ADDR(.tracedata) - LOAD_OFFSET) { \
- BOUNDED_SECTION_POST_LABEL(.tracedata, __tracedata, _start, _end) \
+ BOUNDED_SECTION_POST_LABEL_ALIGNED(.tracedata, __tracedata, _start, _end, 4) \
}
#else
#define TRACEDATA
@@ -906,13 +907,14 @@
*(.note.gnu.property) \
} \
.notes : AT(ADDR(.notes) - LOAD_OFFSET) { \
- BOUNDED_SECTION_BY(.note.*, _notes) \
+ /* *(.note.*) are natively 4-byte aligned */ \
+ BOUNDED_SECTION_BY_ALIGNED(.note.*, _notes, 4) \
} NOTES_HEADERS \
NOTES_HEADERS_RESTORE
#define INIT_SETUP(initsetup_align) \
. = ALIGN(initsetup_align); \
- BOUNDED_SECTION_POST_LABEL(.init.setup, __setup, _start, _end)
+ BOUNDED_SECTION_POST_LABEL_ALIGNED(.init.setup, __setup, _start, _end, initsetup_align)
#define INIT_CALLS_LEVEL(level) \
__initcall##level##_start = .; \
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 05/39] vmlinux.lds.h: remove redundant ALIGN(8) directives
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (3 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 04/39] vmlinux.lds.h: Fix ALIGN(8) omission causing NULL ptr on i386 Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 06/39] dyndbg.lds.S: fix lost dyndbg sections in modules Jim Cromie via B4 Relay
` (33 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
The BOUNDED_SECTION_PRE_LABEL and BOUNDED_SECTION_POST_LABEL macros
were recently updated to inherently enforce an 8-byte alignment. This
makes the explicit '. = ALIGN(8);' statements preceding 'naked' macro
calls in vmlinux.lds.h redundant.
Remove these redundant alignment directives to clean up the file and
clarify that the macros handle their own alignment padding.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
include/asm-generic/vmlinux.lds.h | 13 -------------
1 file changed, 13 deletions(-)
diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
index b1a69f8af6d2..c3376665d027 100644
--- a/include/asm-generic/vmlinux.lds.h
+++ b/include/asm-generic/vmlinux.lds.h
@@ -228,7 +228,6 @@
#ifdef CONFIG_KPROBES
#define KPROBE_BLACKLIST() \
- . = ALIGN(8); \
BOUNDED_SECTION(_kprobe_blacklist)
#else
#define KPROBE_BLACKLIST()
@@ -244,7 +243,6 @@
#ifdef CONFIG_EVENT_TRACING
#define FTRACE_EVENTS() \
- . = ALIGN(8); \
BOUNDED_SECTION(_ftrace_events) \
BOUNDED_SECTION_BY(_ftrace_eval_map, _ftrace_eval_maps)
#else
@@ -261,7 +259,6 @@
#ifdef CONFIG_FTRACE_SYSCALLS
#define TRACE_SYSCALLS() \
- . = ALIGN(8); \
BOUNDED_SECTION_BY(__syscalls_metadata, _syscalls_metadata)
#else
#define TRACE_SYSCALLS()
@@ -276,7 +273,6 @@
#ifdef CONFIG_SERIAL_EARLYCON
#define EARLYCON_TABLE() \
- . = ALIGN(8); \
BOUNDED_SECTION_POST_LABEL(__earlycon_table, __earlycon_table, , _end)
#else
#define EARLYCON_TABLE()
@@ -284,11 +280,9 @@
#ifdef CONFIG_SECURITY
#define LSM_TABLE() \
- . = ALIGN(8); \
BOUNDED_SECTION_PRE_LABEL(.lsm_info.init, _lsm_info, __start, __end)
#define EARLY_LSM_TABLE() \
- . = ALIGN(8); \
BOUNDED_SECTION_PRE_LABEL(.early_lsm_info.init, _early_lsm_info, __start, __end)
#else
#define LSM_TABLE()
@@ -314,7 +308,6 @@
#ifdef CONFIG_ACPI
#define ACPI_PROBE_TABLE(name) \
- . = ALIGN(8); \
BOUNDED_SECTION_POST_LABEL(__##name##_acpi_probe_table, \
__##name##_acpi_probe_table,, _end)
#else
@@ -323,7 +316,6 @@
#ifdef CONFIG_THERMAL
#define THERMAL_TABLE(name) \
- . = ALIGN(8); \
BOUNDED_SECTION_POST_LABEL(__##name##_thermal_table, \
__##name##_thermal_table,, _end)
#else
@@ -403,12 +395,10 @@
__end_init_stack = .;
#define JUMP_TABLE_DATA \
- . = ALIGN(8); \
BOUNDED_SECTION_BY(__jump_table, ___jump_table)
#ifdef CONFIG_HAVE_STATIC_CALL_INLINE
#define STATIC_CALL_DATA \
- . = ALIGN(8); \
BOUNDED_SECTION_BY(.static_call_sites, _static_call_sites) \
BOUNDED_SECTION_BY(.static_call_tramp_key, _static_call_tramp_key)
#else
@@ -453,7 +443,6 @@
*(.rodata) *(.rodata.*) *(.data.rel.ro*) \
SCHED_DATA \
RO_AFTER_INIT_DATA /* Read only after init */ \
- . = ALIGN(8); \
BOUNDED_SECTION_BY(__tracepoints_ptrs, ___tracepoints_ptrs) \
*(__tracepoints_strings)/* Tracepoints: strings */ \
} \
@@ -958,12 +947,10 @@
/* Alignment must be consistent with (kunit_suite *) in include/kunit/test.h */
#define KUNIT_TABLE() \
- . = ALIGN(8); \
BOUNDED_SECTION_POST_LABEL(.kunit_test_suites, __kunit_suites, _start, _end)
/* Alignment must be consistent with (kunit_suite *) in include/kunit/test.h */
#define KUNIT_INIT_TABLE() \
- . = ALIGN(8); \
BOUNDED_SECTION_POST_LABEL(.kunit_init_test_suites, \
__kunit_init_suites, _start, _end)
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 06/39] dyndbg.lds.S: fix lost dyndbg sections in modules
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (4 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 05/39] vmlinux.lds.h: remove redundant ALIGN(8) directives Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 07/39] dyndbg: factor ddebug_match_desc out from ddebug_change Jim Cromie via B4 Relay
` (32 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
With CONFIG_DRM_USE_DYNAMIC_DEBUG=y, several build configs had
problems with __dyndbg* sections getting lost in drm drivers. Fix
this by following the model demonstrated in codetag.lds.h.
Introduce include/asm-generic/dyndbg.lds.h, to bundle dynamic-debug's
multiple sections together, into 2 macros:
vmlinux.lds.h DATA_DATA: move the 2 BOUNDED_SECTION_BY(__dyndbg*)
calls into dyndbg.lds.h DYNDBG_SECTIONS(). vmlinux.lds.h now includes
the new file and calls the new macro.
MOD_DYNDBG_SECTIONS keeps the 2 sections by name, aligns them and sets
the output address to 0 when the sections are empty.
dyndbg.lds.h includes (reuses) bounded-section.lds.h
scripts/module.lds.S: now calls MOD_DYNDBG_SECTIONS right before the
CODETAG macro (consistent with their placements in vmlinux.lds.h), and
also includes dyndbg.lds.h
This isolates vmlinux.lds.h from further __dyndbg section additions.
CC: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Petr Pavlu <petr.pavlu@suse.com>
---
v3: move #includes to top, drop extra ALIGN(8) in DYNDBG_SECTIONS, add RvBy
v2: Address linker script review feedback for relocatable modules.
MOD_DYNDBG_SECTIONS() used the BOUNDED_SECTION_BY() macro, which
proved problematic for kernel modules for two reasons:
1. Unwanted Empty Sections:
BOUNDED_SECTION_BY() automatically generates `__start` and `__stop`
symbols. When applied to `MOD_DYNDBG_SECTIONS()`, the linker assumes
the sections are populated due to the symbol definitions, forcing an
empty `__dyndbg` and `__dyndbg_classes` output section in every
compiled module, even those without dynamic debug configuration.
Since the module loader uses `section_objs()` to locate data via
ELF headers instead of relying on `__start`/`__stop` symbols, these
assignments are completely unnecessary.
2. Non-zero Output Addresses:
During relocatable linking (e.g., `ld.bfd -r`), omitting an explicit
base address causes the section to inherit the current location
counter. This results in non-zero sh_addr values in `.ko` files,
which is confusing, degrades compressibility, and can cause issues
with external tools parsing the ELF.
Fix both issues by dropping `BOUNDED_SECTION_BY()` in favor of a simple
`KEEP(*(...))` constraint and explicitly defining the sections with a `0`
base address: `__dyndbg 0 : ALIGN(8) { ... }`.
fixup-inc-vml
---
MAINTAINERS | 1 +
include/asm-generic/dyndbg.lds.h | 18 ++++++++++++++++++
include/asm-generic/vmlinux.lds.h | 6 ++----
scripts/module.lds.S | 2 ++
4 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/MAINTAINERS b/MAINTAINERS
index 74790be45d06..009d628417d5 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9257,6 +9257,7 @@ DYNAMIC DEBUG
M: Jason Baron <jbaron@akamai.com>
M: Jim Cromie <jim.cromie@gmail.com>
S: Maintained
+F: include/asm-generic/dyndbg.lds.h
F: include/linux/dynamic_debug.h
F: lib/dynamic_debug.c
F: lib/test_dynamic_debug.c
diff --git a/include/asm-generic/dyndbg.lds.h b/include/asm-generic/dyndbg.lds.h
new file mode 100644
index 000000000000..9d8951bef688
--- /dev/null
+++ b/include/asm-generic/dyndbg.lds.h
@@ -0,0 +1,18 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+#ifndef __ASM_GENERIC_DYNDBG_LDS_H
+#define __ASM_GENERIC_DYNDBG_LDS_H
+
+#include <asm-generic/bounded_sections.lds.h>
+#define DYNDBG_SECTIONS() \
+ BOUNDED_SECTION_BY(__dyndbg, ___dyndbg) \
+ BOUNDED_SECTION_BY(__dyndbg_classes, ___dyndbg_classes)
+
+#define MOD_DYNDBG_SECTIONS() \
+ __dyndbg 0 : ALIGN(8) { \
+ KEEP(*(__dyndbg)) \
+ } \
+ __dyndbg_classes 0 : ALIGN(8) { \
+ KEEP(*(__dyndbg_classes)) \
+ }
+
+#endif /* __ASM_GENERIC_DYNDBG_LDS_H */
diff --git a/include/asm-generic/vmlinux.lds.h b/include/asm-generic/vmlinux.lds.h
index c3376665d027..48f00c5e8762 100644
--- a/include/asm-generic/vmlinux.lds.h
+++ b/include/asm-generic/vmlinux.lds.h
@@ -52,6 +52,7 @@
#include <asm-generic/bounded_sections.lds.h>
#include <asm-generic/codetag.lds.h>
+#include <asm-generic/dyndbg.lds.h>
#ifndef LOAD_OFFSET
#define LOAD_OFFSET 0
@@ -344,10 +345,7 @@
*(.data..do_once) \
STRUCT_ALIGN(); \
*(__tracepoints) \
- /* implement dynamic printk debug */ \
- . = ALIGN(8); \
- BOUNDED_SECTION_BY(__dyndbg_classes, ___dyndbg_classes) \
- BOUNDED_SECTION_BY(__dyndbg, ___dyndbg) \
+ DYNDBG_SECTIONS() \
CODETAG_SECTIONS() \
LIKELY_PROFILE() \
BRANCH_PROFILE() \
diff --git a/scripts/module.lds.S b/scripts/module.lds.S
index d0f200428957..5950ff8edc31 100644
--- a/scripts/module.lds.S
+++ b/scripts/module.lds.S
@@ -5,6 +5,7 @@
*/
#include <asm-generic/codetag.lds.h>
+#include <asm-generic/dyndbg.lds.h>
SECTIONS {
/DISCARD/ : {
@@ -56,6 +57,7 @@ SECTIONS {
*(.rodata..L*)
}
+ MOD_DYNDBG_SECTIONS()
MOD_SEPARATE_CODETAG_SECTIONS()
}
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 07/39] dyndbg: factor ddebug_match_desc out from ddebug_change
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (5 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 06/39] dyndbg.lds.S: fix lost dyndbg sections in modules Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 08/39] dyndbg: add stub macro for DECLARE_DYNDBG_CLASSMAP Jim Cromie via B4 Relay
` (31 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
ddebug_change() is a big (~100 lines) function with a nested for loop.
The outer loop walks the per-module ddebug_tables list, and does
module stuff: it filters on a query's "module FOO*" and "class BAR",
failures here skip the entire inner loop.
The inner loop (60 lines) scans a module's descriptors. It starts
with a long block of filters on function, line, format, and the
validated "BAR" class (or the legacy/_DPRINTK_CLASS_DFLT).
These filters "continue" past pr_debugs that don't match the query
criteria, before it falls through the code below that counts matches,
then adjusts the flags and static-keys. This is unnecessarily hard to
think about.
So move the per-descriptor filter-block into a boolean function:
ddebug_match_desc(desc), and change each "continue" to "return false".
This puts a clear interface in place, so any future changes are either
inside, outside, or across this interface.
also fix checkpatch complaints about spaces and braces.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v5: check for null format in callsite. shouldnt happen, but pr_debug() isnt illegal
v7: elevate null format to pr_err adding filename, function, lineno.
---
lib/dynamic_debug.c | 90 ++++++++++++++++++++++++++++++++---------------------
1 file changed, 54 insertions(+), 36 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 49334d1aa4b3..46ef31328194 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -172,6 +172,59 @@ static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table cons
* callsites, normally the same as number of changes. If verbose,
* logs the changes. Takes ddebug_lock.
*/
+static bool ddebug_match_desc(const struct ddebug_query *query,
+ struct _ddebug *dp,
+ int valid_class)
+{
+ /* match site against query-class */
+ if (dp->class_id != valid_class)
+ return false;
+
+ /* match against the source filename */
+ if (query->filename &&
+ !match_wildcard(query->filename, dp->filename) &&
+ !match_wildcard(query->filename,
+ kbasename(dp->filename)) &&
+ !match_wildcard(query->filename,
+ trim_prefix(dp->filename)))
+ return false;
+
+ /* match against the function */
+ if (query->function &&
+ !match_wildcard(query->function, dp->function))
+ return false;
+
+ /* match against the format */
+ if (query->format) {
+ if (!dp->format) {
+ pr_err_ratelimited("ddebug: NULL format string at %s:%s:%u\n",
+ dp->filename ? dp->filename : "?",
+ dp->function ? dp->function : "?",
+ dp->lineno);
+ return false;
+ }
+ if (*query->format == '^') {
+ char *p;
+ /* anchored search. match must be at beginning */
+ p = strstr(dp->format, query->format + 1);
+ if (p != dp->format)
+ return false;
+ } else if (!strstr(dp->format, query->format)) {
+ return false;
+ }
+ }
+
+ /* match against the line number range */
+ if (query->first_lineno &&
+ dp->lineno < query->first_lineno)
+ return false;
+ if (query->last_lineno &&
+ dp->lineno > query->last_lineno)
+ return false;
+
+ return true;
+}
+
static int ddebug_change(const struct ddebug_query *query,
struct flag_settings *modifiers)
{
@@ -204,42 +257,7 @@ static int ddebug_change(const struct ddebug_query *query,
for (i = 0; i < dt->num_ddebugs; i++) {
struct _ddebug *dp = &dt->ddebugs[i];
- /* match site against query-class */
- if (dp->class_id != valid_class)
- continue;
-
- /* match against the source filename */
- if (query->filename &&
- !match_wildcard(query->filename, dp->filename) &&
- !match_wildcard(query->filename,
- kbasename(dp->filename)) &&
- !match_wildcard(query->filename,
- trim_prefix(dp->filename)))
- continue;
-
- /* match against the function */
- if (query->function &&
- !match_wildcard(query->function, dp->function))
- continue;
-
- /* match against the format */
- if (query->format) {
- if (*query->format == '^') {
- char *p;
- /* anchored search. match must be at beginning */
- p = strstr(dp->format, query->format+1);
- if (p != dp->format)
- continue;
- } else if (!strstr(dp->format, query->format))
- continue;
- }
-
- /* match against the line number range */
- if (query->first_lineno &&
- dp->lineno < query->first_lineno)
- continue;
- if (query->last_lineno &&
- dp->lineno > query->last_lineno)
+ if (!ddebug_match_desc(query, dp, valid_class))
continue;
nfound++;
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 08/39] dyndbg: add stub macro for DECLARE_DYNDBG_CLASSMAP
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (6 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 07/39] dyndbg: factor ddebug_match_desc out from ddebug_change Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 09/39] dyndbg: reword "class unknown," to "class:_UNKNOWN_" Jim Cromie via B4 Relay
` (30 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Add the stub macro for !DYNAMIC_DEBUG builds, after moving the
original macro-defn down under the big ifdef. Do it now so future
changes have a cleaner starting point.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
include/linux/dynamic_debug.h | 43 ++++++++++++++++++++++---------------------
1 file changed, 22 insertions(+), 21 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 05743900a116..a10adac8e8f0 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -93,27 +93,6 @@ struct ddebug_class_map {
enum class_map_type map_type;
};
-/**
- * DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module
- * @_var: a struct ddebug_class_map, passed to module_param_cb
- * @_type: enum class_map_type, chooses bits/verbose, numeric/symbolic
- * @_base: offset of 1st class-name. splits .class_id space
- * @classes: class-names used to control class'd prdbgs
- */
-#define DECLARE_DYNDBG_CLASSMAP(_var, _maptype, _base, ...) \
- static const char *_var##_classnames[] = { __VA_ARGS__ }; \
- static struct ddebug_class_map __aligned(8) __used \
- __section("__dyndbg_classes") _var = { \
- .mod = THIS_MODULE, \
- .mod_name = KBUILD_MODNAME, \
- .base = _base, \
- .map_type = _maptype, \
- .length = NUM_TYPE_ARGS(char*, __VA_ARGS__), \
- .class_names = _var##_classnames, \
- }
-#define NUM_TYPE_ARGS(eltype, ...) \
- (sizeof((eltype[]){__VA_ARGS__}) / sizeof(eltype))
-
/* encapsulate linker provided built-in (or module) dyndbg data */
struct _ddebug_info {
struct _ddebug *descs;
@@ -138,6 +117,27 @@ struct ddebug_class_param {
#if defined(CONFIG_DYNAMIC_DEBUG) || \
(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
+/**
+ * DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module
+ * @_var: a struct ddebug_class_map, passed to module_param_cb
+ * @_type: enum class_map_type, chooses bits/verbose, numeric/symbolic
+ * @_base: offset of 1st class-name. splits .class_id space
+ * @classes: class-names used to control class'd prdbgs
+ */
+#define DECLARE_DYNDBG_CLASSMAP(_var, _maptype, _base, ...) \
+ static const char *_var##_classnames[] = { __VA_ARGS__ }; \
+ static struct ddebug_class_map __aligned(8) __used \
+ __section("__dyndbg_classes") _var = { \
+ .mod = THIS_MODULE, \
+ .mod_name = KBUILD_MODNAME, \
+ .base = _base, \
+ .map_type = _maptype, \
+ .length = NUM_TYPE_ARGS(char*, __VA_ARGS__), \
+ .class_names = _var##_classnames, \
+ }
+#define NUM_TYPE_ARGS(eltype, ...) \
+ (sizeof((eltype[]) {__VA_ARGS__}) / sizeof(eltype))
+
extern __printf(2, 3)
void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
@@ -314,6 +314,7 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt)
#define DYNAMIC_DEBUG_BRANCH(descriptor) false
+#define DECLARE_DYNDBG_CLASSMAP(...)
#define dynamic_pr_debug(fmt, ...) \
no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 09/39] dyndbg: reword "class unknown," to "class:_UNKNOWN_"
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (7 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 08/39] dyndbg: add stub macro for DECLARE_DYNDBG_CLASSMAP Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 10/39] dyndbg-API: remove DD_CLASS_TYPE_(DISJOINT|LEVEL)_NAMES and code Jim Cromie via B4 Relay
` (29 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
When a dyndbg classname is unknown to a kernel module, the callsite is
un-addressable via >control queries, and therefore uncontrollable.
The control-file displays this condition as "class unknown, _id:N"
currently. That spelling is sub-optimal/too-generic, so change it to
"class:_UNKNOWN_ _id:N" to loudly announce the erroneous situation,
and to make it uniquely greppable.
NB: while this might be seen as a user-visible change, this shouldn't
disqualify the change:
a- it reports a classmap coding error condition, which should be
detected in (or before) review.
b- SHOUTING the error makes it more visible, uniquely greppable.
c- the classmap feature is marked BROKEN for its only current user.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
lib/dynamic_debug.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 46ef31328194..5e4b9f7709a2 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -1173,7 +1173,7 @@ static int ddebug_proc_show(struct seq_file *m, void *p)
if (class)
seq_printf(m, " class:%s", class);
else
- seq_printf(m, " class unknown, _id:%d", dp->class_id);
+ seq_printf(m, " class:_UNKNOWN_ _id:%d", dp->class_id);
}
seq_putc(m, '\n');
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 10/39] dyndbg-API: remove DD_CLASS_TYPE_(DISJOINT|LEVEL)_NAMES and code
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (8 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 09/39] dyndbg: reword "class unknown," to "class:_UNKNOWN_" Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 11/39] dyndbg: drop NUM_TYPE_ARGS Jim Cromie via B4 Relay
` (28 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
Remove the DD_CLASS_TYPE_*_NAMES classmap types and code.
These 2 classmap types accept class names at the PARAM interface, for
example:
echo +DRM_UT_CORE,-DRM_UT_KMS > /sys/module/drm/parameters/debug_names
The code works, but its only used by test-dynamic-debug, and wasn't
asked for by anyone else, so reduce LOC & test-surface; simplify things.
Also rename enum class_map_type to enum ddebug_class_map_type.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v3:
fix name of enum in kdoc
also change name of struct (to future name)
v2:
move RvB after SoB
respect const instr in param_set_dyndbg_module_classes, return -EINVAL on classtype err.
---
include/linux/dynamic_debug.h | 28 ++++---------
lib/dynamic_debug.c | 98 +++----------------------------------------
lib/test_dynamic_debug.c | 26 ------------
3 files changed, 15 insertions(+), 137 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index a10adac8e8f0..9607121c3072 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -59,27 +59,17 @@ struct _ddebug {
#endif
} __attribute__((aligned(8)));
-enum class_map_type {
+enum ddebug_class_map_type {
DD_CLASS_TYPE_DISJOINT_BITS,
/**
- * DD_CLASS_TYPE_DISJOINT_BITS: classes are independent, one per bit.
- * expecting hex input. Built for drm.debug, basis for other types.
+ * DD_CLASS_TYPE_DISJOINT_BITS: classes are independent,
+ * mapped to bits[0..N]. Expects hex input. Built for
+ * drm.debug, basis for other types.
*/
DD_CLASS_TYPE_LEVEL_NUM,
/**
- * DD_CLASS_TYPE_LEVEL_NUM: input is numeric level, 0-N.
- * N turns on just bits N-1 .. 0, so N=0 turns all bits off.
- */
- DD_CLASS_TYPE_DISJOINT_NAMES,
- /**
- * DD_CLASS_TYPE_DISJOINT_NAMES: input is a CSV of [+-]CLASS_NAMES,
- * classes are independent, like _DISJOINT_BITS.
- */
- DD_CLASS_TYPE_LEVEL_NAMES,
- /**
- * DD_CLASS_TYPE_LEVEL_NAMES: input is a CSV of [+-]CLASS_NAMES,
- * intended for names like: INFO,DEBUG,TRACE, with a module prefix
- * avoid EMERG,ALERT,CRIT,ERR,WARNING: they're not debug
+ * DD_CLASS_TYPE_LEVEL_NUM: input is numeric level, 0..N.
+ * Input N turns on bits 0..N-1
*/
};
@@ -90,7 +80,7 @@ struct ddebug_class_map {
const char **class_names;
const int length;
const int base; /* index of 1st .class_id, allows split/shared space */
- enum class_map_type map_type;
+ enum ddebug_class_map_type map_type;
};
/* encapsulate linker provided built-in (or module) dyndbg data */
@@ -119,8 +109,8 @@ struct ddebug_class_param {
/**
* DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module
- * @_var: a struct ddebug_class_map, passed to module_param_cb
- * @_type: enum class_map_type, chooses bits/verbose, numeric/symbolic
+ * @_var: a struct _ddebug_class_map, passed to module_param_cb
+ * @_maptype: enum ddebug_class_map_type, chooses bits/verbose
* @_base: offset of 1st class-name. splits .class_id space
* @classes: class-names used to control class'd prdbgs
*/
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 5e4b9f7709a2..113569285d30 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -653,76 +653,6 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
#define CLASSMAP_BITMASK(width) ((1UL << (width)) - 1)
-/* accept comma-separated-list of [+-] classnames */
-static int param_set_dyndbg_classnames(const char *instr, const struct kernel_param *kp)
-{
- const struct ddebug_class_param *dcp = kp->arg;
- const struct ddebug_class_map *map = dcp->map;
- unsigned long curr_bits, old_bits;
- char *cl_str, *p, *tmp;
- int cls_id, totct = 0;
- bool wanted;
-
- cl_str = tmp = kstrdup_and_replace(instr, '\n', '\0', GFP_KERNEL);
- if (!tmp)
- return -ENOMEM;
-
- /* start with previously set state-bits, then modify */
- curr_bits = old_bits = *dcp->bits;
- vpr_info("\"%s\" > %s:0x%lx\n", cl_str, KP_NAME(kp), curr_bits);
-
- for (; cl_str; cl_str = p) {
- p = strchr(cl_str, ',');
- if (p)
- *p++ = '\0';
-
- if (*cl_str == '-') {
- wanted = false;
- cl_str++;
- } else {
- wanted = true;
- if (*cl_str == '+')
- cl_str++;
- }
- cls_id = match_string(map->class_names, map->length, cl_str);
- if (cls_id < 0) {
- pr_err("%s unknown to %s\n", cl_str, KP_NAME(kp));
- continue;
- }
-
- /* have one or more valid class_ids of one *_NAMES type */
- switch (map->map_type) {
- case DD_CLASS_TYPE_DISJOINT_NAMES:
- /* the +/- pertains to a single bit */
- if (test_bit(cls_id, &curr_bits) == wanted) {
- v3pr_info("no change on %s\n", cl_str);
- continue;
- }
- curr_bits ^= BIT(cls_id);
- totct += ddebug_apply_class_bitmap(dcp, &curr_bits, dcp->bits);
- *dcp->bits = curr_bits;
- v2pr_info("%s: changed bit %d:%s\n", KP_NAME(kp), cls_id,
- map->class_names[cls_id]);
- break;
- case DD_CLASS_TYPE_LEVEL_NAMES:
- /* cls_id = N in 0..max. wanted +/- determines N or N-1 */
- old_bits = CLASSMAP_BITMASK(*dcp->lvl);
- curr_bits = CLASSMAP_BITMASK(cls_id + (wanted ? 1 : 0 ));
-
- totct += ddebug_apply_class_bitmap(dcp, &curr_bits, &old_bits);
- *dcp->lvl = (cls_id + (wanted ? 1 : 0));
- v2pr_info("%s: changed bit-%d: \"%s\" %lx->%lx\n", KP_NAME(kp), cls_id,
- map->class_names[cls_id], old_bits, curr_bits);
- break;
- default:
- pr_err("illegal map-type value %d\n", map->map_type);
- }
- }
- kfree(tmp);
- vpr_info("total matches: %d\n", totct);
- return 0;
-}
-
/**
* param_set_dyndbg_classes - class FOO >control
* @instr: string echo>d to sysfs, input depends on map_type
@@ -741,28 +671,15 @@ int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
unsigned long inrep, new_bits, old_bits;
int rc, totct = 0;
- switch (map->map_type) {
-
- case DD_CLASS_TYPE_DISJOINT_NAMES:
- case DD_CLASS_TYPE_LEVEL_NAMES:
- /* handle [+-]classnames list separately, we are done here */
- return param_set_dyndbg_classnames(instr, kp);
+ rc = kstrtoul(instr, 0, &inrep);
+ if (rc) {
+ int len = strcspn(instr, "\n");
- case DD_CLASS_TYPE_DISJOINT_BITS:
- case DD_CLASS_TYPE_LEVEL_NUM:
- /* numeric input, accept and fall-thru */
- rc = kstrtoul(instr, 0, &inrep);
- if (rc) {
- pr_err("expecting numeric input: %s > %s\n", instr, KP_NAME(kp));
- return -EINVAL;
- }
- break;
- default:
- pr_err("%s: bad map type: %d\n", KP_NAME(kp), map->map_type);
+ pr_err("expecting numeric input, not: %.*s > %s\n",
+ len, instr, KP_NAME(kp));
return -EINVAL;
}
- /* only _BITS,_NUM (numeric) map-types get here */
switch (map->map_type) {
case DD_CLASS_TYPE_DISJOINT_BITS:
/* expect bits. mask and warn if too many */
@@ -790,6 +707,7 @@ int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
break;
default:
pr_warn("%s: bad map type: %d\n", KP_NAME(kp), map->map_type);
+ return -EINVAL;
}
vpr_info("%s: total matches: %d\n", KP_NAME(kp), totct);
return 0;
@@ -811,12 +729,8 @@ int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp)
const struct ddebug_class_map *map = dcp->map;
switch (map->map_type) {
-
- case DD_CLASS_TYPE_DISJOINT_NAMES:
case DD_CLASS_TYPE_DISJOINT_BITS:
return scnprintf(buffer, PAGE_SIZE, "0x%lx\n", *dcp->bits);
-
- case DD_CLASS_TYPE_LEVEL_NAMES:
case DD_CLASS_TYPE_LEVEL_NUM:
return scnprintf(buffer, PAGE_SIZE, "%d\n", *dcp->lvl);
default:
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 77c2a669b6af..74d183ebf3e0 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -74,13 +74,6 @@ DECLARE_DYNDBG_CLASSMAP(map_disjoint_bits, DD_CLASS_TYPE_DISJOINT_BITS, 0,
DD_SYS_WRAP(disjoint_bits, p);
DD_SYS_WRAP(disjoint_bits, T);
-/* symbolic input, independent bits */
-enum cat_disjoint_names { LOW = 11, MID, HI };
-DECLARE_DYNDBG_CLASSMAP(map_disjoint_names, DD_CLASS_TYPE_DISJOINT_NAMES, 10,
- "LOW", "MID", "HI");
-DD_SYS_WRAP(disjoint_names, p);
-DD_SYS_WRAP(disjoint_names, T);
-
/* numeric verbosity, V2 > V1 related */
enum cat_level_num { V0 = 14, V1, V2, V3, V4, V5, V6, V7 };
DECLARE_DYNDBG_CLASSMAP(map_level_num, DD_CLASS_TYPE_LEVEL_NUM, 14,
@@ -88,13 +81,6 @@ DECLARE_DYNDBG_CLASSMAP(map_level_num, DD_CLASS_TYPE_LEVEL_NUM, 14,
DD_SYS_WRAP(level_num, p);
DD_SYS_WRAP(level_num, T);
-/* symbolic verbosity */
-enum cat_level_names { L0 = 22, L1, L2, L3, L4, L5, L6, L7 };
-DECLARE_DYNDBG_CLASSMAP(map_level_names, DD_CLASS_TYPE_LEVEL_NAMES, 22,
- "L0", "L1", "L2", "L3", "L4", "L5", "L6", "L7");
-DD_SYS_WRAP(level_names, p);
-DD_SYS_WRAP(level_names, T);
-
/* stand-in for all pr_debug etc */
#define prdbg(SYM) __pr_debug_cls(SYM, #SYM " msg\n")
@@ -102,10 +88,6 @@ static void do_cats(void)
{
pr_debug("doing categories\n");
- prdbg(LOW);
- prdbg(MID);
- prdbg(HI);
-
prdbg(D2_CORE);
prdbg(D2_DRIVER);
prdbg(D2_KMS);
@@ -129,14 +111,6 @@ static void do_levels(void)
prdbg(V5);
prdbg(V6);
prdbg(V7);
-
- prdbg(L1);
- prdbg(L2);
- prdbg(L3);
- prdbg(L4);
- prdbg(L5);
- prdbg(L6);
- prdbg(L7);
}
static void do_prints(void)
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 11/39] dyndbg: drop NUM_TYPE_ARGS
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (9 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 10/39] dyndbg-API: remove DD_CLASS_TYPE_(DISJOINT|LEVEL)_NAMES and code Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 12/39] dyndbg: bump num-tokens in a query-cmd from 9 to 15 Jim Cromie via B4 Relay
` (27 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
ARRAY_SIZE almost works here, since array decl is complete.
But define it locally, named __DDEBUG_ARRAY_SIZE, to avoid
include conflicts with boot/<something> on some arch.
no functional change
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v7: actually use macro
v5: drop include, it causes redefined probs in /boot/* for some arch.
v2: include linux/array_size.h, correct commit subject, review after sob
---
include/linux/dynamic_debug.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 9607121c3072..baf5c0853f45 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -8,6 +8,8 @@
#include <linux/build_bug.h>
+#define __DDEBUG_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
+
/*
* An instance of this structure is created in a special
* ELF section at every dynamic debug callsite. At runtime,
@@ -122,11 +124,9 @@ struct ddebug_class_param {
.mod_name = KBUILD_MODNAME, \
.base = _base, \
.map_type = _maptype, \
- .length = NUM_TYPE_ARGS(char*, __VA_ARGS__), \
.class_names = _var##_classnames, \
+ .length = __DDEBUG_ARRAY_SIZE(_var##_classnames), \
}
-#define NUM_TYPE_ARGS(eltype, ...) \
- (sizeof((eltype[]) {__VA_ARGS__}) / sizeof(eltype))
extern __printf(2, 3)
void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 12/39] dyndbg: bump num-tokens in a query-cmd from 9 to 15
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (10 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 11/39] dyndbg: drop NUM_TYPE_ARGS Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 13/39] dyndbg: reduce verbose/debug clutter Jim Cromie via B4 Relay
` (26 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Current MAXWORDS in ddebug_exec_query() is too small to accept a legal
query-command using all 6 keywords. We *need* 13, but this adds a few
extra to allow certain errors to fail on subsequent, more meaningful
grammar checks.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
lib/dynamic_debug.c | 2 +-
tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh | 12 ++++++------
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 113569285d30..43850ff5ccc3 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -557,7 +557,7 @@ static int ddebug_exec_query(char *query_string, const char *modname)
{
struct flag_settings modifiers = {};
struct ddebug_query query = {};
-#define MAXWORDS 9
+#define MAXWORDS 15
int nwords, nfound;
char *words[MAXWORDS];
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 49dd85adb36c..bf02c505f1b5 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -619,8 +619,8 @@ function GOLDEN_RECORDS {
#K= 9c405e06fcea50284df82d1ae9692403 FT_grammar_errs.2
#K= 0b0d9b0e6f4c45c7d75d699fd3b6aa93 FT_grammar_errs.3
#K= e008644e159c2a9d99a8d0806c06e71e FT_grammar_errs.4
-#K= 11833e6cf8fe8b03869aa4f669b63398 FT_grammar_errs.5
-#K= e85a4b665f5ef141e3f4d4505dec1da1 FT_grammar_errs.6
+#K= 5750ed178633f9a68623f928c093d16e FT_grammar_errs.5
+#K= 2cd51e5e3c3e2501544524bed0fab620 FT_grammar_errs.6
#K= 3e1eba65bd936e1276c7e1d76b399595 FT_grammar_errs.7
#K= e3ac86676e309d4e72ff3da287736c29 FT_grammar_errs.8
#K= 466d325c23519119f754fa7860bae7c6 FT_grammar_errs.9
@@ -633,8 +633,8 @@ function GOLDEN_RECORDS {
#K= bd8d9cf661c9aca54dac93c74cfc1501 FT_grammar_errs.16
#K= e991391048f2fdffaaed99ba36b787ed FT_grammar_errs.17
#K= 82d99278f471ebfbf47eeb19898525cf FT_grammar_errs.18
-#K= 3c8d268c94b0bf97e64999654cd840c4 FT_grammar_errs.19
-#K= 1a448ff3f1df9155cc3acf1e124f24f5 FT_grammar_errs.20
+#K= f3f088fa7d276981bf2898c048087f76 FT_grammar_errs.19
+#K= 984ecc198e0fa9fc91bc31caf7da2a5d FT_grammar_errs.20
#K= 76c8a33c585d414fcc3f1c8b5ea5b4b3 FT_grammar_errs.21
#K= 90cfc66e9d61f5c448353b97baa99145 FT_grammar_errs.22
#K= 37a51dfd6e84cb64b69d3a0e23e68ceb FT_grammar_errs.23
@@ -647,8 +647,8 @@ function GOLDEN_RECORDS {
#K= 2e37642dc8aee3d04b8a54a76b3b891c FT_grammar_errs.30
#K= 593c8b4c41932e3bde564a0008627ced FT_grammar_errs.31
#K= 85a2a0bee8d0cd10f883aa5477d62efb FT_grammar_errs.32
-#K= 3c8d268c94b0bf97e64999654cd840c4 FT_grammar_errs.33
-#K= 1a448ff3f1df9155cc3acf1e124f24f5 FT_grammar_errs.34
+#K= f3f088fa7d276981bf2898c048087f76 FT_grammar_errs.33
+#K= 629f6a7e379e02f38c543cdb48e3b84f FT_grammar_errs.34
#K= d9f0cffb0898c54690735a71b0d4f3bf FT_grammar_errs.35
#K= 4cf728b6a32043ea5336a14d0c435312 FT_grammar_errs.36
#K= a11ae3f86f4e5f539fd6168d318f74b4 FT_grammar_errs.37
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 13/39] dyndbg: reduce verbose/debug clutter
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (11 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 12/39] dyndbg: bump num-tokens in a query-cmd from 9 to 15 Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 14/39] lib/parser: add match_wildcard_hyphen() for agnostic matching Jim Cromie via B4 Relay
` (25 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
currently, for verbose=3, these are logged (blank lines for clarity):
dyndbg: query 0: "class DRM_UT_CORE +p" mod:*
dyndbg: split into words: "class" "DRM_UT_CORE" "+p"
dyndbg: op='+'
dyndbg: flags=0x1
dyndbg: *flagsp=0x1 *maskp=0xffffffff
dyndbg: parsed: func="" file="" module="" format="" lineno=0-0 class=...
dyndbg: no matches for query
dyndbg: no-match: func="" file="" module="" format="" lineno=0-0 class=...
dyndbg: processed 1 queries, with 0 matches, 0 errs
That is excessive, so this patch:
- shrinks 3 lines of 2nd stanza to single line
- drops 1st 2 lines of 3rd stanza
3rd line is like 1st, with result, not procedure.
2nd line is just status, retold in 4th, with more info.
New output:
dyndbg: query 0: "class DRM_UT_CORE +p"
dyndbg: split into words: "class" "DRM_UT_CORE" "+p"
dyndbg: op='+' flags=0x1 maskp=0xffffffff
dyndbg: processed 1 queries, with 0 matches, 0 errs
Also drop several verbose=3 messages in ddebug_add_module. When
modprobing a module, dyndbg currently logs/says "add-module", and then
"skipping" if the module has no prdbgs. Instead just check 1st and
return quietly.
Unmatched query diagnostics are intentionally restricted to verbose
level 3 (v3pr_info_dq) to reduce dmesg output clutter on standard
verbose levels (verbose=1 and verbose=2), aligning with the overall
de-cluttering of dynamic debug logging.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v7: update fingerprints of grammar-errs changed here
v4: rename vpr_dq_info to v3pr_dq_info to tell its active logging level
adjust some vX levels per doc'd intentions
v2: RvB after SoB
trivial change to verbose-debug output line to output the actual
"module" keyword rather than "mod:", and do so only when the module is
constrained by the callchain (ie as part of a modprobe).
was: query X: "(keyword value)* [+-=]flags" mod:*
now: query X: "(keyword value)* [+-=]flags"
or query X: module FOO "keyword value)* [+-=]flags"
IOW, adjust output to reflect the input grammar more closely.
---
lib/dynamic_debug.c | 24 +++----
.../selftests/dynamic_debug/dyndbg_selftest.sh | 84 +++++++++++-----------
2 files changed, 52 insertions(+), 56 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 43850ff5ccc3..2a69f86f973e 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -128,7 +128,7 @@ do { \
#define v3pr_info(fmt, ...) vnpr_info(3, fmt, ##__VA_ARGS__)
#define v4pr_info(fmt, ...) vnpr_info(4, fmt, ##__VA_ARGS__)
-static void vpr_info_dq(const struct ddebug_query *query, const char *msg)
+static void v3pr_info_dq(const struct ddebug_query *query, const char *msg)
{
/* trim any trailing newlines */
int fmtlen = 0;
@@ -283,9 +283,6 @@ static int ddebug_change(const struct ddebug_query *query,
}
mutex_unlock(&ddebug_lock);
- if (!nfound && verbose)
- pr_info("no matches for query\n");
-
return nfound;
}
@@ -494,7 +491,6 @@ static int ddebug_parse_query(char *words[], int nwords,
*/
query->module = modname;
- vpr_info_dq(query, "parsed");
return 0;
}
@@ -518,7 +514,6 @@ static int ddebug_parse_flags(const char *str, struct flag_settings *modifiers)
pr_err("bad flag-op %c, at start of %s\n", *str, str);
return -EINVAL;
}
- v3pr_info("op='%c'\n", op);
for (; *str ; ++str) {
for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) {
@@ -532,7 +527,6 @@ static int ddebug_parse_flags(const char *str, struct flag_settings *modifiers)
return -EINVAL;
}
}
- v3pr_info("flags=0x%x\n", modifiers->flags);
/* calculate final flags, mask based upon op */
switch (op) {
@@ -548,7 +542,7 @@ static int ddebug_parse_flags(const char *str, struct flag_settings *modifiers)
modifiers->flags = 0;
break;
}
- v3pr_info("*flagsp=0x%x *maskp=0x%x\n", modifiers->flags, modifiers->mask);
+ v3pr_info("op='%c' flags=0x%x maskp=0x%x\n", op, modifiers->flags, modifiers->mask);
return 0;
}
@@ -577,7 +571,7 @@ static int ddebug_exec_query(char *query_string, const char *modname)
}
/* actually go and implement the change */
nfound = ddebug_change(&query, &modifiers);
- vpr_info_dq(&query, nfound ? "applied" : "no-match");
+ v3pr_info_dq(&query, nfound ? "applied" : "no-match");
return nfound;
}
@@ -600,7 +594,10 @@ static int ddebug_exec_queries(char *query, const char *modname)
if (!query || !*query || *query == '#')
continue;
- vpr_info("query %d: \"%s\" mod:%s\n", i, query, modname ?: "*");
+ if (modname)
+ v2pr_info("query %d: module %s \"%s\"\n", i, modname, query);
+ else
+ v2pr_info("query %d: \"%s\"\n", i, query);
rc = ddebug_exec_query(query, modname);
if (rc < 0) {
@@ -1167,11 +1164,10 @@ static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
{
struct ddebug_table *dt;
- v3pr_info("add-module: %s.%d sites\n", modname, di->num_descs);
- if (!di->num_descs) {
- v3pr_info(" skip %s\n", modname);
+ if (!di->num_descs)
return 0;
- }
+
+ v3pr_info("add-module: %s %d sites\n", modname, di->num_descs);
dt = kzalloc_obj(*dt);
if (dt == NULL) {
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index bf02c505f1b5..e9f9db35fb7f 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -615,48 +615,48 @@ modular_tests=(
# ==============================================================================
function GOLDEN_RECORDS {
cat << 'EOF' | {
-#K= bb85d28739876b0fdf1eb426baae8ef7 FT_grammar_errs.1
-#K= 9c405e06fcea50284df82d1ae9692403 FT_grammar_errs.2
-#K= 0b0d9b0e6f4c45c7d75d699fd3b6aa93 FT_grammar_errs.3
-#K= e008644e159c2a9d99a8d0806c06e71e FT_grammar_errs.4
-#K= 5750ed178633f9a68623f928c093d16e FT_grammar_errs.5
-#K= 2cd51e5e3c3e2501544524bed0fab620 FT_grammar_errs.6
-#K= 3e1eba65bd936e1276c7e1d76b399595 FT_grammar_errs.7
-#K= e3ac86676e309d4e72ff3da287736c29 FT_grammar_errs.8
-#K= 466d325c23519119f754fa7860bae7c6 FT_grammar_errs.9
-#K= 51c489366cd86c16280858b95adf34ac FT_grammar_errs.10
-#K= dfc632c6c0cd6206b6141dbc5fb989db FT_grammar_errs.11
-#K= 69650fc26e97a78082bd851eb4a5c83b FT_grammar_errs.12
-#K= 5cfe5665962a482f416836793067f2a2 FT_grammar_errs.13
-#K= 661cc9a2d8d3c381bfeae41392432575 FT_grammar_errs.14
-#K= 5dd0accf9be37ce2f4bf697e9bdebe30 FT_grammar_errs.15
-#K= bd8d9cf661c9aca54dac93c74cfc1501 FT_grammar_errs.16
-#K= e991391048f2fdffaaed99ba36b787ed FT_grammar_errs.17
-#K= 82d99278f471ebfbf47eeb19898525cf FT_grammar_errs.18
-#K= f3f088fa7d276981bf2898c048087f76 FT_grammar_errs.19
-#K= 984ecc198e0fa9fc91bc31caf7da2a5d FT_grammar_errs.20
-#K= 76c8a33c585d414fcc3f1c8b5ea5b4b3 FT_grammar_errs.21
-#K= 90cfc66e9d61f5c448353b97baa99145 FT_grammar_errs.22
-#K= 37a51dfd6e84cb64b69d3a0e23e68ceb FT_grammar_errs.23
-#K= 3aefa325b63742710b45e4531152c9d8 FT_grammar_errs.24
-#K= bc8d2c23282cd6834879bc1f1b303d05 FT_grammar_errs.25
-#K= 092ec5530d875be1dc96ad4202fc7dc3 FT_grammar_errs.26
-#K= 98caa2677e9070953a852b27ab57861e FT_grammar_errs.27
-#K= 8d755baa707c7b3b67491bf84708ef08 FT_grammar_errs.28
-#K= 5dd0accf9be37ce2f4bf697e9bdebe30 FT_grammar_errs.29
-#K= 2e37642dc8aee3d04b8a54a76b3b891c FT_grammar_errs.30
-#K= 593c8b4c41932e3bde564a0008627ced FT_grammar_errs.31
-#K= 85a2a0bee8d0cd10f883aa5477d62efb FT_grammar_errs.32
-#K= f3f088fa7d276981bf2898c048087f76 FT_grammar_errs.33
-#K= 629f6a7e379e02f38c543cdb48e3b84f FT_grammar_errs.34
-#K= d9f0cffb0898c54690735a71b0d4f3bf FT_grammar_errs.35
-#K= 4cf728b6a32043ea5336a14d0c435312 FT_grammar_errs.36
-#K= a11ae3f86f4e5f539fd6168d318f74b4 FT_grammar_errs.37
-#K= c7d3830b0391f6a773205066b64e15f9 FT_grammar_errs.38
-#K= 5c506ea2bfd050439b580b91543e9be7 FT_grammar_errs.39
-#K= a257660007408f7bb0cb43c99b1c7bb8 FT_grammar_errs.40
-#K= 0082939f100300a7b327b143cf40cb43 FT_grammar_errs.41
-#K= 657ac4360f978687ad25a705b2bb89f1 FT_grammar_errs.42
+#K= f3dbd5afb9aa1750f93275b634499e22 FT_grammar_errs.1
+#K= 200c01632c52a63f6d186da1c6460740 FT_grammar_errs.2
+#K= 7d7141900ce6e32f15c99202309c63a4 FT_grammar_errs.3
+#K= 1bb798a5831d0119789d424ef6cb55c4 FT_grammar_errs.4
+#K= 5edd66e308b2792d5694df86c07a3eaf FT_grammar_errs.5
+#K= 6f87d92ffe0812550f43287127c6f2b9 FT_grammar_errs.6
+#K= c0eb05b58a008c722e091e1ae74440ec FT_grammar_errs.7
+#K= 911929ec0e2ffc1f13822b479dec6805 FT_grammar_errs.8
+#K= c1407512376369d2e591a4b25a4b607a FT_grammar_errs.9
+#K= 2046abda72725ea06fe339d5f364f1c9 FT_grammar_errs.10
+#K= b72f7fccf76f8a5bee47a05d7bb545fb FT_grammar_errs.11
+#K= 98e2bd3e4f3da58536496a38ec3e6238 FT_grammar_errs.12
+#K= b371c6ba52503d037dbc43da788af8be FT_grammar_errs.13
+#K= cb8288d607b0c5282125852f3ab05107 FT_grammar_errs.14
+#K= 9346a310c4ad57cc3746afbace702c3e FT_grammar_errs.15
+#K= 533d27af85eed3c0fd2eaec961982a36 FT_grammar_errs.16
+#K= 114e0632585e205a3347c82bac7d79f2 FT_grammar_errs.17
+#K= 73f5c173bafdfb9674b5ecce77db3354 FT_grammar_errs.18
+#K= 0fc110d078f60eacdd389e5975ba18d9 FT_grammar_errs.19
+#K= 815a1c52f365510c644450bb80c07e72 FT_grammar_errs.20
+#K= 621e3cd81b553973cb40a935bb9298f1 FT_grammar_errs.21
+#K= 581222901232344ade18bbda58302c48 FT_grammar_errs.22
+#K= ea0aae3e01b3bb22eb8ad7acd327b371 FT_grammar_errs.23
+#K= 8f28189bff62a3d5ed16f537d41a725a FT_grammar_errs.24
+#K= 19c425e5d3a645b5dc5e23758ba0f4a1 FT_grammar_errs.25
+#K= 75415542333f2250f0e060a54dae50f8 FT_grammar_errs.26
+#K= 0955815c0e595ab2206e25aa31fe1ef2 FT_grammar_errs.27
+#K= 3ff4c0b60db33e44c3cd6f0e14f81e3e FT_grammar_errs.28
+#K= 9346a310c4ad57cc3746afbace702c3e FT_grammar_errs.29
+#K= 7aaf0a16c287e66b62e11298ee160b34 FT_grammar_errs.30
+#K= 06350c62105b537cdd0c67736b29727d FT_grammar_errs.31
+#K= 6ef0ec01805c8719d828553098f95377 FT_grammar_errs.32
+#K= 0fc110d078f60eacdd389e5975ba18d9 FT_grammar_errs.33
+#K= 72203b2d88d0617cd5c659d3b80e26f9 FT_grammar_errs.34
+#K= 6ecb03736d5cddb7ab2aaff49d561be9 FT_grammar_errs.35
+#K= eaa989336cb7c96c13ef4a3964fc6898 FT_grammar_errs.36
+#K= 5b624d9c133d7bb4f5370c3ce06929ed FT_grammar_errs.37
+#K= 127275739b1fe04c84eedad28ec154f6 FT_grammar_errs.38
+#K= 3e2fd15a7e8c0583bc5066524bc50508 FT_grammar_errs.39
+#K= 781995971d28f732a792522f3c56cdd3 FT_grammar_errs.40
+#K= 6614a677d9f9ac09d9825b4e989d2c42 FT_grammar_errs.41
+#K= 70de9afed457a6be9f9c3c81cbd6d4d5 FT_grammar_errs.42
#K= 6e8599556a312200fb6d484565b6c52f FT_basic_queries.1
#K= db17180b59444e5e34a8fc20c40e4530 FT_basic_queries.2
#K= f7bd56bd407ff255ef2e3b5fb093ae6a FT_basic_queries.3
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 14/39] lib/parser: add match_wildcard_hyphen() for agnostic matching
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (12 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 13/39] dyndbg: reduce verbose/debug clutter Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 15/39] kbuild, dyndbg: Clean up builtin module-name ambiguities Jim Cromie via B4 Relay
` (24 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
This commit introduces match_wildcard_hyphen() as a variant of the
existing match_wildcard() function. It treats hyphens and underscores
as identical characters during the matching process.
This is necessary for subsystems like dynamic_debug that need to match
module names provided by users (who often use underscores) against
names stored in the kernel (which may use hyphens, especially when
using KBUILD_MODFILE for built-ins).
To avoid code duplication, the core logic is refactored into a private
__match_wildcard() function marked as __always_inline. This allows the
compiler to generate optimized versions for both the strict and agnostic
callsites with zero runtime overhead.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v5: move ahead of array-slice patch to silence sashiko complaint about it
v4: initial version
---
include/linux/parser.h | 1 +
lib/parser.c | 58 ++++++++++++++++------
.../selftests/dynamic_debug/dyndbg_selftest.sh | 2 +-
3 files changed, 45 insertions(+), 16 deletions(-)
diff --git a/include/linux/parser.h b/include/linux/parser.h
index dd79f45a37b8..a3cc7bc5fb93 100644
--- a/include/linux/parser.h
+++ b/include/linux/parser.h
@@ -34,6 +34,7 @@ int match_u64(substring_t *, u64 *result);
int match_octal(substring_t *, int *result);
int match_hex(substring_t *, int *result);
bool match_wildcard(const char *pattern, const char *str);
+bool match_wildcard_hyphen(const char *pattern, const char *str);
size_t match_strlcpy(char *, const substring_t *, size_t);
char *match_strdup(const substring_t *);
diff --git a/lib/parser.c b/lib/parser.c
index 62da0ac0d438..d5be01fa9adf 100644
--- a/lib/parser.c
+++ b/lib/parser.c
@@ -268,20 +268,13 @@ int match_hex(substring_t *s, int *result)
}
EXPORT_SYMBOL(match_hex);
-/**
- * match_wildcard - parse if a string matches given wildcard pattern
- * @pattern: wildcard pattern
- * @str: the string to be parsed
- *
- * Description: Parse the string @str to check if matches wildcard
- * pattern @pattern. The pattern may contain two types of wildcards:
- *
- * * '*' - matches zero or more characters
- * * '?' - matches one character
- *
- * Return: If the @str matches the @pattern, return true, else return false.
- */
-bool match_wildcard(const char *pattern, const char *str)
+static inline char dash2underscore(char c)
+{
+ return (c == '-') ? '_' : c;
+}
+
+static __always_inline bool __match_wildcard(const char *pattern, const char *str,
+ bool hyphen_agnostic)
{
const char *s = str;
const char *p = pattern;
@@ -301,7 +294,9 @@ bool match_wildcard(const char *pattern, const char *str)
pattern = p;
break;
default:
- if (*s == *p) {
+ if (hyphen_agnostic ?
+ (dash2underscore(*s) == dash2underscore(*p)) :
+ (*s == *p)) {
s++;
p++;
} else {
@@ -319,8 +314,41 @@ bool match_wildcard(const char *pattern, const char *str)
++p;
return !*p;
}
+
+/**
+ * match_wildcard - parse if a string matches given wildcard pattern
+ * @pattern: wildcard pattern
+ * @str: the string to be parsed
+ *
+ * Description: Parse the string @str to check if matches wildcard
+ * pattern @pattern. The pattern may contain two types of wildcards:
+ *
+ * * '*' - matches zero or more characters
+ * * '?' - matches one character
+ *
+ * Return: If the @str matches the @pattern, return true, else return false.
+ */
+bool match_wildcard(const char *pattern, const char *str)
+{
+ return __match_wildcard(pattern, str, false);
+}
EXPORT_SYMBOL(match_wildcard);
+/**
+ * match_wildcard_hyphen - parse if a string matches given wildcard pattern
+ * @pattern: wildcard pattern
+ * @str: the string to be parsed
+ *
+ * Description: Same as match_wildcard, but treats '-' and '_' as identical.
+ *
+ * Return: If the @str matches the @pattern, return true, else return false.
+ */
+bool match_wildcard_hyphen(const char *pattern, const char *str)
+{
+ return __match_wildcard(pattern, str, true);
+}
+EXPORT_SYMBOL(match_wildcard_hyphen);
+
/**
* match_strlcpy - Copy the characters from a substring_t to a sized buffer
* @dest: where to copy to
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index e9f9db35fb7f..69a1787a4302 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -591,7 +591,7 @@ builtin_tests=(
FT_grammar_errs
FT_basic_queries
#FT_path_module_queries
- #FT_hyphen_underscore
+ FT_hyphen_underscore
)
# Modular Feature Tests (Require CONFIG_MODULES=y and test_dynamic_debug*.ko available)
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 15/39] kbuild, dyndbg: Clean up builtin module-name ambiguities
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (13 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 14/39] lib/parser: add match_wildcard_hyphen() for agnostic matching Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 15:50 ` Nicolas Schier
2026-09-09 0:55 ` [PATCH v9 16/39] dyndbg: refactor param_set_dyndbg_classes and below Jim Cromie via B4 Relay
` (23 subsequent siblings)
38 siblings, 1 reply; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Currently, dyndbg binds KBUILD_MODNAME into callsite & classmap
declarator-macros. While loadable modules have unique names enforced at
modprobe, for built-ins, its values suffer some collisions (e.g.
multiple distinct compilation units named "main", "core", or "init").
KBUILD_MODNAME defaults to the leaf of the pathname, so built-in
subsystems are fragmented into the names of their individual
implementation parts. The callsites remain adjacent in their subsystem
directories, but expose 278 separate module labels in
/proc/dynamic_debug/control instead of unified subsystem addresses.
Bind DDEBUG_MODNAME into all callsite and classmap declarator macros
instead. In include/linux/dynamic_debug.h, define DDEBUG_MODNAME to
cascade across KBUILD_DD_MODNAME, KBUILD_MODFILE, and KBUILD_MODNAME.
In scripts/Makefile.lib, compute KBUILD_DD_MODNAME with structured
precedence:
0. Check for per-target override: DD_MODNAME_<target-stem>.o
1. Check for directory-level override: DD_MODNAME in local Makefile
2. Fall back to automatic clean heuristic:
- Strip leading "drivers/" and arch prefixes.
- Map top-level built-in targets to directory names (e.g. power,
init).
- Unify multi-target shared helpers under containing subsystem paths
(e.g. mmc/host, coco/sev, events/amd, kernel/cpu).
- Sanitize commas, hyphens, and whitespace to prevent token
splitting in column 2 of /proc/dynamic_debug/control.
In /proc/dynamic_debug/control on a default boot, unique built-in module
names drop from 278 to 211, consolidating 67 fragmented targets:
Subsystem Group Legacy Names (linux.git) Consolidated Name (wk-A)
---------------- ---------------------------- ------------------------
Power snapshot, swap, suspend, power
hibernate, main, em
Kernel Init main, init, init_64, init
initramfs, do_mounts
Sound / HDA snd_hda_codec_*, snd_intel* sound/hda/codecs,
snd_hda_core, snd_hda_intel sound/hda/controllers
TTY & Serial 8250, 8250_base, 8250_pci, tty/serial,
8250_exar, serial_base tty/serial/8250
GPU / DRM drm, drm_kms_helper, gpu/drm, gpu/drm/display
bridge, display, clients gpu/drm/clients, tiny
ACPI & Platform acpi, acpi_dma, acpi_x86, acpi, acpi/numa,
numa, srat acpi/x86
IOMMU & Perf amd_node, dmar, iommu, iommu/amd, iommu/intel,
ibs, events events/amd, events/intel
Input atkbd, psmouse, libps2 input/keyboard, mouse
Filesystems fuse, overlay, inotify_user fs/fuse, fs/overlayfs,
sysfs, kernfs fs/notify/inotify
Networking tcp, tcp_input, tcp_cong, net/core, net/ipv4,
tcp_cubic, arp, icmp net/sched
This yields unambiguous, user-visible subsystem namespaces across both
built-in objects and loadable modules while maintaining compatibility
with wildcard queries (e.g. `module main` matching `[*/main]`).
Adjust documentation and selftests to track refreshed module names.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Revision history (v9):
. implement subsystem-centric KBUILD_DD_MODNAME naming heuristic.
. unify multi-target shared helpers under containing subsystem path.
. eliminate whitespace splitting in control file column 2.
---
Documentation/admin-guide/dynamic-debug-howto.rst | 42 ++++---
include/linux/dynamic_debug.h | 19 ++-
kernel/power/Makefile | 2 +
lib/dynamic_debug.c | 3 +-
scripts/Makefile.lib | 26 ++++
.../selftests/dynamic_debug/dyndbg_selftest.sh | 137 +++++++++++----------
6 files changed, 143 insertions(+), 86 deletions(-)
diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
index 9c2f096ed1d8..99bbae37d34e 100644
--- a/Documentation/admin-guide/dynamic-debug-howto.rst
+++ b/Documentation/admin-guide/dynamic-debug-howto.rst
@@ -38,12 +38,12 @@ You can view the currently configured behaviour in the *prdbg* catalog::
:#> head -n7 /proc/dynamic_debug/control
# filename:lineno [module]function flags format
- init/main.c:1179 [main]initcall_blacklist =_ "blacklisting initcall %s\n"
- init/main.c:1218 [main]initcall_blacklisted =_ "initcall %s blacklisted\n"
- init/main.c:1424 [main]run_init_process =_ " with arguments:\n"
- init/main.c:1426 [main]run_init_process =_ " %s\n"
- init/main.c:1427 [main]run_init_process =_ " with environment:\n"
- init/main.c:1429 [main]run_init_process =_ " %s\n"
+ init/main.c:1179 [init/main]initcall_blacklist =_ "blacklisting initcall %s\n"
+ init/main.c:1218 [init/main]initcall_blacklisted =_ "initcall %s blacklisted\n"
+ init/main.c:1424 [init/main]run_init_process =_ " with arguments:\n"
+ init/main.c:1426 [init/main]run_init_process =_ " %s\n"
+ init/main.c:1427 [init/main]run_init_process =_ " with environment:\n"
+ init/main.c:1429 [init/main]run_init_process =_ " %s\n"
The 3rd space-delimited column shows the current flags, preceded by
a ``=`` for easy use with grep/cut. ``=p`` shows enabled callsites.
@@ -59,10 +59,10 @@ query/commands to the control file. Example::
:#> ddcmd '-p; module main func run* +p'
:#> grep =p /proc/dynamic_debug/control
- init/main.c:1424 [main]run_init_process =p " with arguments:\n"
- init/main.c:1426 [main]run_init_process =p " %s\n"
- init/main.c:1427 [main]run_init_process =p " with environment:\n"
- init/main.c:1429 [main]run_init_process =p " %s\n"
+ init/main.c:1424 [init/main]run_init_process =p " with arguments:\n"
+ init/main.c:1426 [init/main]run_init_process =p " %s\n"
+ init/main.c:1427 [init/main]run_init_process =p " with environment:\n"
+ init/main.c:1429 [init/main]run_init_process =p " %s\n"
Error messages go to console/syslog::
@@ -161,17 +161,21 @@ file
file kernel/freezer.c # ie column 1 of control file
file drivers/usb/* # all callsites under it
file inode.c:start_* # parse :tail as a func (above)
- file inode.c:1-100 # parse :tail as a line-range (above)
+ file inode.c:1-100 # parse :tail as a line-range (below)
module
- The given string is compared against the module name
- of each callsite. The module name is the string as
- seen in ``lsmod``, i.e. without the directory or the ``.ko``
- suffix and with ``-`` changed to ``_``. Examples::
-
- module sunrpc
- module nfsd
- module drm* # both drm, drm_kms_helper
+ The query string is compared against the subsystem module name of
+ each callsite, as shown in the control file, or its simple name.
+ The simple module name is the string as seen in ``lsmod``,
+ i.e. without the directory or the ``.ko`` suffix and with ``-``
+ changed to ``_``.
+ Examples::
+
+ module nfsd # simple modname (as from lsmod)
+ module init/main # subsystem modname (as in control file)
+ module */main # any subsystem ending in main
+ module main # simple modname, selects same as above
+ module drm* # both drm, drm_kms_helper
format
The given string is searched for in the dynamic debug format
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index baf5c0853f45..54a80e7fdbaf 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -10,6 +10,21 @@
#define __DDEBUG_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
+/*
+ * DDEBUG_MODNAME resolves from:
+ * 1. KBUILD_DD_MODNAME: Subsystem-scoped, sanitized name from scripts/Makefile.lib
+ * (supports directory-level DD_MODNAME and per-target DD_MODNAME_<target>.o).
+ * 2. KBUILD_MODFILE: Path-based fallback for specialized or out-of-tree builds.
+ * 3. KBUILD_MODNAME: Default kernel module target name.
+ */
+#ifdef KBUILD_DD_MODNAME
+# define DDEBUG_MODNAME KBUILD_DD_MODNAME
+#elif defined(KBUILD_MODFILE)
+# define DDEBUG_MODNAME KBUILD_MODFILE
+#else
+# define DDEBUG_MODNAME KBUILD_MODNAME
+#endif
+
/*
* An instance of this structure is created in a special
* ELF section at every dynamic debug callsite. At runtime,
@@ -121,7 +136,7 @@ struct ddebug_class_param {
static struct ddebug_class_map __aligned(8) __used \
__section("__dyndbg_classes") _var = { \
.mod = THIS_MODULE, \
- .mod_name = KBUILD_MODNAME, \
+ .mod_name = DDEBUG_MODNAME, \
.base = _base, \
.map_type = _maptype, \
.class_names = _var##_classnames, \
@@ -160,7 +175,7 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt) \
static struct _ddebug __aligned(8) \
__section("__dyndbg") name = { \
- .modname = KBUILD_MODNAME, \
+ .modname = DDEBUG_MODNAME, \
.function = __func__, \
.filename = __FILE__, \
.format = (fmt), \
diff --git a/kernel/power/Makefile b/kernel/power/Makefile
index 773e2789412b..ddceacfd76d7 100644
--- a/kernel/power/Makefile
+++ b/kernel/power/Makefile
@@ -1,5 +1,7 @@
# SPDX-License-Identifier: GPL-2.0
+DD_MODNAME := power
+
ifeq ($(CONFIG_DYNAMIC_DEBUG), y)
CFLAGS_swap.o := -DDEBUG
CFLAGS_snapshot.o := -DDEBUG
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 2a69f86f973e..d4dbbd1a91ef 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -242,7 +242,8 @@ static int ddebug_change(const struct ddebug_query *query,
/* match against the module name */
if (query->module &&
- !match_wildcard(query->module, dt->mod_name))
+ !match_wildcard_hyphen(query->module, dt->mod_name) &&
+ !match_wildcard_hyphen(query->module, kbasename(dt->mod_name)))
continue;
if (query->class_string) {
diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib
index 0a4fdd8bd975..e129c4d10ed8 100644
--- a/scripts/Makefile.lib
+++ b/scripts/Makefile.lib
@@ -23,6 +23,32 @@ modname_flags = -DKBUILD_MODNAME=$(call name-fix,$(modname)) \
-D__KBUILD_MODNAME=$(call name-fix-token,$(modname))
modfile_flags = -DKBUILD_MODFILE=$(call stringify,$(modfile))
+# Dynamic debug subsystem modname with clean heuristic and override support
+dd_modname_override = $(strip $(firstword $(DD_MODNAME_$(target-stem).o) \
+ $(DD_MODNAME)))
+dd_obj := $(strip $(filter-out .,\
+ $(patsubst drivers/%,%,\
+ $(patsubst arch/$(SRCARCH)/%,%,\
+ $(patsubst arch/%/,%,$(obj))))))
+dd_modname_default = $(strip $(if $(filter $(notdir $(obj)),$(__modname)),\
+ $(__modname),\
+ $(if $(filter main core common util init snapshot \
+ process,$(__modname)),\
+ $(dd_obj),\
+ $(if $(word 2,$(__modname)),\
+ $(dd_obj),\
+ $(if $(dd_obj),$(dd_obj),$(__modname))))))
+dd_modname = $(strip $(or $(dd_modname_override),\
+ $(dd_modname_default),\
+ $(__modname)))
+dd-name-subst = $(subst $(comma),_,$(subst -,_,$(strip $1)))
+dd-name-fix-token = $(subst $(space),_,$(call dd-name-subst,$1))
+dd_tok = $(call dd-name-fix-token,$(dd_modname))
+dd_modname_flags = $(if $(dd_modname),\
+ -DKBUILD_DD_MODNAME=$(call stringify,$(dd_tok)))
+
+modfile_flags += $(dd_modname_flags)
+
_c_flags = $(filter-out $(CFLAGS_REMOVE_$(target-stem).o), \
$(filter-out $(ccflags-remove-y), \
$(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) $(ccflags-y)) \
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 69a1787a4302..5ef6e313fa4b 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -308,98 +308,114 @@ function FT_grammar_errs {
ddcmd =_
}
-# these queries run against the builtin module: params, and change
-# flags. The control file state-of-interest is found by path,
-# kernel/params.c, to avoid module keyword entirely
+# these queries run against the builtin file: kernel/params.c, and change
+# flags. The control file state-of-interest is found by path $f,
+# perfectly binding the stimulus scope to the observation slice.
function FT_basic_queries {
v_echo "${GREEN}# BASIC_TESTS ${NC}"
if [ $LACK_DD_BUILTIN -eq 1 ]; then
- echo "SKIP - test requires params, which is a builtin module"
+ echo "SKIP - test requires dynamic_debug built into kernel"
return
fi
+ local f='kernel/params.c'
ddcmd =_ # zero everything
- ddcmd "module params +mf" 'kernel/params.c'
- ddcmd "module params +l" 'kernel/params.c'
- ddcmd "module params -m" 'kernel/params.c'
- ddcmd "module params =_" 'kernel/params.c'
+ ddcmd "file $f +mf" "$f"
+ ddcmd "file $f +l" "$f"
+ ddcmd "file $f -m" "$f"
+ ddcmd "file $f =_" "$f"
# multi-query commands split on ; on a single line
- ddcmd "module params +mf ; module params func parse_args +sl" 'kernel/params.c'
+ ddcmd "file $f +mf ; file $f func parse_args +sl" "$f"
# verify multi-cmd input, newline separated, with embedded comments
ddcmd =_ # reset before multiline query to capture full transition
- ddcmd "module params =_ # clear params
- module params +ml # set flags
- module params func parse_args +fs # set other flags" \
- 'kernel/params.c'
+ ddcmd "file $f =_ # clear params
+ file $f +ml # set flags
+ file $f func parse_args +fs # set other flags" \
+ "$f"
# clear flags and verify
- ddcmd "module params =_" 'kernel/params.c'
+ ddcmd "file $f =_" "$f"
}
function FT_path_module_queries {
v_echo "${GREEN}# TEST_PATH_MODULE_QUERIES ${NC}"
ddcmd =_
- # Find how many 'main' modules we have in total (by basename)
- # Use a precise OR pattern to match exactly [main] or [*/main] and avoid irqdomain
- local total_main=$(grep -c "\[main\]\|\[[^]]*/main\]" /proc/dynamic_debug/control)
- v_echo "# found $total_main total 'main' modules"
+ # Find a module with a path/slash in its name from the control file
+ local slashed_mod
+ slashed_mod=$(awk -F'[][]' \
+ '/^[^#:]+:[0-9]+/ { if ($2 ~ /\//) { print $2; exit } }' \
+ /proc/dynamic_debug/control)
- if [ $total_main -eq 0 ]; then
- echo "SKIP - no 'main' modules found to test slashes"
+ if [ -z "$slashed_mod" ]; then
+ echo "SKIP - no slashed module found to test paths"
return
fi
- # Verify a robust, cross-query state-interaction handshake between
- # narrow path and wide wildcard/basename queries. This dynamically
- # proves they interact with the exact same underlying callsites!
+ local base_mod=$(basename "$slashed_mod")
+ local slice_pattern="\[$slashed_mod\]"
+
+ v_echo "# testing path module queries for module: $slashed_mod (basename: $base_mod)"
+
+ # 1. Turn ON specific path
+ ddcmd "module '$slashed_mod' +p"
+ local hash_path=$(slice_and_hash_ddctrl "$slice_pattern")
- # 1. Turn ON specific path, verified under '[init/main]' range
- ddcmd "module 'init/main' +p" "init/main.c"
+ # 2. Turn OFF using wide wildcard query
+ ddcmd "module '*/$base_mod' =_"
+ local hash_off=$(slice_and_hash_ddctrl "$slice_pattern")
- # 2. Turn OFF using wide wildcard query,
- ddcmd "module '*/main' =_" "init/main.c"
+ # 3. Turn ON using wide unscoped basename
+ ddcmd "module '$base_mod' +p"
+ local hash_base=$(slice_and_hash_ddctrl "$slice_pattern")
- # 3. Turn ON using wide unscoped basename,
- ddcmd "module 'main' +p" "init/main.c"
+ # 4. Turn OFF using specific narrow path
+ ddcmd "module '$slashed_mod' =_"
- # 4. Turn OFF using specific narrow path,
- ddcmd "module 'init/main' =_" "init/main.c"
+ if [ "$hash_path" != "$hash_base" ]; then
+ echo -e "${RED}: Path vs Basename equivalence check failed! " \
+ "Fingerprints do not match.${NC}"
+ exit $ksft_fail
+ else
+ v_echo "${GREEN}: Proven: Slashed path and basename module queries match!${NC}"
+ fi
+
+ ddcmd =_
}
function FT_hyphen_underscore {
v_echo "${GREEN}# TEST_HYPHEN_UNDERSCORE ${NC}"
ddcmd =_
- # Find a module with a hyphen in its name (e.g., from the control file)
- local mod_with_hyphen
- mod_with_hyphen=$(awk -F'[][]' \
- '/^[^#:]+:[0-9]+/ { if ($2 ~ /-/) { print $2; exit } }' \
+ # Find a module with an underscore in its name (e.g., from the control file)
+ local mod_with_underscore
+ mod_with_underscore=$(awk -F'[][]' \
+ '/^[^#:]+:[0-9]+/ { if ($2 ~ /_/) { print $2; exit } }' \
/proc/dynamic_debug/control)
- if [ -z "$mod_with_hyphen" ]; then
- echo "SKIP - no module with hyphen found in /proc/dynamic_debug/control"
+ if [ -z "$mod_with_underscore" ]; then
+ echo "SKIP - no module with underscore found in /proc/dynamic_debug/control"
return
fi
- v_echo "# testing hyphen/underscore equivalence for module: $mod_with_hyphen"
- local mod_with_underscore=$(echo "$mod_with_hyphen" | tr '-' '_')
+ local mod_with_hyphen=$(echo "$mod_with_underscore" | tr '_' '-')
+ local base_underscore=$(basename "$mod_with_underscore")
local base_hyphen=$(basename "$mod_with_hyphen")
- local slice_pattern="\[[^]]*$base_hyphen\]"
+ local slice_pattern="\[$mod_with_underscore\]"
+
+ v_echo "# testing hyphen/underscore equivalence for module: $mod_with_underscore (hyphen: $mod_with_hyphen)"
# 1. Enable using literal hyphen name, and record the state fingerprint
v_echo "# trying hyphen name: $mod_with_hyphen"
- ddcmd "module $mod_with_hyphen +p"
- # verify_control_slice "$slice_pattern"
+ ddcmd "module '$mod_with_hyphen' +p"
local hash_hyphen=$(slice_and_hash_ddctrl "$slice_pattern")
# 2. Disable and enable using underscore name, record the state fingerprint
ddcmd =_
v_echo "# trying underscore name: $mod_with_underscore"
- ddcmd "module $mod_with_underscore +p"
- # verify_control_slice "$slice_pattern"
+ ddcmd "module '$mod_with_underscore' +p"
local hash_underscore=$(slice_and_hash_ddctrl "$slice_pattern")
# Real-time mathematical proof of hyphen/underscore name equivalence!
@@ -413,19 +429,17 @@ function FT_hyphen_underscore {
v_echo "${GREEN}: Proven: Hyphen/Underscore literal name equivalence matches!${NC}"
fi
- # Try kbasename with hyphen (if it has a path)
+ # 3. Try kbasename with hyphen (if it has a path)
if [ "$base_hyphen" != "$mod_with_hyphen" ]; then
ddcmd =_
v_echo "# trying hyphen kbasename: $base_hyphen"
- ddcmd "module $base_hyphen +pmf"
- # verify_control_slice "$slice_pattern" # omitted: slice contains dynamic
- # module info which drifts across different targets
+ ddcmd "module '$base_hyphen' +pmf"
local hash_base_hyphen=$(slice_and_hash_ddctrl "$slice_pattern")
# Prove kbasename hyphen name matches literal path hyphen name (with different flags)!
v_echo "# trying full path hyphen with pmf flags"
ddcmd =_
- ddcmd "module $mod_with_hyphen +pmf"
+ ddcmd "module '$mod_with_hyphen' +pmf"
local hash_path_pmf=$(slice_and_hash_ddctrl "$slice_pattern")
if [ "$hash_path_pmf" != "$hash_base_hyphen" ]; then
echo -e "${RED}: Hyphen kbasename check failed! " \
@@ -438,17 +452,13 @@ function FT_hyphen_underscore {
fi
# 4. Try kbasename with underscore
- local base_underscore=$(echo "$base_hyphen" | tr '-' '_')
ddcmd =_
v_echo "# trying underscore kbasename: $base_underscore"
- ddcmd "module $base_underscore +pmf"
- # verify_control_slice "$slice_pattern" # omitted: slice contains dynamic
- # module info which drifts across different targets
+ ddcmd "module '$base_underscore' +pmf"
local hash_base_underscore=$(slice_and_hash_ddctrl "$slice_pattern")
# Real-time mathematical proof of hyphen/underscore kbasename equivalence!
- if [ "$hash_base_hyphen" != "$hash_base_underscore" ] && \
- [ -n "$hash_base_hyphen" ]; then
+ if [ -n "$hash_base_hyphen" ] && [ "$hash_base_hyphen" != "$hash_base_underscore" ]; then
echo -e "${RED}: Hyphen/Underscore kbasename equivalence check " \
"failed! Fingerprints do not match.${NC}"
exit $ksft_fail
@@ -460,7 +470,6 @@ function FT_hyphen_underscore {
ddcmd =_
}
-
# testing classmap-based query enablers and class configurations
function FT_test_classes {
v_echo "${GREEN}# TEST_CLASSES - classmap-based query enablers and class configs ${NC}"
@@ -590,7 +599,7 @@ builtin_tests=(
FT_grammar_ok
FT_grammar_errs
FT_basic_queries
- #FT_path_module_queries
+ FT_path_module_queries
FT_hyphen_underscore
)
@@ -657,13 +666,13 @@ function GOLDEN_RECORDS {
#K= 781995971d28f732a792522f3c56cdd3 FT_grammar_errs.40
#K= 6614a677d9f9ac09d9825b4e989d2c42 FT_grammar_errs.41
#K= 70de9afed457a6be9f9c3c81cbd6d4d5 FT_grammar_errs.42
-#K= 6e8599556a312200fb6d484565b6c52f FT_basic_queries.1
-#K= db17180b59444e5e34a8fc20c40e4530 FT_basic_queries.2
-#K= f7bd56bd407ff255ef2e3b5fb093ae6a FT_basic_queries.3
-#K= 4ce44468b3b5f80ae42ade1f261b952f FT_basic_queries.4
-#K= 02e4fd94602e108cb89bfc70d47a5dad FT_basic_queries.5
-#K= f03a7ca7316e8db4c0e16523dc41e75d FT_basic_queries.6
-#K= c518a50ba30ba8099d0dc874a27ecf16 FT_basic_queries.7
+#K= 3c445fb23d701041e920a2a6d2b022c7 FT_basic_queries.1
+#K= d8eb8f226860aa558fb8a98097f05be9 FT_basic_queries.2
+#K= 6a86bb9209a3a0492bc6c2d29f4d5e52 FT_basic_queries.3
+#K= 90804574a5336971465f92d6cc3aa7fb FT_basic_queries.4
+#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_basic_queries.5
+#K= 8c2dd1164fbcefb721345ce62a864a37 FT_basic_queries.6
+#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
EOF
# Read the K-recs and skip those for tests that can't run
while read -r line; do
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* Re: [PATCH v9 15/39] kbuild, dyndbg: Clean up builtin module-name ambiguities
2026-09-09 0:55 ` [PATCH v9 15/39] kbuild, dyndbg: Clean up builtin module-name ambiguities Jim Cromie via B4 Relay
@ 2026-09-09 15:50 ` Nicolas Schier
2026-09-11 18:20 ` jim.cromie
0 siblings, 1 reply; 42+ messages in thread
From: Nicolas Schier @ 2026-09-09 15:50 UTC (permalink / raw)
To: jim.cromie
Cc: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Shuah Khan, Randy Dunlap, Rafael J. Wysocki,
Pavel Machek, Len Brown, linux-kernel, linux-kselftest, dri-devel,
linux-arch, linux-modules, linux-doc, linux-kbuild, linux-pm
[-- Attachment #1: Type: text/plain, Size: 4127 bytes --]
On Tue, Sep 08, 2026 at 06:55:11PM -0600, Jim Cromie via B4 Relay wrote:
[...]
> diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
> index 9c2f096ed1d8..99bbae37d34e 100644
> --- a/Documentation/admin-guide/dynamic-debug-howto.rst
> +++ b/Documentation/admin-guide/dynamic-debug-howto.rst
[...]
> @@ -161,17 +161,21 @@ file
> file kernel/freezer.c # ie column 1 of control file
> file drivers/usb/* # all callsites under it
> file inode.c:start_* # parse :tail as a func (above)
> - file inode.c:1-100 # parse :tail as a line-range (above)
> + file inode.c:1-100 # parse :tail as a line-range (below)
>
> module
> - The given string is compared against the module name
> - of each callsite. The module name is the string as
> - seen in ``lsmod``, i.e. without the directory or the ``.ko``
> - suffix and with ``-`` changed to ``_``. Examples::
> -
> - module sunrpc
> - module nfsd
> - module drm* # both drm, drm_kms_helper
> + The query string is compared against the subsystem module name of
> + each callsite, as shown in the control file, or its simple name.
> + The simple module name is the string as seen in ``lsmod``,
> + i.e. without the directory or the ``.ko`` suffix and with ``-``
> + changed to ``_``.
> + Examples::
> +
> + module nfsd # simple modname (as from lsmod)
> + module init/main # subsystem modname (as in control file)
> + module */main # any subsystem ending in main
> + module main # simple modname, selects same as above
> + module drm* # both drm, drm_kms_helper
The five lines above have mixed indentation, please switch them all to
one tab (no spaces).
[...]
> diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib
> index 0a4fdd8bd975..e129c4d10ed8 100644
> --- a/scripts/Makefile.lib
> +++ b/scripts/Makefile.lib
> @@ -23,6 +23,32 @@ modname_flags = -DKBUILD_MODNAME=$(call name-fix,$(modname)) \
> -D__KBUILD_MODNAME=$(call name-fix-token,$(modname))
> modfile_flags = -DKBUILD_MODFILE=$(call stringify,$(modfile))
>
> +# Dynamic debug subsystem modname with clean heuristic and override support
> +dd_modname_override = $(strip $(firstword $(DD_MODNAME_$(target-stem).o) \
> + $(DD_MODNAME)))
> +dd_obj := $(strip $(filter-out .,\
> + $(patsubst drivers/%,%,\
> + $(patsubst arch/$(SRCARCH)/%,%,\
> + $(patsubst arch/%/,%,$(obj))))))
May it become problematic if there is a conflict with
arch/sh/drivers/dma/*
arch/sh/drivers/pci/*
vs.
drivers/dma/*
drivers/pci/*
?
> +dd_modname_default = $(strip $(if $(filter $(notdir $(obj)),$(__modname)),\
> + $(__modname),\
> + $(if $(filter main core common util init snapshot \
> + process,$(__modname)),\
> + $(dd_obj),\
> + $(if $(word 2,$(__modname)),\
> + $(dd_obj),\
> + $(if $(dd_obj),$(dd_obj),$(__modname))))))
This looks quite complex. I _think_ this should be equivalent, but
perhaps a bit more simple to maintenance:
dd_modname_default = \
$(or \
$(filter $(notdir obj), $(__modname)), \
$(filter-out main core common util init snapshot process, $(__modname)), \
$(dd_obj)))
(Removed $(strip) and the last $(__modname) fallback as both are already
in definition of 'dd_modname'.)
What do you think?
> +dd_modname = $(strip $(or $(dd_modname_override),\
> + $(dd_modname_default),\
> + $(__modname)))
> +dd-name-subst = $(subst $(comma),_,$(subst -,_,$(strip $1)))
> +dd-name-fix-token = $(subst $(space),_,$(call dd-name-subst,$1))
> +dd_tok = $(call dd-name-fix-token,$(dd_modname))
> +dd_modname_flags = $(if $(dd_modname),\
> + -DKBUILD_DD_MODNAME=$(call stringify,$(dd_tok)))
> +
> +modfile_flags += $(dd_modname_flags)
dd-name-subst and dd-name-fix-token are not needed, dd_modname_flags is
used only once and can be folded:
dd_tok = $(call name-fix,$(subst $(space),_,$(dd_modname)))
modfile_flags += $(if (dd_modname), -DKBUILD_DD_MODNAME=$(dd_tok))
--
Nicolas
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 42+ messages in thread* Re: [PATCH v9 15/39] kbuild, dyndbg: Clean up builtin module-name ambiguities
2026-09-09 15:50 ` Nicolas Schier
@ 2026-09-11 18:20 ` jim.cromie
0 siblings, 0 replies; 42+ messages in thread
From: jim.cromie @ 2026-09-11 18:20 UTC (permalink / raw)
To: Nicolas Schier
Cc: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Shuah Khan, Randy Dunlap, Rafael J. Wysocki,
Pavel Machek, Len Brown, linux-kernel, linux-kselftest, dri-devel,
linux-arch, linux-modules, linux-doc, linux-kbuild, linux-pm
On Wed, Sep 9, 2026 at 9:50 AM Nicolas Schier <n.schier@fritz.com> wrote:
>
> On Tue, Sep 08, 2026 at 06:55:11PM -0600, Jim Cromie via B4 Relay wrote:
> [...]
>
> > diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
> > index 9c2f096ed1d8..99bbae37d34e 100644
> > --- a/Documentation/admin-guide/dynamic-debug-howto.rst
> > +++ b/Documentation/admin-guide/dynamic-debug-howto.rst
> [...]
> > @@ -161,17 +161,21 @@ file
> > file kernel/freezer.c # ie column 1 of control file
> > file drivers/usb/* # all callsites under it
> > file inode.c:start_* # parse :tail as a func (above)
> > - file inode.c:1-100 # parse :tail as a line-range (above)
> > + file inode.c:1-100 # parse :tail as a line-range (below)
> >
> > module
> > - The given string is compared against the module name
> > - of each callsite. The module name is the string as
> > - seen in ``lsmod``, i.e. without the directory or the ``.ko``
> > - suffix and with ``-`` changed to ``_``. Examples::
> > -
> > - module sunrpc
> > - module nfsd
> > - module drm* # both drm, drm_kms_helper
> > + The query string is compared against the subsystem module name of
> > + each callsite, as shown in the control file, or its simple name.
> > + The simple module name is the string as seen in ``lsmod``,
> > + i.e. without the directory or the ``.ko`` suffix and with ``-``
> > + changed to ``_``.
> > + Examples::
> > +
> > + module nfsd # simple modname (as from lsmod)
> > + module init/main # subsystem modname (as in control file)
> > + module */main # any subsystem ending in main
> > + module main # simple modname, selects same as above
> > + module drm* # both drm, drm_kms_helper
>
> The five lines above have mixed indentation, please switch them all to
> one tab (no spaces).
>
thanks, will fix.
>
> [...]
> > diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib
> > index 0a4fdd8bd975..e129c4d10ed8 100644
> > --- a/scripts/Makefile.lib
> > +++ b/scripts/Makefile.lib
> > @@ -23,6 +23,32 @@ modname_flags = -DKBUILD_MODNAME=$(call name-fix,$(modname)) \
> > -D__KBUILD_MODNAME=$(call name-fix-token,$(modname))
> > modfile_flags = -DKBUILD_MODFILE=$(call stringify,$(modfile))
> >
> > +# Dynamic debug subsystem modname with clean heuristic and override support
> > +dd_modname_override = $(strip $(firstword $(DD_MODNAME_$(target-stem).o) \
> > + $(DD_MODNAME)))
> > +dd_obj := $(strip $(filter-out .,\
> > + $(patsubst drivers/%,%,\
> > + $(patsubst arch/$(SRCARCH)/%,%,\
> > + $(patsubst arch/%/,%,$(obj))))))
>
> May it become problematic if there is a conflict with
>
> arch/sh/drivers/dma/*
> arch/sh/drivers/pci/*
>
> vs.
>
> drivers/dma/*
> drivers/pci/*
>
> ?
2 questions here really -
- what should happen ? strip arch/sh/ and then also drivers ?
- what will happen - I will play with the expressions to find out.
>
>
> > +dd_modname_default = $(strip $(if $(filter $(notdir $(obj)),$(__modname)),\
> > + $(__modname),\
> > + $(if $(filter main core common util init snapshot \
> > + process,$(__modname)),\
> > + $(dd_obj),\
> > + $(if $(word 2,$(__modname)),\
> > + $(dd_obj),\
> > + $(if $(dd_obj),$(dd_obj),$(__modname))))))
>
> This looks quite complex. I _think_ this should be equivalent, but
> perhaps a bit more simple to maintenance:
>
> dd_modname_default = \
> $(or \
> $(filter $(notdir obj), $(__modname)), \
> $(filter-out main core common util init snapshot process, $(__modname)), \
> $(dd_obj)))
>
> (Removed $(strip) and the last $(__modname) fallback as both are already
> in definition of 'dd_modname'.)
>
> What do you think?
it does read better. I will try it too.
> > +dd_modname = $(strip $(or $(dd_modname_override),\
> > + $(dd_modname_default),\
> > + $(__modname)))
> > +dd-name-subst = $(subst $(comma),_,$(subst -,_,$(strip $1)))
> > +dd-name-fix-token = $(subst $(space),_,$(call dd-name-subst,$1))
> > +dd_tok = $(call dd-name-fix-token,$(dd_modname))
> > +dd_modname_flags = $(if $(dd_modname),\
> > + -DKBUILD_DD_MODNAME=$(call stringify,$(dd_tok)))
> > +
> > +modfile_flags += $(dd_modname_flags)
>
> dd-name-subst and dd-name-fix-token are not needed, dd_modname_flags is
> used only once and can be folded:
>
>
> dd_tok = $(call name-fix,$(subst $(space),_,$(dd_modname)))
>
> modfile_flags += $(if (dd_modname), -DKBUILD_DD_MODNAME=$(dd_tok))
>
yes, this all looks cleaner and more comprehensible. thanks.
>
>
>
> --
> Nicolas
^ permalink raw reply [flat|nested] 42+ messages in thread
* [PATCH v9 16/39] dyndbg: refactor param_set_dyndbg_classes and below
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (14 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 15/39] kbuild, dyndbg: Clean up builtin module-name ambiguities Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 17/39] dyndbg: tighten fn-sig of ddebug_apply_class_bitmap Jim Cromie via B4 Relay
` (22 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
Refactor the callchain below param_set_dyndbg_classes(1) to allow
mod-name specific settings. Split (1) into upper/lower fns, adding
modname param to lower, and passing NULL in from upper. Below that,
add the same param to ddebug_apply_class_bitmap(), and pass it thru to
_ddebug_queries(), replacing NULL with the param.
This allows the callchain to update the classmap in just one module,
vs just all as currently done. While the sysfs param is unlikely to
ever update just one module, the callchain will be used for modprobe
handling, which should update only that just-probed module.
In ddebug_apply_class_bitmap(), also check for actual changes to the
bits before announcing them, to declutter logs.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v2: move RvB after SoB
v8: drop kdoc on static fn,
---
lib/dynamic_debug.c | 73 ++++++++++++++++++++++++++++++++++-------------------
1 file changed, 47 insertions(+), 26 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index d4dbbd1a91ef..b0e9f4768eb8 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -618,9 +618,10 @@ static int ddebug_exec_queries(char *query, const char *modname)
return nfound;
}
-/* apply a new bitmap to the sys-knob's current bit-state */
+/* apply a new class-param setting */
static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
- unsigned long *new_bits, unsigned long *old_bits)
+ unsigned long *new_bits, unsigned long *old_bits,
+ const char *query_modname)
{
#define QUERY_SIZE 128
char query[QUERY_SIZE];
@@ -628,7 +629,9 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
int matches = 0;
int bi, ct;
- v2pr_info("apply: 0x%lx to: 0x%lx\n", *new_bits, *old_bits);
+ if (*new_bits != *old_bits)
+ v2pr_info("apply bitmap: 0x%lx to: 0x%lx for %s\n", *new_bits,
+ *old_bits, query_modname ?: "'*'");
for (bi = 0; bi < map->length; bi++) {
if (test_bit(bi, new_bits) == test_bit(bi, old_bits))
@@ -637,12 +640,16 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
snprintf(query, QUERY_SIZE, "class %s %c%s", map->class_names[bi],
test_bit(bi, new_bits) ? '+' : '-', dcp->flags);
- ct = ddebug_exec_queries(query, NULL);
+ ct = ddebug_exec_queries(query, query_modname);
matches += ct;
v2pr_info("bit_%d: %d matches on class: %s -> 0x%lx\n", bi,
ct, map->class_names[bi], *new_bits);
}
+ if (*new_bits != *old_bits)
+ v2pr_info("applied bitmap: 0x%lx to: 0x%lx for %s\n", *new_bits,
+ *old_bits, query_modname ?: "'*'");
+
return matches;
}
@@ -651,22 +658,17 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
#define CLASSMAP_BITMASK(width) ((1UL << (width)) - 1)
-/**
- * param_set_dyndbg_classes - class FOO >control
- * @instr: string echo>d to sysfs, input depends on map_type
- * @kp: kp->arg has state: bits/lvl, map, map_type
- *
- * Enable/disable prdbgs by their class, as given in the arguments to
- * DECLARE_DYNDBG_CLASSMAP. For LEVEL map-types, enforce relative
- * levels by bitpos.
- *
- * Returns: 0 or <0 if error.
+/*
+ * param-setter helper to validate numeric input, clamp its value by
+ * the classmap type and size, and apply the bits.
*/
-int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
+static int param_set_dyndbg_module_classes(const char *instr,
+ const struct kernel_param *kp,
+ const char *mod_name)
{
const struct ddebug_class_param *dcp = kp->arg;
const struct ddebug_class_map *map = dcp->map;
- unsigned long inrep, new_bits, old_bits;
+ unsigned long inrep, new_bits, old_bits, old_val;
int rc, totct = 0;
rc = kstrtoul(instr, 0, &inrep);
@@ -686,9 +688,10 @@ int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
KP_NAME(kp), inrep, CLASSMAP_BITMASK(map->length));
inrep &= CLASSMAP_BITMASK(map->length);
}
- v2pr_info("bits:%lx > %s\n", inrep, KP_NAME(kp));
- totct += ddebug_apply_class_bitmap(dcp, &inrep, dcp->bits);
- *dcp->bits = inrep;
+ old_val = READ_ONCE(*dcp->bits);
+ v2pr_info("bits:0x%lx > %s.%s\n", inrep, mod_name ?: "*", KP_NAME(kp));
+ totct += ddebug_apply_class_bitmap(dcp, &inrep, &old_val, mod_name);
+ WRITE_ONCE(*dcp->bits, inrep);
break;
case DD_CLASS_TYPE_LEVEL_NUM:
/* input is bitpos, of highest verbosity to be enabled */
@@ -697,11 +700,12 @@ int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
KP_NAME(kp), inrep, map->length);
inrep = map->length;
}
- old_bits = CLASSMAP_BITMASK(*dcp->lvl);
+ old_val = READ_ONCE(*dcp->lvl);
+ old_bits = CLASSMAP_BITMASK(old_val);
new_bits = CLASSMAP_BITMASK(inrep);
v2pr_info("lvl:%ld bits:0x%lx > %s\n", inrep, new_bits, KP_NAME(kp));
- totct += ddebug_apply_class_bitmap(dcp, &new_bits, &old_bits);
- *dcp->lvl = inrep;
+ totct += ddebug_apply_class_bitmap(dcp, &new_bits, &old_bits, mod_name);
+ WRITE_ONCE(*dcp->lvl, inrep);
break;
default:
pr_warn("%s: bad map type: %d\n", KP_NAME(kp), map->map_type);
@@ -710,16 +714,33 @@ int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
vpr_info("%s: total matches: %d\n", KP_NAME(kp), totct);
return 0;
}
+
+/**
+ * param_set_dyndbg_classes - classmap-based kernel parameter setter
+ * @instr: string value to set (numeric bitmask or level)
+ * @kp: kernel parameter info referencing classmap state
+ *
+ * Enable or disable all class'd pr_debug callsites in the classmap,
+ * independent of the module they're in.
+ *
+ * Returns: 0 on success, or a negative error code.
+ */
+int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
+{
+ return param_set_dyndbg_module_classes(instr, kp, NULL);
+}
EXPORT_SYMBOL(param_set_dyndbg_classes);
/**
- * param_get_dyndbg_classes - classes reader
+ * param_get_dyndbg_classes - classmap kparam getter
* @buffer: string description of controlled bits -> classes
* @kp: kp->arg has state: bits, map
*
- * Reads last written state, underlying prdbg state may have been
- * altered by direct >control. Displays 0x for DISJOINT, 0-N for
- * LEVEL Returns: #chars written or <0 on error
+ * Reads last written state, underlying pr_debug states may have been
+ * altered by direct >control. Displays 0x for DISJOINT classmap
+ * types, 0-N for LEVEL types.
+ *
+ * Returns: ct of chars written or <0 on error
*/
int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp)
{
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 17/39] dyndbg: tighten fn-sig of ddebug_apply_class_bitmap
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (15 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 16/39] dyndbg: refactor param_set_dyndbg_classes and below Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 18/39] dyndbg: replace classmap list with an array-slice Jim Cromie via B4 Relay
` (21 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
old_bits arg is currently a pointer to the input bits, but this could
allow inadvertent changes to the input by the fn. Disallow this.
And constify new_bits while here.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v2: move RvB after SoB
---
lib/dynamic_debug.c | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index b0e9f4768eb8..c34b8262cd25 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -620,7 +620,8 @@ static int ddebug_exec_queries(char *query, const char *modname)
/* apply a new class-param setting */
static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
- unsigned long *new_bits, unsigned long *old_bits,
+ const unsigned long *new_bits,
+ const unsigned long old_bits,
const char *query_modname)
{
#define QUERY_SIZE 128
@@ -629,12 +630,12 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
int matches = 0;
int bi, ct;
- if (*new_bits != *old_bits)
+ if (*new_bits != old_bits)
v2pr_info("apply bitmap: 0x%lx to: 0x%lx for %s\n", *new_bits,
- *old_bits, query_modname ?: "'*'");
+ old_bits, query_modname ?: "'*'");
for (bi = 0; bi < map->length; bi++) {
- if (test_bit(bi, new_bits) == test_bit(bi, old_bits))
+ if (test_bit(bi, new_bits) == test_bit(bi, &old_bits))
continue;
snprintf(query, QUERY_SIZE, "class %s %c%s", map->class_names[bi],
@@ -646,9 +647,9 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
v2pr_info("bit_%d: %d matches on class: %s -> 0x%lx\n", bi,
ct, map->class_names[bi], *new_bits);
}
- if (*new_bits != *old_bits)
+ if (*new_bits != old_bits)
v2pr_info("applied bitmap: 0x%lx to: 0x%lx for %s\n", *new_bits,
- *old_bits, query_modname ?: "'*'");
+ old_bits, query_modname ?: "'*'");
return matches;
}
@@ -690,7 +691,7 @@ static int param_set_dyndbg_module_classes(const char *instr,
}
old_val = READ_ONCE(*dcp->bits);
v2pr_info("bits:0x%lx > %s.%s\n", inrep, mod_name ?: "*", KP_NAME(kp));
- totct += ddebug_apply_class_bitmap(dcp, &inrep, &old_val, mod_name);
+ totct += ddebug_apply_class_bitmap(dcp, &inrep, old_val, mod_name);
WRITE_ONCE(*dcp->bits, inrep);
break;
case DD_CLASS_TYPE_LEVEL_NUM:
@@ -704,7 +705,7 @@ static int param_set_dyndbg_module_classes(const char *instr,
old_bits = CLASSMAP_BITMASK(old_val);
new_bits = CLASSMAP_BITMASK(inrep);
v2pr_info("lvl:%ld bits:0x%lx > %s\n", inrep, new_bits, KP_NAME(kp));
- totct += ddebug_apply_class_bitmap(dcp, &new_bits, &old_bits, mod_name);
+ totct += ddebug_apply_class_bitmap(dcp, &new_bits, old_bits, mod_name);
WRITE_ONCE(*dcp->lvl, inrep);
break;
default:
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 18/39] dyndbg: replace classmap list with an array-slice
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (16 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 17/39] dyndbg: tighten fn-sig of ddebug_apply_class_bitmap Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 19/39] dyndbg: macrofy a 2-index for-loop pattern Jim Cromie via B4 Relay
` (20 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
Classmaps are stored in an elf section/array, but currently are
individually list-linked onto dyndbg's per-module ddebug_table for
operation. This is unnecessary.
Just like dyndbg's descriptors, classmaps are packed in compile order;
so even with many builtin modules employing multiple classmaps, each
modules' maps are packed contiguously, and can be treated as a
array-start-address & array-length.
So this drops the whole list building operation done in
ddebug_attach_module_classes(), and removes the list-head members of
the classmap structs. The "select-by-modname" condition is reused to
find the start,end of the subrange of classmaps belonging to the module.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v2: RvB after SoB
---
include/linux/dynamic_debug.h | 1 -
lib/dynamic_debug.c | 65 +++++++++++++++++++++++--------------------
2 files changed, 35 insertions(+), 31 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 54a80e7fdbaf..050624e5a809 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -91,7 +91,6 @@ enum ddebug_class_map_type {
};
struct ddebug_class_map {
- struct list_head link;
struct module *mod;
const char *mod_name; /* needed for builtins */
const char **class_names;
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index c34b8262cd25..b163e5c4ec3a 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -45,10 +45,11 @@ extern struct ddebug_class_map __start___dyndbg_classes[];
extern struct ddebug_class_map __stop___dyndbg_classes[];
struct ddebug_table {
- struct list_head link, maps;
+ struct list_head link;
const char *mod_name;
- unsigned int num_ddebugs;
struct _ddebug *ddebugs;
+ struct ddebug_class_map *classes;
+ unsigned int num_ddebugs, num_classes;
};
struct ddebug_query {
@@ -149,12 +150,13 @@ static void v3pr_info_dq(const struct ddebug_query *query, const char *msg)
}
static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table const *dt,
- const char *class_string, int *class_id)
+ const char *class_string,
+ int *class_id)
{
struct ddebug_class_map *map;
- int idx;
+ int i, idx;
- list_for_each_entry(map, &dt->maps, link) {
+ for (map = dt->classes, i = 0; i < dt->num_classes; i++, map++) {
idx = match_string(map->class_names, map->length, class_string);
if (idx >= 0) {
*class_id = idx + map->base;
@@ -165,7 +167,6 @@ static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table cons
return NULL;
}
-#define __outvar /* filled by callee */
/*
* Search the tables for _ddebug's which match the given `query' and
* apply the `flags' and `mask' to them. Returns number of matching
@@ -234,7 +235,7 @@ static int ddebug_change(const struct ddebug_query *query,
unsigned int nfound = 0;
struct flagsbuf fbuf, nbuf;
struct ddebug_class_map *map = NULL;
- int __outvar valid_class;
+ int valid_class;
/* search for matching ddebugs */
mutex_lock(&ddebug_lock);
@@ -1067,9 +1068,10 @@ static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
static const char *ddebug_class_name(struct ddebug_iter *iter, struct _ddebug *dp)
{
- struct ddebug_class_map *map;
+ struct ddebug_class_map *map = iter->table->classes;
+ int i, nc = iter->table->num_classes;
- list_for_each_entry(map, &iter->table->maps, link)
+ for (i = 0; i < nc; i++, map++)
if (class_in_range(dp->class_id, map))
return map->class_names[dp->class_id - map->base];
@@ -1153,30 +1155,34 @@ static const struct proc_ops proc_fops = {
.proc_write = ddebug_proc_write
};
-static void ddebug_attach_module_classes(struct ddebug_table *dt,
- struct ddebug_class_map *classes,
- int num_classes)
+static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug_info *di)
{
struct ddebug_class_map *cm;
- int i, j, ct = 0;
+ int i, nc = 0;
- for (cm = classes, i = 0; i < num_classes; i++, cm++) {
+ /*
+ * Find this module's classmaps in a subrange/wholerange of
+ * the builtin/modular classmap vector/section. Save the start
+ * and length of the subrange at its edges.
+ */
+ for (cm = di->classes, i = 0; i < di->num_classes; i++, cm++) {
if (!strcmp(cm->mod_name, dt->mod_name)) {
-
- v2pr_info("class[%d]: module:%s base:%d len:%d ty:%d\n", i,
- cm->mod_name, cm->base, cm->length, cm->map_type);
-
- for (j = 0; j < cm->length; j++)
- v3pr_info(" %d: %d %s\n", j + cm->base, j,
- cm->class_names[j]);
-
- list_add(&cm->link, &dt->maps);
- ct++;
+ if (!nc) {
+ v2pr_info("start subrange, class[%d]: module:%s base:%d len:%d ty:%d\n",
+ i, cm->mod_name, cm->base, cm->length, cm->map_type);
+ dt->classes = cm;
+ }
+ nc++;
+ } else if (nc) {
+ /* end of matching classmaps */
+ break;
}
}
- if (ct)
- vpr_info("module:%s attached %d classes\n", dt->mod_name, ct);
+ if (nc) {
+ dt->num_classes = nc;
+ vpr_info("module:%s attached %d classes\n", dt->mod_name, nc);
+ }
}
/*
@@ -1208,10 +1214,9 @@ static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
dt->num_ddebugs = di->num_descs;
INIT_LIST_HEAD(&dt->link);
- INIT_LIST_HEAD(&dt->maps);
if (di->classes && di->num_classes)
- ddebug_attach_module_classes(dt, di->classes, di->num_classes);
+ ddebug_attach_module_classes(dt, di);
mutex_lock(&ddebug_lock);
list_add_tail(&dt->link, &ddebug_tables);
@@ -1324,8 +1329,8 @@ static void ddebug_remove_all_tables(void)
mutex_lock(&ddebug_lock);
while (!list_empty(&ddebug_tables)) {
struct ddebug_table *dt = list_entry(ddebug_tables.next,
- struct ddebug_table,
- link);
+ struct ddebug_table,
+ link);
ddebug_table_free(dt);
}
mutex_unlock(&ddebug_lock);
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 19/39] dyndbg: macrofy a 2-index for-loop pattern
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (17 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 18/39] dyndbg: replace classmap list with an array-slice Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 20/39] dyndbg: reduce class param storage to u32 Jim Cromie via B4 Relay
` (19 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
dynamic-debug currently has 2 __sections (__dyndbg, __dyndb_classes),
struct _ddebug_info keeps track of them both, with 2 members each:
_vec and _vec#_len.
We need to loop over these sections, with index and record pointer,
making ref to both _vec and _vec_len. This is already fiddly and
error-prone, and will get worse as we add a 3rd section.
Lets instead embed/abstract the fiddly-ness in the `for_subvec()`
macro, and avoid repeating it going forward.
This is a for-loop macro expander, so it syntactically expects to
precede either a single statement or a { block } of them, and the
usual typeof or do-while-0 tricks are unavailable to fix the
multiple-expansion warning.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v2: move RvB after SoB
---
lib/dynamic_debug.c | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index b163e5c4ec3a..e5a3658dd9bd 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -149,6 +149,20 @@ static void v3pr_info_dq(const struct ddebug_query *query, const char *msg)
query->first_lineno, query->last_lineno, query->class_string);
}
+/*
+ * simplify a repeated for-loop pattern walking N steps in a T _vec
+ * member inside a struct _box. It expects int i and T *_sp to be
+ * declared in the caller.
+ * @_i: caller provided counter.
+ * @_sp: cursor into _vec, to examine each item.
+ * @_box: ptr to a struct containing @_vec member
+ * @_vec: name of a member in @_box
+ */
+#define for_subvec(_i, _sp, _box, _vec) \
+ for ((_i) = 0, (_sp) = (_box)->_vec; \
+ (_i) < (_box)->num_##_vec; \
+ (_i)++, (_sp)++) /* { block } */
+
static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table const *dt,
const char *class_string,
int *class_id)
@@ -156,7 +170,7 @@ static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table cons
struct ddebug_class_map *map;
int i, idx;
- for (map = dt->classes, i = 0; i < dt->num_classes; i++, map++) {
+ for_subvec(i, map, dt, classes) {
idx = match_string(map->class_names, map->length, class_string);
if (idx >= 0) {
*class_id = idx + map->base;
@@ -1165,8 +1179,7 @@ static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug
* the builtin/modular classmap vector/section. Save the start
* and length of the subrange at its edges.
*/
- for (cm = di->classes, i = 0; i < di->num_classes; i++, cm++) {
-
+ for_subvec(i, cm, di, classes) {
if (!strcmp(cm->mod_name, dt->mod_name)) {
if (!nc) {
v2pr_info("start subrange, class[%d]: module:%s base:%d len:%d ty:%d\n",
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 20/39] dyndbg: reduce class param storage to u32
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (18 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 19/39] dyndbg: macrofy a 2-index for-loop pattern Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 21/39] dyndbg,module: make proper substructs in _ddebug_info Jim Cromie via B4 Relay
` (18 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Currently, `struct ddebug_class_param` uses pointers to `unsigned
long` values which store the state of `bits` and `lvl`, so it changes
sizes depending upon the architecture. Make it always u32 for
consistency.
The bits field references __drm_debug, which was unsigned int, before
commit f158936b60a7 ("drm: POC drm on dyndbg - use in core, 2 helpers, 3 drivers.")
changed it to unsigned long. This patch changes it back.
That enlargement was a thinko; although modules can have up to 63
classes, and *could* have put all those classes in a single classmap,
the reason for it is to support multiple classmaps (with
non-overlapping class-id ranges).
32 bits is a practical limit for a class-param's usability since all
classes are set together with a single write of a hex value; 16 would
be a realistic limit, drm.debug has ~12 classes.
#> echo 0x0fff > /sys/module/drm/parameters/debug
Several followon patches add a number of compile-time validations,
including a num-classes <=32 check.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v8: add a <32 limit to prevent undefined shifts on 32 bit number
v5: u32 for all arches
v4: undo change struct ddebug_class_param to _ddebug_class_param
v3:
fix undefd behavior when classmaps is all 64 bits.
change module_param_named( type-arg from ulong to ullong)
change struct ddebug_class_param to _ddebug_class_param
in drivers/gpu/drm/drm_print.{c,h}
api change later
v2:
patch was "make bits & lvl same size"
but that size was unsigned long, only 32 bits on i386 etc
use u64 for all bits, and %llu %llx
u64-fix
u64-drm-dbg
---
drivers/gpu/drm/drm_print.c | 4 ++--
include/drm/drm_print.h | 2 +-
include/linux/dynamic_debug.h | 4 ++--
lib/dynamic_debug.c | 37 ++++++++++++++++++++-----------------
lib/test_dynamic_debug.c | 2 +-
5 files changed, 26 insertions(+), 23 deletions(-)
diff --git a/drivers/gpu/drm/drm_print.c b/drivers/gpu/drm/drm_print.c
index 86cef1a37678..794417c62097 100644
--- a/drivers/gpu/drm/drm_print.c
+++ b/drivers/gpu/drm/drm_print.c
@@ -40,7 +40,7 @@
* __drm_debug: Enable debug output.
* Bitmask of DRM_UT_x. See include/drm/drm_print.h for details.
*/
-unsigned long __drm_debug;
+u32 __drm_debug;
EXPORT_SYMBOL(__drm_debug);
MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
@@ -56,7 +56,7 @@ MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug cat
"\t\tBit 9 (0x200) will enable DRMRES messages (managed resources code)");
#if !defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
-module_param_named(debug, __drm_debug, ulong, 0600);
+module_param_named(debug, __drm_debug, uint, 0600);
#else
/* classnames must match vals of enum drm_debug_category */
DECLARE_DYNDBG_CLASSMAP(drm_debug_classes, DD_CLASS_TYPE_DISJOINT_BITS, 0,
diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
index 2adc5ac688e1..50b3ba0ae76d 100644
--- a/include/drm/drm_print.h
+++ b/include/drm/drm_print.h
@@ -39,7 +39,7 @@ struct drm_device;
struct seq_file;
/* Do *not* use outside of drm_print.[ch]! */
-extern unsigned long __drm_debug;
+extern u32 __drm_debug;
/**
* DOC: print
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 050624e5a809..4e2995abddc8 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -109,8 +109,8 @@ struct _ddebug_info {
struct ddebug_class_param {
union {
- unsigned long *bits;
- unsigned int *lvl;
+ u32 *bits;
+ u32 *lvl;
};
char flags[8];
const struct ddebug_class_map *map;
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index e5a3658dd9bd..ff7afd525b7f 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -585,6 +585,7 @@ static int ddebug_exec_query(char *query_string, const char *modname)
pr_err("query parse failed\n");
return -EINVAL;
}
+
/* actually go and implement the change */
nfound = ddebug_change(&query, &modifiers);
v3pr_info_dq(&query, nfound ? "applied" : "no-match");
@@ -635,8 +636,7 @@ static int ddebug_exec_queries(char *query, const char *modname)
/* apply a new class-param setting */
static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
- const unsigned long *new_bits,
- const unsigned long old_bits,
+ const u32 *new_bits, const u32 old_bits,
const char *query_modname)
{
#define QUERY_SIZE 128
@@ -646,24 +646,27 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
int bi, ct;
if (*new_bits != old_bits)
- v2pr_info("apply bitmap: 0x%lx to: 0x%lx for %s\n", *new_bits,
+ v2pr_info("apply bitmap: 0x%x to: 0x%x for %s\n", *new_bits,
old_bits, query_modname ?: "'*'");
- for (bi = 0; bi < map->length; bi++) {
- if (test_bit(bi, new_bits) == test_bit(bi, &old_bits))
+ for (bi = 0; bi < map->length && bi < 32; bi++) {
+ bool new_b = !!(*new_bits & BIT(bi));
+ bool old_b = !!(old_bits & BIT(bi));
+
+ if (new_b == old_b)
continue;
snprintf(query, QUERY_SIZE, "class %s %c%s", map->class_names[bi],
- test_bit(bi, new_bits) ? '+' : '-', dcp->flags);
+ new_b ? '+' : '-', dcp->flags);
ct = ddebug_exec_queries(query, query_modname);
matches += ct;
- v2pr_info("bit_%d: %d matches on class: %s -> 0x%lx\n", bi,
+ v2pr_info("bit_%d: %d matches on class: %s -> 0x%x\n", bi,
ct, map->class_names[bi], *new_bits);
}
if (*new_bits != old_bits)
- v2pr_info("applied bitmap: 0x%lx to: 0x%lx for %s\n", *new_bits,
+ v2pr_info("applied bitmap: 0x%x to: 0x%x for %s\n", *new_bits,
old_bits, query_modname ?: "'*'");
return matches;
@@ -672,7 +675,7 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
/* stub to later conditionally add "$module." prefix where not already done */
#define KP_NAME(kp) kp->name
-#define CLASSMAP_BITMASK(width) ((1UL << (width)) - 1)
+#define CLASSMAP_BITMASK(width) ((width) >= 32 ? ~0U : (1U << (width)) - 1)
/*
* param-setter helper to validate numeric input, clamp its value by
@@ -684,10 +687,10 @@ static int param_set_dyndbg_module_classes(const char *instr,
{
const struct ddebug_class_param *dcp = kp->arg;
const struct ddebug_class_map *map = dcp->map;
- unsigned long inrep, new_bits, old_bits, old_val;
+ u32 inrep, new_bits, old_bits, old_val;
int rc, totct = 0;
- rc = kstrtoul(instr, 0, &inrep);
+ rc = kstrtou32(instr, 0, &inrep);
if (rc) {
int len = strcspn(instr, "\n");
@@ -700,26 +703,26 @@ static int param_set_dyndbg_module_classes(const char *instr,
case DD_CLASS_TYPE_DISJOINT_BITS:
/* expect bits. mask and warn if too many */
if (inrep & ~CLASSMAP_BITMASK(map->length)) {
- pr_warn("%s: input: 0x%lx exceeds mask: 0x%lx, masking\n",
+ pr_warn("%s: input: 0x%x exceeds mask: 0x%x, masking\n",
KP_NAME(kp), inrep, CLASSMAP_BITMASK(map->length));
inrep &= CLASSMAP_BITMASK(map->length);
}
old_val = READ_ONCE(*dcp->bits);
- v2pr_info("bits:0x%lx > %s.%s\n", inrep, mod_name ?: "*", KP_NAME(kp));
+ v2pr_info("bits:0x%x > %s.%s\n", inrep, mod_name ?: "*", KP_NAME(kp));
totct += ddebug_apply_class_bitmap(dcp, &inrep, old_val, mod_name);
WRITE_ONCE(*dcp->bits, inrep);
break;
case DD_CLASS_TYPE_LEVEL_NUM:
/* input is bitpos, of highest verbosity to be enabled */
if (inrep > map->length) {
- pr_warn("%s: level:%ld exceeds max:%d, clamping\n",
+ pr_warn("%s: level:%u exceeds max:%d, clamping\n",
KP_NAME(kp), inrep, map->length);
inrep = map->length;
}
old_val = READ_ONCE(*dcp->lvl);
old_bits = CLASSMAP_BITMASK(old_val);
new_bits = CLASSMAP_BITMASK(inrep);
- v2pr_info("lvl:%ld bits:0x%lx > %s\n", inrep, new_bits, KP_NAME(kp));
+ v2pr_info("lvl:%u bits:0x%x > %s\n", inrep, new_bits, KP_NAME(kp));
totct += ddebug_apply_class_bitmap(dcp, &new_bits, old_bits, mod_name);
WRITE_ONCE(*dcp->lvl, inrep);
break;
@@ -765,9 +768,9 @@ int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp)
switch (map->map_type) {
case DD_CLASS_TYPE_DISJOINT_BITS:
- return scnprintf(buffer, PAGE_SIZE, "0x%lx\n", *dcp->bits);
+ return scnprintf(buffer, PAGE_SIZE, "0x%x\n", *dcp->bits);
case DD_CLASS_TYPE_LEVEL_NUM:
- return scnprintf(buffer, PAGE_SIZE, "%d\n", *dcp->lvl);
+ return scnprintf(buffer, PAGE_SIZE, "%u\n", *dcp->lvl);
default:
return -1;
}
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 74d183ebf3e0..9e8e028461ad 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -40,7 +40,7 @@ module_param_cb(do_prints, ¶m_ops_do_prints, NULL, 0600);
* - tie together sysname, mapname, bitsname, flagsname
*/
#define DD_SYS_WRAP(_model, _flags) \
- static unsigned long bits_##_model; \
+ static u32 bits_##_model; \
static struct ddebug_class_param _flags##_model = { \
.bits = &bits_##_model, \
.flags = #_flags, \
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 21/39] dyndbg,module: make proper substructs in _ddebug_info
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (19 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 20/39] dyndbg: reduce class param storage to u32 Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 22/39] dyndbg: move mod_name down from struct ddebug_table to _ddebug_info Jim Cromie via B4 Relay
` (17 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
recompose struct _ddebug_info, inserting proper sub-structs.
The struct _ddebug_info has 2 pairs of _vec, num_##_vec fields, for
descs and classes respectively. for_subvec() makes walking these
vectors less cumbersome, now lets move those field pairs into their
own "vec" structs: _ddebug_descs & _ddebug_class_maps, and re-compose
struct _ddebug_info to contain them cleanly. This also lets us get
rid of for_subvec()'s num_##_vec paste-up.
Also recompose struct ddebug_table to contain a _ddebug_info. This
reinforces _ddebug_info's use as a cursor into relevant data for a
builtin module, and access to the full _ddebug state for modules.
NOTES:
rename section:__dyndbg_classes to _class_maps, to better align with
struct _ddebug_class_maps.
names together, for more obvious name pairing.
Invariant: These vectors ref a contiguous subrange of __section memory
in builtin/DATA or in loadable modules via mod->dyndbg_info; with
guaranteed life-time for us.
struct module contains a _ddebug_info field and module/main.c sets it
up, so that gets adjusted rather obviously.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v8: set maps.len = nc unconditionally
v3: squash in section name changes.
v2:
Move RvB after SoB
In structs _ddebug_descs & _ddebug_class_maps, change int length to unsigned int
No use of <0 vals is contemplated.
dyndbg: improve section names
change __dyndbg to __dyndbg_descs
change __dyndbg_classes to __dyndbg_class_maps
this sets up for adding __dyndbg_class_users
fixup-drmprint
---
include/asm-generic/dyndbg.lds.h | 14 +++---
include/linux/dynamic_debug.h | 34 ++++++++-----
kernel/module/main.c | 12 ++---
lib/dynamic_debug.c | 101 +++++++++++++++++++--------------------
4 files changed, 86 insertions(+), 75 deletions(-)
diff --git a/include/asm-generic/dyndbg.lds.h b/include/asm-generic/dyndbg.lds.h
index 9d8951bef688..ec661f9f3793 100644
--- a/include/asm-generic/dyndbg.lds.h
+++ b/include/asm-generic/dyndbg.lds.h
@@ -3,16 +3,16 @@
#define __ASM_GENERIC_DYNDBG_LDS_H
#include <asm-generic/bounded_sections.lds.h>
-#define DYNDBG_SECTIONS() \
- BOUNDED_SECTION_BY(__dyndbg, ___dyndbg) \
- BOUNDED_SECTION_BY(__dyndbg_classes, ___dyndbg_classes)
+#define DYNDBG_SECTIONS() \
+ BOUNDED_SECTION_BY(__dyndbg_descs, ___dyndbg_descs) \
+ BOUNDED_SECTION_BY(__dyndbg_class_maps, ___dyndbg_class_maps)
#define MOD_DYNDBG_SECTIONS() \
- __dyndbg 0 : ALIGN(8) { \
- KEEP(*(__dyndbg)) \
+ __dyndbg_descs 0 : ALIGN(8) { \
+ KEEP(*(__dyndbg_descs)) \
} \
- __dyndbg_classes 0 : ALIGN(8) { \
- KEEP(*(__dyndbg_classes)) \
+ __dyndbg_class_maps 0 : ALIGN(8) { \
+ KEEP(*(__dyndbg_class_maps)) \
}
#endif /* __ASM_GENERIC_DYNDBG_LDS_H */
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 4e2995abddc8..535aa3fc36e1 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -91,7 +91,7 @@ enum ddebug_class_map_type {
};
struct ddebug_class_map {
- struct module *mod;
+ struct module *mod; /* NULL for builtins */
const char *mod_name; /* needed for builtins */
const char **class_names;
const int length;
@@ -99,12 +99,24 @@ struct ddebug_class_map {
enum ddebug_class_map_type map_type;
};
-/* encapsulate linker provided built-in (or module) dyndbg data */
+/*
+ * @_ddebug_info: gathers module/builtin dyndbg_* __sections together.
+ * For builtins, it is used as a cursor, with the inner structs
+ * marking sub-vectors of the builtin __sections in DATA.
+ */
+struct _ddebug_descs {
+ struct _ddebug *start;
+ unsigned int len;
+};
+
+struct _ddebug_class_maps {
+ struct ddebug_class_map *start;
+ unsigned int len;
+};
+
struct _ddebug_info {
- struct _ddebug *descs;
- struct ddebug_class_map *classes;
- unsigned int num_descs;
- unsigned int num_classes;
+ struct _ddebug_descs descs;
+ struct _ddebug_class_maps maps;
};
struct ddebug_class_param {
@@ -125,7 +137,7 @@ struct ddebug_class_param {
/**
* DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module
- * @_var: a struct _ddebug_class_map, passed to module_param_cb
+ * @_var: a struct ddebug_class_map, passed to module_param_cb
* @_maptype: enum ddebug_class_map_type, chooses bits/verbose
* @_base: offset of 1st class-name. splits .class_id space
* @classes: class-names used to control class'd prdbgs
@@ -133,7 +145,7 @@ struct ddebug_class_param {
#define DECLARE_DYNDBG_CLASSMAP(_var, _maptype, _base, ...) \
static const char *_var##_classnames[] = { __VA_ARGS__ }; \
static struct ddebug_class_map __aligned(8) __used \
- __section("__dyndbg_classes") _var = { \
+ __section("__dyndbg_class_maps") _var = { \
.mod = THIS_MODULE, \
.mod_name = DDEBUG_MODNAME, \
.base = _base, \
@@ -173,7 +185,7 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt) \
static struct _ddebug __aligned(8) \
- __section("__dyndbg") name = { \
+ __section("__dyndbg_descs") name = { \
.modname = DDEBUG_MODNAME, \
.function = __func__, \
.filename = __FILE__, \
@@ -260,7 +272,7 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
* macro.
*/
#define _dynamic_func_call_cls(cls, fmt, func, ...) \
- __dynamic_func_call_cls(__UNIQUE_ID(ddebug), cls, fmt, func, ##__VA_ARGS__)
+ __dynamic_func_call_cls(__UNIQUE_ID(_ddebug), cls, fmt, func, ##__VA_ARGS__)
#define _dynamic_func_call(fmt, func, ...) \
_dynamic_func_call_cls(_DPRINTK_CLASS_DFLT, fmt, func, ##__VA_ARGS__)
@@ -270,7 +282,7 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
* with precisely the macro's varargs.
*/
#define _dynamic_func_call_cls_no_desc(cls, fmt, func, ...) \
- __dynamic_func_call_cls_no_desc(__UNIQUE_ID(ddebug), cls, fmt, \
+ __dynamic_func_call_cls_no_desc(__UNIQUE_ID(_ddebug), cls, fmt, \
func, ##__VA_ARGS__)
#define _dynamic_func_call_no_desc(fmt, func, ...) \
_dynamic_func_call_cls_no_desc(_DPRINTK_CLASS_DFLT, fmt, \
diff --git a/kernel/module/main.c b/kernel/module/main.c
index c1b34dc1e89a..852cce2c5113 100644
--- a/kernel/module/main.c
+++ b/kernel/module/main.c
@@ -2785,12 +2785,12 @@ static int find_module_sections(struct module *mod, struct load_info *info)
pr_warn("%s: Ignoring obsolete parameters\n", mod->name);
#ifdef CONFIG_DYNAMIC_DEBUG_CORE
- mod->dyndbg_info.descs = section_objs(info, "__dyndbg",
- sizeof(*mod->dyndbg_info.descs),
- &mod->dyndbg_info.num_descs);
- mod->dyndbg_info.classes = section_objs(info, "__dyndbg_classes",
- sizeof(*mod->dyndbg_info.classes),
- &mod->dyndbg_info.num_classes);
+ mod->dyndbg_info.descs.start = section_objs(info, "__dyndbg_descs",
+ sizeof(*mod->dyndbg_info.descs.start),
+ &mod->dyndbg_info.descs.len);
+ mod->dyndbg_info.maps.start = section_objs(info, "__dyndbg_class_maps",
+ sizeof(*mod->dyndbg_info.maps.start),
+ &mod->dyndbg_info.maps.len);
#endif
return 0;
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index ff7afd525b7f..52990a814345 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -39,17 +39,15 @@
#include <rdma/ib_verbs.h>
-extern struct _ddebug __start___dyndbg[];
-extern struct _ddebug __stop___dyndbg[];
-extern struct ddebug_class_map __start___dyndbg_classes[];
-extern struct ddebug_class_map __stop___dyndbg_classes[];
+extern struct _ddebug __start___dyndbg_descs[];
+extern struct _ddebug __stop___dyndbg_descs[];
+extern struct ddebug_class_map __start___dyndbg_class_maps[];
+extern struct ddebug_class_map __stop___dyndbg_class_maps[];
struct ddebug_table {
struct list_head link;
const char *mod_name;
- struct _ddebug *ddebugs;
- struct ddebug_class_map *classes;
- unsigned int num_ddebugs, num_classes;
+ struct _ddebug_info info;
};
struct ddebug_query {
@@ -159,18 +157,18 @@ static void v3pr_info_dq(const struct ddebug_query *query, const char *msg)
* @_vec: name of a member in @_box
*/
#define for_subvec(_i, _sp, _box, _vec) \
- for ((_i) = 0, (_sp) = (_box)->_vec; \
- (_i) < (_box)->num_##_vec; \
+ for ((_i) = 0, (_sp) = (_box)->_vec.start; \
+ (_i) < (_box)->_vec.len; \
(_i)++, (_sp)++) /* { block } */
static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table const *dt,
- const char *class_string,
- int *class_id)
+ const char *class_string,
+ int *class_id)
{
struct ddebug_class_map *map;
int i, idx;
- for_subvec(i, map, dt, classes) {
+ for_subvec(i, map, &dt->info, maps) {
idx = match_string(map->class_names, map->length, class_string);
if (idx >= 0) {
*class_id = idx + map->base;
@@ -270,8 +268,8 @@ static int ddebug_change(const struct ddebug_query *query,
valid_class = _DPRINTK_CLASS_DFLT;
}
- for (i = 0; i < dt->num_ddebugs; i++) {
- struct _ddebug *dp = &dt->ddebugs[i];
+ for (i = 0; i < dt->info.descs.len; i++) {
+ struct _ddebug *dp = &dt->info.descs.start[i];
if (!ddebug_match_desc(query, dp, valid_class))
continue;
@@ -1011,8 +1009,8 @@ static struct _ddebug *ddebug_iter_first(struct ddebug_iter *iter)
}
iter->table = list_entry(ddebug_tables.next,
struct ddebug_table, link);
- iter->idx = iter->table->num_ddebugs;
- return &iter->table->ddebugs[--iter->idx];
+ iter->idx = iter->table->info.descs.len;
+ return &iter->table->info.descs.start[--iter->idx];
}
/*
@@ -1033,10 +1031,10 @@ static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
}
iter->table = list_entry(iter->table->link.next,
struct ddebug_table, link);
- iter->idx = iter->table->num_ddebugs;
+ iter->idx = iter->table->info.descs.len;
--iter->idx;
}
- return &iter->table->ddebugs[iter->idx];
+ return &iter->table->info.descs.start[iter->idx];
}
/*
@@ -1080,16 +1078,19 @@ static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
return dp;
}
-#define class_in_range(class_id, map) \
- (class_id >= map->base && class_id < map->base + map->length)
+static bool ddebug_class_in_range(const int class_id, const struct ddebug_class_map *map)
+{
+ return (class_id >= map->base &&
+ class_id < map->base + map->length);
+}
-static const char *ddebug_class_name(struct ddebug_iter *iter, struct _ddebug *dp)
+static const char *ddebug_class_name(struct ddebug_table *dt, struct _ddebug *dp)
{
- struct ddebug_class_map *map = iter->table->classes;
- int i, nc = iter->table->num_classes;
+ struct ddebug_class_map *map;
+ int i;
- for (i = 0; i < nc; i++, map++)
- if (class_in_range(dp->class_id, map))
+ for_subvec(i, map, &dt->info, maps)
+ if (ddebug_class_in_range(dp->class_id, map))
return map->class_names[dp->class_id - map->base];
return NULL;
@@ -1122,7 +1123,7 @@ static int ddebug_proc_show(struct seq_file *m, void *p)
seq_putc(m, '"');
if (dp->class_id != _DPRINTK_CLASS_DFLT) {
- class = ddebug_class_name(iter, dp);
+ class = ddebug_class_name(iter->table, dp);
if (class)
seq_printf(m, " class:%s", class);
else
@@ -1182,12 +1183,12 @@ static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug
* the builtin/modular classmap vector/section. Save the start
* and length of the subrange at its edges.
*/
- for_subvec(i, cm, di, classes) {
+ for_subvec(i, cm, di, maps) {
if (!strcmp(cm->mod_name, dt->mod_name)) {
if (!nc) {
v2pr_info("start subrange, class[%d]: module:%s base:%d len:%d ty:%d\n",
i, cm->mod_name, cm->base, cm->length, cm->map_type);
- dt->classes = cm;
+ dt->info.maps.start = cm;
}
nc++;
} else if (nc) {
@@ -1195,10 +1196,9 @@ static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug
break;
}
}
- if (nc) {
- dt->num_classes = nc;
+ dt->info.maps.len = nc;
+ if (nc)
vpr_info("module:%s attached %d classes\n", dt->mod_name, nc);
- }
}
/*
@@ -1209,10 +1209,10 @@ static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
{
struct ddebug_table *dt;
- if (!di->num_descs)
+ if (!di->descs.len)
return 0;
- v3pr_info("add-module: %s %d sites\n", modname, di->num_descs);
+ v3pr_info("add-module: %s %d sites\n", modname, di->descs.len);
dt = kzalloc_obj(*dt);
if (dt == NULL) {
@@ -1226,19 +1226,18 @@ static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
* this struct ddebug_table.
*/
dt->mod_name = modname;
- dt->ddebugs = di->descs;
- dt->num_ddebugs = di->num_descs;
+ dt->info = *di;
INIT_LIST_HEAD(&dt->link);
- if (di->classes && di->num_classes)
+ if (di->maps.len)
ddebug_attach_module_classes(dt, di);
mutex_lock(&ddebug_lock);
list_add_tail(&dt->link, &ddebug_tables);
mutex_unlock(&ddebug_lock);
- vpr_info("%3u debug prints in module %s\n", di->num_descs, modname);
+ vpr_info("%3u debug prints in module %s\n", di->descs.len, modname);
return 0;
}
@@ -1385,10 +1384,10 @@ static int __init dynamic_debug_init(void)
char *cmdline;
struct _ddebug_info di = {
- .descs = __start___dyndbg,
- .classes = __start___dyndbg_classes,
- .num_descs = __stop___dyndbg - __start___dyndbg,
- .num_classes = __stop___dyndbg_classes - __start___dyndbg_classes,
+ .descs.start = __start___dyndbg_descs,
+ .maps.start = __start___dyndbg_class_maps,
+ .descs.len = __stop___dyndbg_descs - __start___dyndbg_descs,
+ .maps.len = __stop___dyndbg_class_maps - __start___dyndbg_class_maps,
};
#ifdef CONFIG_MODULES
@@ -1399,7 +1398,7 @@ static int __init dynamic_debug_init(void)
}
#endif /* CONFIG_MODULES */
- if (&__start___dyndbg == &__stop___dyndbg) {
+ if (&__start___dyndbg_descs == &__stop___dyndbg_descs) {
if (IS_ENABLED(CONFIG_DYNAMIC_DEBUG)) {
pr_warn("_ddebug table is empty in a CONFIG_DYNAMIC_DEBUG build\n");
return 1;
@@ -1409,14 +1408,14 @@ static int __init dynamic_debug_init(void)
return 0;
}
- iter = iter_mod_start = __start___dyndbg;
+ iter = iter_mod_start = __start___dyndbg_descs;
modname = iter->modname;
i = mod_sites = mod_ct = 0;
- for (; iter < __stop___dyndbg; iter++, i++, mod_sites++) {
+ for (; iter < __stop___dyndbg_descs; iter++, i++, mod_sites++) {
if (strcmp(modname, iter->modname)) {
- di.descs = iter_mod_start;
- di.num_descs = mod_sites;
+ di.descs.len = mod_sites;
+ di.descs.start = iter_mod_start;
ret = ddebug_add_module(&di, modname);
if (ret)
goto out_err;
@@ -1429,8 +1428,8 @@ static int __init dynamic_debug_init(void)
}
}
- di.descs = iter_mod_start;
- di.num_descs = mod_sites;
+ di.descs.len = mod_sites;
+ di.descs.start = iter_mod_start;
ret = ddebug_add_module(&di, modname);
if (ret)
goto out_err;
@@ -1438,12 +1437,12 @@ static int __init dynamic_debug_init(void)
mod_ct++;
ddebug_init_success = 1;
- vpr_info("%d prdebugs in %d modules, %d KiB in ddebug tables, %d kiB in __dyndbg section\n",
+ vpr_info("%d prdebugs in %d modules, %d KiB in ddebug tables, %d kiB in __dyndbg_descs section\n",
i, mod_ct, (int)((mod_ct * sizeof(struct ddebug_table)) >> 10),
(int)((i * sizeof(struct _ddebug)) >> 10));
- if (di.num_classes)
- v2pr_info(" %d builtin ddebug class-maps\n", di.num_classes);
+ if (di.maps.len)
+ v2pr_info(" %d builtin ddebug class-maps\n", di.maps.len);
/* now that ddebug tables are loaded, process all boot args
* again to find and activate queries given in dyndbg params.
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 22/39] dyndbg: move mod_name down from struct ddebug_table to _ddebug_info
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (20 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 21/39] dyndbg,module: make proper substructs in _ddebug_info Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 23/39] dyndbg: hoist classmap-filter-by-modname up to ddebug_add_module Jim Cromie via B4 Relay
` (16 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
struct _ddebug_info already has most of dyndbg's info for a module;
push debug_table.mod_name down into it, finishing the encapsulation.
This allows refactoring several callchains, passing &_ddebug_info
instead of &ddebug_table, and hoisting the "&dt->info" deref up
instead of repeating it thru the callchans
ddebug_table contains a _ddebug_info member, so code with a ptr to a
ddebug_table still have access to mod_name, just now with "->info."
added in.
In static ddebug_add_module(&di), reinforce the cursor-model by
dropping the modname arg, and setting di->mod_name at each caller.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v2: move RvB after SoB
old-v12
. moved up 1 position in series, ahead of hoist...
---
include/linux/dynamic_debug.h | 1 +
lib/dynamic_debug.c | 52 ++++++++++++++++++++++---------------------
2 files changed, 28 insertions(+), 25 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 535aa3fc36e1..144a2a947abc 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -115,6 +115,7 @@ struct _ddebug_class_maps {
};
struct _ddebug_info {
+ const char *mod_name;
struct _ddebug_descs descs;
struct _ddebug_class_maps maps;
};
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 52990a814345..81396f25623b 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -46,7 +46,6 @@ extern struct ddebug_class_map __stop___dyndbg_class_maps[];
struct ddebug_table {
struct list_head link;
- const char *mod_name;
struct _ddebug_info info;
};
@@ -252,11 +251,12 @@ static int ddebug_change(const struct ddebug_query *query,
/* search for matching ddebugs */
mutex_lock(&ddebug_lock);
list_for_each_entry(dt, &ddebug_tables, link) {
+ struct _ddebug_info *di = &dt->info;
/* match against the module name */
if (query->module &&
- !match_wildcard_hyphen(query->module, dt->mod_name) &&
- !match_wildcard_hyphen(query->module, kbasename(dt->mod_name)))
+ !match_wildcard_hyphen(query->module, di->mod_name) &&
+ !match_wildcard_hyphen(query->module, kbasename(di->mod_name)))
continue;
if (query->class_string) {
@@ -268,8 +268,8 @@ static int ddebug_change(const struct ddebug_query *query,
valid_class = _DPRINTK_CLASS_DFLT;
}
- for (i = 0; i < dt->info.descs.len; i++) {
- struct _ddebug *dp = &dt->info.descs.start[i];
+ for (i = 0; i < di->descs.len; i++) {
+ struct _ddebug *dp = &di->descs.start[i];
if (!ddebug_match_desc(query, dp, valid_class))
continue;
@@ -289,7 +289,7 @@ static int ddebug_change(const struct ddebug_query *query,
#endif
v4pr_info("changed %s:%d [%s]%s %s => %s\n",
trim_prefix(dp->filename), dp->lineno,
- dt->mod_name, dp->function,
+ di->mod_name, dp->function,
ddebug_describe_flags(dp->flags, &fbuf),
ddebug_describe_flags(newflags, &nbuf));
dp->flags = newflags;
@@ -1084,12 +1084,12 @@ static bool ddebug_class_in_range(const int class_id, const struct ddebug_class_
class_id < map->base + map->length);
}
-static const char *ddebug_class_name(struct ddebug_table *dt, struct _ddebug *dp)
+static const char *ddebug_class_name(struct _ddebug_info *di, struct _ddebug *dp)
{
struct ddebug_class_map *map;
int i;
- for_subvec(i, map, &dt->info, maps)
+ for_subvec(i, map, di, maps)
if (ddebug_class_in_range(dp->class_id, map))
return map->class_names[dp->class_id - map->base];
@@ -1117,13 +1117,13 @@ static int ddebug_proc_show(struct seq_file *m, void *p)
seq_printf(m, "%s:%u [%s]%s =%s \"",
trim_prefix(dp->filename), dp->lineno,
- iter->table->mod_name, dp->function,
+ iter->table->info.mod_name, dp->function,
ddebug_describe_flags(dp->flags, &flags));
seq_escape_str(m, dp->format, ESCAPE_SPACE, "\t\r\n\"");
seq_putc(m, '"');
if (dp->class_id != _DPRINTK_CLASS_DFLT) {
- class = ddebug_class_name(iter->table, dp);
+ class = ddebug_class_name(&iter->table->info, dp);
if (class)
seq_printf(m, " class:%s", class);
else
@@ -1184,7 +1184,7 @@ static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug
* and length of the subrange at its edges.
*/
for_subvec(i, cm, di, maps) {
- if (!strcmp(cm->mod_name, dt->mod_name)) {
+ if (!strcmp(cm->mod_name, dt->info.mod_name)) {
if (!nc) {
v2pr_info("start subrange, class[%d]: module:%s base:%d len:%d ty:%d\n",
i, cm->mod_name, cm->base, cm->length, cm->map_type);
@@ -1198,34 +1198,33 @@ static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug
}
dt->info.maps.len = nc;
if (nc)
- vpr_info("module:%s attached %d classes\n", dt->mod_name, nc);
+ vpr_info("module:%s attached %d classes\n", dt->info.mod_name, nc);
}
/*
* Allocate a new ddebug_table for the given module
* and add it to the global list.
*/
-static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
+static int ddebug_add_module(struct _ddebug_info *di)
{
struct ddebug_table *dt;
if (!di->descs.len)
return 0;
- v3pr_info("add-module: %s %d sites\n", modname, di->descs.len);
+ v3pr_info("add-module: %s %d sites\n", di->mod_name, di->descs.len);
dt = kzalloc_obj(*dt);
if (dt == NULL) {
- pr_err("error adding module: %s\n", modname);
+ pr_err("error adding module: %s\n", di->mod_name);
return -ENOMEM;
}
/*
- * For built-in modules, name lives in .rodata and is
- * immortal. For loaded modules, name points at the name[]
- * member of struct module, which lives at least as long as
- * this struct ddebug_table.
+ * For built-in modules, name (as supplied in di by its
+ * callers) lives in .rodata and is immortal. For loaded
+ * modules, name points at the name[] member of struct module,
+ * which lives at least as long as this struct ddebug_table.
*/
- dt->mod_name = modname;
dt->info = *di;
INIT_LIST_HEAD(&dt->link);
@@ -1237,7 +1236,7 @@ static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
list_add_tail(&dt->link, &ddebug_tables);
mutex_unlock(&ddebug_lock);
- vpr_info("%3u debug prints in module %s\n", di->descs.len, modname);
+ vpr_info("%3u debug prints in module %s\n", di->descs.len, di->mod_name);
return 0;
}
@@ -1300,7 +1299,7 @@ static int ddebug_remove_module(const char *mod_name)
mutex_lock(&ddebug_lock);
list_for_each_entry_safe(dt, nextdt, &ddebug_tables, link) {
- if (dt->mod_name == mod_name) {
+ if (dt->info.mod_name == mod_name) {
ddebug_table_free(dt);
ret = 0;
break;
@@ -1320,7 +1319,8 @@ static int ddebug_module_notify(struct notifier_block *self, unsigned long val,
switch (val) {
case MODULE_STATE_COMING:
- ret = ddebug_add_module(&mod->dyndbg_info, mod->name);
+ mod->dyndbg_info.mod_name = mod->name;
+ ret = ddebug_add_module(&mod->dyndbg_info);
if (ret)
WARN(1, "Failed to allocate memory: dyndbg may not work properly.\n");
break;
@@ -1416,7 +1416,8 @@ static int __init dynamic_debug_init(void)
if (strcmp(modname, iter->modname)) {
di.descs.len = mod_sites;
di.descs.start = iter_mod_start;
- ret = ddebug_add_module(&di, modname);
+ di.mod_name = modname;
+ ret = ddebug_add_module(&di);
if (ret)
goto out_err;
@@ -1430,7 +1431,8 @@ static int __init dynamic_debug_init(void)
di.descs.len = mod_sites;
di.descs.start = iter_mod_start;
- ret = ddebug_add_module(&di, modname);
+ di.mod_name = modname;
+ ret = ddebug_add_module(&di);
if (ret)
goto out_err;
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 23/39] dyndbg: hoist classmap-filter-by-modname up to ddebug_add_module
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (21 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 22/39] dyndbg: move mod_name down from struct ddebug_table to _ddebug_info Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 24/39] dyndbg-API: replace DECLARE_DYNDBG_CLASSMAP Jim Cromie via B4 Relay
` (15 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
The body of ddebug_attach_module_classes() is just a code-block that
finds the contiguous subrange of classmaps matching on modname, and
saves it into the ddebug_table's info record.
Implement this block in a macro to accommodate different component
vectors in the "box" (as named in the for_subvec macro). We will
reuse this macro shortly.
And hoist its invocation out of ddebug_attach_module_classes() up into
ddebug_add_module(). This moves the filtering step up closer to
dynamic_debug_init(), which already segments the builtin pr_debug
descriptors on their mod_name boundaries.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v8: set maps.len = nc unconditionally
v3: expand block-comment in ddebug_add_module
v2: move RvB after SoB
finish hoist - drop old fn - ddebug_attach_module_classes
the v1 rev left the old ddebug_attach_module_classes in place, but it
is completely redundant now, since it already lost the list-linking
job it was doing.
It was being cut out later in the patchset (in the unsent API
adaptation phase), but for cleaner review, lets excise it now.
OLD all-in-1-series (pre split into reviewable chunks)
v10?- reordered params to match kdoc
v12- refactor/rename: s/dd_mark_vector_subrange/dd_set_module_subrange/
1. Renamed the macro from dd_mark_vector_subrange to
dd_set_module_subrange to better reflect its purpose of narrowing a
vector to a module-specific subrange.
2. Simplified the arguments by removing the redundant _dst, as the _di
pointer already provides access to the target _ddebug_info struct.
3. Refactored for Clarity: Instead of overwriting the struct's start
pointer while the for_subvec loop is using it to iterate, I
introduced a temporary __start variable. This avoids the "subtle"
side effect and makes the logic easier to follow.
4. Updated Documentation: Improved the comment block to explicitly
state that the macro scans for the first match and counts
contiguous elements.
fiuxp
---
lib/dynamic_debug.c | 79 +++++++++++++++++++++++++++++------------------------
1 file changed, 43 insertions(+), 36 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 81396f25623b..2065bfd1687e 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -1173,33 +1173,34 @@ static const struct proc_ops proc_fops = {
.proc_write = ddebug_proc_write
};
-static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug_info *di)
-{
- struct ddebug_class_map *cm;
- int i, nc = 0;
-
- /*
- * Find this module's classmaps in a subrange/wholerange of
- * the builtin/modular classmap vector/section. Save the start
- * and length of the subrange at its edges.
- */
- for_subvec(i, cm, di, maps) {
- if (!strcmp(cm->mod_name, dt->info.mod_name)) {
- if (!nc) {
- v2pr_info("start subrange, class[%d]: module:%s base:%d len:%d ty:%d\n",
- i, cm->mod_name, cm->base, cm->length, cm->map_type);
- dt->info.maps.start = cm;
- }
- nc++;
- } else if (nc) {
- /* end of matching classmaps */
- break;
- }
- }
- dt->info.maps.len = nc;
- if (nc)
- vpr_info("module:%s attached %d classes\n", dt->info.mod_name, nc);
-}
+/*
+ * dd_set_module_subrange - find matching subrange of classmaps
+ * @_i: caller-provided index var
+ * @_sp: cursor into @_vec
+ * @_di: pointer to the struct _ddebug_info to be narrowed
+ * @_vec: name of the vector member (must have .start and .len)
+ *
+ * Narrow a _ddebug_info's vector (@_vec) of classmaps to the
+ * contiguous subrange of elements where ->mod_name matches
+ * @__di->mod_name. This is primarily for builtins, loadable modules
+ * have only their classmaps, and dont need this sub-selection.
+ */
+#define dd_set_module_subrange(_i, _sp, _di, _vec) ({ \
+ struct _ddebug_info *__di = (_di); \
+ typeof(__di->_vec.start) __start = NULL; \
+ int __nc = 0; \
+ for_subvec(_i, _sp, __di, _vec) { \
+ if (!strcmp((_sp)->mod_name, __di->mod_name)) { \
+ if (!__nc++) \
+ __start = (_sp); \
+ } else if (__nc) { \
+ break; /* end of consecutive matches */ \
+ } \
+ } \
+ __di->_vec.len = __nc; \
+ if (__nc) \
+ __di->_vec.start = __start; \
+})
/*
* Allocate a new ddebug_table for the given module
@@ -1208,6 +1209,8 @@ static void ddebug_attach_module_classes(struct ddebug_table *dt, struct _ddebug
static int ddebug_add_module(struct _ddebug_info *di)
{
struct ddebug_table *dt;
+ struct ddebug_class_map *cm;
+ int i;
if (!di->descs.len)
return 0;
@@ -1220,17 +1223,21 @@ static int ddebug_add_module(struct _ddebug_info *di)
return -ENOMEM;
}
/*
- * For built-in modules, name (as supplied in di by its
- * callers) lives in .rodata and is immortal. For loaded
- * modules, name points at the name[] member of struct module,
- * which lives at least as long as this struct ddebug_table.
+ * For built-in modules, di is a partial cursor into the
+ * builtin dyndbg data; the descriptors are the subrange
+ * matching the modname, but the classmaps are the full set.
+ * We find and set the relevant subrange of classmaps here.
+ *
+ * The modname string is in .rodata, the descriptors and
+ * classmaps are in writable .data. All are immortal.
+ *
+ * For loaded modules, mod_name points at the name[] member
+ * of struct module, and the descriptors and classmaps point
+ * at the module's ELF sections; all have lifetimes matching
+ * the module's presence.
*/
dt->info = *di;
-
- INIT_LIST_HEAD(&dt->link);
-
- if (di->maps.len)
- ddebug_attach_module_classes(dt, di);
+ dd_set_module_subrange(i, cm, &dt->info, maps);
mutex_lock(&ddebug_lock);
list_add_tail(&dt->link, &ddebug_tables);
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 24/39] dyndbg-API: replace DECLARE_DYNDBG_CLASSMAP
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (22 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 23/39] dyndbg: hoist classmap-filter-by-modname up to ddebug_add_module Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 25/39] selftests/dyndbg: enable FT_classmap_inheritance Jim Cromie via B4 Relay
` (14 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
DECLARE_DYNDBG_CLASSMAP had a flaw: multiple invocations across both
core and driver modules broke the K&R "define once, refer afterwards"
principle, causing boot-time parameter propagation failures.
Replace it with an explicit client-server model:
- DYNAMIC_DEBUG_CLASSMAP_DEFINE: invoked once in the core module, creating
and exporting the classmap.
- DYNAMIC_DEBUG_CLASSMAP_USE: invoked across driver/helper modules,
placing a reference record into the __dyndbg_class_users section.
At module load time, dyndbg scans __dyndbg_class_users, resolves the
reference to the parent classmap, finds the associated controlling
kernel parameter, and automatically applies the initial bitmap to the
loading module.
Fixes: aad0214f3026 ("dyndbg: add DECLARE_DYNDBG_CLASSMAP macro")
Cc: linux-doc@vger.kernel.org
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
include/asm-generic/dyndbg.lds.h | 6 +-
include/linux/dynamic_debug.h | 164 +++++++++++++++++++++++++++++----
kernel/module/main.c | 3 +
lib/Kconfig.debug | 24 ++++-
lib/Makefile | 3 +
lib/dynamic_debug.c | 191 +++++++++++++++++++++++++++++++++++++--
lib/test_dynamic_debug.c | 131 +++++++++++++++++++++------
lib/test_dynamic_debug_submod.c | 14 +++
8 files changed, 479 insertions(+), 57 deletions(-)
diff --git a/include/asm-generic/dyndbg.lds.h b/include/asm-generic/dyndbg.lds.h
index ec661f9f3793..0ffc9cde4377 100644
--- a/include/asm-generic/dyndbg.lds.h
+++ b/include/asm-generic/dyndbg.lds.h
@@ -5,7 +5,8 @@
#include <asm-generic/bounded_sections.lds.h>
#define DYNDBG_SECTIONS() \
BOUNDED_SECTION_BY(__dyndbg_descs, ___dyndbg_descs) \
- BOUNDED_SECTION_BY(__dyndbg_class_maps, ___dyndbg_class_maps)
+ BOUNDED_SECTION_BY(__dyndbg_class_maps, ___dyndbg_class_maps) \
+ BOUNDED_SECTION_BY(__dyndbg_class_users, ___dyndbg_class_users)
#define MOD_DYNDBG_SECTIONS() \
__dyndbg_descs 0 : ALIGN(8) { \
@@ -13,6 +14,9 @@
} \
__dyndbg_class_maps 0 : ALIGN(8) { \
KEEP(*(__dyndbg_class_maps)) \
+ } \
+ __dyndbg_class_users 0 : ALIGN(8) { \
+ KEEP(*(__dyndbg_class_users)) \
}
#endif /* __ASM_GENERIC_DYNDBG_LDS_H */
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 144a2a947abc..6517e0169a80 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -90,19 +90,30 @@ enum ddebug_class_map_type {
*/
};
+/*
+ * map @class_names 0..N to consecutive constants starting at @base.
+ */
struct ddebug_class_map {
- struct module *mod; /* NULL for builtins */
- const char *mod_name; /* needed for builtins */
+ const struct module *mod; /* NULL for builtins */
+ const char *mod_name; /* needed for builtins */
const char **class_names;
const int length;
const int base; /* index of 1st .class_id, allows split/shared space */
enum ddebug_class_map_type map_type;
-};
+} __aligned(8);
+
+struct ddebug_class_user {
+ char *mod_name;
+ struct ddebug_class_map *map;
+ const int offset; /* offset from map->base */
+} __aligned(8);
/*
- * @_ddebug_info: gathers module/builtin dyndbg_* __sections together.
+ * @_ddebug_info: gathers module/builtin __dyndbg_<T> __sections
+ * together, each is a vec_<T>: a struct { struct T start[], int len }.
+ *
* For builtins, it is used as a cursor, with the inner structs
- * marking sub-vectors of the builtin __sections in DATA.
+ * marking sub-vectors of the builtin __sections in DATA_DATA
*/
struct _ddebug_descs {
struct _ddebug *start;
@@ -114,10 +125,16 @@ struct _ddebug_class_maps {
unsigned int len;
};
+struct _ddebug_class_users {
+ struct ddebug_class_user *start;
+ int len;
+};
+
struct _ddebug_info {
const char *mod_name;
struct _ddebug_descs descs;
struct _ddebug_class_maps maps;
+ struct _ddebug_class_users users;
};
struct ddebug_class_param {
@@ -136,17 +153,86 @@ struct ddebug_class_param {
#if defined(CONFIG_DYNAMIC_DEBUG) || \
(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
+/*
+ * dyndbg classmaps is modelled closely upon drm.debug:
+ *
+ * 1. run-time control via sysfs node (api/abi)
+ * 2. each bit 0..N controls a single "category"
+ * 3. a pr_debug can have only 1 category, not several.
+ * 4. "kind" is a compile-time constant: 0..N or BIT() thereof
+ * 5. macro impls - give compile-time resolution or fail.
+ *
+ * dyndbg classmaps design axioms/constraints:
+ *
+ * . optimizing compilers use 1-5 above, so preserve them.
+ * . classmaps.class_id *is* the category.
+ * . classmap definers/users are modules.
+ * . every user wants 0..N
+ * . 0..N exposes as ABI
+ * . no 1 use-case wants N > 32, 16 is more usable
+ * . N <= 64 in *all* cases
+ * . modules/subsystems make category/classmap decisions
+ * . ie an enum: DRM has DRM_UT_CORE..DRM_UT_DRMRES
+ * . some categories are exposed to user: ABI
+ * . making modules change their numbering is bogus, avoid if possible
+ *
+ * We can solve for all these at once:
+ * A: map class-names to a .class_id range at compile-time
+ * B: allow only "class NAME" changes to class'd callsites at run-time
+ * C: users/modules must manage 0..62 hardcoded .class_id range limit.
+ * D: existing pr_debugs get CLASS_DFLT=63
+ *
+ * By mapping class-names at >control to class-ids underneath, and
+ * responding only to class-names DEFINEd or USEd by the module, we
+ * can private-ize the class-id, and adjust class'd pr_debugs only by
+ * their names.
+ *
+ * This give us:
+ * E: class_ids without classnames are unreachable
+ * F: user modules opt-in by DEFINEing a classmap and/or USEing another
+ *
+ * Multi-classmap modules/groups are supported, if the classmaps share
+ * the class_id space [0..62] without overlap/conflict.
+ *
+ * NOTE: Due to the integer class_id, this api cannot disallow these:
+ * __pr_debug_cls(0, "fake CORE msg"); works only if a classmap maps 0.
+ * __pr_debug_cls(22, "no such class"); compiles but is not reachable
+ */
+
/**
- * DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module
- * @_var: a struct ddebug_class_map, passed to module_param_cb
- * @_maptype: enum ddebug_class_map_type, chooses bits/verbose
- * @_base: offset of 1st class-name. splits .class_id space
- * @classes: class-names used to control class'd prdbgs
+ * DYNAMIC_DEBUG_CLASSMAP_DEFINE - define debug classes used by a module.
+ * @_var: name of the classmap, exported for other modules coordinated use.
+ * @_mapty: enum ddebug_class_map_type: 0:DISJOINT - independent, 1:LEVEL - v2>v1
+ * @_base: reserve N classids starting at _base, to split 0..62 classid space
+ * @classes: names of the N classes.
+ *
+ * This tells dyndbg what class_ids the module is using: _base..+N, by
+ * mapping names onto them. This qualifies "class NAME" >controls on
+ * the defining module, ignoring unknown names.
+ */
+#define DYNAMIC_DEBUG_CLASSMAP_DEFINE(_var, _mapty, _base, ...) \
+ static const char *_var##_classnames[] = { __VA_ARGS__ }; \
+ extern struct ddebug_class_map _var; \
+ struct ddebug_class_map __aligned(8) __used \
+ __section("__dyndbg_class_maps") _var = { \
+ .mod = THIS_MODULE, \
+ .mod_name = DDEBUG_MODNAME, \
+ .base = (_base), \
+ .map_type = (_mapty), \
+ .length = ARRAY_SIZE(_var##_classnames), \
+ .class_names = _var##_classnames, \
+ }; \
+ EXPORT_SYMBOL(_var)
+
+/*
+ * XXX: keep this until DRM adapts to use the DEFINE/USE api, it
+ * differs from DYNAMIC_DEBUG_CLASSMAP_DEFINE by the lack of the
+ * extern/EXPORT on the struct init, and cascading thinkos.
*/
#define DECLARE_DYNDBG_CLASSMAP(_var, _maptype, _base, ...) \
static const char *_var##_classnames[] = { __VA_ARGS__ }; \
static struct ddebug_class_map __aligned(8) __used \
- __section("__dyndbg_class_maps") _var = { \
+ __section("__dyndbg_class_maps") _var = { \
.mod = THIS_MODULE, \
.mod_name = DDEBUG_MODNAME, \
.base = _base, \
@@ -155,6 +241,44 @@ struct ddebug_class_param {
.length = __DDEBUG_ARRAY_SIZE(_var##_classnames), \
}
+/**
+ * DYNAMIC_DEBUG_CLASSMAP_USE - refer to a classmap, DEFINEd elsewhere.
+ * @_var: name of the exported classmap var
+ *
+ * This tells dyndbg that the module has prdbgs with classids defined
+ * in the named classmap. This qualifies "class NAME" >controls on
+ * the user module, and ignores unknown names. This is a wrapper for
+ * DYNAMIC_DEBUG_CLASSMAP_USE_() with a base offset of 0.
+ */
+#define DYNAMIC_DEBUG_CLASSMAP_USE(_var) \
+ DYNAMIC_DEBUG_CLASSMAP_USE_(_var, 0)
+
+/**
+ * DYNAMIC_DEBUG_CLASSMAP_USE_ - refer to a classmap with a manual offset.
+ * @_var: name of the exported classmap var to use.
+ * @_offset: an integer offset to add to the class IDs of the used map.
+ *
+ * This is an extended version of DYNAMIC_DEBUG_CLASSMAP_USE(). It should
+ * only be used to resolve class ID conflicts when a module uses multiple
+ * classmaps that have overlapping ID ranges.
+ *
+ * The final class IDs for the used map will be calculated as:
+ * original_map_base + class_index + @_offset.
+ */
+#define DYNAMIC_DEBUG_CLASSMAP_USE_(_var, _offset) \
+ extern struct ddebug_class_map _var; \
+ static_assert((_offset) >= 0 && (_offset) < _DPRINTK_CLASS_DFLT, \
+ "classmap use offset must be in 0..62"); \
+ extern struct ddebug_class_user __aligned(8) \
+ __PASTE(_var ## _, __KBUILD_MODNAME); \
+ struct ddebug_class_user __aligned(8) __used \
+ __section("__dyndbg_class_users") \
+ __PASTE(_var ## _, __KBUILD_MODNAME) = { \
+ .mod_name = DDEBUG_MODNAME, \
+ .map = &(_var), \
+ .offset = _offset \
+ }
+
extern __printf(2, 3)
void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
@@ -316,12 +440,18 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
KERN_DEBUG, prefix_str, prefix_type, \
rowsize, groupsize, buf, len, ascii)
-/* for test only, generally expect drm.debug style macro wrappers */
-#define __pr_debug_cls(cls, fmt, ...) do { \
+/*
+ * This is the "model" class variant of pr_debug. It is not really
+ * intended for direct use; I'd encourage DRM-style drm_dbg_<T>
+ * macros for the interface, along with an enum for the <T>
+ *
+ * __printf(2, 3) would apply.
+ */
+#define __pr_debug_cls(cls, fmt, ...) ({ \
BUILD_BUG_ON_MSG(!__builtin_constant_p(cls), \
"expecting constant class int/enum"); \
dynamic_pr_debug_cls(cls, fmt, ##__VA_ARGS__); \
- } while (0)
+})
#else /* !(CONFIG_DYNAMIC_DEBUG || (CONFIG_DYNAMIC_DEBUG_CORE && DYNAMIC_DEBUG_MODULE)) */
@@ -329,6 +459,9 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#include <linux/errno.h>
#include <linux/printk.h>
+#define DYNAMIC_DEBUG_CLASSMAP_DEFINE(_var, _mapty, _base, ...)
+#define DYNAMIC_DEBUG_CLASSMAP_USE(_var)
+#define DYNAMIC_DEBUG_CLASSMAP_USE_(_var, _offset)
#define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt)
#define DYNAMIC_DEBUG_BRANCH(descriptor) false
#define DECLARE_DYNDBG_CLASSMAP(...)
@@ -375,8 +508,7 @@ static inline int param_set_dyndbg_classes(const char *instr, const struct kerne
static inline int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp)
{ return 0; }
-#endif
-
+#endif /* !CONFIG_DYNAMIC_DEBUG_CORE */
extern const struct kernel_param_ops param_ops_dyndbg_classes;
diff --git a/kernel/module/main.c b/kernel/module/main.c
index 852cce2c5113..abf0c6991f66 100644
--- a/kernel/module/main.c
+++ b/kernel/module/main.c
@@ -2791,6 +2791,9 @@ static int find_module_sections(struct module *mod, struct load_info *info)
mod->dyndbg_info.maps.start = section_objs(info, "__dyndbg_class_maps",
sizeof(*mod->dyndbg_info.maps.start),
&mod->dyndbg_info.maps.len);
+ mod->dyndbg_info.users.start = section_objs(info, "__dyndbg_class_users",
+ sizeof(*mod->dyndbg_info.users.start),
+ &mod->dyndbg_info.users.len);
#endif
return 0;
diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index c3f448f3b8f1..2abf28d6d063 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -3138,12 +3138,26 @@ config TEST_STATIC_KEYS
If unsure, say N.
config TEST_DYNAMIC_DEBUG
- tristate "Test DYNAMIC_DEBUG"
- depends on DYNAMIC_DEBUG
+ tristate "Build test-dynamic-debug module"
+ depends on DYNAMIC_DEBUG || DYNAMIC_DEBUG_CORE
help
- This module registers a tracer callback to count enabled
- pr_debugs in a 'do_debugging' function, then alters their
- enablements, calls the function, and compares counts.
+ This module exercises/demonstrates dyndbg's classmap API, by
+ creating 2 classes: a DISJOINT classmap (supporting DRM.debug)
+ and a LEVELS/VERBOSE classmap (like verbose2 > verbose1).
+
+ If unsure, say N.
+
+config TEST_DYNAMIC_DEBUG_SUBMOD
+ tristate "Build test-dynamic-debug submodule"
+ default m
+ depends on DYNAMIC_DEBUG || DYNAMIC_DEBUG_CORE
+ depends on TEST_DYNAMIC_DEBUG
+ help
+ This sub-module uses a classmap defined and exported by the
+ parent module, recapitulating drm & driver's shared use of
+ drm.debug to control enabled debug-categories.
+ It is tristate, independent of parent, to allow testing all
+ proper combinations of parent=y/m submod=y/m.
If unsure, say N.
diff --git a/lib/Makefile b/lib/Makefile
index dfab958327c5..9cdf0a430f5f 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -85,6 +85,7 @@ obj-$(CONFIG_TEST_RHASHTABLE) += test_rhashtable.o
obj-$(CONFIG_TEST_STATIC_KEYS) += test_static_keys.o
obj-$(CONFIG_TEST_STATIC_KEYS) += test_static_key_base.o
obj-$(CONFIG_TEST_DYNAMIC_DEBUG) += test_dynamic_debug.o
+obj-$(CONFIG_TEST_DYNAMIC_DEBUG_SUBMOD) += test_dynamic_debug_submod.o
obj-$(CONFIG_TEST_BITMAP) += test_bitmap.o
ifeq ($(CONFIG_CC_IS_CLANG)$(CONFIG_KASAN),yy)
@@ -206,6 +207,8 @@ obj-$(CONFIG_ARCH_NEED_CMPXCHG_1_EMU) += cmpxchg-emu.o
obj-$(CONFIG_DYNAMIC_DEBUG_CORE) += dynamic_debug.o
#ensure exported functions have prototypes
CFLAGS_dynamic_debug.o := -DDYNAMIC_DEBUG_MODULE
+CFLAGS_test_dynamic_debug.o := -DDYNAMIC_DEBUG_MODULE
+CFLAGS_test_dynamic_debug_submod.o := -DDYNAMIC_DEBUG_MODULE
obj-$(CONFIG_SYMBOLIC_ERRNAME) += errname.o
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 2065bfd1687e..0e25b4d53942 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -29,6 +29,7 @@
#include <linux/string_helpers.h>
#include <linux/uaccess.h>
#include <linux/dynamic_debug.h>
+
#include <linux/debugfs.h>
#include <linux/slab.h>
#include <linux/jump_label.h>
@@ -43,6 +44,8 @@ extern struct _ddebug __start___dyndbg_descs[];
extern struct _ddebug __stop___dyndbg_descs[];
extern struct ddebug_class_map __start___dyndbg_class_maps[];
extern struct ddebug_class_map __stop___dyndbg_class_maps[];
+extern struct ddebug_class_user __start___dyndbg_class_users[];
+extern struct ddebug_class_user __stop___dyndbg_class_users[];
struct ddebug_table {
struct list_head link;
@@ -160,20 +163,39 @@ static void v3pr_info_dq(const struct ddebug_query *query, const char *msg)
(_i) < (_box)->_vec.len; \
(_i)++, (_sp)++) /* { block } */
-static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table const *dt,
- const char *class_string,
+#define v2pr_di_info(di_p, msg_p, ...) \
+({ \
+ struct _ddebug_info const *_di = di_p; \
+ v2pr_info(msg_p "module:%s nd:%d nc:%d nu:%d\n", ##__VA_ARGS__, \
+ _di->mod_name, _di->descs.len, _di->maps.len, \
+ _di->users.len); \
+})
+
+static struct ddebug_class_map *ddebug_find_valid_class(struct _ddebug_info const *di,
+ const char *query_class,
int *class_id)
{
struct ddebug_class_map *map;
+ struct ddebug_class_user *cli;
int i, idx;
- for_subvec(i, map, &dt->info, maps) {
- idx = match_string(map->class_names, map->length, class_string);
+ for_subvec(i, map, di, maps) {
+ idx = match_string(map->class_names, map->length, query_class);
if (idx >= 0) {
+ v2pr_di_info(di, "good-class: %s.%s ", map->mod_name, query_class);
*class_id = idx + map->base;
return map;
}
}
+ for_subvec(i, cli, di, users) {
+ idx = match_string(cli->map->class_names, cli->map->length, query_class);
+ if (idx >= 0) {
+ v2pr_di_info(di, "class-ref: %s -> %s.%s ",
+ cli->mod_name, cli->map->mod_name, query_class);
+ *class_id = idx + cli->map->base + cli->offset;
+ return cli->map;
+ }
+ }
*class_id = -ENOENT;
return NULL;
}
@@ -237,8 +259,7 @@ static bool ddebug_match_desc(const struct ddebug_query *query,
return true;
}
-static int ddebug_change(const struct ddebug_query *query,
- struct flag_settings *modifiers)
+static int ddebug_change(const struct ddebug_query *query, struct flag_settings *modifiers)
{
int i;
struct ddebug_table *dt;
@@ -260,7 +281,8 @@ static int ddebug_change(const struct ddebug_query *query,
continue;
if (query->class_string) {
- map = ddebug_find_valid_class(dt, query->class_string, &valid_class);
+ map = ddebug_find_valid_class(&dt->info, query->class_string,
+ &valid_class);
if (!map)
continue;
} else {
@@ -593,7 +615,7 @@ static int ddebug_exec_query(char *query_string, const char *modname)
/* handle multiple queries in query string, continue on error, return
last error or number of matching callsites. Module name is either
- in param (for boot arg) or perhaps in query string.
+ in the modname arg (for boot args) or perhaps in query string.
*/
static int ddebug_exec_queries(char *query, const char *modname)
{
@@ -772,6 +794,7 @@ int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp)
default:
return -1;
}
+ return 0;
}
EXPORT_SYMBOL(param_get_dyndbg_classes);
@@ -1084,15 +1107,26 @@ static bool ddebug_class_in_range(const int class_id, const struct ddebug_class_
class_id < map->base + map->length);
}
+static bool ddebug_user_class_in_range(const int class_id, const struct ddebug_class_user *cli)
+{
+ int base = cli->map->base + cli->offset;
+ return (class_id >= base && class_id < base + cli->map->length);
+}
+
static const char *ddebug_class_name(struct _ddebug_info *di, struct _ddebug *dp)
{
struct ddebug_class_map *map;
+ struct ddebug_class_user *cli;
int i;
for_subvec(i, map, di, maps)
if (ddebug_class_in_range(dp->class_id, map))
return map->class_names[dp->class_id - map->base];
+ for_subvec(i, cli, di, users)
+ if (ddebug_user_class_in_range(dp->class_id, cli))
+ return cli->map->class_names[dp->class_id - cli->map->base - cli->offset];
+
return NULL;
}
@@ -1173,6 +1207,136 @@ static const struct proc_ops proc_fops = {
.proc_write = ddebug_proc_write
};
+#define vpr_cm_info(cm_p, msg_fmt, ...) ({ \
+ struct ddebug_class_map const *_cm = cm_p; \
+ v2pr_info(msg_fmt "%s [%d..%d] %s..%s\n", ##__VA_ARGS__, \
+ _cm->mod_name, _cm->base, _cm->base + _cm->length, \
+ _cm->class_names[0], _cm->class_names[_cm->length - 1]); \
+ })
+
+/*
+ * Modules which define classmaps get them initialized by
+ * param-callback via module.c:parse_one. Modules which use other's
+ * classmaps must be initialized explicitly.
+ */
+static inline u32 ddebug_class_param_to_bits(const struct ddebug_class_param *dcp)
+{
+ const struct ddebug_class_map *map = dcp->map;
+
+ switch (map->map_type) {
+ case DD_CLASS_TYPE_DISJOINT_BITS:
+ return *dcp->bits & CLASSMAP_BITMASK(map->length);
+ case DD_CLASS_TYPE_LEVEL_NUM:
+ return CLASSMAP_BITMASK(min_t(u32, *dcp->lvl, map->length));
+ default:
+ return 0;
+ }
+}
+
+static void __maybe_unused ddebug_class_param_clamp_input(u32 *inrep, const struct kernel_param *kp)
+{
+ const struct ddebug_class_param *dcp = kp->arg;
+ const struct ddebug_class_map *map = dcp->map;
+
+ switch (map->map_type) {
+ case DD_CLASS_TYPE_DISJOINT_BITS:
+ /* expect bits. mask and warn if too many */
+ if (*inrep & ~CLASSMAP_BITMASK(map->length)) {
+ pr_warn("%s: input: 0x%x exceeds mask: 0x%x, masking\n",
+ KP_NAME(kp), *inrep, CLASSMAP_BITMASK(map->length));
+ *inrep &= CLASSMAP_BITMASK(map->length);
+ }
+ break;
+ case DD_CLASS_TYPE_LEVEL_NUM:
+ /* input is bitpos, of highest verbosity to be enabled */
+ if (*inrep > map->length) {
+ pr_warn("%s: level:%d exceeds max:%d, clamping\n",
+ KP_NAME(kp), *inrep, map->length);
+ *inrep = map->length;
+ }
+ break;
+ }
+}
+
+/* called for class-users only, parse_one does this for definer modules */
+static void ddebug_sync_classbits(const struct kernel_param *kp, const char *modname)
+{
+ const struct ddebug_class_param *dcp = kp->arg;
+ u32 val, new_bits;
+
+ if (!dcp || !dcp->map)
+ return;
+
+ switch (dcp->map->map_type) {
+ case DD_CLASS_TYPE_DISJOINT_BITS:
+ val = READ_ONCE(*dcp->bits);
+ ddebug_class_param_clamp_input(&val, kp);
+ new_bits = val;
+ v2pr_info(" %s: classbits: 0x%x\n", KP_NAME(kp), new_bits);
+ ddebug_apply_class_bitmap(dcp, &new_bits, 0UL, modname);
+ break;
+ case DD_CLASS_TYPE_LEVEL_NUM:
+ val = READ_ONCE(*dcp->lvl);
+ ddebug_class_param_clamp_input(&val, kp);
+ new_bits = CLASSMAP_BITMASK(val);
+ v2pr_info(" %s: lvl:%d bits:0x%x\n", KP_NAME(kp), val, new_bits);
+ ddebug_apply_class_bitmap(dcp, &new_bits, 0UL, modname);
+ break;
+ default:
+ pr_err("bad map type %d\n", dcp->map->map_type);
+ return;
+ }
+}
+
+static void ddebug_match_apply_kparam(const struct kernel_param *kp,
+ const struct ddebug_class_map *map,
+ const char *mod_name)
+{
+ struct ddebug_class_param *dcp;
+
+ if (kp->ops != ¶m_ops_dyndbg_classes)
+ return;
+
+ dcp = (struct ddebug_class_param *)kp->arg;
+
+ if (dcp && dcp->map == map) {
+ v2pr_info(" kp:%s.%s =0x%x", mod_name, kp->name, *dcp->bits);
+ vpr_cm_info(map, " %s maps ", mod_name);
+ ddebug_sync_classbits(kp, mod_name);
+ }
+}
+
+static void ddebug_apply_params(const struct ddebug_class_map *cm, const char *mod_name)
+{
+ const struct kernel_param *kp;
+#if IS_ENABLED(CONFIG_MODULES)
+ int i;
+
+ if (cm->mod) {
+ vpr_cm_info(cm, "loaded classmap: %s ", mod_name);
+ /* ifdef protects the cm->mod->kp deref */
+ for (i = 0, kp = cm->mod->kp; i < cm->mod->num_kp; i++, kp++)
+ ddebug_match_apply_kparam(kp, cm, mod_name);
+ }
+#endif
+ if (!cm->mod) {
+ vpr_cm_info(cm, "builtin classmap: %s ", mod_name);
+ for (kp = __start___param; kp < __stop___param; kp++)
+ ddebug_match_apply_kparam(kp, cm, mod_name);
+ }
+}
+
+static void ddebug_apply_class_users(const struct _ddebug_info *di)
+{
+ struct ddebug_class_user *cli;
+ int i;
+
+ for_subvec(i, cli, di, users)
+ ddebug_apply_params(cli->map, cli->mod_name);
+
+ v2pr_di_info(di, "attached %d class-users to ", i);
+}
+
/*
* dd_set_module_subrange - find matching subrange of classmaps
* @_i: caller-provided index var
@@ -1210,6 +1374,7 @@ static int ddebug_add_module(struct _ddebug_info *di)
{
struct ddebug_table *dt;
struct ddebug_class_map *cm;
+ struct ddebug_class_user *cli;
int i;
if (!di->descs.len)
@@ -1222,6 +1387,7 @@ static int ddebug_add_module(struct _ddebug_info *di)
pr_err("error adding module: %s\n", di->mod_name);
return -ENOMEM;
}
+ INIT_LIST_HEAD(&dt->link);
/*
* For built-in modules, di is a partial cursor into the
* builtin dyndbg data; the descriptors are the subrange
@@ -1238,12 +1404,17 @@ static int ddebug_add_module(struct _ddebug_info *di)
*/
dt->info = *di;
dd_set_module_subrange(i, cm, &dt->info, maps);
+ dd_set_module_subrange(i, cli, &dt->info, users);
mutex_lock(&ddebug_lock);
list_add_tail(&dt->link, &ddebug_tables);
mutex_unlock(&ddebug_lock);
- vpr_info("%3u debug prints in module %s\n", di->descs.len, di->mod_name);
+ if (dt->info.users.len)
+ ddebug_apply_class_users(&dt->info);
+
+ vpr_info("%3u debug prints in module %s\n",
+ dt->info.descs.len, dt->info.mod_name);
return 0;
}
@@ -1393,8 +1564,10 @@ static int __init dynamic_debug_init(void)
struct _ddebug_info di = {
.descs.start = __start___dyndbg_descs,
.maps.start = __start___dyndbg_class_maps,
+ .users.start = __start___dyndbg_class_users,
.descs.len = __stop___dyndbg_descs - __start___dyndbg_descs,
.maps.len = __stop___dyndbg_class_maps - __start___dyndbg_class_maps,
+ .users.len = __stop___dyndbg_class_users - __start___dyndbg_class_users,
};
#ifdef CONFIG_MODULES
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 9e8e028461ad..34e51996aa20 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -6,11 +6,30 @@
* Jim Cromie <jim.cromie@gmail.com>
*/
-#define pr_fmt(fmt) "test_dd: " fmt
+/*
+ * This file is built 2x, also making test_dynamic_debug_submod.ko,
+ * whose 2-line src file #includes this file. This gives us a _submod
+ * clone with identical pr_debugs, without further maintenance.
+ *
+ * If things are working properly, they should operate identically
+ * when printed or adjusted by >control. This eases visual perusal of
+ * the logs, and simplifies testing, by easing the proper accounting
+ * of expectations.
+ *
+ * It also puts both halves of the subsystem _DEFINE & _USE use case
+ * together, and integrates the common ENUM providing both class_ids
+ * and class-names to both _DEFINErs and _USERs. I think this makes
+ * the usage clearer.
+ */
+#if defined(TEST_DYNAMIC_DEBUG_SUBMOD)
+ #define pr_fmt(fmt) "test_dd_submod: " fmt
+#else
+ #define pr_fmt(fmt) "test_dd: " fmt
+#endif
#include <linux/module.h>
-/* run tests by reading or writing sysfs node: do_prints */
+/* re-gen output by reading or writing sysfs node: do_prints */
static void do_prints(void); /* device under test */
static int param_set_do_prints(const char *instr, const struct kernel_param *kp)
@@ -39,14 +58,36 @@ module_param_cb(do_prints, ¶m_ops_do_prints, NULL, 0600);
* Additionally, here:
* - tie together sysname, mapname, bitsname, flagsname
*/
-#define DD_SYS_WRAP(_model, _flags) \
- static u32 bits_##_model; \
- static struct ddebug_class_param _flags##_model = { \
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM_(_model, _flags, _init) \
+ static u32 bits_##_model = _init; \
+ static struct ddebug_class_param _flags##_##_model = { \
.bits = &bits_##_model, \
.flags = #_flags, \
.map = &map_##_model, \
}; \
- module_param_cb(_flags##_##_model, ¶m_ops_dyndbg_classes, &_flags##_model, 0600)
+ module_param_cb(_flags##_##_model, ¶m_ops_dyndbg_classes, \
+ &_flags##_##_model, 0600)
+#ifdef DEBUG
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_model, _flags) \
+ DYNAMIC_DEBUG_CLASSMAP_PARAM_(_model, _flags, ~0)
+#else
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_model, _flags) \
+ DYNAMIC_DEBUG_CLASSMAP_PARAM_(_model, _flags, 0)
+#endif
+
+/*
+ * Demonstrate/test DISJOINT & LEVEL typed classmaps with a sys-param.
+ *
+ * To comport with DRM debug-category (an int), classmaps map names to
+ * ids (also an int). So a classmap starts with an enum; DRM has enum
+ * debug_category: with DRM_UT_<CORE,DRIVER,KMS,etc>. We use the enum
+ * values as class-ids, and stringified enum-symbols as classnames.
+ *
+ * Modules with multiple CLASSMAPS must have enums with distinct
+ * value-ranges, as arranged below with explicit enum_sym = X inits.
+ * To clarify this sharing, declare the 2 enums now, for the 2
+ * different classmap types
+ */
/* numeric input, independent bits */
enum cat_disjoint_bits {
@@ -60,26 +101,53 @@ enum cat_disjoint_bits {
D2_LEASE,
D2_DP,
D2_DRMRES };
-DECLARE_DYNDBG_CLASSMAP(map_disjoint_bits, DD_CLASS_TYPE_DISJOINT_BITS, 0,
- "D2_CORE",
- "D2_DRIVER",
- "D2_KMS",
- "D2_PRIME",
- "D2_ATOMIC",
- "D2_VBL",
- "D2_STATE",
- "D2_LEASE",
- "D2_DP",
- "D2_DRMRES");
-DD_SYS_WRAP(disjoint_bits, p);
-DD_SYS_WRAP(disjoint_bits, T);
-
-/* numeric verbosity, V2 > V1 related */
-enum cat_level_num { V0 = 14, V1, V2, V3, V4, V5, V6, V7 };
-DECLARE_DYNDBG_CLASSMAP(map_level_num, DD_CLASS_TYPE_LEVEL_NUM, 14,
- "V0", "V1", "V2", "V3", "V4", "V5", "V6", "V7");
-DD_SYS_WRAP(level_num, p);
-DD_SYS_WRAP(level_num, T);
+
+/* numeric verbosity, V2 > V1 related. V1 is > D2_DRMRES */
+enum cat_level_num { V1 = 16, V2, V3, V4, V5, V6, V7 };
+
+/* recapitulate DRM's multi-classmap setup */
+#if !defined(TEST_DYNAMIC_DEBUG_SUBMOD)
+/*
+ * In single user, or parent / coordinator (drm.ko) modules, define
+ * classmaps on the client enums above, and then declares the PARAMS
+ * ref'g the classmaps. Each is exported.
+ */
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_disjoint_bits, DD_CLASS_TYPE_DISJOINT_BITS,
+ D2_CORE,
+ "D2_CORE",
+ "D2_DRIVER",
+ "D2_KMS",
+ "D2_PRIME",
+ "D2_ATOMIC",
+ "D2_VBL",
+ "D2_STATE",
+ "D2_LEASE",
+ "D2_DP",
+ "D2_DRMRES");
+
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_level_num, DD_CLASS_TYPE_LEVEL_NUM,
+ V1, "V1", "V2", "V3", "V4", "V5", "V6", "V7");
+
+#else /* TEST_DYNAMIC_DEBUG_SUBMOD */
+
+/*
+ * in submod/drm-drivers, use the classmaps defined in top/parent
+ * module above.
+ */
+
+DYNAMIC_DEBUG_CLASSMAP_USE(map_disjoint_bits);
+DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 7);
+
+enum cat_level_offset { Vu1 = V1 + 7, Vu2, Vu3, Vu4, Vu5, Vu6, Vu7 };
+
+#endif
+
+/*
+ * now add the sysfs-params
+ */
+
+DYNAMIC_DEBUG_CLASSMAP_PARAM(disjoint_bits, p);
+DYNAMIC_DEBUG_CLASSMAP_PARAM(level_num, p);
/* stand-in for all pr_debug etc */
#define prdbg(SYM) __pr_debug_cls(SYM, #SYM " msg\n")
@@ -104,6 +172,7 @@ static void do_levels(void)
{
pr_debug("doing levels\n");
+#if !defined(TEST_DYNAMIC_DEBUG_SUBMOD)
prdbg(V1);
prdbg(V2);
prdbg(V3);
@@ -111,10 +180,20 @@ static void do_levels(void)
prdbg(V5);
prdbg(V6);
prdbg(V7);
+#else
+ prdbg(Vu1);
+ prdbg(Vu2);
+ prdbg(Vu3);
+ prdbg(Vu4);
+ prdbg(Vu5);
+ prdbg(Vu6);
+ prdbg(Vu7);
+#endif
}
static void do_prints(void)
{
+ pr_debug("do_prints:\n");
do_cats();
do_levels();
}
diff --git a/lib/test_dynamic_debug_submod.c b/lib/test_dynamic_debug_submod.c
new file mode 100644
index 000000000000..672aabf40160
--- /dev/null
+++ b/lib/test_dynamic_debug_submod.c
@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Kernel module for testing dynamic_debug
+ *
+ * Authors:
+ * Jim Cromie <jim.cromie@gmail.com>
+ */
+
+/*
+ * clone the parent, inherit all the properties, for consistency and
+ * simpler accounting in test expectations.
+ */
+#define TEST_DYNAMIC_DEBUG_SUBMOD
+#include "test_dynamic_debug.c"
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 25/39] selftests/dyndbg: enable FT_classmap_inheritance
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (23 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 24/39] dyndbg-API: replace DECLARE_DYNDBG_CLASSMAP Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 26/39] dyndbg: detect class_id reservation conflicts Jim Cromie via B4 Relay
` (13 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
re-enable FT_classmap_inheritance, and comment out writes to missing
test-mod params. tbd where they are.
fix-some-tests-sysl test-tweaks
selftests/dyndbg: sync all results checksums
happened on gandalf, at end of progress_from master+5 in this tree.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
lib/dynamic_debug.c | 7 +-
.../selftests/dynamic_debug/dyndbg_selftest.sh | 76 +++++++---------------
2 files changed, 30 insertions(+), 53 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 0e25b4d53942..e55747d26515 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -1109,6 +1109,8 @@ static bool ddebug_class_in_range(const int class_id, const struct ddebug_class_
static bool ddebug_user_class_in_range(const int class_id, const struct ddebug_class_user *cli)
{
+ if (!cli || !cli->map)
+ return false;
int base = cli->map->base + cli->offset;
return (class_id >= base && class_id < base + cli->map->length);
}
@@ -1270,14 +1272,12 @@ static void ddebug_sync_classbits(const struct kernel_param *kp, const char *mod
switch (dcp->map->map_type) {
case DD_CLASS_TYPE_DISJOINT_BITS:
val = READ_ONCE(*dcp->bits);
- ddebug_class_param_clamp_input(&val, kp);
new_bits = val;
v2pr_info(" %s: classbits: 0x%x\n", KP_NAME(kp), new_bits);
ddebug_apply_class_bitmap(dcp, &new_bits, 0UL, modname);
break;
case DD_CLASS_TYPE_LEVEL_NUM:
val = READ_ONCE(*dcp->lvl);
- ddebug_class_param_clamp_input(&val, kp);
new_bits = CLASSMAP_BITMASK(val);
v2pr_info(" %s: lvl:%d bits:0x%x\n", KP_NAME(kp), val, new_bits);
ddebug_apply_class_bitmap(dcp, &new_bits, 0UL, modname);
@@ -1309,6 +1309,9 @@ static void ddebug_match_apply_kparam(const struct kernel_param *kp,
static void ddebug_apply_params(const struct ddebug_class_map *cm, const char *mod_name)
{
const struct kernel_param *kp;
+
+ if (!cm)
+ return;
#if IS_ENABLED(CONFIG_MODULES)
int i;
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 5ef6e313fa4b..0c9af93aef7c 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -188,7 +188,7 @@ function slice_and_hash_ddctrl {
# ==============================================================================
function verify_modprobe_param_logging {
- # $1 - parameter name (e.g. do_classes)
+ # $1 - parameter name (e.g. do_prints)
# $2 - parameter value (e.g. 1)
local param="$1"
local val="$2"
@@ -245,7 +245,7 @@ function FT_grammar_ok {
# use 4 keywords (max 9 words inc flags)
ddcmd "module foo file bar.c func buz class D2_CORE +_" # 4 keywords
- #ddcmd "module foo file bar.c func buz class D2 line 100 +_" # 5 keywords
+ ddcmd "module foo file bar.c func buz class D2 line 100 +_" # 5 keywords
# 3. Dedicated lineno range grammar assertions (side-effect-free proofs)
ddcmd "line 42 +_" # test exact line syntax
@@ -484,9 +484,9 @@ function FT_test_classes {
verify_control_slice '\[test_dynamic_debug\]'
# 2. Verify state transition and live-printing end-to-end via ddcmd_load!
- ddcmd_load "class,D2_CORE,+pmf@class,D2_KMS,+pls@class,D2_ATOMIC,+pml" \
+ ddcmd_load "class,D2_CORE,+pmf;class,D2_KMS,+pls;class,D2_ATOMIC,+pml" \
'\[test_dynamic_debug\]' \
- "/sys/module/test_dynamic_debug/parameters/do_classes" "1"
+ "/sys/module/test_dynamic_debug/parameters/do_prints" "1"
ifrmmod test_dynamic_debug
}
@@ -502,27 +502,26 @@ function FT_classmap_inheritance {
"dyndbg=+p;class D2_CORE +pf;class D2_KMS +pt;class D2_ATOMIC +pm"
verify_control_slice '\[test_dynamic_debug\]'
+ set_param 5 /sys/module/test_dynamic_debug/parameters/p_level_num
+ verify_control_slice '\[test_dynamic_debug\]'
+
+ my_modprobe test_dynamic_debug_submod
+ verify_control_slice 'test_dynamic_debug_submod'
+
# fresh start, to clear all above flags (test-fn limits)
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
- # act on submod, which loads supermod
+ # load submod, which loads supermod
my_modprobe test_dynamic_debug_submod \
"dyndbg=+p;class D2_CORE +pfs;class D2_KMS +pts;class D2_ATOMIC +pmf"
+ verify_control_slice 'test_dynamic_debug'
+ # runtime changes to both
set_param 0x57 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
set_param 4 /sys/module/test_dynamic_debug/parameters/p_level_num
verify_control_slice 'test_dynamic_debug'
- set_param 3 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
- set_param 0 /sys/module/test_dynamic_debug/parameters/p_level_num
- verify_control_slice 'test_dynamic_debug'
-
- set_param 0x16 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
- set_param 0 /sys/module/test_dynamic_debug/parameters/p_level_num
- verify_control_slice 'test_dynamic_debug'
-
- # recap DRM_USE_DYNAMIC_DEBUG regression
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
@@ -553,47 +552,16 @@ function FT_classmap_inheritance {
else
v_echo "${GREEN}: Proven: parameter load-time (modprobe) " \
"and runtime (sysfs write) are equivalent!${NC}"
- fi
-
- # --- Live Content Fingerprinting Phase ---
+ fi # --- Live Content Fingerprinting Phase ---
log_start
- echo 1 > /sys/module/test_dynamic_debug/parameters/do_classes
- echo 1 > /sys/module/test_dynamic_debug_submod/parameters/do_classes
+ echo 1 > /sys/module/test_dynamic_debug/parameters/do_prints
+ echo 1 > /sys/module/test_dynamic_debug_submod/parameters/do_prints
log_stop
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
}
-function FT_modprobe_w_param {
- v_echo "${GREEN}# TEST_MODPROBES ${NC}"
- local verbose
-
- ifrmmod test_dynamic_debug_submod
- ifrmmod test_dynamic_debug
-
- for verbose in 1 2; do # 3 4 0; do
- echo $verbose > /sys/module/dynamic_debug/parameters/verbose
-
- # Verify each parameter load sequence with 100% DRY modularity
- verify_modprobe_param_logging "do_prints" "1"
-
- #verify_modprobe_param_logging "do_classes" "1"
- #verify_modprobe_param_logging "do_bulk" "1"
-
- # Sequence composite bitmasks to verify disjoint bit transitions
- for mask in "0x05" "0x12" "0x1f" "0x00"; do
- verify_modprobe_param_logging "p_disjoint_bits" "$mask"
- done
-
- # Sequence levels to verify both growing and shrinking verbose transitions
- for lvl in "3" "5" "4" "0"; do
- verify_modprobe_param_logging "p_level_num" "$lvl"
- done
- done
- ddcmd =_
-}
-
# Built-in Feature Tests (Can run on any CONFIG_DYNAMIC_DEBUG kernel, modular or monolithic)
builtin_tests=(
FT_grammar_ok
@@ -605,9 +573,7 @@ builtin_tests=(
# Modular Feature Tests (Require CONFIG_MODULES=y and test_dynamic_debug*.ko available)
modular_tests=(
- #FT_test_classes
- #FT_classmap_inheritance
- #FT_modprobe_w_param
+ FT_classmap_inheritance
)
# ==============================================================================
@@ -673,6 +639,14 @@ function GOLDEN_RECORDS {
#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_basic_queries.5
#K= 8c2dd1164fbcefb721345ce62a864a37 FT_basic_queries.6
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
+#K= fb294f02a4207b28b2a874524ef07afd FT_classmap_inheritance.1
+#K= 7a0b87016fdc237077dfe96bbbb3661b FT_classmap_inheritance.2
+#K= 2784d60f5056fc5cc03b3ceb854293f5 FT_classmap_inheritance.3
+#K= bf66aaf8ff612272c0cda29778ed2131 FT_classmap_inheritance.4
+#K= 49fdd29d91a4c1d16f8b59bb431e741b FT_classmap_inheritance.5
+#K= a8aa244285d048b5ebe33061fa99c424 FT_classmap_inheritance.6
+#K= 3060b86a0f553dd5a826bb7023284925 FT_classmap_inheritance.7
+#K= f43e0aff8a4b38435b73d90ed8100d1b FT_classmap_inheritance.8
EOF
# Read the K-recs and skip those for tests that can't run
while read -r line; do
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 26/39] dyndbg: detect class_id reservation conflicts
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (24 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 25/39] selftests/dyndbg: enable FT_classmap_inheritance Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 27/39] dyndbg: check DYNAMIC_DEBUG_CLASSMAP_{DEFINE,USE_} args at compile-time Jim Cromie via B4 Relay
` (12 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
If a module _DEFINEs 2 or more classmaps, it must devise them to share
the per-module 0..62 class-id space; ie their respective base,+length
reservations cannot overlap.
To detect conflicts at modprobe, add ddebug_class_range_overlap(),
call it from ddebug_add_module(), and WARN and return -EINVAL when
they're detected.
This insures that class_id -> classname lookup has just 1 answer, so
the 1st-found search in find-class-name works properly.
test_dynamic_debug.c:
If built with -DFORCE_CLASSID_CONFLICT, the test-modules invoke 2
conflicting DYNAMIC_DEBUG_CLASSMAP_DEFINE() declarations, into parent
and the _submod. These conflict with one of the good ones in the
parent (D2_CORE..etc), causing the modprobe(s) to WARN and fail.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v9:
. make ddebug_add_module() failure non-fatal during dynamic_debug_init(),
logging warning and continuing instead of tearing down all tables kernel-wide.
v2: RvB after SoB
old-v9 - fix WARN() by adding new 1st arg 1.
old-v12 - drop maybe_unused on range-overlap fn
---
lib/dynamic_debug.c | 60 +++++++++++++++++++++++++++---------------------
lib/test_dynamic_debug.c | 8 +++++++
2 files changed, 42 insertions(+), 26 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index e55747d26515..11aca5d0c89e 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -1101,18 +1101,19 @@ static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
return dp;
}
-static bool ddebug_class_in_range(const int class_id, const struct ddebug_class_map *map)
+static bool ddebug_class_map_in_range(const int class_id, const struct ddebug_class_map *map)
{
+ if (!map)
+ return false;
return (class_id >= map->base &&
class_id < map->base + map->length);
}
-static bool ddebug_user_class_in_range(const int class_id, const struct ddebug_class_user *cli)
+static bool ddebug_class_user_in_range(const int class_id, const struct ddebug_class_user *user)
{
- if (!cli || !cli->map)
+ if (!user)
return false;
- int base = cli->map->base + cli->offset;
- return (class_id >= base && class_id < base + cli->map->length);
+ return ddebug_class_map_in_range(class_id - user->offset, user->map);
}
static const char *ddebug_class_name(struct _ddebug_info *di, struct _ddebug *dp)
@@ -1122,11 +1123,11 @@ static const char *ddebug_class_name(struct _ddebug_info *di, struct _ddebug *dp
int i;
for_subvec(i, map, di, maps)
- if (ddebug_class_in_range(dp->class_id, map))
+ if (ddebug_class_map_in_range(dp->class_id, map))
return map->class_names[dp->class_id - map->base];
for_subvec(i, cli, di, users)
- if (ddebug_user_class_in_range(dp->class_id, cli))
+ if (ddebug_class_user_in_range(dp->class_id, cli))
return cli->map->class_names[dp->class_id - cli->map->base - cli->offset];
return NULL;
@@ -1369,6 +1370,20 @@ static void ddebug_apply_class_users(const struct _ddebug_info *di)
__di->_vec.start = __start; \
})
+static int ddebug_class_range_overlap(struct ddebug_class_map *cm, u64 *reserved_ids)
+{
+ u64 range = (((1ULL << cm->length) - 1) << cm->base);
+
+ if (range & *reserved_ids) {
+ pr_err("[%d..%d] on %s conflicts with %llx\n", cm->base,
+ cm->base + cm->length - 1, cm->class_names[0],
+ *reserved_ids);
+ return -EINVAL;
+ }
+ *reserved_ids |= range;
+ return 0;
+}
+
/*
* Allocate a new ddebug_table for the given module
* and add it to the global list.
@@ -1378,6 +1393,7 @@ static int ddebug_add_module(struct _ddebug_info *di)
struct ddebug_table *dt;
struct ddebug_class_map *cm;
struct ddebug_class_user *cli;
+ u64 reserved_ids = 0;
int i;
if (!di->descs.len)
@@ -1409,16 +1425,24 @@ static int ddebug_add_module(struct _ddebug_info *di)
dd_set_module_subrange(i, cm, &dt->info, maps);
dd_set_module_subrange(i, cli, &dt->info, users);
+ /* insure 2+ classmaps share the per-module 0..62 class_id space */
+ for_subvec(i, cm, &dt->info, maps)
+ if (ddebug_class_range_overlap(cm, &reserved_ids))
+ goto cleanup;
+
mutex_lock(&ddebug_lock);
list_add_tail(&dt->link, &ddebug_tables);
mutex_unlock(&ddebug_lock);
-
if (dt->info.users.len)
ddebug_apply_class_users(&dt->info);
vpr_info("%3u debug prints in module %s\n",
dt->info.descs.len, dt->info.mod_name);
return 0;
+cleanup:
+ WARN_ONCE(1, "dyndbg multi-classmap conflict in %s\n", di->mod_name);
+ kfree(dt);
+ return -EINVAL;
}
/* helper for ddebug_dyndbg_(boot|module)_param_cb */
@@ -1520,18 +1544,6 @@ static struct notifier_block ddebug_module_nb = {
#endif /* CONFIG_MODULES */
-static void ddebug_remove_all_tables(void)
-{
- mutex_lock(&ddebug_lock);
- while (!list_empty(&ddebug_tables)) {
- struct ddebug_table *dt = list_entry(ddebug_tables.next,
- struct ddebug_table,
- link);
- ddebug_table_free(dt);
- }
- mutex_unlock(&ddebug_lock);
-}
-
static __initdata int ddebug_init_success;
static int __init dynamic_debug_init_control(void)
@@ -1602,7 +1614,7 @@ static int __init dynamic_debug_init(void)
di.mod_name = modname;
ret = ddebug_add_module(&di);
if (ret)
- goto out_err;
+ pr_warn("failed to add built-in module %s: %d\n", modname, ret);
mod_ct++;
@@ -1617,7 +1629,7 @@ static int __init dynamic_debug_init(void)
di.mod_name = modname;
ret = ddebug_add_module(&di);
if (ret)
- goto out_err;
+ pr_warn("failed to add built-in module %s: %d\n", modname, ret);
mod_ct++;
@@ -1642,10 +1654,6 @@ static int __init dynamic_debug_init(void)
0, 0, 0, NULL, &ddebug_dyndbg_boot_param_cb);
kfree(cmdline);
return 0;
-
-out_err:
- ddebug_remove_all_tables();
- return 0;
}
/* Allow early initialization for boot messages via boot param */
early_initcall(dynamic_debug_init);
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 34e51996aa20..3a69cc3cae6d 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -128,6 +128,14 @@ DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_disjoint_bits, DD_CLASS_TYPE_DISJOINT_BITS,
DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_level_num, DD_CLASS_TYPE_LEVEL_NUM,
V1, "V1", "V2", "V3", "V4", "V5", "V6", "V7");
+#ifdef FORCE_CLASSID_CONFLICT
+/*
+ * Enable with -Dflag on compile to test overlapping class-id range
+ * detection. This should warn on modprobes.
+ */
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(classid_range_conflict, 0, D2_CORE + 1, "D3_CORE");
+#endif
+
#else /* TEST_DYNAMIC_DEBUG_SUBMOD */
/*
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 27/39] dyndbg: check DYNAMIC_DEBUG_CLASSMAP_{DEFINE,USE_} args at compile-time
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (25 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 26/39] dyndbg: detect class_id reservation conflicts Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 28/39] dyndbg-test: add do_bulk testpoint, rename do_prints to do_classes Jim Cromie via B4 Relay
` (11 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Add __DYNAMIC_DEBUG_CLASSMAP_CHECK to implement the following
arg-checks at compile-time:
0 <= _base < 63
class_names is not empty
class_names[0] is a string
class_names.length <= 32
(class_names.length + _base) < 63
dd-map-type is known value
These compile-time checks will prevent several simple misuses, issuing
obvious errors if violated.
Several bad examples are ifdef DDD_MACRO_ARGCHECK qualified in
test_dynamic_debug_submod.c and will fail compilation if enabled.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
include/linux/dynamic_debug.h | 16 +++++++++++++++-
lib/test_dynamic_debug.c | 20 +++++++++++++++++---
2 files changed, 32 insertions(+), 4 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 6517e0169a80..b53e7488b7f7 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -199,6 +199,19 @@ struct ddebug_class_param {
* __pr_debug_cls(22, "no such class"); compiles but is not reachable
*/
+#define __DYNAMIC_DEBUG_CLASSMAP_CHECK(_clnames, _base, _mapty) \
+ static_assert(((_base) >= 0 && (_base) < _DPRINTK_CLASS_DFLT), \
+ "_base must be in 0..62"); \
+ static_assert(__DDEBUG_ARRAY_SIZE(_clnames) > 0, \
+ "classnames array size must be > 0"); \
+ static_assert(__DDEBUG_ARRAY_SIZE(_clnames) <= 32, \
+ "classnames array size must be <= 32"); \
+ static_assert((__DDEBUG_ARRAY_SIZE(_clnames) + (_base)) <= _DPRINTK_CLASS_DFLT, \
+ "_base + classnames.length must be <= 63"); \
+ static_assert(((_mapty) >= DD_CLASS_TYPE_DISJOINT_BITS) && \
+ ((_mapty) <= DD_CLASS_TYPE_LEVEL_NUM), \
+ "unknown class_map_type")
+
/**
* DYNAMIC_DEBUG_CLASSMAP_DEFINE - define debug classes used by a module.
* @_var: name of the classmap, exported for other modules coordinated use.
@@ -212,6 +225,7 @@ struct ddebug_class_param {
*/
#define DYNAMIC_DEBUG_CLASSMAP_DEFINE(_var, _mapty, _base, ...) \
static const char *_var##_classnames[] = { __VA_ARGS__ }; \
+ __DYNAMIC_DEBUG_CLASSMAP_CHECK(_var##_classnames, (_base), (_mapty)); \
extern struct ddebug_class_map _var; \
struct ddebug_class_map __aligned(8) __used \
__section("__dyndbg_class_maps") _var = { \
@@ -219,7 +233,7 @@ struct ddebug_class_param {
.mod_name = DDEBUG_MODNAME, \
.base = (_base), \
.map_type = (_mapty), \
- .length = ARRAY_SIZE(_var##_classnames), \
+ .length = __DDEBUG_ARRAY_SIZE(_var##_classnames), \
.class_names = _var##_classnames, \
}; \
EXPORT_SYMBOL(_var)
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 3a69cc3cae6d..01ce07001d4c 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -148,12 +148,26 @@ DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 7);
enum cat_level_offset { Vu1 = V1 + 7, Vu2, Vu3, Vu4, Vu5, Vu6, Vu7 };
-#endif
-
+#if defined(DD_MACRO_ARGCHECK)
/*
- * now add the sysfs-params
+ * Exersize compile-time arg-checks in DYNAMIC_DEBUG_CLASSMAP_DEFINE.
+ * These will break compilation.
*/
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_base_neg, 0, -1, "NEGATIVE_BASE_ARG");
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_base_big, 0, 100, "TOOBIG_BASE_ARG");
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_str_type, 0, 0, 1 /* not a string */);
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_emptyclass, 0, 0 /* ,empty */);
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_maptype, 3, 10, "no such type");
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_base_len, 0, 60,
+ "base", "plus", "classes", "length", "too-big");
+DYNAMIC_DEBUG_CLASSMAP_USE_(fail_offset_big, 100);
+#endif /* DD_MACRO_ARGCHECK */
+
+#endif /* TEST_DYNAMIC_DEBUG_SUBMOD */
+/*
+ * now add the sysfs-params to both sub/super-mods
+ */
DYNAMIC_DEBUG_CLASSMAP_PARAM(disjoint_bits, p);
DYNAMIC_DEBUG_CLASSMAP_PARAM(level_num, p);
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 28/39] dyndbg-test: add do_bulk testpoint, rename do_prints to do_classes
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (26 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 27/39] dyndbg: check DYNAMIC_DEBUG_CLASSMAP_{DEFINE,USE_} args at compile-time Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 29/39] dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API Jim Cromie via B4 Relay
` (10 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
test_dynamic_debug.ko currently has the do_prints sysnode to support
testing of the classmaps feature, it calls ~16 class'd pr_debug()s,
*once* for each class defined in the module.
Improve the versatility of this support by:
1. changing do_prints() to do_classes()
to better align with its actual purpose
2. new parameters/do_bulk & do_bulk(N):
loops over 10 pr_debugs, N times
creates idempotent non-repetetive (ie 1..N lines) output
meant for creating high-volume workloads
3. using common param-ops for both (no reason not to)
ie: do_classes(N) now accepts work-count.
So now we can generate significant workloads with a single write.
modprobe test_dynamic_debug dyndbg=+p
echo 100 > /sys/module/test_dynamic_debug/parameters/do_classes
echo 2000 > /sys/module/test_dynamic_debug/parameters/do_bulk
TODO: enable do_bulk() callsites by default, since the modprobe is an
explicit act, the user intends to use it, lets turn it on.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v9:
. use unsigned int for loop index in do_bulk() to prevent wrapping lockups on UINT_MAX.
. add cond_resched() to do_classes() and do_bulk() loops.
v8: fix a test which had commas, from the future, adjust KRECs
---
lib/test_dynamic_debug.c | 107 ++++++++++++-----
.../selftests/dynamic_debug/dyndbg_selftest.sh | 126 ++++++++++++++-------
2 files changed, 166 insertions(+), 67 deletions(-)
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 01ce07001d4c..b7f9ed9b2794 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -28,25 +28,45 @@
#endif
#include <linux/module.h>
+#include <linux/sched.h>
-/* re-gen output by reading or writing sysfs node: do_prints */
+/* re-trigger debug output by reading or writing sysfs nodes: do_classes or do_bulk */
+static void do_classes(unsigned int); /* device under test */
+static void do_bulk(unsigned int); /* device under test */
-static void do_prints(void); /* device under test */
-static int param_set_do_prints(const char *instr, const struct kernel_param *kp)
+static int param_set_do_repeats(const char *instr, const struct kernel_param *kp)
{
- do_prints();
+ int rc;
+ unsigned int ct;
+ void (*repeat_fn)(unsigned int) = kp->arg;
+
+ rc = kstrtouint(instr, 0, &ct);
+ if (rc) {
+ pr_err("expecting numeric input, using 1 instead\n");
+ ct = 1;
+ }
+
+ repeat_fn(ct);
+
return 0;
}
-static int param_get_do_prints(char *buffer, const struct kernel_param *kp)
+
+static int param_get_do_repeats(char *buffer, const struct kernel_param *kp)
{
- do_prints();
- return scnprintf(buffer, PAGE_SIZE, "did do_prints\n");
+ void (*repeat_fn)(unsigned int) = kp->arg;
+
+ repeat_fn(1);
+
+ return scnprintf(buffer, PAGE_SIZE, "did 1 %s\n", kp->name);
}
-static const struct kernel_param_ops param_ops_do_prints = {
- .set = param_set_do_prints,
- .get = param_get_do_prints,
+
+static const struct kernel_param_ops param_ops_do_repeats = {
+ .set = param_set_do_repeats,
+ .get = param_get_do_repeats,
};
-module_param_cb(do_prints, ¶m_ops_do_prints, NULL, 0600);
+
+module_param_cb(do_classes, ¶m_ops_do_repeats, do_classes, 0600);
+module_param_cb(do_bulk, ¶m_ops_do_repeats, do_bulk, 0600);
/*
* Using the CLASSMAP api:
@@ -103,7 +123,10 @@ enum cat_disjoint_bits {
D2_DRMRES };
/* numeric verbosity, V2 > V1 related. V1 is > D2_DRMRES */
-enum cat_level_num { V1 = 16, V2, V3, V4, V5, V6, V7 };
+enum cat_level_num { V1 = 16, V2, V3, V4, V5, V6, V7, V8 };
+
+/* test _USE_ w offset */
+enum cat_level_offset { Vu1 = V1 + 8, Vu2, Vu3, Vu4, Vu5, Vu6, Vu7, Vu8 };
/* recapitulate DRM's multi-classmap setup */
#if !defined(TEST_DYNAMIC_DEBUG_SUBMOD)
@@ -136,18 +159,6 @@ DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_level_num, DD_CLASS_TYPE_LEVEL_NUM,
DYNAMIC_DEBUG_CLASSMAP_DEFINE(classid_range_conflict, 0, D2_CORE + 1, "D3_CORE");
#endif
-#else /* TEST_DYNAMIC_DEBUG_SUBMOD */
-
-/*
- * in submod/drm-drivers, use the classmaps defined in top/parent
- * module above.
- */
-
-DYNAMIC_DEBUG_CLASSMAP_USE(map_disjoint_bits);
-DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 7);
-
-enum cat_level_offset { Vu1 = V1 + 7, Vu2, Vu3, Vu4, Vu5, Vu6, Vu7 };
-
#if defined(DD_MACRO_ARGCHECK)
/*
* Exersize compile-time arg-checks in DYNAMIC_DEBUG_CLASSMAP_DEFINE.
@@ -160,6 +171,19 @@ DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_emptyclass, 0, 0 /* ,empty */);
DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_maptype, 3, 10, "no such type");
DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_base_len, 0, 60,
"base", "plus", "classes", "length", "too-big");
+#endif
+
+#else /* TEST_DYNAMIC_DEBUG_SUBMOD */
+
+/*
+ * in submod/drm-drivers, use the classmaps defined in top/parent
+ * module above.
+ */
+
+DYNAMIC_DEBUG_CLASSMAP_USE(map_disjoint_bits);
+DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 7);
+
+#if defined(DD_MACRO_ARGCHECK)
DYNAMIC_DEBUG_CLASSMAP_USE_(fail_offset_big, 100);
#endif /* DD_MACRO_ARGCHECK */
@@ -213,17 +237,42 @@ static void do_levels(void)
#endif
}
-static void do_prints(void)
+static void do_classes(unsigned int ct)
{
- pr_debug("do_prints:\n");
- do_cats();
- do_levels();
+ /* maybe clamp this */
+ pr_debug("do_classes %u times:\n", ct);
+ for (; ct; ct--) {
+ do_cats();
+ do_levels();
+ cond_resched();
+ }
+}
+
+static void do_bulk(unsigned int ct)
+{
+ unsigned int i;
+
+ pr_debug("do_bulk %u times:\n", ct);
+ for (i = 1; i <= ct; i++) {
+ pr_debug("bulk msg %u.0\n", i);
+ pr_debug("bulk msg %u.1\n", i);
+ pr_debug("bulk msg %u.2\n", i);
+ pr_debug("bulk msg %u.3\n", i);
+ pr_debug("bulk msg %u.4\n", i);
+ pr_debug("bulk msg %u.5\n", i);
+ pr_debug("bulk msg %u.6\n", i);
+ pr_debug("bulk msg %u.7\n", i);
+ pr_debug("bulk msg %u.8\n", i);
+ pr_debug("bulk msg %u.9\n", i);
+ cond_resched();
+ }
}
static int __init test_dynamic_debug_init(void)
{
pr_debug("init start\n");
- do_prints();
+ do_classes(1);
+ do_bulk(1);
pr_debug("init done\n");
return 0;
}
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 0c9af93aef7c..10dc3f2b3fa8 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -207,7 +207,7 @@ function verify_modprobe_param_logging {
# capture bookends to verify their actual pr_debug logging!
if [ "$param" = "p_disjoint_bits" ] || [ "$param" = "p_level_num" ]; then
- set_param 1 /sys/module/test_dynamic_debug/parameters/do_prints
+ set_param 1 /sys/module/test_dynamic_debug/parameters/do_classes
fi
log_stop
@@ -480,44 +480,29 @@ function FT_test_classes {
# 1. Verify initial multi-query enablement state via file slice
my_modprobe test_dynamic_debug \
- dyndbg="class,D2_CORE,+pf;class,D2_KMS,+ps;class,D2_ATOMIC,+pm"
+ dyndbg="class D2_CORE,+pf;class D2_KMS,+ps;class D2_ATOMIC +pm"
verify_control_slice '\[test_dynamic_debug\]'
# 2. Verify state transition and live-printing end-to-end via ddcmd_load!
- ddcmd_load "class,D2_CORE,+pmf;class,D2_KMS,+pls;class,D2_ATOMIC,+pml" \
+ ddcmd_load "class D2_CORE +pmf;class D2_KMS +pls;class D2_ATOMIC +pml" \
'\[test_dynamic_debug\]' \
- "/sys/module/test_dynamic_debug/parameters/do_prints" "1"
+ "/sys/module/test_dynamic_debug/parameters/do_classes" "1"
ifrmmod test_dynamic_debug
}
function FT_classmap_inheritance {
- v_echo "${GREEN}# TEST_MOD_SUBMOD ${NC}"
+ v_echo "${GREEN}# TEST_MOD_SUBMOD - Classmap state inheritance between supermod and submod ${NC}"
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
- # modprobe with plain-old +p & 3 class enablements
- my_modprobe test_dynamic_debug \
- "dyndbg=+p;class D2_CORE +pf;class D2_KMS +pt;class D2_ATOMIC +pm"
- verify_control_slice '\[test_dynamic_debug\]'
-
- set_param 5 /sys/module/test_dynamic_debug/parameters/p_level_num
- verify_control_slice '\[test_dynamic_debug\]'
-
- my_modprobe test_dynamic_debug_submod
- verify_control_slice 'test_dynamic_debug_submod'
-
- # fresh start, to clear all above flags (test-fn limits)
- ifrmmod test_dynamic_debug_submod
- ifrmmod test_dynamic_debug
-
- # load submod, which loads supermod
+ # 1. Load submod directly (which auto-loads supermod with default parameters)
my_modprobe test_dynamic_debug_submod \
"dyndbg=+p;class D2_CORE +pfs;class D2_KMS +pts;class D2_ATOMIC +pmf"
verify_control_slice 'test_dynamic_debug'
- # runtime changes to both
+ # 2. Runtime parameter changes to supermod propagate to submod descriptors
set_param 0x57 /sys/module/test_dynamic_debug/parameters/p_disjoint_bits
set_param 4 /sys/module/test_dynamic_debug/parameters/p_level_num
verify_control_slice 'test_dynamic_debug'
@@ -525,19 +510,17 @@ function FT_classmap_inheritance {
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
- # set super-mod params at load-time
+ # 3. Pre-initialize supermod parameter state at load-time
my_modprobe test_dynamic_debug p_disjoint_bits=0x16 p_level_num=5
verify_control_slice '\[test_dynamic_debug\]'
- # see them picked up by submod
+ # 4. Verify submod inherits pre-initialized supermod classmap parameter state upon load
my_modprobe test_dynamic_debug_submod
verify_control_slice 'test_dynamic_debug'
- # Real-time mathematical proof that load-time (modprobe) parameter parsing
- # and runtime (sysfs write) parameter configurations are perfectly equivalent!
+ # 5. Prove load-time (modprobe) and runtime (sysfs write) parameter equivalence
local hash_modprobe=$(slice_and_hash_ddctrl '\[test_dynamic_debug\]')
- # Fresh load with default parameters, then configure them dynamically at runtime
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
my_modprobe test_dynamic_debug
@@ -552,16 +535,45 @@ function FT_classmap_inheritance {
else
v_echo "${GREEN}: Proven: parameter load-time (modprobe) " \
"and runtime (sysfs write) are equivalent!${NC}"
- fi # --- Live Content Fingerprinting Phase ---
+ fi
+
+ # 6. End-to-end syslog content logging verification
log_start
- echo 1 > /sys/module/test_dynamic_debug/parameters/do_prints
- echo 1 > /sys/module/test_dynamic_debug_submod/parameters/do_prints
+ echo 1 > /sys/module/test_dynamic_debug/parameters/do_classes
+ echo 1 > /sys/module/test_dynamic_debug_submod/parameters/do_classes
log_stop
ifrmmod test_dynamic_debug_submod
ifrmmod test_dynamic_debug
}
+function FT_modprobe_w_param {
+ v_echo "${GREEN}# TEST_MODPROBES ${NC}"
+ local verbose
+
+ ifrmmod test_dynamic_debug_submod
+ ifrmmod test_dynamic_debug
+
+ for verbose in 1 2; do # 3 4 0; do
+ echo $verbose > /sys/module/dynamic_debug/parameters/verbose
+
+ # Verify each parameter load sequence with 100% DRY modularity
+ verify_modprobe_param_logging "do_classes" "1"
+ verify_modprobe_param_logging "do_bulk" "1"
+
+ # Sequence composite bitmasks to verify disjoint bit transitions
+ for mask in "0x05" "0x12" "0x1f" "0x00"; do
+ verify_modprobe_param_logging "p_disjoint_bits" "$mask"
+ done
+
+ # Sequence levels to verify both growing and shrinking verbose transitions
+ for lvl in "3" "5" "4" "0"; do
+ verify_modprobe_param_logging "p_level_num" "$lvl"
+ done
+ done
+ ddcmd =_
+}
+
# Built-in Feature Tests (Can run on any CONFIG_DYNAMIC_DEBUG kernel, modular or monolithic)
builtin_tests=(
FT_grammar_ok
@@ -573,7 +585,9 @@ builtin_tests=(
# Modular Feature Tests (Require CONFIG_MODULES=y and test_dynamic_debug*.ko available)
modular_tests=(
+ FT_test_classes
FT_classmap_inheritance
+ FT_modprobe_w_param
)
# ==============================================================================
@@ -639,14 +653,50 @@ function GOLDEN_RECORDS {
#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_basic_queries.5
#K= 8c2dd1164fbcefb721345ce62a864a37 FT_basic_queries.6
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
-#K= fb294f02a4207b28b2a874524ef07afd FT_classmap_inheritance.1
-#K= 7a0b87016fdc237077dfe96bbbb3661b FT_classmap_inheritance.2
-#K= 2784d60f5056fc5cc03b3ceb854293f5 FT_classmap_inheritance.3
-#K= bf66aaf8ff612272c0cda29778ed2131 FT_classmap_inheritance.4
-#K= 49fdd29d91a4c1d16f8b59bb431e741b FT_classmap_inheritance.5
-#K= a8aa244285d048b5ebe33061fa99c424 FT_classmap_inheritance.6
-#K= 3060b86a0f553dd5a826bb7023284925 FT_classmap_inheritance.7
-#K= f43e0aff8a4b38435b73d90ed8100d1b FT_classmap_inheritance.8
+#K= 3bcbdc30323082d6e961b5f0e269fff7 FT_test_classes.1
+#K= 5516e3d13cba7ea4197a7fb6c033887a FT_test_classes.2
+#K= 22213a7bf431c3e0efd3edbfcba69677 FT_test_classes.3
+#K= 3a6afd41fadaaf70fad18f8a4632ffec FT_classmap_inheritance.1
+#K= 6f1e347f0a7930814d2e54d589439465 FT_classmap_inheritance.2
+#K= a6e6aab5a6cb9a792d4296b1200ba409 FT_classmap_inheritance.3
+#K= 315cc5dad3a775c54a0b60a0276300b7 FT_classmap_inheritance.4
+#K= 7e92245008439ee79fe2460aeaa16a9b FT_classmap_inheritance.5
+#K= 94610c57ac44bd7011002a654fd78f93 FT_modprobe_w_param.1
+#K= 94610c57ac44bd7011002a654fd78f93 FT_modprobe_w_param.2
+#K= c1309e18dc9bf2f57184fa13164d917d FT_modprobe_w_param.3
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.4
+#K= a1232e658d95fbca8b23a69e9a0db965 FT_modprobe_w_param.5
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.6
+#K= af7b3d532325b1c5ab990e4b32fed577 FT_modprobe_w_param.7
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.8
+#K= 591411c42cf52d7c4c46d76bcc345a5f FT_modprobe_w_param.9
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.10
+#K= b0435304108118e64529469e59332111 FT_modprobe_w_param.11
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.12
+#K= 4d036833ce9f661057a4e13d97295c65 FT_modprobe_w_param.13
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.14
+#K= 5c3c6ecf6a46f9ccebd60c5ca9ebdbb7 FT_modprobe_w_param.15
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.16
+#K= 73a93377a823739e8aae44856a20fa7f FT_modprobe_w_param.17
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.18
+#K= 10464b2c3e3972f05e93c609700f8fb2 FT_modprobe_w_param.19
+#K= 10464b2c3e3972f05e93c609700f8fb2 FT_modprobe_w_param.20
+#K= 07c1f81d5a58675a291dc77acd6938c4 FT_modprobe_w_param.21
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.22
+#K= b070066b0eb13a033446bd05850b15e2 FT_modprobe_w_param.23
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.24
+#K= 32ca47823c27e629e03c21aebfc25095 FT_modprobe_w_param.25
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.26
+#K= 7b91db8e9f160aebb1ee87fab2232404 FT_modprobe_w_param.27
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.28
+#K= e393499e02677de414e478f4e710eeb9 FT_modprobe_w_param.29
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.30
+#K= 375e38613af3b49bb7c7689dfecf4177 FT_modprobe_w_param.31
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.32
+#K= 745a61d20e26a6a22db0b99420fea80a FT_modprobe_w_param.33
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.34
+#K= 3d2538bf868e71bff17c768cf118c352 FT_modprobe_w_param.35
+#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.36
EOF
# Read the K-recs and skip those for tests that can't run
while read -r line; do
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 29/39] dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (27 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 28/39] dyndbg-test: add do_bulk testpoint, rename do_prints to do_classes Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 30/39] dyndbg: control-parser: treat comma as a token separator Jim Cromie via B4 Relay
` (9 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
move the DYNAMIC_DEBUG_CLASSMAP_PARAM macro from test-dynamic-debug.c into
the header, and refine it, by distinguishing the 2 use cases:
1.DYNAMIC_DEBUG_CLASSMAP_PARAM_REF
for DRM, to pass in extern __drm_debug by name.
dyndbg keeps bits in it, so drm can still use it as before
2.DYNAMIC_DEBUG_CLASSMAP_PARAM
new user (test_dynamic_debug) doesn't need to share state,
declares a u32 to store the bitvec.
__DYNAMIC_DEBUG_CLASSMAP_PARAM
bottom layer - allocate,init a ddebug-class-param, module-param-cb.
Modify ddebug_sync_classbits() argtype deref inside the fn, to give
access to all kp members.
Also add stub macros, clean up and improve comments in test-code, and
add MODULE_DESCRIPTIONs.
cc: linux-doc@vger.kernel.org
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v9:
. fix 4-argument signature for DYNAMIC_DEBUG_CLASSMAP_PARAM_REF fallback macro stub.
. update format specifier from %d to %u for inrep in ddebug_class_param_clamp_input().
. drop duplicate v2pr_info() line in param_set_dyndbg_module_classes().
. drop unused CLASSMAP_BITMASK(width, base) define in test_dynamic_debug.c.
---
include/linux/dynamic_debug.h | 40 ++++++++++++
lib/dynamic_debug.c | 75 +++++++++++-----------
lib/test_dynamic_debug.c | 55 ++++++----------
lib/test_dynamic_debug_submod.c | 9 ++-
.../selftests/dynamic_debug/dyndbg_selftest.sh | 2 +-
5 files changed, 106 insertions(+), 75 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index b53e7488b7f7..cc203b6c1b56 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -293,6 +293,44 @@ struct ddebug_class_param {
.offset = _offset \
}
+/**
+ * DYNAMIC_DEBUG_CLASSMAP_PARAM - control a ddebug-classmap from a sys-param
+ * @_name: sysfs node name
+ * @_var: name of the classmap var defining the controlled classes/bits
+ * @_flags: flags to be toggled, typically just 'p'
+ *
+ * Creates a sysfs-param to control the classes defined by the
+ * exported classmap, with bits 0..N-1 mapped to the classes named.
+ * This version keeps class-state in a private long int.
+ */
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _var, _flags) \
+ static u32 _name##_bvec; \
+ __DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _name##_bvec, _var, _flags)
+
+/**
+ * DYNAMIC_DEBUG_CLASSMAP_PARAM_REF - wrap a classmap with a controlling sys-param
+ * @_name: sysfs node name
+ * @_bits: name of the module's u32 bit-vector, ex: __drm_debug
+ * @_var: name of the (exported) classmap var defining the classes/bits
+ * @_flags: flags to be toggled, typically just 'p'
+ *
+ * Creates a sysfs-param to control the classes defined by the
+ * exported clasmap, with bits 0..N-1 mapped to the classes named.
+ * This version keeps class-state in user @_bits. This lets drm check
+ * __drm_debug elsewhere too.
+ */
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM_REF(_name, _bits, _var, _flags) \
+ __DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _bits, _var, _flags)
+
+#define __DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _bits, _var, _flags) \
+ static struct ddebug_class_param _name##_##_flags = { \
+ .bits = &(_bits), \
+ .flags = #_flags, \
+ .map = &(_var), \
+ }; \
+ module_param_cb(_name, ¶m_ops_dyndbg_classes, \
+ &_name##_##_flags, 0600)
+
extern __printf(2, 3)
void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
@@ -476,6 +514,8 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#define DYNAMIC_DEBUG_CLASSMAP_DEFINE(_var, _mapty, _base, ...)
#define DYNAMIC_DEBUG_CLASSMAP_USE(_var)
#define DYNAMIC_DEBUG_CLASSMAP_USE_(_var, _offset)
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _var, _flags)
+#define DYNAMIC_DEBUG_CLASSMAP_PARAM_REF(_name, _bits, _var, _flags)
#define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt)
#define DYNAMIC_DEBUG_BRANCH(descriptor) false
#define DECLARE_DYNDBG_CLASSMAP(...)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 11aca5d0c89e..15aba978d3c4 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -697,9 +697,42 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
#define CLASSMAP_BITMASK(width) ((width) >= 32 ? ~0U : (1U << (width)) - 1)
-/*
- * param-setter helper to validate numeric input, clamp its value by
- * the classmap type and size, and apply the bits.
+static void __maybe_unused ddebug_class_param_clamp_input(u32 *inrep, const struct kernel_param *kp)
+{
+ const struct ddebug_class_param *dcp = kp->arg;
+ const struct ddebug_class_map *map = dcp->map;
+
+ switch (map->map_type) {
+ case DD_CLASS_TYPE_DISJOINT_BITS:
+ /* expect bits. mask and warn if too many */
+ if (*inrep & ~CLASSMAP_BITMASK(map->length)) {
+ pr_warn("%s: input: 0x%x exceeds mask: 0x%x, masking\n",
+ KP_NAME(kp), *inrep, CLASSMAP_BITMASK(map->length));
+ *inrep &= CLASSMAP_BITMASK(map->length);
+ }
+ break;
+ case DD_CLASS_TYPE_LEVEL_NUM:
+ /* input is bitpos, of highest verbosity to be enabled */
+ if (*inrep > map->length) {
+ pr_warn("%s: level:%u exceeds max:%d, clamping\n",
+ KP_NAME(kp), *inrep, map->length);
+ *inrep = map->length;
+ }
+ break;
+ }
+}
+
+/**
+ * param_set_dyndbg_classes - class FOO >control
+ * @instr: string echo>d to sysfs, input depends on map_type
+ * @kp: kp->arg has state: bits/lvl, map, map_type
+ * @mod_name: module name or null for all modules with the classes
+ *
+ * Enable/disable prdbgs by their class, as given in the arguments to
+ * DECLARE_DYNDBG_CLASSMAP. For LEVEL map-types, enforce relative
+ * levels by bitpos.
+ *
+ * Returns: 0 or <0 if error.
*/
static int param_set_dyndbg_module_classes(const char *instr,
const struct kernel_param *kp,
@@ -718,27 +751,16 @@ static int param_set_dyndbg_module_classes(const char *instr,
len, instr, KP_NAME(kp));
return -EINVAL;
}
+ ddebug_class_param_clamp_input(&inrep, kp);
switch (map->map_type) {
case DD_CLASS_TYPE_DISJOINT_BITS:
- /* expect bits. mask and warn if too many */
- if (inrep & ~CLASSMAP_BITMASK(map->length)) {
- pr_warn("%s: input: 0x%x exceeds mask: 0x%x, masking\n",
- KP_NAME(kp), inrep, CLASSMAP_BITMASK(map->length));
- inrep &= CLASSMAP_BITMASK(map->length);
- }
old_val = READ_ONCE(*dcp->bits);
v2pr_info("bits:0x%x > %s.%s\n", inrep, mod_name ?: "*", KP_NAME(kp));
totct += ddebug_apply_class_bitmap(dcp, &inrep, old_val, mod_name);
WRITE_ONCE(*dcp->bits, inrep);
break;
case DD_CLASS_TYPE_LEVEL_NUM:
- /* input is bitpos, of highest verbosity to be enabled */
- if (inrep > map->length) {
- pr_warn("%s: level:%u exceeds max:%d, clamping\n",
- KP_NAME(kp), inrep, map->length);
- inrep = map->length;
- }
old_val = READ_ONCE(*dcp->lvl);
old_bits = CLASSMAP_BITMASK(old_val);
new_bits = CLASSMAP_BITMASK(inrep);
@@ -1236,30 +1258,7 @@ static inline u32 ddebug_class_param_to_bits(const struct ddebug_class_param *dc
}
}
-static void __maybe_unused ddebug_class_param_clamp_input(u32 *inrep, const struct kernel_param *kp)
-{
- const struct ddebug_class_param *dcp = kp->arg;
- const struct ddebug_class_map *map = dcp->map;
- switch (map->map_type) {
- case DD_CLASS_TYPE_DISJOINT_BITS:
- /* expect bits. mask and warn if too many */
- if (*inrep & ~CLASSMAP_BITMASK(map->length)) {
- pr_warn("%s: input: 0x%x exceeds mask: 0x%x, masking\n",
- KP_NAME(kp), *inrep, CLASSMAP_BITMASK(map->length));
- *inrep &= CLASSMAP_BITMASK(map->length);
- }
- break;
- case DD_CLASS_TYPE_LEVEL_NUM:
- /* input is bitpos, of highest verbosity to be enabled */
- if (*inrep > map->length) {
- pr_warn("%s: level:%d exceeds max:%d, clamping\n",
- KP_NAME(kp), *inrep, map->length);
- *inrep = map->length;
- }
- break;
- }
-}
/* called for class-users only, parse_one does this for definer modules */
static void ddebug_sync_classbits(const struct kernel_param *kp, const char *modname)
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index b7f9ed9b2794..368891075175 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: GPL-2.0-only
/*
- * Kernel module for testing dynamic_debug
+ * Kernel module to test/demonstrate dynamic_debug features,
+ * particularly classmaps and their support for subsystems like DRM.
*
* Authors:
* Jim Cromie <jim.cromie@gmail.com>
@@ -68,33 +69,6 @@ static const struct kernel_param_ops param_ops_do_repeats = {
module_param_cb(do_classes, ¶m_ops_do_repeats, do_classes, 0600);
module_param_cb(do_bulk, ¶m_ops_do_repeats, do_bulk, 0600);
-/*
- * Using the CLASSMAP api:
- * - classmaps must have corresponding enum
- * - enum symbols must match/correlate with class-name strings in the map.
- * - base must equal enum's 1st value
- * - multiple maps must set their base to share the 0-30 class_id space !!
- * (build-bug-on tips welcome)
- * Additionally, here:
- * - tie together sysname, mapname, bitsname, flagsname
- */
-#define DYNAMIC_DEBUG_CLASSMAP_PARAM_(_model, _flags, _init) \
- static u32 bits_##_model = _init; \
- static struct ddebug_class_param _flags##_##_model = { \
- .bits = &bits_##_model, \
- .flags = #_flags, \
- .map = &map_##_model, \
- }; \
- module_param_cb(_flags##_##_model, ¶m_ops_dyndbg_classes, \
- &_flags##_##_model, 0600)
-#ifdef DEBUG
-#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_model, _flags) \
- DYNAMIC_DEBUG_CLASSMAP_PARAM_(_model, _flags, ~0)
-#else
-#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_model, _flags) \
- DYNAMIC_DEBUG_CLASSMAP_PARAM_(_model, _flags, 0)
-#endif
-
/*
* Demonstrate/test DISJOINT & LEVEL typed classmaps with a sys-param.
*
@@ -128,12 +102,15 @@ enum cat_level_num { V1 = 16, V2, V3, V4, V5, V6, V7, V8 };
/* test _USE_ w offset */
enum cat_level_offset { Vu1 = V1 + 8, Vu2, Vu3, Vu4, Vu5, Vu6, Vu7, Vu8 };
-/* recapitulate DRM's multi-classmap setup */
+/*
+ * use/demonstrate multi-module-group classmaps, as for DRM
+ */
#if !defined(TEST_DYNAMIC_DEBUG_SUBMOD)
/*
- * In single user, or parent / coordinator (drm.ko) modules, define
- * classmaps on the client enums above, and then declares the PARAMS
- * ref'g the classmaps. Each is exported.
+ * For module-groups of 1+, define classmaps with names (stringified
+ * enum-symbols) copied from above. 1-to-1 mapping is recommended.
+ * The classmap is exported, so that other modules in the group can
+ * link to it and control their prdbgs.
*/
DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_disjoint_bits, DD_CLASS_TYPE_DISJOINT_BITS,
D2_CORE,
@@ -151,6 +128,15 @@ DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_disjoint_bits, DD_CLASS_TYPE_DISJOINT_BITS,
DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_level_num, DD_CLASS_TYPE_LEVEL_NUM,
V1, "V1", "V2", "V3", "V4", "V5", "V6", "V7");
+/*
+ * for use-cases that want it, provide a sysfs-param to set the
+ * classes in the classmap. It is at this interface where the
+ * "v3>v2" property is applied to DD_CLASS_TYPE_LEVEL_NUM inputs.
+ */
+
+DYNAMIC_DEBUG_CLASSMAP_PARAM(p_disjoint_bits, map_disjoint_bits, p);
+DYNAMIC_DEBUG_CLASSMAP_PARAM(p_level_num, map_level_num, p);
+
#ifdef FORCE_CLASSID_CONFLICT
/*
* Enable with -Dflag on compile to test overlapping class-id range
@@ -159,6 +145,7 @@ DYNAMIC_DEBUG_CLASSMAP_DEFINE(map_level_num, DD_CLASS_TYPE_LEVEL_NUM,
DYNAMIC_DEBUG_CLASSMAP_DEFINE(classid_range_conflict, 0, D2_CORE + 1, "D3_CORE");
#endif
+
#if defined(DD_MACRO_ARGCHECK)
/*
* Exersize compile-time arg-checks in DYNAMIC_DEBUG_CLASSMAP_DEFINE.
@@ -192,8 +179,6 @@ DYNAMIC_DEBUG_CLASSMAP_USE_(fail_offset_big, 100);
/*
* now add the sysfs-params to both sub/super-mods
*/
-DYNAMIC_DEBUG_CLASSMAP_PARAM(disjoint_bits, p);
-DYNAMIC_DEBUG_CLASSMAP_PARAM(level_num, p);
/* stand-in for all pr_debug etc */
#define prdbg(SYM) __pr_debug_cls(SYM, #SYM " msg\n")
@@ -286,5 +271,5 @@ module_init(test_dynamic_debug_init);
module_exit(test_dynamic_debug_exit);
MODULE_AUTHOR("Jim Cromie <jim.cromie@gmail.com>");
-MODULE_DESCRIPTION("Kernel module for testing dynamic_debug");
+MODULE_DESCRIPTION("test/demonstrate dynamic-debug features");
MODULE_LICENSE("GPL");
diff --git a/lib/test_dynamic_debug_submod.c b/lib/test_dynamic_debug_submod.c
index 672aabf40160..3adf3925fb86 100644
--- a/lib/test_dynamic_debug_submod.c
+++ b/lib/test_dynamic_debug_submod.c
@@ -1,6 +1,9 @@
// SPDX-License-Identifier: GPL-2.0
/*
- * Kernel module for testing dynamic_debug
+ * Kernel module to test/demonstrate dynamic_debug features,
+ * particularly classmaps and their support for subsystems, like DRM,
+ * which defines its drm_debug classmap in drm module, and uses it in
+ * helpers & drivers.
*
* Authors:
* Jim Cromie <jim.cromie@gmail.com>
@@ -12,3 +15,7 @@
*/
#define TEST_DYNAMIC_DEBUG_SUBMOD
#include "test_dynamic_debug.c"
+
+MODULE_DESCRIPTION("test/demonstrate dynamic-debug subsystem support");
+MODULE_AUTHOR("Jim Cromie <jim.cromie@gmail.com>");
+MODULE_LICENSE("GPL");
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 10dc3f2b3fa8..97588c9b07a7 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -655,7 +655,7 @@ function GOLDEN_RECORDS {
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
#K= 3bcbdc30323082d6e961b5f0e269fff7 FT_test_classes.1
#K= 5516e3d13cba7ea4197a7fb6c033887a FT_test_classes.2
-#K= 22213a7bf431c3e0efd3edbfcba69677 FT_test_classes.3
+#K= 20d4545f9753e677e72e3adf52527fd3 FT_test_classes.3
#K= 3a6afd41fadaaf70fad18f8a4632ffec FT_classmap_inheritance.1
#K= 6f1e347f0a7930814d2e54d589439465 FT_classmap_inheritance.2
#K= a6e6aab5a6cb9a792d4296b1200ba409 FT_classmap_inheritance.3
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 30/39] dyndbg: control-parser: treat comma as a token separator
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (28 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 29/39] dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 31/39] selftests: enable comma-terminator tests Jim Cromie via B4 Relay
` (8 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Treat comma as a token terminator, just like a space. This allows a
user to avoid quoting hassles when spaces are otherwise needed:
:#> modprobe drm dyndbg=class,DRM_UT_CORE,+p\;class,DRM_UT_KMS,+p
Add corresponding Strategy 2 control-file fingerprinting checks to
verify the exact control-file state of kernel/params callsites after
commas-as-spaces, ignored-commas, and quoted-commas queries.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
Documentation/admin-guide/dynamic-debug-howto.rst | 4 +++-
lib/dynamic_debug.c | 17 +++++++++++++----
.../testing/selftests/dynamic_debug/dyndbg_selftest.sh | 4 ++--
3 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
index 99bbae37d34e..fe86a9997ab5 100644
--- a/Documentation/admin-guide/dynamic-debug-howto.rst
+++ b/Documentation/admin-guide/dynamic-debug-howto.rst
@@ -78,11 +78,12 @@ Command Language Reference
==========================
At the basic lexical level, a command is a sequence of words separated
-by spaces or tabs. So these are all equivalent::
+by spaces, tabs, or commas. So these are all equivalent::
:#> ddcmd file svcsock.c line 1603 +p
:#> ddcmd "file svcsock.c line 1603 +p"
:#> ddcmd ' file svcsock.c line 1603 +p '
+ :#> ddcmd file,svcsock.c,line,1603,+p
Command submissions are bounded by a write() system call.
Multiple commands can be written together, separated by ``;`` or ``\n``::
@@ -176,6 +177,7 @@ module
module */main # any subsystem ending in main
module main # simple modname, selects same as above
module drm* # both drm, drm_kms_helper
+ module,sunrpc # with ',' as token separator
format
The given string is searched for in the dynamic debug format
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 15aba978d3c4..d28858acdc8f 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -322,6 +322,14 @@ static int ddebug_change(const struct ddebug_query *query, struct flag_settings
return nfound;
}
+static char *skip_spaces_and_commas(const char *str)
+{
+ str = skip_spaces(str);
+ while (*str == ',')
+ str = skip_spaces(++str);
+ return (char *)str;
+}
+
/*
* Split the buffer `buf' into space-separated words.
* Handles simple " and ' quoting, i.e. without nested,
@@ -335,8 +343,8 @@ static int ddebug_tokenize(char *buf, char *words[], int maxwords)
while (*buf) {
char *end;
- /* Skip leading whitespace */
- buf = skip_spaces(buf);
+ /* Skip leading whitespace and comma */
+ buf = skip_spaces_and_commas(buf);
if (!*buf)
break; /* oh, it was trailing whitespace */
if (*buf == '#')
@@ -352,7 +360,7 @@ static int ddebug_tokenize(char *buf, char *words[], int maxwords)
return -EINVAL; /* unclosed quote */
}
} else {
- for (end = buf; *end && !isspace(*end); end++)
+ for (end = buf; *end && !isspace(*end) && *end != ','; end++)
;
if (end == buf) {
pr_err("parse err after word:%d=%s\n", nwords,
@@ -627,7 +635,8 @@ static int ddebug_exec_queries(char *query, const char *modname)
if (split)
*split++ = '\0';
- query = skip_spaces(query);
+ query = skip_spaces_and_commas(query);
+
if (!query || !*query || *query == '#')
continue;
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 97588c9b07a7..89c9cfa23d2c 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -653,8 +653,8 @@ function GOLDEN_RECORDS {
#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_basic_queries.5
#K= 8c2dd1164fbcefb721345ce62a864a37 FT_basic_queries.6
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
-#K= 3bcbdc30323082d6e961b5f0e269fff7 FT_test_classes.1
-#K= 5516e3d13cba7ea4197a7fb6c033887a FT_test_classes.2
+#K= 8146f6f983c3a76783c89b78b892ed48 FT_test_classes.1
+#K= a15ec4843acd721fbdfddc0b512c8032 FT_test_classes.2
#K= 20d4545f9753e677e72e3adf52527fd3 FT_test_classes.3
#K= 3a6afd41fadaaf70fad18f8a4632ffec FT_classmap_inheritance.1
#K= 6f1e347f0a7930814d2e54d589439465 FT_classmap_inheritance.2
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 31/39] selftests: enable comma-terminator tests
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (29 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 30/39] dyndbg: control-parser: treat comma as a token separator Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 32/39] dyndbg: split multi-query strings with @ Jim Cromie via B4 Relay
` (7 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Enable the FT_comma_terminators test block in dyndbg_selftest.sh to
verify control query parsing when queries are terminated by commas.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
.../selftests/dynamic_debug/dyndbg_selftest.sh | 25 ++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 89c9cfa23d2c..70da3662a201 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -470,6 +470,25 @@ function FT_hyphen_underscore {
ddcmd =_
}
+# test parsing on spaces, commas. testing against builtin file kernel/params.c
+function FT_comma_terminators {
+ v_echo "${GREEN}# COMMA_TERMINATOR_TESTS ${NC}"
+ if [ $LACK_DD_BUILTIN -eq 1 ]; then
+ echo "SKIP - test requires dynamic_debug built into kernel"
+ return
+ fi
+ local f='kernel/params.c'
+ ddcmd =_
+ ddcmd "file $f +p" "$f"
+
+ ddcmd "file,$f,=_" "$f"
+ ddcmd "file,$f,+mf" "$f"
+ # ignore empty tokens
+ ddcmd ",file ,, , $f, -p" "$f"
+ ddcmd " , file ,,, , $f, -m" "$f"
+
+ ddcmd =_
+}
# testing classmap-based query enablers and class configurations
function FT_test_classes {
v_echo "${GREEN}# TEST_CLASSES - classmap-based query enablers and class configs ${NC}"
@@ -581,6 +600,7 @@ builtin_tests=(
FT_basic_queries
FT_path_module_queries
FT_hyphen_underscore
+ FT_comma_terminators
)
# Modular Feature Tests (Require CONFIG_MODULES=y and test_dynamic_debug*.ko available)
@@ -653,6 +673,11 @@ function GOLDEN_RECORDS {
#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_basic_queries.5
#K= 8c2dd1164fbcefb721345ce62a864a37 FT_basic_queries.6
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
+#K= 78ad5b168d9db27931dfe7dac93143bf FT_comma_terminators.1
+#K= 4a8d6e0468d14659030ef523c6e5a184 FT_comma_terminators.2
+#K= 3c445fb23d701041e920a2a6d2b022c7 FT_comma_terminators.3
+#K= 68b329da9893e34099c7d8ad5cb9c940 FT_comma_terminators.4
+#K= c745b8f58c0557edca58d5a224a09190 FT_comma_terminators.5
#K= 8146f6f983c3a76783c89b78b892ed48 FT_test_classes.1
#K= a15ec4843acd721fbdfddc0b512c8032 FT_test_classes.2
#K= 20d4545f9753e677e72e3adf52527fd3 FT_test_classes.3
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 32/39] dyndbg: split multi-query strings with @
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (30 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 31/39] selftests: enable comma-terminator tests Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 33/39] dyndbg: resolve "protection" of class'd pr_debug Jim Cromie via B4 Relay
` (6 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Since
commit 85f7f6c0edb8 ("dynamic_debug: process multiple debug-queries on a line")
Multi-query commands have been allowed:
modprobe drm dyndbg="class DRM_UT_CORE +p; class DRM_UT_KMS +p"
modprobe drm dyndbg=<<EOX
class DRM_UT_CORE +p
class DRM_UT_KMS +p
EOX
More recently, the need for quoting was avoided by treating a comma
like a space/token-terminator:
modprobe drm dyndbg=class,DRM_UT_CORE,+p\;class,DRM_UT_KMS,+p
That works, but it needs the escaped semicolon, which is a shell
special-char (one of the bash control operators), so it is brittle
when passed in/down/around scripts.
So this patch adds '@' to the existing ';' and '\n' multi-command
separators, which is more shell-friendly, so you can more fully avoid
quoting and escaping hassles.
Update selftests script, adding a multi-query split on @
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v9:
. update FT_multi_query command in dyndbg_selftest.sh to actively test @ delimiter.
v5: avoid +t flag in content tests - pid is not predictable.
remove Reviewed-by: <louis.chauvet@bootlin.com> - too many changes
v2:
replace '%' with '@' as multi-query splitter, as it is:
- not a sshell special cahr
- allows matching on format strings with format specifiers
---
Documentation/admin-guide/dynamic-debug-howto.rst | 8 +++++---
lib/dynamic_debug.c | 2 +-
.../selftests/dynamic_debug/dyndbg_selftest.sh | 23 +++++++++++++++++-----
3 files changed, 24 insertions(+), 9 deletions(-)
diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
index fe86a9997ab5..6b934fab695b 100644
--- a/Documentation/admin-guide/dynamic-debug-howto.rst
+++ b/Documentation/admin-guide/dynamic-debug-howto.rst
@@ -85,10 +85,12 @@ by spaces, tabs, or commas. So these are all equivalent::
:#> ddcmd ' file svcsock.c line 1603 +p '
:#> ddcmd file,svcsock.c,line,1603,+p
-Command submissions are bounded by a write() system call.
-Multiple commands can be written together, separated by ``;`` or ``\n``::
+Command submissions are bounded by a write() system call. Multiple
+commands can be written together, separated by ``@``, ``;`` or ``\n``::
- :#> ddcmd "func pnpacpi_get_resources +p; func pnp_assign_mem +p"
+ :#> ddcmd func foo +p @ func bar +p
+ :#> ddcmd func foo +p \; func bar +p
+ :#> ddcmd "func foo +p ; func bar +p"
:#> ddcmd <<"EOC"
func pnpacpi_get_resources +p
func pnp_assign_mem +p
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index d28858acdc8f..e6f5a524d63b 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -631,7 +631,7 @@ static int ddebug_exec_queries(char *query, const char *modname)
int i, errs = 0, exitcode = 0, rc, nfound = 0;
for (i = 0; query; query = split) {
- split = strpbrk(query, ";\n");
+ split = strpbrk(query, "@;\n");
if (split)
*split++ = '\0';
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 70da3662a201..f10ef7522426 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -324,9 +324,20 @@ function FT_basic_queries {
ddcmd "file $f +l" "$f"
ddcmd "file $f -m" "$f"
ddcmd "file $f =_" "$f"
+}
+
+function FT_multi_query {
+ v_echo "${GREEN}# MULTI_QUERY_TESTS ${NC}"
+ if [ $LACK_DD_BUILTIN -eq 1 ]; then
+ echo "SKIP - test requires dynamic_debug built into kernel"
+ return
+ fi
+ local f='kernel/params.c'
+ ddcmd =_ # zero everything
- # multi-query commands split on ; on a single line
+ # multi-query commands on a single line, split on ;/@ respectively
ddcmd "file $f +mf ; file $f func parse_args +sl" "$f"
+ ddcmd "file $f -f @ file $f func parse_args -l" "$f"
# verify multi-cmd input, newline separated, with embedded comments
ddcmd =_ # reset before multiline query to capture full transition
@@ -503,7 +514,7 @@ function FT_test_classes {
verify_control_slice '\[test_dynamic_debug\]'
# 2. Verify state transition and live-printing end-to-end via ddcmd_load!
- ddcmd_load "class D2_CORE +pmf;class D2_KMS +pls;class D2_ATOMIC +pml" \
+ ddcmd_load "class,D2_CORE,+pmf;class,D2_KMS,+pls;class,D2_ATOMIC,+pml" \
'\[test_dynamic_debug\]' \
"/sys/module/test_dynamic_debug/parameters/do_classes" "1"
@@ -601,6 +612,7 @@ builtin_tests=(
FT_path_module_queries
FT_hyphen_underscore
FT_comma_terminators
+ FT_multi_query
)
# Modular Feature Tests (Require CONFIG_MODULES=y and test_dynamic_debug*.ko available)
@@ -670,14 +682,15 @@ function GOLDEN_RECORDS {
#K= d8eb8f226860aa558fb8a98097f05be9 FT_basic_queries.2
#K= 6a86bb9209a3a0492bc6c2d29f4d5e52 FT_basic_queries.3
#K= 90804574a5336971465f92d6cc3aa7fb FT_basic_queries.4
-#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_basic_queries.5
-#K= 8c2dd1164fbcefb721345ce62a864a37 FT_basic_queries.6
-#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_basic_queries.7
#K= 78ad5b168d9db27931dfe7dac93143bf FT_comma_terminators.1
#K= 4a8d6e0468d14659030ef523c6e5a184 FT_comma_terminators.2
#K= 3c445fb23d701041e920a2a6d2b022c7 FT_comma_terminators.3
#K= 68b329da9893e34099c7d8ad5cb9c940 FT_comma_terminators.4
#K= c745b8f58c0557edca58d5a224a09190 FT_comma_terminators.5
+#K= f2b4f24fece9c55f5a5d28323c2019f8 FT_multi_query.1
+#K= cce9c41c3ac297e910c3ee3b10852cb3 FT_multi_query.2
+#K= 8c2dd1164fbcefb721345ce62a864a37 FT_multi_query.3
+#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_multi_query.4
#K= 8146f6f983c3a76783c89b78b892ed48 FT_test_classes.1
#K= a15ec4843acd721fbdfddc0b512c8032 FT_test_classes.2
#K= 20d4545f9753e677e72e3adf52527fd3 FT_test_classes.3
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 33/39] dyndbg: resolve "protection" of class'd pr_debug
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (31 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 32/39] dyndbg: split multi-query strings with @ Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 34/39] dyndbg: harden classmap and descriptor validation Jim Cromie via B4 Relay
` (5 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
classmap-v1 code protected class'd pr_debugs from unintended
changes by unclassed/_DFLT queries:
# - to declutter examples:
alias ddcmd='echo $* > /proc/dynamic_debug/control'
# IOW, this should NOT alter drm.debug settings
ddcmd -p
# Instead, you must name the class to change it.
# Protective but tedious
ddcmd class DRM_UT_CORE +p
# Or do it the (old school) subsystem way
# This is ABI !!
echo 1 > /sys/module/drm/parameters/debug
Since the debug sysfs-node is ABI, if dyndbg is going to implement it,
it must also honor its settings; it must at least protect against
accidental changes to its classes from legacy queries.
The protection allows all previously conceived queries to work the way
they always have; ie select the same set of pr_debugs, despite the
inclusion of whole new classes of pr_debugs.
But that choice has 2 downsides:
1. "name the class to change it" makes a tedious long-winded
interface, needing many commands to set DRM_UT_* one at a time.
2. It makes the class keyword special in some sense; the other
keywords skip only on query mismatch, otherwise the code falls thru to
adjust the pr-debug site.
Jason Baron didn't like v1 on point 2.
Louis Chauvet didn't like recent rev on point 1 tedium.
But that said: /sys/ is ABI, so this must be reliable:
#> echo 0x1f > /sys/module/drm/parameters/debug
It 'just works' without dyndbg underneath; we must deliver that same
stability. Convenience is secondary.
The new resolution:
If ABI is the blocking issue, then no ABI means no blocking issue.
IOW, if the classmap has no presence under /sys/*, ie no PARAM, there
is no ABI to guard, and no reason to enforce a tedious interface.
In the future, if DRM wants to alter this protection, that is
practical, but I think default-on is the correct mode.
So atm classes without a PARAM are unprotected at >control, allowing
admins their shortcuts. I think this could satisfy all viewpoints.
That said, theres also a possibility of wildcard classes:
#> ddcmd class '*' +p
Currently, the query-class is exact-matched against each module's
classmaps.names. This gives precise behavior, a good basis.
But class wildcards are possible, they just did'nt appear useful for
DRM, whose classmap names are a flat DRM_UT_* namespace.
IOW, theres no useful selectivity there:
#> ddcmd class "DRM_*" +p # these enable every DRM_* class
#> ddcmd class "DRM_UT_*" +p
#> ddcmd class "DRM_UT_V*" +p # finally select just 1: DRM_UT_VBL
#> ddcmd class "DRM_UT_D*" +p # but this gets 3
#> ddcmd class "D*V*" +p # here be dragons
But there is debatable utility in the feature.
#> ddcmd class __DEFAULT__ -p # what about this ?
#> ddcmd -p # thats what this does. automatically
Anyway, this patch does:
1. adds link field from _ddebug_class_map to the .controlling_param
2. sets it in ddebug_match_apply_kparam(), during modprobe/init,
when options like drm.debug=VAL are handled.
3. ddebug_class_has_param() now checks .controlling_param
4. ddebug_class_wants_protection() macro renames 3.
this frames it as a separable policy decision
5. ddebug_match_desc() gets the most attention:
a. move classmap consideration to the bottom
this insures all other constraints act 1st.
allows simpler 'final' decisions.
b. split class choices cleanly on query:
class FOO vs none, and class'd vs _DPRINTK_CLASS_DFLT site.
c. calls 4 when applying a class-less query to a class'd pr_debug
here we need a new fn to find the classmap with this .class_id
d. calls new ddebug_find_classmap_by_class_id().
when class-less query looks at a class'd pr_debug.
finds classmap, which can then decide, currently by PARAM existence.
NOTES:
protection is only against class-less queries, explicit "class FOO"
adjustments are allowed (that is the mechanism).
The drm.debug sysfs-node heavily under-specifies the class'd pr_debugs
it controls; none of the +mfls prefixing flags have any effect, and
each callsite remains individually controllable. drm.debug just
toggles the +p flag for all the modules' class'd pr_debugs.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v9:
. assign map->controlling_param = dcp in ddebug_match_apply_kparam()
to enforce protection on parameterized classmaps.
v2: RvB after SoB
old-v12
minor fixup after squashing subsequent commits to previous ones
---
include/linux/dynamic_debug.h | 14 +++--
lib/dynamic_debug.c | 131 +++++++++++++++++++++++++++++++++++-------
2 files changed, 120 insertions(+), 25 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index cc203b6c1b56..32a34a80672b 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -94,6 +94,7 @@ enum ddebug_class_map_type {
* map @class_names 0..N to consecutive constants starting at @base.
*/
struct ddebug_class_map {
+ struct ddebug_class_param *controlling_param;
const struct module *mod; /* NULL for builtins */
const char *mod_name; /* needed for builtins */
const char **class_names;
@@ -301,7 +302,12 @@ struct ddebug_class_param {
*
* Creates a sysfs-param to control the classes defined by the
* exported classmap, with bits 0..N-1 mapped to the classes named.
- * This version keeps class-state in a private long int.
+ *
+ * Since sysfs-params are ABI, this also protects the classmap'd
+ * pr_debugs from un-class'd `echo -p > /proc/dynamic_debug/control`
+ * changes.
+ *
+ * This keeps class-state in a private long int.
*/
#define DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _var, _flags) \
static u32 _name##_bvec; \
@@ -314,10 +320,8 @@ struct ddebug_class_param {
* @_var: name of the (exported) classmap var defining the classes/bits
* @_flags: flags to be toggled, typically just 'p'
*
- * Creates a sysfs-param to control the classes defined by the
- * exported clasmap, with bits 0..N-1 mapped to the classes named.
- * This version keeps class-state in user @_bits. This lets drm check
- * __drm_debug elsewhere too.
+ * Like DYNAMIC_DEBUG_CLASSMAP_PARAM, but maintains param-state in
+ * extern @_bits. This lets DRM check __drm_debug elsewhere too.
*/
#define DYNAMIC_DEBUG_CLASSMAP_PARAM_REF(_name, _bits, _var, _flags) \
__DYNAMIC_DEBUG_CLASSMAP_PARAM(_name, _bits, _var, _flags)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index e6f5a524d63b..8c90b1e4cd33 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -71,6 +71,10 @@ struct flag_settings {
unsigned int mask;
};
+static bool ddebug_class_map_in_range(const int class_id,
+ const struct ddebug_class_map *map);
+static bool ddebug_class_user_in_range(const int class_id,
+ const struct ddebug_class_user *user);
static DEFINE_MUTEX(ddebug_lock);
static LIST_HEAD(ddebug_tables);
static int verbose;
@@ -200,6 +204,46 @@ static struct ddebug_class_map *ddebug_find_valid_class(struct _ddebug_info cons
return NULL;
}
+
+
+static struct ddebug_class_map *
+ddebug_find_map_by_class_id(struct _ddebug_info *di, int class_id)
+{
+ struct ddebug_class_map *map;
+ struct ddebug_class_user *cli;
+ int i;
+
+ for_subvec(i, map, di, maps)
+ if (ddebug_class_map_in_range(class_id, map))
+ return map;
+
+ for_subvec(i, cli, di, users)
+ if (ddebug_class_user_in_range(class_id, cli))
+ return cli->map;
+
+ return NULL;
+}
+
+/*
+ * classmaps-V1 protected classes from changes by legacy commands
+ * (those selecting _DPRINTK_CLASS_DFLT by omission). This had the
+ * downside that saying "class FOO" for every change can get tedious.
+ *
+ * V2 is smarter, it protects class-maps if the defining module also
+ * calls DYNAMIC_DEBUG_CLASSMAP_PARAM to create a sysfs parameter.
+ * Since the author wants the knob, we should assume they intend to
+ * use it (in preference to "class FOO +p" >control), and want to
+ * trust its settings. This gives protection when its useful, and not
+ * when its just tedious.
+ */
+static inline bool ddebug_class_has_param(const struct ddebug_class_map *map)
+{
+ return !!(map->controlling_param);
+}
+
+/* re-framed as a policy choice */
+#define ddebug_class_wants_protection(map) (ddebug_class_has_param(map))
+
/*
* Search the tables for _ddebug's which match the given `query' and
* apply the `flags' and `mask' to them. Returns number of matching
@@ -208,11 +252,10 @@ static struct ddebug_class_map *ddebug_find_valid_class(struct _ddebug_info cons
*/
static bool ddebug_match_desc(const struct ddebug_query *query,
struct _ddebug *dp,
- int valid_class)
+ struct _ddebug_info *di,
+ int selected_class)
{
- /* match site against query-class */
- if (dp->class_id != valid_class)
- return false;
+ struct ddebug_class_map *site_map;
/* match against the source filename */
if (query->filename &&
@@ -256,7 +299,28 @@ static bool ddebug_match_desc(const struct ddebug_query *query,
dp->lineno > query->last_lineno)
return false;
- return true;
+ /*
+ * above are all satisfied, so we can make final decisions:
+ * 1- class FOO or implied class __DEFAULT__
+ * 2- site.is_classed or not
+ */
+ if (query->class_string) {
+ /* class FOO given, exact match required */
+ return (dp->class_id == selected_class);
+ }
+ /* query class __DEFAULT__ by omission. */
+ if (dp->class_id == _DPRINTK_CLASS_DFLT) {
+ /* un-classed site */
+ return true;
+ }
+ /* site is class'd */
+ site_map = ddebug_find_map_by_class_id(di, dp->class_id);
+ if (!site_map) {
+ WARN_ONCE(1, "unknown class_id %d, check %s's CLASSMAP definitions", dp->class_id, di->mod_name);
+ return false;
+ }
+ /* module(-param) decides protection */
+ return !ddebug_class_wants_protection(site_map);
}
static int ddebug_change(const struct ddebug_query *query, struct flag_settings *modifiers)
@@ -266,13 +330,13 @@ static int ddebug_change(const struct ddebug_query *query, struct flag_settings
unsigned int newflags;
unsigned int nfound = 0;
struct flagsbuf fbuf, nbuf;
- struct ddebug_class_map *map = NULL;
- int valid_class;
+ int selected_class;
/* search for matching ddebugs */
mutex_lock(&ddebug_lock);
list_for_each_entry(dt, &ddebug_tables, link) {
struct _ddebug_info *di = &dt->info;
+ struct ddebug_class_map *mods_map;
/* match against the module name */
if (query->module &&
@@ -280,20 +344,18 @@ static int ddebug_change(const struct ddebug_query *query, struct flag_settings
!match_wildcard_hyphen(query->module, kbasename(di->mod_name)))
continue;
+ selected_class = _DPRINTK_CLASS_DFLT;
if (query->class_string) {
- map = ddebug_find_valid_class(&dt->info, query->class_string,
- &valid_class);
- if (!map)
+ mods_map = ddebug_find_valid_class(di, query->class_string,
+ &selected_class);
+ if (!mods_map)
continue;
- } else {
- /* constrain query, do not touch class'd callsites */
- valid_class = _DPRINTK_CLASS_DFLT;
}
for (i = 0; i < di->descs.len; i++) {
struct _ddebug *dp = &di->descs.start[i];
- if (!ddebug_match_desc(query, dp, valid_class))
+ if (!ddebug_match_desc(query, dp, di, selected_class))
continue;
nfound++;
@@ -1146,7 +1208,6 @@ static bool ddebug_class_user_in_range(const int class_id, const struct ddebug_c
return false;
return ddebug_class_map_in_range(class_id - user->offset, user->map);
}
-
static const char *ddebug_class_name(struct _ddebug_info *di, struct _ddebug *dp)
{
struct ddebug_class_map *map;
@@ -1297,25 +1358,35 @@ static void ddebug_sync_classbits(const struct kernel_param *kp, const char *mod
}
}
-static void ddebug_match_apply_kparam(const struct kernel_param *kp,
- const struct ddebug_class_map *map,
- const char *mod_name)
+static struct ddebug_class_param *
+ddebug_get_classmap_kparam(const struct kernel_param *kp,
+ const struct ddebug_class_map *map)
{
struct ddebug_class_param *dcp;
if (kp->ops != ¶m_ops_dyndbg_classes)
- return;
+ return NULL;
dcp = (struct ddebug_class_param *)kp->arg;
+ return (map == dcp->map)
+ ? dcp : (struct ddebug_class_param *)NULL;
+}
+
+static void ddebug_match_apply_kparam(const struct kernel_param *kp,
+ struct ddebug_class_map *map,
+ const char *mod_name)
+{
+ struct ddebug_class_param *dcp = ddebug_get_classmap_kparam(kp, map);
if (dcp && dcp->map == map) {
+ map->controlling_param = dcp;
v2pr_info(" kp:%s.%s =0x%x", mod_name, kp->name, *dcp->bits);
vpr_cm_info(map, " %s maps ", mod_name);
ddebug_sync_classbits(kp, mod_name);
}
}
-static void ddebug_apply_params(const struct ddebug_class_map *cm, const char *mod_name)
+static void ddebug_apply_params(struct ddebug_class_map *cm, const char *mod_name)
{
const struct kernel_param *kp;
@@ -1338,6 +1409,26 @@ static void ddebug_apply_params(const struct ddebug_class_map *cm, const char *m
}
}
+#if 0
+/*
+ * called from add_module, ie early. it can find controlling kparams,
+ * which can/does? enable protection of this classmap from class-less
+ * queries, on the grounds that the user created the kparam, means to
+ * use it, and expects it to reflect reality. We should oblige him,
+ * and protect those classmaps from classless "-p" changes.
+ */
+static void ddebug_apply_class_maps(const struct _ddebug_info *di)
+{
+ struct ddebug_class_map *cm;
+ int i;
+
+ for_subvec(i, cm, di, maps)
+ ddebug_apply_params(cm, cm->mod_name);
+
+ v2pr_di_info(di, "attached %d class-maps to ", i);
+}
+#endif
+
static void ddebug_apply_class_users(const struct _ddebug_info *di)
{
struct ddebug_class_user *cli;
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 34/39] dyndbg: harden classmap and descriptor validation
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (32 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 33/39] dyndbg: resolve "protection" of class'd pr_debug Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 35/39] docs/dyndbg: add classmap info to howto Jim Cromie via B4 Relay
` (4 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Dynamic debug classmaps allow modules to _DEFINE and/or _USE multiple
classmaps, but this requires coordination amongst the classmaps.
Previously, class validation done by DYNAMIC_DEBUG_CLASSMAP_DEFINE at
compile-time, and ddebug_class_range_overlap() at modprobe-time, was
incomplete, and DYNAMIC_DEBUG_CLASSMAP_USE_ had no validation. This
could allow broken classmaps, making them harder to use well.
This commit improves classmap and descriptor validation:
- Mirror the compile-time limits of _DEFINE by adding a static_assert
to validate the _offset value passed to DYNAMIC_DEBUG_CLASSMAP_USE_.
- Add run-time overlap checks for _USEd classmaps in ddebug_add_module()
to prevent collisions between private maps and imported APIs.
- Scan module descriptors at load time to print a single warning per
missing class_id, rather than waiting for a user query to trip over it.
- Downgrade the global WARN_ONCE in ddebug_match_desc() to a
pr_warn_ratelimited, since orphaned class IDs are now tracked and
warned about early at module load.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
lib/dynamic_debug.c | 68 ++++++++++++++++++++--
lib/test_dynamic_debug.c | 16 +++--
.../selftests/dynamic_debug/dyndbg_selftest.sh | 22 +++----
3 files changed, 84 insertions(+), 22 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 8c90b1e4cd33..afde13a2121f 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -316,7 +316,8 @@ static bool ddebug_match_desc(const struct ddebug_query *query,
/* site is class'd */
site_map = ddebug_find_map_by_class_id(di, dp->class_id);
if (!site_map) {
- WARN_ONCE(1, "unknown class_id %d, check %s's CLASSMAP definitions", dp->class_id, di->mod_name);
+ pr_warn_ratelimited("unknown class_id %d, check %s's CLASSMAP definitions\n",
+ dp->class_id, di->mod_name);
return false;
}
/* module(-param) decides protection */
@@ -1483,6 +1484,23 @@ static int ddebug_class_range_overlap(struct ddebug_class_map *cm, u64 *reserved
return 0;
}
+static int ddebug_class_user_overlap(struct ddebug_class_user *cli,
+ u64 *reserved_ids)
+{
+ struct ddebug_class_map *cm = cli->map;
+ int base = cm->base + cli->offset;
+ u64 range = (((1ULL << cm->length) - 1) << base);
+
+ if (range & *reserved_ids) {
+ pr_err("module %s: [%d..%d] (from %s) conflicts with %llx\n",
+ cli->mod_name, base, base + cm->length - 1,
+ cm->class_names[0], *reserved_ids);
+ return -EINVAL;
+ }
+ *reserved_ids |= range;
+ return 0;
+}
+
/*
* Allocate a new ddebug_table for the given module
* and add it to the global list.
@@ -1493,7 +1511,8 @@ static int ddebug_add_module(struct _ddebug_info *di)
struct ddebug_class_map *cm;
struct ddebug_class_user *cli;
u64 reserved_ids = 0;
- int i;
+ u64 bad_ids = 0;
+ int i, err = 0;
if (!di->descs.len)
return 0;
@@ -1524,10 +1543,47 @@ static int ddebug_add_module(struct _ddebug_info *di)
dd_set_module_subrange(i, cm, &dt->info, maps);
dd_set_module_subrange(i, cli, &dt->info, users);
- /* insure 2+ classmaps share the per-module 0..62 class_id space */
+ /* validate the per-module shared 0..62 class_id space */
for_subvec(i, cm, &dt->info, maps)
if (ddebug_class_range_overlap(cm, &reserved_ids))
- goto cleanup;
+ err = -EINVAL;
+
+ for_subvec(i, cli, &dt->info, users) {
+ cm = cli->map;
+ if (!cm) {
+ pr_err("module %s: classmap not found for user\n", di->mod_name);
+ err = -EINVAL;
+ continue;
+ }
+
+ if (cm->base + cm->length + cli->offset > _DPRINTK_CLASS_DFLT) {
+ pr_err("module %s: base:%d + classes.len:%d + cli.offset:%d must be <= %d\n",
+ di->mod_name, cm->base, cm->length,
+ cli->offset, _DPRINTK_CLASS_DFLT);
+ err = -EINVAL;
+ continue;
+ }
+
+ if (ddebug_class_user_overlap(cli, &reserved_ids))
+ err = -EINVAL;
+ }
+ if (err)
+ goto cleanup;
+
+ /* validate all class_ids against module's classmaps/users */
+ for (i = 0; i < dt->info.descs.len; i++) {
+ struct _ddebug *dp = &dt->info.descs.start[i];
+
+ if (dp->class_id == _DPRINTK_CLASS_DFLT)
+ continue;
+ if (bad_ids & (1ULL << dp->class_id))
+ continue;
+ if (!ddebug_find_map_by_class_id(&dt->info, dp->class_id)) {
+ pr_warn("module %s uses unknown class_id %d\n",
+ dt->info.mod_name, dp->class_id);
+ bad_ids |= (1ULL << dp->class_id);
+ }
+ }
mutex_lock(&ddebug_lock);
list_add_tail(&dt->link, &ddebug_tables);
@@ -1539,7 +1595,7 @@ static int ddebug_add_module(struct _ddebug_info *di)
dt->info.descs.len, dt->info.mod_name);
return 0;
cleanup:
- WARN_ONCE(1, "dyndbg multi-classmap conflict in %s\n", di->mod_name);
+ pr_err("dyndbg multi-classmap conflict in %s\n", di->mod_name);
kfree(dt);
return -EINVAL;
}
@@ -1626,7 +1682,7 @@ static int ddebug_module_notify(struct notifier_block *self, unsigned long val,
mod->dyndbg_info.mod_name = mod->name;
ret = ddebug_add_module(&mod->dyndbg_info);
if (ret)
- WARN(1, "Failed to allocate memory: dyndbg may not work properly.\n");
+ pr_err("dyndbg: failed to add module %s: %d\n", mod->name, ret);
break;
case MODULE_STATE_GOING:
ddebug_remove_module(mod->name);
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 368891075175..97f2c9e1b92b 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -161,14 +161,20 @@ DYNAMIC_DEBUG_CLASSMAP_DEFINE(fail_base_len, 0, 60,
#endif
#else /* TEST_DYNAMIC_DEBUG_SUBMOD */
-
/*
- * in submod/drm-drivers, use the classmaps defined in top/parent
- * module above.
+ * In submod (drm-drivers/helpers) use the classmaps defined in
+ * top/parent module above. We _USE_() with offset, to test the
+ * non-zero case.
*/
-
DYNAMIC_DEBUG_CLASSMAP_USE(map_disjoint_bits);
-DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 7);
+/*
+ * maybe force failure of runtime sanity test of classmap.length + offset < 63
+ */
+#if !defined(DD_RUNTIME_CLASS_CHECK)
+DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 8);
+#else
+DYNAMIC_DEBUG_CLASSMAP_USE_(map_level_num, 55);
+#endif
#if defined(DD_MACRO_ARGCHECK)
DYNAMIC_DEBUG_CLASSMAP_USE_(fail_offset_big, 100);
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index f10ef7522426..25137663d554 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -693,12 +693,12 @@ function GOLDEN_RECORDS {
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_multi_query.4
#K= 8146f6f983c3a76783c89b78b892ed48 FT_test_classes.1
#K= a15ec4843acd721fbdfddc0b512c8032 FT_test_classes.2
-#K= 20d4545f9753e677e72e3adf52527fd3 FT_test_classes.3
-#K= 3a6afd41fadaaf70fad18f8a4632ffec FT_classmap_inheritance.1
-#K= 6f1e347f0a7930814d2e54d589439465 FT_classmap_inheritance.2
+#K= bc074e657d8d7f0bbc960e4dfa8de25d FT_test_classes.3
+#K= 878c5b9b20cbe8b93f2f3e92fc8b77bb FT_classmap_inheritance.1
+#K= 0eb7e891704074434646c2340ddac152 FT_classmap_inheritance.2
#K= a6e6aab5a6cb9a792d4296b1200ba409 FT_classmap_inheritance.3
-#K= 315cc5dad3a775c54a0b60a0276300b7 FT_classmap_inheritance.4
-#K= 7e92245008439ee79fe2460aeaa16a9b FT_classmap_inheritance.5
+#K= 5b6d86bcaa2477699aab655447d780dd FT_classmap_inheritance.4
+#K= f43e0aff8a4b38435b73d90ed8100d1b FT_classmap_inheritance.5
#K= 94610c57ac44bd7011002a654fd78f93 FT_modprobe_w_param.1
#K= 94610c57ac44bd7011002a654fd78f93 FT_modprobe_w_param.2
#K= c1309e18dc9bf2f57184fa13164d917d FT_modprobe_w_param.3
@@ -709,11 +709,11 @@ function GOLDEN_RECORDS {
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.8
#K= 591411c42cf52d7c4c46d76bcc345a5f FT_modprobe_w_param.9
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.10
-#K= b0435304108118e64529469e59332111 FT_modprobe_w_param.11
+#K= 46d24fecc507a8f9be0bd120e27ff64f FT_modprobe_w_param.11
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.12
-#K= 4d036833ce9f661057a4e13d97295c65 FT_modprobe_w_param.13
+#K= 79298a323d3dcca4f74fb9fc0de5a87e FT_modprobe_w_param.13
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.14
-#K= 5c3c6ecf6a46f9ccebd60c5ca9ebdbb7 FT_modprobe_w_param.15
+#K= f649752dfb07a68087f04dafc00ed1e8 FT_modprobe_w_param.15
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.16
#K= 73a93377a823739e8aae44856a20fa7f FT_modprobe_w_param.17
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.18
@@ -727,11 +727,11 @@ function GOLDEN_RECORDS {
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.26
#K= 7b91db8e9f160aebb1ee87fab2232404 FT_modprobe_w_param.27
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.28
-#K= e393499e02677de414e478f4e710eeb9 FT_modprobe_w_param.29
+#K= d3d111da544dd5cee254e88178823b9d FT_modprobe_w_param.29
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.30
-#K= 375e38613af3b49bb7c7689dfecf4177 FT_modprobe_w_param.31
+#K= b5a30ebac06aea6e77a44322667effc7 FT_modprobe_w_param.31
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.32
-#K= 745a61d20e26a6a22db0b99420fea80a FT_modprobe_w_param.33
+#K= bbe7b47ed089428429f4264c8cc2a066 FT_modprobe_w_param.33
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.34
#K= 3d2538bf868e71bff17c768cf118c352 FT_modprobe_w_param.35
#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.36
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 35/39] docs/dyndbg: add classmap info to howto
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (33 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 34/39] dyndbg: harden classmap and descriptor validation Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 36/39] dyndbg: Ignore additional arguments from pr_fmt Jim Cromie via B4 Relay
` (3 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Louis Chauvet
From: Jim Cromie <jim.cromie@gmail.com>
Describe the 3 API macros providing dynamic_debug's classmaps
DYNAMIC_DEBUG_CLASSMAP_DEFINE - create & export a classmap
DYNAMIC_DEBUG_CLASSMAP_USE - refer to exported map
DYNAMIC_DEBUG_CLASSMAP_PARAM - bind control param to the classmap
DYNAMIC_DEBUG_CLASSMAP_PARAM_REF + use module's storage - __drm_debug
NB: The _DEFINE & _USE model makes the user dependent on the definer,
just like EXPORT_SYMBOL(__drm_debug) already does.
cc: linux-doc@vger.kernel.org
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Reviewed-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
v9:
. fix typo in class keyword documentation.
. document DYNAMIC_DEBUG_CLASSMAP_PARAM_REF.
v2: RvB after SoB
---
Documentation/admin-guide/dynamic-debug-howto.rst | 145 ++++++++++++++++++++--
1 file changed, 135 insertions(+), 10 deletions(-)
diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
index 6b934fab695b..f5d96b1553d8 100644
--- a/Documentation/admin-guide/dynamic-debug-howto.rst
+++ b/Documentation/admin-guide/dynamic-debug-howto.rst
@@ -146,6 +146,9 @@ keywords are::
"1-30" is valid range but "1 - 30" is not.
+Keywords
+--------
+
The meanings of each keyword are:
func
@@ -197,16 +200,6 @@ format
format "nfsd: SETATTR" // a neater way to match a format with whitespace
format 'nfsd: SETATTR' // yet another way to match a format with whitespace
-class
- The given class_name is validated against each module, which may
- have declared a list of known class_names. If the class_name is
- found for a module, callsite & class matching and adjustment
- proceeds. Examples::
-
- class DRM_UT_KMS # a DRM.debug category
- class JUNK # silent non-match
- // class TLD_* # NOTICE: no wildcard in class names
-
line
The given line number or range of line numbers is compared
against the line number of each ``pr_debug()`` callsite. A single
@@ -221,6 +214,25 @@ line
line -1605 // the 1605 lines from line 1 to line 1605
line 1600- // all lines from line 1600 to the end of the file
+class
+
+ The given class_name is validated against each module, which may
+ have declared a list of class_names it accepts. If the class_name
+ is accepted by a module, callsite & class matching and adjustment
+ proceeds. Examples::
+
+ class DRM_UT_KMS # a drm.debug category
+ class JUNK # silent non-match
+ // class TLD_* # NOTICE: no wildcard in class names
+
+.. note::
+
+ Unlike other keywords, classes are "name-to-change", not
+ "omitting-constraint-allows-change". See Dynamic Debug Classmaps
+
+Flags
+-----
+
The flags specification comprises a change operation followed
by one or more flag characters. The change operation is one
of the characters::
@@ -242,6 +254,11 @@ The flags are::
l Include line number
d Include call trace
+.. note::
+
+ * To query without changing ``+_`` or ``-_``.
+ * To clear all flags ``=_`` or ``-fslmpt``.
+
For ``print_hex_dump_debug()`` and ``print_hex_dump_bytes()``, only
the ``p`` flag has meaning, other flags are ignored.
@@ -398,3 +415,111 @@ just a shortcut for ``print_hex_dump(KERN_DEBUG)``.
For ``print_hex_dump_debug()``/``print_hex_dump_bytes()``, format string is
its ``prefix_str`` argument, if it is constant string; or ``hexdump``
in case ``prefix_str`` is built dynamically.
+
+.. _dyndbg-classmaps:
+
+Dynamic Debug Classmaps
+=======================
+
+The "class" keyword selects prdbgs based on author supplied,
+domain-oriented names. This complements the nested-scope keywords:
+module, file, function, line.
+
+The main difference from the others: classes must be named to be
+changed. This protects them from unintended overwrite::
+
+ # IOW this cannot undo any drm.debug settings
+ :#> ddcmd -p
+
+This protection is needed; /sys/module/drm/parameters/debug is ABI.
+drm.debug is authoritative when dyndbg is not used, dyndbg-under-DRM
+is an implementation detail, and must not behave erratically, just
+because another admin fed >control something unrelated.
+
+So each class must be enabled individually (no wildcards)::
+
+ :#> ddcmd class DRM_UT_CORE +p
+ :#> ddcmd class DRM_UT_KMS +p
+ # or more selectively
+ :#> ddcmd class DRM_UT_CORE module drm +p
+
+That makes direct >control wordy and annoying, but it is a secondary
+interface; it is not intended to replace the ABI, just slide in
+underneath and reimplement the guaranteed behavior. So DRM would keep
+using the convenient way, and be able to trust it::
+
+ :#> echo 0x1ff > /sys/module/drm/parameters/debug
+
+That said, since the sysfs/kparam is the ABI, if the author omits the
+CLASSMAP_PARAM, theres no ABI to guard, and he probably wants a less
+pedantic >control interface. In this case, protection is dropped.
+
+Dynamic Debug Classmap API
+==========================
+
+DYNAMIC_DEBUG_CLASSMAP_DEFINE(clname,type,_base,classnames) - this maps
+classnames (a list of strings) onto class-ids consecutively, starting
+at _base.
+
+DYNAMIC_DEBUG_CLASSMAP_USE(clname) & _USE_(clname,_base) - modules
+call this to refer to the var _DEFINEd elsewhere (and exported).
+
+DYNAMIC_DEBUG_CLASSMAP_PARAM(clname) - creates the sysfs/kparam,
+maps/exposes bits 0..N as class-names.
+
+DYNAMIC_DEBUG_CLASSMAP_PARAM_REF(name,bits,var,flags) - connects an
+existing module parameter variable (e.g. __drm_debug) to a classmap.
+
+Classmaps are opt-in: modules invoke _DEFINE or _USE to authorize
+dyndbg to update those named classes. "class FOO" queries are
+validated against the classes defined or used by the module, this
+finds the classid to alter; classes are not directly selectable by
+their classid.
+
+Classnames are global in scope, so subsystems (module-groups) should
+prepend a subsystem name; unqualified names like "CORE" are discouraged.
+
+NB: It is an inherent API limitation (due to class_id's int type) that
+the following are possible:
+
+ // these errors should be caught in review
+ __pr_debug_cls(0, "fake DRM_UT_CORE msg"); // this works
+ __pr_debug_cls(62, "un-known classid msg"); // this compiles, does nothing
+
+There are 2 types of classmaps:
+
+* DD_CLASS_TYPE_DISJOINT_BITS: classes are independent, like drm.debug
+* DD_CLASS_TYPE_LEVEL_NUM: classes are relative, ordered (V3 > V2)
+
+DYNAMIC_DEBUG_CLASSMAP_PARAM - modelled after module_param_cb, it
+refers to a DEFINEd classmap, and associates it to the param's
+data-store. This state is then applied to DEFINEr and USEr modules
+when they're modprobed.
+
+The PARAM interface also enforces the DD_CLASS_TYPE_LEVEL_NUM relation
+amongst the contained classnames; all classes are independent in the
+control parser itself. There is no implied meaning in names like "V4"
+or "PL_ERROR" vs "PL_WARNING".
+
+Modules or subsystems (drm & drivers) can define multiple classmaps,
+as long as they (all the classmaps) share the limited 0..62
+per-module-group _class_id range, without overlap.
+
+If a module encounters a conflict between 2 classmaps it is _USEing or
+_DEFINEing, it can invoke the extended _USE_(name,_base) macro to
+de-conflict the respective ranges.
+
+``#define DEBUG`` will enable all pr_debugs in scope, including any
+class'd ones. This won't be reflected in the PARAM readback value,
+but the class'd pr_debug callsites can be forced off by toggling the
+classmap-kparam all-on then all-off.
+
+Self-Testing and Validation
+===========================
+
+Dynamic debug includes a regression test script in kselftest::
+
+ :#> make -C tools/testing/selftests TARGETS=dynamic_debug run_tests
+ # Or run directly on a running kernel:
+ :#> ./tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 36/39] dyndbg: Ignore additional arguments from pr_fmt
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (34 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 35/39] docs/dyndbg: add classmap info to howto Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 37/39] dyndbg: add epilogue to dynamic_debug/control file Jim Cromie via B4 Relay
` (2 subsequent siblings)
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
Philipp Hahn
From: Philipp Hahn <phahn-oss@avm.de>
pr_fmt can be used to add a common prefix to any output from a module:
#define pr_fmt(fmt) KBUILD_MODNAME ".%s " fmt, __func__
But adding additional arguments breaks dynamic debug:
> error: macro "DEFINE_DYNAMIC_DEBUG_METADATA_CLS" passed 4 arguments, but takes just 3
> | pr_debug_ratelimited("%s", "Hello world!");
> | ^
> note: macro "DEFINE_DYNAMIC_DEBUG_METADATA_CLS" defined here
> | #define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt) \
> |
> error: ‘DEFINE_DYNAMIC_DEBUG_METADATA_CLS’ undeclared (first use in this function)
> | DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, _DPRINTK_CLASS_DFLT, fmt)
> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> note: in expansion of macro ‘DEFINE_DYNAMIC_DEBUG_METADATA’
> | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt)); \
> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> note: in expansion of macro ‘pr_debug_ratelimited’
> | pr_debug_ratelimited("%s", "Hello world!");
> | ^~~~~~~~~~~~~~~~~~~~
Add an additional ', ...' to DEFINE_DYNAMIC_DEBUG_METADATA_CLS to slurp
any additional argument, which `pr_fmt` might add.
Signed-off-by: Philipp Hahn <phahn-oss@avm.de>
[pr_fmt change on test_dynamic_debug_submod instead of parent]
Reviewed-by: Jim Cromie <jim.cromie@gmail.com>
---
include/linux/dynamic_debug.h | 2 +-
lib/test_dynamic_debug.c | 4 +-
.../selftests/dynamic_debug/dyndbg_selftest.sh | 68 +++++++++++-----------
3 files changed, 37 insertions(+), 37 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 32a34a80672b..39de59c8bac2 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -364,7 +364,7 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
dump_stack(); \
}
-#define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt) \
+#define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt, ...) \
static struct _ddebug __aligned(8) \
__section("__dyndbg_descs") name = { \
.modname = DDEBUG_MODNAME, \
diff --git a/lib/test_dynamic_debug.c b/lib/test_dynamic_debug.c
index 97f2c9e1b92b..bce0993443b4 100644
--- a/lib/test_dynamic_debug.c
+++ b/lib/test_dynamic_debug.c
@@ -23,7 +23,7 @@
* the usage clearer.
*/
#if defined(TEST_DYNAMIC_DEBUG_SUBMOD)
- #define pr_fmt(fmt) "test_dd_submod: " fmt
+ #define pr_fmt(fmt) "test_dd_submod: %s " fmt, __func__
#else
#define pr_fmt(fmt) "test_dd: " fmt
#endif
@@ -270,7 +270,7 @@ static int __init test_dynamic_debug_init(void)
static void __exit test_dynamic_debug_exit(void)
{
- pr_debug("exited\n");
+ pr_debug_ratelimited("exited\n");
}
module_init(test_dynamic_debug_init);
diff --git a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
index 25137663d554..9713b13be4e2 100755
--- a/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
+++ b/tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
@@ -691,50 +691,50 @@ function GOLDEN_RECORDS {
#K= cce9c41c3ac297e910c3ee3b10852cb3 FT_multi_query.2
#K= 8c2dd1164fbcefb721345ce62a864a37 FT_multi_query.3
#K= 4542e1e5e7eadcbe8f90a9c934635618 FT_multi_query.4
-#K= 8146f6f983c3a76783c89b78b892ed48 FT_test_classes.1
+#K= fd730021392c7d0044408f304d683c69 FT_test_classes.1
#K= a15ec4843acd721fbdfddc0b512c8032 FT_test_classes.2
#K= bc074e657d8d7f0bbc960e4dfa8de25d FT_test_classes.3
-#K= 878c5b9b20cbe8b93f2f3e92fc8b77bb FT_classmap_inheritance.1
-#K= 0eb7e891704074434646c2340ddac152 FT_classmap_inheritance.2
-#K= a6e6aab5a6cb9a792d4296b1200ba409 FT_classmap_inheritance.3
-#K= 5b6d86bcaa2477699aab655447d780dd FT_classmap_inheritance.4
-#K= f43e0aff8a4b38435b73d90ed8100d1b FT_classmap_inheritance.5
+#K= 824adca66a686b530ae8393351b16ecf FT_classmap_inheritance.1
+#K= c26dcd19a11f51322965a08e1fa5c98e FT_classmap_inheritance.2
+#K= cd150aea538ee12e9c18cafd2c95a39a FT_classmap_inheritance.3
+#K= 3aa6360c73a9509c30fff0c4f95f1607 FT_classmap_inheritance.4
+#K= 62b6803edf43519186d6185bebf34352 FT_classmap_inheritance.5
#K= 94610c57ac44bd7011002a654fd78f93 FT_modprobe_w_param.1
#K= 94610c57ac44bd7011002a654fd78f93 FT_modprobe_w_param.2
-#K= c1309e18dc9bf2f57184fa13164d917d FT_modprobe_w_param.3
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.4
-#K= a1232e658d95fbca8b23a69e9a0db965 FT_modprobe_w_param.5
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.6
-#K= af7b3d532325b1c5ab990e4b32fed577 FT_modprobe_w_param.7
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.8
+#K= 8ce6fcd5958d99524509f8ee8b337762 FT_modprobe_w_param.3
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.4
+#K= e99561131cb0877e244ded16465d17be FT_modprobe_w_param.5
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.6
+#K= a6c1e1585418e199de271b71a9746d93 FT_modprobe_w_param.7
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.8
#K= 591411c42cf52d7c4c46d76bcc345a5f FT_modprobe_w_param.9
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.10
-#K= 46d24fecc507a8f9be0bd120e27ff64f FT_modprobe_w_param.11
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.12
-#K= 79298a323d3dcca4f74fb9fc0de5a87e FT_modprobe_w_param.13
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.14
-#K= f649752dfb07a68087f04dafc00ed1e8 FT_modprobe_w_param.15
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.16
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.10
+#K= b425428024ebf309fd38ac6c67d954ef FT_modprobe_w_param.11
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.12
+#K= 35c26142670166a021b523097db2e418 FT_modprobe_w_param.13
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.14
+#K= 090cde34d0a22f90f2bba1fed561aa9c FT_modprobe_w_param.15
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.16
#K= 73a93377a823739e8aae44856a20fa7f FT_modprobe_w_param.17
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.18
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.18
#K= 10464b2c3e3972f05e93c609700f8fb2 FT_modprobe_w_param.19
#K= 10464b2c3e3972f05e93c609700f8fb2 FT_modprobe_w_param.20
-#K= 07c1f81d5a58675a291dc77acd6938c4 FT_modprobe_w_param.21
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.22
-#K= b070066b0eb13a033446bd05850b15e2 FT_modprobe_w_param.23
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.24
-#K= 32ca47823c27e629e03c21aebfc25095 FT_modprobe_w_param.25
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.26
+#K= 69502938a4be4936847568d8aad027f6 FT_modprobe_w_param.21
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.22
+#K= 51fe322a7f368d936d2292c951247b33 FT_modprobe_w_param.23
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.24
+#K= 91391932971be1d599d19ba04d6f6a34 FT_modprobe_w_param.25
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.26
#K= 7b91db8e9f160aebb1ee87fab2232404 FT_modprobe_w_param.27
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.28
-#K= d3d111da544dd5cee254e88178823b9d FT_modprobe_w_param.29
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.30
-#K= b5a30ebac06aea6e77a44322667effc7 FT_modprobe_w_param.31
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.32
-#K= bbe7b47ed089428429f4264c8cc2a066 FT_modprobe_w_param.33
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.34
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.28
+#K= 9d29af8b8039ca84138b6b030a3b2eb7 FT_modprobe_w_param.29
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.30
+#K= 2a90475b035790006963c6245334edab FT_modprobe_w_param.31
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.32
+#K= b4f6d119e4d5fea58ac3a78f6bd64540 FT_modprobe_w_param.33
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.34
#K= 3d2538bf868e71bff17c768cf118c352 FT_modprobe_w_param.35
-#K= 13c54ef65e199294fd078ba72c0cd69a FT_modprobe_w_param.36
+#K= a6dd47315e45f54d89fd2561f83b9bf0 FT_modprobe_w_param.36
EOF
# Read the K-recs and skip those for tests that can't run
while read -r line; do
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 37/39] dyndbg: add epilogue to dynamic_debug/control file
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (35 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 36/39] dyndbg: Ignore additional arguments from pr_fmt Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 38/39] dyndbg: add +c flag to count advantage of classmaps for DRM Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 39/39] dyndbg: add DEBUG-biased fallback stubs for _dynamic_func_call_cls Jim Cromie via B4 Relay
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Add an epilogue to the control-file, to allow display of statistics
etc, without disturbing the header.
NB: epilogue lines should start with "#: " to distinguish them from
lines describing pr_debugs (and from the header line). No new lines
are added here, only the place to do so.
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v9:
. update ddebug_proc_start() to return EPILOGUE_TOKEN when seeking directly to epilogue.
---
lib/dynamic_debug.c | 23 ++++++++++++++++++++---
1 file changed, 20 insertions(+), 3 deletions(-)
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index afde13a2121f..77976e7b264c 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -1159,6 +1159,9 @@ static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
* read() call from userspace. Takes the ddebug_lock and
* seeks the seq_file's iterator to the given position.
*/
+static char ddebug_epilogue_token;
+#define EPILOGUE_TOKEN (&ddebug_epilogue_token)
+
static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
{
struct ddebug_iter *iter = m->private;
@@ -1174,7 +1177,9 @@ static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
dp = ddebug_iter_first(iter);
while (dp != NULL && --n > 0)
dp = ddebug_iter_next(iter);
- return dp;
+ if (dp)
+ return dp;
+ return n == 0 ? EPILOGUE_TOKEN : NULL;
}
/*
@@ -1187,12 +1192,20 @@ static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
struct ddebug_iter *iter = m->private;
struct _ddebug *dp;
+ (*pos)++;
+
+ if (p == EPILOGUE_TOKEN)
+ return NULL;
+
if (p == SEQ_START_TOKEN)
dp = ddebug_iter_first(iter);
else
dp = ddebug_iter_next(iter);
- ++*pos;
- return dp;
+
+ if (dp)
+ return dp;
+
+ return EPILOGUE_TOKEN;
}
static bool ddebug_class_map_in_range(const int class_id, const struct ddebug_class_map *map)
@@ -1244,6 +1257,10 @@ static int ddebug_proc_show(struct seq_file *m, void *p)
"# filename:lineno [module]function flags format\n");
return 0;
}
+ if (p == EPILOGUE_TOKEN) {
+ /* use this soon */
+ return 0;
+ }
seq_printf(m, "%s:%u [%s]%s =%s \"",
trim_prefix(dp->filename), dp->lineno,
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 38/39] dyndbg: add +c flag to count advantage of classmaps for DRM
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (36 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 37/39] dyndbg: add epilogue to dynamic_debug/control file Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
2026-09-09 0:55 ` [PATCH v9 39/39] dyndbg: add DEBUG-biased fallback stubs for _dynamic_func_call_cls Jim Cromie via B4 Relay
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie
From: Jim Cromie <jim.cromie@gmail.com>
Introduce a +c flag, to increment a per-cpu counter: ddebug_count
when a flagged pr_debug() is called.
Reset the counter with:
echo reset_stats > /proc/dynamic_debug/control
and see the count value with:
tail -n1 /proc/dynamic_debug/control
#: total count: 2295401
This counter lets us count drm*dbg() callrate without doing the
printk; it counts how often upstream drm_debug_enabled() would read
main memory, evict a cache-line, and test a bit.
CONFIG_DRM_USE_DYNAMIC_DEBUG=y gives drm a per callsite static-key to
avoid that cache-line insult. On my amdgpu + nvidia laptop, thats
~3200 of them.
The benchmarks below are from a recent build running on my asus
amdgpu + nouveau laptop, using scripts from below the snip.
#> count_hits 30 hammer_vk --
Banging on: hammer_vk (&)
[1] 100847
[1]+ Done hammer_vk
#: total hits: 2295401
#> count_hits 30 hammer_vk -- DRM_UT_CORE
Banging on: hammer_vk (&)
[1] 99910
[1]+ Done hammer_vk
#: total hits: 2204406
Notably, the DRM_UT_CORE category dominates the call traffic, not
DRM_UT_VBL or any others, which contribute little extra to the above.
To see the distribution of debug categories (for vkcube load)
#> isolate_drm_hits 2> /dev/null
Starting isolation study: 10s per class using vkcube
----------------------------------------------------------
DRM CLASS | TOTAL HITS
----------------------------------------------------------
DRM_UT_CORE | 85305
DRM_UT_DRIVER | 0
DRM_UT_KMS | 1435
DRM_UT_PRIME | 0
DRM_UT_ATOMIC | 13645
DRM_UT_VBL | 4071
DRM_UT_STATE | 1780
DRM_UT_LEASE | 0
DRM_UT_DP | 0
DRM_UT_DRMRES | 0
FOO | 0
REVIEW:
In every minute, 12 vkcubes issue ~4.6M drm_debug_enabled(__drm_debug)
macro-calls. To test the bits, they all *may* go out to main memory,
though __drm_debug is ro-mostly. Still, theres significant cache-line
eviction, and potentially meaningful costs we can avoid.
With CONFIG_DRM_USE_DYNAMIC_DEBUG=y, each pr_debug call-site is
replaced by a static-key, with the off-cost of few NOOPs, avoiding all
the unpredictable downsides.
NOTES:
The +c flag invokes the callsite, but avoids the heavy syslog writing.
It is currently independent of +p, but it could be compressed into a
state-machine, and the bit recovered, but not til we need to do so.
The +c flag has no predictive quality; to count usr_dbg() callsites,
you must have reimplemnted them already with pr_debug. This just
gives DRM some numbers to consider, to balance against the work needed
o test this series.
Assisted-by: Gemini-CLI:gemini-2.5-pro
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
v9:
. add missing kfree(tmpbuf) in reset_stats handler before early return.
. sum across for_each_possible_cpu() in get_ddebug_call_count() for hotplug stability.
. update !CONFIG_JUMP_LABEL branch check to check _DPRINTK_FLAGS_ENABLED.
function ddcmd () {
local cmd="$*"
# Direct write - assume the parent script is run with 'sudo' or as root
[ -f /proc/dynamic_debug/control ] || return 1;
if ! echo "$cmd" > /proc/dynamic_debug/control 2>/tmp/dd_err; then
local ret=$?
echo "ERROR ($ret): $(cat /tmp/dd_err)" #>&2
# Check dmesg for the "!" syntax error on wk-baseline
dmesg | grep -i "dyndbg" | tail -n 2 #>&2
return $ret
fi
}
function _get_cal_count() {
if [ ! -f /proc/interrupts ]; then
echo 0
return
fi
# sum all CPU columns for any line starting with CAL:
# the awk starts at $2 to skip the label (CAL:)
# NF-2 skips the trailing text "Function call interrupts"
grep "^ *CAL:" /proc/interrupts | \
awk '{ for(i=2; i<=NF-2; i++) sum+=$i } END { print sum+0 }'
}
function wrap_cal_count() {
local cal_before
cal_before=$(_get_cal_count)
printf " wrapping: %s\n" "$*" #>&2
#time \
"$@" || return 1
local cal_after
cal_after=$(_get_cal_count)
local delta=$(( ${cal_after:-0} - ${cal_before:-0} ))
printf "Delta-CAL (IPI): %d\n" "$delta" #>&2
}
TEST_CLASSES_LIST="D2_CORE D2_DRIVER D2_KMS D2_PRIME D2_ATOMIC D2_VBL D2_STATE D2_LEASE D2_DP D2_DRMRES V0 V1 V2 V3 V4 V5 V6 V7"
DRM_CLASSES_LIST="DRM_UT_CORE DRM_UT_DRIVER DRM_UT_KMS DRM_UT_PRIME DRM_UT_ATOMIC DRM_UT_VBL DRM_UT_STATE DRM_UT_LEASE DRM_UT_DP DRM_UT_DRMRES"
function dd_setup_() {
local flags="${1:-+p}"
# Use $2 if provided, otherwise fallback to the full list
local CLASSES_LIST="$2"
local q=""
local C
# Safeguard: if list is empty, don't do anything
[[ -z "$CLASSES_LIST" ]] && echo "no classes!" && return 0
for C in $CLASSES_LIST; do
q+="class $C $flags ; "
done
#echo "sending: $q"
ddcmd "$q"
}
function dd_setup_test() {
modprobe test_dynamic_debug || return 1
dd_setup_ $1 "${2:-$TEST_CLASSES_LIST}"
}
function dd_setup_drm() {
dd_setup_ $1 "${2:-$DRM_CLASSES_LIST}"
}
function count_hits() {
local duration=60
[[ "$1" =~ ^[0-9]+$ ]] && { duration=$1; shift; }
local cmd_to_run=()
local custom_classes=""
while [[ $# -gt 0 ]]; do
if [[ "$1" == "--" ]]; then
shift
custom_classes="$*"
break
fi
cmd_to_run+=("$1")
shift
done
ddcmd reset_stats
dd_setup_drm "+c" "$custom_classes"
if [[ ${#cmd_to_run[@]} -gt 0 ]]; then
echo "Banging on: ${cmd_to_run[*]} (&)"
# Use eval so bash functions work
eval "${cmd_to_run[*]} &"
local cmd_pid=$!
sleep "$duration"
killall vkcube 2>/dev/null
kill "$cmd_pid" 2>/dev/null
else
sleep "$duration"
fi
dd_setup_drm "-c" "$custom_classes"
tail -n1 /proc/dynamic_debug/control
}
function hammer_vk() {
for i in {1..12}; do vkcube >/dev/null 2>&1 & done
}
function isolate_drm_hits() {
local duration=${1:-10}
local cmd=${2:-vkcube}
echo "Starting isolation study: ${duration}s per class using ${cmd}"
echo "----------------------------------------------------------"
printf "%-20s | %-10s\n" "DRM CLASS" "TOTAL HITS"
echo "----------------------------------------------------------"
for class in $DRM_CLASSES_LIST FOO; do
# Run count_hits for the specific class
# Use 'capture' logic to grab only the hit count from the tail output
result=$(count_hits "$duration" "$cmd" -- "$class" | grep "total hits" | awk '{print $NF}')
printf "%-20s | %-10s\n" "$class" "$result"
done
#result=$(count_hits "$duration" "$cmd" -- "FOO" | grep "total hits" | awk '{print $NF}')
#printf "%-20s | %-10s\n" "$class" "$result"
}
[ $SHLVL == 2 -a -n "$*" ] && echo " doing: $* in $PWD" #>&2
if [ $SHLVL == 2 ]; then
# run args as cmd
$@
fi
---
include/linux/dynamic_debug.h | 29 +++++++++++++++++++++++------
lib/dynamic_debug.c | 41 +++++++++++++++++++++++++++++++++++++----
2 files changed, 60 insertions(+), 10 deletions(-)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 39de59c8bac2..064df695b3a4 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -56,6 +56,10 @@ struct _ddebug {
#define _DPRINTK_FLAGS_INCL_TID (1<<4)
#define _DPRINTK_FLAGS_INCL_SOURCENAME (1<<5)
#define _DPRINTK_FLAGS_INCL_STACK (1<<6)
+#define _DPRINTK_FLAGS_COUNT (1<<7)
+
+#define _DPRINTK_FLAGS_ENABLED (_DPRINTK_FLAGS_PRINT | _DPRINTK_FLAGS_COUNT)
+#define _DPRINTK_FLAGS_ACTIVE (_DPRINTK_FLAGS_PRINT)
#define _DPRINTK_FLAGS_INCL_ANY \
(_DPRINTK_FLAGS_INCL_MODNAME | _DPRINTK_FLAGS_INCL_FUNCNAME |\
@@ -403,14 +407,20 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#ifdef DEBUG
#define DYNAMIC_DEBUG_BRANCH(descriptor) \
- likely(descriptor.flags & _DPRINTK_FLAGS_PRINT)
+ likely(descriptor.flags & _DPRINTK_FLAGS_ENABLED)
#else
#define DYNAMIC_DEBUG_BRANCH(descriptor) \
- unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)
+ unlikely(descriptor.flags & _DPRINTK_FLAGS_ENABLED)
#endif
#endif /* CONFIG_JUMP_LABEL */
+void ddebug_increment_call_count(void);
+#define DYNAMIC_DEBUG_COUNT(descriptor) { \
+ if (unlikely(descriptor.flags & _DPRINTK_FLAGS_COUNT)) \
+ ddebug_increment_call_count(); \
+ }
+
/*
* Factory macros: ($prefix)dynamic_func_call($suffix)
*
@@ -422,11 +432,15 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
* (|_cls): adds in _DPRINT_CLASS_DFLT as needed
* (|_no_desc): former gets callsite descriptor as 1st arg (for prdbgs)
*/
+
#define __dynamic_func_call_cls(id, cls, fmt, func, ...) do { \
DEFINE_DYNAMIC_DEBUG_METADATA_CLS(id, cls, fmt); \
if (DYNAMIC_DEBUG_BRANCH(id)) { \
- func(&id, ##__VA_ARGS__); \
- __dynamic_dump_stack(id); \
+ DYNAMIC_DEBUG_COUNT(id); \
+ if (id.flags & _DPRINTK_FLAGS_ACTIVE) { \
+ func(&id, ##__VA_ARGS__); \
+ __dynamic_dump_stack(id); \
+ } \
} \
} while (0)
#define __dynamic_func_call(id, fmt, func, ...) \
@@ -436,8 +450,11 @@ void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
#define __dynamic_func_call_cls_no_desc(id, cls, fmt, func, ...) do { \
DEFINE_DYNAMIC_DEBUG_METADATA_CLS(id, cls, fmt); \
if (DYNAMIC_DEBUG_BRANCH(id)) { \
- func(__VA_ARGS__); \
- __dynamic_dump_stack(id); \
+ DYNAMIC_DEBUG_COUNT(id); \
+ if (id.flags & _DPRINTK_FLAGS_ACTIVE) { \
+ func(__VA_ARGS__); \
+ __dynamic_dump_stack(id); \
+ } \
} \
} while (0)
#define __dynamic_func_call_no_desc(id, fmt, func, ...) \
diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
index 77976e7b264c..9fa1a6e3afe6 100644
--- a/lib/dynamic_debug.c
+++ b/lib/dynamic_debug.c
@@ -19,12 +19,14 @@
#include <linux/kallsyms.h>
#include <linux/types.h>
#include <linux/mutex.h>
+#include <linux/percpu.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/list.h>
#include <linux/sysctl.h>
#include <linux/ctype.h>
#include <linux/string.h>
+
#include <linux/parser.h>
#include <linux/string_helpers.h>
#include <linux/uaccess.h>
@@ -71,6 +73,13 @@ struct flag_settings {
unsigned int mask;
};
+static DEFINE_PER_CPU(unsigned long, ddebug_call_count);
+void ddebug_increment_call_count(void)
+{
+ this_cpu_inc(ddebug_call_count);
+}
+EXPORT_SYMBOL(ddebug_increment_call_count);
+
static bool ddebug_class_map_in_range(const int class_id,
const struct ddebug_class_map *map);
static bool ddebug_class_user_in_range(const int class_id,
@@ -101,6 +110,7 @@ static const struct { unsigned flag:8; char opt_char; } opt_array[] = {
{ _DPRINTK_FLAGS_INCL_LINENO, 'l' },
{ _DPRINTK_FLAGS_INCL_TID, 't' },
{ _DPRINTK_FLAGS_INCL_STACK, 'd' },
+ { _DPRINTK_FLAGS_COUNT, 'c' },
{ _DPRINTK_FLAGS_NONE, '_' },
};
@@ -365,10 +375,10 @@ static int ddebug_change(const struct ddebug_query *query, struct flag_settings
if (newflags == dp->flags)
continue;
#ifdef CONFIG_JUMP_LABEL
- if (dp->flags & _DPRINTK_FLAGS_PRINT) {
- if (!(newflags & _DPRINTK_FLAGS_PRINT))
+ if (dp->flags & _DPRINTK_FLAGS_ENABLED) {
+ if (!(newflags & _DPRINTK_FLAGS_ENABLED))
static_branch_disable(&dp->key.dd_key_true);
- } else if (newflags & _DPRINTK_FLAGS_PRINT) {
+ } else if (newflags & _DPRINTK_FLAGS_ENABLED) {
static_branch_enable(&dp->key.dd_key_true);
}
#endif
@@ -1082,6 +1092,14 @@ static __init int dyndbg_setup(char *str)
__setup("dyndbg=", dyndbg_setup);
+static void reset_ddebug_call_count(void)
+{
+ int cpu;
+
+ for_each_possible_cpu(cpu)
+ per_cpu(ddebug_call_count, cpu) = 0;
+}
+
/*
* File_ops->write method for <debugfs>/dynamic_debug/control. Gathers the
* command text from userspace, parses and executes it.
@@ -1104,6 +1122,11 @@ static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
return PTR_ERR(tmpbuf);
v2pr_info("read %zu bytes from userspace\n", len);
+ if (len >= 11 && !strncmp(tmpbuf, "reset_stats", 11)) {
+ reset_ddebug_call_count();
+ kfree(tmpbuf);
+ return len;
+ }
ret = ddebug_exec_queries(tmpbuf, NULL);
kfree(tmpbuf);
if (ret < 0)
@@ -1239,6 +1262,16 @@ static const char *ddebug_class_name(struct _ddebug_info *di, struct _ddebug *dp
return NULL;
}
+static unsigned long get_ddebug_call_count(void)
+{
+ unsigned long total = 0;
+ int cpu;
+
+ for_each_possible_cpu(cpu)
+ total += per_cpu(ddebug_call_count, cpu);
+ return total;
+}
+
/*
* Seq_ops show method. Called several times within a read()
* call from userspace, with ddebug_lock held. Formats the
@@ -1258,7 +1291,7 @@ static int ddebug_proc_show(struct seq_file *m, void *p)
return 0;
}
if (p == EPILOGUE_TOKEN) {
- /* use this soon */
+ seq_printf(m, "#: total call-counts: %lu\n", get_ddebug_call_count());
return 0;
}
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread* [PATCH v9 39/39] dyndbg: add DEBUG-biased fallback stubs for _dynamic_func_call_cls
2026-09-09 0:54 [PATCH v9 00/39] dyndbg: fix classmaps API for subsystems, query extensions, and selftests Jim Cromie via B4 Relay
` (37 preceding siblings ...)
2026-09-09 0:55 ` [PATCH v9 38/39] dyndbg: add +c flag to count advantage of classmaps for DRM Jim Cromie via B4 Relay
@ 2026-09-09 0:55 ` Jim Cromie via B4 Relay
38 siblings, 0 replies; 42+ messages in thread
From: Jim Cromie via B4 Relay @ 2026-09-09 0:55 UTC (permalink / raw)
To: Jason Baron, Shuah Khan, Andrew Morton, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Arnd Bergmann, Luis Chamberlain, Petr Pavlu, Daniel Gomez,
Sami Tolvanen, Aaron Tomlin, Jonathan Corbet, Greg Kroah-Hartman,
Nathan Chancellor, Nicolas Schier, Shuah Khan, Randy Dunlap,
Rafael J. Wysocki, Pavel Machek, Len Brown
Cc: linux-kernel, linux-kselftest, dri-devel, linux-arch,
linux-modules, linux-doc, linux-kbuild, linux-pm, Jim Cromie,
kernel test robot
From: Jim Cromie <jim.cromie@gmail.com>
When the dynamic debug core is enabled (CONFIG_DYNAMIC_DEBUG_CORE=y) but
the global CONFIG_DYNAMIC_DEBUG is disabled, subsystems can opt-in to
dynamic debug by defining DYNAMIC_DEBUG_MODULE.
However, for built-in code (like DRM core) where DYNAMIC_DEBUG_MODULE
is not defined, the macros fall back to the disabled #else block in
include/linux/dynamic_debug.h.
In this block, the family of _dynamic_func_call_cls macros were
completely undefined. This caused build failures (implicit declarations)
in subsystems (like DRM) that attempt to use these macros to wrap their
own debug functions even when dynamic debug is disabled.
Add stub definitions that mirror the enabled behavior and respect the
DEBUG macro, similar to pr_debug. If DEBUG is defined, they inject NULL
as the first argument (to satisfy the expected descriptor pointer) and
pass the arguments through, allowing the wrapped function's own slow-path
fallback logic to execute. If DEBUG is not defined, they use an if (0)
statement-expression to compile out the call while returning 0, achieving
zero overhead while maintaining compile-time argument checking.
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202605201408.x1sHT6fx-lkp@intel.com/
Assisted-by: Gemini-CLI:gemini-2.5-pro
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
include/linux/dynamic_debug.h | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/include/linux/dynamic_debug.h b/include/linux/dynamic_debug.h
index 064df695b3a4..a04e8aeca000 100644
--- a/include/linux/dynamic_debug.h
+++ b/include/linux/dynamic_debug.h
@@ -541,6 +541,23 @@ void ddebug_increment_call_count(void);
#define DYNAMIC_DEBUG_BRANCH(descriptor) false
#define DECLARE_DYNDBG_CLASSMAP(...)
+#if defined(DEBUG)
+#define _dynamic_func_call_cls(cls, fmt, func, ...) \
+ do { func(NULL, ##__VA_ARGS__); } while (0)
+#define _dynamic_func_call_cls_no_desc(cls, fmt, func, ...) \
+ do { func(__VA_ARGS__); } while (0)
+#else
+#define _dynamic_func_call_cls(cls, fmt, func, ...) \
+ do { if (0) func(NULL, ##__VA_ARGS__); } while (0)
+#define _dynamic_func_call_cls_no_desc(cls, fmt, func, ...) \
+ do { if (0) func(__VA_ARGS__); } while (0)
+#endif
+
+#define _dynamic_func_call(fmt, func, ...) \
+ _dynamic_func_call_cls(_DPRINTK_CLASS_DFLT, fmt, func, ##__VA_ARGS__)
+#define _dynamic_func_call_no_desc(fmt, func, ...) \
+ _dynamic_func_call_cls_no_desc(_DPRINTK_CLASS_DFLT, fmt, func, ##__VA_ARGS__)
+
#define dynamic_pr_debug(fmt, ...) \
no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#define dynamic_dev_dbg(dev, fmt, ...) \
--
2.55.0
^ permalink raw reply related [flat|nested] 42+ messages in thread