1 //===--- AMDGPUMetadata.cpp -------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// \file
11 /// \brief AMDGPU metadata definitions and in-memory representations.
12 ///
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #include "llvm/Support/AMDGPUMetadata.h"
17 #include "llvm/Support/YAMLTraits.h"
18 
19 using namespace llvm::AMDGPU;
20 using namespace llvm::AMDGPU::HSAMD;
21 
22 LLVM_YAML_IS_SEQUENCE_VECTOR(Kernel::Arg::Metadata)
23 LLVM_YAML_IS_SEQUENCE_VECTOR(Kernel::Metadata)
24 
25 namespace llvm {
26 namespace yaml {
27 
28 template <>
29 struct ScalarEnumerationTraits<AccessQualifier> {
30   static void enumeration(IO &YIO, AccessQualifier &EN) {
31     YIO.enumCase(EN, "Default", AccessQualifier::Default);
32     YIO.enumCase(EN, "ReadOnly", AccessQualifier::ReadOnly);
33     YIO.enumCase(EN, "WriteOnly", AccessQualifier::WriteOnly);
34     YIO.enumCase(EN, "ReadWrite", AccessQualifier::ReadWrite);
35   }
36 };
37 
38 template <>
39 struct ScalarEnumerationTraits<AddressSpaceQualifier> {
40   static void enumeration(IO &YIO, AddressSpaceQualifier &EN) {
41     YIO.enumCase(EN, "Private", AddressSpaceQualifier::Private);
42     YIO.enumCase(EN, "Global", AddressSpaceQualifier::Global);
43     YIO.enumCase(EN, "Constant", AddressSpaceQualifier::Constant);
44     YIO.enumCase(EN, "Local", AddressSpaceQualifier::Local);
45     YIO.enumCase(EN, "Generic", AddressSpaceQualifier::Generic);
46     YIO.enumCase(EN, "Region", AddressSpaceQualifier::Region);
47   }
48 };
49 
50 template <>
51 struct ScalarEnumerationTraits<ValueKind> {
52   static void enumeration(IO &YIO, ValueKind &EN) {
53     YIO.enumCase(EN, "ByValue", ValueKind::ByValue);
54     YIO.enumCase(EN, "GlobalBuffer", ValueKind::GlobalBuffer);
55     YIO.enumCase(EN, "DynamicSharedPointer", ValueKind::DynamicSharedPointer);
56     YIO.enumCase(EN, "Sampler", ValueKind::Sampler);
57     YIO.enumCase(EN, "Image", ValueKind::Image);
58     YIO.enumCase(EN, "Pipe", ValueKind::Pipe);
59     YIO.enumCase(EN, "Queue", ValueKind::Queue);
60     YIO.enumCase(EN, "HiddenGlobalOffsetX", ValueKind::HiddenGlobalOffsetX);
61     YIO.enumCase(EN, "HiddenGlobalOffsetY", ValueKind::HiddenGlobalOffsetY);
62     YIO.enumCase(EN, "HiddenGlobalOffsetZ", ValueKind::HiddenGlobalOffsetZ);
63     YIO.enumCase(EN, "HiddenNone", ValueKind::HiddenNone);
64     YIO.enumCase(EN, "HiddenPrintfBuffer", ValueKind::HiddenPrintfBuffer);
65     YIO.enumCase(EN, "HiddenDefaultQueue", ValueKind::HiddenDefaultQueue);
66     YIO.enumCase(EN, "HiddenCompletionAction",
67                  ValueKind::HiddenCompletionAction);
68   }
69 };
70 
71 template <>
72 struct ScalarEnumerationTraits<ValueType> {
73   static void enumeration(IO &YIO, ValueType &EN) {
74     YIO.enumCase(EN, "Struct", ValueType::Struct);
75     YIO.enumCase(EN, "I8", ValueType::I8);
76     YIO.enumCase(EN, "U8", ValueType::U8);
77     YIO.enumCase(EN, "I16", ValueType::I16);
78     YIO.enumCase(EN, "U16", ValueType::U16);
79     YIO.enumCase(EN, "F16", ValueType::F16);
80     YIO.enumCase(EN, "I32", ValueType::I32);
81     YIO.enumCase(EN, "U32", ValueType::U32);
82     YIO.enumCase(EN, "F32", ValueType::F32);
83     YIO.enumCase(EN, "I64", ValueType::I64);
84     YIO.enumCase(EN, "U64", ValueType::U64);
85     YIO.enumCase(EN, "F64", ValueType::F64);
86   }
87 };
88 
89 template <>
90 struct MappingTraits<Kernel::Attrs::Metadata> {
91   static void mapping(IO &YIO, Kernel::Attrs::Metadata &MD) {
92     YIO.mapOptional(Kernel::Attrs::Key::ReqdWorkGroupSize,
93                     MD.mReqdWorkGroupSize, std::vector<uint32_t>());
94     YIO.mapOptional(Kernel::Attrs::Key::WorkGroupSizeHint,
95                     MD.mWorkGroupSizeHint, std::vector<uint32_t>());
96     YIO.mapOptional(Kernel::Attrs::Key::VecTypeHint,
97                     MD.mVecTypeHint, std::string());
98     YIO.mapOptional(Kernel::Attrs::Key::RuntimeHandle, MD.mRuntimeHandle,
99                     std::string());
100   }
101 };
102 
103 template <>
104 struct MappingTraits<Kernel::Arg::Metadata> {
105   static void mapping(IO &YIO, Kernel::Arg::Metadata &MD) {
106     YIO.mapRequired(Kernel::Arg::Key::Size, MD.mSize);
107     YIO.mapRequired(Kernel::Arg::Key::Align, MD.mAlign);
108     YIO.mapRequired(Kernel::Arg::Key::ValueKind, MD.mValueKind);
109     YIO.mapRequired(Kernel::Arg::Key::ValueType, MD.mValueType);
110     YIO.mapOptional(Kernel::Arg::Key::PointeeAlign, MD.mPointeeAlign,
111                     uint32_t(0));
112     YIO.mapOptional(Kernel::Arg::Key::AccQual, MD.mAccQual,
113                     AccessQualifier::Unknown);
114     YIO.mapOptional(Kernel::Arg::Key::AddrSpaceQual, MD.mAddrSpaceQual,
115                     AddressSpaceQualifier::Unknown);
116     YIO.mapOptional(Kernel::Arg::Key::IsConst, MD.mIsConst, false);
117     YIO.mapOptional(Kernel::Arg::Key::IsPipe, MD.mIsPipe, false);
118     YIO.mapOptional(Kernel::Arg::Key::IsRestrict, MD.mIsRestrict, false);
119     YIO.mapOptional(Kernel::Arg::Key::IsVolatile, MD.mIsVolatile, false);
120     YIO.mapOptional(Kernel::Arg::Key::Name, MD.mName, std::string());
121     YIO.mapOptional(Kernel::Arg::Key::TypeName, MD.mTypeName, std::string());
122   }
123 };
124 
125 template <>
126 struct MappingTraits<Kernel::CodeProps::Metadata> {
127   static void mapping(IO &YIO, Kernel::CodeProps::Metadata &MD) {
128     YIO.mapOptional(Kernel::CodeProps::Key::KernargSegmentSize,
129                     MD.mKernargSegmentSize, uint64_t(0));
130     YIO.mapOptional(Kernel::CodeProps::Key::WorkgroupGroupSegmentSize,
131                     MD.mWorkgroupGroupSegmentSize, uint32_t(0));
132     YIO.mapOptional(Kernel::CodeProps::Key::WorkitemPrivateSegmentSize,
133                     MD.mWorkitemPrivateSegmentSize, uint32_t(0));
134     YIO.mapOptional(Kernel::CodeProps::Key::WavefrontNumSGPRs,
135                     MD.mWavefrontNumSGPRs, uint16_t(0));
136     YIO.mapOptional(Kernel::CodeProps::Key::WorkitemNumVGPRs,
137                     MD.mWorkitemNumVGPRs, uint16_t(0));
138     YIO.mapOptional(Kernel::CodeProps::Key::KernargSegmentAlign,
139                     MD.mKernargSegmentAlign, uint8_t(0));
140     YIO.mapOptional(Kernel::CodeProps::Key::GroupSegmentAlign,
141                     MD.mGroupSegmentAlign, uint8_t(0));
142     YIO.mapOptional(Kernel::CodeProps::Key::PrivateSegmentAlign,
143                     MD.mPrivateSegmentAlign, uint8_t(0));
144     YIO.mapOptional(Kernel::CodeProps::Key::WavefrontSize,
145                     MD.mWavefrontSize, uint8_t(0));
146   }
147 };
148 
149 template <>
150 struct MappingTraits<Kernel::DebugProps::Metadata> {
151   static void mapping(IO &YIO, Kernel::DebugProps::Metadata &MD) {
152     YIO.mapOptional(Kernel::DebugProps::Key::DebuggerABIVersion,
153                     MD.mDebuggerABIVersion, std::vector<uint32_t>());
154     YIO.mapOptional(Kernel::DebugProps::Key::ReservedNumVGPRs,
155                     MD.mReservedNumVGPRs, uint16_t(0));
156     YIO.mapOptional(Kernel::DebugProps::Key::ReservedFirstVGPR,
157                     MD.mReservedFirstVGPR, uint16_t(-1));
158     YIO.mapOptional(Kernel::DebugProps::Key::PrivateSegmentBufferSGPR,
159                     MD.mPrivateSegmentBufferSGPR, uint16_t(-1));
160     YIO.mapOptional(Kernel::DebugProps::Key::WavefrontPrivateSegmentOffsetSGPR,
161                     MD.mWavefrontPrivateSegmentOffsetSGPR, uint16_t(-1));
162   }
163 };
164 
165 template <>
166 struct MappingTraits<Kernel::Metadata> {
167   static void mapping(IO &YIO, Kernel::Metadata &MD) {
168     YIO.mapRequired(Kernel::Key::Name, MD.mName);
169     YIO.mapOptional(Kernel::Key::Language, MD.mLanguage, std::string());
170     YIO.mapOptional(Kernel::Key::LanguageVersion, MD.mLanguageVersion,
171                     std::vector<uint32_t>());
172     if (!MD.mAttrs.empty() || !YIO.outputting())
173       YIO.mapOptional(Kernel::Key::Attrs, MD.mAttrs);
174     if (!MD.mArgs.empty() || !YIO.outputting())
175       YIO.mapOptional(Kernel::Key::Args, MD.mArgs);
176     if (!MD.mCodeProps.empty() || !YIO.outputting())
177       YIO.mapOptional(Kernel::Key::CodeProps, MD.mCodeProps);
178     if (!MD.mDebugProps.empty() || !YIO.outputting())
179       YIO.mapOptional(Kernel::Key::DebugProps, MD.mDebugProps);
180   }
181 };
182 
183 template <>
184 struct MappingTraits<HSAMD::Metadata> {
185   static void mapping(IO &YIO, HSAMD::Metadata &MD) {
186     YIO.mapRequired(Key::Version, MD.mVersion);
187     YIO.mapOptional(Key::Printf, MD.mPrintf, std::vector<std::string>());
188     if (!MD.mKernels.empty() || !YIO.outputting())
189       YIO.mapOptional(Key::Kernels, MD.mKernels);
190   }
191 };
192 
193 } // end namespace yaml
194 
195 namespace AMDGPU {
196 namespace HSAMD {
197 
198 /* static */
199 std::error_code Metadata::fromYamlString(
200     std::string YamlString, Metadata &HSAMetadata) {
201   yaml::Input YamlInput(YamlString);
202   YamlInput >> HSAMetadata;
203   return YamlInput.error();
204 }
205 
206 /* static */
207 std::error_code Metadata::toYamlString(
208     Metadata HSAMetadata, std::string &YamlString) {
209   raw_string_ostream YamlStream(YamlString);
210   yaml::Output YamlOutput(YamlStream, nullptr, std::numeric_limits<int>::max());
211   YamlOutput << HSAMetadata;
212   return std::error_code();
213 }
214 
215 } // end namespace HSAMD
216 } // end namespace AMDGPU
217 } // end namespace llvm
218