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">
|
---|
8 | <!ENTITY spirv-llvm-translator-md5sum "bdf8c56560b187e198f9e4139cdb79a2">
|
---|
9 | <!ENTITY spirv-llvm-translator-size "1.6 MB">
|
---|
10 | <!ENTITY spirv-llvm-translator-buildsize "42 MB">
|
---|
11 | <!ENTITY spirv-llvm-translator-time "0.6 SBU (with parallelism=4)">
|
---|
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 |
|
---|
32 | &lfs121_checked;
|
---|
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 |
|
---|
85 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
86 | -DCMAKE_BUILD_TYPE=Release \
|
---|
87 | -DBUILD_SHARED_LIBS=ON \
|
---|
88 | -DCMAKE_SKIP_INSTALL_RPATH=ON \
|
---|
89 | -DLLVM_EXTERNAL_SPIRV_HEADERS_SOURCE=/usr \
|
---|
90 | -G Ninja .. &&
|
---|
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>
|
---|
111 | <parameter>-DBUILD_SHARED_LIBS=ON</parameter>: This parameter forces
|
---|
112 | building shared versions of the libraries.
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | <parameter>-DCMAKE_SKIP_INSTALL_RPATH=ON</parameter>: This parameter
|
---|
117 | forces CMake to remove hardcoded library search paths when installing
|
---|
118 | a binary executable or library. This package does not need rpath once
|
---|
119 | it's installed into the standard location, and leaving it can cause
|
---|
120 | unexpected effects of security issues.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | <parameter>-DLLVM_EXTERNAL_SPIRV_HEADERS_SOURCE=/usr</parameter>: This
|
---|
125 | parameter allows the build system to use the version of SPIRV-Headers
|
---|
126 | that was installed with SPIRV-Tools, instead of redownloading an
|
---|
127 | unncessary copy of the headers.
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | </sect2>
|
---|
131 |
|
---|
132 | <sect2 role="content">
|
---|
133 | <title>Contents</title>
|
---|
134 |
|
---|
135 | <segmentedlist>
|
---|
136 | <segtitle>Installed Programs</segtitle>
|
---|
137 | <segtitle>Installed Libraries</segtitle>
|
---|
138 | <segtitle>Installed Directories</segtitle>
|
---|
139 |
|
---|
140 | <seglistitem>
|
---|
141 | <seg>
|
---|
142 | llvm-spirv
|
---|
143 | </seg>
|
---|
144 | <seg>
|
---|
145 | libLLVMSPIRVLib.so
|
---|
146 | </seg>
|
---|
147 | <seg>
|
---|
148 | /usr/include/LLVMSPIRVLib
|
---|
149 | </seg>
|
---|
150 | </seglistitem>
|
---|
151 | </segmentedlist>
|
---|
152 |
|
---|
153 | <variablelist>
|
---|
154 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
155 | <?dbfo list-presentation="list"?>
|
---|
156 | <?dbhtml list-presentation="table"?>
|
---|
157 |
|
---|
158 | <varlistentry id="llvm-spirv">
|
---|
159 | <term><command>llvm-spirv</command></term>
|
---|
160 | <listitem>
|
---|
161 | <para>
|
---|
162 | converts between LLVM IR and SPIR-V code
|
---|
163 | </para>
|
---|
164 | <indexterm zone="spirv-llvm-translator llvm-spirv">
|
---|
165 | <primary sortas="b-llvm-spirv">llvm-spirv</primary>
|
---|
166 | </indexterm>
|
---|
167 | </listitem>
|
---|
168 | </varlistentry>
|
---|
169 |
|
---|
170 | <varlistentry id="libLLVMSPIRVLib">
|
---|
171 | <term><filename class="libraryfile">libLLVMSPIRVLib.so</filename></term>
|
---|
172 | <listitem>
|
---|
173 | <para>
|
---|
174 | contains functions that convert between LLVM IR and SPIR-V code
|
---|
175 | </para>
|
---|
176 | <indexterm zone="spirv-llvm-translator libLLVMSPIRVLib">
|
---|
177 | <primary sortas="c-libLLVMSPIRVLib">libLLVMSPIRVLib.so</primary>
|
---|
178 | </indexterm>
|
---|
179 | </listitem>
|
---|
180 | </varlistentry>
|
---|
181 | </variablelist>
|
---|
182 | </sect2>
|
---|
183 | </sect1>
|
---|