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