source: CLRX/CLRadeonExtender/trunk/INSTALL @ 3224

Last change on this file since 3224 was 1913, checked in by matszpk, 4 years ago

CLRadeonExtender: Updated INSTALL file.

File size: 3.7 KB
Line 
1-----------------------------------------------------------------------
2                               CLRadeonExtender
3-----------------------------------------------------------------------
4
51. Installation prerequisities.
6
7CLRadeonExtender doesn't require many libraries and dependencies.
8It can be installed on the 32-bit/64-bit machines.
9Currently, the OpenCL support for AMD Catalyst (for the OpenCL applications)
10is disabled by default (enablement is not recommended in current development
11stage).
12
13This package provides source code and requires:
14
15* C++11 compliant compiler (Clang++ or GCC 4.7 or later)
16* GNU make tool
17* CMake system (2.6 or later)
18* Threads support (for Linux, recommended NPTL)
19* Unix-like (Linux or BSD) system or Windows system
20
21Optionally for clwrapper (an OpenCL wrapper that replaces AMD Catalyst driver
22behaviour) requires:
23
24* libOpenCL.so or OpenCL.dll
25* OpenCL ICD (for example from AMD Catalyst driver)
26* AMD Catalyst driver.
27
28These utilities is working with an OpenCL kernel binaries compiled for the
29Radeon GPU's based on GCN 1.0/1.1/1.2 architecture. Any binaries compiled
30for older Radeons (VLIW architecture) has not been handled.
31
322. Compilation
33
34To build system you should create a build directory in source code package:
35
36  mkdir build
37
38and run:
39
40  cmake .. [cmake options]
41
42Optional CMake configuration options for build:
43
44CMAKE_BUILD_TYPE - type of build (Release, Debug, GCCSan, GCCSSP).
45CMAKE_INSTALL_PREFIX - prefix for installation (for example '/usr/local')
46BUILD_32BIT - build also 32-bit binaries
47BUILD_TESTS - build all tests
48BUILD_SAMPLES - build OpenCL samples
49BUILD_DOCUMENTATION - build project documentation (doxygen, unix manuals, user doc)
50BUILD_DOXYGEN - build doxygen documentation
51BUILD_MANUAL - build Unix manual pages
52BUILD_CLRXDOC - build CLRX user documentation
53NO_STATIC - no static libraries
54OPENCL_DIST_DIR - an OpenCL directory distribution installation (optional)
55
56You can just add one or many of these options to cmake command:
57
58  cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON
59
60After creating Makefiles scripts you can compile project:
61
62  make or make -jX - where X is number of processors.
63
64After building you can check whether project is working (if you will build tests):
65
66  ctest
67 
682.1. Windows and MSVC
69
70CLRadeonExtender has been compiled under Windows 8.1 and Microsoft Visual Studio 2015
71Community version.
72
733. Installation
74
75Installation is easy. Just run command:
76
77  make install
78 
794. clwrapper
80
81CLWrapper integrates the CLRX assembler with the AMD Catalyst driver by using
82wrapper mechanism and embeds an assembler to AMD OpenCL implementation.
83Building an assembler programs will be possible by passing an '-xasm' option which
84should be appended to build options, like following example:
85
86clBuildProgram(program, num_devices, devices, "-xasm", NULL, NULL);
87
88Installation is easy. However, it requires some changes on an OpenCL configuration:
89
90Remove amdocl64.icd and/or amdocl32.icd (if 32-bit system)
91from directory '/etc/OpenCL/vendors'
92(before, we recommend to make backup that directory).
93Create the 'clrx.icd' file on /etc/OpenCL/vendors/ with content: 'libCLRXWrapper.so'.
94That's all. Now you can call an assembler through clBuildProgram on your applications.
95
96Important Attention: CLWrapper make some changes on the program environment and changes
97behaviour of the OpenCL routines. This is still an experimental stuff and
98we recommend to not using its on the deployed/production systems.
99
100DO NOT FORGET to revert these changes before uninstallation.
101
1025. Uninstallation
103
104In a build directory is a 'install_manifest.txt' file that contains all installed files.
105You can remove these files by using command:
106
107  rm -f `cat install_manifest.txt`
108
109DO NOT FORGET to keep 'build' directory after installation.
Note: See TracBrowser for help on using the repository browser.