1 //===-- AMDGPUAsmPrinter.cpp - AMDGPU assembly printer --------------------===//
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 ///
11 /// The AMDGPUAsmPrinter is used to print both assembly string and also binary
12 /// code.  When passed an MCAsmStreamer it prints assembly and when passed
13 /// an MCObjectStreamer it outputs binary code.
14 //
15 //===----------------------------------------------------------------------===//
16 //
17 
18 #include "AMDGPUAsmPrinter.h"
19 #include "AMDGPU.h"
20 #include "AMDGPUSubtarget.h"
21 #include "AMDGPUTargetMachine.h"
22 #include "MCTargetDesc/AMDGPUInstPrinter.h"
23 #include "MCTargetDesc/AMDGPUMCTargetDesc.h"
24 #include "MCTargetDesc/AMDGPUTargetStreamer.h"
25 #include "R600AsmPrinter.h"
26 #include "R600Defines.h"
27 #include "R600MachineFunctionInfo.h"
28 #include "R600RegisterInfo.h"
29 #include "SIDefines.h"
30 #include "SIInstrInfo.h"
31 #include "SIMachineFunctionInfo.h"
32 #include "SIRegisterInfo.h"
33 #include "TargetInfo/AMDGPUTargetInfo.h"
34 #include "Utils/AMDGPUBaseInfo.h"
35 #include "llvm/BinaryFormat/ELF.h"
36 #include "llvm/CodeGen/MachineFrameInfo.h"
37 #include "llvm/IR/DiagnosticInfo.h"
38 #include "llvm/MC/MCAssembler.h"
39 #include "llvm/MC/MCContext.h"
40 #include "llvm/MC/MCSectionELF.h"
41 #include "llvm/MC/MCStreamer.h"
42 #include "llvm/Support/AMDGPUMetadata.h"
43 #include "llvm/Support/MathExtras.h"
44 #include "llvm/Support/TargetParser.h"
45 #include "llvm/Support/TargetRegistry.h"
46 #include "llvm/Target/TargetLoweringObjectFile.h"
47 
48 using namespace llvm;
49 using namespace llvm::AMDGPU;
50 using namespace llvm::AMDGPU::HSAMD;
51 
52 // This should get the default rounding mode from the kernel. We just set the
53 // default here, but this could change if the OpenCL rounding mode pragmas are
54 // used.
55 //
56 // The denormal mode here should match what is reported by the OpenCL runtime
57 // for the CL_FP_DENORM bit from CL_DEVICE_{HALF|SINGLE|DOUBLE}_FP_CONFIG, but
58 // can also be override to flush with the -cl-denorms-are-zero compiler flag.
59 //
60 // AMD OpenCL only sets flush none and reports CL_FP_DENORM for double
61 // precision, and leaves single precision to flush all and does not report
62 // CL_FP_DENORM for CL_DEVICE_SINGLE_FP_CONFIG. Mesa's OpenCL currently reports
63 // CL_FP_DENORM for both.
64 //
65 // FIXME: It seems some instructions do not support single precision denormals
66 // regardless of the mode (exp_*_f32, rcp_*_f32, rsq_*_f32, rsq_*f32, sqrt_f32,
67 // and sin_f32, cos_f32 on most parts).
68 
69 // We want to use these instructions, and using fp32 denormals also causes
70 // instructions to run at the double precision rate for the device so it's
71 // probably best to just report no single precision denormals.
72 static uint32_t getFPMode(AMDGPU::SIModeRegisterDefaults Mode) {
73   return FP_ROUND_MODE_SP(FP_ROUND_ROUND_TO_NEAREST) |
74          FP_ROUND_MODE_DP(FP_ROUND_ROUND_TO_NEAREST) |
75          FP_DENORM_MODE_SP(Mode.fpDenormModeSPValue()) |
76          FP_DENORM_MODE_DP(Mode.fpDenormModeDPValue());
77 }
78 
79 static AsmPrinter *
80 createAMDGPUAsmPrinterPass(TargetMachine &tm,
81                            std::unique_ptr<MCStreamer> &&Streamer) {
82   return new AMDGPUAsmPrinter(tm, std::move(Streamer));
83 }
84 
85 extern "C" void LLVM_EXTERNAL_VISIBILITY LLVMInitializeAMDGPUAsmPrinter() {
86   TargetRegistry::RegisterAsmPrinter(getTheAMDGPUTarget(),
87                                      llvm::createR600AsmPrinterPass);
88   TargetRegistry::RegisterAsmPrinter(getTheGCNTarget(),
89                                      createAMDGPUAsmPrinterPass);
90 }
91 
92 AMDGPUAsmPrinter::AMDGPUAsmPrinter(TargetMachine &TM,
93                                    std::unique_ptr<MCStreamer> Streamer)
94   : AsmPrinter(TM, std::move(Streamer)) {
95     if (IsaInfo::hasCodeObjectV3(getGlobalSTI()))
96       HSAMetadataStream.reset(new MetadataStreamerV3());
97     else
98       HSAMetadataStream.reset(new MetadataStreamerV2());
99 }
100 
101 StringRef AMDGPUAsmPrinter::getPassName() const {
102   return "AMDGPU Assembly Printer";
103 }
104 
105 const MCSubtargetInfo *AMDGPUAsmPrinter::getGlobalSTI() const {
106   return TM.getMCSubtargetInfo();
107 }
108 
109 AMDGPUTargetStreamer* AMDGPUAsmPrinter::getTargetStreamer() const {
110   if (!OutStreamer)
111     return nullptr;
112   return static_cast<AMDGPUTargetStreamer*>(OutStreamer->getTargetStreamer());
113 }
114 
115 void AMDGPUAsmPrinter::emitStartOfAsmFile(Module &M) {
116   if (IsaInfo::hasCodeObjectV3(getGlobalSTI())) {
117     std::string ExpectedTarget;
118     raw_string_ostream ExpectedTargetOS(ExpectedTarget);
119     IsaInfo::streamIsaVersion(getGlobalSTI(), ExpectedTargetOS);
120 
121     getTargetStreamer()->EmitDirectiveAMDGCNTarget(ExpectedTarget);
122   }
123 
124   if (TM.getTargetTriple().getOS() != Triple::AMDHSA &&
125       TM.getTargetTriple().getOS() != Triple::AMDPAL)
126     return;
127 
128   if (TM.getTargetTriple().getOS() == Triple::AMDHSA)
129     HSAMetadataStream->begin(M);
130 
131   if (TM.getTargetTriple().getOS() == Triple::AMDPAL)
132     getTargetStreamer()->getPALMetadata()->readFromIR(M);
133 
134   if (IsaInfo::hasCodeObjectV3(getGlobalSTI()))
135     return;
136 
137   // HSA emits NT_AMDGPU_HSA_CODE_OBJECT_VERSION for code objects v2.
138   if (TM.getTargetTriple().getOS() == Triple::AMDHSA)
139     getTargetStreamer()->EmitDirectiveHSACodeObjectVersion(2, 1);
140 
141   // HSA and PAL emit NT_AMDGPU_HSA_ISA for code objects v2.
142   IsaVersion Version = getIsaVersion(getGlobalSTI()->getCPU());
143   getTargetStreamer()->EmitDirectiveHSACodeObjectISA(
144       Version.Major, Version.Minor, Version.Stepping, "AMD", "AMDGPU");
145 }
146 
147 void AMDGPUAsmPrinter::emitEndOfAsmFile(Module &M) {
148   // Following code requires TargetStreamer to be present.
149   if (!getTargetStreamer())
150     return;
151 
152   if (!IsaInfo::hasCodeObjectV3(getGlobalSTI())) {
153     // Emit ISA Version (NT_AMD_AMDGPU_ISA).
154     std::string ISAVersionString;
155     raw_string_ostream ISAVersionStream(ISAVersionString);
156     IsaInfo::streamIsaVersion(getGlobalSTI(), ISAVersionStream);
157     getTargetStreamer()->EmitISAVersion(ISAVersionStream.str());
158   }
159 
160   // Emit HSA Metadata (NT_AMD_AMDGPU_HSA_METADATA).
161   if (TM.getTargetTriple().getOS() == Triple::AMDHSA) {
162     HSAMetadataStream->end();
163     bool Success = HSAMetadataStream->emitTo(*getTargetStreamer());
164     (void)Success;
165     assert(Success && "Malformed HSA Metadata");
166   }
167 }
168 
169 bool AMDGPUAsmPrinter::isBlockOnlyReachableByFallthrough(
170   const MachineBasicBlock *MBB) const {
171   if (!AsmPrinter::isBlockOnlyReachableByFallthrough(MBB))
172     return false;
173 
174   if (MBB->empty())
175     return true;
176 
177   // If this is a block implementing a long branch, an expression relative to
178   // the start of the block is needed.  to the start of the block.
179   // XXX - Is there a smarter way to check this?
180   return (MBB->back().getOpcode() != AMDGPU::S_SETPC_B64);
181 }
182 
183 void AMDGPUAsmPrinter::emitFunctionBodyStart() {
184   const SIMachineFunctionInfo &MFI = *MF->getInfo<SIMachineFunctionInfo>();
185   if (!MFI.isEntryFunction())
186     return;
187 
188   const GCNSubtarget &STM = MF->getSubtarget<GCNSubtarget>();
189   const Function &F = MF->getFunction();
190   if (!STM.hasCodeObjectV3() && STM.isAmdHsaOrMesa(F) &&
191       (F.getCallingConv() == CallingConv::AMDGPU_KERNEL ||
192        F.getCallingConv() == CallingConv::SPIR_KERNEL)) {
193     amd_kernel_code_t KernelCode;
194     getAmdKernelCode(KernelCode, CurrentProgramInfo, *MF);
195     getTargetStreamer()->EmitAMDKernelCodeT(KernelCode);
196   }
197 
198   if (STM.isAmdHsaOS())
199     HSAMetadataStream->emitKernel(*MF, CurrentProgramInfo);
200 }
201 
202 void AMDGPUAsmPrinter::emitFunctionBodyEnd() {
203   const SIMachineFunctionInfo &MFI = *MF->getInfo<SIMachineFunctionInfo>();
204   if (!MFI.isEntryFunction())
205     return;
206 
207   if (!IsaInfo::hasCodeObjectV3(getGlobalSTI()) ||
208       TM.getTargetTriple().getOS() != Triple::AMDHSA)
209     return;
210 
211   auto &Streamer = getTargetStreamer()->getStreamer();
212   auto &Context = Streamer.getContext();
213   auto &ObjectFileInfo = *Context.getObjectFileInfo();
214   auto &ReadOnlySection = *ObjectFileInfo.getReadOnlySection();
215 
216   Streamer.PushSection();
217   Streamer.SwitchSection(&ReadOnlySection);
218 
219   // CP microcode requires the kernel descriptor to be allocated on 64 byte
220   // alignment.
221   Streamer.emitValueToAlignment(64, 0, 1, 0);
222   if (ReadOnlySection.getAlignment() < 64)
223     ReadOnlySection.setAlignment(Align(64));
224 
225   const MCSubtargetInfo &STI = MF->getSubtarget();
226 
227   SmallString<128> KernelName;
228   getNameWithPrefix(KernelName, &MF->getFunction());
229   getTargetStreamer()->EmitAmdhsaKernelDescriptor(
230       STI, KernelName, getAmdhsaKernelDescriptor(*MF, CurrentProgramInfo),
231       CurrentProgramInfo.NumVGPRsForWavesPerEU,
232       CurrentProgramInfo.NumSGPRsForWavesPerEU -
233           IsaInfo::getNumExtraSGPRs(&STI,
234                                     CurrentProgramInfo.VCCUsed,
235                                     CurrentProgramInfo.FlatUsed),
236       CurrentProgramInfo.VCCUsed, CurrentProgramInfo.FlatUsed,
237       hasXNACK(STI));
238 
239   Streamer.PopSection();
240 }
241 
242 void AMDGPUAsmPrinter::emitFunctionEntryLabel() {
243   if (IsaInfo::hasCodeObjectV3(getGlobalSTI()) &&
244       TM.getTargetTriple().getOS() == Triple::AMDHSA) {
245     AsmPrinter::emitFunctionEntryLabel();
246     return;
247   }
248 
249   const SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
250   const GCNSubtarget &STM = MF->getSubtarget<GCNSubtarget>();
251   if (MFI->isEntryFunction() && STM.isAmdHsaOrMesa(MF->getFunction())) {
252     SmallString<128> SymbolName;
253     getNameWithPrefix(SymbolName, &MF->getFunction()),
254     getTargetStreamer()->EmitAMDGPUSymbolType(
255         SymbolName, ELF::STT_AMDGPU_HSA_KERNEL);
256   }
257   if (DumpCodeInstEmitter) {
258     // Disassemble function name label to text.
259     DisasmLines.push_back(MF->getName().str() + ":");
260     DisasmLineMaxLen = std::max(DisasmLineMaxLen, DisasmLines.back().size());
261     HexLines.push_back("");
262   }
263 
264   AsmPrinter::emitFunctionEntryLabel();
265 }
266 
267 void AMDGPUAsmPrinter::emitBasicBlockStart(const MachineBasicBlock &MBB) {
268   if (DumpCodeInstEmitter && !isBlockOnlyReachableByFallthrough(&MBB)) {
269     // Write a line for the basic block label if it is not only fallthrough.
270     DisasmLines.push_back(
271         (Twine("BB") + Twine(getFunctionNumber())
272          + "_" + Twine(MBB.getNumber()) + ":").str());
273     DisasmLineMaxLen = std::max(DisasmLineMaxLen, DisasmLines.back().size());
274     HexLines.push_back("");
275   }
276   AsmPrinter::emitBasicBlockStart(MBB);
277 }
278 
279 void AMDGPUAsmPrinter::emitGlobalVariable(const GlobalVariable *GV) {
280   if (GV->getAddressSpace() == AMDGPUAS::LOCAL_ADDRESS) {
281     if (GV->hasInitializer() && !isa<UndefValue>(GV->getInitializer())) {
282       OutContext.reportError({},
283                              Twine(GV->getName()) +
284                                  ": unsupported initializer for address space");
285       return;
286     }
287 
288     // LDS variables aren't emitted in HSA or PAL yet.
289     const Triple::OSType OS = TM.getTargetTriple().getOS();
290     if (OS == Triple::AMDHSA || OS == Triple::AMDPAL)
291       return;
292 
293     MCSymbol *GVSym = getSymbol(GV);
294 
295     GVSym->redefineIfPossible();
296     if (GVSym->isDefined() || GVSym->isVariable())
297       report_fatal_error("symbol '" + Twine(GVSym->getName()) +
298                          "' is already defined");
299 
300     const DataLayout &DL = GV->getParent()->getDataLayout();
301     uint64_t Size = DL.getTypeAllocSize(GV->getValueType());
302     unsigned Align = GV->getAlignment();
303     if (!Align)
304       Align = 4;
305 
306     emitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration());
307     emitLinkage(GV, GVSym);
308     if (auto TS = getTargetStreamer())
309       TS->emitAMDGPULDS(GVSym, Size, Align);
310     return;
311   }
312 
313   AsmPrinter::emitGlobalVariable(GV);
314 }
315 
316 bool AMDGPUAsmPrinter::doFinalization(Module &M) {
317   CallGraphResourceInfo.clear();
318 
319   // Pad with s_code_end to help tools and guard against instruction prefetch
320   // causing stale data in caches. Arguably this should be done by the linker,
321   // which is why this isn't done for Mesa.
322   const MCSubtargetInfo &STI = *getGlobalSTI();
323   if (AMDGPU::isGFX10(STI) &&
324       (STI.getTargetTriple().getOS() == Triple::AMDHSA ||
325        STI.getTargetTriple().getOS() == Triple::AMDPAL)) {
326     OutStreamer->SwitchSection(getObjFileLowering().getTextSection());
327     getTargetStreamer()->EmitCodeEnd();
328   }
329 
330   return AsmPrinter::doFinalization(M);
331 }
332 
333 // Print comments that apply to both callable functions and entry points.
334 void AMDGPUAsmPrinter::emitCommonFunctionComments(
335   uint32_t NumVGPR,
336   Optional<uint32_t> NumAGPR,
337   uint32_t TotalNumVGPR,
338   uint32_t NumSGPR,
339   uint64_t ScratchSize,
340   uint64_t CodeSize,
341   const AMDGPUMachineFunction *MFI) {
342   OutStreamer->emitRawComment(" codeLenInByte = " + Twine(CodeSize), false);
343   OutStreamer->emitRawComment(" NumSgprs: " + Twine(NumSGPR), false);
344   OutStreamer->emitRawComment(" NumVgprs: " + Twine(NumVGPR), false);
345   if (NumAGPR) {
346     OutStreamer->emitRawComment(" NumAgprs: " + Twine(*NumAGPR), false);
347     OutStreamer->emitRawComment(" TotalNumVgprs: " + Twine(TotalNumVGPR),
348                                 false);
349   }
350   OutStreamer->emitRawComment(" ScratchSize: " + Twine(ScratchSize), false);
351   OutStreamer->emitRawComment(" MemoryBound: " + Twine(MFI->isMemoryBound()),
352                               false);
353 }
354 
355 uint16_t AMDGPUAsmPrinter::getAmdhsaKernelCodeProperties(
356     const MachineFunction &MF) const {
357   const SIMachineFunctionInfo &MFI = *MF.getInfo<SIMachineFunctionInfo>();
358   uint16_t KernelCodeProperties = 0;
359 
360   if (MFI.hasPrivateSegmentBuffer()) {
361     KernelCodeProperties |=
362         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_PRIVATE_SEGMENT_BUFFER;
363   }
364   if (MFI.hasDispatchPtr()) {
365     KernelCodeProperties |=
366         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_PTR;
367   }
368   if (MFI.hasQueuePtr()) {
369     KernelCodeProperties |=
370         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_QUEUE_PTR;
371   }
372   if (MFI.hasKernargSegmentPtr()) {
373     KernelCodeProperties |=
374         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_KERNARG_SEGMENT_PTR;
375   }
376   if (MFI.hasDispatchID()) {
377     KernelCodeProperties |=
378         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_ID;
379   }
380   if (MFI.hasFlatScratchInit()) {
381     KernelCodeProperties |=
382         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_SGPR_FLAT_SCRATCH_INIT;
383   }
384   if (MF.getSubtarget<GCNSubtarget>().isWave32()) {
385     KernelCodeProperties |=
386         amdhsa::KERNEL_CODE_PROPERTY_ENABLE_WAVEFRONT_SIZE32;
387   }
388 
389   return KernelCodeProperties;
390 }
391 
392 amdhsa::kernel_descriptor_t AMDGPUAsmPrinter::getAmdhsaKernelDescriptor(
393     const MachineFunction &MF,
394     const SIProgramInfo &PI) const {
395   amdhsa::kernel_descriptor_t KernelDescriptor;
396   memset(&KernelDescriptor, 0x0, sizeof(KernelDescriptor));
397 
398   assert(isUInt<32>(PI.ScratchSize));
399   assert(isUInt<32>(PI.ComputePGMRSrc1));
400   assert(isUInt<32>(PI.ComputePGMRSrc2));
401 
402   KernelDescriptor.group_segment_fixed_size = PI.LDSSize;
403   KernelDescriptor.private_segment_fixed_size = PI.ScratchSize;
404   KernelDescriptor.compute_pgm_rsrc1 = PI.ComputePGMRSrc1;
405   KernelDescriptor.compute_pgm_rsrc2 = PI.ComputePGMRSrc2;
406   KernelDescriptor.kernel_code_properties = getAmdhsaKernelCodeProperties(MF);
407 
408   return KernelDescriptor;
409 }
410 
411 bool AMDGPUAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
412   CurrentProgramInfo = SIProgramInfo();
413 
414   const AMDGPUMachineFunction *MFI = MF.getInfo<AMDGPUMachineFunction>();
415 
416   // The starting address of all shader programs must be 256 bytes aligned.
417   // Regular functions just need the basic required instruction alignment.
418   MF.setAlignment(MFI->isEntryFunction() ? Align(256) : Align(4));
419 
420   SetupMachineFunction(MF);
421 
422   const GCNSubtarget &STM = MF.getSubtarget<GCNSubtarget>();
423   MCContext &Context = getObjFileLowering().getContext();
424   // FIXME: This should be an explicit check for Mesa.
425   if (!STM.isAmdHsaOS() && !STM.isAmdPalOS()) {
426     MCSectionELF *ConfigSection =
427         Context.getELFSection(".AMDGPU.config", ELF::SHT_PROGBITS, 0);
428     OutStreamer->SwitchSection(ConfigSection);
429   }
430 
431   if (MFI->isEntryFunction()) {
432     getSIProgramInfo(CurrentProgramInfo, MF);
433   } else {
434     auto I = CallGraphResourceInfo.insert(
435       std::make_pair(&MF.getFunction(), SIFunctionResourceInfo()));
436     SIFunctionResourceInfo &Info = I.first->second;
437     assert(I.second && "should only be called once per function");
438     Info = analyzeResourceUsage(MF);
439   }
440 
441   if (STM.isAmdPalOS())
442     EmitPALMetadata(MF, CurrentProgramInfo);
443   else if (!STM.isAmdHsaOS()) {
444     EmitProgramInfoSI(MF, CurrentProgramInfo);
445   }
446 
447   DumpCodeInstEmitter = nullptr;
448   if (STM.dumpCode()) {
449     // For -dumpcode, get the assembler out of the streamer, even if it does
450     // not really want to let us have it. This only works with -filetype=obj.
451     bool SaveFlag = OutStreamer->getUseAssemblerInfoForParsing();
452     OutStreamer->setUseAssemblerInfoForParsing(true);
453     MCAssembler *Assembler = OutStreamer->getAssemblerPtr();
454     OutStreamer->setUseAssemblerInfoForParsing(SaveFlag);
455     if (Assembler)
456       DumpCodeInstEmitter = Assembler->getEmitterPtr();
457   }
458 
459   DisasmLines.clear();
460   HexLines.clear();
461   DisasmLineMaxLen = 0;
462 
463   emitFunctionBody();
464 
465   if (isVerbose()) {
466     MCSectionELF *CommentSection =
467         Context.getELFSection(".AMDGPU.csdata", ELF::SHT_PROGBITS, 0);
468     OutStreamer->SwitchSection(CommentSection);
469 
470     if (!MFI->isEntryFunction()) {
471       OutStreamer->emitRawComment(" Function info:", false);
472       SIFunctionResourceInfo &Info = CallGraphResourceInfo[&MF.getFunction()];
473       emitCommonFunctionComments(
474         Info.NumVGPR,
475         STM.hasMAIInsts() ? Info.NumAGPR : Optional<uint32_t>(),
476         Info.getTotalNumVGPRs(STM),
477         Info.getTotalNumSGPRs(MF.getSubtarget<GCNSubtarget>()),
478         Info.PrivateSegmentSize,
479         getFunctionCodeSize(MF), MFI);
480       return false;
481     }
482 
483     OutStreamer->emitRawComment(" Kernel info:", false);
484     emitCommonFunctionComments(CurrentProgramInfo.NumArchVGPR,
485                                STM.hasMAIInsts()
486                                  ? CurrentProgramInfo.NumAccVGPR
487                                  : Optional<uint32_t>(),
488                                CurrentProgramInfo.NumVGPR,
489                                CurrentProgramInfo.NumSGPR,
490                                CurrentProgramInfo.ScratchSize,
491                                getFunctionCodeSize(MF), MFI);
492 
493     OutStreamer->emitRawComment(
494       " FloatMode: " + Twine(CurrentProgramInfo.FloatMode), false);
495     OutStreamer->emitRawComment(
496       " IeeeMode: " + Twine(CurrentProgramInfo.IEEEMode), false);
497     OutStreamer->emitRawComment(
498       " LDSByteSize: " + Twine(CurrentProgramInfo.LDSSize) +
499       " bytes/workgroup (compile time only)", false);
500 
501     OutStreamer->emitRawComment(
502       " SGPRBlocks: " + Twine(CurrentProgramInfo.SGPRBlocks), false);
503     OutStreamer->emitRawComment(
504       " VGPRBlocks: " + Twine(CurrentProgramInfo.VGPRBlocks), false);
505 
506     OutStreamer->emitRawComment(
507       " NumSGPRsForWavesPerEU: " +
508       Twine(CurrentProgramInfo.NumSGPRsForWavesPerEU), false);
509     OutStreamer->emitRawComment(
510       " NumVGPRsForWavesPerEU: " +
511       Twine(CurrentProgramInfo.NumVGPRsForWavesPerEU), false);
512 
513     OutStreamer->emitRawComment(
514       " Occupancy: " +
515       Twine(CurrentProgramInfo.Occupancy), false);
516 
517     OutStreamer->emitRawComment(
518       " WaveLimiterHint : " + Twine(MFI->needsWaveLimiter()), false);
519 
520     OutStreamer->emitRawComment(
521       " COMPUTE_PGM_RSRC2:USER_SGPR: " +
522       Twine(G_00B84C_USER_SGPR(CurrentProgramInfo.ComputePGMRSrc2)), false);
523     OutStreamer->emitRawComment(
524       " COMPUTE_PGM_RSRC2:TRAP_HANDLER: " +
525       Twine(G_00B84C_TRAP_HANDLER(CurrentProgramInfo.ComputePGMRSrc2)), false);
526     OutStreamer->emitRawComment(
527       " COMPUTE_PGM_RSRC2:TGID_X_EN: " +
528       Twine(G_00B84C_TGID_X_EN(CurrentProgramInfo.ComputePGMRSrc2)), false);
529     OutStreamer->emitRawComment(
530       " COMPUTE_PGM_RSRC2:TGID_Y_EN: " +
531       Twine(G_00B84C_TGID_Y_EN(CurrentProgramInfo.ComputePGMRSrc2)), false);
532     OutStreamer->emitRawComment(
533       " COMPUTE_PGM_RSRC2:TGID_Z_EN: " +
534       Twine(G_00B84C_TGID_Z_EN(CurrentProgramInfo.ComputePGMRSrc2)), false);
535     OutStreamer->emitRawComment(
536       " COMPUTE_PGM_RSRC2:TIDIG_COMP_CNT: " +
537       Twine(G_00B84C_TIDIG_COMP_CNT(CurrentProgramInfo.ComputePGMRSrc2)),
538       false);
539   }
540 
541   if (DumpCodeInstEmitter) {
542 
543     OutStreamer->SwitchSection(
544         Context.getELFSection(".AMDGPU.disasm", ELF::SHT_PROGBITS, 0));
545 
546     for (size_t i = 0; i < DisasmLines.size(); ++i) {
547       std::string Comment = "\n";
548       if (!HexLines[i].empty()) {
549         Comment = std::string(DisasmLineMaxLen - DisasmLines[i].size(), ' ');
550         Comment += " ; " + HexLines[i] + "\n";
551       }
552 
553       OutStreamer->emitBytes(StringRef(DisasmLines[i]));
554       OutStreamer->emitBytes(StringRef(Comment));
555     }
556   }
557 
558   return false;
559 }
560 
561 uint64_t AMDGPUAsmPrinter::getFunctionCodeSize(const MachineFunction &MF) const {
562   const GCNSubtarget &STM = MF.getSubtarget<GCNSubtarget>();
563   const SIInstrInfo *TII = STM.getInstrInfo();
564 
565   uint64_t CodeSize = 0;
566 
567   for (const MachineBasicBlock &MBB : MF) {
568     for (const MachineInstr &MI : MBB) {
569       // TODO: CodeSize should account for multiple functions.
570 
571       // TODO: Should we count size of debug info?
572       if (MI.isDebugInstr())
573         continue;
574 
575       CodeSize += TII->getInstSizeInBytes(MI);
576     }
577   }
578 
579   return CodeSize;
580 }
581 
582 static bool hasAnyNonFlatUseOfReg(const MachineRegisterInfo &MRI,
583                                   const SIInstrInfo &TII,
584                                   unsigned Reg) {
585   for (const MachineOperand &UseOp : MRI.reg_operands(Reg)) {
586     if (!UseOp.isImplicit() || !TII.isFLAT(*UseOp.getParent()))
587       return true;
588   }
589 
590   return false;
591 }
592 
593 int32_t AMDGPUAsmPrinter::SIFunctionResourceInfo::getTotalNumSGPRs(
594   const GCNSubtarget &ST) const {
595   return NumExplicitSGPR + IsaInfo::getNumExtraSGPRs(&ST,
596                                                      UsesVCC, UsesFlatScratch);
597 }
598 
599 int32_t AMDGPUAsmPrinter::SIFunctionResourceInfo::getTotalNumVGPRs(
600   const GCNSubtarget &ST) const {
601   return std::max(NumVGPR, NumAGPR);
602 }
603 
604 static const Function *getCalleeFunction(const MachineOperand &Op) {
605   if (Op.isImm()) {
606     assert(Op.getImm() == 0);
607     return nullptr;
608   }
609 
610   return cast<Function>(Op.getGlobal());
611 }
612 
613 AMDGPUAsmPrinter::SIFunctionResourceInfo AMDGPUAsmPrinter::analyzeResourceUsage(
614   const MachineFunction &MF) const {
615   SIFunctionResourceInfo Info;
616 
617   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
618   const GCNSubtarget &ST = MF.getSubtarget<GCNSubtarget>();
619   const MachineFrameInfo &FrameInfo = MF.getFrameInfo();
620   const MachineRegisterInfo &MRI = MF.getRegInfo();
621   const SIInstrInfo *TII = ST.getInstrInfo();
622   const SIRegisterInfo &TRI = TII->getRegisterInfo();
623 
624   Info.UsesFlatScratch = MRI.isPhysRegUsed(AMDGPU::FLAT_SCR_LO) ||
625                          MRI.isPhysRegUsed(AMDGPU::FLAT_SCR_HI);
626 
627   // Even if FLAT_SCRATCH is implicitly used, it has no effect if flat
628   // instructions aren't used to access the scratch buffer. Inline assembly may
629   // need it though.
630   //
631   // If we only have implicit uses of flat_scr on flat instructions, it is not
632   // really needed.
633   if (Info.UsesFlatScratch && !MFI->hasFlatScratchInit() &&
634       (!hasAnyNonFlatUseOfReg(MRI, *TII, AMDGPU::FLAT_SCR) &&
635        !hasAnyNonFlatUseOfReg(MRI, *TII, AMDGPU::FLAT_SCR_LO) &&
636        !hasAnyNonFlatUseOfReg(MRI, *TII, AMDGPU::FLAT_SCR_HI))) {
637     Info.UsesFlatScratch = false;
638   }
639 
640   Info.HasDynamicallySizedStack = FrameInfo.hasVarSizedObjects();
641   Info.PrivateSegmentSize = FrameInfo.getStackSize();
642   if (MFI->isStackRealigned())
643     Info.PrivateSegmentSize += FrameInfo.getMaxAlign().value();
644 
645   Info.UsesVCC = MRI.isPhysRegUsed(AMDGPU::VCC_LO) ||
646                  MRI.isPhysRegUsed(AMDGPU::VCC_HI);
647 
648   // If there are no calls, MachineRegisterInfo can tell us the used register
649   // count easily.
650   // A tail call isn't considered a call for MachineFrameInfo's purposes.
651   if (!FrameInfo.hasCalls() && !FrameInfo.hasTailCall()) {
652     MCPhysReg HighestVGPRReg = AMDGPU::NoRegister;
653     for (MCPhysReg Reg : reverse(AMDGPU::VGPR_32RegClass.getRegisters())) {
654       if (MRI.isPhysRegUsed(Reg)) {
655         HighestVGPRReg = Reg;
656         break;
657       }
658     }
659 
660     if (ST.hasMAIInsts()) {
661       MCPhysReg HighestAGPRReg = AMDGPU::NoRegister;
662       for (MCPhysReg Reg : reverse(AMDGPU::AGPR_32RegClass.getRegisters())) {
663         if (MRI.isPhysRegUsed(Reg)) {
664           HighestAGPRReg = Reg;
665           break;
666         }
667       }
668       Info.NumAGPR = HighestAGPRReg == AMDGPU::NoRegister ? 0 :
669         TRI.getHWRegIndex(HighestAGPRReg) + 1;
670     }
671 
672     MCPhysReg HighestSGPRReg = AMDGPU::NoRegister;
673     for (MCPhysReg Reg : reverse(AMDGPU::SGPR_32RegClass.getRegisters())) {
674       if (MRI.isPhysRegUsed(Reg)) {
675         HighestSGPRReg = Reg;
676         break;
677       }
678     }
679 
680     // We found the maximum register index. They start at 0, so add one to get the
681     // number of registers.
682     Info.NumVGPR = HighestVGPRReg == AMDGPU::NoRegister ? 0 :
683       TRI.getHWRegIndex(HighestVGPRReg) + 1;
684     Info.NumExplicitSGPR = HighestSGPRReg == AMDGPU::NoRegister ? 0 :
685       TRI.getHWRegIndex(HighestSGPRReg) + 1;
686 
687     return Info;
688   }
689 
690   int32_t MaxVGPR = -1;
691   int32_t MaxAGPR = -1;
692   int32_t MaxSGPR = -1;
693   uint64_t CalleeFrameSize = 0;
694 
695   for (const MachineBasicBlock &MBB : MF) {
696     for (const MachineInstr &MI : MBB) {
697       // TODO: Check regmasks? Do they occur anywhere except calls?
698       for (const MachineOperand &MO : MI.operands()) {
699         unsigned Width = 0;
700         bool IsSGPR = false;
701         bool IsAGPR = false;
702 
703         if (!MO.isReg())
704           continue;
705 
706         Register Reg = MO.getReg();
707         switch (Reg) {
708         case AMDGPU::EXEC:
709         case AMDGPU::EXEC_LO:
710         case AMDGPU::EXEC_HI:
711         case AMDGPU::SCC:
712         case AMDGPU::M0:
713         case AMDGPU::SRC_SHARED_BASE:
714         case AMDGPU::SRC_SHARED_LIMIT:
715         case AMDGPU::SRC_PRIVATE_BASE:
716         case AMDGPU::SRC_PRIVATE_LIMIT:
717         case AMDGPU::SGPR_NULL:
718           continue;
719 
720         case AMDGPU::SRC_POPS_EXITING_WAVE_ID:
721           llvm_unreachable("src_pops_exiting_wave_id should not be used");
722 
723         case AMDGPU::NoRegister:
724           assert(MI.isDebugInstr());
725           continue;
726 
727         case AMDGPU::VCC:
728         case AMDGPU::VCC_LO:
729         case AMDGPU::VCC_HI:
730           Info.UsesVCC = true;
731           continue;
732 
733         case AMDGPU::FLAT_SCR:
734         case AMDGPU::FLAT_SCR_LO:
735         case AMDGPU::FLAT_SCR_HI:
736           continue;
737 
738         case AMDGPU::XNACK_MASK:
739         case AMDGPU::XNACK_MASK_LO:
740         case AMDGPU::XNACK_MASK_HI:
741           llvm_unreachable("xnack_mask registers should not be used");
742 
743         case AMDGPU::LDS_DIRECT:
744           llvm_unreachable("lds_direct register should not be used");
745 
746         case AMDGPU::TBA:
747         case AMDGPU::TBA_LO:
748         case AMDGPU::TBA_HI:
749         case AMDGPU::TMA:
750         case AMDGPU::TMA_LO:
751         case AMDGPU::TMA_HI:
752           llvm_unreachable("trap handler registers should not be used");
753 
754         case AMDGPU::SRC_VCCZ:
755           llvm_unreachable("src_vccz register should not be used");
756 
757         case AMDGPU::SRC_EXECZ:
758           llvm_unreachable("src_execz register should not be used");
759 
760         case AMDGPU::SRC_SCC:
761           llvm_unreachable("src_scc register should not be used");
762 
763         default:
764           break;
765         }
766 
767         if (AMDGPU::SReg_32RegClass.contains(Reg) ||
768             AMDGPU::SGPR_LO16RegClass.contains(Reg) ||
769             AMDGPU::SGPR_HI16RegClass.contains(Reg)) {
770           assert(!AMDGPU::TTMP_32RegClass.contains(Reg) &&
771                  "trap handler registers should not be used");
772           IsSGPR = true;
773           Width = 1;
774         } else if (AMDGPU::VGPR_32RegClass.contains(Reg) ||
775                    AMDGPU::VGPR_LO16RegClass.contains(Reg) ||
776                    AMDGPU::VGPR_HI16RegClass.contains(Reg)) {
777           IsSGPR = false;
778           Width = 1;
779         } else if (AMDGPU::AGPR_32RegClass.contains(Reg)) {
780           IsSGPR = false;
781           IsAGPR = true;
782           Width = 1;
783         } else if (AMDGPU::SReg_64RegClass.contains(Reg)) {
784           assert(!AMDGPU::TTMP_64RegClass.contains(Reg) &&
785                  "trap handler registers should not be used");
786           IsSGPR = true;
787           Width = 2;
788         } else if (AMDGPU::VReg_64RegClass.contains(Reg)) {
789           IsSGPR = false;
790           Width = 2;
791         } else if (AMDGPU::AReg_64RegClass.contains(Reg)) {
792           IsSGPR = false;
793           IsAGPR = true;
794           Width = 2;
795         } else if (AMDGPU::VReg_96RegClass.contains(Reg)) {
796           IsSGPR = false;
797           Width = 3;
798         } else if (AMDGPU::SReg_96RegClass.contains(Reg)) {
799           IsSGPR = true;
800           Width = 3;
801         } else if (AMDGPU::AReg_96RegClass.contains(Reg)) {
802           IsSGPR = false;
803           IsAGPR = true;
804           Width = 3;
805         } else if (AMDGPU::SReg_128RegClass.contains(Reg)) {
806           assert(!AMDGPU::TTMP_128RegClass.contains(Reg) &&
807             "trap handler registers should not be used");
808           IsSGPR = true;
809           Width = 4;
810         } else if (AMDGPU::VReg_128RegClass.contains(Reg)) {
811           IsSGPR = false;
812           Width = 4;
813         } else if (AMDGPU::AReg_128RegClass.contains(Reg)) {
814           IsSGPR = false;
815           IsAGPR = true;
816           Width = 4;
817         } else if (AMDGPU::VReg_160RegClass.contains(Reg)) {
818           IsSGPR = false;
819           Width = 5;
820         } else if (AMDGPU::SReg_160RegClass.contains(Reg)) {
821           IsSGPR = true;
822           Width = 5;
823         } else if (AMDGPU::AReg_160RegClass.contains(Reg)) {
824           IsSGPR = false;
825           IsAGPR = true;
826           Width = 5;
827         } else if (AMDGPU::VReg_192RegClass.contains(Reg)) {
828           IsSGPR = false;
829           Width = 6;
830         } else if (AMDGPU::SReg_192RegClass.contains(Reg)) {
831           IsSGPR = true;
832           Width = 6;
833         } else if (AMDGPU::AReg_192RegClass.contains(Reg)) {
834           IsSGPR = false;
835           IsAGPR = true;
836           Width = 6;
837         } else if (AMDGPU::SReg_256RegClass.contains(Reg)) {
838           assert(!AMDGPU::TTMP_256RegClass.contains(Reg) &&
839             "trap handler registers should not be used");
840           IsSGPR = true;
841           Width = 8;
842         } else if (AMDGPU::VReg_256RegClass.contains(Reg)) {
843           IsSGPR = false;
844           Width = 8;
845         } else if (AMDGPU::AReg_256RegClass.contains(Reg)) {
846           IsSGPR = false;
847           IsAGPR = true;
848           Width = 8;
849         } else if (AMDGPU::SReg_512RegClass.contains(Reg)) {
850           assert(!AMDGPU::TTMP_512RegClass.contains(Reg) &&
851             "trap handler registers should not be used");
852           IsSGPR = true;
853           Width = 16;
854         } else if (AMDGPU::VReg_512RegClass.contains(Reg)) {
855           IsSGPR = false;
856           Width = 16;
857         } else if (AMDGPU::AReg_512RegClass.contains(Reg)) {
858           IsSGPR = false;
859           IsAGPR = true;
860           Width = 16;
861         } else if (AMDGPU::SReg_1024RegClass.contains(Reg)) {
862           IsSGPR = true;
863           Width = 32;
864         } else if (AMDGPU::VReg_1024RegClass.contains(Reg)) {
865           IsSGPR = false;
866           Width = 32;
867         } else if (AMDGPU::AReg_1024RegClass.contains(Reg)) {
868           IsSGPR = false;
869           IsAGPR = true;
870           Width = 32;
871         } else {
872           llvm_unreachable("Unknown register class");
873         }
874         unsigned HWReg = TRI.getHWRegIndex(Reg);
875         int MaxUsed = HWReg + Width - 1;
876         if (IsSGPR) {
877           MaxSGPR = MaxUsed > MaxSGPR ? MaxUsed : MaxSGPR;
878         } else if (IsAGPR) {
879           MaxAGPR = MaxUsed > MaxAGPR ? MaxUsed : MaxAGPR;
880         } else {
881           MaxVGPR = MaxUsed > MaxVGPR ? MaxUsed : MaxVGPR;
882         }
883       }
884 
885       if (MI.isCall()) {
886         // Pseudo used just to encode the underlying global. Is there a better
887         // way to track this?
888 
889         const MachineOperand *CalleeOp
890           = TII->getNamedOperand(MI, AMDGPU::OpName::callee);
891 
892         const Function *Callee = getCalleeFunction(*CalleeOp);
893         if (!Callee || Callee->isDeclaration()) {
894           // If this is a call to an external function, we can't do much. Make
895           // conservative guesses.
896 
897           // 48 SGPRs - vcc, - flat_scr, -xnack
898           int MaxSGPRGuess =
899             47 - IsaInfo::getNumExtraSGPRs(&ST, true, ST.hasFlatAddressSpace());
900           MaxSGPR = std::max(MaxSGPR, MaxSGPRGuess);
901           MaxVGPR = std::max(MaxVGPR, 23);
902           MaxAGPR = std::max(MaxAGPR, 23);
903 
904           CalleeFrameSize = std::max(CalleeFrameSize, UINT64_C(16384));
905           Info.UsesVCC = true;
906           Info.UsesFlatScratch = ST.hasFlatAddressSpace();
907           Info.HasDynamicallySizedStack = true;
908         } else {
909           // We force CodeGen to run in SCC order, so the callee's register
910           // usage etc. should be the cumulative usage of all callees.
911 
912           auto I = CallGraphResourceInfo.find(Callee);
913           if (I == CallGraphResourceInfo.end()) {
914             // Avoid crashing on undefined behavior with an illegal call to a
915             // kernel. If a callsite's calling convention doesn't match the
916             // function's, it's undefined behavior. If the callsite calling
917             // convention does match, that would have errored earlier.
918             // FIXME: The verifier shouldn't allow this.
919             if (AMDGPU::isEntryFunctionCC(Callee->getCallingConv()))
920               report_fatal_error("invalid call to entry function");
921 
922             llvm_unreachable("callee should have been handled before caller");
923           }
924 
925           MaxSGPR = std::max(I->second.NumExplicitSGPR - 1, MaxSGPR);
926           MaxVGPR = std::max(I->second.NumVGPR - 1, MaxVGPR);
927           MaxAGPR = std::max(I->second.NumAGPR - 1, MaxAGPR);
928           CalleeFrameSize
929             = std::max(I->second.PrivateSegmentSize, CalleeFrameSize);
930           Info.UsesVCC |= I->second.UsesVCC;
931           Info.UsesFlatScratch |= I->second.UsesFlatScratch;
932           Info.HasDynamicallySizedStack |= I->second.HasDynamicallySizedStack;
933           Info.HasRecursion |= I->second.HasRecursion;
934         }
935 
936         // FIXME: Call site could have norecurse on it
937         if (!Callee || !Callee->doesNotRecurse())
938           Info.HasRecursion = true;
939       }
940     }
941   }
942 
943   Info.NumExplicitSGPR = MaxSGPR + 1;
944   Info.NumVGPR = MaxVGPR + 1;
945   Info.NumAGPR = MaxAGPR + 1;
946   Info.PrivateSegmentSize += CalleeFrameSize;
947 
948   return Info;
949 }
950 
951 void AMDGPUAsmPrinter::getSIProgramInfo(SIProgramInfo &ProgInfo,
952                                         const MachineFunction &MF) {
953   SIFunctionResourceInfo Info = analyzeResourceUsage(MF);
954   const GCNSubtarget &STM = MF.getSubtarget<GCNSubtarget>();
955 
956   ProgInfo.NumArchVGPR = Info.NumVGPR;
957   ProgInfo.NumAccVGPR = Info.NumAGPR;
958   ProgInfo.NumVGPR = Info.getTotalNumVGPRs(STM);
959   ProgInfo.NumSGPR = Info.NumExplicitSGPR;
960   ProgInfo.ScratchSize = Info.PrivateSegmentSize;
961   ProgInfo.VCCUsed = Info.UsesVCC;
962   ProgInfo.FlatUsed = Info.UsesFlatScratch;
963   ProgInfo.DynamicCallStack = Info.HasDynamicallySizedStack || Info.HasRecursion;
964 
965   if (!isUInt<32>(ProgInfo.ScratchSize)) {
966     DiagnosticInfoStackSize DiagStackSize(MF.getFunction(),
967                                           ProgInfo.ScratchSize, DS_Error);
968     MF.getFunction().getContext().diagnose(DiagStackSize);
969   }
970 
971   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
972 
973   // TODO(scott.linder): The calculations related to SGPR/VGPR blocks are
974   // duplicated in part in AMDGPUAsmParser::calculateGPRBlocks, and could be
975   // unified.
976   unsigned ExtraSGPRs = IsaInfo::getNumExtraSGPRs(
977       &STM, ProgInfo.VCCUsed, ProgInfo.FlatUsed);
978 
979   // Check the addressable register limit before we add ExtraSGPRs.
980   if (STM.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS &&
981       !STM.hasSGPRInitBug()) {
982     unsigned MaxAddressableNumSGPRs = STM.getAddressableNumSGPRs();
983     if (ProgInfo.NumSGPR > MaxAddressableNumSGPRs) {
984       // This can happen due to a compiler bug or when using inline asm.
985       LLVMContext &Ctx = MF.getFunction().getContext();
986       DiagnosticInfoResourceLimit Diag(MF.getFunction(),
987                                        "addressable scalar registers",
988                                        ProgInfo.NumSGPR, DS_Error,
989                                        DK_ResourceLimit,
990                                        MaxAddressableNumSGPRs);
991       Ctx.diagnose(Diag);
992       ProgInfo.NumSGPR = MaxAddressableNumSGPRs - 1;
993     }
994   }
995 
996   // Account for extra SGPRs and VGPRs reserved for debugger use.
997   ProgInfo.NumSGPR += ExtraSGPRs;
998 
999   // Ensure there are enough SGPRs and VGPRs for wave dispatch, where wave
1000   // dispatch registers are function args.
1001   unsigned WaveDispatchNumSGPR = 0, WaveDispatchNumVGPR = 0;
1002   for (auto &Arg : MF.getFunction().args()) {
1003     unsigned NumRegs = (Arg.getType()->getPrimitiveSizeInBits() + 31) / 32;
1004     if (Arg.hasAttribute(Attribute::InReg))
1005       WaveDispatchNumSGPR += NumRegs;
1006     else
1007       WaveDispatchNumVGPR += NumRegs;
1008   }
1009   ProgInfo.NumSGPR = std::max(ProgInfo.NumSGPR, WaveDispatchNumSGPR);
1010   ProgInfo.NumVGPR = std::max(ProgInfo.NumVGPR, WaveDispatchNumVGPR);
1011 
1012   // Adjust number of registers used to meet default/requested minimum/maximum
1013   // number of waves per execution unit request.
1014   ProgInfo.NumSGPRsForWavesPerEU = std::max(
1015     std::max(ProgInfo.NumSGPR, 1u), STM.getMinNumSGPRs(MFI->getMaxWavesPerEU()));
1016   ProgInfo.NumVGPRsForWavesPerEU = std::max(
1017     std::max(ProgInfo.NumVGPR, 1u), STM.getMinNumVGPRs(MFI->getMaxWavesPerEU()));
1018 
1019   if (STM.getGeneration() <= AMDGPUSubtarget::SEA_ISLANDS ||
1020       STM.hasSGPRInitBug()) {
1021     unsigned MaxAddressableNumSGPRs = STM.getAddressableNumSGPRs();
1022     if (ProgInfo.NumSGPR > MaxAddressableNumSGPRs) {
1023       // This can happen due to a compiler bug or when using inline asm to use
1024       // the registers which are usually reserved for vcc etc.
1025       LLVMContext &Ctx = MF.getFunction().getContext();
1026       DiagnosticInfoResourceLimit Diag(MF.getFunction(),
1027                                        "scalar registers",
1028                                        ProgInfo.NumSGPR, DS_Error,
1029                                        DK_ResourceLimit,
1030                                        MaxAddressableNumSGPRs);
1031       Ctx.diagnose(Diag);
1032       ProgInfo.NumSGPR = MaxAddressableNumSGPRs;
1033       ProgInfo.NumSGPRsForWavesPerEU = MaxAddressableNumSGPRs;
1034     }
1035   }
1036 
1037   if (STM.hasSGPRInitBug()) {
1038     ProgInfo.NumSGPR =
1039         AMDGPU::IsaInfo::FIXED_NUM_SGPRS_FOR_INIT_BUG;
1040     ProgInfo.NumSGPRsForWavesPerEU =
1041         AMDGPU::IsaInfo::FIXED_NUM_SGPRS_FOR_INIT_BUG;
1042   }
1043 
1044   if (MFI->getNumUserSGPRs() > STM.getMaxNumUserSGPRs()) {
1045     LLVMContext &Ctx = MF.getFunction().getContext();
1046     DiagnosticInfoResourceLimit Diag(MF.getFunction(), "user SGPRs",
1047                                      MFI->getNumUserSGPRs(), DS_Error);
1048     Ctx.diagnose(Diag);
1049   }
1050 
1051   if (MFI->getLDSSize() > static_cast<unsigned>(STM.getLocalMemorySize())) {
1052     LLVMContext &Ctx = MF.getFunction().getContext();
1053     DiagnosticInfoResourceLimit Diag(MF.getFunction(), "local memory",
1054                                      MFI->getLDSSize(), DS_Error);
1055     Ctx.diagnose(Diag);
1056   }
1057 
1058   ProgInfo.SGPRBlocks = IsaInfo::getNumSGPRBlocks(
1059       &STM, ProgInfo.NumSGPRsForWavesPerEU);
1060   ProgInfo.VGPRBlocks = IsaInfo::getNumVGPRBlocks(
1061       &STM, ProgInfo.NumVGPRsForWavesPerEU);
1062 
1063   const SIModeRegisterDefaults Mode = MFI->getMode();
1064 
1065   // Set the value to initialize FP_ROUND and FP_DENORM parts of the mode
1066   // register.
1067   ProgInfo.FloatMode = getFPMode(Mode);
1068 
1069   ProgInfo.IEEEMode = Mode.IEEE;
1070 
1071   // Make clamp modifier on NaN input returns 0.
1072   ProgInfo.DX10Clamp = Mode.DX10Clamp;
1073 
1074   unsigned LDSAlignShift;
1075   if (STM.getGeneration() < AMDGPUSubtarget::SEA_ISLANDS) {
1076     // LDS is allocated in 64 dword blocks.
1077     LDSAlignShift = 8;
1078   } else {
1079     // LDS is allocated in 128 dword blocks.
1080     LDSAlignShift = 9;
1081   }
1082 
1083   unsigned LDSSpillSize =
1084     MFI->getLDSWaveSpillSize() * MFI->getMaxFlatWorkGroupSize();
1085 
1086   ProgInfo.LDSSize = MFI->getLDSSize() + LDSSpillSize;
1087   ProgInfo.LDSBlocks =
1088       alignTo(ProgInfo.LDSSize, 1ULL << LDSAlignShift) >> LDSAlignShift;
1089 
1090   // Scratch is allocated in 256 dword blocks.
1091   unsigned ScratchAlignShift = 10;
1092   // We need to program the hardware with the amount of scratch memory that
1093   // is used by the entire wave.  ProgInfo.ScratchSize is the amount of
1094   // scratch memory used per thread.
1095   ProgInfo.ScratchBlocks =
1096       alignTo(ProgInfo.ScratchSize * STM.getWavefrontSize(),
1097               1ULL << ScratchAlignShift) >>
1098       ScratchAlignShift;
1099 
1100   if (getIsaVersion(getGlobalSTI()->getCPU()).Major >= 10) {
1101     ProgInfo.WgpMode = STM.isCuModeEnabled() ? 0 : 1;
1102     ProgInfo.MemOrdered = 1;
1103   }
1104 
1105   ProgInfo.ComputePGMRSrc1 =
1106       S_00B848_VGPRS(ProgInfo.VGPRBlocks) |
1107       S_00B848_SGPRS(ProgInfo.SGPRBlocks) |
1108       S_00B848_PRIORITY(ProgInfo.Priority) |
1109       S_00B848_FLOAT_MODE(ProgInfo.FloatMode) |
1110       S_00B848_PRIV(ProgInfo.Priv) |
1111       S_00B848_DX10_CLAMP(ProgInfo.DX10Clamp) |
1112       S_00B848_DEBUG_MODE(ProgInfo.DebugMode) |
1113       S_00B848_IEEE_MODE(ProgInfo.IEEEMode) |
1114       S_00B848_WGP_MODE(ProgInfo.WgpMode) |
1115       S_00B848_MEM_ORDERED(ProgInfo.MemOrdered);
1116 
1117   // 0 = X, 1 = XY, 2 = XYZ
1118   unsigned TIDIGCompCnt = 0;
1119   if (MFI->hasWorkItemIDZ())
1120     TIDIGCompCnt = 2;
1121   else if (MFI->hasWorkItemIDY())
1122     TIDIGCompCnt = 1;
1123 
1124   ProgInfo.ComputePGMRSrc2 =
1125       S_00B84C_SCRATCH_EN(ProgInfo.ScratchBlocks > 0) |
1126       S_00B84C_USER_SGPR(MFI->getNumUserSGPRs()) |
1127       // For AMDHSA, TRAP_HANDLER must be zero, as it is populated by the CP.
1128       S_00B84C_TRAP_HANDLER(STM.isAmdHsaOS() ? 0 : STM.isTrapHandlerEnabled()) |
1129       S_00B84C_TGID_X_EN(MFI->hasWorkGroupIDX()) |
1130       S_00B84C_TGID_Y_EN(MFI->hasWorkGroupIDY()) |
1131       S_00B84C_TGID_Z_EN(MFI->hasWorkGroupIDZ()) |
1132       S_00B84C_TG_SIZE_EN(MFI->hasWorkGroupInfo()) |
1133       S_00B84C_TIDIG_COMP_CNT(TIDIGCompCnt) |
1134       S_00B84C_EXCP_EN_MSB(0) |
1135       // For AMDHSA, LDS_SIZE must be zero, as it is populated by the CP.
1136       S_00B84C_LDS_SIZE(STM.isAmdHsaOS() ? 0 : ProgInfo.LDSBlocks) |
1137       S_00B84C_EXCP_EN(0);
1138 
1139   ProgInfo.Occupancy = STM.computeOccupancy(MF, ProgInfo.LDSSize,
1140                                             ProgInfo.NumSGPRsForWavesPerEU,
1141                                             ProgInfo.NumVGPRsForWavesPerEU);
1142 }
1143 
1144 static unsigned getRsrcReg(CallingConv::ID CallConv) {
1145   switch (CallConv) {
1146   default: LLVM_FALLTHROUGH;
1147   case CallingConv::AMDGPU_CS: return R_00B848_COMPUTE_PGM_RSRC1;
1148   case CallingConv::AMDGPU_LS: return R_00B528_SPI_SHADER_PGM_RSRC1_LS;
1149   case CallingConv::AMDGPU_HS: return R_00B428_SPI_SHADER_PGM_RSRC1_HS;
1150   case CallingConv::AMDGPU_ES: return R_00B328_SPI_SHADER_PGM_RSRC1_ES;
1151   case CallingConv::AMDGPU_GS: return R_00B228_SPI_SHADER_PGM_RSRC1_GS;
1152   case CallingConv::AMDGPU_VS: return R_00B128_SPI_SHADER_PGM_RSRC1_VS;
1153   case CallingConv::AMDGPU_PS: return R_00B028_SPI_SHADER_PGM_RSRC1_PS;
1154   }
1155 }
1156 
1157 void AMDGPUAsmPrinter::EmitProgramInfoSI(const MachineFunction &MF,
1158                                          const SIProgramInfo &CurrentProgramInfo) {
1159   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
1160   unsigned RsrcReg = getRsrcReg(MF.getFunction().getCallingConv());
1161 
1162   if (AMDGPU::isCompute(MF.getFunction().getCallingConv())) {
1163     OutStreamer->emitInt32(R_00B848_COMPUTE_PGM_RSRC1);
1164 
1165     OutStreamer->emitInt32(CurrentProgramInfo.ComputePGMRSrc1);
1166 
1167     OutStreamer->emitInt32(R_00B84C_COMPUTE_PGM_RSRC2);
1168     OutStreamer->emitInt32(CurrentProgramInfo.ComputePGMRSrc2);
1169 
1170     OutStreamer->emitInt32(R_00B860_COMPUTE_TMPRING_SIZE);
1171     OutStreamer->emitInt32(S_00B860_WAVESIZE(CurrentProgramInfo.ScratchBlocks));
1172 
1173     // TODO: Should probably note flat usage somewhere. SC emits a "FlatPtr32 =
1174     // 0" comment but I don't see a corresponding field in the register spec.
1175   } else {
1176     OutStreamer->emitInt32(RsrcReg);
1177     OutStreamer->emitIntValue(S_00B028_VGPRS(CurrentProgramInfo.VGPRBlocks) |
1178                               S_00B028_SGPRS(CurrentProgramInfo.SGPRBlocks), 4);
1179     OutStreamer->emitInt32(R_0286E8_SPI_TMPRING_SIZE);
1180     OutStreamer->emitIntValue(
1181         S_0286E8_WAVESIZE(CurrentProgramInfo.ScratchBlocks), 4);
1182   }
1183 
1184   if (MF.getFunction().getCallingConv() == CallingConv::AMDGPU_PS) {
1185     OutStreamer->emitInt32(R_00B02C_SPI_SHADER_PGM_RSRC2_PS);
1186     OutStreamer->emitInt32(
1187         S_00B02C_EXTRA_LDS_SIZE(CurrentProgramInfo.LDSBlocks));
1188     OutStreamer->emitInt32(R_0286CC_SPI_PS_INPUT_ENA);
1189     OutStreamer->emitInt32(MFI->getPSInputEnable());
1190     OutStreamer->emitInt32(R_0286D0_SPI_PS_INPUT_ADDR);
1191     OutStreamer->emitInt32(MFI->getPSInputAddr());
1192   }
1193 
1194   OutStreamer->emitInt32(R_SPILLED_SGPRS);
1195   OutStreamer->emitInt32(MFI->getNumSpilledSGPRs());
1196   OutStreamer->emitInt32(R_SPILLED_VGPRS);
1197   OutStreamer->emitInt32(MFI->getNumSpilledVGPRs());
1198 }
1199 
1200 // This is the equivalent of EmitProgramInfoSI above, but for when the OS type
1201 // is AMDPAL.  It stores each compute/SPI register setting and other PAL
1202 // metadata items into the PALMD::Metadata, combining with any provided by the
1203 // frontend as LLVM metadata. Once all functions are written, the PAL metadata
1204 // is then written as a single block in the .note section.
1205 void AMDGPUAsmPrinter::EmitPALMetadata(const MachineFunction &MF,
1206        const SIProgramInfo &CurrentProgramInfo) {
1207   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
1208   auto CC = MF.getFunction().getCallingConv();
1209   auto MD = getTargetStreamer()->getPALMetadata();
1210 
1211   MD->setEntryPoint(CC, MF.getFunction().getName());
1212   MD->setNumUsedVgprs(CC, CurrentProgramInfo.NumVGPRsForWavesPerEU);
1213   MD->setNumUsedSgprs(CC, CurrentProgramInfo.NumSGPRsForWavesPerEU);
1214   if (AMDGPU::isCompute(MF.getFunction().getCallingConv())) {
1215     MD->setRsrc1(CC, CurrentProgramInfo.ComputePGMRSrc1);
1216     MD->setRsrc2(CC, CurrentProgramInfo.ComputePGMRSrc2);
1217   } else {
1218     MD->setRsrc1(CC, S_00B028_VGPRS(CurrentProgramInfo.VGPRBlocks) |
1219         S_00B028_SGPRS(CurrentProgramInfo.SGPRBlocks));
1220     if (CurrentProgramInfo.ScratchBlocks > 0)
1221       MD->setRsrc2(CC, S_00B84C_SCRATCH_EN(1));
1222   }
1223   // ScratchSize is in bytes, 16 aligned.
1224   MD->setScratchSize(CC, alignTo(CurrentProgramInfo.ScratchSize, 16));
1225   if (MF.getFunction().getCallingConv() == CallingConv::AMDGPU_PS) {
1226     MD->setRsrc2(CC, S_00B02C_EXTRA_LDS_SIZE(CurrentProgramInfo.LDSBlocks));
1227     MD->setSpiPsInputEna(MFI->getPSInputEnable());
1228     MD->setSpiPsInputAddr(MFI->getPSInputAddr());
1229   }
1230 
1231   const GCNSubtarget &STM = MF.getSubtarget<GCNSubtarget>();
1232   if (STM.isWave32())
1233     MD->setWave32(MF.getFunction().getCallingConv());
1234 }
1235 
1236 // This is supposed to be log2(Size)
1237 static amd_element_byte_size_t getElementByteSizeValue(unsigned Size) {
1238   switch (Size) {
1239   case 4:
1240     return AMD_ELEMENT_4_BYTES;
1241   case 8:
1242     return AMD_ELEMENT_8_BYTES;
1243   case 16:
1244     return AMD_ELEMENT_16_BYTES;
1245   default:
1246     llvm_unreachable("invalid private_element_size");
1247   }
1248 }
1249 
1250 void AMDGPUAsmPrinter::getAmdKernelCode(amd_kernel_code_t &Out,
1251                                         const SIProgramInfo &CurrentProgramInfo,
1252                                         const MachineFunction &MF) const {
1253   const Function &F = MF.getFunction();
1254   assert(F.getCallingConv() == CallingConv::AMDGPU_KERNEL ||
1255          F.getCallingConv() == CallingConv::SPIR_KERNEL);
1256 
1257   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
1258   const GCNSubtarget &STM = MF.getSubtarget<GCNSubtarget>();
1259 
1260   AMDGPU::initDefaultAMDKernelCodeT(Out, &STM);
1261 
1262   Out.compute_pgm_resource_registers =
1263       CurrentProgramInfo.ComputePGMRSrc1 |
1264       (CurrentProgramInfo.ComputePGMRSrc2 << 32);
1265   Out.code_properties |= AMD_CODE_PROPERTY_IS_PTR64;
1266 
1267   if (CurrentProgramInfo.DynamicCallStack)
1268     Out.code_properties |= AMD_CODE_PROPERTY_IS_DYNAMIC_CALLSTACK;
1269 
1270   AMD_HSA_BITS_SET(Out.code_properties,
1271                    AMD_CODE_PROPERTY_PRIVATE_ELEMENT_SIZE,
1272                    getElementByteSizeValue(STM.getMaxPrivateElementSize()));
1273 
1274   if (MFI->hasPrivateSegmentBuffer()) {
1275     Out.code_properties |=
1276       AMD_CODE_PROPERTY_ENABLE_SGPR_PRIVATE_SEGMENT_BUFFER;
1277   }
1278 
1279   if (MFI->hasDispatchPtr())
1280     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_PTR;
1281 
1282   if (MFI->hasQueuePtr())
1283     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_QUEUE_PTR;
1284 
1285   if (MFI->hasKernargSegmentPtr())
1286     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_KERNARG_SEGMENT_PTR;
1287 
1288   if (MFI->hasDispatchID())
1289     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_ID;
1290 
1291   if (MFI->hasFlatScratchInit())
1292     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_FLAT_SCRATCH_INIT;
1293 
1294   if (MFI->hasDispatchPtr())
1295     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_PTR;
1296 
1297   if (STM.isXNACKEnabled())
1298     Out.code_properties |= AMD_CODE_PROPERTY_IS_XNACK_SUPPORTED;
1299 
1300   Align MaxKernArgAlign;
1301   Out.kernarg_segment_byte_size = STM.getKernArgSegmentSize(F, MaxKernArgAlign);
1302   Out.wavefront_sgpr_count = CurrentProgramInfo.NumSGPR;
1303   Out.workitem_vgpr_count = CurrentProgramInfo.NumVGPR;
1304   Out.workitem_private_segment_byte_size = CurrentProgramInfo.ScratchSize;
1305   Out.workgroup_group_segment_byte_size = CurrentProgramInfo.LDSSize;
1306 
1307   // kernarg_segment_alignment is specified as log of the alignment.
1308   // The minimum alignment is 16.
1309   Out.kernarg_segment_alignment = Log2(std::max(Align(16), MaxKernArgAlign));
1310 }
1311 
1312 bool AMDGPUAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1313                                        const char *ExtraCode, raw_ostream &O) {
1314   // First try the generic code, which knows about modifiers like 'c' and 'n'.
1315   if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, O))
1316     return false;
1317 
1318   if (ExtraCode && ExtraCode[0]) {
1319     if (ExtraCode[1] != 0)
1320       return true; // Unknown modifier.
1321 
1322     switch (ExtraCode[0]) {
1323     case 'r':
1324       break;
1325     default:
1326       return true;
1327     }
1328   }
1329 
1330   // TODO: Should be able to support other operand types like globals.
1331   const MachineOperand &MO = MI->getOperand(OpNo);
1332   if (MO.isReg()) {
1333     AMDGPUInstPrinter::printRegOperand(MO.getReg(), O,
1334                                        *MF->getSubtarget().getRegisterInfo());
1335     return false;
1336   }
1337 
1338   return true;
1339 }
1340