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 == Traceing ==
  28
  29 For traceing then do
  30
  31  export XMESA_TRACE=y
  32  GALLIUM_TRACE=tri.trace progs/trivial/tri
  33
  34 which should create a tri.trace file, which is an XML file. You can view copying
  35 trace.xsl to the same directory, and opening with a XSLT capable browser such as
  36 Firefox or Internet Explorer.
  37
  38 == Remote debugging ==
  39
  40 For remote debugging
  41
  42  export XMESA_TRACE=y
  43  GALLIUM_RBUG=true progs/trivial/tri
  44
  45 which should open gallium remote debugging session. While the program is running
  46 you can launch the small remote debugging application from progs/rbug. More
  47 information is in that directory.
  48
  49 = Integrating =
  50
  51 You can integrate the trace pipe driver either inside the state tracker or the
  52 winsys. The procedure on both cases is the same. Let's assume you have a
  53 pipe_screen and a pipe_context pair obtained by the usual means (variable and
  54 function names are just for illustration purposes):
  55
  56   real_screen = real_screen_create(...);
  57
  58   real_context = real_context_create(...);
  59
  60 The trace screen and pipe_context is then created by doing
  61
  62   trace_screen = trace_screen_create(real_screen);
  63
  64   trace_context = trace_context_create(trace_screen, real_context);
  65
  66 You can then simply use trace_screen and trace_context instead of real_screen
  67 and real_context.
  68
  69 Do not call trace_winsys_create. Simply pass trace_screen->winsys or
  70 trace_context->winsys in places you would pass winsys.
  71
  72 You can create as many contexts you wish. Just ensure that you don't mistake
  73 trace_screen with real_screen when creating them.
  74
  75
  76 --
  77 Jose Fonseca <jrfonseca@tungstengraphics.com>
  78 Jakob Bornecrantz <jakob@vmware.com>