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 set of tests and is useful for
  31         regression testing. 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 for
  37           the details.
  38
  39         The more comfortable way to run tests is with piglit. First grab piglit
  40         from:
  41
  42         git://anongit.freedesktop.org/piglit
  43
  44         and build it (no need to install anything). Then we need to link up the
  45         i-g-t sources with piglit
  46
  47         piglit-sources $ cd bin
  48         piglit-sources/bin $ ln $i-g-t-sources igt -s
  49
  50         The tests in the i-g-t sources need to have been built already. Then we
  51         can run the testcases with (as usual as root, no other drm clients
  52         running):
  53
  54         piglit-sources # ./piglit-run.py tests/igt.tests <results-file>
  55
  56         The testlist is built at runtime, so no need to update anything in
  57         piglit when adding new tests. See
  58
  59         piglit-sources $ ./piglit-run.py -h
  60
  61         for some useful options.
  62
  63 lib/
  64         Common helper functions and headers used by the other tools.
  65
  66 man/
  67         Manpages, unfortunately rather incomplete.
  68
  69 tools/
  70         This is a collection of debugging tools that had previously been
  71         built with the 2D driver but not shipped.  Some distros were hacking
  72         up the 2D build to ship them.  Instead, here's a separate package for
  73         people debugging the driver.
  74
  75         These tools generally must be run as root, safe for the ones that just
  76         decode dumps.
  77
  78 tools/quick_dump
  79         Quick dumper is a python tool built with SWIG bindings to
  80         important libraries exported by the rest of the tool suite. The tool
  81         itself is quite straight forward, and should also be a useful example
  82         for others wishing to write python based i915 tools.
  83
  84         Note to package maintainers: It is not recommended to package
  85         this directory, as the tool is not yet designed for wide usage. If the
  86         package is installed via "make install" the users will have to set
  87         their python library path appropriately. Use --disable-dumper
  88
  89 debugger/
  90         This tool is to be used to do shader debugging. It acts like a
  91         debug server accepting connections from debug clients such as
  92         mesa. The connections is made with unix domain sockets, and at some
  93         point it would be nice if this directory contained a library for
  94         initiating connections with debug clients..
  95
  96         The debugger must be run as root: "sudo debugger/eudb"