github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-23 05:57:33 +00:00
Code Issues Projects Releases Wiki Activity

doc: update the "ACRN Debugging Tools" tutorial

Browse Source 
Update the "ACRN Debugging Tools" tutorial:
* Remove sections on how to build and install the hypervisor, refer to the
  corresponding user guides instead
* Simplify the flow for checking loglevel (console and mem)
* Add a little text to improve readability

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2019-04-09 10:48:02 +02:00 committed by David Kinder
parent 17b2a72555
commit a459ac97f8
1 changed files with 11 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/tutorials/debug.rst
View File

@ -89,12 +89,17 @@ noted above. For example, add the following code into function
shell_cmd_help added information shell_cmd_help added information
Once you have instrumented the code, you need to rebuild the hypervisor and
install it on your platform. Refer to :ref:`getting-started-building` and
:ref:`getting-started-apl-nuc` for detailed instructions on how to do that.
We set console log level to 5, and mem log level to 2 through the We set console log level to 5, and mem log level to 2 through the
command:: command::
loglevel 5 2 loglevel 5 2
Then we input "help" into the ACRN console, and find the log as follows. Then we input ``help`` into the ACRN console (this is the command that we have
just instrumented with additional log information), and check the log as follows.
.. figure:: images/debug_image23.png .. figure:: images/debug_image23.png
:align: center :align: center
@ -105,26 +110,11 @@ Then we use the command, on the ACRN console::
sos_console sos_console
to switch to the SOS console the use the commands:: to switch to the SOS console. Then we use the command::
systemctl enable acrnlog
reboot
to enable the mem log and reboot the SOS.
Next we set the console and mem log levels with::
loglevel 5 2
and run the command::
help
Finally we get into the SOS and use the command::
cat /tmp/acrnlog/acrnlog_cur.0 cat /tmp/acrnlog/acrnlog_cur.0
on the console, and we'll see the following log: and we will see the following log:
.. figure:: images/debug_image24.png .. figure:: images/debug_image24.png
:align: center :align: center
@ -214,16 +204,9 @@ shown in the following example:
inserted trace information inserted trace information
4. After we have inserted the trace code addition, we need to rebuild 4. After we have inserted the trace code addition, we need to rebuild
the acrn-hypervisor in the ``acrn-hypervisor`` directory:: the ACRN hypervisor and install it on the platform. Refer to
:ref:`getting-started-building` and :ref:`getting-started-apl-nuc` for
# make PLATFORM=uefi detailed instructions on how to do that.
and replace the existing ``acrn.efi`` with the new one we just
built in the ``build/hypervisor/`` folder::
# mount /dev/sda1 /mnt && mkdir -p /mnt/EFI/acrn
# mv /mnt/EFI/acrn/acrn.efi /mnt/EFI/acrn/acrn.efi.old
# cp build/hypervisor/acrn.efi /mnt/EFI/acrn/
5. Now we can use the following command in the SOS console 5. Now we can use the following command in the SOS console
to generate acrntrace data into the current directory:: to generate acrntrace data into the current directory::