1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AMDGPU Instructions Notation — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="DWARF Extensions For Heterogeneous Debugging" href="AMDGPUDwarfExtensionsForHeterogeneousDebugging.html" />
<link rel="prev" title="AMDGPU Instruction Syntax" href="AMDGPUInstructionSyntax.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="AMDGPUDwarfExtensionsForHeterogeneousDebugging.html" title="DWARF Extensions For Heterogeneous Debugging"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="AMDGPUInstructionSyntax.html" title="AMDGPU Instruction Syntax"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="UserGuides.html" >User Guides</a> »</li>
<li class="nav-item nav-item-2"><a href="AMDGPUUsage.html" accesskey="U">User Guide for AMDGPU Backend</a> »</li>
<li class="nav-item nav-item-this"><a href="">AMDGPU Instructions Notation</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/AMDGPUInstructionNotation.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="amdgpu-instructions-notation">
<h1>AMDGPU Instructions Notation<a class="headerlink" href="#amdgpu-instructions-notation" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#introduction" id="id4">Introduction</a></p></li>
<li><p><a class="reference internal" href="#instructions" id="id5">Instructions</a></p>
<ul>
<li><p><a class="reference internal" href="#notation" id="id6">Notation</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#opcode" id="id7">Opcode</a></p>
<ul>
<li><p><a class="reference internal" href="#id1" id="id8">Notation</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#operands" id="id9">Operands</a></p>
<ul>
<li><p><a class="reference internal" href="#amdgpu-syn-instruction-operand-notation" id="id10">Notation</a></p>
<ul>
<li><p><a class="reference internal" href="#operand-kinds" id="id11">Operand Kinds</a></p></li>
<li><p><a class="reference internal" href="#operand-tags" id="id12">Operand Tags</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#modifiers" id="id13">Modifiers</a></p>
<ul>
<li><p><a class="reference internal" href="#amdgpu-syn-instruction-modifier-notation" id="id14">Notation</a></p></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="introduction">
<span id="amdgpu-syn-instruction-notation"></span><h2><a class="toc-backref" href="#id4">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>This is an overview of notation used to describe syntax of AMDGPU assembler instructions.</p>
<p>This notation mimics the <a class="reference internal" href="AMDGPUInstructionSyntax.html#amdgpu-syn-instructions"><span class="std std-ref">syntax of assembler instructions</span></a>
except that instead of real operands and modifiers it provides references to their description.</p>
</div>
<div class="section" id="instructions">
<h2><a class="toc-backref" href="#id5">Instructions</a><a class="headerlink" href="#instructions" title="Permalink to this headline">¶</a></h2>
<div class="section" id="notation">
<h3><a class="toc-backref" href="#id6">Notation</a><a class="headerlink" href="#notation" title="Permalink to this headline">¶</a></h3>
<p>This is the notation used to describe AMDGPU instructions:</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-opcode-notation"><span class="std std-ref">opcode description</span></a><code class="docutils literal notranslate"><span class="pre">></span>  <span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-instruction-operands-notation"><span class="std std-ref">operands description</span></a><code class="docutils literal notranslate"><span class="pre">></span>  <span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-instruction-modifiers-notation"><span class="std std-ref">modifiers description</span></a><code class="docutils literal notranslate"><span class="pre">></span></code></p>
</div></blockquote>
</div>
</div>
<div class="section" id="opcode">
<span id="amdgpu-syn-opcode-notation"></span><h2><a class="toc-backref" href="#id7">Opcode</a><a class="headerlink" href="#opcode" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id1">
<h3><a class="toc-backref" href="#id8">Notation</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>TBD</p>
</div>
</div>
<div class="section" id="operands">
<span id="amdgpu-syn-instruction-operands-notation"></span><h2><a class="toc-backref" href="#id9">Operands</a><a class="headerlink" href="#operands" title="Permalink to this headline">¶</a></h2>
<p>An instruction may have zero or more <em>operands</em>. They are comma-separated in the description:</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-instruction-operand-notation"><span class="std std-ref">description of operand 0</span></a><code class="docutils literal notranslate"><span class="pre">>,</span> <span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-instruction-operand-notation"><span class="std std-ref">description of operand 1</span></a><code class="docutils literal notranslate"><span class="pre">>,</span> <span class="pre">...</span></code></p>
</div></blockquote>
<p>The order of <em>operands</em> is fixed. <em>Operands</em> cannot be omitted
except for special cases described below.</p>
<div class="section" id="amdgpu-syn-instruction-operand-notation">
<span id="id2"></span><h3><a class="toc-backref" href="#id10">Notation</a><a class="headerlink" href="#amdgpu-syn-instruction-operand-notation" title="Permalink to this headline">¶</a></h3>
<p>An operand is described using the following notation:</p>
<blockquote>
<div><p><em><kind><name><tag0><tag1>…</em></p>
</div></blockquote>
<p>Where:</p>
<ul class="simple">
<li><p><em>kind</em> is an optional prefix describing operand <a class="reference internal" href="#amdgpu-syn-instruction-operand-kinds"><span class="std std-ref">kind</span></a>.</p></li>
<li><p><em>name</em> is a link to a description of the operand.</p></li>
<li><p><em>tags</em> are optional. They are used to indicate <a class="reference internal" href="#amdgpu-syn-instruction-operand-tags"><span class="std std-ref">special operand properties</span></a>.</p></li>
</ul>
<div class="section" id="operand-kinds">
<span id="amdgpu-syn-instruction-operand-kinds"></span><h4><a class="toc-backref" href="#id11">Operand Kinds</a><a class="headerlink" href="#operand-kinds" title="Permalink to this headline">¶</a></h4>
<p>Operand kind indicates which values are accepted by the operand.</p>
<ul class="simple">
<li><p>Operands which only accept <em>vector</em> registers are labelled with ‘v’ prefix.</p></li>
<li><p>Operands which only accept <em>scalar</em> values are labelled with ‘s’ prefix.</p></li>
<li><p>Operands which accept both <em>vector</em> registers and <em>scalar</em> values have no prefix.</p></li>
</ul>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">vdata</span> <span class="o">//</span> <span class="n">operand</span> <span class="n">only</span> <span class="n">accepts</span> <span class="n">vector</span> <span class="n">registers</span>
<span class="n">sdst</span> <span class="o">//</span> <span class="n">operand</span> <span class="n">only</span> <span class="n">accepts</span> <span class="n">scalar</span> <span class="n">registers</span>
<span class="n">src1</span> <span class="o">//</span> <span class="n">operand</span> <span class="n">accepts</span> <span class="n">both</span> <span class="n">scalar</span> <span class="ow">and</span> <span class="n">vector</span> <span class="n">registers</span>
</pre></div>
</div>
</div>
<div class="section" id="operand-tags">
<span id="amdgpu-syn-instruction-operand-tags"></span><h4><a class="toc-backref" href="#id12">Operand Tags</a><a class="headerlink" href="#operand-tags" title="Permalink to this headline">¶</a></h4>
<p>Operand tags indicate special operand properties.</p>
<blockquote>
<div><table class="docutils align-default">
<colgroup>
<col style="width: 15%" />
<col style="width: 85%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Operand tag</p></th>
<th class="head"><p>Meaning</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>:opt</p></td>
<td><p>An optional operand.</p></td>
</tr>
<tr class="row-odd"><td><p>:m</p></td>
<td><p>An operand which may be used with
<a class="reference internal" href="AMDGPUModifierSyntax.html#amdgpu-synid-vop3-operand-modifiers"><span class="std std-ref">VOP3 operand modifiers</span></a> or
<a class="reference internal" href="AMDGPUModifierSyntax.html#amdgpu-synid-sdwa-operand-modifiers"><span class="std std-ref">SDWA operand modifiers</span></a>.</p></td>
</tr>
<tr class="row-even"><td><p>:dst</p></td>
<td><p>An input operand which may also serve as a destination
if <a class="reference internal" href="AMDGPUModifierSyntax.html#amdgpu-synid-glc"><span class="std std-ref">glc</span></a> modifier is specified.</p></td>
</tr>
<tr class="row-odd"><td><p>:fx</p></td>
<td><p>This is an <em>f32</em> or <em>f16</em> operand depending on
<a class="reference internal" href="AMDGPUModifierSyntax.html#amdgpu-synid-mad-mix-op-sel-hi"><span class="std std-ref">m_op_sel_hi</span></a> modifier.</p></td>
</tr>
<tr class="row-even"><td><p>:<type></p></td>
<td><p>Operand <em>type</em> differs from <em>type</em>
<a class="reference internal" href="AMDGPUInstructionSyntax.html#amdgpu-syn-instruction-type"><span class="std std-ref">implied by the opcode name</span></a>.
This tag specifies actual operand <em>type</em>.</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">src1</span><span class="p">:</span><span class="n">m</span> <span class="o">//</span> <span class="n">src1</span> <span class="n">operand</span> <span class="n">may</span> <span class="n">be</span> <span class="n">used</span> <span class="k">with</span> <span class="n">operand</span> <span class="n">modifiers</span>
<span class="n">vdata</span><span class="p">:</span><span class="n">dst</span> <span class="o">//</span> <span class="n">vdata</span> <span class="n">operand</span> <span class="n">may</span> <span class="n">be</span> <span class="n">used</span> <span class="k">as</span> <span class="n">both</span> <span class="n">source</span> <span class="ow">and</span> <span class="n">destination</span>
<span class="n">vdst</span><span class="p">:</span><span class="n">u32</span> <span class="o">//</span> <span class="n">vdst</span> <span class="n">operand</span> <span class="n">has</span> <span class="n">u32</span> <span class="nb">type</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="modifiers">
<span id="amdgpu-syn-instruction-modifiers-notation"></span><h2><a class="toc-backref" href="#id13">Modifiers</a><a class="headerlink" href="#modifiers" title="Permalink to this headline">¶</a></h2>
<p>An instruction may have zero or more optional <em>modifiers</em>. They are space-separated in the description:</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-instruction-modifier-notation"><span class="std std-ref">description of modifier 0</span></a><code class="docutils literal notranslate"><span class="pre">></span> <span class="pre"><</span></code><a class="reference internal" href="#amdgpu-syn-instruction-modifier-notation"><span class="std std-ref">description of modifier 1</span></a><code class="docutils literal notranslate"><span class="pre">></span> <span class="pre">...</span></code></p>
</div></blockquote>
<p>The order of <em>modifiers</em> is fixed.</p>
<div class="section" id="amdgpu-syn-instruction-modifier-notation">
<span id="id3"></span><h3><a class="toc-backref" href="#id14">Notation</a><a class="headerlink" href="#amdgpu-syn-instruction-modifier-notation" title="Permalink to this headline">¶</a></h3>
<p>A <em>modifier</em> is described using the following notation:</p>
<blockquote>
<div><p><em><name></em></p>
</div></blockquote>
<p>Where <em>name</em> is a link to a description of the <em>modifier</em>.</p>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="AMDGPUDwarfExtensionsForHeterogeneousDebugging.html" title="DWARF Extensions For Heterogeneous Debugging"
>next</a> |</li>
<li class="right" >
<a href="AMDGPUInstructionSyntax.html" title="AMDGPU Instruction Syntax"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="UserGuides.html" >User Guides</a> »</li>
<li class="nav-item nav-item-2"><a href="AMDGPUUsage.html" >User Guide for AMDGPU Backend</a> »</li>
<li class="nav-item nav-item-this"><a href="">AMDGPU Instructions Notation</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
