Loading...
1Dynamic debug
2+++++++++++++
3
4
5Introduction
6============
7
8Dynamic debug allows you to dynamically enable/disable kernel
9debug-print code to obtain additional kernel information.
10
11If ``/proc/dynamic_debug/control`` exists, your kernel has dynamic
12debug. You'll need root access (sudo su) to use this.
13
14Dynamic debug provides:
15
16 * a Catalog of all *prdbgs* in your kernel.
17 ``cat /proc/dynamic_debug/control`` to see them.
18
19 * a Simple query/command language to alter *prdbgs* by selecting on
20 any combination of 0 or 1 of:
21
22 - source filename
23 - function name
24 - line number (including ranges of line numbers)
25 - module name
26 - format string
27 - class name (as known/declared by each module)
28
29NOTE: To actually get the debug-print output on the console, you may
30need to adjust the kernel ``loglevel=``, or use ``ignore_loglevel``.
31Read about these kernel parameters in
32Documentation/admin-guide/kernel-parameters.rst.
33
34Viewing Dynamic Debug Behaviour
35===============================
36
37You can view the currently configured behaviour in the *prdbg* catalog::
38
39 :#> head -n7 /proc/dynamic_debug/control
40 # filename:lineno [module]function flags format
41 init/main.c:1179 [main]initcall_blacklist =_ "blacklisting initcall %s\012
42 init/main.c:1218 [main]initcall_blacklisted =_ "initcall %s blacklisted\012"
43 init/main.c:1424 [main]run_init_process =_ " with arguments:\012"
44 init/main.c:1426 [main]run_init_process =_ " %s\012"
45 init/main.c:1427 [main]run_init_process =_ " with environment:\012"
46 init/main.c:1429 [main]run_init_process =_ " %s\012"
47
48The 3rd space-delimited column shows the current flags, preceded by
49a ``=`` for easy use with grep/cut. ``=p`` shows enabled callsites.
50
51Controlling dynamic debug Behaviour
52===================================
53
54The behaviour of *prdbg* sites are controlled by writing
55query/commands to the control file. Example::
56
57 # grease the interface
58 :#> alias ddcmd='echo $* > /proc/dynamic_debug/control'
59
60 :#> ddcmd '-p; module main func run* +p'
61 :#> grep =p /proc/dynamic_debug/control
62 init/main.c:1424 [main]run_init_process =p " with arguments:\012"
63 init/main.c:1426 [main]run_init_process =p " %s\012"
64 init/main.c:1427 [main]run_init_process =p " with environment:\012"
65 init/main.c:1429 [main]run_init_process =p " %s\012"
66
67Error messages go to console/syslog::
68
69 :#> ddcmd mode foo +p
70 dyndbg: unknown keyword "mode"
71 dyndbg: query parse failed
72 bash: echo: write error: Invalid argument
73
74If debugfs is also enabled and mounted, ``dynamic_debug/control`` is
75also under the mount-dir, typically ``/sys/kernel/debug/``.
76
77Command Language Reference
78==========================
79
80At the basic lexical level, a command is a sequence of words separated
81by spaces or tabs. So these are all equivalent::
82
83 :#> ddcmd file svcsock.c line 1603 +p
84 :#> ddcmd "file svcsock.c line 1603 +p"
85 :#> ddcmd ' file svcsock.c line 1603 +p '
86
87Command submissions are bounded by a write() system call.
88Multiple commands can be written together, separated by ``;`` or ``\n``::
89
90 :#> ddcmd "func pnpacpi_get_resources +p; func pnp_assign_mem +p"
91 :#> ddcmd <<"EOC"
92 func pnpacpi_get_resources +p
93 func pnp_assign_mem +p
94 EOC
95 :#> cat query-batch-file > /proc/dynamic_debug/control
96
97You can also use wildcards in each query term. The match rule supports
98``*`` (matches zero or more characters) and ``?`` (matches exactly one
99character). For example, you can match all usb drivers::
100
101 :#> ddcmd file "drivers/usb/*" +p # "" to suppress shell expansion
102
103Syntactically, a command is pairs of keyword values, followed by a
104flags change or setting::
105
106 command ::= match-spec* flags-spec
107
108The match-spec's select *prdbgs* from the catalog, upon which to apply
109the flags-spec, all constraints are ANDed together. An absent keyword
110is the same as keyword "*".
111
112
113A match specification is a keyword, which selects the attribute of
114the callsite to be compared, and a value to compare against. Possible
115keywords are:::
116
117 match-spec ::= 'func' string |
118 'file' string |
119 'module' string |
120 'format' string |
121 'class' string |
122 'line' line-range
123
124 line-range ::= lineno |
125 '-'lineno |
126 lineno'-' |
127 lineno'-'lineno
128
129 lineno ::= unsigned-int
130
131.. note::
132
133 ``line-range`` cannot contain space, e.g.
134 "1-30" is valid range but "1 - 30" is not.
135
136
137The meanings of each keyword are:
138
139func
140 The given string is compared against the function name
141 of each callsite. Example::
142
143 func svc_tcp_accept
144 func *recv* # in rfcomm, bluetooth, ping, tcp
145
146file
147 The given string is compared against either the src-root relative
148 pathname, or the basename of the source file of each callsite.
149 Examples::
150
151 file svcsock.c
152 file kernel/freezer.c # ie column 1 of control file
153 file drivers/usb/* # all callsites under it
154 file inode.c:start_* # parse :tail as a func (above)
155 file inode.c:1-100 # parse :tail as a line-range (above)
156
157module
158 The given string is compared against the module name
159 of each callsite. The module name is the string as
160 seen in ``lsmod``, i.e. without the directory or the ``.ko``
161 suffix and with ``-`` changed to ``_``. Examples::
162
163 module sunrpc
164 module nfsd
165 module drm* # both drm, drm_kms_helper
166
167format
168 The given string is searched for in the dynamic debug format
169 string. Note that the string does not need to match the
170 entire format, only some part. Whitespace and other
171 special characters can be escaped using C octal character
172 escape ``\ooo`` notation, e.g. the space character is ``\040``.
173 Alternatively, the string can be enclosed in double quote
174 characters (``"``) or single quote characters (``'``).
175 Examples::
176
177 format svcrdma: // many of the NFS/RDMA server pr_debugs
178 format readahead // some pr_debugs in the readahead cache
179 format nfsd:\040SETATTR // one way to match a format with whitespace
180 format "nfsd: SETATTR" // a neater way to match a format with whitespace
181 format 'nfsd: SETATTR' // yet another way to match a format with whitespace
182
183class
184 The given class_name is validated against each module, which may
185 have declared a list of known class_names. If the class_name is
186 found for a module, callsite & class matching and adjustment
187 proceeds. Examples::
188
189 class DRM_UT_KMS # a DRM.debug category
190 class JUNK # silent non-match
191 // class TLD_* # NOTICE: no wildcard in class names
192
193line
194 The given line number or range of line numbers is compared
195 against the line number of each ``pr_debug()`` callsite. A single
196 line number matches the callsite line number exactly. A
197 range of line numbers matches any callsite between the first
198 and last line number inclusive. An empty first number means
199 the first line in the file, an empty last line number means the
200 last line number in the file. Examples::
201
202 line 1603 // exactly line 1603
203 line 1600-1605 // the six lines from line 1600 to line 1605
204 line -1605 // the 1605 lines from line 1 to line 1605
205 line 1600- // all lines from line 1600 to the end of the file
206
207The flags specification comprises a change operation followed
208by one or more flag characters. The change operation is one
209of the characters::
210
211 - remove the given flags
212 + add the given flags
213 = set the flags to the given flags
214
215The flags are::
216
217 p enables the pr_debug() callsite.
218 _ enables no flags.
219
220 Decorator flags add to the message-prefix, in order:
221 t Include thread ID, or <intr>
222 m Include module name
223 f Include the function name
224 s Include the source file name
225 l Include line number
226
227For ``print_hex_dump_debug()`` and ``print_hex_dump_bytes()``, only
228the ``p`` flag has meaning, other flags are ignored.
229
230Note the regexp ``^[-+=][fslmpt_]+$`` matches a flags specification.
231To clear all flags at once, use ``=_`` or ``-fslmpt``.
232
233
234Debug messages during Boot Process
235==================================
236
237To activate debug messages for core code and built-in modules during
238the boot process, even before userspace and debugfs exists, use
239``dyndbg="QUERY"`` or ``module.dyndbg="QUERY"``. QUERY follows
240the syntax described above, but must not exceed 1023 characters. Your
241bootloader may impose lower limits.
242
243These ``dyndbg`` params are processed just after the ddebug tables are
244processed, as part of the early_initcall. Thus you can enable debug
245messages in all code run after this early_initcall via this boot
246parameter.
247
248On an x86 system for example ACPI enablement is a subsys_initcall and::
249
250 dyndbg="file ec.c +p"
251
252will show early Embedded Controller transactions during ACPI setup if
253your machine (typically a laptop) has an Embedded Controller.
254PCI (or other devices) initialization also is a hot candidate for using
255this boot parameter for debugging purposes.
256
257If ``foo`` module is not built-in, ``foo.dyndbg`` will still be processed at
258boot time, without effect, but will be reprocessed when module is
259loaded later. Bare ``dyndbg=`` is only processed at boot.
260
261
262Debug Messages at Module Initialization Time
263============================================
264
265When ``modprobe foo`` is called, modprobe scans ``/proc/cmdline`` for
266``foo.params``, strips ``foo.``, and passes them to the kernel along with
267params given in modprobe args or ``/etc/modprobe.d/*.conf`` files,
268in the following order:
269
2701. parameters given via ``/etc/modprobe.d/*.conf``::
271
272 options foo dyndbg=+pt
273 options foo dyndbg # defaults to +p
274
2752. ``foo.dyndbg`` as given in boot args, ``foo.`` is stripped and passed::
276
277 foo.dyndbg=" func bar +p; func buz +mp"
278
2793. args to modprobe::
280
281 modprobe foo dyndbg==pmf # override previous settings
282
283These ``dyndbg`` queries are applied in order, with last having final say.
284This allows boot args to override or modify those from ``/etc/modprobe.d``
285(sensible, since 1 is system wide, 2 is kernel or boot specific), and
286modprobe args to override both.
287
288In the ``foo.dyndbg="QUERY"`` form, the query must exclude ``module foo``.
289``foo`` is extracted from the param-name, and applied to each query in
290``QUERY``, and only 1 match-spec of each type is allowed.
291
292The ``dyndbg`` option is a "fake" module parameter, which means:
293
294- modules do not need to define it explicitly
295- every module gets it tacitly, whether they use pr_debug or not
296- it doesn't appear in ``/sys/module/$module/parameters/``
297 To see it, grep the control file, or inspect ``/proc/cmdline.``
298
299For ``CONFIG_DYNAMIC_DEBUG`` kernels, any settings given at boot-time (or
300enabled by ``-DDEBUG`` flag during compilation) can be disabled later via
301the debugfs interface if the debug messages are no longer needed::
302
303 echo "module module_name -p" > /proc/dynamic_debug/control
304
305Examples
306========
307
308::
309
310 // enable the message at line 1603 of file svcsock.c
311 :#> ddcmd 'file svcsock.c line 1603 +p'
312
313 // enable all the messages in file svcsock.c
314 :#> ddcmd 'file svcsock.c +p'
315
316 // enable all the messages in the NFS server module
317 :#> ddcmd 'module nfsd +p'
318
319 // enable all 12 messages in the function svc_process()
320 :#> ddcmd 'func svc_process +p'
321
322 // disable all 12 messages in the function svc_process()
323 :#> ddcmd 'func svc_process -p'
324
325 // enable messages for NFS calls READ, READLINK, READDIR and READDIR+.
326 :#> ddcmd 'format "nfsd: READ" +p'
327
328 // enable messages in files of which the paths include string "usb"
329 :#> ddcmd 'file *usb* +p'
330
331 // enable all messages
332 :#> ddcmd '+p'
333
334 // add module, function to all enabled messages
335 :#> ddcmd '+mf'
336
337 // boot-args example, with newlines and comments for readability
338 Kernel command line: ...
339 // see what's going on in dyndbg=value processing
340 dynamic_debug.verbose=3
341 // enable pr_debugs in the btrfs module (can be builtin or loadable)
342 btrfs.dyndbg="+p"
343 // enable pr_debugs in all files under init/
344 // and the function parse_one, #cmt is stripped
345 dyndbg="file init/* +p #cmt ; func parse_one +p"
346 // enable pr_debugs in 2 functions in a module loaded later
347 pc87360.dyndbg="func pc87360_init_device +p; func pc87360_find +p"
348
349Kernel Configuration
350====================
351
352Dynamic Debug is enabled via kernel config items::
353
354 CONFIG_DYNAMIC_DEBUG=y # build catalog, enables CORE
355 CONFIG_DYNAMIC_DEBUG_CORE=y # enable mechanics only, skip catalog
356
357If you do not want to enable dynamic debug globally (i.e. in some embedded
358system), you may set ``CONFIG_DYNAMIC_DEBUG_CORE`` as basic support of dynamic
359debug and add ``ccflags := -DDYNAMIC_DEBUG_MODULE`` into the Makefile of any
360modules which you'd like to dynamically debug later.
361
362
363Kernel *prdbg* API
364==================
365
366The following functions are cataloged and controllable when dynamic
367debug is enabled::
368
369 pr_debug()
370 dev_dbg()
371 print_hex_dump_debug()
372 print_hex_dump_bytes()
373
374Otherwise, they are off by default; ``ccflags += -DDEBUG`` or
375``#define DEBUG`` in a source file will enable them appropriately.
376
377If ``CONFIG_DYNAMIC_DEBUG`` is not set, ``print_hex_dump_debug()`` is
378just a shortcut for ``print_hex_dump(KERN_DEBUG)``.
379
380For ``print_hex_dump_debug()``/``print_hex_dump_bytes()``, format string is
381its ``prefix_str`` argument, if it is constant string; or ``hexdump``
382in case ``prefix_str`` is built dynamically.
1Dynamic debug
2+++++++++++++
3
4
5Introduction
6============
7
8This document describes how to use the dynamic debug (dyndbg) feature.
9
10Dynamic debug is designed to allow you to dynamically enable/disable
11kernel code to obtain additional kernel information. Currently, if
12``CONFIG_DYNAMIC_DEBUG`` is set, then all ``pr_debug()``/``dev_dbg()`` and
13``print_hex_dump_debug()``/``print_hex_dump_bytes()`` calls can be dynamically
14enabled per-callsite.
15
16If you do not want to enable dynamic debug globally (i.e. in some embedded
17system), you may set ``CONFIG_DYNAMIC_DEBUG_CORE`` as basic support of dynamic
18debug and add ``ccflags := -DDYNAMIC_DEBUG_MODULE`` into the Makefile of any
19modules which you'd like to dynamically debug later.
20
21If ``CONFIG_DYNAMIC_DEBUG`` is not set, ``print_hex_dump_debug()`` is just
22shortcut for ``print_hex_dump(KERN_DEBUG)``.
23
24For ``print_hex_dump_debug()``/``print_hex_dump_bytes()``, format string is
25its ``prefix_str`` argument, if it is constant string; or ``hexdump``
26in case ``prefix_str`` is built dynamically.
27
28Dynamic debug has even more useful features:
29
30 * Simple query language allows turning on and off debugging
31 statements by matching any combination of 0 or 1 of:
32
33 - source filename
34 - function name
35 - line number (including ranges of line numbers)
36 - module name
37 - format string
38
39 * Provides a debugfs control file: ``<debugfs>/dynamic_debug/control``
40 which can be read to display the complete list of known debug
41 statements, to help guide you
42
43Controlling dynamic debug Behaviour
44===================================
45
46The behaviour of ``pr_debug()``/``dev_dbg()`` are controlled via writing to a
47control file in the 'debugfs' filesystem. Thus, you must first mount
48the debugfs filesystem, in order to make use of this feature.
49Subsequently, we refer to the control file as:
50``<debugfs>/dynamic_debug/control``. For example, if you want to enable
51printing from source file ``svcsock.c``, line 1603 you simply do::
52
53 nullarbor:~ # echo 'file svcsock.c line 1603 +p' >
54 <debugfs>/dynamic_debug/control
55
56If you make a mistake with the syntax, the write will fail thus::
57
58 nullarbor:~ # echo 'file svcsock.c wtf 1 +p' >
59 <debugfs>/dynamic_debug/control
60 -bash: echo: write error: Invalid argument
61
62Note, for systems without 'debugfs' enabled, the control file can be
63found in ``/proc/dynamic_debug/control``.
64
65Viewing Dynamic Debug Behaviour
66===============================
67
68You can view the currently configured behaviour of all the debug
69statements via::
70
71 nullarbor:~ # cat <debugfs>/dynamic_debug/control
72 # filename:lineno [module]function flags format
73 net/sunrpc/svc_rdma.c:323 [svcxprt_rdma]svc_rdma_cleanup =_ "SVCRDMA Module Removed, deregister RPC RDMA transport\012"
74 net/sunrpc/svc_rdma.c:341 [svcxprt_rdma]svc_rdma_init =_ "\011max_inline : %d\012"
75 net/sunrpc/svc_rdma.c:340 [svcxprt_rdma]svc_rdma_init =_ "\011sq_depth : %d\012"
76 net/sunrpc/svc_rdma.c:338 [svcxprt_rdma]svc_rdma_init =_ "\011max_requests : %d\012"
77 ...
78
79
80You can also apply standard Unix text manipulation filters to this
81data, e.g.::
82
83 nullarbor:~ # grep -i rdma <debugfs>/dynamic_debug/control | wc -l
84 62
85
86 nullarbor:~ # grep -i tcp <debugfs>/dynamic_debug/control | wc -l
87 42
88
89The third column shows the currently enabled flags for each debug
90statement callsite (see below for definitions of the flags). The
91default value, with no flags enabled, is ``=_``. So you can view all
92the debug statement callsites with any non-default flags::
93
94 nullarbor:~ # awk '$3 != "=_"' <debugfs>/dynamic_debug/control
95 # filename:lineno [module]function flags format
96 net/sunrpc/svcsock.c:1603 [sunrpc]svc_send p "svc_process: st_sendto returned %d\012"
97
98Command Language Reference
99==========================
100
101At the lexical level, a command comprises a sequence of words separated
102by spaces or tabs. So these are all equivalent::
103
104 nullarbor:~ # echo -n 'file svcsock.c line 1603 +p' >
105 <debugfs>/dynamic_debug/control
106 nullarbor:~ # echo -n ' file svcsock.c line 1603 +p ' >
107 <debugfs>/dynamic_debug/control
108 nullarbor:~ # echo -n 'file svcsock.c line 1603 +p' >
109 <debugfs>/dynamic_debug/control
110
111Command submissions are bounded by a write() system call.
112Multiple commands can be written together, separated by ``;`` or ``\n``::
113
114 ~# echo "func pnpacpi_get_resources +p; func pnp_assign_mem +p" \
115 > <debugfs>/dynamic_debug/control
116
117If your query set is big, you can batch them too::
118
119 ~# cat query-batch-file > <debugfs>/dynamic_debug/control
120
121Another way is to use wildcards. The match rule supports ``*`` (matches
122zero or more characters) and ``?`` (matches exactly one character). For
123example, you can match all usb drivers::
124
125 ~# echo "file drivers/usb/* +p" > <debugfs>/dynamic_debug/control
126
127At the syntactical level, a command comprises a sequence of match
128specifications, followed by a flags change specification::
129
130 command ::= match-spec* flags-spec
131
132The match-spec's are used to choose a subset of the known pr_debug()
133callsites to which to apply the flags-spec. Think of them as a query
134with implicit ANDs between each pair. Note that an empty list of
135match-specs will select all debug statement callsites.
136
137A match specification comprises a keyword, which controls the
138attribute of the callsite to be compared, and a value to compare
139against. Possible keywords are:::
140
141 match-spec ::= 'func' string |
142 'file' string |
143 'module' string |
144 'format' string |
145 'line' line-range
146
147 line-range ::= lineno |
148 '-'lineno |
149 lineno'-' |
150 lineno'-'lineno
151
152 lineno ::= unsigned-int
153
154.. note::
155
156 ``line-range`` cannot contain space, e.g.
157 "1-30" is valid range but "1 - 30" is not.
158
159
160The meanings of each keyword are:
161
162func
163 The given string is compared against the function name
164 of each callsite. Example::
165
166 func svc_tcp_accept
167 func *recv* # in rfcomm, bluetooth, ping, tcp
168
169file
170 The given string is compared against either the src-root relative
171 pathname, or the basename of the source file of each callsite.
172 Examples::
173
174 file svcsock.c
175 file kernel/freezer.c # ie column 1 of control file
176 file drivers/usb/* # all callsites under it
177 file inode.c:start_* # parse :tail as a func (above)
178 file inode.c:1-100 # parse :tail as a line-range (above)
179
180module
181 The given string is compared against the module name
182 of each callsite. The module name is the string as
183 seen in ``lsmod``, i.e. without the directory or the ``.ko``
184 suffix and with ``-`` changed to ``_``. Examples::
185
186 module sunrpc
187 module nfsd
188 module drm* # both drm, drm_kms_helper
189
190format
191 The given string is searched for in the dynamic debug format
192 string. Note that the string does not need to match the
193 entire format, only some part. Whitespace and other
194 special characters can be escaped using C octal character
195 escape ``\ooo`` notation, e.g. the space character is ``\040``.
196 Alternatively, the string can be enclosed in double quote
197 characters (``"``) or single quote characters (``'``).
198 Examples::
199
200 format svcrdma: // many of the NFS/RDMA server pr_debugs
201 format readahead // some pr_debugs in the readahead cache
202 format nfsd:\040SETATTR // one way to match a format with whitespace
203 format "nfsd: SETATTR" // a neater way to match a format with whitespace
204 format 'nfsd: SETATTR' // yet another way to match a format with whitespace
205
206line
207 The given line number or range of line numbers is compared
208 against the line number of each ``pr_debug()`` callsite. A single
209 line number matches the callsite line number exactly. A
210 range of line numbers matches any callsite between the first
211 and last line number inclusive. An empty first number means
212 the first line in the file, an empty last line number means the
213 last line number in the file. Examples::
214
215 line 1603 // exactly line 1603
216 line 1600-1605 // the six lines from line 1600 to line 1605
217 line -1605 // the 1605 lines from line 1 to line 1605
218 line 1600- // all lines from line 1600 to the end of the file
219
220The flags specification comprises a change operation followed
221by one or more flag characters. The change operation is one
222of the characters::
223
224 - remove the given flags
225 + add the given flags
226 = set the flags to the given flags
227
228The flags are::
229
230 p enables the pr_debug() callsite.
231 f Include the function name in the printed message
232 l Include line number in the printed message
233 m Include module name in the printed message
234 t Include thread ID in messages not generated from interrupt context
235 _ No flags are set. (Or'd with others on input)
236
237For ``print_hex_dump_debug()`` and ``print_hex_dump_bytes()``, only ``p`` flag
238have meaning, other flags ignored.
239
240For display, the flags are preceded by ``=``
241(mnemonic: what the flags are currently equal to).
242
243Note the regexp ``^[-+=][flmpt_]+$`` matches a flags specification.
244To clear all flags at once, use ``=_`` or ``-flmpt``.
245
246
247Debug messages during Boot Process
248==================================
249
250To activate debug messages for core code and built-in modules during
251the boot process, even before userspace and debugfs exists, use
252``dyndbg="QUERY"``, ``module.dyndbg="QUERY"``, or ``ddebug_query="QUERY"``
253(``ddebug_query`` is obsoleted by ``dyndbg``, and deprecated). QUERY follows
254the syntax described above, but must not exceed 1023 characters. Your
255bootloader may impose lower limits.
256
257These ``dyndbg`` params are processed just after the ddebug tables are
258processed, as part of the early_initcall. Thus you can enable debug
259messages in all code run after this early_initcall via this boot
260parameter.
261
262On an x86 system for example ACPI enablement is a subsys_initcall and::
263
264 dyndbg="file ec.c +p"
265
266will show early Embedded Controller transactions during ACPI setup if
267your machine (typically a laptop) has an Embedded Controller.
268PCI (or other devices) initialization also is a hot candidate for using
269this boot parameter for debugging purposes.
270
271If ``foo`` module is not built-in, ``foo.dyndbg`` will still be processed at
272boot time, without effect, but will be reprocessed when module is
273loaded later. ``ddebug_query=`` and bare ``dyndbg=`` are only processed at
274boot.
275
276
277Debug Messages at Module Initialization Time
278============================================
279
280When ``modprobe foo`` is called, modprobe scans ``/proc/cmdline`` for
281``foo.params``, strips ``foo.``, and passes them to the kernel along with
282params given in modprobe args or ``/etc/modprob.d/*.conf`` files,
283in the following order:
284
2851. parameters given via ``/etc/modprobe.d/*.conf``::
286
287 options foo dyndbg=+pt
288 options foo dyndbg # defaults to +p
289
2902. ``foo.dyndbg`` as given in boot args, ``foo.`` is stripped and passed::
291
292 foo.dyndbg=" func bar +p; func buz +mp"
293
2943. args to modprobe::
295
296 modprobe foo dyndbg==pmf # override previous settings
297
298These ``dyndbg`` queries are applied in order, with last having final say.
299This allows boot args to override or modify those from ``/etc/modprobe.d``
300(sensible, since 1 is system wide, 2 is kernel or boot specific), and
301modprobe args to override both.
302
303In the ``foo.dyndbg="QUERY"`` form, the query must exclude ``module foo``.
304``foo`` is extracted from the param-name, and applied to each query in
305``QUERY``, and only 1 match-spec of each type is allowed.
306
307The ``dyndbg`` option is a "fake" module parameter, which means:
308
309- modules do not need to define it explicitly
310- every module gets it tacitly, whether they use pr_debug or not
311- it doesn't appear in ``/sys/module/$module/parameters/``
312 To see it, grep the control file, or inspect ``/proc/cmdline.``
313
314For ``CONFIG_DYNAMIC_DEBUG`` kernels, any settings given at boot-time (or
315enabled by ``-DDEBUG`` flag during compilation) can be disabled later via
316the debugfs interface if the debug messages are no longer needed::
317
318 echo "module module_name -p" > <debugfs>/dynamic_debug/control
319
320Examples
321========
322
323::
324
325 // enable the message at line 1603 of file svcsock.c
326 nullarbor:~ # echo -n 'file svcsock.c line 1603 +p' >
327 <debugfs>/dynamic_debug/control
328
329 // enable all the messages in file svcsock.c
330 nullarbor:~ # echo -n 'file svcsock.c +p' >
331 <debugfs>/dynamic_debug/control
332
333 // enable all the messages in the NFS server module
334 nullarbor:~ # echo -n 'module nfsd +p' >
335 <debugfs>/dynamic_debug/control
336
337 // enable all 12 messages in the function svc_process()
338 nullarbor:~ # echo -n 'func svc_process +p' >
339 <debugfs>/dynamic_debug/control
340
341 // disable all 12 messages in the function svc_process()
342 nullarbor:~ # echo -n 'func svc_process -p' >
343 <debugfs>/dynamic_debug/control
344
345 // enable messages for NFS calls READ, READLINK, READDIR and READDIR+.
346 nullarbor:~ # echo -n 'format "nfsd: READ" +p' >
347 <debugfs>/dynamic_debug/control
348
349 // enable messages in files of which the paths include string "usb"
350 nullarbor:~ # echo -n 'file *usb* +p' > <debugfs>/dynamic_debug/control
351
352 // enable all messages
353 nullarbor:~ # echo -n '+p' > <debugfs>/dynamic_debug/control
354
355 // add module, function to all enabled messages
356 nullarbor:~ # echo -n '+mf' > <debugfs>/dynamic_debug/control
357
358 // boot-args example, with newlines and comments for readability
359 Kernel command line: ...
360 // see whats going on in dyndbg=value processing
361 dynamic_debug.verbose=1
362 // enable pr_debugs in 2 builtins, #cmt is stripped
363 dyndbg="module params +p #cmt ; module sys +p"
364 // enable pr_debugs in 2 functions in a module loaded later
365 pc87360.dyndbg="func pc87360_init_device +p; func pc87360_find +p"