github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2026-06-08 10:04:42 +00:00
Code Issues Projects Releases Wiki Activity

tools: acrn-crashlog: add documents for acrn-crashlog

Browse Source 
This patch adds the documents for acrn-crashlog:
README.rst: General introduction for acrn-crashlog.
acrnprobe/README.rst: Introduction for acrnprobe in detail.
usercrash/README.rst: Introduction for usercrash in detail.

Signed-off-by: xiaojin2 <xiaojing.liu@intel.com>
Signed-off-by: Liu Xinwu <xinwu.liu@intel.com>
Signed-off-by: CHEN Gang <gang.c.chen@intel.com>
Acked-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
CHEN Gang
2018-05-31 10:00:30 +00:00
committed by David Kinder
parent 756083fefc
commit 7d13e5be1b
3 changed files with 420 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
tools/acrn-crashlog/usercrash/README.rst Normal file
View File

@@ -0,0 +1,91 @@
.. _usercrash_doc:
Usercrash
#########
Description
***********
The ``usercrash`` is to get the crash info for the crashing process in
userpace. The collected information is saved as usercrash_xx under
``/var/log/usercrashes/``.
Design
******
The ``usercrash`` is designed as Client/Server model. The server is autostarted
at boot, and the client is configured in ``core_pattern``, which will be
triggered once crash occurs in userspace. Then client sends the crash event to
server. The server will check the files under ``/var/log/usercrashes/`` and
create a new file usercrash_xx(xx means the index of the crash files), then
it will send the fd to client. The client will be responsible for collecting
crash information and saving it in the crashlog file. After saving work is done,
client will notify server. Then the server will clean up.
The work flow diagram:
::
+--------------------------------------------------+
| |
| Server Client |
| + + |
| | Send crash event | |
| | <-----------------------+ |
| | | |
| Create usercrash_xx | |
| | | |
| | Send usercrash_xx fd | |
| +-----------------------> | |
| | | |
| | Fill usercrash_xx |
| | | |
| | Notify completion | |
| | <-----------------------+ |
| | | |
| Clean up | |
| | | |
| v v |
| |
+--------------------------------------------------+
Usage
*****
- The server is launched automatically at boot, and the client is configured in
``core_pattern``. The content of ``core_pattern`` is configured as
``usercrash_c`` while booting up:
.. code-block:: console
$ echo "|/usr/bin/usercrash_c %p %e %s" > /proc/sys/kernel/core_pattern
That means client will be triggered once userspace crash occurs. Then the
event will be sent to server from client.
- The ``debugger`` is an independent tool to dump the debug information of the
specific process, including backtrace, stack, opened files, registers value,
memory content around registers, and etc.
.. code-block:: console
$ debugger <pid>
.. note::
You need to be ``root`` to use the ``debugger``.
Souce Code
**********
- client.c : This file is the implementation for client of ``usercrash``, which
is responsible for delivering the ``usercrash`` event to the server, and
collecting crash information and saving it to the crashfile.
- crash_dump.c : This file is the implementation for dumping the crash
information, including backtrace stack, opened files, registers value, memory
content around registers, and etc.
- debugger.c : This file is to implement a tool, which runs in command line to
dump the process information list above.
- protocol.c : This file is the socket protocol implement file.
- server.c : This file is the implement file for server of ``usercrash``, which
is responsible for creating the crashfile and handle the events from client.