This is an archive of the discontinued LLVM Phabricator instance.

Differential D53351

AMDGPU/Docs: Correct note ids for metadata
AbandonedPublic

Authored by kzhuravl on Oct 16 2018, 6:25 PM.

Details

Reviewers
scott.linder
t-tye

Diff Detail

Event Timeline

kzhuravl created this revision.Oct 16 2018, 6:25 PM
Herald added subscribers: tpr, dstuttard, yaxunl and 3 others. · View Herald TranscriptOct 16 2018, 6:25 PM
kzhuravl added a subscriber: llvm-commits.Oct 16 2018, 6:25 PM
kzhuravl abandoned this revision.Oct 17 2018, 1:56 PM

@scott.linder is working on a complete set of doc changes.

Revision Contents

PathSize
docs/
25 lines

Diff 169936

docs/AMDGPUUsage.rst

  • This file is larger than 256 KB, so syntax highlighting is disabled by default.
Show First 20 Lines • Show All 667 Lines • ▼ Show 20 Lines
number of bytes, including the terminating null character, in the string. The number of bytes, including the terminating null character, in the string. The
string(s) come immediately after the preceding fields. string(s) come immediately after the preceding fields.
Additional note records can be present. Additional note records can be present.
.. table:: AMDGPU ELF Note Records .. table:: AMDGPU ELF Note Records
:name: amdgpu-elf-note-records-table :name: amdgpu-elf-note-records-table
===== ============================== ====================================== ======== ====================== ======================================
Name Type Description Name Type Description
===== ============================== ====================================== ======== ====================== ======================================
"AMD" ``NT_AMD_AMDGPU_HSA_METADATA`` <metadata null terminated string> "AMDGPU" ``NT_AMDGPU_METADATA`` Metadata in MessagePack format
===== ============================== ====================================== ======== ====================== ======================================
..
.. table:: AMDGPU ELF Note Record Enumeration Values .. table:: AMDGPU ELF Note Record Enumeration Values
:name: amdgpu-elf-note-record-enumeration-values-table :name: amdgpu-elf-note-record-enumeration-values-table
============================== ===== ============================== =====
Name Value Name Value
============================== ===== ============================== =====
*reserved* 0-9 *reserved* 0
``NT_AMD_AMDGPU_HSA_METADATA`` 10 ``NT_AMDGPU_METADATA`` 1
*reserved* 11
============================== ===== ============================== =====
``NT_AMD_AMDGPU_HSA_METADATA`` ``NT_AMDGPU_METADATA``
.. TODO
Add description of metadata abi.
Specifies extensible metadata associated with the code objects executed on HSA Specifies extensible metadata associated with the code objects executed on HSA
[HSA]_ compatible runtimes such as AMD's ROCm [AMD-ROCm]_. It is required when [HSA]_ compatible runtimes such as AMD's ROCm [AMD-ROCm]_. It is required when
the target triple OS is ``amdhsa`` (see :ref:`amdgpu-target-triples`). See the target triple OS is ``amdhsa`` (see :ref:`amdgpu-target-triples`). See
:ref:`amdgpu-amdhsa-code-object-metadata` for the syntax of the code :ref:`amdgpu-amdhsa-code-object-metadata` for the syntax of the code
object metadata string. object metadata string.
.. _amdgpu-symbols: .. _amdgpu-symbols:
▲ Show 20 Lines • Show All 280 Lines • ▼ Show 20 LinesFor example:
``"amdgcn-amd-amdhsa--gfx902+xnack"`` ``"amdgcn-amd-amdhsa--gfx902+xnack"``
.. _amdgpu-amdhsa-code-object-metadata: .. _amdgpu-amdhsa-code-object-metadata:
Code Object Metadata Code Object Metadata
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. TODO
This text is outdated. Add description of metadata abi.
The code object metadata specifies extensible metadata associated with the code The code object metadata specifies extensible metadata associated with the code
objects executed on HSA [HSA]_ compatible runtimes such as AMD's ROCm objects executed on HSA [HSA]_ compatible runtimes such as AMD's ROCm
[AMD-ROCm]_. It is specified by the ``NT_AMD_AMDGPU_HSA_METADATA`` note record [AMD-ROCm]_. It is specified by the ``NT_AMD_AMDGPU_HSA_METADATA`` note record
(see :ref:`amdgpu-note-records`) and is required when the target triple OS is (see :ref:`amdgpu-note-records`) and is required when the target triple OS is
``amdhsa`` (see :ref:`amdgpu-target-triples`). It must contain the minimum ``amdhsa`` (see :ref:`amdgpu-target-triples`). It must contain the minimum
information necessary to support the ROCM kernel queries. For example, the information necessary to support the ROCM kernel queries. For example, the
segment sizes needed in a dispatch packet. In addition, a high level language segment sizes needed in a dispatch packet. In addition, a high level language
runtime may require other information to be included. For example, the AMD runtime may require other information to be included. For example, the AMD
▲ Show 20 Lines • Show All 3,624 Lines • Show Last 20 Lines