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         Note: The old automake based testrunner had to be scraped due to
  28         upstream changes which broke dynamic creation of the test list. Of
  29         course it is still possible to directly run tests, even when not always
  30         limiting tests to specific subtests (like piglit does).
  31
  32         The more comfortable way to run tests is with piglit. First grab piglit
  33         from:
  34
  35         git://anongit.freedesktop.org/piglit
  36
  37         and build it (no need to install anything). Then we need to link up the
  38         i-g-t sources with piglit
  39
  40         piglit-sources $ cd bin
  41         piglit-sources/bin $ ln $i-g-t-sources igt -s
  42
  43         The tests in the i-g-t sources need to have been built already. Then we
  44         can run the testcases with (as usual as root, no other drm clients
  45         running):
  46
  47         piglit-sources # ./piglit-run.py tests/igt.tests <results-file>
  48
  49         The testlist is built at runtime, so no need to update anything in
  50         piglit when adding new tests. See
  51
  52         piglit-sources $ ./piglit-run.py -h
  53
  54         for some useful options.
  55
  56         Piglit only runs a default set of tests and is useful for regression
  57         testing. Other tests not run are:
  58         - tests that might hang the gpu, see HANG in Makefile.am
  59         - gem_stress, a stress test suite. Look at the source for all the
  60           various options.
  61         - testdisplay is only run in the default mode. testdisplay has tons of
  62           options to test different kms functionality, again read the source for
  63           the details.
  64
  65         When creating new tests or subtests please read and follow
  66         tests/NAMING-CONVENTION.
  67
  68 lib/
  69         Common helper functions and headers used by the other tools.
  70
  71 man/
  72         Manpages, unfortunately rather incomplete.
  73
  74 tools/
  75         This is a collection of debugging tools that had previously been
  76         built with the 2D driver but not shipped.  Some distros were hacking
  77         up the 2D build to ship them.  Instead, here's a separate package for
  78         people debugging the driver.
  79
  80         These tools generally must be run as root, safe for the ones that just
  81         decode dumps.
  82
  83 tools/quick_dump
  84         Quick dumper is a python tool built with SWIG bindings to
  85         important libraries exported by the rest of the tool suite. The tool
  86         itself is quite straight forward, and should also be a useful example
  87         for others wishing to write python based i915 tools.
  88
  89         Note to package maintainers: It is not recommended to package
  90         this directory, as the tool is not yet designed for wide usage. If the
  91         package is installed via "make install" the users will have to set
  92         their python library path appropriately. Use --disable-dumper
  93
  94 debugger/
  95         This tool is to be used to do shader debugging. It acts like a
  96         debug server accepting connections from debug clients such as
  97         mesa. The connections is made with unix domain sockets, and at some
  98         point it would be nice if this directory contained a library for
  99         initiating connections with debug clients..
 100
 101         The debugger must be run as root: "sudo debugger/eudb"
 102
 103 DEPENDENCIES
 104         This is a non-exchaustive list of package dependencies required for
 105         building everything:
 106
 107         libpciaccess-dev
 108         libdrm-dev
 109         xutils-dev
 110         libcairo2-dev
 111         swig2.0
 112         libpython3.3-dev
 113         x11proto-dri2-dev