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