1 //===-- AMDGPUTargetStreamer.cpp - Mips Target Streamer Methods -----------===//
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 // This file provides AMDGPU specific target streamer methods.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "AMDGPUTargetStreamer.h"
14 #include "AMDGPU.h"
15 #include "SIDefines.h"
16 #include "Utils/AMDGPUBaseInfo.h"
17 #include "Utils/AMDKernelCodeTUtils.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/BinaryFormat/AMDGPUMetadataVerifier.h"
20 #include "llvm/BinaryFormat/ELF.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/IR/Metadata.h"
24 #include "llvm/IR/Module.h"
25 #include "llvm/MC/MCContext.h"
26 #include "llvm/MC/MCELFStreamer.h"
27 #include "llvm/MC/MCObjectFileInfo.h"
28 #include "llvm/MC/MCSectionELF.h"
29 #include "llvm/Support/FormattedStream.h"
30 #include "llvm/Support/TargetParser.h"
31 
32 namespace llvm {
33 #include "AMDGPUPTNote.h"
34 }
35 
36 using namespace llvm;
37 using namespace llvm::AMDGPU;
38 using namespace llvm::AMDGPU::HSAMD;
39 
40 //===----------------------------------------------------------------------===//
41 // AMDGPUTargetStreamer
42 //===----------------------------------------------------------------------===//
43 
44 bool AMDGPUTargetStreamer::EmitHSAMetadataV2(StringRef HSAMetadataString) {
45   HSAMD::Metadata HSAMetadata;
46   if (HSAMD::fromString(HSAMetadataString, HSAMetadata))
47     return false;
48 
49   return EmitHSAMetadata(HSAMetadata);
50 }
51 
52 bool AMDGPUTargetStreamer::EmitHSAMetadataV3(StringRef HSAMetadataString) {
53   msgpack::Document HSAMetadataDoc;
54   if (!HSAMetadataDoc.fromYAML(HSAMetadataString))
55     return false;
56   return EmitHSAMetadata(HSAMetadataDoc, false);
57 }
58 
59 StringRef AMDGPUTargetStreamer::getArchNameFromElfMach(unsigned ElfMach) {
60   AMDGPU::GPUKind AK;
61 
62   switch (ElfMach) {
63   case ELF::EF_AMDGPU_MACH_R600_R600:      AK = GK_R600;    break;
64   case ELF::EF_AMDGPU_MACH_R600_R630:      AK = GK_R630;    break;
65   case ELF::EF_AMDGPU_MACH_R600_RS880:     AK = GK_RS880;   break;
66   case ELF::EF_AMDGPU_MACH_R600_RV670:     AK = GK_RV670;   break;
67   case ELF::EF_AMDGPU_MACH_R600_RV710:     AK = GK_RV710;   break;
68   case ELF::EF_AMDGPU_MACH_R600_RV730:     AK = GK_RV730;   break;
69   case ELF::EF_AMDGPU_MACH_R600_RV770:     AK = GK_RV770;   break;
70   case ELF::EF_AMDGPU_MACH_R600_CEDAR:     AK = GK_CEDAR;   break;
71   case ELF::EF_AMDGPU_MACH_R600_CYPRESS:   AK = GK_CYPRESS; break;
72   case ELF::EF_AMDGPU_MACH_R600_JUNIPER:   AK = GK_JUNIPER; break;
73   case ELF::EF_AMDGPU_MACH_R600_REDWOOD:   AK = GK_REDWOOD; break;
74   case ELF::EF_AMDGPU_MACH_R600_SUMO:      AK = GK_SUMO;    break;
75   case ELF::EF_AMDGPU_MACH_R600_BARTS:     AK = GK_BARTS;   break;
76   case ELF::EF_AMDGPU_MACH_R600_CAICOS:    AK = GK_CAICOS;  break;
77   case ELF::EF_AMDGPU_MACH_R600_CAYMAN:    AK = GK_CAYMAN;  break;
78   case ELF::EF_AMDGPU_MACH_R600_TURKS:     AK = GK_TURKS;   break;
79   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX600:  AK = GK_GFX600;  break;
80   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX601:  AK = GK_GFX601;  break;
81   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX700:  AK = GK_GFX700;  break;
82   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX701:  AK = GK_GFX701;  break;
83   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX702:  AK = GK_GFX702;  break;
84   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX703:  AK = GK_GFX703;  break;
85   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX704:  AK = GK_GFX704;  break;
86   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX801:  AK = GK_GFX801;  break;
87   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX802:  AK = GK_GFX802;  break;
88   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX803:  AK = GK_GFX803;  break;
89   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX810:  AK = GK_GFX810;  break;
90   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX900:  AK = GK_GFX900;  break;
91   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX902:  AK = GK_GFX902;  break;
92   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX904:  AK = GK_GFX904;  break;
93   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX906:  AK = GK_GFX906;  break;
94   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX909:  AK = GK_GFX909;  break;
95   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX1010: AK = GK_GFX1010; break;
96   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX1011: AK = GK_GFX1011; break;
97   case ELF::EF_AMDGPU_MACH_AMDGCN_GFX1012: AK = GK_GFX1012; break;
98   case ELF::EF_AMDGPU_MACH_NONE:           AK = GK_NONE;    break;
99   }
100 
101   StringRef GPUName = getArchNameAMDGCN(AK);
102   if (GPUName != "")
103     return GPUName;
104   return getArchNameR600(AK);
105 }
106 
107 unsigned AMDGPUTargetStreamer::getElfMach(StringRef GPU) {
108   AMDGPU::GPUKind AK = parseArchAMDGCN(GPU);
109   if (AK == AMDGPU::GPUKind::GK_NONE)
110     AK = parseArchR600(GPU);
111 
112   switch (AK) {
113   case GK_R600:    return ELF::EF_AMDGPU_MACH_R600_R600;
114   case GK_R630:    return ELF::EF_AMDGPU_MACH_R600_R630;
115   case GK_RS880:   return ELF::EF_AMDGPU_MACH_R600_RS880;
116   case GK_RV670:   return ELF::EF_AMDGPU_MACH_R600_RV670;
117   case GK_RV710:   return ELF::EF_AMDGPU_MACH_R600_RV710;
118   case GK_RV730:   return ELF::EF_AMDGPU_MACH_R600_RV730;
119   case GK_RV770:   return ELF::EF_AMDGPU_MACH_R600_RV770;
120   case GK_CEDAR:   return ELF::EF_AMDGPU_MACH_R600_CEDAR;
121   case GK_CYPRESS: return ELF::EF_AMDGPU_MACH_R600_CYPRESS;
122   case GK_JUNIPER: return ELF::EF_AMDGPU_MACH_R600_JUNIPER;
123   case GK_REDWOOD: return ELF::EF_AMDGPU_MACH_R600_REDWOOD;
124   case GK_SUMO:    return ELF::EF_AMDGPU_MACH_R600_SUMO;
125   case GK_BARTS:   return ELF::EF_AMDGPU_MACH_R600_BARTS;
126   case GK_CAICOS:  return ELF::EF_AMDGPU_MACH_R600_CAICOS;
127   case GK_CAYMAN:  return ELF::EF_AMDGPU_MACH_R600_CAYMAN;
128   case GK_TURKS:   return ELF::EF_AMDGPU_MACH_R600_TURKS;
129   case GK_GFX600:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX600;
130   case GK_GFX601:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX601;
131   case GK_GFX700:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX700;
132   case GK_GFX701:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX701;
133   case GK_GFX702:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX702;
134   case GK_GFX703:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX703;
135   case GK_GFX704:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX704;
136   case GK_GFX801:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX801;
137   case GK_GFX802:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX802;
138   case GK_GFX803:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX803;
139   case GK_GFX810:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX810;
140   case GK_GFX900:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX900;
141   case GK_GFX902:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX902;
142   case GK_GFX904:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX904;
143   case GK_GFX906:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX906;
144   case GK_GFX909:  return ELF::EF_AMDGPU_MACH_AMDGCN_GFX909;
145   case GK_GFX1010: return ELF::EF_AMDGPU_MACH_AMDGCN_GFX1010;
146   case GK_GFX1011: return ELF::EF_AMDGPU_MACH_AMDGCN_GFX1011;
147   case GK_GFX1012: return ELF::EF_AMDGPU_MACH_AMDGCN_GFX1012;
148   case GK_NONE:    return ELF::EF_AMDGPU_MACH_NONE;
149   }
150 
151   llvm_unreachable("unknown GPU");
152 }
153 
154 //===----------------------------------------------------------------------===//
155 // AMDGPUTargetAsmStreamer
156 //===----------------------------------------------------------------------===//
157 
158 AMDGPUTargetAsmStreamer::AMDGPUTargetAsmStreamer(MCStreamer &S,
159                                                  formatted_raw_ostream &OS)
160     : AMDGPUTargetStreamer(S), OS(OS) { }
161 
162 // A hook for emitting stuff at the end.
163 // We use it for emitting the accumulated PAL metadata as directives.
164 void AMDGPUTargetAsmStreamer::finish() {
165   std::string S;
166   getPALMetadata()->toString(S);
167   OS << S;
168 }
169 
170 void AMDGPUTargetAsmStreamer::EmitDirectiveAMDGCNTarget(StringRef Target) {
171   OS << "\t.amdgcn_target \"" << Target << "\"\n";
172 }
173 
174 void AMDGPUTargetAsmStreamer::EmitDirectiveHSACodeObjectVersion(
175     uint32_t Major, uint32_t Minor) {
176   OS << "\t.hsa_code_object_version " <<
177         Twine(Major) << "," << Twine(Minor) << '\n';
178 }
179 
180 void
181 AMDGPUTargetAsmStreamer::EmitDirectiveHSACodeObjectISA(uint32_t Major,
182                                                        uint32_t Minor,
183                                                        uint32_t Stepping,
184                                                        StringRef VendorName,
185                                                        StringRef ArchName) {
186   OS << "\t.hsa_code_object_isa " <<
187         Twine(Major) << "," << Twine(Minor) << "," << Twine(Stepping) <<
188         ",\"" << VendorName << "\",\"" << ArchName << "\"\n";
189 
190 }
191 
192 void
193 AMDGPUTargetAsmStreamer::EmitAMDKernelCodeT(const amd_kernel_code_t &Header) {
194   OS << "\t.amd_kernel_code_t\n";
195   dumpAmdKernelCode(&Header, OS, "\t\t");
196   OS << "\t.end_amd_kernel_code_t\n";
197 }
198 
199 void AMDGPUTargetAsmStreamer::EmitAMDGPUSymbolType(StringRef SymbolName,
200                                                    unsigned Type) {
201   switch (Type) {
202     default: llvm_unreachable("Invalid AMDGPU symbol type");
203     case ELF::STT_AMDGPU_HSA_KERNEL:
204       OS << "\t.amdgpu_hsa_kernel " << SymbolName << '\n' ;
205       break;
206   }
207 }
208 
209 void AMDGPUTargetAsmStreamer::emitAMDGPULDS(MCSymbol *Symbol, unsigned Size,
210                                             unsigned Align) {
211   OS << "\t.amdgpu_lds " << Symbol->getName() << ", " << Size << ", " << Align
212      << '\n';
213 }
214 
215 bool AMDGPUTargetAsmStreamer::EmitISAVersion(StringRef IsaVersionString) {
216   OS << "\t.amd_amdgpu_isa \"" << IsaVersionString << "\"\n";
217   return true;
218 }
219 
220 bool AMDGPUTargetAsmStreamer::EmitHSAMetadata(
221     const AMDGPU::HSAMD::Metadata &HSAMetadata) {
222   std::string HSAMetadataString;
223   if (HSAMD::toString(HSAMetadata, HSAMetadataString))
224     return false;
225 
226   OS << '\t' << AssemblerDirectiveBegin << '\n';
227   OS << HSAMetadataString << '\n';
228   OS << '\t' << AssemblerDirectiveEnd << '\n';
229   return true;
230 }
231 
232 bool AMDGPUTargetAsmStreamer::EmitHSAMetadata(
233     msgpack::Document &HSAMetadataDoc, bool Strict) {
234   V3::MetadataVerifier Verifier(Strict);
235   if (!Verifier.verify(HSAMetadataDoc.getRoot()))
236     return false;
237 
238   std::string HSAMetadataString;
239   raw_string_ostream StrOS(HSAMetadataString);
240   HSAMetadataDoc.toYAML(StrOS);
241 
242   OS << '\t' << V3::AssemblerDirectiveBegin << '\n';
243   OS << StrOS.str() << '\n';
244   OS << '\t' << V3::AssemblerDirectiveEnd << '\n';
245   return true;
246 }
247 
248 bool AMDGPUTargetAsmStreamer::EmitCodeEnd() {
249   const uint32_t Encoded_s_code_end = 0xbf9f0000;
250   OS << "\t.p2alignl 6, " << Encoded_s_code_end << '\n';
251   OS << "\t.fill 32, 4, " << Encoded_s_code_end << '\n';
252   return true;
253 }
254 
255 void AMDGPUTargetAsmStreamer::EmitAmdhsaKernelDescriptor(
256     const MCSubtargetInfo &STI, StringRef KernelName,
257     const amdhsa::kernel_descriptor_t &KD, uint64_t NextVGPR, uint64_t NextSGPR,
258     bool ReserveVCC, bool ReserveFlatScr, bool ReserveXNACK) {
259   IsaVersion IVersion = getIsaVersion(STI.getCPU());
260 
261   OS << "\t.amdhsa_kernel " << KernelName << '\n';
262 
263 #define PRINT_FIELD(STREAM, DIRECTIVE, KERNEL_DESC, MEMBER_NAME, FIELD_NAME)   \
264   STREAM << "\t\t" << DIRECTIVE << " "                                         \
265          << AMDHSA_BITS_GET(KERNEL_DESC.MEMBER_NAME, FIELD_NAME) << '\n';
266 
267   OS << "\t\t.amdhsa_group_segment_fixed_size " << KD.group_segment_fixed_size
268      << '\n';
269   OS << "\t\t.amdhsa_private_segment_fixed_size "
270      << KD.private_segment_fixed_size << '\n';
271 
272   PRINT_FIELD(OS, ".amdhsa_user_sgpr_private_segment_buffer", KD,
273               kernel_code_properties,
274               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_PRIVATE_SEGMENT_BUFFER);
275   PRINT_FIELD(OS, ".amdhsa_user_sgpr_dispatch_ptr", KD,
276               kernel_code_properties,
277               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_PTR);
278   PRINT_FIELD(OS, ".amdhsa_user_sgpr_queue_ptr", KD,
279               kernel_code_properties,
280               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_QUEUE_PTR);
281   PRINT_FIELD(OS, ".amdhsa_user_sgpr_kernarg_segment_ptr", KD,
282               kernel_code_properties,
283               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_KERNARG_SEGMENT_PTR);
284   PRINT_FIELD(OS, ".amdhsa_user_sgpr_dispatch_id", KD,
285               kernel_code_properties,
286               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_ID);
287   PRINT_FIELD(OS, ".amdhsa_user_sgpr_flat_scratch_init", KD,
288               kernel_code_properties,
289               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_FLAT_SCRATCH_INIT);
290   PRINT_FIELD(OS, ".amdhsa_user_sgpr_private_segment_size", KD,
291               kernel_code_properties,
292               amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_PRIVATE_SEGMENT_SIZE);
293   if (IVersion.Major >= 10)
294     PRINT_FIELD(OS, ".amdhsa_wavefront_size32", KD,
295                 kernel_code_properties,
296                 amdhsa::KERNEL_CODE_PROPERTY_ENABLE_WAVEFRONT_SIZE32);
297   PRINT_FIELD(
298       OS, ".amdhsa_system_sgpr_private_segment_wavefront_offset", KD,
299       compute_pgm_rsrc2,
300       amdhsa::COMPUTE_PGM_RSRC2_ENABLE_SGPR_PRIVATE_SEGMENT_WAVEFRONT_OFFSET);
301   PRINT_FIELD(OS, ".amdhsa_system_sgpr_workgroup_id_x", KD,
302               compute_pgm_rsrc2,
303               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_SGPR_WORKGROUP_ID_X);
304   PRINT_FIELD(OS, ".amdhsa_system_sgpr_workgroup_id_y", KD,
305               compute_pgm_rsrc2,
306               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_SGPR_WORKGROUP_ID_Y);
307   PRINT_FIELD(OS, ".amdhsa_system_sgpr_workgroup_id_z", KD,
308               compute_pgm_rsrc2,
309               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_SGPR_WORKGROUP_ID_Z);
310   PRINT_FIELD(OS, ".amdhsa_system_sgpr_workgroup_info", KD,
311               compute_pgm_rsrc2,
312               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_SGPR_WORKGROUP_INFO);
313   PRINT_FIELD(OS, ".amdhsa_system_vgpr_workitem_id", KD,
314               compute_pgm_rsrc2,
315               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_VGPR_WORKITEM_ID);
316 
317   // These directives are required.
318   OS << "\t\t.amdhsa_next_free_vgpr " << NextVGPR << '\n';
319   OS << "\t\t.amdhsa_next_free_sgpr " << NextSGPR << '\n';
320 
321   if (!ReserveVCC)
322     OS << "\t\t.amdhsa_reserve_vcc " << ReserveVCC << '\n';
323   if (IVersion.Major >= 7 && !ReserveFlatScr)
324     OS << "\t\t.amdhsa_reserve_flat_scratch " << ReserveFlatScr << '\n';
325   if (IVersion.Major >= 8 && ReserveXNACK != hasXNACK(STI))
326     OS << "\t\t.amdhsa_reserve_xnack_mask " << ReserveXNACK << '\n';
327 
328   PRINT_FIELD(OS, ".amdhsa_float_round_mode_32", KD,
329               compute_pgm_rsrc1,
330               amdhsa::COMPUTE_PGM_RSRC1_FLOAT_ROUND_MODE_32);
331   PRINT_FIELD(OS, ".amdhsa_float_round_mode_16_64", KD,
332               compute_pgm_rsrc1,
333               amdhsa::COMPUTE_PGM_RSRC1_FLOAT_ROUND_MODE_16_64);
334   PRINT_FIELD(OS, ".amdhsa_float_denorm_mode_32", KD,
335               compute_pgm_rsrc1,
336               amdhsa::COMPUTE_PGM_RSRC1_FLOAT_DENORM_MODE_32);
337   PRINT_FIELD(OS, ".amdhsa_float_denorm_mode_16_64", KD,
338               compute_pgm_rsrc1,
339               amdhsa::COMPUTE_PGM_RSRC1_FLOAT_DENORM_MODE_16_64);
340   PRINT_FIELD(OS, ".amdhsa_dx10_clamp", KD,
341               compute_pgm_rsrc1,
342               amdhsa::COMPUTE_PGM_RSRC1_ENABLE_DX10_CLAMP);
343   PRINT_FIELD(OS, ".amdhsa_ieee_mode", KD,
344               compute_pgm_rsrc1,
345               amdhsa::COMPUTE_PGM_RSRC1_ENABLE_IEEE_MODE);
346   if (IVersion.Major >= 9)
347     PRINT_FIELD(OS, ".amdhsa_fp16_overflow", KD,
348                 compute_pgm_rsrc1,
349                 amdhsa::COMPUTE_PGM_RSRC1_FP16_OVFL);
350   if (IVersion.Major >= 10) {
351     PRINT_FIELD(OS, ".amdhsa_workgroup_processor_mode", KD,
352                 compute_pgm_rsrc1,
353                 amdhsa::COMPUTE_PGM_RSRC1_WGP_MODE);
354     PRINT_FIELD(OS, ".amdhsa_memory_ordered", KD,
355                 compute_pgm_rsrc1,
356                 amdhsa::COMPUTE_PGM_RSRC1_MEM_ORDERED);
357     PRINT_FIELD(OS, ".amdhsa_forward_progress", KD,
358                 compute_pgm_rsrc1,
359                 amdhsa::COMPUTE_PGM_RSRC1_FWD_PROGRESS);
360   }
361   PRINT_FIELD(
362       OS, ".amdhsa_exception_fp_ieee_invalid_op", KD,
363       compute_pgm_rsrc2,
364       amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_IEEE_754_FP_INVALID_OPERATION);
365   PRINT_FIELD(OS, ".amdhsa_exception_fp_denorm_src", KD,
366               compute_pgm_rsrc2,
367               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_FP_DENORMAL_SOURCE);
368   PRINT_FIELD(
369       OS, ".amdhsa_exception_fp_ieee_div_zero", KD,
370       compute_pgm_rsrc2,
371       amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_IEEE_754_FP_DIVISION_BY_ZERO);
372   PRINT_FIELD(OS, ".amdhsa_exception_fp_ieee_overflow", KD,
373               compute_pgm_rsrc2,
374               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_IEEE_754_FP_OVERFLOW);
375   PRINT_FIELD(OS, ".amdhsa_exception_fp_ieee_underflow", KD,
376               compute_pgm_rsrc2,
377               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_IEEE_754_FP_UNDERFLOW);
378   PRINT_FIELD(OS, ".amdhsa_exception_fp_ieee_inexact", KD,
379               compute_pgm_rsrc2,
380               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_IEEE_754_FP_INEXACT);
381   PRINT_FIELD(OS, ".amdhsa_exception_int_div_zero", KD,
382               compute_pgm_rsrc2,
383               amdhsa::COMPUTE_PGM_RSRC2_ENABLE_EXCEPTION_INT_DIVIDE_BY_ZERO);
384 #undef PRINT_FIELD
385 
386   OS << "\t.end_amdhsa_kernel\n";
387 }
388 
389 //===----------------------------------------------------------------------===//
390 // AMDGPUTargetELFStreamer
391 //===----------------------------------------------------------------------===//
392 
393 AMDGPUTargetELFStreamer::AMDGPUTargetELFStreamer(
394     MCStreamer &S, const MCSubtargetInfo &STI)
395     : AMDGPUTargetStreamer(S), Streamer(S) {
396   MCAssembler &MCA = getStreamer().getAssembler();
397   unsigned EFlags = MCA.getELFHeaderEFlags();
398 
399   EFlags &= ~ELF::EF_AMDGPU_MACH;
400   EFlags |= getElfMach(STI.getCPU());
401 
402   EFlags &= ~ELF::EF_AMDGPU_XNACK;
403   if (AMDGPU::hasXNACK(STI))
404     EFlags |= ELF::EF_AMDGPU_XNACK;
405 
406   EFlags &= ~ELF::EF_AMDGPU_SRAM_ECC;
407   if (AMDGPU::hasSRAMECC(STI))
408     EFlags |= ELF::EF_AMDGPU_SRAM_ECC;
409 
410   MCA.setELFHeaderEFlags(EFlags);
411 }
412 
413 MCELFStreamer &AMDGPUTargetELFStreamer::getStreamer() {
414   return static_cast<MCELFStreamer &>(Streamer);
415 }
416 
417 // A hook for emitting stuff at the end.
418 // We use it for emitting the accumulated PAL metadata as a .note record.
419 void AMDGPUTargetELFStreamer::finish() {
420   std::string Blob;
421   const char *Vendor = getPALMetadata()->getVendor();
422   unsigned Type = getPALMetadata()->getType();
423   getPALMetadata()->toBlob(Type, Blob);
424   if (Blob.empty())
425     return;
426   EmitNote(Vendor, MCConstantExpr::create(Blob.size(), getContext()), Type,
427            [&](MCELFStreamer &OS) { OS.EmitBytes(Blob); });
428 }
429 
430 void AMDGPUTargetELFStreamer::EmitNote(
431     StringRef Name, const MCExpr *DescSZ, unsigned NoteType,
432     function_ref<void(MCELFStreamer &)> EmitDesc) {
433   auto &S = getStreamer();
434   auto &Context = S.getContext();
435 
436   auto NameSZ = Name.size() + 1;
437 
438   S.PushSection();
439   S.SwitchSection(Context.getELFSection(
440     ElfNote::SectionName, ELF::SHT_NOTE, ELF::SHF_ALLOC));
441   S.EmitIntValue(NameSZ, 4);                                  // namesz
442   S.EmitValue(DescSZ, 4);                                     // descz
443   S.EmitIntValue(NoteType, 4);                                // type
444   S.EmitBytes(Name);                                          // name
445   S.EmitValueToAlignment(4, 0, 1, 0);                         // padding 0
446   EmitDesc(S);                                                // desc
447   S.EmitValueToAlignment(4, 0, 1, 0);                         // padding 0
448   S.PopSection();
449 }
450 
451 void AMDGPUTargetELFStreamer::EmitDirectiveAMDGCNTarget(StringRef Target) {}
452 
453 void AMDGPUTargetELFStreamer::EmitDirectiveHSACodeObjectVersion(
454     uint32_t Major, uint32_t Minor) {
455 
456   EmitNote(ElfNote::NoteNameV2, MCConstantExpr::create(8, getContext()),
457            ElfNote::NT_AMDGPU_HSA_CODE_OBJECT_VERSION, [&](MCELFStreamer &OS) {
458              OS.EmitIntValue(Major, 4);
459              OS.EmitIntValue(Minor, 4);
460            });
461 }
462 
463 void
464 AMDGPUTargetELFStreamer::EmitDirectiveHSACodeObjectISA(uint32_t Major,
465                                                        uint32_t Minor,
466                                                        uint32_t Stepping,
467                                                        StringRef VendorName,
468                                                        StringRef ArchName) {
469   uint16_t VendorNameSize = VendorName.size() + 1;
470   uint16_t ArchNameSize = ArchName.size() + 1;
471 
472   unsigned DescSZ = sizeof(VendorNameSize) + sizeof(ArchNameSize) +
473     sizeof(Major) + sizeof(Minor) + sizeof(Stepping) +
474     VendorNameSize + ArchNameSize;
475 
476   EmitNote(ElfNote::NoteNameV2, MCConstantExpr::create(DescSZ, getContext()),
477            ElfNote::NT_AMDGPU_HSA_ISA, [&](MCELFStreamer &OS) {
478              OS.EmitIntValue(VendorNameSize, 2);
479              OS.EmitIntValue(ArchNameSize, 2);
480              OS.EmitIntValue(Major, 4);
481              OS.EmitIntValue(Minor, 4);
482              OS.EmitIntValue(Stepping, 4);
483              OS.EmitBytes(VendorName);
484              OS.EmitIntValue(0, 1); // NULL terminate VendorName
485              OS.EmitBytes(ArchName);
486              OS.EmitIntValue(0, 1); // NULL terminte ArchName
487            });
488 }
489 
490 void
491 AMDGPUTargetELFStreamer::EmitAMDKernelCodeT(const amd_kernel_code_t &Header) {
492 
493   MCStreamer &OS = getStreamer();
494   OS.PushSection();
495   OS.EmitBytes(StringRef((const char*)&Header, sizeof(Header)));
496   OS.PopSection();
497 }
498 
499 void AMDGPUTargetELFStreamer::EmitAMDGPUSymbolType(StringRef SymbolName,
500                                                    unsigned Type) {
501   MCSymbolELF *Symbol = cast<MCSymbolELF>(
502       getStreamer().getContext().getOrCreateSymbol(SymbolName));
503   Symbol->setType(Type);
504 }
505 
506 void AMDGPUTargetELFStreamer::emitAMDGPULDS(MCSymbol *Symbol, unsigned Size,
507                                             unsigned Align) {
508   assert(isPowerOf2_32(Align));
509 
510   MCSymbolELF *SymbolELF = cast<MCSymbolELF>(Symbol);
511   SymbolELF->setType(ELF::STT_OBJECT);
512 
513   if (!SymbolELF->isBindingSet()) {
514     SymbolELF->setBinding(ELF::STB_GLOBAL);
515     SymbolELF->setExternal(true);
516   }
517 
518   if (SymbolELF->declareCommon(Size, Align, true)) {
519     report_fatal_error("Symbol: " + Symbol->getName() +
520                        " redeclared as different type");
521   }
522 
523   SymbolELF->setIndex(ELF::SHN_AMDGPU_LDS);
524   SymbolELF->setSize(MCConstantExpr::create(Size, getContext()));
525 }
526 
527 bool AMDGPUTargetELFStreamer::EmitISAVersion(StringRef IsaVersionString) {
528   // Create two labels to mark the beginning and end of the desc field
529   // and a MCExpr to calculate the size of the desc field.
530   auto &Context = getContext();
531   auto *DescBegin = Context.createTempSymbol();
532   auto *DescEnd = Context.createTempSymbol();
533   auto *DescSZ = MCBinaryExpr::createSub(
534     MCSymbolRefExpr::create(DescEnd, Context),
535     MCSymbolRefExpr::create(DescBegin, Context), Context);
536 
537   EmitNote(ElfNote::NoteNameV2, DescSZ, ELF::NT_AMD_AMDGPU_ISA,
538            [&](MCELFStreamer &OS) {
539              OS.EmitLabel(DescBegin);
540              OS.EmitBytes(IsaVersionString);
541              OS.EmitLabel(DescEnd);
542            });
543   return true;
544 }
545 
546 bool AMDGPUTargetELFStreamer::EmitHSAMetadata(msgpack::Document &HSAMetadataDoc,
547                                               bool Strict) {
548   V3::MetadataVerifier Verifier(Strict);
549   if (!Verifier.verify(HSAMetadataDoc.getRoot()))
550     return false;
551 
552   std::string HSAMetadataString;
553   HSAMetadataDoc.writeToBlob(HSAMetadataString);
554 
555   // Create two labels to mark the beginning and end of the desc field
556   // and a MCExpr to calculate the size of the desc field.
557   auto &Context = getContext();
558   auto *DescBegin = Context.createTempSymbol();
559   auto *DescEnd = Context.createTempSymbol();
560   auto *DescSZ = MCBinaryExpr::createSub(
561       MCSymbolRefExpr::create(DescEnd, Context),
562       MCSymbolRefExpr::create(DescBegin, Context), Context);
563 
564   EmitNote(ElfNote::NoteNameV3, DescSZ, ELF::NT_AMDGPU_METADATA,
565            [&](MCELFStreamer &OS) {
566              OS.EmitLabel(DescBegin);
567              OS.EmitBytes(HSAMetadataString);
568              OS.EmitLabel(DescEnd);
569            });
570   return true;
571 }
572 
573 bool AMDGPUTargetELFStreamer::EmitHSAMetadata(
574     const AMDGPU::HSAMD::Metadata &HSAMetadata) {
575   std::string HSAMetadataString;
576   if (HSAMD::toString(HSAMetadata, HSAMetadataString))
577     return false;
578 
579   // Create two labels to mark the beginning and end of the desc field
580   // and a MCExpr to calculate the size of the desc field.
581   auto &Context = getContext();
582   auto *DescBegin = Context.createTempSymbol();
583   auto *DescEnd = Context.createTempSymbol();
584   auto *DescSZ = MCBinaryExpr::createSub(
585     MCSymbolRefExpr::create(DescEnd, Context),
586     MCSymbolRefExpr::create(DescBegin, Context), Context);
587 
588   EmitNote(ElfNote::NoteNameV2, DescSZ, ELF::NT_AMD_AMDGPU_HSA_METADATA,
589            [&](MCELFStreamer &OS) {
590              OS.EmitLabel(DescBegin);
591              OS.EmitBytes(HSAMetadataString);
592              OS.EmitLabel(DescEnd);
593            });
594   return true;
595 }
596 
597 bool AMDGPUTargetELFStreamer::EmitCodeEnd() {
598   const uint32_t Encoded_s_code_end = 0xbf9f0000;
599 
600   MCStreamer &OS = getStreamer();
601   OS.PushSection();
602   OS.EmitValueToAlignment(64, Encoded_s_code_end, 4);
603   for (unsigned I = 0; I < 32; ++I)
604     OS.EmitIntValue(Encoded_s_code_end, 4);
605   OS.PopSection();
606   return true;
607 }
608 
609 void AMDGPUTargetELFStreamer::EmitAmdhsaKernelDescriptor(
610     const MCSubtargetInfo &STI, StringRef KernelName,
611     const amdhsa::kernel_descriptor_t &KernelDescriptor, uint64_t NextVGPR,
612     uint64_t NextSGPR, bool ReserveVCC, bool ReserveFlatScr,
613     bool ReserveXNACK) {
614   auto &Streamer = getStreamer();
615   auto &Context = Streamer.getContext();
616 
617   MCSymbolELF *KernelCodeSymbol = cast<MCSymbolELF>(
618       Context.getOrCreateSymbol(Twine(KernelName)));
619   MCSymbolELF *KernelDescriptorSymbol = cast<MCSymbolELF>(
620       Context.getOrCreateSymbol(Twine(KernelName) + Twine(".kd")));
621 
622   // Copy kernel descriptor symbol's binding, other and visibility from the
623   // kernel code symbol.
624   KernelDescriptorSymbol->setBinding(KernelCodeSymbol->getBinding());
625   KernelDescriptorSymbol->setOther(KernelCodeSymbol->getOther());
626   KernelDescriptorSymbol->setVisibility(KernelCodeSymbol->getVisibility());
627   // Kernel descriptor symbol's type and size are fixed.
628   KernelDescriptorSymbol->setType(ELF::STT_OBJECT);
629   KernelDescriptorSymbol->setSize(
630       MCConstantExpr::create(sizeof(KernelDescriptor), Context));
631 
632   // The visibility of the kernel code symbol must be protected or less to allow
633   // static relocations from the kernel descriptor to be used.
634   if (KernelCodeSymbol->getVisibility() == ELF::STV_DEFAULT)
635     KernelCodeSymbol->setVisibility(ELF::STV_PROTECTED);
636 
637   Streamer.EmitLabel(KernelDescriptorSymbol);
638   Streamer.EmitBytes(StringRef(
639       (const char*)&(KernelDescriptor),
640       offsetof(amdhsa::kernel_descriptor_t, kernel_code_entry_byte_offset)));
641   // FIXME: Remove the use of VK_AMDGPU_REL64 in the expression below. The
642   // expression being created is:
643   //   (start of kernel code) - (start of kernel descriptor)
644   // It implies R_AMDGPU_REL64, but ends up being R_AMDGPU_ABS64.
645   Streamer.EmitValue(MCBinaryExpr::createSub(
646       MCSymbolRefExpr::create(
647           KernelCodeSymbol, MCSymbolRefExpr::VK_AMDGPU_REL64, Context),
648       MCSymbolRefExpr::create(
649           KernelDescriptorSymbol, MCSymbolRefExpr::VK_None, Context),
650       Context),
651       sizeof(KernelDescriptor.kernel_code_entry_byte_offset));
652   Streamer.EmitBytes(StringRef(
653       (const char*)&(KernelDescriptor) +
654           offsetof(amdhsa::kernel_descriptor_t, kernel_code_entry_byte_offset) +
655           sizeof(KernelDescriptor.kernel_code_entry_byte_offset),
656       sizeof(KernelDescriptor) -
657           offsetof(amdhsa::kernel_descriptor_t, kernel_code_entry_byte_offset) -
658           sizeof(KernelDescriptor.kernel_code_entry_byte_offset)));
659 }
660