1//===--- AMDGPUHSAMetadataStreamer.h ----------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9/// \file
10/// AMDGPU HSA Metadata Streamer.
11///
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_LIB_TARGET_AMDGPU_MCTARGETDESC_AMDGPUHSAMETADATASTREAMER_H
16#define LLVM_LIB_TARGET_AMDGPU_MCTARGETDESC_AMDGPUHSAMETADATASTREAMER_H
17
18#include "Utils/AMDGPUDelayedMCExpr.h"
19#include "llvm/BinaryFormat/MsgPackDocument.h"
20#include "llvm/Support/AMDGPUMetadata.h"
21#include "llvm/Support/Alignment.h"
22#include "llvm/Support/Compiler.h"
23
24namespace llvm {
25
26struct AMDGPUOptions;
27class AMDGPUTargetMachine;
28class AMDGPUTargetStreamer;
29class Argument;
30class DataLayout;
31class Function;
32class MachineFunction;
33class MDNode;
34class Module;
35struct SIProgramInfo;
36class Type;
37
38namespace AMDGPU {
39
40class TargetID;
41
42namespace HSAMD {
43
44class MetadataStreamer {
45public:
46 virtual ~MetadataStreamer() = default;
47
48 virtual bool emitTo(AMDGPUTargetStreamer &TargetStreamer) = 0;
49
50 virtual void begin(const Module &Mod, const TargetID &TargetID) = 0;
51
52 virtual void end() = 0;
53
54 virtual void emitKernel(const MachineFunction &MF,
55 const SIProgramInfo &ProgramInfo) = 0;
56
57protected:
58 virtual void emitVersion() = 0;
59 virtual void emitHiddenKernelArgs(const MachineFunction &MF, uint64_t &Offset,
60 msgpack::ArrayDocNode Args) = 0;
61 virtual void emitKernelAttrs(const AMDGPUTargetMachine &TM,
62 const MachineFunction &MF,
63 msgpack::MapDocNode Kern) = 0;
64};
65
66class LLVM_EXTERNAL_VISIBILITY MetadataStreamerMsgPackV4
67 : public MetadataStreamer {
68protected:
69 const AMDGPUOptions &CLOpts;
70
71 std::unique_ptr<DelayedMCExprs> DelayedExprs =
72 std::make_unique<DelayedMCExprs>();
73
74 std::unique_ptr<msgpack::Document> HSAMetadataDoc =
75 std::make_unique<msgpack::Document>();
76
77 void dump(StringRef HSAMetadataString) const;
78
79 void verify(StringRef HSAMetadataString) const;
80
81 std::optional<StringRef> getAccessQualifier(StringRef AccQual) const;
82
83 std::optional<StringRef>
84 getAddressSpaceQualifier(unsigned AddressSpace) const;
85
86 StringRef getValueKind(Type *Ty, StringRef TypeQual,
87 StringRef BaseTypeName) const;
88
89 std::string getTypeName(Type *Ty, bool Signed) const;
90
91 msgpack::ArrayDocNode getWorkGroupDimensions(MDNode *Node) const;
92
93 msgpack::MapDocNode getHSAKernelProps(const MachineFunction &MF,
94 const SIProgramInfo &ProgramInfo,
95 unsigned CodeObjectVersion) const;
96
97 void emitVersion() override;
98
99 void emitTargetID(const TargetID &TargetID);
100
101 void emitPrintf(const Module &Mod);
102
103 void emitKernelLanguage(const Function &Func, msgpack::MapDocNode Kern);
104
105 void emitKernelAttrs(const AMDGPUTargetMachine &TM, const MachineFunction &MF,
106 msgpack::MapDocNode Kern) override;
107
108 void emitKernelArgs(const MachineFunction &MF, msgpack::MapDocNode Kern);
109
110 void emitKernelArg(const Argument &Arg, uint64_t &Offset,
111 msgpack::ArrayDocNode Args);
112
113 void emitKernelArg(const DataLayout &DL, Type *Ty, Align Alignment,
114 StringRef ValueKind, uint64_t &Offset,
115 msgpack::ArrayDocNode Args,
116 MaybeAlign PointeeAlign = std::nullopt,
117 StringRef Name = "", StringRef TypeName = "",
118 StringRef BaseTypeName = "", StringRef ActAccQual = "",
119 StringRef AccQual = "", StringRef TypeQual = "");
120
121 void emitHiddenKernelArgs(const MachineFunction &MF, uint64_t &Offset,
122 msgpack::ArrayDocNode Args) override;
123
124 msgpack::DocNode &getRootMetadata(StringRef Key) {
125 return HSAMetadataDoc->getRoot().getMap(/*Convert=*/Convert: true)[Key];
126 }
127
128public:
129 explicit MetadataStreamerMsgPackV4(const AMDGPUOptions &CLOpts)
130 : CLOpts(CLOpts) {}
131 ~MetadataStreamerMsgPackV4() override = default;
132
133 bool emitTo(AMDGPUTargetStreamer &TargetStreamer) override;
134
135 void begin(const Module &Mod, const TargetID &TargetID) override;
136
137 void end() override;
138
139 void emitKernel(const MachineFunction &MF,
140 const SIProgramInfo &ProgramInfo) override;
141};
142
143class MetadataStreamerMsgPackV5 : public MetadataStreamerMsgPackV4 {
144protected:
145 void emitVersion() override;
146 void emitHiddenKernelArgs(const MachineFunction &MF, uint64_t &Offset,
147 msgpack::ArrayDocNode Args) override;
148 void emitKernelAttrs(const AMDGPUTargetMachine &TM, const MachineFunction &MF,
149 msgpack::MapDocNode Kern) override;
150
151public:
152 using MetadataStreamerMsgPackV4::MetadataStreamerMsgPackV4;
153 ~MetadataStreamerMsgPackV5() override = default;
154};
155
156class MetadataStreamerMsgPackV6 final : public MetadataStreamerMsgPackV5 {
157protected:
158 void emitVersion() override;
159
160public:
161 using MetadataStreamerMsgPackV5::MetadataStreamerMsgPackV5;
162 ~MetadataStreamerMsgPackV6() override = default;
163
164 void emitKernelAttrs(const AMDGPUTargetMachine &TM, const MachineFunction &MF,
165 msgpack::MapDocNode Kern) override;
166};
167
168} // end namespace HSAMD
169} // end namespace AMDGPU
170} // end namespace llvm
171
172#endif // LLVM_LIB_TARGET_AMDGPU_MCTARGETDESC_AMDGPUHSAMETADATASTREAMER_H
173