xref: /openbsd-src/gnu/llvm/llvm/lib/Target/PowerPC/PPCAsmPrinter.cpp (revision 46035553bfdd96e63c94e32da0210227ec2e3cf1)
1 //===-- PPCAsmPrinter.cpp - Print machine instrs to PowerPC assembly ------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains a printer that converts from our internal representation
10 // of machine-dependent LLVM code to PowerPC assembly language. This printer is
11 // the output mechanism used by `llc'.
12 //
13 // Documentation at http://developer.apple.com/documentation/DeveloperTools/
14 // Reference/Assembler/ASMIntroduction/chapter_1_section_1.html
15 //
16 //===----------------------------------------------------------------------===//
17 
18 #include "MCTargetDesc/PPCInstPrinter.h"
19 #include "MCTargetDesc/PPCMCExpr.h"
20 #include "MCTargetDesc/PPCMCTargetDesc.h"
21 #include "MCTargetDesc/PPCPredicates.h"
22 #include "PPC.h"
23 #include "PPCInstrInfo.h"
24 #include "PPCMachineFunctionInfo.h"
25 #include "PPCSubtarget.h"
26 #include "PPCTargetMachine.h"
27 #include "PPCTargetStreamer.h"
28 #include "TargetInfo/PowerPCTargetInfo.h"
29 #include "llvm/ADT/MapVector.h"
30 #include "llvm/ADT/StringRef.h"
31 #include "llvm/ADT/Triple.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/BinaryFormat/ELF.h"
34 #include "llvm/BinaryFormat/MachO.h"
35 #include "llvm/CodeGen/AsmPrinter.h"
36 #include "llvm/CodeGen/MachineBasicBlock.h"
37 #include "llvm/CodeGen/MachineFunction.h"
38 #include "llvm/CodeGen/MachineInstr.h"
39 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
40 #include "llvm/CodeGen/MachineOperand.h"
41 #include "llvm/CodeGen/MachineRegisterInfo.h"
42 #include "llvm/CodeGen/StackMaps.h"
43 #include "llvm/CodeGen/TargetLoweringObjectFileImpl.h"
44 #include "llvm/IR/DataLayout.h"
45 #include "llvm/IR/GlobalValue.h"
46 #include "llvm/IR/GlobalVariable.h"
47 #include "llvm/IR/Module.h"
48 #include "llvm/MC/MCAsmInfo.h"
49 #include "llvm/MC/MCContext.h"
50 #include "llvm/MC/MCExpr.h"
51 #include "llvm/MC/MCInst.h"
52 #include "llvm/MC/MCInstBuilder.h"
53 #include "llvm/MC/MCSectionELF.h"
54 #include "llvm/MC/MCSectionMachO.h"
55 #include "llvm/MC/MCSectionXCOFF.h"
56 #include "llvm/MC/MCStreamer.h"
57 #include "llvm/MC/MCSymbol.h"
58 #include "llvm/MC/MCSymbolELF.h"
59 #include "llvm/MC/MCSymbolXCOFF.h"
60 #include "llvm/MC/SectionKind.h"
61 #include "llvm/Support/Casting.h"
62 #include "llvm/Support/CodeGen.h"
63 #include "llvm/Support/Debug.h"
64 #include "llvm/Support/ErrorHandling.h"
65 #include "llvm/Support/TargetRegistry.h"
66 #include "llvm/Support/raw_ostream.h"
67 #include "llvm/Target/TargetMachine.h"
68 #include <algorithm>
69 #include <cassert>
70 #include <cstdint>
71 #include <memory>
72 #include <new>
73 
74 using namespace llvm;
75 
76 #define DEBUG_TYPE "asmprinter"
77 
78 namespace {
79 
80 class PPCAsmPrinter : public AsmPrinter {
81 protected:
82   MapVector<const MCSymbol *, MCSymbol *> TOC;
83   const PPCSubtarget *Subtarget = nullptr;
84   StackMaps SM;
85 
86   virtual MCSymbol *getMCSymbolForTOCPseudoMO(const MachineOperand &MO);
87 
88 public:
89   explicit PPCAsmPrinter(TargetMachine &TM,
90                          std::unique_ptr<MCStreamer> Streamer)
91       : AsmPrinter(TM, std::move(Streamer)), SM(*this) {}
92 
93   StringRef getPassName() const override { return "PowerPC Assembly Printer"; }
94 
95   MCSymbol *lookUpOrCreateTOCEntry(const MCSymbol *Sym);
96 
97   bool doInitialization(Module &M) override {
98     if (!TOC.empty())
99       TOC.clear();
100     return AsmPrinter::doInitialization(M);
101   }
102 
103   void EmitInstruction(const MachineInstr *MI) override;
104 
105   /// This function is for PrintAsmOperand and PrintAsmMemoryOperand,
106   /// invoked by EmitMSInlineAsmStr and EmitGCCInlineAsmStr only.
107   /// The \p MI would be INLINEASM ONLY.
108   void printOperand(const MachineInstr *MI, unsigned OpNo, raw_ostream &O);
109 
110   void PrintSymbolOperand(const MachineOperand &MO, raw_ostream &O) override;
111   bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
112                        const char *ExtraCode, raw_ostream &O) override;
113   bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
114                              const char *ExtraCode, raw_ostream &O) override;
115 
116   void EmitEndOfAsmFile(Module &M) override;
117 
118   void LowerSTACKMAP(StackMaps &SM, const MachineInstr &MI);
119   void LowerPATCHPOINT(StackMaps &SM, const MachineInstr &MI);
120   void EmitTlsCall(const MachineInstr *MI, MCSymbolRefExpr::VariantKind VK);
121   bool runOnMachineFunction(MachineFunction &MF) override {
122     Subtarget = &MF.getSubtarget<PPCSubtarget>();
123     bool Changed = AsmPrinter::runOnMachineFunction(MF);
124     emitXRayTable();
125     return Changed;
126   }
127 };
128 
129 /// PPCLinuxAsmPrinter - PowerPC assembly printer, customized for Linux
130 class PPCLinuxAsmPrinter : public PPCAsmPrinter {
131 public:
132   explicit PPCLinuxAsmPrinter(TargetMachine &TM,
133                               std::unique_ptr<MCStreamer> Streamer)
134       : PPCAsmPrinter(TM, std::move(Streamer)) {}
135 
136   StringRef getPassName() const override {
137     return "Linux PPC Assembly Printer";
138   }
139 
140   bool doFinalization(Module &M) override;
141   void EmitStartOfAsmFile(Module &M) override;
142 
143   void EmitFunctionEntryLabel() override;
144 
145   void EmitFunctionBodyStart() override;
146   void EmitFunctionBodyEnd() override;
147   void EmitInstruction(const MachineInstr *MI) override;
148 };
149 
150 class PPCAIXAsmPrinter : public PPCAsmPrinter {
151 private:
152   static void ValidateGV(const GlobalVariable *GV);
153 protected:
154   MCSymbol *getMCSymbolForTOCPseudoMO(const MachineOperand &MO) override;
155 
156 public:
157   PPCAIXAsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer)
158       : PPCAsmPrinter(TM, std::move(Streamer)) {}
159 
160   StringRef getPassName() const override { return "AIX PPC Assembly Printer"; }
161 
162   void SetupMachineFunction(MachineFunction &MF) override;
163 
164   const MCExpr *lowerConstant(const Constant *CV) override;
165 
166   void EmitGlobalVariable(const GlobalVariable *GV) override;
167 
168   void EmitFunctionDescriptor() override;
169 
170   void EmitEndOfAsmFile(Module &) override;
171 };
172 
173 } // end anonymous namespace
174 
175 void PPCAsmPrinter::PrintSymbolOperand(const MachineOperand &MO,
176                                        raw_ostream &O) {
177   // Computing the address of a global symbol, not calling it.
178   const GlobalValue *GV = MO.getGlobal();
179   MCSymbol *SymToPrint;
180 
181   // External or weakly linked global variables need non-lazily-resolved stubs
182   if (Subtarget->hasLazyResolverStub(GV)) {
183     SymToPrint = getSymbolWithGlobalValueBase(GV, "$non_lazy_ptr");
184     MachineModuleInfoImpl::StubValueTy &StubSym =
185         MMI->getObjFileInfo<MachineModuleInfoMachO>().getGVStubEntry(
186             SymToPrint);
187     if (!StubSym.getPointer())
188       StubSym = MachineModuleInfoImpl::StubValueTy(getSymbol(GV),
189                                                    !GV->hasInternalLinkage());
190   } else {
191     SymToPrint = getSymbol(GV);
192   }
193 
194   SymToPrint->print(O, MAI);
195 
196   printOffset(MO.getOffset(), O);
197 }
198 
199 void PPCAsmPrinter::printOperand(const MachineInstr *MI, unsigned OpNo,
200                                  raw_ostream &O) {
201   const DataLayout &DL = getDataLayout();
202   const MachineOperand &MO = MI->getOperand(OpNo);
203 
204   switch (MO.getType()) {
205   case MachineOperand::MO_Register: {
206     // The MI is INLINEASM ONLY and UseVSXReg is always false.
207     const char *RegName = PPCInstPrinter::getRegisterName(MO.getReg());
208 
209     // Linux assembler (Others?) does not take register mnemonics.
210     // FIXME - What about special registers used in mfspr/mtspr?
211     if (!Subtarget->isDarwin())
212       RegName = PPCRegisterInfo::stripRegisterPrefix(RegName);
213     O << RegName;
214     return;
215   }
216   case MachineOperand::MO_Immediate:
217     O << MO.getImm();
218     return;
219 
220   case MachineOperand::MO_MachineBasicBlock:
221     MO.getMBB()->getSymbol()->print(O, MAI);
222     return;
223   case MachineOperand::MO_ConstantPoolIndex:
224     O << DL.getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
225       << MO.getIndex();
226     return;
227   case MachineOperand::MO_BlockAddress:
228     GetBlockAddressSymbol(MO.getBlockAddress())->print(O, MAI);
229     return;
230   case MachineOperand::MO_GlobalAddress: {
231     PrintSymbolOperand(MO, O);
232     return;
233   }
234 
235   default:
236     O << "<unknown operand type: " << (unsigned)MO.getType() << ">";
237     return;
238   }
239 }
240 
241 /// PrintAsmOperand - Print out an operand for an inline asm expression.
242 ///
243 bool PPCAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
244                                     const char *ExtraCode, raw_ostream &O) {
245   // Does this asm operand have a single letter operand modifier?
246   if (ExtraCode && ExtraCode[0]) {
247     if (ExtraCode[1] != 0) return true; // Unknown modifier.
248 
249     switch (ExtraCode[0]) {
250     default:
251       // See if this is a generic print operand
252       return AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, O);
253     case 'L': // Write second word of DImode reference.
254       // Verify that this operand has two consecutive registers.
255       if (!MI->getOperand(OpNo).isReg() ||
256           OpNo+1 == MI->getNumOperands() ||
257           !MI->getOperand(OpNo+1).isReg())
258         return true;
259       ++OpNo;   // Return the high-part.
260       break;
261     case 'I':
262       // Write 'i' if an integer constant, otherwise nothing.  Used to print
263       // addi vs add, etc.
264       if (MI->getOperand(OpNo).isImm())
265         O << "i";
266       return false;
267     case 'x':
268       if(!MI->getOperand(OpNo).isReg())
269         return true;
270       // This operand uses VSX numbering.
271       // If the operand is a VMX register, convert it to a VSX register.
272       Register Reg = MI->getOperand(OpNo).getReg();
273       if (PPCInstrInfo::isVRRegister(Reg))
274         Reg = PPC::VSX32 + (Reg - PPC::V0);
275       else if (PPCInstrInfo::isVFRegister(Reg))
276         Reg = PPC::VSX32 + (Reg - PPC::VF0);
277       const char *RegName;
278       RegName = PPCInstPrinter::getRegisterName(Reg);
279       RegName = PPCRegisterInfo::stripRegisterPrefix(RegName);
280       O << RegName;
281       return false;
282     }
283   }
284 
285   printOperand(MI, OpNo, O);
286   return false;
287 }
288 
289 // At the moment, all inline asm memory operands are a single register.
290 // In any case, the output of this routine should always be just one
291 // assembler operand.
292 
293 bool PPCAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
294                                           const char *ExtraCode,
295                                           raw_ostream &O) {
296   if (ExtraCode && ExtraCode[0]) {
297     if (ExtraCode[1] != 0) return true; // Unknown modifier.
298 
299     switch (ExtraCode[0]) {
300     default: return true;  // Unknown modifier.
301     case 'L': // A memory reference to the upper word of a double word op.
302       O << getDataLayout().getPointerSize() << "(";
303       printOperand(MI, OpNo, O);
304       O << ")";
305       return false;
306     case 'y': // A memory reference for an X-form instruction
307       {
308         const char *RegName = "r0";
309         if (!Subtarget->isDarwin())
310           RegName = PPCRegisterInfo::stripRegisterPrefix(RegName);
311         O << RegName << ", ";
312         printOperand(MI, OpNo, O);
313         return false;
314       }
315     case 'U': // Print 'u' for update form.
316     case 'X': // Print 'x' for indexed form.
317       // FIXME: Currently for PowerPC memory operands are always loaded
318       // into a register, so we never get an update or indexed form.
319       // This is bad even for offset forms, since even if we know we
320       // have a value in -16(r1), we will generate a load into r<n>
321       // and then load from 0(r<n>).  Until that issue is fixed,
322       // tolerate 'U' and 'X' but don't output anything.
323       assert(MI->getOperand(OpNo).isReg());
324       return false;
325     }
326   }
327 
328   assert(MI->getOperand(OpNo).isReg());
329   O << "0(";
330   printOperand(MI, OpNo, O);
331   O << ")";
332   return false;
333 }
334 
335 /// lookUpOrCreateTOCEntry -- Given a symbol, look up whether a TOC entry
336 /// exists for it.  If not, create one.  Then return a symbol that references
337 /// the TOC entry.
338 MCSymbol *PPCAsmPrinter::lookUpOrCreateTOCEntry(const MCSymbol *Sym) {
339   MCSymbol *&TOCEntry = TOC[Sym];
340   if (!TOCEntry)
341     TOCEntry = createTempSymbol("C");
342   return TOCEntry;
343 }
344 
345 void PPCAsmPrinter::EmitEndOfAsmFile(Module &M) {
346   emitStackMaps(SM);
347 }
348 
349 void PPCAsmPrinter::LowerSTACKMAP(StackMaps &SM, const MachineInstr &MI) {
350   unsigned NumNOPBytes = MI.getOperand(1).getImm();
351 
352   auto &Ctx = OutStreamer->getContext();
353   MCSymbol *MILabel = Ctx.createTempSymbol();
354   OutStreamer->EmitLabel(MILabel);
355 
356   SM.recordStackMap(*MILabel, MI);
357   assert(NumNOPBytes % 4 == 0 && "Invalid number of NOP bytes requested!");
358 
359   // Scan ahead to trim the shadow.
360   const MachineBasicBlock &MBB = *MI.getParent();
361   MachineBasicBlock::const_iterator MII(MI);
362   ++MII;
363   while (NumNOPBytes > 0) {
364     if (MII == MBB.end() || MII->isCall() ||
365         MII->getOpcode() == PPC::DBG_VALUE ||
366         MII->getOpcode() == TargetOpcode::PATCHPOINT ||
367         MII->getOpcode() == TargetOpcode::STACKMAP)
368       break;
369     ++MII;
370     NumNOPBytes -= 4;
371   }
372 
373   // Emit nops.
374   for (unsigned i = 0; i < NumNOPBytes; i += 4)
375     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::NOP));
376 }
377 
378 // Lower a patchpoint of the form:
379 // [<def>], <id>, <numBytes>, <target>, <numArgs>
380 void PPCAsmPrinter::LowerPATCHPOINT(StackMaps &SM, const MachineInstr &MI) {
381   auto &Ctx = OutStreamer->getContext();
382   MCSymbol *MILabel = Ctx.createTempSymbol();
383   OutStreamer->EmitLabel(MILabel);
384 
385   SM.recordPatchPoint(*MILabel, MI);
386   PatchPointOpers Opers(&MI);
387 
388   unsigned EncodedBytes = 0;
389   const MachineOperand &CalleeMO = Opers.getCallTarget();
390 
391   if (CalleeMO.isImm()) {
392     int64_t CallTarget = CalleeMO.getImm();
393     if (CallTarget) {
394       assert((CallTarget & 0xFFFFFFFFFFFF) == CallTarget &&
395              "High 16 bits of call target should be zero.");
396       Register ScratchReg = MI.getOperand(Opers.getNextScratchIdx()).getReg();
397       EncodedBytes = 0;
398       // Materialize the jump address:
399       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LI8)
400                                       .addReg(ScratchReg)
401                                       .addImm((CallTarget >> 32) & 0xFFFF));
402       ++EncodedBytes;
403       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::RLDIC)
404                                       .addReg(ScratchReg)
405                                       .addReg(ScratchReg)
406                                       .addImm(32).addImm(16));
407       ++EncodedBytes;
408       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ORIS8)
409                                       .addReg(ScratchReg)
410                                       .addReg(ScratchReg)
411                                       .addImm((CallTarget >> 16) & 0xFFFF));
412       ++EncodedBytes;
413       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ORI8)
414                                       .addReg(ScratchReg)
415                                       .addReg(ScratchReg)
416                                       .addImm(CallTarget & 0xFFFF));
417 
418       // Save the current TOC pointer before the remote call.
419       int TOCSaveOffset = Subtarget->getFrameLowering()->getTOCSaveOffset();
420       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::STD)
421                                       .addReg(PPC::X2)
422                                       .addImm(TOCSaveOffset)
423                                       .addReg(PPC::X1));
424       ++EncodedBytes;
425 
426       // If we're on ELFv1, then we need to load the actual function pointer
427       // from the function descriptor.
428       if (!Subtarget->isELFv2ABI()) {
429         // Load the new TOC pointer and the function address, but not r11
430         // (needing this is rare, and loading it here would prevent passing it
431         // via a 'nest' parameter.
432         EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LD)
433                                         .addReg(PPC::X2)
434                                         .addImm(8)
435                                         .addReg(ScratchReg));
436         ++EncodedBytes;
437         EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LD)
438                                         .addReg(ScratchReg)
439                                         .addImm(0)
440                                         .addReg(ScratchReg));
441         ++EncodedBytes;
442       }
443 
444       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::MTCTR8)
445                                       .addReg(ScratchReg));
446       ++EncodedBytes;
447       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::BCTRL8));
448       ++EncodedBytes;
449 
450       // Restore the TOC pointer after the call.
451       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LD)
452                                       .addReg(PPC::X2)
453                                       .addImm(TOCSaveOffset)
454                                       .addReg(PPC::X1));
455       ++EncodedBytes;
456     }
457   } else if (CalleeMO.isGlobal()) {
458     const GlobalValue *GValue = CalleeMO.getGlobal();
459     MCSymbol *MOSymbol = getSymbol(GValue);
460     const MCExpr *SymVar = MCSymbolRefExpr::create(MOSymbol, OutContext);
461 
462     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::BL8_NOP)
463                                     .addExpr(SymVar));
464     EncodedBytes += 2;
465   }
466 
467   // Each instruction is 4 bytes.
468   EncodedBytes *= 4;
469 
470   // Emit padding.
471   unsigned NumBytes = Opers.getNumPatchBytes();
472   assert(NumBytes >= EncodedBytes &&
473          "Patchpoint can't request size less than the length of a call.");
474   assert((NumBytes - EncodedBytes) % 4 == 0 &&
475          "Invalid number of NOP bytes requested!");
476   for (unsigned i = EncodedBytes; i < NumBytes; i += 4)
477     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::NOP));
478 }
479 
480 /// EmitTlsCall -- Given a GETtls[ld]ADDR[32] instruction, print a
481 /// call to __tls_get_addr to the current output stream.
482 void PPCAsmPrinter::EmitTlsCall(const MachineInstr *MI,
483                                 MCSymbolRefExpr::VariantKind VK) {
484   StringRef Name = "__tls_get_addr";
485   MCSymbol *TlsGetAddr = OutContext.getOrCreateSymbol(Name);
486   MCSymbolRefExpr::VariantKind Kind = MCSymbolRefExpr::VK_None;
487   const Module *M = MF->getFunction().getParent();
488 
489   assert(MI->getOperand(0).isReg() &&
490          ((Subtarget->isPPC64() && MI->getOperand(0).getReg() == PPC::X3) ||
491           (!Subtarget->isPPC64() && MI->getOperand(0).getReg() == PPC::R3)) &&
492          "GETtls[ld]ADDR[32] must define GPR3");
493   assert(MI->getOperand(1).isReg() &&
494          ((Subtarget->isPPC64() && MI->getOperand(1).getReg() == PPC::X3) ||
495           (!Subtarget->isPPC64() && MI->getOperand(1).getReg() == PPC::R3)) &&
496          "GETtls[ld]ADDR[32] must read GPR3");
497 
498   if (Subtarget->is32BitELFABI() && isPositionIndependent())
499     Kind = MCSymbolRefExpr::VK_PLT;
500 
501   const MCExpr *TlsRef =
502     MCSymbolRefExpr::create(TlsGetAddr, Kind, OutContext);
503 
504   // Add 32768 offset to the symbol so we follow up the latest GOT/PLT ABI.
505   if (Kind == MCSymbolRefExpr::VK_PLT && Subtarget->isSecurePlt() &&
506       M->getPICLevel() == PICLevel::BigPIC)
507     TlsRef = MCBinaryExpr::createAdd(
508         TlsRef, MCConstantExpr::create(32768, OutContext), OutContext);
509   const MachineOperand &MO = MI->getOperand(2);
510   const GlobalValue *GValue = MO.getGlobal();
511   MCSymbol *MOSymbol = getSymbol(GValue);
512   const MCExpr *SymVar = MCSymbolRefExpr::create(MOSymbol, VK, OutContext);
513   EmitToStreamer(*OutStreamer,
514                  MCInstBuilder(Subtarget->isPPC64() ?
515                                PPC::BL8_NOP_TLS : PPC::BL_TLS)
516                  .addExpr(TlsRef)
517                  .addExpr(SymVar));
518 }
519 
520 /// Map a machine operand for a TOC pseudo-machine instruction to its
521 /// corresponding MCSymbol.
522 MCSymbol *PPCAsmPrinter::getMCSymbolForTOCPseudoMO(const MachineOperand &MO) {
523   switch (MO.getType()) {
524   case MachineOperand::MO_GlobalAddress:
525     return getSymbol(MO.getGlobal());
526   case MachineOperand::MO_ConstantPoolIndex:
527     return GetCPISymbol(MO.getIndex());
528   case MachineOperand::MO_JumpTableIndex:
529     return GetJTISymbol(MO.getIndex());
530   case MachineOperand::MO_BlockAddress:
531     return GetBlockAddressSymbol(MO.getBlockAddress());
532   default:
533     llvm_unreachable("Unexpected operand type to get symbol.");
534   }
535 }
536 
537 /// EmitInstruction -- Print out a single PowerPC MI in Darwin syntax to
538 /// the current output stream.
539 ///
540 void PPCAsmPrinter::EmitInstruction(const MachineInstr *MI) {
541   MCInst TmpInst;
542   const bool IsDarwin = TM.getTargetTriple().isOSDarwin();
543   const bool IsPPC64 = Subtarget->isPPC64();
544   const bool IsAIX = Subtarget->isAIXABI();
545   const Module *M = MF->getFunction().getParent();
546   PICLevel::Level PL = M->getPICLevel();
547 
548 #ifndef NDEBUG
549   // Validate that SPE and FPU are mutually exclusive in codegen
550   if (!MI->isInlineAsm()) {
551     for (const MachineOperand &MO: MI->operands()) {
552       if (MO.isReg()) {
553         Register Reg = MO.getReg();
554         if (Subtarget->hasSPE()) {
555           if (PPC::F4RCRegClass.contains(Reg) ||
556               PPC::F8RCRegClass.contains(Reg) ||
557               PPC::QBRCRegClass.contains(Reg) ||
558               PPC::QFRCRegClass.contains(Reg) ||
559               PPC::QSRCRegClass.contains(Reg) ||
560               PPC::VFRCRegClass.contains(Reg) ||
561               PPC::VRRCRegClass.contains(Reg) ||
562               PPC::VSFRCRegClass.contains(Reg) ||
563               PPC::VSSRCRegClass.contains(Reg)
564               )
565             llvm_unreachable("SPE targets cannot have FPRegs!");
566         } else {
567           if (PPC::SPERCRegClass.contains(Reg))
568             llvm_unreachable("SPE register found in FPU-targeted code!");
569         }
570       }
571     }
572   }
573 #endif
574   // Lower multi-instruction pseudo operations.
575   switch (MI->getOpcode()) {
576   default: break;
577   case TargetOpcode::DBG_VALUE:
578     llvm_unreachable("Should be handled target independently");
579   case TargetOpcode::STACKMAP:
580     return LowerSTACKMAP(SM, *MI);
581   case TargetOpcode::PATCHPOINT:
582     return LowerPATCHPOINT(SM, *MI);
583 
584   case PPC::MoveGOTtoLR: {
585     // Transform %lr = MoveGOTtoLR
586     // Into this: bl _GLOBAL_OFFSET_TABLE_@local-4
587     // _GLOBAL_OFFSET_TABLE_@local-4 (instruction preceding
588     // _GLOBAL_OFFSET_TABLE_) has exactly one instruction:
589     //      blrl
590     // This will return the pointer to _GLOBAL_OFFSET_TABLE_@local
591     MCSymbol *GOTSymbol =
592       OutContext.getOrCreateSymbol(StringRef("_GLOBAL_OFFSET_TABLE_"));
593     const MCExpr *OffsExpr =
594       MCBinaryExpr::createSub(MCSymbolRefExpr::create(GOTSymbol,
595                                                       MCSymbolRefExpr::VK_PPC_LOCAL,
596                                                       OutContext),
597                               MCConstantExpr::create(4, OutContext),
598                               OutContext);
599 
600     // Emit the 'bl'.
601     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::BL).addExpr(OffsExpr));
602     return;
603   }
604   case PPC::MovePCtoLR:
605   case PPC::MovePCtoLR8: {
606     // Transform %lr = MovePCtoLR
607     // Into this, where the label is the PIC base:
608     //     bl L1$pb
609     // L1$pb:
610     MCSymbol *PICBase = MF->getPICBaseSymbol();
611 
612     // Emit the 'bl'.
613     EmitToStreamer(*OutStreamer,
614                    MCInstBuilder(PPC::BL)
615                        // FIXME: We would like an efficient form for this, so we
616                        // don't have to do a lot of extra uniquing.
617                        .addExpr(MCSymbolRefExpr::create(PICBase, OutContext)));
618 
619     // Emit the label.
620     OutStreamer->EmitLabel(PICBase);
621     return;
622   }
623   case PPC::UpdateGBR: {
624     // Transform %rd = UpdateGBR(%rt, %ri)
625     // Into: lwz %rt, .L0$poff - .L0$pb(%ri)
626     //       add %rd, %rt, %ri
627     // or into (if secure plt mode is on):
628     //       addis r30, r30, {.LTOC,_GLOBAL_OFFSET_TABLE} - .L0$pb@ha
629     //       addi r30, r30, {.LTOC,_GLOBAL_OFFSET_TABLE} - .L0$pb@l
630     // Get the offset from the GOT Base Register to the GOT
631     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
632     if (Subtarget->isSecurePlt() && isPositionIndependent() ) {
633       unsigned PICR = TmpInst.getOperand(0).getReg();
634       MCSymbol *BaseSymbol = OutContext.getOrCreateSymbol(
635           M->getPICLevel() == PICLevel::SmallPIC ? "_GLOBAL_OFFSET_TABLE_"
636                                                  : ".LTOC");
637       const MCExpr *PB =
638           MCSymbolRefExpr::create(MF->getPICBaseSymbol(), OutContext);
639 
640       const MCExpr *DeltaExpr = MCBinaryExpr::createSub(
641           MCSymbolRefExpr::create(BaseSymbol, OutContext), PB, OutContext);
642 
643       const MCExpr *DeltaHi = PPCMCExpr::createHa(DeltaExpr, false, OutContext);
644       EmitToStreamer(
645           *OutStreamer,
646           MCInstBuilder(PPC::ADDIS).addReg(PICR).addReg(PICR).addExpr(DeltaHi));
647 
648       const MCExpr *DeltaLo = PPCMCExpr::createLo(DeltaExpr, false, OutContext);
649       EmitToStreamer(
650           *OutStreamer,
651           MCInstBuilder(PPC::ADDI).addReg(PICR).addReg(PICR).addExpr(DeltaLo));
652       return;
653     } else {
654       MCSymbol *PICOffset =
655         MF->getInfo<PPCFunctionInfo>()->getPICOffsetSymbol();
656       TmpInst.setOpcode(PPC::LWZ);
657       const MCExpr *Exp =
658         MCSymbolRefExpr::create(PICOffset, MCSymbolRefExpr::VK_None, OutContext);
659       const MCExpr *PB =
660         MCSymbolRefExpr::create(MF->getPICBaseSymbol(),
661                                 MCSymbolRefExpr::VK_None,
662                                 OutContext);
663       const MCOperand TR = TmpInst.getOperand(1);
664       const MCOperand PICR = TmpInst.getOperand(0);
665 
666       // Step 1: lwz %rt, .L$poff - .L$pb(%ri)
667       TmpInst.getOperand(1) =
668           MCOperand::createExpr(MCBinaryExpr::createSub(Exp, PB, OutContext));
669       TmpInst.getOperand(0) = TR;
670       TmpInst.getOperand(2) = PICR;
671       EmitToStreamer(*OutStreamer, TmpInst);
672 
673       TmpInst.setOpcode(PPC::ADD4);
674       TmpInst.getOperand(0) = PICR;
675       TmpInst.getOperand(1) = TR;
676       TmpInst.getOperand(2) = PICR;
677       EmitToStreamer(*OutStreamer, TmpInst);
678       return;
679     }
680   }
681   case PPC::RETGUARD_LOAD_PC: {
682     unsigned DEST = MI->getOperand(0).getReg();
683     unsigned LR  = MI->getOperand(1).getReg();
684     MCSymbol *HereSym = MI->getOperand(2).getMCSymbol();
685 
686     unsigned MTLR = PPC::MTLR;
687     unsigned MFLR = PPC::MFLR;
688     unsigned BL   = PPC::BL;
689     if (Subtarget->isPPC64()) {
690       MTLR = PPC::MTLR8;
691       MFLR = PPC::MFLR8;
692       BL   = PPC::BL8;
693     }
694 
695     // Cache the current LR
696     EmitToStreamer(*OutStreamer, MCInstBuilder(MFLR)
697                                  .addReg(LR));
698 
699     // Create the BL forward
700     const MCExpr *HereExpr = MCSymbolRefExpr::create(HereSym, OutContext);
701     EmitToStreamer(*OutStreamer, MCInstBuilder(BL)
702                                  .addExpr(HereExpr));
703     OutStreamer->EmitLabel(HereSym);
704 
705     // Grab the result
706     EmitToStreamer(*OutStreamer, MCInstBuilder(MFLR)
707                                  .addReg(DEST));
708     // Restore LR
709     EmitToStreamer(*OutStreamer, MCInstBuilder(MTLR)
710                                  .addReg(LR));
711     return;
712   }
713   case PPC::RETGUARD_LOAD_GOT: {
714     if (Subtarget->isSecurePlt() && isPositionIndependent() ) {
715       StringRef GOTName = (PL == PICLevel::SmallPIC ?
716                                  "_GLOBAL_OFFSET_TABLE_" : ".LTOC");
717       unsigned DEST     = MI->getOperand(0).getReg();
718       unsigned HERE     = MI->getOperand(1).getReg();
719       MCSymbol *HereSym = MI->getOperand(2).getMCSymbol();
720       MCSymbol *GOTSym  = OutContext.getOrCreateSymbol(GOTName);
721       const MCExpr *HereExpr = MCSymbolRefExpr::create(HereSym, OutContext);
722       const MCExpr *GOTExpr  = MCSymbolRefExpr::create(GOTSym, OutContext);
723 
724       // Get offset from Here to GOT
725       const MCExpr *GOTDeltaExpr =
726         MCBinaryExpr::createSub(GOTExpr, HereExpr, OutContext);
727       const MCExpr *GOTDeltaHi =
728         PPCMCExpr::createHa(GOTDeltaExpr, false, OutContext);
729       const MCExpr *GOTDeltaLo =
730         PPCMCExpr::createLo(GOTDeltaExpr, false, OutContext);
731 
732       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDIS)
733                                    .addReg(DEST)
734                                    .addReg(HERE)
735                                    .addExpr(GOTDeltaHi));
736       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDI)
737                                    .addReg(DEST)
738                                    .addReg(DEST)
739                                    .addExpr(GOTDeltaLo));
740     }
741     return;
742   }
743   case PPC::RETGUARD_LOAD_COOKIE: {
744     unsigned DEST       = MI->getOperand(0).getReg();
745     MCSymbol *CookieSym = getSymbol(MI->getOperand(1).getGlobal());
746     const MCExpr *CookieExprHa = MCSymbolRefExpr::create(
747         CookieSym, MCSymbolRefExpr::VK_PPC_HA, OutContext);
748     const MCExpr *CookieExprLo = MCSymbolRefExpr::create(
749         CookieSym, MCSymbolRefExpr::VK_PPC_LO, OutContext);
750 
751     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LIS)
752                                  .addReg(DEST)
753                                  .addExpr(CookieExprHa));
754     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LWZ)
755                                  .addReg(DEST)
756                                  .addExpr(CookieExprLo)
757                                  .addReg(DEST));
758     return;
759   }
760   case PPC::LWZtoc: {
761     assert(!IsDarwin && "TOC is an ELF/XCOFF construct.");
762 
763     // Transform %rN = LWZtoc @op1, %r2
764     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
765 
766     // Change the opcode to LWZ.
767     TmpInst.setOpcode(PPC::LWZ);
768 
769     const MachineOperand &MO = MI->getOperand(1);
770     assert((MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isBlockAddress()) &&
771            "Invalid operand for LWZtoc.");
772 
773     // Map the operand to its corresponding MCSymbol.
774     const MCSymbol *const MOSymbol = getMCSymbolForTOCPseudoMO(MO);
775 
776     // Create a reference to the GOT entry for the symbol. The GOT entry will be
777     // synthesized later.
778     if (PL == PICLevel::SmallPIC && !IsAIX) {
779       const MCExpr *Exp =
780         MCSymbolRefExpr::create(MOSymbol, MCSymbolRefExpr::VK_GOT,
781                                 OutContext);
782       TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
783       EmitToStreamer(*OutStreamer, TmpInst);
784       return;
785     }
786 
787     // Otherwise, use the TOC. 'TOCEntry' is a label used to reference the
788     // storage allocated in the TOC which contains the address of
789     // 'MOSymbol'. Said TOC entry will be synthesized later.
790     MCSymbol *TOCEntry = lookUpOrCreateTOCEntry(MOSymbol);
791     const MCExpr *Exp =
792         MCSymbolRefExpr::create(TOCEntry, MCSymbolRefExpr::VK_None, OutContext);
793 
794     // AIX uses the label directly as the lwz displacement operand for
795     // references into the toc section. The displacement value will be generated
796     // relative to the toc-base.
797     if (IsAIX) {
798       assert(
799           TM.getCodeModel() == CodeModel::Small &&
800           "This pseudo should only be selected for 32-bit small code model.");
801       TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
802       EmitToStreamer(*OutStreamer, TmpInst);
803       return;
804     }
805 
806     // Create an explicit subtract expression between the local symbol and
807     // '.LTOC' to manifest the toc-relative offset.
808     const MCExpr *PB = MCSymbolRefExpr::create(
809         OutContext.getOrCreateSymbol(Twine(".LTOC")), OutContext);
810     Exp = MCBinaryExpr::createSub(Exp, PB, OutContext);
811     TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
812     EmitToStreamer(*OutStreamer, TmpInst);
813     return;
814   }
815   case PPC::LDtocJTI:
816   case PPC::LDtocCPT:
817   case PPC::LDtocBA:
818   case PPC::LDtoc: {
819     assert(!IsDarwin && "TOC is an ELF/XCOFF construct");
820 
821     // Transform %x3 = LDtoc @min1, %x2
822     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
823 
824     // Change the opcode to LD.
825     TmpInst.setOpcode(PPC::LD);
826 
827     const MachineOperand &MO = MI->getOperand(1);
828     assert((MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isBlockAddress()) &&
829            "Invalid operand!");
830 
831     // Map the machine operand to its corresponding MCSymbol, then map the
832     // global address operand to be a reference to the TOC entry we will
833     // synthesize later.
834     MCSymbol *TOCEntry =
835         lookUpOrCreateTOCEntry(getMCSymbolForTOCPseudoMO(MO));
836 
837     const MCSymbolRefExpr::VariantKind VK =
838         IsAIX ? MCSymbolRefExpr::VK_None : MCSymbolRefExpr::VK_PPC_TOC;
839     const MCExpr *Exp =
840         MCSymbolRefExpr::create(TOCEntry, VK, OutContext);
841     TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
842     EmitToStreamer(*OutStreamer, TmpInst);
843     return;
844   }
845   case PPC::ADDIStocHA: {
846     assert((IsAIX && !IsPPC64 && TM.getCodeModel() == CodeModel::Large) &&
847            "This pseudo should only be selected for 32-bit large code model on"
848            " AIX.");
849 
850     // Transform %rd = ADDIStocHA %rA, @sym(%r2)
851     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
852 
853     // Change the opcode to ADDIS.
854     TmpInst.setOpcode(PPC::ADDIS);
855 
856     const MachineOperand &MO = MI->getOperand(2);
857     assert((MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isBlockAddress()) &&
858            "Invalid operand for ADDIStocHA.");
859 
860     // Map the machine operand to its corresponding MCSymbol.
861     MCSymbol *MOSymbol = getMCSymbolForTOCPseudoMO(MO);
862 
863     // Always use TOC on AIX. Map the global address operand to be a reference
864     // to the TOC entry we will synthesize later. 'TOCEntry' is a label used to
865     // reference the storage allocated in the TOC which contains the address of
866     // 'MOSymbol'.
867     MCSymbol *TOCEntry = lookUpOrCreateTOCEntry(MOSymbol);
868     const MCExpr *Exp = MCSymbolRefExpr::create(TOCEntry,
869                                                 MCSymbolRefExpr::VK_PPC_U,
870                                                 OutContext);
871     TmpInst.getOperand(2) = MCOperand::createExpr(Exp);
872     EmitToStreamer(*OutStreamer, TmpInst);
873     return;
874   }
875   case PPC::LWZtocL: {
876     assert(IsAIX && !IsPPC64 && TM.getCodeModel() == CodeModel::Large &&
877            "This pseudo should only be selected for 32-bit large code model on"
878            " AIX.");
879 
880     // Transform %rd = LWZtocL @sym, %rs.
881     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
882 
883     // Change the opcode to lwz.
884     TmpInst.setOpcode(PPC::LWZ);
885 
886     const MachineOperand &MO = MI->getOperand(1);
887     assert((MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isBlockAddress()) &&
888            "Invalid operand for LWZtocL.");
889 
890     // Map the machine operand to its corresponding MCSymbol.
891     MCSymbol *MOSymbol = getMCSymbolForTOCPseudoMO(MO);
892 
893     // Always use TOC on AIX. Map the global address operand to be a reference
894     // to the TOC entry we will synthesize later. 'TOCEntry' is a label used to
895     // reference the storage allocated in the TOC which contains the address of
896     // 'MOSymbol'.
897     MCSymbol *TOCEntry = lookUpOrCreateTOCEntry(MOSymbol);
898     const MCExpr *Exp = MCSymbolRefExpr::create(TOCEntry,
899                                                 MCSymbolRefExpr::VK_PPC_L,
900                                                 OutContext);
901     TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
902     EmitToStreamer(*OutStreamer, TmpInst);
903     return;
904   }
905   case PPC::ADDIStocHA8: {
906     assert(!IsDarwin && "TOC is an ELF/XCOFF construct");
907 
908     // Transform %xd = ADDIStocHA8 %x2, @sym
909     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
910 
911     // Change the opcode to ADDIS8. If the global address is the address of
912     // an external symbol, is a jump table address, is a block address, or is a
913     // constant pool index with large code model enabled, then generate a TOC
914     // entry and reference that. Otherwise, reference the symbol directly.
915     TmpInst.setOpcode(PPC::ADDIS8);
916 
917     const MachineOperand &MO = MI->getOperand(2);
918     assert((MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isBlockAddress()) &&
919            "Invalid operand for ADDIStocHA8!");
920 
921     const MCSymbol *MOSymbol = getMCSymbolForTOCPseudoMO(MO);
922 
923     const bool GlobalToc =
924         MO.isGlobal() && Subtarget->isGVIndirectSymbol(MO.getGlobal());
925     if (GlobalToc || MO.isJTI() || MO.isBlockAddress() ||
926         (MO.isCPI() && TM.getCodeModel() == CodeModel::Large))
927       MOSymbol = lookUpOrCreateTOCEntry(MOSymbol);
928 
929     const MCSymbolRefExpr::VariantKind VK =
930         IsAIX ? MCSymbolRefExpr::VK_PPC_U : MCSymbolRefExpr::VK_PPC_TOC_HA;
931 
932     const MCExpr *Exp =
933         MCSymbolRefExpr::create(MOSymbol, VK, OutContext);
934 
935     if (!MO.isJTI() && MO.getOffset())
936       Exp = MCBinaryExpr::createAdd(Exp,
937                                     MCConstantExpr::create(MO.getOffset(),
938                                                            OutContext),
939                                     OutContext);
940 
941     TmpInst.getOperand(2) = MCOperand::createExpr(Exp);
942     EmitToStreamer(*OutStreamer, TmpInst);
943     return;
944   }
945   case PPC::LDtocL: {
946     assert(!IsDarwin && "TOC is an ELF/XCOFF construct");
947 
948     // Transform %xd = LDtocL @sym, %xs
949     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
950 
951     // Change the opcode to LD. If the global address is the address of
952     // an external symbol, is a jump table address, is a block address, or is
953     // a constant pool index with large code model enabled, then generate a
954     // TOC entry and reference that. Otherwise, reference the symbol directly.
955     TmpInst.setOpcode(PPC::LD);
956 
957     const MachineOperand &MO = MI->getOperand(1);
958     assert((MO.isGlobal() || MO.isCPI() || MO.isJTI() ||
959             MO.isBlockAddress()) &&
960            "Invalid operand for LDtocL!");
961 
962     LLVM_DEBUG(assert(
963         (!MO.isGlobal() || Subtarget->isGVIndirectSymbol(MO.getGlobal())) &&
964         "LDtocL used on symbol that could be accessed directly is "
965         "invalid. Must match ADDIStocHA8."));
966 
967     const MCSymbol *MOSymbol = getMCSymbolForTOCPseudoMO(MO);
968 
969     if (!MO.isCPI() || TM.getCodeModel() == CodeModel::Large)
970       MOSymbol = lookUpOrCreateTOCEntry(MOSymbol);
971 
972     const MCSymbolRefExpr::VariantKind VK =
973         IsAIX ? MCSymbolRefExpr::VK_PPC_L : MCSymbolRefExpr::VK_PPC_TOC_LO;
974     const MCExpr *Exp =
975         MCSymbolRefExpr::create(MOSymbol, VK, OutContext);
976     TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
977     EmitToStreamer(*OutStreamer, TmpInst);
978     return;
979   }
980   case PPC::ADDItocL: {
981     // Transform %xd = ADDItocL %xs, @sym
982     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
983 
984     // Change the opcode to ADDI8. If the global address is external, then
985     // generate a TOC entry and reference that. Otherwise, reference the
986     // symbol directly.
987     TmpInst.setOpcode(PPC::ADDI8);
988 
989     const MachineOperand &MO = MI->getOperand(2);
990     assert((MO.isGlobal() || MO.isCPI()) && "Invalid operand for ADDItocL.");
991 
992     LLVM_DEBUG(assert(
993         !(MO.isGlobal() && Subtarget->isGVIndirectSymbol(MO.getGlobal())) &&
994         "Interposable definitions must use indirect access."));
995 
996     const MCExpr *Exp =
997         MCSymbolRefExpr::create(getMCSymbolForTOCPseudoMO(MO),
998                                 MCSymbolRefExpr::VK_PPC_TOC_LO, OutContext);
999     TmpInst.getOperand(2) = MCOperand::createExpr(Exp);
1000     EmitToStreamer(*OutStreamer, TmpInst);
1001     return;
1002   }
1003   case PPC::ADDISgotTprelHA: {
1004     // Transform: %xd = ADDISgotTprelHA %x2, @sym
1005     // Into:      %xd = ADDIS8 %x2, sym@got@tlsgd@ha
1006     assert(IsPPC64 && "Not supported for 32-bit PowerPC");
1007     const MachineOperand &MO = MI->getOperand(2);
1008     const GlobalValue *GValue = MO.getGlobal();
1009     MCSymbol *MOSymbol = getSymbol(GValue);
1010     const MCExpr *SymGotTprel =
1011         MCSymbolRefExpr::create(MOSymbol, MCSymbolRefExpr::VK_PPC_GOT_TPREL_HA,
1012                                 OutContext);
1013     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDIS8)
1014                                  .addReg(MI->getOperand(0).getReg())
1015                                  .addReg(MI->getOperand(1).getReg())
1016                                  .addExpr(SymGotTprel));
1017     return;
1018   }
1019   case PPC::LDgotTprelL:
1020   case PPC::LDgotTprelL32: {
1021     // Transform %xd = LDgotTprelL @sym, %xs
1022     LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
1023 
1024     // Change the opcode to LD.
1025     TmpInst.setOpcode(IsPPC64 ? PPC::LD : PPC::LWZ);
1026     const MachineOperand &MO = MI->getOperand(1);
1027     const GlobalValue *GValue = MO.getGlobal();
1028     MCSymbol *MOSymbol = getSymbol(GValue);
1029     const MCExpr *Exp = MCSymbolRefExpr::create(
1030         MOSymbol, IsPPC64 ? MCSymbolRefExpr::VK_PPC_GOT_TPREL_LO
1031                           : MCSymbolRefExpr::VK_PPC_GOT_TPREL,
1032         OutContext);
1033     TmpInst.getOperand(1) = MCOperand::createExpr(Exp);
1034     EmitToStreamer(*OutStreamer, TmpInst);
1035     return;
1036   }
1037 
1038   case PPC::PPC32PICGOT: {
1039     MCSymbol *GOTSymbol = OutContext.getOrCreateSymbol(StringRef("_GLOBAL_OFFSET_TABLE_"));
1040     MCSymbol *GOTRef = OutContext.createTempSymbol();
1041     MCSymbol *NextInstr = OutContext.createTempSymbol();
1042 
1043     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::BL)
1044       // FIXME: We would like an efficient form for this, so we don't have to do
1045       // a lot of extra uniquing.
1046       .addExpr(MCSymbolRefExpr::create(NextInstr, OutContext)));
1047     const MCExpr *OffsExpr =
1048       MCBinaryExpr::createSub(MCSymbolRefExpr::create(GOTSymbol, OutContext),
1049                                 MCSymbolRefExpr::create(GOTRef, OutContext),
1050         OutContext);
1051     OutStreamer->EmitLabel(GOTRef);
1052     OutStreamer->EmitValue(OffsExpr, 4);
1053     OutStreamer->EmitLabel(NextInstr);
1054     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::MFLR)
1055                                  .addReg(MI->getOperand(0).getReg()));
1056     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LWZ)
1057                                  .addReg(MI->getOperand(1).getReg())
1058                                  .addImm(0)
1059                                  .addReg(MI->getOperand(0).getReg()));
1060     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADD4)
1061                                  .addReg(MI->getOperand(0).getReg())
1062                                  .addReg(MI->getOperand(1).getReg())
1063                                  .addReg(MI->getOperand(0).getReg()));
1064     return;
1065   }
1066   case PPC::PPC32GOT: {
1067     MCSymbol *GOTSymbol =
1068         OutContext.getOrCreateSymbol(StringRef("_GLOBAL_OFFSET_TABLE_"));
1069     const MCExpr *SymGotTlsL = MCSymbolRefExpr::create(
1070         GOTSymbol, MCSymbolRefExpr::VK_PPC_LO, OutContext);
1071     const MCExpr *SymGotTlsHA = MCSymbolRefExpr::create(
1072         GOTSymbol, MCSymbolRefExpr::VK_PPC_HA, OutContext);
1073     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LI)
1074                                  .addReg(MI->getOperand(0).getReg())
1075                                  .addExpr(SymGotTlsL));
1076     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDIS)
1077                                  .addReg(MI->getOperand(0).getReg())
1078                                  .addReg(MI->getOperand(0).getReg())
1079                                  .addExpr(SymGotTlsHA));
1080     return;
1081   }
1082   case PPC::ADDIStlsgdHA: {
1083     // Transform: %xd = ADDIStlsgdHA %x2, @sym
1084     // Into:      %xd = ADDIS8 %x2, sym@got@tlsgd@ha
1085     assert(IsPPC64 && "Not supported for 32-bit PowerPC");
1086     const MachineOperand &MO = MI->getOperand(2);
1087     const GlobalValue *GValue = MO.getGlobal();
1088     MCSymbol *MOSymbol = getSymbol(GValue);
1089     const MCExpr *SymGotTlsGD =
1090       MCSymbolRefExpr::create(MOSymbol, MCSymbolRefExpr::VK_PPC_GOT_TLSGD_HA,
1091                               OutContext);
1092     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDIS8)
1093                                  .addReg(MI->getOperand(0).getReg())
1094                                  .addReg(MI->getOperand(1).getReg())
1095                                  .addExpr(SymGotTlsGD));
1096     return;
1097   }
1098   case PPC::ADDItlsgdL:
1099     // Transform: %xd = ADDItlsgdL %xs, @sym
1100     // Into:      %xd = ADDI8 %xs, sym@got@tlsgd@l
1101   case PPC::ADDItlsgdL32: {
1102     // Transform: %rd = ADDItlsgdL32 %rs, @sym
1103     // Into:      %rd = ADDI %rs, sym@got@tlsgd
1104     const MachineOperand &MO = MI->getOperand(2);
1105     const GlobalValue *GValue = MO.getGlobal();
1106     MCSymbol *MOSymbol = getSymbol(GValue);
1107     const MCExpr *SymGotTlsGD = MCSymbolRefExpr::create(
1108         MOSymbol, IsPPC64 ? MCSymbolRefExpr::VK_PPC_GOT_TLSGD_LO
1109                           : MCSymbolRefExpr::VK_PPC_GOT_TLSGD,
1110         OutContext);
1111     EmitToStreamer(*OutStreamer,
1112                    MCInstBuilder(IsPPC64 ? PPC::ADDI8 : PPC::ADDI)
1113                    .addReg(MI->getOperand(0).getReg())
1114                    .addReg(MI->getOperand(1).getReg())
1115                    .addExpr(SymGotTlsGD));
1116     return;
1117   }
1118   case PPC::GETtlsADDR:
1119     // Transform: %x3 = GETtlsADDR %x3, @sym
1120     // Into: BL8_NOP_TLS __tls_get_addr(sym at tlsgd)
1121   case PPC::GETtlsADDR32: {
1122     // Transform: %r3 = GETtlsADDR32 %r3, @sym
1123     // Into: BL_TLS __tls_get_addr(sym at tlsgd)@PLT
1124     EmitTlsCall(MI, MCSymbolRefExpr::VK_PPC_TLSGD);
1125     return;
1126   }
1127   case PPC::ADDIStlsldHA: {
1128     // Transform: %xd = ADDIStlsldHA %x2, @sym
1129     // Into:      %xd = ADDIS8 %x2, sym@got@tlsld@ha
1130     assert(IsPPC64 && "Not supported for 32-bit PowerPC");
1131     const MachineOperand &MO = MI->getOperand(2);
1132     const GlobalValue *GValue = MO.getGlobal();
1133     MCSymbol *MOSymbol = getSymbol(GValue);
1134     const MCExpr *SymGotTlsLD =
1135       MCSymbolRefExpr::create(MOSymbol, MCSymbolRefExpr::VK_PPC_GOT_TLSLD_HA,
1136                               OutContext);
1137     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDIS8)
1138                                  .addReg(MI->getOperand(0).getReg())
1139                                  .addReg(MI->getOperand(1).getReg())
1140                                  .addExpr(SymGotTlsLD));
1141     return;
1142   }
1143   case PPC::ADDItlsldL:
1144     // Transform: %xd = ADDItlsldL %xs, @sym
1145     // Into:      %xd = ADDI8 %xs, sym@got@tlsld@l
1146   case PPC::ADDItlsldL32: {
1147     // Transform: %rd = ADDItlsldL32 %rs, @sym
1148     // Into:      %rd = ADDI %rs, sym@got@tlsld
1149     const MachineOperand &MO = MI->getOperand(2);
1150     const GlobalValue *GValue = MO.getGlobal();
1151     MCSymbol *MOSymbol = getSymbol(GValue);
1152     const MCExpr *SymGotTlsLD = MCSymbolRefExpr::create(
1153         MOSymbol, IsPPC64 ? MCSymbolRefExpr::VK_PPC_GOT_TLSLD_LO
1154                           : MCSymbolRefExpr::VK_PPC_GOT_TLSLD,
1155         OutContext);
1156     EmitToStreamer(*OutStreamer,
1157                    MCInstBuilder(IsPPC64 ? PPC::ADDI8 : PPC::ADDI)
1158                        .addReg(MI->getOperand(0).getReg())
1159                        .addReg(MI->getOperand(1).getReg())
1160                        .addExpr(SymGotTlsLD));
1161     return;
1162   }
1163   case PPC::GETtlsldADDR:
1164     // Transform: %x3 = GETtlsldADDR %x3, @sym
1165     // Into: BL8_NOP_TLS __tls_get_addr(sym at tlsld)
1166   case PPC::GETtlsldADDR32: {
1167     // Transform: %r3 = GETtlsldADDR32 %r3, @sym
1168     // Into: BL_TLS __tls_get_addr(sym at tlsld)@PLT
1169     EmitTlsCall(MI, MCSymbolRefExpr::VK_PPC_TLSLD);
1170     return;
1171   }
1172   case PPC::ADDISdtprelHA:
1173     // Transform: %xd = ADDISdtprelHA %xs, @sym
1174     // Into:      %xd = ADDIS8 %xs, sym@dtprel@ha
1175   case PPC::ADDISdtprelHA32: {
1176     // Transform: %rd = ADDISdtprelHA32 %rs, @sym
1177     // Into:      %rd = ADDIS %rs, sym@dtprel@ha
1178     const MachineOperand &MO = MI->getOperand(2);
1179     const GlobalValue *GValue = MO.getGlobal();
1180     MCSymbol *MOSymbol = getSymbol(GValue);
1181     const MCExpr *SymDtprel =
1182       MCSymbolRefExpr::create(MOSymbol, MCSymbolRefExpr::VK_PPC_DTPREL_HA,
1183                               OutContext);
1184     EmitToStreamer(
1185         *OutStreamer,
1186         MCInstBuilder(IsPPC64 ? PPC::ADDIS8 : PPC::ADDIS)
1187             .addReg(MI->getOperand(0).getReg())
1188             .addReg(MI->getOperand(1).getReg())
1189             .addExpr(SymDtprel));
1190     return;
1191   }
1192   case PPC::ADDIdtprelL:
1193     // Transform: %xd = ADDIdtprelL %xs, @sym
1194     // Into:      %xd = ADDI8 %xs, sym@dtprel@l
1195   case PPC::ADDIdtprelL32: {
1196     // Transform: %rd = ADDIdtprelL32 %rs, @sym
1197     // Into:      %rd = ADDI %rs, sym@dtprel@l
1198     const MachineOperand &MO = MI->getOperand(2);
1199     const GlobalValue *GValue = MO.getGlobal();
1200     MCSymbol *MOSymbol = getSymbol(GValue);
1201     const MCExpr *SymDtprel =
1202       MCSymbolRefExpr::create(MOSymbol, MCSymbolRefExpr::VK_PPC_DTPREL_LO,
1203                               OutContext);
1204     EmitToStreamer(*OutStreamer,
1205                    MCInstBuilder(IsPPC64 ? PPC::ADDI8 : PPC::ADDI)
1206                        .addReg(MI->getOperand(0).getReg())
1207                        .addReg(MI->getOperand(1).getReg())
1208                        .addExpr(SymDtprel));
1209     return;
1210   }
1211   case PPC::MFOCRF:
1212   case PPC::MFOCRF8:
1213     if (!Subtarget->hasMFOCRF()) {
1214       // Transform: %r3 = MFOCRF %cr7
1215       // Into:      %r3 = MFCR   ;; cr7
1216       unsigned NewOpcode =
1217         MI->getOpcode() == PPC::MFOCRF ? PPC::MFCR : PPC::MFCR8;
1218       OutStreamer->AddComment(PPCInstPrinter::
1219                               getRegisterName(MI->getOperand(1).getReg()));
1220       EmitToStreamer(*OutStreamer, MCInstBuilder(NewOpcode)
1221                                   .addReg(MI->getOperand(0).getReg()));
1222       return;
1223     }
1224     break;
1225   case PPC::MTOCRF:
1226   case PPC::MTOCRF8:
1227     if (!Subtarget->hasMFOCRF()) {
1228       // Transform: %cr7 = MTOCRF %r3
1229       // Into:      MTCRF mask, %r3 ;; cr7
1230       unsigned NewOpcode =
1231         MI->getOpcode() == PPC::MTOCRF ? PPC::MTCRF : PPC::MTCRF8;
1232       unsigned Mask = 0x80 >> OutContext.getRegisterInfo()
1233                               ->getEncodingValue(MI->getOperand(0).getReg());
1234       OutStreamer->AddComment(PPCInstPrinter::
1235                               getRegisterName(MI->getOperand(0).getReg()));
1236       EmitToStreamer(*OutStreamer, MCInstBuilder(NewOpcode)
1237                                      .addImm(Mask)
1238                                      .addReg(MI->getOperand(1).getReg()));
1239       return;
1240     }
1241     break;
1242   case PPC::LD:
1243   case PPC::STD:
1244   case PPC::LWA_32:
1245   case PPC::LWA: {
1246     // Verify alignment is legal, so we don't create relocations
1247     // that can't be supported.
1248     // FIXME:  This test is currently disabled for Darwin.  The test
1249     // suite shows a handful of test cases that fail this check for
1250     // Darwin.  Those need to be investigated before this sanity test
1251     // can be enabled for those subtargets.
1252     if (!IsDarwin) {
1253       unsigned OpNum = (MI->getOpcode() == PPC::STD) ? 2 : 1;
1254       const MachineOperand &MO = MI->getOperand(OpNum);
1255       if (MO.isGlobal() && MO.getGlobal()->getAlignment() < 4)
1256         llvm_unreachable("Global must be word-aligned for LD, STD, LWA!");
1257     }
1258     // Now process the instruction normally.
1259     break;
1260   }
1261   }
1262 
1263   LowerPPCMachineInstrToMCInst(MI, TmpInst, *this, IsDarwin);
1264   EmitToStreamer(*OutStreamer, TmpInst);
1265 }
1266 
1267 void PPCLinuxAsmPrinter::EmitInstruction(const MachineInstr *MI) {
1268   if (!Subtarget->isPPC64())
1269     return PPCAsmPrinter::EmitInstruction(MI);
1270 
1271   switch (MI->getOpcode()) {
1272   default:
1273     return PPCAsmPrinter::EmitInstruction(MI);
1274   case TargetOpcode::PATCHABLE_FUNCTION_ENTER: {
1275     // .begin:
1276     //   b .end # lis 0, FuncId[16..32]
1277     //   nop    # li  0, FuncId[0..15]
1278     //   std 0, -8(1)
1279     //   mflr 0
1280     //   bl __xray_FunctionEntry
1281     //   mtlr 0
1282     // .end:
1283     //
1284     // Update compiler-rt/lib/xray/xray_powerpc64.cc accordingly when number
1285     // of instructions change.
1286     MCSymbol *BeginOfSled = OutContext.createTempSymbol();
1287     MCSymbol *EndOfSled = OutContext.createTempSymbol();
1288     OutStreamer->EmitLabel(BeginOfSled);
1289     EmitToStreamer(*OutStreamer,
1290                    MCInstBuilder(PPC::B).addExpr(
1291                        MCSymbolRefExpr::create(EndOfSled, OutContext)));
1292     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::NOP));
1293     EmitToStreamer(
1294         *OutStreamer,
1295         MCInstBuilder(PPC::STD).addReg(PPC::X0).addImm(-8).addReg(PPC::X1));
1296     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::MFLR8).addReg(PPC::X0));
1297     EmitToStreamer(*OutStreamer,
1298                    MCInstBuilder(PPC::BL8_NOP)
1299                        .addExpr(MCSymbolRefExpr::create(
1300                            OutContext.getOrCreateSymbol("__xray_FunctionEntry"),
1301                            OutContext)));
1302     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::MTLR8).addReg(PPC::X0));
1303     OutStreamer->EmitLabel(EndOfSled);
1304     recordSled(BeginOfSled, *MI, SledKind::FUNCTION_ENTER);
1305     break;
1306   }
1307   case TargetOpcode::PATCHABLE_RET: {
1308     unsigned RetOpcode = MI->getOperand(0).getImm();
1309     MCInst RetInst;
1310     RetInst.setOpcode(RetOpcode);
1311     for (const auto &MO :
1312          make_range(std::next(MI->operands_begin()), MI->operands_end())) {
1313       MCOperand MCOp;
1314       if (LowerPPCMachineOperandToMCOperand(MO, MCOp, *this, false))
1315         RetInst.addOperand(MCOp);
1316     }
1317 
1318     bool IsConditional;
1319     if (RetOpcode == PPC::BCCLR) {
1320       IsConditional = true;
1321     } else if (RetOpcode == PPC::TCRETURNdi8 || RetOpcode == PPC::TCRETURNri8 ||
1322                RetOpcode == PPC::TCRETURNai8) {
1323       break;
1324     } else if (RetOpcode == PPC::BLR8 || RetOpcode == PPC::TAILB8) {
1325       IsConditional = false;
1326     } else {
1327       EmitToStreamer(*OutStreamer, RetInst);
1328       break;
1329     }
1330 
1331     MCSymbol *FallthroughLabel;
1332     if (IsConditional) {
1333       // Before:
1334       //   bgtlr cr0
1335       //
1336       // After:
1337       //   ble cr0, .end
1338       // .p2align 3
1339       // .begin:
1340       //   blr    # lis 0, FuncId[16..32]
1341       //   nop    # li  0, FuncId[0..15]
1342       //   std 0, -8(1)
1343       //   mflr 0
1344       //   bl __xray_FunctionExit
1345       //   mtlr 0
1346       //   blr
1347       // .end:
1348       //
1349       // Update compiler-rt/lib/xray/xray_powerpc64.cc accordingly when number
1350       // of instructions change.
1351       FallthroughLabel = OutContext.createTempSymbol();
1352       EmitToStreamer(
1353           *OutStreamer,
1354           MCInstBuilder(PPC::BCC)
1355               .addImm(PPC::InvertPredicate(
1356                   static_cast<PPC::Predicate>(MI->getOperand(1).getImm())))
1357               .addReg(MI->getOperand(2).getReg())
1358               .addExpr(MCSymbolRefExpr::create(FallthroughLabel, OutContext)));
1359       RetInst = MCInst();
1360       RetInst.setOpcode(PPC::BLR8);
1361     }
1362     // .p2align 3
1363     // .begin:
1364     //   b(lr)? # lis 0, FuncId[16..32]
1365     //   nop    # li  0, FuncId[0..15]
1366     //   std 0, -8(1)
1367     //   mflr 0
1368     //   bl __xray_FunctionExit
1369     //   mtlr 0
1370     //   b(lr)?
1371     //
1372     // Update compiler-rt/lib/xray/xray_powerpc64.cc accordingly when number
1373     // of instructions change.
1374     OutStreamer->EmitCodeAlignment(8);
1375     MCSymbol *BeginOfSled = OutContext.createTempSymbol();
1376     OutStreamer->EmitLabel(BeginOfSled);
1377     EmitToStreamer(*OutStreamer, RetInst);
1378     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::NOP));
1379     EmitToStreamer(
1380         *OutStreamer,
1381         MCInstBuilder(PPC::STD).addReg(PPC::X0).addImm(-8).addReg(PPC::X1));
1382     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::MFLR8).addReg(PPC::X0));
1383     EmitToStreamer(*OutStreamer,
1384                    MCInstBuilder(PPC::BL8_NOP)
1385                        .addExpr(MCSymbolRefExpr::create(
1386                            OutContext.getOrCreateSymbol("__xray_FunctionExit"),
1387                            OutContext)));
1388     EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::MTLR8).addReg(PPC::X0));
1389     EmitToStreamer(*OutStreamer, RetInst);
1390     if (IsConditional)
1391       OutStreamer->EmitLabel(FallthroughLabel);
1392     recordSled(BeginOfSled, *MI, SledKind::FUNCTION_EXIT);
1393     break;
1394   }
1395   case TargetOpcode::PATCHABLE_FUNCTION_EXIT:
1396     llvm_unreachable("PATCHABLE_FUNCTION_EXIT should never be emitted");
1397   case TargetOpcode::PATCHABLE_TAIL_CALL:
1398     // TODO: Define a trampoline `__xray_FunctionTailExit` and differentiate a
1399     // normal function exit from a tail exit.
1400     llvm_unreachable("Tail call is handled in the normal case. See comments "
1401                      "around this assert.");
1402   }
1403 }
1404 
1405 void PPCLinuxAsmPrinter::EmitStartOfAsmFile(Module &M) {
1406   if (static_cast<const PPCTargetMachine &>(TM).isELFv2ABI()) {
1407     PPCTargetStreamer *TS =
1408       static_cast<PPCTargetStreamer *>(OutStreamer->getTargetStreamer());
1409 
1410     if (TS)
1411       TS->emitAbiVersion(2);
1412   }
1413 
1414   if (static_cast<const PPCTargetMachine &>(TM).isPPC64() ||
1415       !isPositionIndependent())
1416     return AsmPrinter::EmitStartOfAsmFile(M);
1417 
1418   if (M.getPICLevel() == PICLevel::SmallPIC)
1419     return AsmPrinter::EmitStartOfAsmFile(M);
1420 
1421   OutStreamer->SwitchSection(OutContext.getELFSection(
1422       ".got2", ELF::SHT_PROGBITS, ELF::SHF_WRITE | ELF::SHF_ALLOC));
1423 
1424   MCSymbol *TOCSym = OutContext.getOrCreateSymbol(Twine(".LTOC"));
1425   MCSymbol *CurrentPos = OutContext.createTempSymbol();
1426 
1427   OutStreamer->EmitLabel(CurrentPos);
1428 
1429   // The GOT pointer points to the middle of the GOT, in order to reference the
1430   // entire 64kB range.  0x8000 is the midpoint.
1431   const MCExpr *tocExpr =
1432     MCBinaryExpr::createAdd(MCSymbolRefExpr::create(CurrentPos, OutContext),
1433                             MCConstantExpr::create(0x8000, OutContext),
1434                             OutContext);
1435 
1436   OutStreamer->EmitAssignment(TOCSym, tocExpr);
1437 
1438   OutStreamer->SwitchSection(getObjFileLowering().getTextSection());
1439 }
1440 
1441 void PPCLinuxAsmPrinter::EmitFunctionEntryLabel() {
1442   // linux/ppc32 - Normal entry label.
1443   if (!Subtarget->isPPC64() &&
1444       (!isPositionIndependent() ||
1445        MF->getFunction().getParent()->getPICLevel() == PICLevel::SmallPIC))
1446     return AsmPrinter::EmitFunctionEntryLabel();
1447 
1448   if (!Subtarget->isPPC64()) {
1449     const PPCFunctionInfo *PPCFI = MF->getInfo<PPCFunctionInfo>();
1450     if (PPCFI->usesPICBase() && !Subtarget->isSecurePlt()) {
1451       MCSymbol *RelocSymbol = PPCFI->getPICOffsetSymbol();
1452       MCSymbol *PICBase = MF->getPICBaseSymbol();
1453       OutStreamer->EmitLabel(RelocSymbol);
1454 
1455       const MCExpr *OffsExpr =
1456         MCBinaryExpr::createSub(
1457           MCSymbolRefExpr::create(OutContext.getOrCreateSymbol(Twine(".LTOC")),
1458                                                                OutContext),
1459                                   MCSymbolRefExpr::create(PICBase, OutContext),
1460           OutContext);
1461       OutStreamer->EmitValue(OffsExpr, 4);
1462       OutStreamer->EmitLabel(CurrentFnSym);
1463       return;
1464     } else
1465       return AsmPrinter::EmitFunctionEntryLabel();
1466   }
1467 
1468   // ELFv2 ABI - Normal entry label.
1469   if (Subtarget->isELFv2ABI()) {
1470     // In the Large code model, we allow arbitrary displacements between
1471     // the text section and its associated TOC section.  We place the
1472     // full 8-byte offset to the TOC in memory immediately preceding
1473     // the function global entry point.
1474     if (TM.getCodeModel() == CodeModel::Large
1475         && !MF->getRegInfo().use_empty(PPC::X2)) {
1476       const PPCFunctionInfo *PPCFI = MF->getInfo<PPCFunctionInfo>();
1477 
1478       MCSymbol *TOCSymbol = OutContext.getOrCreateSymbol(StringRef(".TOC."));
1479       MCSymbol *GlobalEPSymbol = PPCFI->getGlobalEPSymbol();
1480       const MCExpr *TOCDeltaExpr =
1481         MCBinaryExpr::createSub(MCSymbolRefExpr::create(TOCSymbol, OutContext),
1482                                 MCSymbolRefExpr::create(GlobalEPSymbol,
1483                                                         OutContext),
1484                                 OutContext);
1485 
1486       OutStreamer->EmitLabel(PPCFI->getTOCOffsetSymbol());
1487       OutStreamer->EmitValue(TOCDeltaExpr, 8);
1488     }
1489     return AsmPrinter::EmitFunctionEntryLabel();
1490   }
1491 
1492   // Emit an official procedure descriptor.
1493   MCSectionSubPair Current = OutStreamer->getCurrentSection();
1494   MCSectionELF *Section = OutStreamer->getContext().getELFSection(
1495       ".opd", ELF::SHT_PROGBITS, ELF::SHF_WRITE | ELF::SHF_ALLOC);
1496   OutStreamer->SwitchSection(Section);
1497   OutStreamer->EmitLabel(CurrentFnSym);
1498   OutStreamer->EmitValueToAlignment(8);
1499   MCSymbol *Symbol1 = CurrentFnSymForSize;
1500   // Generates a R_PPC64_ADDR64 (from FK_DATA_8) relocation for the function
1501   // entry point.
1502   OutStreamer->EmitValue(MCSymbolRefExpr::create(Symbol1, OutContext),
1503                          8 /*size*/);
1504   MCSymbol *Symbol2 = OutContext.getOrCreateSymbol(StringRef(".TOC."));
1505   // Generates a R_PPC64_TOC relocation for TOC base insertion.
1506   OutStreamer->EmitValue(
1507     MCSymbolRefExpr::create(Symbol2, MCSymbolRefExpr::VK_PPC_TOCBASE, OutContext),
1508     8/*size*/);
1509   // Emit a null environment pointer.
1510   OutStreamer->EmitIntValue(0, 8 /* size */);
1511   OutStreamer->SwitchSection(Current.first, Current.second);
1512 }
1513 
1514 bool PPCLinuxAsmPrinter::doFinalization(Module &M) {
1515   const DataLayout &DL = getDataLayout();
1516 
1517   bool isPPC64 = DL.getPointerSizeInBits() == 64;
1518 
1519   PPCTargetStreamer &TS =
1520       static_cast<PPCTargetStreamer &>(*OutStreamer->getTargetStreamer());
1521 
1522   if (!TOC.empty()) {
1523     MCSectionELF *Section;
1524 
1525     if (isPPC64)
1526       Section = OutStreamer->getContext().getELFSection(
1527           ".toc", ELF::SHT_PROGBITS, ELF::SHF_WRITE | ELF::SHF_ALLOC);
1528         else
1529           Section = OutStreamer->getContext().getELFSection(
1530               ".got2", ELF::SHT_PROGBITS, ELF::SHF_WRITE | ELF::SHF_ALLOC);
1531     OutStreamer->SwitchSection(Section);
1532 
1533     for (const auto &TOCMapPair : TOC) {
1534       const MCSymbol *const TOCEntryTarget = TOCMapPair.first;
1535       MCSymbol *const TOCEntryLabel = TOCMapPair.second;
1536 
1537       OutStreamer->EmitLabel(TOCEntryLabel);
1538       if (isPPC64) {
1539         TS.emitTCEntry(*TOCEntryTarget);
1540       } else {
1541         OutStreamer->EmitValueToAlignment(4);
1542         OutStreamer->EmitSymbolValue(TOCEntryTarget, 4);
1543       }
1544     }
1545   }
1546 
1547   return AsmPrinter::doFinalization(M);
1548 }
1549 
1550 /// EmitFunctionBodyStart - Emit a global entry point prefix for ELFv2.
1551 void PPCLinuxAsmPrinter::EmitFunctionBodyStart() {
1552   // In the ELFv2 ABI, in functions that use the TOC register, we need to
1553   // provide two entry points.  The ABI guarantees that when calling the
1554   // local entry point, r2 is set up by the caller to contain the TOC base
1555   // for this function, and when calling the global entry point, r12 is set
1556   // up by the caller to hold the address of the global entry point.  We
1557   // thus emit a prefix sequence along the following lines:
1558   //
1559   // func:
1560   // .Lfunc_gepNN:
1561   //         # global entry point
1562   //         addis r2,r12,(.TOC.-.Lfunc_gepNN)@ha
1563   //         addi  r2,r2,(.TOC.-.Lfunc_gepNN)@l
1564   // .Lfunc_lepNN:
1565   //         .localentry func, .Lfunc_lepNN-.Lfunc_gepNN
1566   //         # local entry point, followed by function body
1567   //
1568   // For the Large code model, we create
1569   //
1570   // .Lfunc_tocNN:
1571   //         .quad .TOC.-.Lfunc_gepNN      # done by EmitFunctionEntryLabel
1572   // func:
1573   // .Lfunc_gepNN:
1574   //         # global entry point
1575   //         ld    r2,.Lfunc_tocNN-.Lfunc_gepNN(r12)
1576   //         add   r2,r2,r12
1577   // .Lfunc_lepNN:
1578   //         .localentry func, .Lfunc_lepNN-.Lfunc_gepNN
1579   //         # local entry point, followed by function body
1580   //
1581   // This ensures we have r2 set up correctly while executing the function
1582   // body, no matter which entry point is called.
1583   if (Subtarget->isELFv2ABI()
1584       // Only do all that if the function uses r2 in the first place.
1585       && !MF->getRegInfo().use_empty(PPC::X2)) {
1586     // Note: The logic here must be synchronized with the code in the
1587     // branch-selection pass which sets the offset of the first block in the
1588     // function. This matters because it affects the alignment.
1589     const PPCFunctionInfo *PPCFI = MF->getInfo<PPCFunctionInfo>();
1590 
1591     MCSymbol *GlobalEntryLabel = PPCFI->getGlobalEPSymbol();
1592     OutStreamer->EmitLabel(GlobalEntryLabel);
1593     const MCSymbolRefExpr *GlobalEntryLabelExp =
1594       MCSymbolRefExpr::create(GlobalEntryLabel, OutContext);
1595 
1596     if (TM.getCodeModel() != CodeModel::Large) {
1597       MCSymbol *TOCSymbol = OutContext.getOrCreateSymbol(StringRef(".TOC."));
1598       const MCExpr *TOCDeltaExpr =
1599         MCBinaryExpr::createSub(MCSymbolRefExpr::create(TOCSymbol, OutContext),
1600                                 GlobalEntryLabelExp, OutContext);
1601 
1602       const MCExpr *TOCDeltaHi =
1603         PPCMCExpr::createHa(TOCDeltaExpr, false, OutContext);
1604       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDIS)
1605                                    .addReg(PPC::X2)
1606                                    .addReg(PPC::X12)
1607                                    .addExpr(TOCDeltaHi));
1608 
1609       const MCExpr *TOCDeltaLo =
1610         PPCMCExpr::createLo(TOCDeltaExpr, false, OutContext);
1611       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADDI)
1612                                    .addReg(PPC::X2)
1613                                    .addReg(PPC::X2)
1614                                    .addExpr(TOCDeltaLo));
1615     } else {
1616       MCSymbol *TOCOffset = PPCFI->getTOCOffsetSymbol();
1617       const MCExpr *TOCOffsetDeltaExpr =
1618         MCBinaryExpr::createSub(MCSymbolRefExpr::create(TOCOffset, OutContext),
1619                                 GlobalEntryLabelExp, OutContext);
1620 
1621       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::LD)
1622                                    .addReg(PPC::X2)
1623                                    .addExpr(TOCOffsetDeltaExpr)
1624                                    .addReg(PPC::X12));
1625       EmitToStreamer(*OutStreamer, MCInstBuilder(PPC::ADD8)
1626                                    .addReg(PPC::X2)
1627                                    .addReg(PPC::X2)
1628                                    .addReg(PPC::X12));
1629     }
1630 
1631     MCSymbol *LocalEntryLabel = PPCFI->getLocalEPSymbol();
1632     OutStreamer->EmitLabel(LocalEntryLabel);
1633     const MCSymbolRefExpr *LocalEntryLabelExp =
1634        MCSymbolRefExpr::create(LocalEntryLabel, OutContext);
1635     const MCExpr *LocalOffsetExp =
1636       MCBinaryExpr::createSub(LocalEntryLabelExp,
1637                               GlobalEntryLabelExp, OutContext);
1638 
1639     PPCTargetStreamer *TS =
1640       static_cast<PPCTargetStreamer *>(OutStreamer->getTargetStreamer());
1641 
1642     if (TS)
1643       TS->emitLocalEntry(cast<MCSymbolELF>(CurrentFnSym), LocalOffsetExp);
1644   }
1645 }
1646 
1647 /// EmitFunctionBodyEnd - Print the traceback table before the .size
1648 /// directive.
1649 ///
1650 void PPCLinuxAsmPrinter::EmitFunctionBodyEnd() {
1651   // Only the 64-bit target requires a traceback table.  For now,
1652   // we only emit the word of zeroes that GDB requires to find
1653   // the end of the function, and zeroes for the eight-byte
1654   // mandatory fields.
1655   // FIXME: We should fill in the eight-byte mandatory fields as described in
1656   // the PPC64 ELF ABI (this is a low-priority item because GDB does not
1657   // currently make use of these fields).
1658   if (Subtarget->isPPC64()) {
1659     OutStreamer->EmitIntValue(0, 4/*size*/);
1660     OutStreamer->EmitIntValue(0, 8/*size*/);
1661   }
1662 }
1663 
1664 void PPCAIXAsmPrinter::SetupMachineFunction(MachineFunction &MF) {
1665   // Get the function descriptor symbol.
1666   CurrentFnDescSym = getSymbol(&MF.getFunction());
1667   // Set the containing csect.
1668   MCSectionXCOFF *FnDescSec = OutStreamer->getContext().getXCOFFSection(
1669       CurrentFnDescSym->getName(), XCOFF::XMC_DS, XCOFF::XTY_SD,
1670       XCOFF::C_HIDEXT, SectionKind::getData());
1671   cast<MCSymbolXCOFF>(CurrentFnDescSym)->setContainingCsect(FnDescSec);
1672 
1673   return AsmPrinter::SetupMachineFunction(MF);
1674 }
1675 
1676 void PPCAIXAsmPrinter::ValidateGV(const GlobalVariable *GV) {
1677   // Early error checking limiting what is supported.
1678   if (GV->isThreadLocal())
1679     report_fatal_error("Thread local not yet supported on AIX.");
1680 
1681   if (GV->hasSection())
1682     report_fatal_error("Custom section for Data not yet supported.");
1683 
1684   if (GV->hasComdat())
1685     report_fatal_error("COMDAT not yet supported by AIX.");
1686 }
1687 
1688 const MCExpr *PPCAIXAsmPrinter::lowerConstant(const Constant *CV) {
1689   if (const Function *F = dyn_cast<Function>(CV)) {
1690     MCSymbolXCOFF *FSym = cast<MCSymbolXCOFF>(getSymbol(F));
1691     if (!FSym->hasContainingCsect()) {
1692       const XCOFF::StorageClass SC =
1693           F->isDeclaration()
1694               ? TargetLoweringObjectFileXCOFF::getStorageClassForGlobal(F)
1695               : XCOFF::C_HIDEXT;
1696       MCSectionXCOFF *Csect = OutStreamer->getContext().getXCOFFSection(
1697           FSym->getName(), XCOFF::XMC_DS,
1698           F->isDeclaration() ? XCOFF::XTY_ER : XCOFF::XTY_SD, SC,
1699           SectionKind::getData());
1700       FSym->setContainingCsect(Csect);
1701     }
1702     return MCSymbolRefExpr::create(
1703         FSym->getContainingCsect()->getQualNameSymbol(), OutContext);
1704   }
1705   return PPCAsmPrinter::lowerConstant(CV);
1706 }
1707 
1708 void PPCAIXAsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
1709   ValidateGV(GV);
1710 
1711   // External global variables are already handled.
1712   if (!GV->hasInitializer())
1713     return;
1714 
1715   // Create the symbol, set its storage class.
1716   MCSymbolXCOFF *GVSym = cast<MCSymbolXCOFF>(getSymbol(GV));
1717   GVSym->setStorageClass(
1718       TargetLoweringObjectFileXCOFF::getStorageClassForGlobal(GV));
1719 
1720   SectionKind GVKind = getObjFileLowering().getKindForGlobal(GV, TM);
1721   if ((!GVKind.isGlobalWriteableData() && !GVKind.isReadOnly()) ||
1722       GVKind.isMergeable2ByteCString() || GVKind.isMergeable4ByteCString())
1723     report_fatal_error("Encountered a global variable kind that is "
1724                        "not supported yet.");
1725 
1726   // Create the containing csect and switch to it.
1727   MCSectionXCOFF *Csect = cast<MCSectionXCOFF>(
1728       getObjFileLowering().SectionForGlobal(GV, GVKind, TM));
1729   OutStreamer->SwitchSection(Csect);
1730   GVSym->setContainingCsect(Csect);
1731 
1732   const DataLayout &DL = GV->getParent()->getDataLayout();
1733 
1734   // Handle common symbols.
1735   if (GVKind.isCommon() || GVKind.isBSSLocal()) {
1736     unsigned Align =
1737       GV->getAlignment() ? GV->getAlignment() : DL.getPreferredAlignment(GV);
1738     uint64_t Size = DL.getTypeAllocSize(GV->getType()->getElementType());
1739 
1740     if (GVKind.isBSSLocal())
1741       OutStreamer->EmitXCOFFLocalCommonSymbol(
1742           GVSym, Size, Csect->getQualNameSymbol(), Align);
1743     else
1744       OutStreamer->EmitCommonSymbol(Csect->getQualNameSymbol(), Size, Align);
1745     return;
1746   }
1747 
1748   MCSymbol *EmittedInitSym = GVSym;
1749   EmitLinkage(GV, EmittedInitSym);
1750   EmitAlignment(getGVAlignment(GV, DL), GV);
1751   OutStreamer->EmitLabel(EmittedInitSym);
1752   EmitGlobalConstant(GV->getParent()->getDataLayout(), GV->getInitializer());
1753 }
1754 
1755 void PPCAIXAsmPrinter::EmitFunctionDescriptor() {
1756   const DataLayout &DL = getDataLayout();
1757   const unsigned PointerSize = DL.getPointerSizeInBits() == 64 ? 8 : 4;
1758 
1759   MCSectionSubPair Current = OutStreamer->getCurrentSection();
1760   // Emit function descriptor.
1761   OutStreamer->SwitchSection(
1762       cast<MCSymbolXCOFF>(CurrentFnDescSym)->getContainingCsect());
1763   OutStreamer->EmitLabel(CurrentFnDescSym);
1764   // Emit function entry point address.
1765   OutStreamer->EmitValue(MCSymbolRefExpr::create(CurrentFnSym, OutContext),
1766                          PointerSize);
1767   // Emit TOC base address.
1768   const MCSectionXCOFF *TOCBaseSec = OutStreamer->getContext().getXCOFFSection(
1769       StringRef("TOC"), XCOFF::XMC_TC0, XCOFF::XTY_SD, XCOFF::C_HIDEXT,
1770       SectionKind::getData());
1771   const MCSymbol *TOCBaseSym = TOCBaseSec->getQualNameSymbol();
1772   OutStreamer->EmitValue(MCSymbolRefExpr::create(TOCBaseSym, OutContext),
1773                          PointerSize);
1774   // Emit a null environment pointer.
1775   OutStreamer->EmitIntValue(0, PointerSize);
1776 
1777   OutStreamer->SwitchSection(Current.first, Current.second);
1778 }
1779 
1780 void PPCAIXAsmPrinter::EmitEndOfAsmFile(Module &M) {
1781   // If there are no functions in this module, we will never need to reference
1782   // the TOC base.
1783   if (M.empty())
1784     return;
1785 
1786   // Emit TOC base.
1787   MCSectionXCOFF *TOCBaseSection = OutStreamer->getContext().getXCOFFSection(
1788       StringRef("TOC"), XCOFF::XMC_TC0, XCOFF::XTY_SD, XCOFF::C_HIDEXT,
1789       SectionKind::getData());
1790   // The TOC-base always has 0 size, but 4 byte alignment.
1791   TOCBaseSection->setAlignment(Align(4));
1792   // Switch to section to emit TOC base.
1793   OutStreamer->SwitchSection(TOCBaseSection);
1794 
1795   PPCTargetStreamer &TS =
1796       static_cast<PPCTargetStreamer &>(*OutStreamer->getTargetStreamer());
1797 
1798   for (auto &I : TOC) {
1799     // Setup the csect for the current TC entry.
1800     MCSectionXCOFF *TCEntry = OutStreamer->getContext().getXCOFFSection(
1801         cast<MCSymbolXCOFF>(I.first)->getUnqualifiedName(), XCOFF::XMC_TC,
1802         XCOFF::XTY_SD, XCOFF::C_HIDEXT, SectionKind::getData());
1803     cast<MCSymbolXCOFF>(I.second)->setContainingCsect(TCEntry);
1804     OutStreamer->SwitchSection(TCEntry);
1805 
1806     OutStreamer->EmitLabel(I.second);
1807     TS.emitTCEntry(*I.first);
1808   }
1809 }
1810 
1811 MCSymbol *
1812 PPCAIXAsmPrinter::getMCSymbolForTOCPseudoMO(const MachineOperand &MO) {
1813   const GlobalObject *GO = nullptr;
1814 
1815   // If the MO is a function or certain kind of globals, we want to make sure to
1816   // refer to the csect symbol, otherwise we can just do the default handling.
1817   if (MO.getType() != MachineOperand::MO_GlobalAddress ||
1818       !(GO = dyn_cast<const GlobalObject>(MO.getGlobal())))
1819     return PPCAsmPrinter::getMCSymbolForTOCPseudoMO(MO);
1820 
1821   // Do an early error check for globals we don't support. This will go away
1822   // eventually.
1823   const auto *GV = dyn_cast<const GlobalVariable>(GO);
1824   if (GV) {
1825     ValidateGV(GV);
1826   }
1827 
1828   MCSymbolXCOFF *XSym = cast<MCSymbolXCOFF>(getSymbol(GO));
1829 
1830   // If the global object is a global variable without initializer or is a
1831   // declaration of a function, then XSym is an external referenced symbol.
1832   // Hence we may need to explictly create a MCSectionXCOFF for it so that we
1833   // can return its symbol later.
1834   if (GO->isDeclaration()) {
1835     if (!XSym->hasContainingCsect()) {
1836       // Make sure the storage class is set.
1837       const XCOFF::StorageClass SC =
1838           TargetLoweringObjectFileXCOFF::getStorageClassForGlobal(GO);
1839       XSym->setStorageClass(SC);
1840 
1841       MCSectionXCOFF *Csect = OutStreamer->getContext().getXCOFFSection(
1842           XSym->getName(), isa<Function>(GO) ? XCOFF::XMC_DS : XCOFF::XMC_UA,
1843           XCOFF::XTY_ER, SC, SectionKind::getMetadata());
1844       XSym->setContainingCsect(Csect);
1845     }
1846 
1847     return XSym->getContainingCsect()->getQualNameSymbol();
1848   }
1849 
1850   // Handle initialized global variables and defined functions.
1851   SectionKind GOKind = getObjFileLowering().getKindForGlobal(GO, TM);
1852 
1853   if (GOKind.isText()) {
1854     // If the MO is a function, we want to make sure to refer to the function
1855     // descriptor csect.
1856     return OutStreamer->getContext()
1857         .getXCOFFSection(XSym->getName(), XCOFF::XMC_DS, XCOFF::XTY_SD,
1858                          XCOFF::C_HIDEXT, SectionKind::getData())
1859         ->getQualNameSymbol();
1860   } else if (GOKind.isCommon() || GOKind.isBSSLocal()) {
1861     // If the operand is a common then we should refer to the csect symbol.
1862     return cast<MCSectionXCOFF>(
1863                getObjFileLowering().SectionForGlobal(GO, GOKind, TM))
1864         ->getQualNameSymbol();
1865   }
1866 
1867   // Other global variables are refered to by labels inside of a single csect,
1868   // so refer to the label directly.
1869   return getSymbol(GV);
1870 }
1871 
1872 /// createPPCAsmPrinterPass - Returns a pass that prints the PPC assembly code
1873 /// for a MachineFunction to the given output stream, in a format that the
1874 /// Darwin assembler can deal with.
1875 ///
1876 static AsmPrinter *
1877 createPPCAsmPrinterPass(TargetMachine &tm,
1878                         std::unique_ptr<MCStreamer> &&Streamer) {
1879   if (tm.getTargetTriple().isOSAIX())
1880     return new PPCAIXAsmPrinter(tm, std::move(Streamer));
1881 
1882   return new PPCLinuxAsmPrinter(tm, std::move(Streamer));
1883 }
1884 
1885 // Force static initialization.
1886 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializePowerPCAsmPrinter() {
1887   TargetRegistry::RegisterAsmPrinter(getThePPC32Target(),
1888                                      createPPCAsmPrinterPass);
1889   TargetRegistry::RegisterAsmPrinter(getThePPC64Target(),
1890                                      createPPCAsmPrinterPass);
1891   TargetRegistry::RegisterAsmPrinter(getThePPC64LETarget(),
1892                                      createPPCAsmPrinterPass);
1893 }
1894