X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=README.markdown;h=536729e81fcac8bbc121db5ca71b87d2b82210b5;hb=67964385bd2abb065787c52625ed19dbe08f2bf8;hp=f57836e37d06124f6b4eafeaefeb80e6310473e4;hpb=c7cc272ddcf5dbde3361f2a9a54427a77976da89;p=apitrace diff --git a/README.markdown b/README.markdown index f57836e..536729e 100644 --- a/README.markdown +++ b/README.markdown @@ -12,24 +12,38 @@ About **apitrace** * visualize and edit trace files. -Basic usage -=========== +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. -Linux and Mac OS X ------------------- + +Basic usage +=========== Run the application you want to trace as - apitrace trace /path/to/application [args...] + apitrace trace --api API /path/to/application [args...] 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. +directory. You can specify the written trace filename by passing the +`--output` command line option. + +Problems while tracing (e.g, if the application uses calls/parameters +unsupported by apitrace) will be reported via stderr output on Unices. On +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 --color application.trace | less -R + apitrace dump application.trace Replay an OpenGL trace with @@ -38,30 +52,49 @@ 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 -Windows -------- -* Copy `opengl32.dll`, `d3d8.dll`, or `d3d9.dll` from build/wrappers directory - to the directory with the application you want to trace. +Advanced command line usage +=========================== -* Run the application. -* View the trace with +Call sets +--------- - \path\to\apitrace dump application.trace +Several tools take `CALLSET` arguments, e.g: -* Replay the trace with + apitrace dump --calls CALLSET foo.trace + glretrace -S CALLSET foo.trace - \path\to\glretrace application.trace +The call syntax is very flexible. Here are a few examples: + * `4` one call + + * `1,2,4,5` set of calls + + * `"1 2 4 5"` set of calls (commas are optional and can be replaced with whitespace) + + * `1-100/2` calls 1, 3, 5, ..., 99 + + * `1-1000/draw` all draw calls between 1 and 1000 + + * `1-1000/fbo` all fbo changes between calls 1 and 1000 + + * `frame` all calls at end of frames + + * `@foo.txt` read call numbers from `foo.txt`, using the same syntax as above -Advanced command line usage -=========================== Tracing manually @@ -69,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 @@ -96,6 +137,10 @@ to trace by using `glxtrace.so` as an ordinary `libGL.so` and injecting into See the `ld.so` man page for more information about `LD_PRELOAD` and `LD_LIBRARY_PATH` environment flags. +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 + ### Mac OS X ### Run the application you want to trace as @@ -107,11 +152,35 @@ Note that although Mac OS X has an `LD_PRELOAD` equivalent, `DYLD_FORCE_FLAT_NAMESPACE=1` which breaks most applications. See the `dyld` man page for more details about these environment flags. +### Windows ### + +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. -Emitting annotations to the trace from GL applications ------------------------------------------------------- +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 emit string and frame annotations through the +You can specify the written trace filename by setting the `TRACE_FILE` +environment variable before running. + + +Emitting annotations to the trace +--------------------------------- + +From OpenGL applications you can embed annotations in the trace file through the [`GL_GREMEDY_string_marker`](http://www.opengl.org/registry/specs/GREMEDY/string_marker.txt) and [`GL_GREMEDY_frame_terminator`](http://www.opengl.org/registry/specs/GREMEDY/frame_terminator.txt) @@ -141,6 +210,15 @@ detect and use GL extensions, you could easily accomplish this by doing: This has the added advantage of working equally well with gDEBugger. +From OpenGL ES applications you can embed annotations in the trace file through the +[`GL_EXT_debug_marker`](http://www.khronos.org/registry/gles/extensions/EXT/EXT_debug_marker.txt) +extension. + + +For Direct3D applications you can follow the same procedure used for +[instrumenting an application for PIX](http://technet.microsoft.com/en-us/query/ee417250) + + Dump GL state at a particular call ---------------------------------- @@ -173,6 +251,18 @@ 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 +--------------- + +You can make a smaller trace by doing: + + apitrace trim --callset 100-1000 -o trimed.trace applicated.trace + +If you need precise control over which calls to trim you can specify the +individual call numbers a plaintext file, as described in the 'Call sets' +section above. + + Advanced usage for OpenGL implementors ====================================== @@ -186,13 +276,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: @@ -201,8 +289,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 @@ -270,16 +358,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 @@ -311,8 +403,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 ------ @@ -325,9 +421,11 @@ Open-source: * [tracy](https://gitorious.org/tracy): OpenGL ES and OpenVG trace, retrace, and state inspection +* [WebGL-Inspector](http://benvanik.github.com/WebGL-Inspector/) + Closed-source: -* [gDEBugger](http://www.gremedy.com/products.php) +* [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)