1 //===--- AMDGPUCodeObjectMetadata.cpp ---------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief AMDGPU Code Object Metadata definitions and in-memory
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Support/AMDGPUCodeObjectMetadata.h"
18 #include "llvm/Support/YAMLTraits.h"
20 using namespace llvm::AMDGPU;
21 using namespace llvm::AMDGPU::CodeObject;
23 LLVM_YAML_IS_SEQUENCE_VECTOR(Kernel::Arg::Metadata)
24 LLVM_YAML_IS_SEQUENCE_VECTOR(Kernel::Metadata)
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);
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);
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);
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);
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());
103 struct MappingTraits<Kernel::Arg::Metadata> {
104 static void mapping(IO &YIO, Kernel::Arg::Metadata &MD) {
105 YIO.mapRequired(Kernel::Arg::Key::Size, MD.mSize);
106 YIO.mapRequired(Kernel::Arg::Key::Align, MD.mAlign);
107 YIO.mapRequired(Kernel::Arg::Key::ValueKind, MD.mValueKind);
108 YIO.mapRequired(Kernel::Arg::Key::ValueType, MD.mValueType);
109 YIO.mapOptional(Kernel::Arg::Key::PointeeAlign, MD.mPointeeAlign,
111 YIO.mapOptional(Kernel::Arg::Key::AccQual, MD.mAccQual,
112 AccessQualifier::Unknown);
113 YIO.mapOptional(Kernel::Arg::Key::AddrSpaceQual, MD.mAddrSpaceQual,
114 AddressSpaceQualifier::Unknown);
115 YIO.mapOptional(Kernel::Arg::Key::IsConst, MD.mIsConst, false);
116 YIO.mapOptional(Kernel::Arg::Key::IsPipe, MD.mIsPipe, false);
117 YIO.mapOptional(Kernel::Arg::Key::IsRestrict, MD.mIsRestrict, false);
118 YIO.mapOptional(Kernel::Arg::Key::IsVolatile, MD.mIsVolatile, false);
119 YIO.mapOptional(Kernel::Arg::Key::Name, MD.mName, std::string());
120 YIO.mapOptional(Kernel::Arg::Key::TypeName, MD.mTypeName, std::string());
125 struct MappingTraits<Kernel::CodeProps::Metadata> {
126 static void mapping(IO &YIO, Kernel::CodeProps::Metadata &MD) {
127 YIO.mapOptional(Kernel::CodeProps::Key::KernargSegmentSize,
128 MD.mKernargSegmentSize, uint64_t(0));
129 YIO.mapOptional(Kernel::CodeProps::Key::WorkgroupGroupSegmentSize,
130 MD.mWorkgroupGroupSegmentSize, uint32_t(0));
131 YIO.mapOptional(Kernel::CodeProps::Key::WorkitemPrivateSegmentSize,
132 MD.mWorkitemPrivateSegmentSize, uint32_t(0));
133 YIO.mapOptional(Kernel::CodeProps::Key::WavefrontNumSGPRs,
134 MD.mWavefrontNumSGPRs, uint16_t(0));
135 YIO.mapOptional(Kernel::CodeProps::Key::WorkitemNumVGPRs,
136 MD.mWorkitemNumVGPRs, uint16_t(0));
137 YIO.mapOptional(Kernel::CodeProps::Key::KernargSegmentAlign,
138 MD.mKernargSegmentAlign, uint8_t(0));
139 YIO.mapOptional(Kernel::CodeProps::Key::GroupSegmentAlign,
140 MD.mGroupSegmentAlign, uint8_t(0));
141 YIO.mapOptional(Kernel::CodeProps::Key::PrivateSegmentAlign,
142 MD.mPrivateSegmentAlign, uint8_t(0));
143 YIO.mapOptional(Kernel::CodeProps::Key::WavefrontSize,
144 MD.mWavefrontSize, uint8_t(0));
149 struct MappingTraits<Kernel::DebugProps::Metadata> {
150 static void mapping(IO &YIO, Kernel::DebugProps::Metadata &MD) {
151 YIO.mapOptional(Kernel::DebugProps::Key::DebuggerABIVersion,
152 MD.mDebuggerABIVersion, std::vector<uint32_t>());
153 YIO.mapOptional(Kernel::DebugProps::Key::ReservedNumVGPRs,
154 MD.mReservedNumVGPRs, uint16_t(0));
155 YIO.mapOptional(Kernel::DebugProps::Key::ReservedFirstVGPR,
156 MD.mReservedFirstVGPR, uint16_t(-1));
157 YIO.mapOptional(Kernel::DebugProps::Key::PrivateSegmentBufferSGPR,
158 MD.mPrivateSegmentBufferSGPR, uint16_t(-1));
159 YIO.mapOptional(Kernel::DebugProps::Key::WavefrontPrivateSegmentOffsetSGPR,
160 MD.mWavefrontPrivateSegmentOffsetSGPR, uint16_t(-1));
165 struct MappingTraits<Kernel::Metadata> {
166 static void mapping(IO &YIO, Kernel::Metadata &MD) {
167 YIO.mapRequired(Kernel::Key::Name, MD.mName);
168 YIO.mapOptional(Kernel::Key::Language, MD.mLanguage, std::string());
169 YIO.mapOptional(Kernel::Key::LanguageVersion, MD.mLanguageVersion,
170 std::vector<uint32_t>());
171 if (!MD.mAttrs.empty() || !YIO.outputting())
172 YIO.mapOptional(Kernel::Key::Attrs, MD.mAttrs);
173 if (!MD.mArgs.empty() || !YIO.outputting())
174 YIO.mapOptional(Kernel::Key::Args, MD.mArgs);
175 if (!MD.mCodeProps.empty() || !YIO.outputting())
176 YIO.mapOptional(Kernel::Key::CodeProps, MD.mCodeProps);
177 if (!MD.mDebugProps.empty() || !YIO.outputting())
178 YIO.mapOptional(Kernel::Key::DebugProps, MD.mDebugProps);
183 struct MappingTraits<CodeObject::Metadata> {
184 static void mapping(IO &YIO, CodeObject::Metadata &MD) {
185 YIO.mapRequired(Key::Version, MD.mVersion);
186 YIO.mapOptional(Key::Printf, MD.mPrintf, std::vector<std::string>());
187 if (!MD.mKernels.empty() || !YIO.outputting())
188 YIO.mapOptional(Key::Kernels, MD.mKernels);
192 } // end namespace yaml
195 namespace CodeObject {
198 std::error_code Metadata::fromYamlString(
199 std::string YamlString, Metadata &CodeObjectMetadata) {
200 yaml::Input YamlInput(YamlString);
201 YamlInput >> CodeObjectMetadata;
202 return YamlInput.error();
206 std::error_code Metadata::toYamlString(
207 Metadata CodeObjectMetadata, std::string &YamlString) {
208 raw_string_ostream YamlStream(YamlString);
209 yaml::Output YamlOutput(YamlStream, nullptr, std::numeric_limits<int>::max());
210 YamlOutput << CodeObjectMetadata;
211 return std::error_code();
214 } // end namespace CodeObject
215 } // end namespace AMDGPU
216 } // end namespace llvm