X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=README.markdown;h=7d858371ca4e9ea0552a619b45ac97ec7207b94b;hb=13ae9a9b9844db27dd33e0274984f0caf0e1e370;hp=ce00ca5d123ee39e49bc30337559ab13ad437500;hpb=c4e76a988d2bda4e4e211b5596f1ae3de504fec8;p=apitrace diff --git a/README.markdown b/README.markdown index ce00ca5..7d85837 100644 --- a/README.markdown +++ b/README.markdown @@ -3,7 +3,7 @@ About **apitrace** **apitrace** consists of a set of tools to: -* trace OpenGL, OpenGL ES, D3D9, D3D8, D3D7, and DDRAW APIs calls to a file; +* trace OpenGL, OpenGL ES, Direct3D, and DirectDraw APIs calls to a file; * retrace OpenGL and OpenGL ES calls from a file; @@ -12,6 +12,16 @@ About **apitrace** * visualize and edit trace files. +Obtaining **apitrace** +====================== + +To obtain apitrace either [download the latest +binaries](https://github.com/apitrace/apitrace/downloads) for your platform if +available, or follow the instructions in INSTALL.markdown to build it yourself. +On 64bits Linux and Windows platforms you'll need apitrace binaries that match +the architecture (32bits or 64bits) of the application being traced. + + Basic usage =========== @@ -29,6 +39,8 @@ Windows you'll need to run [DebugView](http://technet.microsoft.com/en-us/sysinternals/bb896647) to view these messages. +Follow the "Tracing manually" instructions below if you cannot obtain a trace. + View the trace with apitrace dump application.trace @@ -40,10 +52,18 @@ Replay an OpenGL trace with Pass the `-sb` option to use a single buffered visual. Pass `--help` to glretrace for more options. + +Basic GUI usage +=============== + Start the GUI as qapitrace application.trace +You can also tell the GUI to go directly to a specific call + + qapitrace application.trace 12345 + Advanced command line usage =========================== @@ -82,6 +102,14 @@ Tracing manually ### Linux ### +On 64 bits systems, you'll need to determine ether the application is 64 bits +or 32 bits. This can be done by doing + + file /path/to/application + +But beware of wrapper shell scripts -- what matters is the architecture of the +main process. + Run the application you want to trace as LD_PRELOAD=/path/to/apitrace/wrappers/glxtrace.so /path/to/application @@ -90,14 +118,14 @@ and it will generate a trace named `application.trace` in the current directory. You can specify the written trace filename by setting the `TRACE_FILE` environment variable before running. -The `LD_PRELOAD` mechanism should work with most applications. There are some -applications, e.g., Unigine Heaven, which global function pointers with the -same name as GL entrypoints, living in a shared object that wasn't linked with -`-Bsymbolic` flag, so relocations to those globals function pointers get -overwritten with the address to our wrapper library, and the application will -segfault when trying to write to them. For these applications it is possible -to trace by using `glxtrace.so` as an ordinary `libGL.so` and injecting into -`LD_LIBRARY_PATH`: +The `LD_PRELOAD` mechanism should work with the majority applications. There +are some applications (e.g., Unigine Heaven, Android GPU emulator, etc.), that +have global function pointers with the same name as GL entrypoints, living in a +shared object that wasn't linked with `-Bsymbolic` flag, so relocations to +those globals function pointers get overwritten with the address to our wrapper +library, and the application will segfault when trying to write to them. For +these applications it is possible to trace by using `glxtrace.so` as an +ordinary `libGL.so` and injecting it via `LD_LIBRARY_PATH`: ln -s glxtrace.so wrappers/libGL.so ln -s glxtrace.so wrappers/libGL.so.1 @@ -106,6 +134,9 @@ to trace by using `glxtrace.so` as an ordinary `libGL.so` and injecting into export TRACE_LIBGL=/path/to/real/libGL.so.1 /path/to/application +If you are an application developer, you can avoid this either by linking with +`-Bsymbolic` flag, or by using some unique prefix for your function pointers. + See the `ld.so` man page for more information about `LD_PRELOAD` and `LD_LIBRARY_PATH` environment flags. @@ -113,6 +144,63 @@ To trace the application inside gdb, invoke gdb as: gdb --ex 'set exec-wrapper env LD_PRELOAD=/path/to/glxtrace.so' --args /path/to/application +### Android ### + +The following instructions should work at least for Android Ice Scream +Sandwitch: + +For standalone applications the instructions above for Linux should +work. To trace applications started from within the Android VM process +(`app_process` aka zygote) you'll have to wrap this process and enable +tracing dynamically for the application to be traced. + +- Wrapping the android main VM process: + + In the Android root /init.rc add the `LD_PRELOAD` setting to zygote's + environment in the 'service zygote' section: + + service zygote ... + setenv LD_PRELOAD /data/egltrace.so + ... + + Note that ICS will overwrite the /init.rc during each boot with the + version in the recovery image. So you'll have to change the file in + your ICS source tree, rebuild and reflash the device. + Rebuilding/reflashing only the recovery image should be sufficient. + +- Copy egltrace.so to /data + + On the host: + + adb push /path/to/apitrace/build/wrappers/egltrace.so /data + +- Adjust file permissions to store the trace file: + + By default egltrace.so will store the trace in + `/data/app_process.trace`. For this to work for applications running + with a uid other than 0, you have to allow writes to the `/data` + directory on the device: + + chmod 0777 /data + +- Enable tracing for a specific process name: + + To trace for example the Settings application: + + setprop debug.apitrace.procname com.android.settings + + In general this name will match what `ps` reports. + +- Start the application: + + If the application was already running, for example due to ICS's way + of pre-starting the apps, you might have to kill the application + first: + + kill + + Launch the application for example from the application menu. + ### Mac OS X ### Run the application you want to trace as @@ -126,9 +214,24 @@ page for more details about these environment flags. ### Windows ### -Copy `opengl32.dll`, `d3d8.dll`, or `d3d9.dll` from the wrappers directory -to the directory with the application you want to trace. Then run the -application. +When tracing third-party applications, you can identify the target +application's main executable, either by: + +* right clicking on the application's icon in the _Start Menu_, choose + _Properties_, and see the _Target_ field; + +* or by starting the application, run Windows Task Manager (taskmgr.exe), right + click on the application name in the _Applications_ tab, choose _Go To Process_, + note the highlighted _Image Name_, and search it on `C:\Program Files` or + `C:\Program Files (x86)`. + +On 64 bits Windows, you'll need to determine ether the application is a 64 bits +or 32 bits. 32 bits applications will have a `*32` suffix in the _Image Name_ +column of the _Processes_ tab of _Windows Task Manager_ window. + +Copy the appropriate `opengl32.dll`, `d3d8.dll`, or `d3d9.dll` from the +wrappers directory to the directory with the application you want to trace. +Then run the application as usual. You can specify the written trace filename by setting the `TRACE_FILE` environment variable before running. @@ -208,8 +311,8 @@ You can make a video of the output by doing | ffmpeg -r 30 -f image2pipe -vcodec ppm -i pipe: -vcodec mpeg4 -y output.mp4 -Triming a trace ---------------- +Trimming a trace +---------------- You can make a smaller trace by doing: @@ -220,6 +323,27 @@ individual call numbers a plaintext file, as described in the 'Call sets' section above. +Profiling a trace +----------------- + +You can perform gpu and cpu profiling with the command line options: + + * `-pgpu` record gpu times for frames and draw calls. + + * `-pcpu` record cpu times for frames and draw calls. + + * `-ppd` record pixels drawn for each draw call. + +The results from this can then be read by hand or analysed with a script. + +`scripts/profileshader.py` will read the profile results and format them into a +table which displays profiling results per shader. + +For example, to record all profiling data and utilise the per shader script: + + ./glretrace -pgpu -pcpu -ppd foo.trace | ./scripts/profileshader.py + + Advanced usage for OpenGL implementors ====================================== @@ -233,13 +357,11 @@ These are the steps to create a regression test-suite around **apitrace**: * obtain a trace -* obtain reference snapshots, by doing: +* obtain reference snapshots, by doing on a reference system: - mkdir /path/to/snapshots/ + mkdir /path/to/reference/snapshots/ glretrace -s /path/to/reference/snapshots/ application.trace - on reference system. - * prune the snapshots which are not interesting * to do a regression test, do: @@ -248,8 +370,8 @@ These are the steps to create a regression test-suite around **apitrace**: Alternatively, for a HTML summary, use `apitrace diff-images`: - glretrace -s /path/to/current/snapshots/ application.trace - apitrace diff-images --output summary.html /path/to/reference/snapshots/ /path/to/current/snapshots/ + glretrace -s /path/to/test/snapshots/ application.trace + apitrace diff-images --output summary.html /path/to/reference/snapshots/ /path/to/test/snapshots/ Automated git-bisection @@ -317,16 +439,20 @@ reference software renderer. This can be achieved with retracediff.py script, which invokes glretrace with different environments, allowing to choose the desired GL driver by -manipulating variables such as `LD_LIBRARY_PATH` or `LIBGL_DRIVERS_DIR`. +manipulating variables such as `LD_LIBRARY_PATH`, `LIBGL_DRIVERS_DIR`, or +`TRACE_LIBGL`. -For example: +For example, on Linux: ./scripts/retracediff.py \ --ref-env LD_LIBRARY_PATH=/path/to/reference/GL/implementation \ - -r ./glretrace \ + --retrace /path/to/glretrace \ --diff-prefix=/path/to/output/diffs \ application.trace +Or on Windows: + + python scripts\retracediff.py --retrace \path\to\glretrace.exe --ref-env TRACE_LIBGL=\path\to\reference\opengl32.dll application.trace Links @@ -358,8 +484,12 @@ Closed-source: * [D3DSpy](http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm): the predecessor of PIX +* [NVIDIA PerfKit](http://developer.nvidia.com/nvidia-perfkit) + * [AMD GPU PerfStudio](http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx) +* [Intel Graphics Performance Analyzers](http://www.intel.com/software/gpa/) + OpenGL ------ @@ -372,11 +502,15 @@ Open-source: * [tracy](https://gitorious.org/tracy): OpenGL ES and OpenVG trace, retrace, and state inspection -Closed-source: +* [WebGL-Inspector](http://benvanik.github.com/WebGL-Inspector/) -* [gDEBugger](http://www.gremedy.com/products.php) +Closed-source: -* [glslDevil](http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html) +* [AMD CodeXL](http://developer.amd.com/tools/hc/CodeXL/Pages/default.aspx) * [AMD GPU PerfStudio](http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx) +* [gDEBugger](http://www.gremedy.com/products.php) and [AMD gDEBugger](http://developer.amd.com/tools/gDEBugger/Pages/default.aspx) + +* [glslDevil](http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html) +