lib/Target/ARM64/ARM64CleanupLocalDynamicTLSPass.cpp

   1 //===-- ARM64CleanupLocalDynamicTLSPass.cpp -----------------------*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Local-dynamic access to thread-local variables proceeds in three stages.
  11 //
  12 // 1. The offset of this Module's thread-local area from TPIDR_EL0 is calculated
  13 //    in much the same way as a general-dynamic TLS-descriptor access against
  14 //    the special symbol _TLS_MODULE_BASE.
  15 // 2. The variable's offset from _TLS_MODULE_BASE_ is calculated using
  16 //    instructions with "dtprel" modifiers.
  17 // 3. These two are added, together with TPIDR_EL0, to obtain the variable's
  18 //    true address.
  19 //
  20 // This is only better than general-dynamic access to the variable if two or
  21 // more of the first stage TLS-descriptor calculations can be combined. This
  22 // pass looks through a function and performs such combinations.
  23 //
  24 //===----------------------------------------------------------------------===//
  25 #include "ARM64.h"
  26 #include "ARM64InstrInfo.h"
  27 #include "ARM64MachineFunctionInfo.h"
  28 #include "ARM64TargetMachine.h"
  29 #include "llvm/CodeGen/MachineDominators.h"
  30 #include "llvm/CodeGen/MachineFunction.h"
  31 #include "llvm/CodeGen/MachineFunctionPass.h"
  32 #include "llvm/CodeGen/MachineInstrBuilder.h"
  33 #include "llvm/CodeGen/MachineRegisterInfo.h"
  34 using namespace llvm;
  35
  36 namespace {
  37 struct LDTLSCleanup : public MachineFunctionPass {
  38   static char ID;
  39   LDTLSCleanup() : MachineFunctionPass(ID) {}
  40
  41   virtual bool runOnMachineFunction(MachineFunction &MF) {
  42     ARM64FunctionInfo *AFI = MF.getInfo<ARM64FunctionInfo>();
  43     if (AFI->getNumLocalDynamicTLSAccesses() < 2) {
  44       // No point folding accesses if there isn't at least two.
  45       return false;
  46     }
  47
  48     MachineDominatorTree *DT = &getAnalysis<MachineDominatorTree>();
  49     return VisitNode(DT->getRootNode(), 0);
  50   }
  51
  52   // Visit the dominator subtree rooted at Node in pre-order.
  53   // If TLSBaseAddrReg is non-null, then use that to replace any
  54   // TLS_base_addr instructions. Otherwise, create the register
  55   // when the first such instruction is seen, and then use it
  56   // as we encounter more instructions.
  57   bool VisitNode(MachineDomTreeNode *Node, unsigned TLSBaseAddrReg) {
  58     MachineBasicBlock *BB = Node->getBlock();
  59     bool Changed = false;
  60
  61     // Traverse the current block.
  62     for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;
  63          ++I) {
  64       switch (I->getOpcode()) {
  65       case ARM64::TLSDESC_BLR:
  66         // Make sure it's a local dynamic access.
  67         if (!I->getOperand(1).isSymbol() ||
  68             strcmp(I->getOperand(1).getSymbolName(), "_TLS_MODULE_BASE_"))
  69           break;
  70
  71         if (TLSBaseAddrReg)
  72           I = replaceTLSBaseAddrCall(I, TLSBaseAddrReg);
  73         else
  74           I = setRegister(I, &TLSBaseAddrReg);
  75         Changed = true;
  76         break;
  77       default:
  78         break;
  79       }
  80     }
  81
  82     // Visit the children of this block in the dominator tree.
  83     for (MachineDomTreeNode::iterator I = Node->begin(), E = Node->end();
  84          I != E; ++I) {
  85       Changed |= VisitNode(*I, TLSBaseAddrReg);
  86     }
  87
  88     return Changed;
  89   }
  90
  91   // Replace the TLS_base_addr instruction I with a copy from
  92   // TLSBaseAddrReg, returning the new instruction.
  93   MachineInstr *replaceTLSBaseAddrCall(MachineInstr *I,
  94                                        unsigned TLSBaseAddrReg) {
  95     MachineFunction *MF = I->getParent()->getParent();
  96     const ARM64TargetMachine *TM =
  97         static_cast<const ARM64TargetMachine *>(&MF->getTarget());
  98     const ARM64InstrInfo *TII = TM->getInstrInfo();
  99
 100     // Insert a Copy from TLSBaseAddrReg to x0, which is where the rest of the
 101     // code sequence assumes the address will be.
 102     MachineInstr *Copy =
 103         BuildMI(*I->getParent(), I, I->getDebugLoc(),
 104                 TII->get(TargetOpcode::COPY), ARM64::X0).addReg(TLSBaseAddrReg);
 105
 106     // Erase the TLS_base_addr instruction.
 107     I->eraseFromParent();
 108
 109     return Copy;
 110   }
 111
 112   // Create a virtal register in *TLSBaseAddrReg, and populate it by
 113   // inserting a copy instruction after I. Returns the new instruction.
 114   MachineInstr *setRegister(MachineInstr *I, unsigned *TLSBaseAddrReg) {
 115     MachineFunction *MF = I->getParent()->getParent();
 116     const ARM64TargetMachine *TM =
 117         static_cast<const ARM64TargetMachine *>(&MF->getTarget());
 118     const ARM64InstrInfo *TII = TM->getInstrInfo();
 119
 120     // Create a virtual register for the TLS base address.
 121     MachineRegisterInfo &RegInfo = MF->getRegInfo();
 122     *TLSBaseAddrReg = RegInfo.createVirtualRegister(&ARM64::GPR64RegClass);
 123
 124     // Insert a copy from X0 to TLSBaseAddrReg for later.
 125     MachineInstr *Next = I->getNextNode();
 126     MachineInstr *Copy = BuildMI(*I->getParent(), Next, I->getDebugLoc(),
 127                                  TII->get(TargetOpcode::COPY),
 128                                  *TLSBaseAddrReg).addReg(ARM64::X0);
 129
 130     return Copy;
 131   }
 132
 133   virtual const char *getPassName() const {
 134     return "Local Dynamic TLS Access Clean-up";
 135   }
 136
 137   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 138     AU.setPreservesCFG();
 139     AU.addRequired<MachineDominatorTree>();
 140     MachineFunctionPass::getAnalysisUsage(AU);
 141   }
 142 };
 143 }
 144
 145 char LDTLSCleanup::ID = 0;
 146 FunctionPass *llvm::createARM64CleanupLocalDynamicTLSPass() {
 147   return new LDTLSCleanup();
 148 }