openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: s390: s390dbf: typos and formatting, update crash command 

Signed-off-by: Steffen Maier <maier@linux.ibm.com>
Acked-by: Christian Borntraeger <borntraeger@de.ibm.com>
Message-Id: <1562149189-1417-4-git-send-email-maier@linux.ibm.com>
Signed-off-by: Vasily Gorbik <gor@linux.ibm.com>
This commit is contained in:
Steffen Maier 2019-07-03 12:19:49 +02:00 committed by Vasily Gorbik
parent 0328e519a7
commit 499723d120
1 changed files with 68 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
Documentation/s390/s390dbf.rst
View File

@ -23,7 +23,8 @@ The debug feature may also very useful for kernel and driver development.
Design: Design:
------- -------
Kernel components (e.g. device drivers) can register themselves at the debug Kernel components (e.g. device drivers) can register themselves at the debug
feature with the function call debug_register(). This function initializes a feature with the function call :c:func:`debug_register()`.
This function initializes a
debug log for the caller. For each debug log exists a number of debug areas debug log for the caller. For each debug log exists a number of debug areas
where exactly one is active at one time. Each debug area consists of contiguous where exactly one is active at one time. Each debug area consists of contiguous
pages in memory. In the debug areas there are stored debug entries (log records) pages in memory. In the debug areas there are stored debug entries (log records)
@ -44,8 +45,9 @@ The debug areas themselves are also ordered in form of a ring buffer.
When an exception is thrown in the last debug area, the following debug When an exception is thrown in the last debug area, the following debug
entries are then written again in the very first area. entries are then written again in the very first area.
There are three versions for the event- and exception-calls: One for There are four versions for the event- and exception-calls: One for
logging raw data, one for text and one for numbers. logging raw data, one for text, one for numbers (unsigned int and long),
and one for sprintf-like formatted strings.
Each debug entry contains the following data: Each debug entry contains the following data:
@ -56,29 +58,29 @@ Each debug entry contains the following data:
- Flag, if entry is an exception or not - Flag, if entry is an exception or not
The debug logs can be inspected in a live system through entries in The debug logs can be inspected in a live system through entries in
the debugfs-filesystem. Under the toplevel directory "s390dbf" there is the debugfs-filesystem. Under the toplevel directory "``s390dbf``" there is
a directory for each registered component, which is named like the a directory for each registered component, which is named like the
corresponding component. The debugfs normally should be mounted to corresponding component. The debugfs normally should be mounted to
/sys/kernel/debug therefore the debug feature can be accessed under ``/sys/kernel/debug`` therefore the debug feature can be accessed under
/sys/kernel/debug/s390dbf. ``/sys/kernel/debug/s390dbf``.
The content of the directories are files which represent different views The content of the directories are files which represent different views
to the debug log. Each component can decide which views should be to the debug log. Each component can decide which views should be
used through registering them with the function debug_register_view(). used through registering them with the function :c:func:`debug_register_view()`.
Predefined views for hex/ascii, sprintf and raw binary data are provided. Predefined views for hex/ascii, sprintf and raw binary data are provided.
It is also possible to define other views. The content of It is also possible to define other views. The content of
a view can be inspected simply by reading the corresponding debugfs file. a view can be inspected simply by reading the corresponding debugfs file.
All debug logs have an actual debug level (range from 0 to 6). All debug logs have an actual debug level (range from 0 to 6).
The default level is 3. Event and Exception functions have a 'level' The default level is 3. Event and Exception functions have a :c:data:`level`
parameter. Only debug entries with a level that is lower or equal parameter. Only debug entries with a level that is lower or equal
than the actual level are written to the log. This means, when than the actual level are written to the log. This means, when
writing events, high priority log entries should have a low level writing events, high priority log entries should have a low level
value whereas low priority entries should have a high one. value whereas low priority entries should have a high one.
The actual debug level can be changed with the help of the debugfs-filesystem The actual debug level can be changed with the help of the debugfs-filesystem
through writing a number string "x" to the 'level' debugfs file which is through writing a number string "x" to the ``level`` debugfs file which is
provided for every debug log. Debugging can be switched off completely provided for every debug log. Debugging can be switched off completely
by using "-" on the 'level' debugfs file. by using "-" on the ``level`` debugfs file.
Example:: Example::
@ -86,21 +88,21 @@ Example::
It is also possible to deactivate the debug feature globally for every It is also possible to deactivate the debug feature globally for every
debug log. You can change the behavior using 2 sysctl parameters in debug log. You can change the behavior using 2 sysctl parameters in
/proc/sys/s390dbf: ``/proc/sys/s390dbf``:
There are currently 2 possible triggers, which stop the debug feature There are currently 2 possible triggers, which stop the debug feature
globally. The first possibility is to use the "debug_active" sysctl. If globally. The first possibility is to use the ``debug_active`` sysctl. If
set to 1 the debug feature is running. If "debug_active" is set to 0 the set to 1 the debug feature is running. If ``debug_active`` is set to 0 the
debug feature is turned off. debug feature is turned off.
The second trigger which stops the debug feature is a kernel oops. The second trigger which stops the debug feature is a kernel oops.
That prevents the debug feature from overwriting debug information that That prevents the debug feature from overwriting debug information that
happened before the oops. After an oops you can reactivate the debug feature happened before the oops. After an oops you can reactivate the debug feature
by piping 1 to /proc/sys/s390dbf/debug_active. Nevertheless, its not by piping 1 to ``/proc/sys/s390dbf/debug_active``. Nevertheless, it's not
suggested to use an oopsed kernel in a production environment. suggested to use an oopsed kernel in a production environment.
If you want to disallow the deactivation of the debug feature, you can use If you want to disallow the deactivation of the debug feature, you can use
the "debug_stoppable" sysctl. If you set "debug_stoppable" to 0 the debug the ``debug_stoppable`` sysctl. If you set ``debug_stoppable`` to 0 the debug
feature cannot be stopped. If the debug feature is already stopped, it feature cannot be stopped. If the debug feature is already stopped, it
will stay deactivated. will stay deactivated.
@ -113,6 +115,8 @@ Kernel Interfaces:
Predefined views: Predefined views:
----------------- -----------------
.. code-block:: c
extern struct debug_view debug_hex_ascii_view; extern struct debug_view debug_hex_ascii_view;
extern struct debug_view debug_raw_view; extern struct debug_view debug_raw_view;
@ -122,7 +126,7 @@ extern struct debug_view debug_sprintf_view;
Examples Examples
-------- --------
:: .. code-block:: c
/* /*
* hex_ascii- + raw-view Example * hex_ascii- + raw-view Example
@ -156,7 +160,7 @@ Examples
module_init(init); module_init(init);
module_exit(cleanup); module_exit(cleanup);
:: .. code-block:: c
/* /*
* sprintf-view Example * sprintf-view Example
@ -252,7 +256,7 @@ Define 4 pages for the debug areas of debug feature "dasd"::
> echo "4" > /sys/kernel/debug/s390dbf/dasd/pages > echo "4" > /sys/kernel/debug/s390dbf/dasd/pages
Stooping the debug feature Stopping the debug feature
-------------------------- --------------------------
Example: Example:
@ -264,10 +268,11 @@ Example:
> echo 0 > /proc/sys/s390dbf/debug_active > echo 0 > /proc/sys/s390dbf/debug_active
lcrash Interface crash Interface
---------------- ----------------
It is planned that the dump analysis tool lcrash gets an additional command The ``crash`` tool since v5.1.0 has a built-in command
's390dbf' to display all the debug logs. With this tool it will be possible ``s390dbf`` to display all the debug logs or export them to the file system.
With this tool it is possible
to investigate the debug logs on a live system and with a memory dump after to investigate the debug logs on a live system and with a memory dump after
a system crash. a system crash.
@ -276,8 +281,8 @@ Investigating raw memory
One last possibility to investigate the debug logs at a live One last possibility to investigate the debug logs at a live
system and after a system crash is to look at the raw memory system and after a system crash is to look at the raw memory
under VM or at the Service Element. under VM or at the Service Element.
It is possible to find the anker of the debug-logs through It is possible to find the anchor of the debug-logs through
the 'debug_area_first' symbol in the System map. Then one has the ``debug_area_first`` symbol in the System map. Then one has
to follow the correct pointers of the data-structures defined to follow the correct pointers of the data-structures defined
in debug.h and find the debug-areas in memory. in debug.h and find the debug-areas in memory.
Normally modules which use the debug feature will also have Normally modules which use the debug feature will also have
@ -286,7 +291,7 @@ this pointer it will also be possible to find the debug logs in
memory. memory.
For this method it is recommended to use '16 * x + 4' byte (x = 0..n) For this method it is recommended to use '16 * x + 4' byte (x = 0..n)
for the length of the data field in debug_register() in for the length of the data field in :c:func:`debug_register()` in
order to see the debug entries well formatted. order to see the debug entries well formatted.
@ -295,7 +300,7 @@ Predefined Views
There are three predefined views: hex_ascii, raw and sprintf. There are three predefined views: hex_ascii, raw and sprintf.
The hex_ascii view shows the data field in hex and ascii representation The hex_ascii view shows the data field in hex and ascii representation
(e.g. '45 43 4b 44 | ECKD'). (e.g. ``45 43 4b 44 | ECKD``).
The raw view returns a bytestream as the debug areas are stored in memory. The raw view returns a bytestream as the debug areas are stored in memory.
The sprintf view formats the debug entries in the same way as the sprintf The sprintf view formats the debug entries in the same way as the sprintf
@ -335,7 +340,7 @@ The format of the raw view is:
- datafield - datafield
A typical line of the hex_ascii view will look like the following (first line A typical line of the hex_ascii view will look like the following (first line
is only for explanation and will not be displayed when 'cating' the view): is only for explanation and will not be displayed when 'cating' the view)::
area time level exception cpu caller data (hex + ascii) area time level exception cpu caller data (hex + ascii)
-------------------------------------------------------------------------- --------------------------------------------------------------------------
@ -346,7 +351,9 @@ Defining views
-------------- --------------
Views are specified with the 'debug_view' structure. There are defined Views are specified with the 'debug_view' structure. There are defined
callback functions which are used for reading and writing the debugfs files:: callback functions which are used for reading and writing the debugfs files:
.. code-block:: c
struct debug_view { struct debug_view {
char name[DEBUG_MAX_PROCF_LEN]; char name[DEBUG_MAX_PROCF_LEN];
@ -357,7 +364,9 @@ callback functions which are used for reading and writing the debugfs files::
void* private_data; void* private_data;
}; };
where:: where:
.. code-block:: c
typedef int (debug_header_proc_t) (debug_info_t* id, typedef int (debug_header_proc_t) (debug_info_t* id,
struct debug_view* view, struct debug_view* view,
@ -395,10 +404,10 @@ Then 'header_proc' and 'format_proc' are called for each
existing debug entry. existing debug entry.
The input_proc can be used to implement functionality when it is written to The input_proc can be used to implement functionality when it is written to
the view (e.g. like with 'echo "0" > /sys/kernel/debug/s390dbf/dasd/level). the view (e.g. like with ``echo "0" > /sys/kernel/debug/s390dbf/dasd/level``).
For header_proc there can be used the default function For header_proc there can be used the default function
debug_dflt_header_fn() which is defined in debug.h. :c:func:`debug_dflt_header_fn()` which is defined in debug.h.
and which produces the same header output as the predefined views. and which produces the same header output as the predefined views.
E.g:: E.g::
@ -407,7 +416,9 @@ E.g::
In order to see how to use the callback functions check the implementation In order to see how to use the callback functions check the implementation
of the default views! of the default views!
Example:: Example:
.. code-block:: c
#include <asm/debug.h> #include <asm/debug.h>
@ -436,7 +447,6 @@ Example::
else else
rc += sprintf(out_buf, UNKNOWNSTR, msg_nr); rc += sprintf(out_buf, UNKNOWNSTR, msg_nr);
} }
out:
return rc; return rc;
} }
@ -452,13 +462,17 @@ Example::
test: test:
===== =====
:: .. code-block:: c
debug_info_t *debug_info; debug_info_t *debug_info;
int i;
... ...
debug_info = debug_register ("test", 0, 4, 4 )); debug_info = debug_register("test", 0, 4, 4);
debug_register_view(debug_info, &debug_test_view); debug_register_view(debug_info, &debug_test_view);
for(i = 0; i < 10; i ++) debug_int_event(debug_info, 1, i); for (i = 0; i < 10; i ++)
debug_int_event(debug_info, 1, i);
::
> cat /sys/kernel/debug/s390dbf/test/myview > cat /sys/kernel/debug/s390dbf/test/myview
00 00964419734:611402 1 - 00 88042ca This error........... 00 00964419734:611402 1 - 00 88042ca This error...........