1 //===-- AMDGPUAsmPrinter.cpp - AMDGPU Assebly printer  --------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 /// \file
11 ///
12 /// The AMDGPUAsmPrinter is used to print both assembly string and also binary
13 /// code.  When passed an MCAsmStreamer it prints assembly and when passed
14 /// an MCObjectStreamer it outputs binary code.
15 //
16 //===----------------------------------------------------------------------===//
17 //
18 
19 #include "AMDGPUAsmPrinter.h"
20 #include "AMDGPU.h"
21 #include "AMDGPUSubtarget.h"
22 #include "AMDGPUTargetMachine.h"
23 #include "InstPrinter/AMDGPUInstPrinter.h"
24 #include "MCTargetDesc/AMDGPUTargetStreamer.h"
25 #include "R600Defines.h"
26 #include "R600MachineFunctionInfo.h"
27 #include "R600RegisterInfo.h"
28 #include "SIDefines.h"
29 #include "SIInstrInfo.h"
30 #include "SIMachineFunctionInfo.h"
31 #include "SIRegisterInfo.h"
32 #include "Utils/AMDGPUBaseInfo.h"
33 #include "llvm/BinaryFormat/ELF.h"
34 #include "llvm/CodeGen/MachineFrameInfo.h"
35 #include "llvm/CodeGen/TargetLoweringObjectFile.h"
36 #include "llvm/IR/DiagnosticInfo.h"
37 #include "llvm/MC/MCContext.h"
38 #include "llvm/MC/MCSectionELF.h"
39 #include "llvm/MC/MCStreamer.h"
40 #include "llvm/Support/AMDGPUMetadata.h"
41 #include "llvm/Support/MathExtras.h"
42 #include "llvm/Support/TargetRegistry.h"
43 
44 using namespace llvm;
45 using namespace llvm::AMDGPU;
46 
47 // TODO: This should get the default rounding mode from the kernel. We just set
48 // the default here, but this could change if the OpenCL rounding mode pragmas
49 // are used.
50 //
51 // The denormal mode here should match what is reported by the OpenCL runtime
52 // for the CL_FP_DENORM bit from CL_DEVICE_{HALF|SINGLE|DOUBLE}_FP_CONFIG, but
53 // can also be override to flush with the -cl-denorms-are-zero compiler flag.
54 //
55 // AMD OpenCL only sets flush none and reports CL_FP_DENORM for double
56 // precision, and leaves single precision to flush all and does not report
57 // CL_FP_DENORM for CL_DEVICE_SINGLE_FP_CONFIG. Mesa's OpenCL currently reports
58 // CL_FP_DENORM for both.
59 //
60 // FIXME: It seems some instructions do not support single precision denormals
61 // regardless of the mode (exp_*_f32, rcp_*_f32, rsq_*_f32, rsq_*f32, sqrt_f32,
62 // and sin_f32, cos_f32 on most parts).
63 
64 // We want to use these instructions, and using fp32 denormals also causes
65 // instructions to run at the double precision rate for the device so it's
66 // probably best to just report no single precision denormals.
67 static uint32_t getFPMode(const MachineFunction &F) {
68   const SISubtarget& ST = F.getSubtarget<SISubtarget>();
69   // TODO: Is there any real use for the flush in only / flush out only modes?
70 
71   uint32_t FP32Denormals =
72     ST.hasFP32Denormals() ? FP_DENORM_FLUSH_NONE : FP_DENORM_FLUSH_IN_FLUSH_OUT;
73 
74   uint32_t FP64Denormals =
75     ST.hasFP64Denormals() ? FP_DENORM_FLUSH_NONE : FP_DENORM_FLUSH_IN_FLUSH_OUT;
76 
77   return FP_ROUND_MODE_SP(FP_ROUND_ROUND_TO_NEAREST) |
78          FP_ROUND_MODE_DP(FP_ROUND_ROUND_TO_NEAREST) |
79          FP_DENORM_MODE_SP(FP32Denormals) |
80          FP_DENORM_MODE_DP(FP64Denormals);
81 }
82 
83 static AsmPrinter *
84 createAMDGPUAsmPrinterPass(TargetMachine &tm,
85                            std::unique_ptr<MCStreamer> &&Streamer) {
86   return new AMDGPUAsmPrinter(tm, std::move(Streamer));
87 }
88 
89 extern "C" void LLVMInitializeAMDGPUAsmPrinter() {
90   TargetRegistry::RegisterAsmPrinter(getTheAMDGPUTarget(),
91                                      createAMDGPUAsmPrinterPass);
92   TargetRegistry::RegisterAsmPrinter(getTheGCNTarget(),
93                                      createAMDGPUAsmPrinterPass);
94 }
95 
96 AMDGPUAsmPrinter::AMDGPUAsmPrinter(TargetMachine &TM,
97                                    std::unique_ptr<MCStreamer> Streamer)
98   : AsmPrinter(TM, std::move(Streamer)) {
99     AMDGPUASI = static_cast<AMDGPUTargetMachine*>(&TM)->getAMDGPUAS();
100   }
101 
102 StringRef AMDGPUAsmPrinter::getPassName() const {
103   return "AMDGPU Assembly Printer";
104 }
105 
106 const MCSubtargetInfo* AMDGPUAsmPrinter::getSTI() const {
107   return TM.getMCSubtargetInfo();
108 }
109 
110 AMDGPUTargetStreamer* AMDGPUAsmPrinter::getTargetStreamer() const {
111   if (!OutStreamer)
112     return nullptr;
113   return static_cast<AMDGPUTargetStreamer*>(OutStreamer->getTargetStreamer());
114 }
115 
116 void AMDGPUAsmPrinter::EmitStartOfAsmFile(Module &M) {
117   if (TM.getTargetTriple().getArch() != Triple::amdgcn)
118     return;
119 
120   if (TM.getTargetTriple().getOS() != Triple::AMDHSA &&
121       TM.getTargetTriple().getOS() != Triple::AMDPAL)
122     return;
123 
124   if (TM.getTargetTriple().getOS() == Triple::AMDHSA)
125     HSAMetadataStream.begin(M);
126 
127   if (TM.getTargetTriple().getOS() == Triple::AMDPAL)
128     readPALMetadata(M);
129 
130   // Deprecated notes are not emitted for code object v3.
131   if (IsaInfo::hasCodeObjectV3(getSTI()->getFeatureBits()))
132     return;
133 
134   // HSA emits NT_AMDGPU_HSA_CODE_OBJECT_VERSION for code objects v2.
135   if (TM.getTargetTriple().getOS() == Triple::AMDHSA)
136     getTargetStreamer()->EmitDirectiveHSACodeObjectVersion(2, 1);
137 
138   // HSA and PAL emit NT_AMDGPU_HSA_ISA for code objects v2.
139   IsaInfo::IsaVersion ISA = IsaInfo::getIsaVersion(getSTI()->getFeatureBits());
140   getTargetStreamer()->EmitDirectiveHSACodeObjectISA(
141       ISA.Major, ISA.Minor, ISA.Stepping, "AMD", "AMDGPU");
142 }
143 
144 void AMDGPUAsmPrinter::EmitEndOfAsmFile(Module &M) {
145   if (TM.getTargetTriple().getArch() != Triple::amdgcn)
146     return;
147 
148   // Following code requires TargetStreamer to be present.
149   if (!getTargetStreamer())
150     return;
151 
152   // Emit ISA Version (NT_AMD_AMDGPU_ISA).
153   std::string ISAVersionString;
154   raw_string_ostream ISAVersionStream(ISAVersionString);
155   IsaInfo::streamIsaVersion(getSTI(), ISAVersionStream);
156   getTargetStreamer()->EmitISAVersion(ISAVersionStream.str());
157 
158   // Emit HSA Metadata (NT_AMD_AMDGPU_HSA_METADATA).
159   if (TM.getTargetTriple().getOS() == Triple::AMDHSA) {
160     HSAMetadataStream.end();
161     getTargetStreamer()->EmitHSAMetadata(HSAMetadataStream.getHSAMetadata());
162   }
163 
164   // Emit PAL Metadata (NT_AMD_AMDGPU_PAL_METADATA).
165   if (TM.getTargetTriple().getOS() == Triple::AMDPAL) {
166     // Copy the PAL metadata from the map where we collected it into a vector,
167     // then write it as a .note.
168     PALMD::Metadata PALMetadataVector;
169     for (auto i : PALMetadataMap) {
170       PALMetadataVector.push_back(i.first);
171       PALMetadataVector.push_back(i.second);
172     }
173     getTargetStreamer()->EmitPALMetadata(PALMetadataVector);
174   }
175 }
176 
177 bool AMDGPUAsmPrinter::isBlockOnlyReachableByFallthrough(
178   const MachineBasicBlock *MBB) const {
179   if (!AsmPrinter::isBlockOnlyReachableByFallthrough(MBB))
180     return false;
181 
182   if (MBB->empty())
183     return true;
184 
185   // If this is a block implementing a long branch, an expression relative to
186   // the start of the block is needed.  to the start of the block.
187   // XXX - Is there a smarter way to check this?
188   return (MBB->back().getOpcode() != AMDGPU::S_SETPC_B64);
189 }
190 
191 void AMDGPUAsmPrinter::EmitFunctionBodyStart() {
192   const AMDGPUMachineFunction *MFI = MF->getInfo<AMDGPUMachineFunction>();
193   if (!MFI->isEntryFunction())
194     return;
195 
196   const AMDGPUSubtarget &STM = MF->getSubtarget<AMDGPUSubtarget>();
197   amd_kernel_code_t KernelCode;
198   if (STM.isAmdCodeObjectV2(*MF)) {
199     getAmdKernelCode(KernelCode, CurrentProgramInfo, *MF);
200 
201     OutStreamer->SwitchSection(getObjFileLowering().getTextSection());
202     getTargetStreamer()->EmitAMDKernelCodeT(KernelCode);
203   }
204 
205   if (TM.getTargetTriple().getOS() != Triple::AMDHSA)
206     return;
207 
208   HSAMetadataStream.emitKernel(MF->getFunction(),
209                                getHSACodeProps(*MF, CurrentProgramInfo),
210                                getHSADebugProps(*MF, CurrentProgramInfo));
211 }
212 
213 void AMDGPUAsmPrinter::EmitFunctionEntryLabel() {
214   const SIMachineFunctionInfo *MFI = MF->getInfo<SIMachineFunctionInfo>();
215   const AMDGPUSubtarget &STM = MF->getSubtarget<AMDGPUSubtarget>();
216   if (MFI->isEntryFunction() && STM.isAmdCodeObjectV2(*MF)) {
217     SmallString<128> SymbolName;
218     getNameWithPrefix(SymbolName, &MF->getFunction()),
219     getTargetStreamer()->EmitAMDGPUSymbolType(
220         SymbolName, ELF::STT_AMDGPU_HSA_KERNEL);
221   }
222   const AMDGPUSubtarget &STI = MF->getSubtarget<AMDGPUSubtarget>();
223   if (STI.dumpCode()) {
224     // Disassemble function name label to text.
225     DisasmLines.push_back(MF->getName().str() + ":");
226     DisasmLineMaxLen = std::max(DisasmLineMaxLen, DisasmLines.back().size());
227     HexLines.push_back("");
228   }
229 
230   AsmPrinter::EmitFunctionEntryLabel();
231 }
232 
233 void AMDGPUAsmPrinter::EmitBasicBlockStart(const MachineBasicBlock &MBB) const {
234   const AMDGPUSubtarget &STI = MBB.getParent()->getSubtarget<AMDGPUSubtarget>();
235   if (STI.dumpCode() && !isBlockOnlyReachableByFallthrough(&MBB)) {
236     // Write a line for the basic block label if it is not only fallthrough.
237     DisasmLines.push_back(
238         (Twine("BB") + Twine(getFunctionNumber())
239          + "_" + Twine(MBB.getNumber()) + ":").str());
240     DisasmLineMaxLen = std::max(DisasmLineMaxLen, DisasmLines.back().size());
241     HexLines.push_back("");
242   }
243   AsmPrinter::EmitBasicBlockStart(MBB);
244 }
245 
246 void AMDGPUAsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
247 
248   // Group segment variables aren't emitted in HSA.
249   if (AMDGPU::isGroupSegment(GV))
250     return;
251 
252   AsmPrinter::EmitGlobalVariable(GV);
253 }
254 
255 bool AMDGPUAsmPrinter::doFinalization(Module &M) {
256   CallGraphResourceInfo.clear();
257   return AsmPrinter::doFinalization(M);
258 }
259 
260 // For the amdpal OS type, read the amdgpu.pal.metadata supplied by the
261 // frontend into our PALMetadataMap, ready for per-function modification.  It
262 // is a NamedMD containing an MDTuple containing a number of MDNodes each of
263 // which is an integer value, and each two integer values forms a key=value
264 // pair that we store as PALMetadataMap[key]=value in the map.
265 void AMDGPUAsmPrinter::readPALMetadata(Module &M) {
266   auto NamedMD = M.getNamedMetadata("amdgpu.pal.metadata");
267   if (!NamedMD || !NamedMD->getNumOperands())
268     return;
269   auto Tuple = dyn_cast<MDTuple>(NamedMD->getOperand(0));
270   if (!Tuple)
271     return;
272   for (unsigned I = 0, E = Tuple->getNumOperands() & -2; I != E; I += 2) {
273     auto Key = mdconst::dyn_extract<ConstantInt>(Tuple->getOperand(I));
274     auto Val = mdconst::dyn_extract<ConstantInt>(Tuple->getOperand(I + 1));
275     if (!Key || !Val)
276       continue;
277     PALMetadataMap[Key->getZExtValue()] = Val->getZExtValue();
278   }
279 }
280 
281 // Print comments that apply to both callable functions and entry points.
282 void AMDGPUAsmPrinter::emitCommonFunctionComments(
283   uint32_t NumVGPR,
284   uint32_t NumSGPR,
285   uint64_t ScratchSize,
286   uint64_t CodeSize) {
287   OutStreamer->emitRawComment(" codeLenInByte = " + Twine(CodeSize), false);
288   OutStreamer->emitRawComment(" NumSgprs: " + Twine(NumSGPR), false);
289   OutStreamer->emitRawComment(" NumVgprs: " + Twine(NumVGPR), false);
290   OutStreamer->emitRawComment(" ScratchSize: " + Twine(ScratchSize), false);
291 }
292 
293 bool AMDGPUAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
294   CurrentProgramInfo = SIProgramInfo();
295 
296   const AMDGPUMachineFunction *MFI = MF.getInfo<AMDGPUMachineFunction>();
297 
298   // The starting address of all shader programs must be 256 bytes aligned.
299   // Regular functions just need the basic required instruction alignment.
300   MF.setAlignment(MFI->isEntryFunction() ? 8 : 2);
301 
302   SetupMachineFunction(MF);
303 
304   const AMDGPUSubtarget &STM = MF.getSubtarget<AMDGPUSubtarget>();
305   MCContext &Context = getObjFileLowering().getContext();
306   if (!STM.isAmdHsaOS()) {
307     MCSectionELF *ConfigSection =
308         Context.getELFSection(".AMDGPU.config", ELF::SHT_PROGBITS, 0);
309     OutStreamer->SwitchSection(ConfigSection);
310   }
311 
312   if (STM.getGeneration() >= AMDGPUSubtarget::SOUTHERN_ISLANDS) {
313     if (MFI->isEntryFunction()) {
314       getSIProgramInfo(CurrentProgramInfo, MF);
315     } else {
316       auto I = CallGraphResourceInfo.insert(
317         std::make_pair(&MF.getFunction(), SIFunctionResourceInfo()));
318       SIFunctionResourceInfo &Info = I.first->second;
319       assert(I.second && "should only be called once per function");
320       Info = analyzeResourceUsage(MF);
321     }
322 
323     if (STM.isAmdPalOS())
324       EmitPALMetadata(MF, CurrentProgramInfo);
325     if (!STM.isAmdHsaOS()) {
326       EmitProgramInfoSI(MF, CurrentProgramInfo);
327     }
328   } else {
329     EmitProgramInfoR600(MF);
330   }
331 
332   DisasmLines.clear();
333   HexLines.clear();
334   DisasmLineMaxLen = 0;
335 
336   EmitFunctionBody();
337 
338   if (isVerbose()) {
339     MCSectionELF *CommentSection =
340         Context.getELFSection(".AMDGPU.csdata", ELF::SHT_PROGBITS, 0);
341     OutStreamer->SwitchSection(CommentSection);
342 
343     if (STM.getGeneration() >= AMDGPUSubtarget::SOUTHERN_ISLANDS) {
344       if (!MFI->isEntryFunction()) {
345         OutStreamer->emitRawComment(" Function info:", false);
346         SIFunctionResourceInfo &Info = CallGraphResourceInfo[&MF.getFunction()];
347         emitCommonFunctionComments(
348           Info.NumVGPR,
349           Info.getTotalNumSGPRs(MF.getSubtarget<SISubtarget>()),
350           Info.PrivateSegmentSize,
351           getFunctionCodeSize(MF));
352         return false;
353       }
354 
355       OutStreamer->emitRawComment(" Kernel info:", false);
356       emitCommonFunctionComments(CurrentProgramInfo.NumVGPR,
357                                  CurrentProgramInfo.NumSGPR,
358                                  CurrentProgramInfo.ScratchSize,
359                                  getFunctionCodeSize(MF));
360 
361       OutStreamer->emitRawComment(
362         " FloatMode: " + Twine(CurrentProgramInfo.FloatMode), false);
363       OutStreamer->emitRawComment(
364         " IeeeMode: " + Twine(CurrentProgramInfo.IEEEMode), false);
365       OutStreamer->emitRawComment(
366         " LDSByteSize: " + Twine(CurrentProgramInfo.LDSSize) +
367         " bytes/workgroup (compile time only)", false);
368 
369       OutStreamer->emitRawComment(
370         " SGPRBlocks: " + Twine(CurrentProgramInfo.SGPRBlocks), false);
371       OutStreamer->emitRawComment(
372         " VGPRBlocks: " + Twine(CurrentProgramInfo.VGPRBlocks), false);
373 
374       OutStreamer->emitRawComment(
375         " NumSGPRsForWavesPerEU: " +
376         Twine(CurrentProgramInfo.NumSGPRsForWavesPerEU), false);
377       OutStreamer->emitRawComment(
378         " NumVGPRsForWavesPerEU: " +
379         Twine(CurrentProgramInfo.NumVGPRsForWavesPerEU), false);
380 
381       OutStreamer->emitRawComment(
382         " ReservedVGPRFirst: " + Twine(CurrentProgramInfo.ReservedVGPRFirst),
383         false);
384       OutStreamer->emitRawComment(
385         " ReservedVGPRCount: " + Twine(CurrentProgramInfo.ReservedVGPRCount),
386         false);
387 
388       if (MF.getSubtarget<SISubtarget>().debuggerEmitPrologue()) {
389         OutStreamer->emitRawComment(
390           " DebuggerWavefrontPrivateSegmentOffsetSGPR: s" +
391           Twine(CurrentProgramInfo.DebuggerWavefrontPrivateSegmentOffsetSGPR), false);
392         OutStreamer->emitRawComment(
393           " DebuggerPrivateSegmentBufferSGPR: s" +
394           Twine(CurrentProgramInfo.DebuggerPrivateSegmentBufferSGPR), false);
395       }
396 
397       OutStreamer->emitRawComment(
398         " COMPUTE_PGM_RSRC2:USER_SGPR: " +
399         Twine(G_00B84C_USER_SGPR(CurrentProgramInfo.ComputePGMRSrc2)), false);
400       OutStreamer->emitRawComment(
401         " COMPUTE_PGM_RSRC2:TRAP_HANDLER: " +
402         Twine(G_00B84C_TRAP_HANDLER(CurrentProgramInfo.ComputePGMRSrc2)), false);
403       OutStreamer->emitRawComment(
404         " COMPUTE_PGM_RSRC2:TGID_X_EN: " +
405         Twine(G_00B84C_TGID_X_EN(CurrentProgramInfo.ComputePGMRSrc2)), false);
406       OutStreamer->emitRawComment(
407         " COMPUTE_PGM_RSRC2:TGID_Y_EN: " +
408         Twine(G_00B84C_TGID_Y_EN(CurrentProgramInfo.ComputePGMRSrc2)), false);
409       OutStreamer->emitRawComment(
410         " COMPUTE_PGM_RSRC2:TGID_Z_EN: " +
411         Twine(G_00B84C_TGID_Z_EN(CurrentProgramInfo.ComputePGMRSrc2)), false);
412       OutStreamer->emitRawComment(
413         " COMPUTE_PGM_RSRC2:TIDIG_COMP_CNT: " +
414         Twine(G_00B84C_TIDIG_COMP_CNT(CurrentProgramInfo.ComputePGMRSrc2)),
415         false);
416     } else {
417       R600MachineFunctionInfo *MFI = MF.getInfo<R600MachineFunctionInfo>();
418       OutStreamer->emitRawComment(
419         Twine("SQ_PGM_RESOURCES:STACK_SIZE = " + Twine(MFI->CFStackSize)));
420     }
421   }
422 
423   if (STM.dumpCode()) {
424 
425     OutStreamer->SwitchSection(
426         Context.getELFSection(".AMDGPU.disasm", ELF::SHT_NOTE, 0));
427 
428     for (size_t i = 0; i < DisasmLines.size(); ++i) {
429       std::string Comment = "\n";
430       if (!HexLines[i].empty()) {
431         Comment = std::string(DisasmLineMaxLen - DisasmLines[i].size(), ' ');
432         Comment += " ; " + HexLines[i] + "\n";
433       }
434 
435       OutStreamer->EmitBytes(StringRef(DisasmLines[i]));
436       OutStreamer->EmitBytes(StringRef(Comment));
437     }
438   }
439 
440   return false;
441 }
442 
443 void AMDGPUAsmPrinter::EmitProgramInfoR600(const MachineFunction &MF) {
444   unsigned MaxGPR = 0;
445   bool killPixel = false;
446   const R600Subtarget &STM = MF.getSubtarget<R600Subtarget>();
447   const R600RegisterInfo *RI = STM.getRegisterInfo();
448   const R600MachineFunctionInfo *MFI = MF.getInfo<R600MachineFunctionInfo>();
449 
450   for (const MachineBasicBlock &MBB : MF) {
451     for (const MachineInstr &MI : MBB) {
452       if (MI.getOpcode() == AMDGPU::KILLGT)
453         killPixel = true;
454       unsigned numOperands = MI.getNumOperands();
455       for (unsigned op_idx = 0; op_idx < numOperands; op_idx++) {
456         const MachineOperand &MO = MI.getOperand(op_idx);
457         if (!MO.isReg())
458           continue;
459         unsigned HWReg = RI->getHWRegIndex(MO.getReg());
460 
461         // Register with value > 127 aren't GPR
462         if (HWReg > 127)
463           continue;
464         MaxGPR = std::max(MaxGPR, HWReg);
465       }
466     }
467   }
468 
469   unsigned RsrcReg;
470   if (STM.getGeneration() >= R600Subtarget::EVERGREEN) {
471     // Evergreen / Northern Islands
472     switch (MF.getFunction().getCallingConv()) {
473     default: LLVM_FALLTHROUGH;
474     case CallingConv::AMDGPU_CS: RsrcReg = R_0288D4_SQ_PGM_RESOURCES_LS; break;
475     case CallingConv::AMDGPU_GS: RsrcReg = R_028878_SQ_PGM_RESOURCES_GS; break;
476     case CallingConv::AMDGPU_PS: RsrcReg = R_028844_SQ_PGM_RESOURCES_PS; break;
477     case CallingConv::AMDGPU_VS: RsrcReg = R_028860_SQ_PGM_RESOURCES_VS; break;
478     }
479   } else {
480     // R600 / R700
481     switch (MF.getFunction().getCallingConv()) {
482     default: LLVM_FALLTHROUGH;
483     case CallingConv::AMDGPU_GS: LLVM_FALLTHROUGH;
484     case CallingConv::AMDGPU_CS: LLVM_FALLTHROUGH;
485     case CallingConv::AMDGPU_VS: RsrcReg = R_028868_SQ_PGM_RESOURCES_VS; break;
486     case CallingConv::AMDGPU_PS: RsrcReg = R_028850_SQ_PGM_RESOURCES_PS; break;
487     }
488   }
489 
490   OutStreamer->EmitIntValue(RsrcReg, 4);
491   OutStreamer->EmitIntValue(S_NUM_GPRS(MaxGPR + 1) |
492                            S_STACK_SIZE(MFI->CFStackSize), 4);
493   OutStreamer->EmitIntValue(R_02880C_DB_SHADER_CONTROL, 4);
494   OutStreamer->EmitIntValue(S_02880C_KILL_ENABLE(killPixel), 4);
495 
496   if (AMDGPU::isCompute(MF.getFunction().getCallingConv())) {
497     OutStreamer->EmitIntValue(R_0288E8_SQ_LDS_ALLOC, 4);
498     OutStreamer->EmitIntValue(alignTo(MFI->getLDSSize(), 4) >> 2, 4);
499   }
500 }
501 
502 uint64_t AMDGPUAsmPrinter::getFunctionCodeSize(const MachineFunction &MF) const {
503   const SISubtarget &STM = MF.getSubtarget<SISubtarget>();
504   const SIInstrInfo *TII = STM.getInstrInfo();
505 
506   uint64_t CodeSize = 0;
507 
508   for (const MachineBasicBlock &MBB : MF) {
509     for (const MachineInstr &MI : MBB) {
510       // TODO: CodeSize should account for multiple functions.
511 
512       // TODO: Should we count size of debug info?
513       if (MI.isDebugValue())
514         continue;
515 
516       CodeSize += TII->getInstSizeInBytes(MI);
517     }
518   }
519 
520   return CodeSize;
521 }
522 
523 static bool hasAnyNonFlatUseOfReg(const MachineRegisterInfo &MRI,
524                                   const SIInstrInfo &TII,
525                                   unsigned Reg) {
526   for (const MachineOperand &UseOp : MRI.reg_operands(Reg)) {
527     if (!UseOp.isImplicit() || !TII.isFLAT(*UseOp.getParent()))
528       return true;
529   }
530 
531   return false;
532 }
533 
534 static unsigned getNumExtraSGPRs(const SISubtarget &ST,
535                                  bool VCCUsed,
536                                  bool FlatScrUsed) {
537   unsigned ExtraSGPRs = 0;
538   if (VCCUsed)
539     ExtraSGPRs = 2;
540 
541   if (ST.getGeneration() < SISubtarget::VOLCANIC_ISLANDS) {
542     if (FlatScrUsed)
543       ExtraSGPRs = 4;
544   } else {
545     if (ST.isXNACKEnabled())
546       ExtraSGPRs = 4;
547 
548     if (FlatScrUsed)
549       ExtraSGPRs = 6;
550   }
551 
552   return ExtraSGPRs;
553 }
554 
555 int32_t AMDGPUAsmPrinter::SIFunctionResourceInfo::getTotalNumSGPRs(
556   const SISubtarget &ST) const {
557   return NumExplicitSGPR + getNumExtraSGPRs(ST, UsesVCC, UsesFlatScratch);
558 }
559 
560 AMDGPUAsmPrinter::SIFunctionResourceInfo AMDGPUAsmPrinter::analyzeResourceUsage(
561   const MachineFunction &MF) const {
562   SIFunctionResourceInfo Info;
563 
564   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
565   const SISubtarget &ST = MF.getSubtarget<SISubtarget>();
566   const MachineFrameInfo &FrameInfo = MF.getFrameInfo();
567   const MachineRegisterInfo &MRI = MF.getRegInfo();
568   const SIInstrInfo *TII = ST.getInstrInfo();
569   const SIRegisterInfo &TRI = TII->getRegisterInfo();
570 
571   Info.UsesFlatScratch = MRI.isPhysRegUsed(AMDGPU::FLAT_SCR_LO) ||
572                          MRI.isPhysRegUsed(AMDGPU::FLAT_SCR_HI);
573 
574   // Even if FLAT_SCRATCH is implicitly used, it has no effect if flat
575   // instructions aren't used to access the scratch buffer. Inline assembly may
576   // need it though.
577   //
578   // If we only have implicit uses of flat_scr on flat instructions, it is not
579   // really needed.
580   if (Info.UsesFlatScratch && !MFI->hasFlatScratchInit() &&
581       (!hasAnyNonFlatUseOfReg(MRI, *TII, AMDGPU::FLAT_SCR) &&
582        !hasAnyNonFlatUseOfReg(MRI, *TII, AMDGPU::FLAT_SCR_LO) &&
583        !hasAnyNonFlatUseOfReg(MRI, *TII, AMDGPU::FLAT_SCR_HI))) {
584     Info.UsesFlatScratch = false;
585   }
586 
587   Info.HasDynamicallySizedStack = FrameInfo.hasVarSizedObjects();
588   Info.PrivateSegmentSize = FrameInfo.getStackSize();
589 
590 
591   Info.UsesVCC = MRI.isPhysRegUsed(AMDGPU::VCC_LO) ||
592                  MRI.isPhysRegUsed(AMDGPU::VCC_HI);
593 
594   // If there are no calls, MachineRegisterInfo can tell us the used register
595   // count easily.
596   // A tail call isn't considered a call for MachineFrameInfo's purposes.
597   if (!FrameInfo.hasCalls() && !FrameInfo.hasTailCall()) {
598     MCPhysReg HighestVGPRReg = AMDGPU::NoRegister;
599     for (MCPhysReg Reg : reverse(AMDGPU::VGPR_32RegClass.getRegisters())) {
600       if (MRI.isPhysRegUsed(Reg)) {
601         HighestVGPRReg = Reg;
602         break;
603       }
604     }
605 
606     MCPhysReg HighestSGPRReg = AMDGPU::NoRegister;
607     for (MCPhysReg Reg : reverse(AMDGPU::SGPR_32RegClass.getRegisters())) {
608       if (MRI.isPhysRegUsed(Reg)) {
609         HighestSGPRReg = Reg;
610         break;
611       }
612     }
613 
614     // We found the maximum register index. They start at 0, so add one to get the
615     // number of registers.
616     Info.NumVGPR = HighestVGPRReg == AMDGPU::NoRegister ? 0 :
617       TRI.getHWRegIndex(HighestVGPRReg) + 1;
618     Info.NumExplicitSGPR = HighestSGPRReg == AMDGPU::NoRegister ? 0 :
619       TRI.getHWRegIndex(HighestSGPRReg) + 1;
620 
621     return Info;
622   }
623 
624   int32_t MaxVGPR = -1;
625   int32_t MaxSGPR = -1;
626   uint64_t CalleeFrameSize = 0;
627 
628   for (const MachineBasicBlock &MBB : MF) {
629     for (const MachineInstr &MI : MBB) {
630       // TODO: Check regmasks? Do they occur anywhere except calls?
631       for (const MachineOperand &MO : MI.operands()) {
632         unsigned Width = 0;
633         bool IsSGPR = false;
634 
635         if (!MO.isReg())
636           continue;
637 
638         unsigned Reg = MO.getReg();
639         switch (Reg) {
640         case AMDGPU::EXEC:
641         case AMDGPU::EXEC_LO:
642         case AMDGPU::EXEC_HI:
643         case AMDGPU::SCC:
644         case AMDGPU::M0:
645         case AMDGPU::SRC_SHARED_BASE:
646         case AMDGPU::SRC_SHARED_LIMIT:
647         case AMDGPU::SRC_PRIVATE_BASE:
648         case AMDGPU::SRC_PRIVATE_LIMIT:
649           continue;
650 
651         case AMDGPU::NoRegister:
652           assert(MI.isDebugValue());
653           continue;
654 
655         case AMDGPU::VCC:
656         case AMDGPU::VCC_LO:
657         case AMDGPU::VCC_HI:
658           Info.UsesVCC = true;
659           continue;
660 
661         case AMDGPU::FLAT_SCR:
662         case AMDGPU::FLAT_SCR_LO:
663         case AMDGPU::FLAT_SCR_HI:
664           continue;
665 
666         case AMDGPU::TBA:
667         case AMDGPU::TBA_LO:
668         case AMDGPU::TBA_HI:
669         case AMDGPU::TMA:
670         case AMDGPU::TMA_LO:
671         case AMDGPU::TMA_HI:
672           llvm_unreachable("trap handler registers should not be used");
673 
674         default:
675           break;
676         }
677 
678         if (AMDGPU::SReg_32RegClass.contains(Reg)) {
679           assert(!AMDGPU::TTMP_32RegClass.contains(Reg) &&
680                  "trap handler registers should not be used");
681           IsSGPR = true;
682           Width = 1;
683         } else if (AMDGPU::VGPR_32RegClass.contains(Reg)) {
684           IsSGPR = false;
685           Width = 1;
686         } else if (AMDGPU::SReg_64RegClass.contains(Reg)) {
687           assert(!AMDGPU::TTMP_64RegClass.contains(Reg) &&
688                  "trap handler registers should not be used");
689           IsSGPR = true;
690           Width = 2;
691         } else if (AMDGPU::VReg_64RegClass.contains(Reg)) {
692           IsSGPR = false;
693           Width = 2;
694         } else if (AMDGPU::VReg_96RegClass.contains(Reg)) {
695           IsSGPR = false;
696           Width = 3;
697         } else if (AMDGPU::SReg_128RegClass.contains(Reg)) {
698           assert(!AMDGPU::TTMP_128RegClass.contains(Reg) &&
699             "trap handler registers should not be used");
700           IsSGPR = true;
701           Width = 4;
702         } else if (AMDGPU::VReg_128RegClass.contains(Reg)) {
703           IsSGPR = false;
704           Width = 4;
705         } else if (AMDGPU::SReg_256RegClass.contains(Reg)) {
706           assert(!AMDGPU::TTMP_256RegClass.contains(Reg) &&
707             "trap handler registers should not be used");
708           IsSGPR = true;
709           Width = 8;
710         } else if (AMDGPU::VReg_256RegClass.contains(Reg)) {
711           IsSGPR = false;
712           Width = 8;
713         } else if (AMDGPU::SReg_512RegClass.contains(Reg)) {
714           assert(!AMDGPU::TTMP_512RegClass.contains(Reg) &&
715             "trap handler registers should not be used");
716           IsSGPR = true;
717           Width = 16;
718         } else if (AMDGPU::VReg_512RegClass.contains(Reg)) {
719           IsSGPR = false;
720           Width = 16;
721         } else {
722           llvm_unreachable("Unknown register class");
723         }
724         unsigned HWReg = TRI.getHWRegIndex(Reg);
725         int MaxUsed = HWReg + Width - 1;
726         if (IsSGPR) {
727           MaxSGPR = MaxUsed > MaxSGPR ? MaxUsed : MaxSGPR;
728         } else {
729           MaxVGPR = MaxUsed > MaxVGPR ? MaxUsed : MaxVGPR;
730         }
731       }
732 
733       if (MI.isCall()) {
734         // Pseudo used just to encode the underlying global. Is there a better
735         // way to track this?
736 
737         const MachineOperand *CalleeOp
738           = TII->getNamedOperand(MI, AMDGPU::OpName::callee);
739         const Function *Callee = cast<Function>(CalleeOp->getGlobal());
740         if (Callee->isDeclaration()) {
741           // If this is a call to an external function, we can't do much. Make
742           // conservative guesses.
743 
744           // 48 SGPRs - vcc, - flat_scr, -xnack
745           int MaxSGPRGuess = 47 - getNumExtraSGPRs(ST, true,
746                                                    ST.hasFlatAddressSpace());
747           MaxSGPR = std::max(MaxSGPR, MaxSGPRGuess);
748           MaxVGPR = std::max(MaxVGPR, 23);
749 
750           CalleeFrameSize = std::max(CalleeFrameSize, UINT64_C(16384));
751           Info.UsesVCC = true;
752           Info.UsesFlatScratch = ST.hasFlatAddressSpace();
753           Info.HasDynamicallySizedStack = true;
754         } else {
755           // We force CodeGen to run in SCC order, so the callee's register
756           // usage etc. should be the cumulative usage of all callees.
757           auto I = CallGraphResourceInfo.find(Callee);
758           assert(I != CallGraphResourceInfo.end() &&
759                  "callee should have been handled before caller");
760 
761           MaxSGPR = std::max(I->second.NumExplicitSGPR - 1, MaxSGPR);
762           MaxVGPR = std::max(I->second.NumVGPR - 1, MaxVGPR);
763           CalleeFrameSize
764             = std::max(I->second.PrivateSegmentSize, CalleeFrameSize);
765           Info.UsesVCC |= I->second.UsesVCC;
766           Info.UsesFlatScratch |= I->second.UsesFlatScratch;
767           Info.HasDynamicallySizedStack |= I->second.HasDynamicallySizedStack;
768           Info.HasRecursion |= I->second.HasRecursion;
769         }
770 
771         if (!Callee->doesNotRecurse())
772           Info.HasRecursion = true;
773       }
774     }
775   }
776 
777   Info.NumExplicitSGPR = MaxSGPR + 1;
778   Info.NumVGPR = MaxVGPR + 1;
779   Info.PrivateSegmentSize += CalleeFrameSize;
780 
781   return Info;
782 }
783 
784 void AMDGPUAsmPrinter::getSIProgramInfo(SIProgramInfo &ProgInfo,
785                                         const MachineFunction &MF) {
786   SIFunctionResourceInfo Info = analyzeResourceUsage(MF);
787 
788   ProgInfo.NumVGPR = Info.NumVGPR;
789   ProgInfo.NumSGPR = Info.NumExplicitSGPR;
790   ProgInfo.ScratchSize = Info.PrivateSegmentSize;
791   ProgInfo.VCCUsed = Info.UsesVCC;
792   ProgInfo.FlatUsed = Info.UsesFlatScratch;
793   ProgInfo.DynamicCallStack = Info.HasDynamicallySizedStack || Info.HasRecursion;
794 
795   if (!isUInt<32>(ProgInfo.ScratchSize)) {
796     DiagnosticInfoStackSize DiagStackSize(MF.getFunction(),
797                                           ProgInfo.ScratchSize, DS_Error);
798     MF.getFunction().getContext().diagnose(DiagStackSize);
799   }
800 
801   const SISubtarget &STM = MF.getSubtarget<SISubtarget>();
802   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
803   const SIInstrInfo *TII = STM.getInstrInfo();
804   const SIRegisterInfo *RI = &TII->getRegisterInfo();
805 
806   unsigned ExtraSGPRs = getNumExtraSGPRs(STM,
807                                          ProgInfo.VCCUsed,
808                                          ProgInfo.FlatUsed);
809   unsigned ExtraVGPRs = STM.getReservedNumVGPRs(MF);
810 
811   // Check the addressable register limit before we add ExtraSGPRs.
812   if (STM.getGeneration() >= AMDGPUSubtarget::VOLCANIC_ISLANDS &&
813       !STM.hasSGPRInitBug()) {
814     unsigned MaxAddressableNumSGPRs = STM.getAddressableNumSGPRs();
815     if (ProgInfo.NumSGPR > MaxAddressableNumSGPRs) {
816       // This can happen due to a compiler bug or when using inline asm.
817       LLVMContext &Ctx = MF.getFunction().getContext();
818       DiagnosticInfoResourceLimit Diag(MF.getFunction(),
819                                        "addressable scalar registers",
820                                        ProgInfo.NumSGPR, DS_Error,
821                                        DK_ResourceLimit,
822                                        MaxAddressableNumSGPRs);
823       Ctx.diagnose(Diag);
824       ProgInfo.NumSGPR = MaxAddressableNumSGPRs - 1;
825     }
826   }
827 
828   // Account for extra SGPRs and VGPRs reserved for debugger use.
829   ProgInfo.NumSGPR += ExtraSGPRs;
830   ProgInfo.NumVGPR += ExtraVGPRs;
831 
832   // Adjust number of registers used to meet default/requested minimum/maximum
833   // number of waves per execution unit request.
834   ProgInfo.NumSGPRsForWavesPerEU = std::max(
835     std::max(ProgInfo.NumSGPR, 1u), STM.getMinNumSGPRs(MFI->getMaxWavesPerEU()));
836   ProgInfo.NumVGPRsForWavesPerEU = std::max(
837     std::max(ProgInfo.NumVGPR, 1u), STM.getMinNumVGPRs(MFI->getMaxWavesPerEU()));
838 
839   if (STM.getGeneration() <= AMDGPUSubtarget::SEA_ISLANDS ||
840       STM.hasSGPRInitBug()) {
841     unsigned MaxAddressableNumSGPRs = STM.getAddressableNumSGPRs();
842     if (ProgInfo.NumSGPR > MaxAddressableNumSGPRs) {
843       // This can happen due to a compiler bug or when using inline asm to use
844       // the registers which are usually reserved for vcc etc.
845       LLVMContext &Ctx = MF.getFunction().getContext();
846       DiagnosticInfoResourceLimit Diag(MF.getFunction(),
847                                        "scalar registers",
848                                        ProgInfo.NumSGPR, DS_Error,
849                                        DK_ResourceLimit,
850                                        MaxAddressableNumSGPRs);
851       Ctx.diagnose(Diag);
852       ProgInfo.NumSGPR = MaxAddressableNumSGPRs;
853       ProgInfo.NumSGPRsForWavesPerEU = MaxAddressableNumSGPRs;
854     }
855   }
856 
857   if (STM.hasSGPRInitBug()) {
858     ProgInfo.NumSGPR =
859         AMDGPU::IsaInfo::FIXED_NUM_SGPRS_FOR_INIT_BUG;
860     ProgInfo.NumSGPRsForWavesPerEU =
861         AMDGPU::IsaInfo::FIXED_NUM_SGPRS_FOR_INIT_BUG;
862   }
863 
864   if (MFI->getNumUserSGPRs() > STM.getMaxNumUserSGPRs()) {
865     LLVMContext &Ctx = MF.getFunction().getContext();
866     DiagnosticInfoResourceLimit Diag(MF.getFunction(), "user SGPRs",
867                                      MFI->getNumUserSGPRs(), DS_Error);
868     Ctx.diagnose(Diag);
869   }
870 
871   if (MFI->getLDSSize() > static_cast<unsigned>(STM.getLocalMemorySize())) {
872     LLVMContext &Ctx = MF.getFunction().getContext();
873     DiagnosticInfoResourceLimit Diag(MF.getFunction(), "local memory",
874                                      MFI->getLDSSize(), DS_Error);
875     Ctx.diagnose(Diag);
876   }
877 
878   // SGPRBlocks is actual number of SGPR blocks minus 1.
879   ProgInfo.SGPRBlocks = alignTo(ProgInfo.NumSGPRsForWavesPerEU,
880                                 STM.getSGPREncodingGranule());
881   ProgInfo.SGPRBlocks = ProgInfo.SGPRBlocks / STM.getSGPREncodingGranule() - 1;
882 
883   // VGPRBlocks is actual number of VGPR blocks minus 1.
884   ProgInfo.VGPRBlocks = alignTo(ProgInfo.NumVGPRsForWavesPerEU,
885                                 STM.getVGPREncodingGranule());
886   ProgInfo.VGPRBlocks = ProgInfo.VGPRBlocks / STM.getVGPREncodingGranule() - 1;
887 
888   // Record first reserved VGPR and number of reserved VGPRs.
889   ProgInfo.ReservedVGPRFirst = STM.debuggerReserveRegs() ? ProgInfo.NumVGPR : 0;
890   ProgInfo.ReservedVGPRCount = STM.getReservedNumVGPRs(MF);
891 
892   // Update DebuggerWavefrontPrivateSegmentOffsetSGPR and
893   // DebuggerPrivateSegmentBufferSGPR fields if "amdgpu-debugger-emit-prologue"
894   // attribute was requested.
895   if (STM.debuggerEmitPrologue()) {
896     ProgInfo.DebuggerWavefrontPrivateSegmentOffsetSGPR =
897       RI->getHWRegIndex(MFI->getScratchWaveOffsetReg());
898     ProgInfo.DebuggerPrivateSegmentBufferSGPR =
899       RI->getHWRegIndex(MFI->getScratchRSrcReg());
900   }
901 
902   // Set the value to initialize FP_ROUND and FP_DENORM parts of the mode
903   // register.
904   ProgInfo.FloatMode = getFPMode(MF);
905 
906   ProgInfo.IEEEMode = STM.enableIEEEBit(MF);
907 
908   // Make clamp modifier on NaN input returns 0.
909   ProgInfo.DX10Clamp = STM.enableDX10Clamp();
910 
911   unsigned LDSAlignShift;
912   if (STM.getGeneration() < SISubtarget::SEA_ISLANDS) {
913     // LDS is allocated in 64 dword blocks.
914     LDSAlignShift = 8;
915   } else {
916     // LDS is allocated in 128 dword blocks.
917     LDSAlignShift = 9;
918   }
919 
920   unsigned LDSSpillSize =
921     MFI->getLDSWaveSpillSize() * MFI->getMaxFlatWorkGroupSize();
922 
923   ProgInfo.LDSSize = MFI->getLDSSize() + LDSSpillSize;
924   ProgInfo.LDSBlocks =
925       alignTo(ProgInfo.LDSSize, 1ULL << LDSAlignShift) >> LDSAlignShift;
926 
927   // Scratch is allocated in 256 dword blocks.
928   unsigned ScratchAlignShift = 10;
929   // We need to program the hardware with the amount of scratch memory that
930   // is used by the entire wave.  ProgInfo.ScratchSize is the amount of
931   // scratch memory used per thread.
932   ProgInfo.ScratchBlocks =
933       alignTo(ProgInfo.ScratchSize * STM.getWavefrontSize(),
934               1ULL << ScratchAlignShift) >>
935       ScratchAlignShift;
936 
937   ProgInfo.ComputePGMRSrc1 =
938       S_00B848_VGPRS(ProgInfo.VGPRBlocks) |
939       S_00B848_SGPRS(ProgInfo.SGPRBlocks) |
940       S_00B848_PRIORITY(ProgInfo.Priority) |
941       S_00B848_FLOAT_MODE(ProgInfo.FloatMode) |
942       S_00B848_PRIV(ProgInfo.Priv) |
943       S_00B848_DX10_CLAMP(ProgInfo.DX10Clamp) |
944       S_00B848_DEBUG_MODE(ProgInfo.DebugMode) |
945       S_00B848_IEEE_MODE(ProgInfo.IEEEMode);
946 
947   // 0 = X, 1 = XY, 2 = XYZ
948   unsigned TIDIGCompCnt = 0;
949   if (MFI->hasWorkItemIDZ())
950     TIDIGCompCnt = 2;
951   else if (MFI->hasWorkItemIDY())
952     TIDIGCompCnt = 1;
953 
954   ProgInfo.ComputePGMRSrc2 =
955       S_00B84C_SCRATCH_EN(ProgInfo.ScratchBlocks > 0) |
956       S_00B84C_USER_SGPR(MFI->getNumUserSGPRs()) |
957       S_00B84C_TRAP_HANDLER(STM.isTrapHandlerEnabled()) |
958       S_00B84C_TGID_X_EN(MFI->hasWorkGroupIDX()) |
959       S_00B84C_TGID_Y_EN(MFI->hasWorkGroupIDY()) |
960       S_00B84C_TGID_Z_EN(MFI->hasWorkGroupIDZ()) |
961       S_00B84C_TG_SIZE_EN(MFI->hasWorkGroupInfo()) |
962       S_00B84C_TIDIG_COMP_CNT(TIDIGCompCnt) |
963       S_00B84C_EXCP_EN_MSB(0) |
964       // For AMDHSA, LDS_SIZE must be zero, as it is populated by the CP.
965       S_00B84C_LDS_SIZE(STM.isAmdHsaOS() ? 0 : ProgInfo.LDSBlocks) |
966       S_00B84C_EXCP_EN(0);
967 }
968 
969 static unsigned getRsrcReg(CallingConv::ID CallConv) {
970   switch (CallConv) {
971   default: LLVM_FALLTHROUGH;
972   case CallingConv::AMDGPU_CS: return R_00B848_COMPUTE_PGM_RSRC1;
973   case CallingConv::AMDGPU_LS: return R_00B528_SPI_SHADER_PGM_RSRC1_LS;
974   case CallingConv::AMDGPU_HS: return R_00B428_SPI_SHADER_PGM_RSRC1_HS;
975   case CallingConv::AMDGPU_ES: return R_00B328_SPI_SHADER_PGM_RSRC1_ES;
976   case CallingConv::AMDGPU_GS: return R_00B228_SPI_SHADER_PGM_RSRC1_GS;
977   case CallingConv::AMDGPU_VS: return R_00B128_SPI_SHADER_PGM_RSRC1_VS;
978   case CallingConv::AMDGPU_PS: return R_00B028_SPI_SHADER_PGM_RSRC1_PS;
979   }
980 }
981 
982 void AMDGPUAsmPrinter::EmitProgramInfoSI(const MachineFunction &MF,
983                                          const SIProgramInfo &CurrentProgramInfo) {
984   const SISubtarget &STM = MF.getSubtarget<SISubtarget>();
985   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
986   unsigned RsrcReg = getRsrcReg(MF.getFunction().getCallingConv());
987 
988   if (AMDGPU::isCompute(MF.getFunction().getCallingConv())) {
989     OutStreamer->EmitIntValue(R_00B848_COMPUTE_PGM_RSRC1, 4);
990 
991     OutStreamer->EmitIntValue(CurrentProgramInfo.ComputePGMRSrc1, 4);
992 
993     OutStreamer->EmitIntValue(R_00B84C_COMPUTE_PGM_RSRC2, 4);
994     OutStreamer->EmitIntValue(CurrentProgramInfo.ComputePGMRSrc2, 4);
995 
996     OutStreamer->EmitIntValue(R_00B860_COMPUTE_TMPRING_SIZE, 4);
997     OutStreamer->EmitIntValue(S_00B860_WAVESIZE(CurrentProgramInfo.ScratchBlocks), 4);
998 
999     // TODO: Should probably note flat usage somewhere. SC emits a "FlatPtr32 =
1000     // 0" comment but I don't see a corresponding field in the register spec.
1001   } else {
1002     OutStreamer->EmitIntValue(RsrcReg, 4);
1003     OutStreamer->EmitIntValue(S_00B028_VGPRS(CurrentProgramInfo.VGPRBlocks) |
1004                               S_00B028_SGPRS(CurrentProgramInfo.SGPRBlocks), 4);
1005     unsigned Rsrc2Val = 0;
1006     if (STM.isVGPRSpillingEnabled(MF.getFunction())) {
1007       OutStreamer->EmitIntValue(R_0286E8_SPI_TMPRING_SIZE, 4);
1008       OutStreamer->EmitIntValue(S_0286E8_WAVESIZE(CurrentProgramInfo.ScratchBlocks), 4);
1009       if (TM.getTargetTriple().getOS() == Triple::AMDPAL)
1010         Rsrc2Val = S_00B84C_SCRATCH_EN(CurrentProgramInfo.ScratchBlocks > 0);
1011     }
1012     if (MF.getFunction().getCallingConv() == CallingConv::AMDGPU_PS) {
1013       OutStreamer->EmitIntValue(R_0286CC_SPI_PS_INPUT_ENA, 4);
1014       OutStreamer->EmitIntValue(MFI->getPSInputEnable(), 4);
1015       OutStreamer->EmitIntValue(R_0286D0_SPI_PS_INPUT_ADDR, 4);
1016       OutStreamer->EmitIntValue(MFI->getPSInputAddr(), 4);
1017       Rsrc2Val |= S_00B02C_EXTRA_LDS_SIZE(CurrentProgramInfo.LDSBlocks);
1018     }
1019     if (Rsrc2Val) {
1020       OutStreamer->EmitIntValue(RsrcReg + 4 /*rsrc2*/, 4);
1021       OutStreamer->EmitIntValue(Rsrc2Val, 4);
1022     }
1023   }
1024 
1025   OutStreamer->EmitIntValue(R_SPILLED_SGPRS, 4);
1026   OutStreamer->EmitIntValue(MFI->getNumSpilledSGPRs(), 4);
1027   OutStreamer->EmitIntValue(R_SPILLED_VGPRS, 4);
1028   OutStreamer->EmitIntValue(MFI->getNumSpilledVGPRs(), 4);
1029 }
1030 
1031 // This is the equivalent of EmitProgramInfoSI above, but for when the OS type
1032 // is AMDPAL.  It stores each compute/SPI register setting and other PAL
1033 // metadata items into the PALMetadataMap, combining with any provided by the
1034 // frontend as LLVM metadata. Once all functions are written, PALMetadataMap is
1035 // then written as a single block in the .note section.
1036 void AMDGPUAsmPrinter::EmitPALMetadata(const MachineFunction &MF,
1037        const SIProgramInfo &CurrentProgramInfo) {
1038   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
1039   // Given the calling convention, calculate the register number for rsrc1. In
1040   // principle the register number could change in future hardware, but we know
1041   // it is the same for gfx6-9 (except that LS and ES don't exist on gfx9), so
1042   // we can use the same fixed value that .AMDGPU.config has for Mesa. Note
1043   // that we use a register number rather than a byte offset, so we need to
1044   // divide by 4.
1045   unsigned Rsrc1Reg = getRsrcReg(MF.getFunction().getCallingConv()) / 4;
1046   unsigned Rsrc2Reg = Rsrc1Reg + 1;
1047   // Also calculate the PAL metadata key for *S_SCRATCH_SIZE. It can be used
1048   // with a constant offset to access any non-register shader-specific PAL
1049   // metadata key.
1050   unsigned ScratchSizeKey = PALMD::Key::CS_SCRATCH_SIZE;
1051   switch (MF.getFunction().getCallingConv()) {
1052     case CallingConv::AMDGPU_PS:
1053       ScratchSizeKey = PALMD::Key::PS_SCRATCH_SIZE;
1054       break;
1055     case CallingConv::AMDGPU_VS:
1056       ScratchSizeKey = PALMD::Key::VS_SCRATCH_SIZE;
1057       break;
1058     case CallingConv::AMDGPU_GS:
1059       ScratchSizeKey = PALMD::Key::GS_SCRATCH_SIZE;
1060       break;
1061     case CallingConv::AMDGPU_ES:
1062       ScratchSizeKey = PALMD::Key::ES_SCRATCH_SIZE;
1063       break;
1064     case CallingConv::AMDGPU_HS:
1065       ScratchSizeKey = PALMD::Key::HS_SCRATCH_SIZE;
1066       break;
1067     case CallingConv::AMDGPU_LS:
1068       ScratchSizeKey = PALMD::Key::LS_SCRATCH_SIZE;
1069       break;
1070   }
1071   unsigned NumUsedVgprsKey = ScratchSizeKey +
1072       PALMD::Key::VS_NUM_USED_VGPRS - PALMD::Key::VS_SCRATCH_SIZE;
1073   unsigned NumUsedSgprsKey = ScratchSizeKey +
1074       PALMD::Key::VS_NUM_USED_SGPRS - PALMD::Key::VS_SCRATCH_SIZE;
1075   PALMetadataMap[NumUsedVgprsKey] = CurrentProgramInfo.NumVGPRsForWavesPerEU;
1076   PALMetadataMap[NumUsedSgprsKey] = CurrentProgramInfo.NumSGPRsForWavesPerEU;
1077   if (AMDGPU::isCompute(MF.getFunction().getCallingConv())) {
1078     PALMetadataMap[Rsrc1Reg] |= CurrentProgramInfo.ComputePGMRSrc1;
1079     PALMetadataMap[Rsrc2Reg] |= CurrentProgramInfo.ComputePGMRSrc2;
1080     // ScratchSize is in bytes, 16 aligned.
1081     PALMetadataMap[ScratchSizeKey] |=
1082         alignTo(CurrentProgramInfo.ScratchSize, 16);
1083   } else {
1084     PALMetadataMap[Rsrc1Reg] |= S_00B028_VGPRS(CurrentProgramInfo.VGPRBlocks) |
1085         S_00B028_SGPRS(CurrentProgramInfo.SGPRBlocks);
1086     if (CurrentProgramInfo.ScratchBlocks > 0)
1087       PALMetadataMap[Rsrc2Reg] |= S_00B84C_SCRATCH_EN(1);
1088     // ScratchSize is in bytes, 16 aligned.
1089     PALMetadataMap[ScratchSizeKey] |=
1090         alignTo(CurrentProgramInfo.ScratchSize, 16);
1091   }
1092   if (MF.getFunction().getCallingConv() == CallingConv::AMDGPU_PS) {
1093     PALMetadataMap[Rsrc2Reg] |=
1094         S_00B02C_EXTRA_LDS_SIZE(CurrentProgramInfo.LDSBlocks);
1095     PALMetadataMap[R_0286CC_SPI_PS_INPUT_ENA / 4] |= MFI->getPSInputEnable();
1096     PALMetadataMap[R_0286D0_SPI_PS_INPUT_ADDR / 4] |= MFI->getPSInputAddr();
1097   }
1098 }
1099 
1100 // This is supposed to be log2(Size)
1101 static amd_element_byte_size_t getElementByteSizeValue(unsigned Size) {
1102   switch (Size) {
1103   case 4:
1104     return AMD_ELEMENT_4_BYTES;
1105   case 8:
1106     return AMD_ELEMENT_8_BYTES;
1107   case 16:
1108     return AMD_ELEMENT_16_BYTES;
1109   default:
1110     llvm_unreachable("invalid private_element_size");
1111   }
1112 }
1113 
1114 void AMDGPUAsmPrinter::getAmdKernelCode(amd_kernel_code_t &Out,
1115                                         const SIProgramInfo &CurrentProgramInfo,
1116                                         const MachineFunction &MF) const {
1117   const SIMachineFunctionInfo *MFI = MF.getInfo<SIMachineFunctionInfo>();
1118   const SISubtarget &STM = MF.getSubtarget<SISubtarget>();
1119 
1120   AMDGPU::initDefaultAMDKernelCodeT(Out, STM.getFeatureBits());
1121 
1122   Out.compute_pgm_resource_registers =
1123       CurrentProgramInfo.ComputePGMRSrc1 |
1124       (CurrentProgramInfo.ComputePGMRSrc2 << 32);
1125   Out.code_properties = AMD_CODE_PROPERTY_IS_PTR64;
1126 
1127   if (CurrentProgramInfo.DynamicCallStack)
1128     Out.code_properties |= AMD_CODE_PROPERTY_IS_DYNAMIC_CALLSTACK;
1129 
1130   AMD_HSA_BITS_SET(Out.code_properties,
1131                    AMD_CODE_PROPERTY_PRIVATE_ELEMENT_SIZE,
1132                    getElementByteSizeValue(STM.getMaxPrivateElementSize()));
1133 
1134   if (MFI->hasPrivateSegmentBuffer()) {
1135     Out.code_properties |=
1136       AMD_CODE_PROPERTY_ENABLE_SGPR_PRIVATE_SEGMENT_BUFFER;
1137   }
1138 
1139   if (MFI->hasDispatchPtr())
1140     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_PTR;
1141 
1142   if (MFI->hasQueuePtr())
1143     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_QUEUE_PTR;
1144 
1145   if (MFI->hasKernargSegmentPtr())
1146     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_KERNARG_SEGMENT_PTR;
1147 
1148   if (MFI->hasDispatchID())
1149     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_ID;
1150 
1151   if (MFI->hasFlatScratchInit())
1152     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_FLAT_SCRATCH_INIT;
1153 
1154   if (MFI->hasGridWorkgroupCountX()) {
1155     Out.code_properties |=
1156       AMD_CODE_PROPERTY_ENABLE_SGPR_GRID_WORKGROUP_COUNT_X;
1157   }
1158 
1159   if (MFI->hasGridWorkgroupCountY()) {
1160     Out.code_properties |=
1161       AMD_CODE_PROPERTY_ENABLE_SGPR_GRID_WORKGROUP_COUNT_Y;
1162   }
1163 
1164   if (MFI->hasGridWorkgroupCountZ()) {
1165     Out.code_properties |=
1166       AMD_CODE_PROPERTY_ENABLE_SGPR_GRID_WORKGROUP_COUNT_Z;
1167   }
1168 
1169   if (MFI->hasDispatchPtr())
1170     Out.code_properties |= AMD_CODE_PROPERTY_ENABLE_SGPR_DISPATCH_PTR;
1171 
1172   if (STM.debuggerSupported())
1173     Out.code_properties |= AMD_CODE_PROPERTY_IS_DEBUG_SUPPORTED;
1174 
1175   if (STM.isXNACKEnabled())
1176     Out.code_properties |= AMD_CODE_PROPERTY_IS_XNACK_SUPPORTED;
1177 
1178   // FIXME: Should use getKernArgSize
1179   Out.kernarg_segment_byte_size =
1180     STM.getKernArgSegmentSize(MF, MFI->getABIArgOffset());
1181   Out.wavefront_sgpr_count = CurrentProgramInfo.NumSGPR;
1182   Out.workitem_vgpr_count = CurrentProgramInfo.NumVGPR;
1183   Out.workitem_private_segment_byte_size = CurrentProgramInfo.ScratchSize;
1184   Out.workgroup_group_segment_byte_size = CurrentProgramInfo.LDSSize;
1185   Out.reserved_vgpr_first = CurrentProgramInfo.ReservedVGPRFirst;
1186   Out.reserved_vgpr_count = CurrentProgramInfo.ReservedVGPRCount;
1187 
1188   // These alignment values are specified in powers of two, so alignment =
1189   // 2^n.  The minimum alignment is 2^4 = 16.
1190   Out.kernarg_segment_alignment = std::max((size_t)4,
1191       countTrailingZeros(MFI->getMaxKernArgAlign()));
1192 
1193   if (STM.debuggerEmitPrologue()) {
1194     Out.debug_wavefront_private_segment_offset_sgpr =
1195       CurrentProgramInfo.DebuggerWavefrontPrivateSegmentOffsetSGPR;
1196     Out.debug_private_segment_buffer_sgpr =
1197       CurrentProgramInfo.DebuggerPrivateSegmentBufferSGPR;
1198   }
1199 }
1200 
1201 AMDGPU::HSAMD::Kernel::CodeProps::Metadata AMDGPUAsmPrinter::getHSACodeProps(
1202     const MachineFunction &MF,
1203     const SIProgramInfo &ProgramInfo) const {
1204   const SISubtarget &STM = MF.getSubtarget<SISubtarget>();
1205   const SIMachineFunctionInfo &MFI = *MF.getInfo<SIMachineFunctionInfo>();
1206   HSAMD::Kernel::CodeProps::Metadata HSACodeProps;
1207 
1208   HSACodeProps.mKernargSegmentSize =
1209       STM.getKernArgSegmentSize(MF, MFI.getABIArgOffset());
1210   HSACodeProps.mGroupSegmentFixedSize = ProgramInfo.LDSSize;
1211   HSACodeProps.mPrivateSegmentFixedSize = ProgramInfo.ScratchSize;
1212   HSACodeProps.mKernargSegmentAlign =
1213       std::max(uint32_t(4), MFI.getMaxKernArgAlign());
1214   HSACodeProps.mWavefrontSize = STM.getWavefrontSize();
1215   HSACodeProps.mNumSGPRs = CurrentProgramInfo.NumSGPR;
1216   HSACodeProps.mNumVGPRs = CurrentProgramInfo.NumVGPR;
1217   HSACodeProps.mMaxFlatWorkGroupSize = MFI.getMaxFlatWorkGroupSize();
1218   HSACodeProps.mIsDynamicCallStack = ProgramInfo.DynamicCallStack;
1219   HSACodeProps.mIsXNACKEnabled = STM.isXNACKEnabled();
1220   HSACodeProps.mNumSpilledSGPRs = MFI.getNumSpilledSGPRs();
1221   HSACodeProps.mNumSpilledVGPRs = MFI.getNumSpilledVGPRs();
1222 
1223   return HSACodeProps;
1224 }
1225 
1226 AMDGPU::HSAMD::Kernel::DebugProps::Metadata AMDGPUAsmPrinter::getHSADebugProps(
1227     const MachineFunction &MF,
1228     const SIProgramInfo &ProgramInfo) const {
1229   const SISubtarget &STM = MF.getSubtarget<SISubtarget>();
1230   HSAMD::Kernel::DebugProps::Metadata HSADebugProps;
1231 
1232   if (!STM.debuggerSupported())
1233     return HSADebugProps;
1234 
1235   HSADebugProps.mDebuggerABIVersion.push_back(1);
1236   HSADebugProps.mDebuggerABIVersion.push_back(0);
1237   HSADebugProps.mReservedNumVGPRs = ProgramInfo.ReservedVGPRCount;
1238   HSADebugProps.mReservedFirstVGPR = ProgramInfo.ReservedVGPRFirst;
1239 
1240   if (STM.debuggerEmitPrologue()) {
1241     HSADebugProps.mPrivateSegmentBufferSGPR =
1242         ProgramInfo.DebuggerPrivateSegmentBufferSGPR;
1243     HSADebugProps.mWavefrontPrivateSegmentOffsetSGPR =
1244         ProgramInfo.DebuggerWavefrontPrivateSegmentOffsetSGPR;
1245   }
1246 
1247   return HSADebugProps;
1248 }
1249 
1250 bool AMDGPUAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1251                                        unsigned AsmVariant,
1252                                        const char *ExtraCode, raw_ostream &O) {
1253   // First try the generic code, which knows about modifiers like 'c' and 'n'.
1254   if (!AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, O))
1255     return false;
1256 
1257   if (ExtraCode && ExtraCode[0]) {
1258     if (ExtraCode[1] != 0)
1259       return true; // Unknown modifier.
1260 
1261     switch (ExtraCode[0]) {
1262     case 'r':
1263       break;
1264     default:
1265       return true;
1266     }
1267   }
1268 
1269   // TODO: Should be able to support other operand types like globals.
1270   const MachineOperand &MO = MI->getOperand(OpNo);
1271   if (MO.isReg()) {
1272     AMDGPUInstPrinter::printRegOperand(MO.getReg(), O,
1273                                        *MF->getSubtarget().getRegisterInfo());
1274     return false;
1275   }
1276 
1277   return true;
1278 }
1279