[a81f3ed] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY spirv-llvm-translator-download-http "https://github.com/KhronosGroup/SPIRV-LLVM-Translator/archive/v&spirv-llvm-translator-version;/SPIRV-LLVM-Translator-&spirv-llvm-translator-version;.tar.gz">
|
---|
[7cb4485c] | 8 | <!ENTITY spirv-llvm-translator-md5sum "094ff60909ada1e76e87da90df053be6">
|
---|
[a81f3ed] | 9 | <!ENTITY spirv-llvm-translator-size "1.6 MB">
|
---|
[7cb4485c] | 10 | <!ENTITY spirv-llvm-translator-buildsize "36 MB">
|
---|
| 11 | <!ENTITY spirv-llvm-translator-time "0.6 SBU (with parallelism=4)">
|
---|
[a81f3ed] | 12 | ]>
|
---|
| 13 |
|
---|
| 14 | <sect1 id="spirv-llvm-translator" xreflabel="SPIRV-LLVM-Translator-&spirv-llvm-translator-version;">
|
---|
| 15 | <?dbhtml filename="spirv-llvm-translator.html"?>
|
---|
| 16 |
|
---|
| 17 | <title>SPIRV-LLVM-Translator-&spirv-llvm-translator-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="spirv-llvm-translator">
|
---|
| 20 | <primary sortas="a-spirv-llvm-translator">SPIRV-LLVM-Translator</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title>Introduction to SPIRV-LLVM-Translator</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>SPIRV-LLVM-Translator</application> package contains a
|
---|
| 28 | library and utility for converting between LLVM IR and SPIR-V code.
|
---|
| 29 | This package currently only supports the OpenCL/Compute version of SPIR-V.
|
---|
| 30 | </para>
|
---|
| 31 |
|
---|
[d4dc5bae] | 32 | &lfs122_checked;
|
---|
[a81f3ed] | 33 |
|
---|
| 34 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&spirv-llvm-translator-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download MD5 sum: &spirv-llvm-translator-md5sum;
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download size: &spirv-llvm-translator-size;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Estimated disk space required: &spirv-llvm-translator-buildsize;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated build time: &spirv-llvm-translator-time;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | </itemizedlist>
|
---|
| 62 |
|
---|
| 63 | <bridgehead renderas="sect3">SPIRV-LLVM-Translator Dependencies</bridgehead>
|
---|
| 64 |
|
---|
| 65 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 66 | <para role="required">
|
---|
| 67 | <xref linkend="libxml2"/>,
|
---|
| 68 | <xref linkend="llvm"/>, and
|
---|
| 69 | <xref linkend="spirv-tools"/>
|
---|
| 70 | </para>
|
---|
| 71 |
|
---|
| 72 | </sect2>
|
---|
| 73 |
|
---|
| 74 | <sect2 role="installation">
|
---|
| 75 | <title>Installation of SPIRV-LLVM-Translator</title>
|
---|
| 76 |
|
---|
| 77 | <para>
|
---|
| 78 | Install <application>SPIRV-LLVM-Translator</application> by running the following
|
---|
| 79 | commands:
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <screen><userinput>mkdir build &&
|
---|
| 83 | cd build &&
|
---|
| 84 |
|
---|
[3f573f1] | 85 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 86 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 87 | -D BUILD_SHARED_LIBS=ON \
|
---|
| 88 | -D CMAKE_SKIP_INSTALL_RPATH=ON \
|
---|
| 89 | -D LLVM_EXTERNAL_SPIRV_HEADERS_SOURCE_DIR=/usr \
|
---|
| 90 | -G Ninja .. &&
|
---|
[a81f3ed] | 91 | ninja</userinput></screen>
|
---|
| 92 |
|
---|
| 93 | <!-- This package does come with a test suite, but needs an internal
|
---|
| 94 | utility from LLVM's source tree. Let's not mention it for now. -->
|
---|
| 95 | <para>
|
---|
| 96 | This package does not come with a test suite.
|
---|
| 97 | </para>
|
---|
| 98 |
|
---|
| 99 | <para>
|
---|
| 100 | Now, as the &root; user:
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
| 104 |
|
---|
| 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="commands">
|
---|
| 108 | <title>Command Explanations</title>
|
---|
| 109 |
|
---|
| 110 | <para>
|
---|
[d7634e94] | 111 | <parameter>-D BUILD_SHARED_LIBS=ON</parameter>: This parameter forces
|
---|
[a81f3ed] | 112 | building shared versions of the libraries.
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
[e0b539b] | 115 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 116 | href="../../xincludes/cmake-skip-install-rpath.xml"/>
|
---|
| 117 |
|
---|
[a81f3ed] | 118 | <para>
|
---|
[3f573f1] | 119 | <parameter>-D LLVM_EXTERNAL_SPIRV_HEADERS_SOURCE_DIR=/usr</parameter>:
|
---|
| 120 | This parameter allows the build system to use the version of
|
---|
| 121 | SPIRV-Headers that should have been installed as a dependency of
|
---|
| 122 | SPIRV-Tools, instead of redownloading an unnecessary copy of the
|
---|
| 123 | headers.
|
---|
[a81f3ed] | 124 | </para>
|
---|
| 125 |
|
---|
| 126 | </sect2>
|
---|
| 127 |
|
---|
| 128 | <sect2 role="content">
|
---|
| 129 | <title>Contents</title>
|
---|
| 130 |
|
---|
| 131 | <segmentedlist>
|
---|
| 132 | <segtitle>Installed Programs</segtitle>
|
---|
| 133 | <segtitle>Installed Libraries</segtitle>
|
---|
| 134 | <segtitle>Installed Directories</segtitle>
|
---|
| 135 |
|
---|
| 136 | <seglistitem>
|
---|
| 137 | <seg>
|
---|
| 138 | llvm-spirv
|
---|
| 139 | </seg>
|
---|
| 140 | <seg>
|
---|
| 141 | libLLVMSPIRVLib.so
|
---|
| 142 | </seg>
|
---|
| 143 | <seg>
|
---|
| 144 | /usr/include/LLVMSPIRVLib
|
---|
| 145 | </seg>
|
---|
| 146 | </seglistitem>
|
---|
| 147 | </segmentedlist>
|
---|
| 148 |
|
---|
| 149 | <variablelist>
|
---|
| 150 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 151 | <?dbfo list-presentation="list"?>
|
---|
| 152 | <?dbhtml list-presentation="table"?>
|
---|
| 153 |
|
---|
| 154 | <varlistentry id="llvm-spirv">
|
---|
| 155 | <term><command>llvm-spirv</command></term>
|
---|
| 156 | <listitem>
|
---|
| 157 | <para>
|
---|
| 158 | converts between LLVM IR and SPIR-V code
|
---|
| 159 | </para>
|
---|
| 160 | <indexterm zone="spirv-llvm-translator llvm-spirv">
|
---|
| 161 | <primary sortas="b-llvm-spirv">llvm-spirv</primary>
|
---|
| 162 | </indexterm>
|
---|
| 163 | </listitem>
|
---|
| 164 | </varlistentry>
|
---|
| 165 |
|
---|
| 166 | <varlistentry id="libLLVMSPIRVLib">
|
---|
| 167 | <term><filename class="libraryfile">libLLVMSPIRVLib.so</filename></term>
|
---|
| 168 | <listitem>
|
---|
| 169 | <para>
|
---|
| 170 | contains functions that convert between LLVM IR and SPIR-V code
|
---|
| 171 | </para>
|
---|
| 172 | <indexterm zone="spirv-llvm-translator libLLVMSPIRVLib">
|
---|
| 173 | <primary sortas="c-libLLVMSPIRVLib">libLLVMSPIRVLib.so</primary>
|
---|
| 174 | </indexterm>
|
---|
| 175 | </listitem>
|
---|
| 176 | </varlistentry>
|
---|
| 177 | </variablelist>
|
---|
| 178 | </sect2>
|
---|
| 179 | </sect1>
|
---|