Skip to content

Commit

Permalink
Docs how set up machine for gdb (#396)
Browse files Browse the repository at this point in the history
* Add docs
* Move set_up_machine to debugging
* Fix style in set_up_machine
* Fix spelling in debugging_environment
  • Loading branch information
Elena Totmenina authored May 26, 2021
1 parent d877898 commit 6ec08d3
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/user_guides/debugging/debugging_environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Activate NEO drivers

Further, if you want to use local NEO driver, you need to activate the variables for it.

Checking debuggin environment
-----------------------------
Checking debugging environment
------------------------------

You can check the correctness of the work with the following example:

Expand Down
1 change: 1 addition & 0 deletions docs/user_guides/debugging/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ the relevant documentation can be found at `Intel® Distribution for GDB documen
.. toctree::
:maxdepth: 2

set_up_machine
debugging_environment


Expand Down
89 changes: 89 additions & 0 deletions docs/user_guides/debugging/set_up_machine.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
Setting up the machine for debugging
====================================

Graphics driver
---------------

You need to install drivers using following guides:

- `GPGPU Documents / Installation guides`_
- `Intel® oneAPI Toolkits Installation Guide for Linux* OS / Installation Guide / Install Intel GPU Drivers`_

.. _`GPGPU Documents / Installation guides`: https://dgpu-docs.intel.com/installation-guides/index.html
.. _`Intel® oneAPI Toolkits Installation Guide for Linux* OS / Installation Guide / Install Intel GPU Drivers`:
https://software.intel.com/content/www/us/en/develop/documentation/installation-guide-for-intel-oneapi-toolkits-linux/top/prerequisites/install-intel-gpu-drivers.html

It is also important that the user is in the group "video" (on Ubuntu* 18, Fedora* 30, and SLES* 15 SP1)
or "render" (on Ubuntu* 19 and higher, CentOS* 8, and Fedora* 31).
An administrator with sudo or root privilege can change the group owner of `/dev/dri/renderD*` and `/dev/dri/card*`
to a group ID used by your user base:

.. code-block:: bash
sudo usermod -a -G video <username>
NEO driver
----------

NEO driver at least `21.15.19533` version is required to make debugger work correctly.

Follow the `link <https://github.com/intel/compute-runtime/releases/tag/21.15.19533>`_ below to download the drivers.

1) To install the driver on the system, use the command:

.. code-block:: bash
sudo dpkg -i *.deb
2) To install the NEO driver locally follow the commands below:

.. code-block:: bash
cd /path/to/my/neo
for file in `ls *.deb`; do dpkg -x $file .; done
export MY_ACTIVE_NEO=/path/to/my/neo/usr/local/lib
export LD_LIBRARY_PATH=${MY_ACTIVE_NEO}:${MY_ACTIVE_NEO}/intel-opencl:$LD_LIBRARY_PATH
The Installable Client Driver (ICD) uses the system implementation for OpenCL by default.
You will also need to add environment variables to change the behavior of the ICD.
Add all needed from "/etc/OpenCL/vendors/" and custom to `OCL_ICD_FILENAMES`.

.. code-block:: bash
export OCL_ICD_FILENAMES=/path/to/my/neo/usr/local/lib/intel-opencl/libigdrcl.so:/optional/from/vendors/libintelocl.so
export OCL_ICD_VENDORS=
See also:

- `Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver <https://github.com/intel/compute-runtime>`_
- `Intel(R) Graphics Compute Runtime Releases <https://github.com/intel/compute-runtime/releases>`_
- `OpenCL ICD Loader <https://github.com/KhronosGroup/OpenCL-ICD-Loader>`_


DCD driver
----------

To install the DCD (Debugger Companion Driver) driver from oneAPI into the system, use the following command:

.. code-block:: bash
sudo dpkg -i /path/to/oneapi/debugger/latest/igfxdcd-*-Linux.deb
Before working, you must activate it:

.. code-block:: bash
sudo modinfo igfxdcd
Also, you must remove the driver from the system if you want to install a different version:

.. code-block:: bash
sudo dpkg -r igfxdcd
If you are installing DCD for the first time, you need to create keys.

See also:

- `Get Started with Intel® Distribution for GDB* on Linux* OS Host <https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-debugging-dpcpp-linux/top.html>`_

0 comments on commit 6ec08d3

Please sign in to comment.