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