git.oblomov.eu Git - clinfo/blob - README.md

   1 # What is this?
   2
   3 clinfo is a simple command-line application that enumerates all possible
   4 (known) properties of the OpenCL platform and devices available on the
   5 system.
   6
   7 Inspired by AMD's program of the same name, it is coded in pure C and it
   8 tries to output all possible information, including those provided by
   9 platform-specific extensions, trying not to crash on unsupported
  10 properties (e.g. 1.2 properties on 1.1 platforms).
  11
  12 # Usage
  13
  14     clinfo [options...]
  15
  16 Common used options are `-l` to show a synthetic summary of the
  17 available devices (without properties), and `-a`, to try and show
  18 properties even if `clinfo` would otherwise think they aren't supported
  19 by the platform or device.
  20
  21 Refer to the man page for further information.
  22
  23 ## Use cases
  24
  25 * verify that your OpenCL environment is set up correctly;
  26   if `clinfo` cannot find any platform or devices (or fails to load
  27   the OpenCL dispatcher library), chances are high no other OpenCL
  28   application will run;
  29 * verify that your OpenCL _development_ environment is set up
  30   correctly: if `clinfo` fails to build, chances are high no
  31   other OpenCL application will build;
  32 * explore/report the actual properties of the available device(s).
  33
  34 ## Segmentation faults
  35
  36 Some faulty OpenCL platforms may cause `clinfo` to crash. There isn't
  37 much `clinfo` itself can do about it, but you can try and isolate the
  38 platform responsible for this. On POSIX systems, you can generally find
  39 the platform responsible for the fault with the following one-liner:
  40
  41     find /etc/OpenCL/vendors/ -name '*.icd' | while read OPENCL_VENDOR_PATH ; do clinfo -l > /dev/null ; echo "$? ${OPENCL_VENDOR_PATH}" ; done
  42
  43 ## Missing information
  44
  45 If you know of device properties that are exposed in OpenCL (either as core
  46 properties or as extensions), but are not shown by `clinfo`, please [open
  47 an issue](https://github.com/Oblomov/clinfo/issues) providing as much
  48 information as you can. Patches and pull requests accepted too.
  49
  50
  51 # Building
  52
  53 <img
  54 src='https://api.travis-ci.org/Oblomov/clinfo.svg?branch=master'
  55 alt='Build status on Travis'
  56 style='float: right'>
  57
  58 Building requires an OpenCL SDK (or at least OpenCL headers and
  59 development files), and the standard build environment for the platform.
  60 No special build system is used (autotools, CMake, meson, ninja, etc),
  61 as I feel adding more dependencies for such a simple program would be
  62 excessive. Simply running `make` at the project root should work.
  63
  64 ## Windows support
  65
  66 The application can usually be built in Windows too (support for which
  67 required way more time than I should have spent, really, but I digress),
  68 by running `make` in a Developer Command Prompt for Visual Studio,
  69 provided an OpenCL SDK (such as the Intel or AMD one) is installed.
  70
  71 Precompiled Windows executable are available as artefacts of the
  72 AppVeyor CI.
  73
  74 <table style='margin: 1em auto; width: 100%; max-width: 33em'>
  75 <tr><th>Build status</th><th colspan=2>Windows binaries</th></tr>
  76 <tr>
  77 <td><a href='https://ci.appveyor.com/project/Oblomov/clinfo/'><img
  78 src='https://ci.appveyor.com/api/projects/status/github/Oblomov/clinfo?svg=true'
  79 alt='Build status on AppVeyor'></a></td>
  80 <td><a href='https://ci.appveyor.com/api/projects/oblomov/clinfo/artifacts/clinfo.exe?job=platform%3a+x86'>32-bit</a></td>
  81 <td><a href='https://ci.appveyor.com/api/projects/oblomov/clinfo/artifacts/clinfo.exe?job=platform%3a+x64'>64-bit</a></td>
  82 </tr>
  83 </table>