Changes between Version 1 and Version 2 of ClrxWrapper


Ignore:
Timestamp:
10/27/15 20:41:43 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ClrxWrapper

    v1 v2  
    11{{{
    2 #!Markdown
    3 ## CLRadeonExtender CLRXWrapper
    4 
    5 CLRXWrapper embeds and integrates the assembler into AMD Catalyst OpenCL implementation.
     2#!html
     3<h2>CLRadeonExtender CLRXWrapper</h2>
     4<p>CLRXWrapper embeds and integrates the assembler into AMD Catalyst OpenCL implementation.
    65It make possible to call an assembler from OpenCL applications. Assembler will be called
    7 when special build options will be added: `-xasm` or `-x asm`.
    8 
    9 ### Installation
    10 
    11 By default, CLRXWrapper is not enabled. To enable CLRX wrapper few step should be done:
    12 
    13 * remove `amdocl32.icd` or `amdocl64.icd` (if 64-bit systems) in `/etc/OpenCL/vendors`
    14 directory
    15 * write `clrx.icd` with content `libCLRXWrapper.so` in  `/etc/OpenCL/vendors`
    16 directory
    17 
    18 Before below steps, we recommend to make copy of `/etc/OpenCL/vendors` directory.
    19 
    20 ### Additional build options
    21 
    22 * **-xasm**, **-x asm**
    23 
    24     compile program by using CLRX assembler
    25 
    26 * **-D SYMBOL=[VALUE]**, **-defsym=SYMBOL[=VALUE]**
    27 
    28     Define symbol. Value is optional and if it is not given then assembler set 0 by default.
    29 This option can be occurred many times to defining many symbols.
    30 
    31 * **-I PATH**, **-includePath=PATH**
    32 
    33     Add an include path to search path list. Assembler begins search from current directory
     6when special build options will be added: <code>-xasm</code> or <code>-x asm</code>.</p>
     7<h3>Installation</h3>
     8<p>By default, CLRXWrapper is not enabled. To enable CLRX wrapper few step should be done:</p>
     9<ul>
     10<li>remove <code>amdocl32.icd</code> or <code>amdocl64.icd</code> (if 64-bit systems) in <code>/etc/OpenCL/vendors</code>
     11directory</li>
     12<li>write <code>clrx.icd</code> with content <code>libCLRXWrapper.so</code> in  <code>/etc/OpenCL/vendors</code>
     13directory</li>
     14</ul>
     15<p>Before below steps, we recommend to make copy of <code>/etc/OpenCL/vendors</code> directory.</p>
     16<h3>Additional build options</h3>
     17<ul>
     18<li>
     19<p><strong>-xasm</strong>, <strong>-x asm</strong></p>
     20<p>compile program by using CLRX assembler</p>
     21</li>
     22<li>
     23<p><strong>-D SYMBOL=[VALUE]</strong>, <strong>-defsym=SYMBOL[=VALUE]</strong></p>
     24<p>Define symbol. Value is optional and if it is not given then assembler set 0 by default.
     25This option can be occurred many times to defining many symbols.</p>
     26</li>
     27<li>
     28<p><strong>-I PATH</strong>, <strong>-includePath=PATH</strong></p>
     29<p>Add an include path to search path list. Assembler begins search from current directory
    3430and follows to next include paths.
    35 This option can be occurred many times to adding many include paths.
    36 
    37 * **-forceAddSymbols**
    38 
    39     Add all non-local symbols to binaries. By default any assembler does not add any symbols
    40 to keep compatibility with original format.
    41 
    42 * **-w**
    43     Do not print all warnings.
    44 
    45 ### Environment variables
    46 
    47 * CLRX_FORCE_ORIGINAL_AMDOCL=1|0 - enable forcing of the original AMDOCL
    48 * CLRX_AMDOCL_PATH=PATH - set path to AMDOCL library
    49 
    50 ### Usage
    51 
    52 Sample call: `clBuildProgram(program, num_devices, devices, "-xasm", NULL, NULL);`
    53 }}}
     31This option can be occurred many times to adding many include paths.</p>
     32</li>
     33<li>
     34<p><strong>-forceAddSymbols</strong></p>
     35<p>Add all non-local symbols to binaries. By default any assembler does not add any symbols
     36to keep compatibility with original format.</p>
     37</li>
     38<li>
     39<p><strong>-w</strong>
     40    Do not print all warnings.</p>
     41</li>
     42</ul>
     43<h3>Environment variables</h3>
     44<ul>
     45<li>CLRX_FORCE_ORIGINAL_AMDOCL=1|0 - enable forcing of the original AMDOCL</li>
     46<li>CLRX_AMDOCL_PATH=PATH - set path to AMDOCL library</li>
     47</ul>
     48<h3>Usage</h3>
     49<p>Sample call: <code>clBuildProgram(program, num_devices, devices, "-xasm", NULL, NULL);</code></p>}}}