xref: /aosp_15_r20/external/mesa3d/src/intel/tools/README.md (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1# aubinator_error_decode
2
3This tool allows decode an error state dump generated by the kernel
4driver.
5
6Make a copy of the error state file (i915) :
7```
8$ sudo cp /sys/devices/pci0000:00/0000:00:02.0/drm/card0/error /tmp/error
9$ sudo chmod go+rw /tmp/error
10```
11
12Make a copy of the error state file (Xe) :
13```
14$ sudo cp /sys/class/drm/card0/device/devcoredump/data /tmp/error
15$ sudo chmod go+rw /tmp/error
16```
17
18Then visualize the error state (from the mesa build directory) :
19```
20$ ./src/intel/tools/aubinator_error_decode /tmp/error
21```
22
23# intel_stub_gpu
24
25This tool allows faking a particular device at the ioctl level. This
26is useful to test compiler changes (using shader-db/fossils-db
27replays) across a number of device you don't necessarily have access
28too.
29
30Faking a DG2 device :
31```
32$ intel_stub_gpu -p dg2 fossilize-replay /path/to/fossilize.foz --enable-pipeline-stats /tmp/dg2.csv
33```
34
35Faking a ICL device :
36```
37$ intel_stub_gpu -p icl fossilize-replay /path/to/fossilize.foz --enable-pipeline-stats /tmp/icl.csv
38```
39
40# intel_error2hangdump
41
42This tool converts an error state dump into an
43uncompressed/easy-to-modify binary file (format described in
44`src/intel/common/intel_hang_dump.h`).
45
46Capture the error state (i915) :
47```
48$ sudo cp /sys/devices/pci0000:00/0000:00:02.0/drm/card0/error /tmp/error
49$ sudo chmod go+rw /tmp/error
50```
51Capture the error state (Xe) :
52```
53$ sudo cp /sys/class/drm/card0/device/devcoredump/data /tmp/error
54$ sudo chmod go+rw /tmp/error
55```
56
57Convert an error state (from the mesa build directory) :
58```
59$ ./src/intel/tools/intel_error2hang /tmp/error
60```
61
62A resulting `error.dmp` file will be created
63
64# intel_hang_replay
65
66This tool replays a binary file generated by `intel_error2hangdump`.
67
68From the mesa build directory :
69```
70$ ./src/intel/tools/intel_hang_replay -d /tmp/error.dmp
71```
72
73# intel_hang_viewer
74
75This tool is a editor/visualizer for the file generated by
76`intel_error2hangdump`. When replaying on simulation a few tweaks
77might be needed in order for the simulator to accept the input
78commands (this is due to divergences between the simulation & HW
79implementations).
80
81To visualize a file generated from a DG2 error state (from the mesa
82build directory) :
83```
84./src/intel/tools/intel_hang_viewer -p dg2 /tmp/error.dmp
85```
86
87To visualize and edit a file generated from a DG2 error state (from the mesa
88build directory) :
89```
90./src/intel/tools/intel_hang_viewer -e -p dg2 /tmp/error.dmp
91```
92