[wiki:ClrxToc Back to Table of content]
{{{
#!html
<h2>CLRadeonExtender CLRXWrapper</h2>
<p>CLRXWrapper embeds and integrates the assembler into AMD Catalyst OpenCL implementation.
It make possible to call an assembler from OpenCL applications. Assembler will be called
when special build options will be added: <code>-xasm</code> or <code>-x asm</code>.</p>
<h3>Installation</h3>
<p>By default, CLRXWrapper is not enabled. To enable CLRX wrapper few step should be done:</p>
<ul>
<li>remove <code>amdocl32.icd</code> or <code>amdocl64.icd</code> (if 64-bit systems) in <code>/etc/OpenCL/vendors</code>
directory</li>
<li>write <code>clrx.icd</code> with content <code>libCLRXWrapper.so</code> in  <code>/etc/OpenCL/vendors</code>
directory</li>
</ul>
<p>Before below steps, we recommend to make copy of <code>/etc/OpenCL/vendors</code> directory.</p>
<p>Installation on Windows:</p>
<ul>
<li>copy all CLRX libraries and CLRXWrapper into AMDAPP directory or OpenCL directory</li>
<li>run RegEdit and go to <code>HKEY_LOCAL_MACHINE\SOFTWARE\Khronos\OpenCL\Vendors\</code></li>
<li>remove <code>amdocl32.dll</code> or <code>amdocl64.dll</code> key</li>
<li>add a DWORD <code>CLRXWrapper.dll</code> key with value 0</li>
<li>additionally, set system environment variable to path to CLRX_AMDOCL_PATH dynamic library</li>
</ul>
<p>WARNING: CLRXWrapper has been tested under Linux. This part of CLRadeonExtender can behave
very unexpectedly under Windows.</p>
<h3>Additional build options</h3>
<ul>
<li>
<p><strong>-xasm</strong>, <strong>-x asm</strong></p>
<p>compile program by using CLRX assembler</p>
</li>
<li>
<p><strong>-D SYMBOL[=VALUE]</strong>, <strong>-defsym=SYMBOL[=VALUE]</strong></p>
<p>Define symbol. Value is optional and if it is not given then assembler set 0 by default.
This option can be occurred many times to defining many symbols.</p>
</li>
<li>
<p><strong>-I PATH</strong>, <strong>-includePath=PATH</strong></p>
<p>Add an include path to search path list. Assembler begins search from current directory
and follows to next include paths.
This option can be occurred many times to adding many include paths.</p>
</li>
<li>
<p><strong>-forceAddSymbols</strong></p>
<p>Add all non-local symbols to binaries. By default any assembler does not add any symbols
to keep compatibility with original format.</p>
</li>
<li>
<p><strong>-buggyFPLit</strong></p>
<p>Choose old and buggy floating point literals rules (to 0.1.2 version)
for compatibility.</p>
</li>
<li>
<p><strong>-oldModParam</strong></p>
<p>Choose old modifier parametrization that accepts only 0 and 1 values (to 0.1.5 version)
for compatibility.</p>
</li>
<li>
<p><strong>-noMacroCase</strong>
    Do not ignore letter's case in macro names (by default is ignored).</p>
</li>
<li>
<p><strong>-w</strong>
    Do not print all warnings.</p>
</li>
<li>
<p><strong>-legacy</strong>
    Force use legacy AMD Catalyst OpenCL 1.2 binary format instead AMD OpemCL 2.0.</p>
</li>
<li>
<p><strong>-policy=VERSION</strong>
    Set CLRX assembler policy version.</p>
</li>
</ul>
<h3>Environment variables</h3>
<ul>
<li>CLRX_FORCE_ORIGINAL_AMDOCL=1|0 - enable forcing of the original AMDOCL</li>
<li>CLRX_AMDOCL_PATH=PATH - set path to AMDOCL library</li>
</ul>
<h3>Usage</h3>
<p>Sample call: <code>clBuildProgram(program, num_devices, devices, "-xasm", NULL, NULL);</code></p>
}}}