README.md

   1 # Building the OpenCL ICD Loader and Tests
   2
   3 The build system will build ICD Loader library (OpenCL.dll or libOpenCL.so), the
   4 ICD Loader Test binary (icd_loader_test), and some helper libraries for the test.
   5
   6 ## Linux
   7
   8 Run "make"
   9
  10 ## Windows
  11
  12 Run "build_using_cmake.bat"
  13
  14 ## Running ICD Test
  15
  16 The ICD Test can be run using ctest, which is a companion to cmake. It can also be
  17 run directly by executing icd_loader_test(.exe) executable from the bin folder.
  18
  19 ### Linux
  20
  21 1. Add driver stub as an ICD
  22     echo full/path/to/libOpenCLDriverStub.so > /etc/OpenCL/vendors/test.icd
  23
  24 2. Run test using ctest
  25     make test
  26
  27 ### Windows
  28
  29 1. Add driver stub as an ICD by adding appropriate registry value
  30     Key for 32-bit apps: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Khronos\OpenCL\Vendors
  31     Key for 64-bit apps: HKEY_LOCAL_MACHINE\SOFTWARE\Khronos\OpenCL\Vendors
  32
  33     Add a REG_DWORD value:
  34         Name: c:/full/path/to/OpenCLDriverStub.dll
  35         Data: 0
  36
  37     Note: The build_using_cmake.bat builds ICD test as a 32-bit binary.
  38
  39 2. Run test using ctest.exe
  40     cd build
  41     ctest.exe
  42
  43 ### Cleanup
  44
  45 Manually remove the registry key or .icd files added for running the ICD test.
  46
  47 The "build" and "bin" folders are autogenerated by the build so those may be
  48 safely deleted without losing any source code (on Linux "make clobber" will
  49 delete them).