Skip to content

dyndbg: fix dynamic-debug regression in DRM

Jim Cromie dri-devel linux-doc lkml 3 versions – New

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v8 Latest31 patches 0 repliesNew
  2. v731 patches 0 repliesSuperseded
  3. v631 patches 22 repliesSuperseded

Patches in v8 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/31dyndbg: factor ddebug_match_desc out from ddebug_changelib/dynamic_debug.c+47 -360 replies
2/31dyndbg: add stub macro for DECLARE_DYNDBG_CLASSMAPinclude/linux/dynamic_debug.h+22 -210 replies
3/31docs/dyndbg: update examples \012 to \nDocumentation/admin-guide/dynamic-debug-howto.rst+10 -100 replies
4/31docs/dyndbg: explain flags parse 1stDocumentation/admin-guide/dynamic-debug-howto.rst+13 -40 replies
5/31test-dyndbg: fixup CLASSMAP usage errorlib/test_dynamic_debug.c+1 -10 replies
6/31dyndbg: reword "class unknown," to "class:_UNKNOWN_"lib/dynamic_debug.c+1 -10 replies
7/31dyndbg: make ddebug_class_param union members same sizeinclude/linux/dynamic_debug.h lib/dynamic_debug.c+2 -20 replies
8/31dyndbg: drop NUM_TYPE_ARRAYinclude/linux/dynamic_debug.h+1 -30 replies
9/31dyndbg: tweak pr_fmt to avoid expansion conflictslib/dynamic_debug.c+1 -10 replies
10/31dyndbg: reduce verbose/debug clutterlib/dynamic_debug.c+6 -150 replies
11/31dyndbg: refactor param_set_dyndbg_classes and belowlib/dynamic_debug.c+40 -250 replies
12/31dyndbg: tighten fn-sig of ddebug_apply_class_bitmaplib/dynamic_debug.c+11 -100 replies
13/31dyndbg: replace classmap list with a vectorinclude/linux/dynamic_debug.h lib/dynamic_debug.c+32 -310 replies
14/31dyndbg: macrofy a 2-index for-loop patternlib/dynamic_debug.c+24 -30 replies
15/31dyndbg,module: make proper substructs in _ddebug_infoinclude/asm-generic/vmlinux.lds.h include/linux/dynamic_debug.h kernel/module/main.c +2 more+100 -870 replies
16/31dyndbg: hoist classmap-filter-by-modname up to ddebug_add_modulelib/dynamic_debug.c+33 -240 replies
17/31dyndbg: move mod_name down from struct ddebug_table to _ddebug_infoinclude/linux/dynamic_debug.h lib/dynamic_debug.c+27 -240 replies
18/31dyndbg-API: remove DD_CLASS_TYPE_(DISJOINT|LEVEL)_NAMES and codeinclude/linux/dynamic_debug.h lib/dynamic_debug.c lib/test_dynamic_debug.c+14 -1370 replies
19/31selftests-dyndbg: add a dynamic_debug run_tests targetMAINTAINERS tools/testing/selftests/Makefile tools/testing/selftests/dynamic_debug/Makefile +2 more+275 -00 replies
20/31dyndbg: change __dynamic_func_call_cls* macros into expressionsinclude/linux/dynamic_debug.h+4 -40 replies
21/31dyndbg-API: replace DECLARE_DYNDBG_CLASSMAPMAINTAINERS include/asm-generic/vmlinux.lds.h include/linux/dynamic_debug.h +6 more+412 -790 replies
22/31dyndbg: detect class_id reservation conflictslib/dynamic_debug.c lib/test_dynamic_debug.c+18 -00 replies
23/31dyndbg: check DYNAMIC_DEBUG_CLASSMAP_DEFINE args at compile-timeinclude/linux/dynamic_debug.h lib/test_dynamic_debug.c+21 -10 replies
24/31dyndbg-test: change do_prints testpoint to accept a loopctlib/test_dynamic_debug.c+21 -110 replies
25/31dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to APIinclude/linux/dynamic_debug.h lib/dynamic_debug.c lib/test_dynamic_debug.c +1 more+106 -500 replies
26/31dyndbg: treat comma as a token separatorDocumentation/admin-guide/dynamic-debug-howto.rst lib/dynamic_debug.c tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh+39 -80 replies
27/31dyndbg: split multi-query strings with %Documentation/admin-guide/dynamic-debug-howto.rst lib/dynamic_debug.c tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh+30 -40 replies
28/31selftests-dyndbg: add test_mod_submodtools/testing/selftests/dynamic_debug/dyndbg_selftest.sh+73 -00 replies
29/31dyndbg: resolve "protection" of class'd pr_debuginclude/linux/dynamic_debug.h lib/dynamic_debug.c+110 -310 replies
30/31dyndbg: add DYNAMIC_DEBUG_CLASSMAP_USE_(dd_class_name, offset)include/linux/dynamic_debug.h lib/dynamic_debug.c+34 -120 replies
31/31docs/dyndbg: add classmap info to howtoDocumentation/admin-guide/dynamic-debug-howto.rst+123 -120 replies

Reviews trailers per patch

15 of 31 patches have a Reviewed-by or Acked-by.

PatchLouis Chauvet
1/31
2/31
3/31R-b T-b
4/31R-b
5/31R-b T-b
6/31R-b
7/31R-b
8/31R-b
9/31R-b
10/31R-b
11/31R-b
12/31R-b
13/31R-b
14/31
15/31
16/31
17/31R-b
18/31
19/31
20/31R-b
21/31
22/31
23/31
24/31
25/31
26/31
27/31R-b
28/31R-b
29/31
30/31
31/31

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v8 thread

Cover letter [PATCH v8 00/31] dyndbg: fix dynamic-debug regression in DRM

commit aad0214f3026 ("dyndbg: add DECLARE_DYNDBG_CLASSMAP macro")

added dyndbg's "classmaps" feature, which brought dyndbg's 0-off-cost debug to DRM. Dyndbg wired to /sys/module/drm/parameters/debug, mapped its bits to classes named "DRM_UT_*", and effected the callsite enablements only on updates to the sys-node (and underlying >control).

Sadly, it hit a CI failure, resulting in:
commit bb2ff6c27bc9 ("drm: Disable dynamic debug as broken")

The regression was that drivers, when modprobed, did not get the drm.debug=0xff turn-on action, because that had already been done for drm.ko itself.

The core design bug is in the DECLARE_DYNDBG_CLASSMAP macro. Its use in both drm.ko (ie core) and all drivers.ko meant that they couldn't fundamentally distinguish their respective roles. They each "re-defined" the classmap separately, breaking K&R-101.

My ad-hoc test scripting helped to hide the error from me, by 1st testing various combos of boot-time module.dyndbg=... and drm.debug=... configurations, and then inadvertently relying upon those initializations.

This series addresses both failings:

It replaces DECLARE_DYNDBG_CLASSMAP with

- DYNAMIC_DEBUG_CLASSMAP_DEFINE: Used by core modules (e.g., drm.ko) to define their classmaps. Based upon DECLARE, it exports the classmap so USE can use it.

- DYNAMIC_DEBUG_CLASSMAP_USE: this lets other "subsystem" users create a linkage to the classmap defined elsewhere (ie drm.ko). These users can then find their "parent" and apply its settings.

It adds a selftest script, and a 2nd "sub-module" to recapitulate DRM's multi-module "subsystem" use-case, including the specific failure scenario.

It also adds minor parsing enhancements, allowing easier construction of multi-part debug configurations. These enhancements are used to test classmaps in particular, but are not otherwize required.

v7 added:
. WARN_ONCE when classmap isn't found for a class'd callsite, JBaron . reorder macro args to match kdoc, JBaron
. Doc formatting fixes, by Bagas

v8 adds:
. CC's for tools/testing, DRM, others
. p21: change _ddebug_class_user.base name to offset, for p30 . p30: amend commit-msg to explain untested, speculative nature

Thank you for your review(s) and/or Tested-by:s

P.S. Id also like to "tease" some follow-on work:

1. DRM adaptation patches, tested on my HW/boxes.

2. patchset to send pr_debugs to tracefs on +T flag

allows 63 "private" tracebufs, 1 "common" one (at 0) "drm.debug_2trace=0x1ff" is possible
from Lukasz Bartosik

NB: the private tracebufs allow test scripts to verify log content, not just counts of changed pr_debugs.

3. patchset to save 40% of dyndbg's memory footprint

move (modname,filename,function) to struct _ddebug_site save their values & descriptor intervals to 3 maple-trees add 3 accessors to fetch on descriptor, from trees move __dyndbg_sites __section to INIT_DATA.

NB: Despite the new accessors, cat control is just as fast.

Cc Greg Kroah-Hartman <[email protected]>
Cc Jason Baron <[email protected]>
Cc Łukasz Bartosik <[email protected]>
Cc Louis Chauvet <[email protected]>
Cc Bagas Sanjaya <[email protected]>
Cc Dave Airlie <[email protected]>
Cc Daniel Vetter <[email protected]>
Cc Maarten Lankhorst <[email protected]>
Cc Maxime Ripard <[email protected]>
Cc Thomas Zimmermann <[email protected]>
Cc Petr Mladek <[email protected]>
Cc Shuah Khan <[email protected]>
Cc Steven Rostedt <[email protected]> (ftrace/logging tease)
Cc Liam R. Howlett <[email protected]> (maple-tree tease)

Jim Cromie (31):

fixes, cleanups, simple stuff::

dyndbg: factor ddebug_match_desc out from ddebug_change
dyndbg: add stub macro for DECLARE_DYNDBG_CLASSMAP docs/dyndbg: update examples \012 to \n docs/dyndbg: explain flags parse 1st
test-dyndbg: fixup CLASSMAP usage error
dyndbg: reword "class unknown," to "class:_UNKNOWN_"
dyndbg: make ddebug_class_param union members same size
dyndbg: drop NUM_TYPE_ARRAY
dyndbg: tweak pr_fmt to avoid expansion conflicts
dyndbg: reduce verbose/debug clutter

callchain grooming, re-structs, code simplify/dedup by macros::

dyndbg: refactor param_set_dyndbg_classes and below
dyndbg: tighten fn-sig of ddebug_apply_class_bitmap
dyndbg: replace classmap list with a vector
dyndbg: macrofy a 2-index for-loop pattern dyndbg,module: make proper substructs in _ddebug_info
dyndbg: hoist classmap-filter-by-modname up to ddebug_add_module
dyndbg: move mod_name down from struct ddebug_table to _ddebug_info
dyndbg-API: remove DD_CLASS_TYPE_(DISJOINT|LEVEL)_NAMES and code
selftests-dyndbg: add a dynamic_debug run_tests target
dyndbg: change __dynamic_func_call_cls* macros into expressions

core fix, detect api misuse errors, etc::

dyndbg-API: replace DECLARE_DYNDBG_CLASSMAP
dyndbg: detect class_id reservation conflicts
dyndbg: check DYNAMIC_DEBUG_CLASSMAP_DEFINE args at compile-time
dyndbg-test: change do_prints testpoint to accept a loopct
dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API
dyndbg: treat comma as a token separator
dyndbg: split multi-query strings with %
selftests-dyndbg: add test_mod_submod
dyndbg: resolve "protection" of class'd pr_debug
dyndbg: add DYNAMIC_DEBUG_CLASSMAP_USE_(dd_class_name, offset) docs/dyndbg: add classmap info to howto

Jim Cromie (31):
dyndbg: factor ddebug_match_desc out from ddebug_change
dyndbg: add stub macro for DECLARE_DYNDBG_CLASSMAP docs/dyndbg: update examples \012 to \n
docs/dyndbg: explain flags parse 1st
test-dyndbg: fixup CLASSMAP usage error
dyndbg: reword "class unknown," to "class:_UNKNOWN_"
dyndbg: make ddebug_class_param union members same size
dyndbg: drop NUM_TYPE_ARRAY
dyndbg: tweak pr_fmt to avoid expansion conflicts
dyndbg: reduce verbose/debug clutter
dyndbg: refactor param_set_dyndbg_classes and below
dyndbg: tighten fn-sig of ddebug_apply_class_bitmap
dyndbg: replace classmap list with a vector
dyndbg: macrofy a 2-index for-loop pattern dyndbg,module: make proper substructs in _ddebug_info
dyndbg: hoist classmap-filter-by-modname up to ddebug_add_module
dyndbg: move mod_name down from struct ddebug_table to _ddebug_info
dyndbg-API: remove DD_CLASS_TYPE_(DISJOINT|LEVEL)_NAMES and code
selftests-dyndbg: add a dynamic_debug run_tests target
dyndbg: change __dynamic_func_call_cls* macros into expressions
dyndbg-API: replace DECLARE_DYNDBG_CLASSMAP
dyndbg: detect class_id reservation conflicts
dyndbg: check DYNAMIC_DEBUG_CLASSMAP_DEFINE args at compile-time
dyndbg-test: change do_prints testpoint to accept a loopct
dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API
dyndbg: treat comma as a token separator
dyndbg: split multi-query strings with %
selftests-dyndbg: add test_mod_submod
dyndbg: resolve "protection" of class'd pr_debug
dyndbg: add DYNAMIC_DEBUG_CLASSMAP_USE_(dd_class_name, offset) docs/dyndbg: add classmap info to howto

 .../admin-guide/dynamic-debug-howto.rst       | 187 ++++-
 MAINTAINERS                                   |   3 +-
 include/asm-generic/vmlinux.lds.h             |   5 +-
 include/linux/dynamic_debug.h                 | 302 +++++--
 kernel/module/main.c                          |  15 +-
 lib/Kconfig.debug                             |  24 +-
 lib/Makefile                                  |   5 +
 lib/dynamic_debug.c                           | 776 +++++++++++-------
 lib/test_dynamic_debug.c                      | 198 +++--
 lib/test_dynamic_debug_submod.c               |  21 +
 tools/testing/selftests/Makefile              |   1 +
 .../testing/selftests/dynamic_debug/Makefile  |   9 +
 tools/testing/selftests/dynamic_debug/config  |   7 +
 .../dynamic_debug/dyndbg_selftest.sh          | 373 +++++++++
 14 files changed, 1465 insertions(+), 461 deletions(-)
 create mode 100644 lib/test_dynamic_debug_submod.c
 create mode 100644 tools/testing/selftests/dynamic_debug/Makefile
 create mode 100644 tools/testing/selftests/dynamic_debug/config
 create mode 100755 tools/testing/selftests/dynamic_debug/dyndbg_selftest.sh
Signature · 1 line
2.52.0