README

   1 This is a collection of tools for development and testing of the Intel DRM
   2 driver.  There are many macro-level test suites that get used against our
   3 driver, including xtest, rendercheck, piglit, and oglconform, but failures
   4 from those can be difficult to track down to kernel changes, and many require
   5 complicated build procedures or specific testing environments to get useful
   6 results.
   7
   8 Thus, intel-graphics-tools was a project I started to collect some low-level
   9 tools I intended to build.
  10
  11 benchmarks/
  12         This should be a collection of useful microbenchmarks.  The hope is
  13         that people can use these to tune some pieces of DRM code in relevant
  14         ways.
  15
  16         The benchmarks require KMS to be enabled.  When run with an X Server
  17         running, they must be run as root to avoid the authentication
  18         requirement.
  19
  20         Note that a few other microbenchmarks are in tests (like gem_gtt_speed).
  21
  22 tests/
  23         This is a set of automated tests to run against the DRM to validate
  24         changes.  Hopefully this can cover the relevant cases we need to
  25         worry about, including backwards compatibility.
  26
  27         Run this tests with "make test" as root from this directory. Note that
  28         no other drm clients (X server) may run.
  29
  30         "make test" only runs a default of test usefull for regression testing.
  31         Other tests not run are:
  32         - tests that might hang the gpu, see HANG in Makefile.am
  33         - gem_stress, a stress test suite. Look at the source for all the
  34           various options.
  35         - testdisplay is only run in the default mode. testdisplay has tons of
  36           options to test different kms functionality, again read the source of
  37           the details.
  38
  39 lib/
  40         Common helper functions and headers used by the other tools.
  41
  42 man/
  43         Manpages, unfortunately rather incomplete.
  44
  45 tools/
  46         This is a collection of debugging tools that had previously been
  47         built with the 2D driver but not shipped.  Some distros were hacking
  48         up the 2D build to ship them.  Instead, here's a separate package for
  49         people debugging the driver.
  50
  51         These tools generally must be run as root, safe for the ones that just
  52         decode dumps.
  53
  54 debugger/
  55         This tool is to be used to do shader debugging. It acts like a
  56         debug server accepting connections from debug clients such as
  57         mesa. The connections is made with unix domain sockets, and at some
  58         point it would be nice if this directory contained a library for
  59         initiating connections with debug clients..
  60
  61         The debugger must be run as root: "sudo debugger/eudb"