src/gallium/drivers/trace/README

   1                              TRACE PIPE DRIVER
   2
   3
   4 = About =
   5
   6 This directory contains a Gallium3D debugger pipe driver.
   7 It can traces all incoming calls and/or provide remote debugging functionality.
   8
   9
  10 = Build Instructions =
  11
  12 To build, invoke scons on the top dir as
  13
  14  scons dri=no statetrackers=mesa drivers=softpipe,i965simple,trace winsys=xlib
  15
  16
  17 = Usage =
  18
  19 To use do
  20
  21  export LD_LIBRARY_PATH=$PWD/build/linux-x86-debug/lib
  22
  23 ensure the right libGL.so is being picked by doing
  24
  25  ldd progs/trivial/tri
  26
  27 == Tracing ==
  28
  29 For tracing then do
  30
  31  GALLIUM_TRACE=tri.trace progs/trivial/tri
  32
  33 which should create a tri.trace file, which is an XML file. You can view copying
  34 trace.xsl to the same directory, and opening with a XSLT capable browser such as
  35 Firefox or Internet Explorer.
  36
  37 == Remote debugging ==
  38
  39 For remote debugging
  40
  41  export XMESA_TRACE=y
  42  GALLIUM_RBUG=true progs/trivial/tri
  43
  44 which should open gallium remote debugging session. While the program is running
  45 you can launch the small remote debugging application from progs/rbug. More
  46 information is in that directory.
  47
  48 = Integrating =
  49
  50 You can integrate the trace pipe driver either inside the state tracker or the
  51 winsys. The procedure on both cases is the same. Let's assume you have a
  52 pipe_screen and a pipe_context pair obtained by the usual means (variable and
  53 function names are just for illustration purposes):
  54
  55   real_screen = real_screen_create(...);
  56
  57   real_context = real_context_create(...);
  58
  59 The trace screen and pipe_context is then created by doing
  60
  61   trace_screen = trace_screen_create(real_screen);
  62
  63   trace_context = trace_context_create(trace_screen, real_context);
  64
  65 You can then simply use trace_screen and trace_context instead of real_screen
  66 and real_context.
  67
  68 Do not call trace_winsys_create. Simply pass trace_screen->winsys or
  69 trace_context->winsys in places you would pass winsys.
  70
  71 You can create as many contexts you wish. Just ensure that you don't mistake
  72 trace_screen with real_screen when creating them.
  73
  74
  75 --
  76 Jose Fonseca <jrfonseca@tungstengraphics.com>
  77 Jakob Bornecrantz <jakob@vmware.com>