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