150f02cb2SNick Lewycky //===-- Analysis.cpp - CodeGen LLVM IR Analysis Utilities -----------------===//
2450aa64fSDan Gohman //
3450aa64fSDan Gohman //                     The LLVM Compiler Infrastructure
4450aa64fSDan Gohman //
5450aa64fSDan Gohman // This file is distributed under the University of Illinois Open Source
6450aa64fSDan Gohman // License. See LICENSE.TXT for details.
7450aa64fSDan Gohman //
8450aa64fSDan Gohman //===----------------------------------------------------------------------===//
9450aa64fSDan Gohman //
10db5028bdSEric Christopher // This file defines several CodeGen-specific LLVM IR analysis utilities.
11450aa64fSDan Gohman //
12450aa64fSDan Gohman //===----------------------------------------------------------------------===//
13450aa64fSDan Gohman 
1409fc276dSEric Christopher #include "llvm/CodeGen/Analysis.h"
15dda00098SEric Christopher #include "llvm/Analysis/ValueTracking.h"
16ed0881b2SChandler Carruth #include "llvm/CodeGen/MachineFunction.h"
17576d36aeSEric Christopher #include "llvm/CodeGen/SelectionDAG.h"
189fb823bbSChandler Carruth #include "llvm/IR/DataLayout.h"
199fb823bbSChandler Carruth #include "llvm/IR/DerivedTypes.h"
209fb823bbSChandler Carruth #include "llvm/IR/Function.h"
219fb823bbSChandler Carruth #include "llvm/IR/Instructions.h"
229fb823bbSChandler Carruth #include "llvm/IR/IntrinsicInst.h"
239fb823bbSChandler Carruth #include "llvm/IR/LLVMContext.h"
249fb823bbSChandler Carruth #include "llvm/IR/Module.h"
25450aa64fSDan Gohman #include "llvm/Support/ErrorHandling.h"
26450aa64fSDan Gohman #include "llvm/Support/MathExtras.h"
27ed0881b2SChandler Carruth #include "llvm/Target/TargetLowering.h"
28d913448bSEric Christopher #include "llvm/Target/TargetSubtargetInfo.h"
29f21434ccSRafael Espindola #include "llvm/Transforms/Utils/GlobalStatus.h"
30d913448bSEric Christopher 
31450aa64fSDan Gohman using namespace llvm;
32450aa64fSDan Gohman 
338923cc54SMehdi Amini /// Compute the linearized index of a member in a nested aggregate/struct/array
348923cc54SMehdi Amini /// by recursing and accumulating CurIndex as long as there are indices in the
358923cc54SMehdi Amini /// index list.
36229907cdSChris Lattner unsigned llvm::ComputeLinearIndex(Type *Ty,
37450aa64fSDan Gohman                                   const unsigned *Indices,
38450aa64fSDan Gohman                                   const unsigned *IndicesEnd,
39450aa64fSDan Gohman                                   unsigned CurIndex) {
40450aa64fSDan Gohman   // Base case: We're done.
41450aa64fSDan Gohman   if (Indices && Indices == IndicesEnd)
42450aa64fSDan Gohman     return CurIndex;
43450aa64fSDan Gohman 
44450aa64fSDan Gohman   // Given a struct type, recursively traverse the elements.
45229907cdSChris Lattner   if (StructType *STy = dyn_cast<StructType>(Ty)) {
46450aa64fSDan Gohman     for (StructType::element_iterator EB = STy->element_begin(),
47450aa64fSDan Gohman                                       EI = EB,
48450aa64fSDan Gohman                                       EE = STy->element_end();
49450aa64fSDan Gohman         EI != EE; ++EI) {
50450aa64fSDan Gohman       if (Indices && *Indices == unsigned(EI - EB))
51aadc5596SDan Gohman         return ComputeLinearIndex(*EI, Indices+1, IndicesEnd, CurIndex);
52c0196b1bSCraig Topper       CurIndex = ComputeLinearIndex(*EI, nullptr, nullptr, CurIndex);
53450aa64fSDan Gohman     }
547b068f6bSMehdi Amini     assert(!Indices && "Unexpected out of bound");
55450aa64fSDan Gohman     return CurIndex;
56450aa64fSDan Gohman   }
57450aa64fSDan Gohman   // Given an array type, recursively traverse the elements.
58229907cdSChris Lattner   else if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
59229907cdSChris Lattner     Type *EltTy = ATy->getElementType();
608923cc54SMehdi Amini     unsigned NumElts = ATy->getNumElements();
618923cc54SMehdi Amini     // Compute the Linear offset when jumping one element of the array
628923cc54SMehdi Amini     unsigned EltLinearOffset = ComputeLinearIndex(EltTy, nullptr, nullptr, 0);
637b068f6bSMehdi Amini     if (Indices) {
647b068f6bSMehdi Amini       assert(*Indices < NumElts && "Unexpected out of bound");
658923cc54SMehdi Amini       // If the indice is inside the array, compute the index to the requested
668923cc54SMehdi Amini       // elt and recurse inside the element with the end of the indices list
678923cc54SMehdi Amini       CurIndex += EltLinearOffset* *Indices;
68aadc5596SDan Gohman       return ComputeLinearIndex(EltTy, Indices+1, IndicesEnd, CurIndex);
69450aa64fSDan Gohman     }
708923cc54SMehdi Amini     CurIndex += EltLinearOffset*NumElts;
71450aa64fSDan Gohman     return CurIndex;
72450aa64fSDan Gohman   }
73450aa64fSDan Gohman   // We haven't found the type we're looking for, so keep searching.
74450aa64fSDan Gohman   return CurIndex + 1;
75450aa64fSDan Gohman }
76450aa64fSDan Gohman 
77450aa64fSDan Gohman /// ComputeValueVTs - Given an LLVM IR type, compute a sequence of
78450aa64fSDan Gohman /// EVTs that represent all the individual underlying
79450aa64fSDan Gohman /// non-aggregate types that comprise it.
80450aa64fSDan Gohman ///
81450aa64fSDan Gohman /// If Offsets is non-null, it points to a vector to be filled in
82450aa64fSDan Gohman /// with the in-memory offsets of each of the individual values.
83450aa64fSDan Gohman ///
8456228dabSMehdi Amini void llvm::ComputeValueVTs(const TargetLowering &TLI, const DataLayout &DL,
8556228dabSMehdi Amini                            Type *Ty, SmallVectorImpl<EVT> &ValueVTs,
86450aa64fSDan Gohman                            SmallVectorImpl<uint64_t> *Offsets,
87450aa64fSDan Gohman                            uint64_t StartingOffset) {
88450aa64fSDan Gohman   // Given a struct type, recursively traverse the elements.
89229907cdSChris Lattner   if (StructType *STy = dyn_cast<StructType>(Ty)) {
9056228dabSMehdi Amini     const StructLayout *SL = DL.getStructLayout(STy);
91450aa64fSDan Gohman     for (StructType::element_iterator EB = STy->element_begin(),
92450aa64fSDan Gohman                                       EI = EB,
93450aa64fSDan Gohman                                       EE = STy->element_end();
94450aa64fSDan Gohman          EI != EE; ++EI)
9556228dabSMehdi Amini       ComputeValueVTs(TLI, DL, *EI, ValueVTs, Offsets,
96450aa64fSDan Gohman                       StartingOffset + SL->getElementOffset(EI - EB));
97450aa64fSDan Gohman     return;
98450aa64fSDan Gohman   }
99450aa64fSDan Gohman   // Given an array type, recursively traverse the elements.
100229907cdSChris Lattner   if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
101229907cdSChris Lattner     Type *EltTy = ATy->getElementType();
10256228dabSMehdi Amini     uint64_t EltSize = DL.getTypeAllocSize(EltTy);
103450aa64fSDan Gohman     for (unsigned i = 0, e = ATy->getNumElements(); i != e; ++i)
10456228dabSMehdi Amini       ComputeValueVTs(TLI, DL, EltTy, ValueVTs, Offsets,
105450aa64fSDan Gohman                       StartingOffset + i * EltSize);
106450aa64fSDan Gohman     return;
107450aa64fSDan Gohman   }
108450aa64fSDan Gohman   // Interpret void as zero return values.
109450aa64fSDan Gohman   if (Ty->isVoidTy())
110450aa64fSDan Gohman     return;
111450aa64fSDan Gohman   // Base case: we can get an EVT for this LLVM IR type.
11244ede33aSMehdi Amini   ValueVTs.push_back(TLI.getValueType(DL, Ty));
113450aa64fSDan Gohman   if (Offsets)
114450aa64fSDan Gohman     Offsets->push_back(StartingOffset);
115450aa64fSDan Gohman }
116450aa64fSDan Gohman 
117450aa64fSDan Gohman /// ExtractTypeInfo - Returns the type info, possibly bitcast, encoded in V.
118283bc2edSReid Kleckner GlobalValue *llvm::ExtractTypeInfo(Value *V) {
119450aa64fSDan Gohman   V = V->stripPointerCasts();
120283bc2edSReid Kleckner   GlobalValue *GV = dyn_cast<GlobalValue>(V);
121283bc2edSReid Kleckner   GlobalVariable *Var = dyn_cast<GlobalVariable>(V);
122450aa64fSDan Gohman 
123283bc2edSReid Kleckner   if (Var && Var->getName() == "llvm.eh.catch.all.value") {
124283bc2edSReid Kleckner     assert(Var->hasInitializer() &&
125450aa64fSDan Gohman            "The EH catch-all value must have an initializer");
126283bc2edSReid Kleckner     Value *Init = Var->getInitializer();
127283bc2edSReid Kleckner     GV = dyn_cast<GlobalValue>(Init);
128450aa64fSDan Gohman     if (!GV) V = cast<ConstantPointerNull>(Init);
129450aa64fSDan Gohman   }
130450aa64fSDan Gohman 
131450aa64fSDan Gohman   assert((GV || isa<ConstantPointerNull>(V)) &&
132450aa64fSDan Gohman          "TypeInfo must be a global variable or NULL");
133450aa64fSDan Gohman   return GV;
134450aa64fSDan Gohman }
135450aa64fSDan Gohman 
136450aa64fSDan Gohman /// hasInlineAsmMemConstraint - Return true if the inline asm instruction being
137450aa64fSDan Gohman /// processed uses a memory 'm' constraint.
138450aa64fSDan Gohman bool
139e8360b71SJohn Thompson llvm::hasInlineAsmMemConstraint(InlineAsm::ConstraintInfoVector &CInfos,
140450aa64fSDan Gohman                                 const TargetLowering &TLI) {
141450aa64fSDan Gohman   for (unsigned i = 0, e = CInfos.size(); i != e; ++i) {
142450aa64fSDan Gohman     InlineAsm::ConstraintInfo &CI = CInfos[i];
143450aa64fSDan Gohman     for (unsigned j = 0, ee = CI.Codes.size(); j != ee; ++j) {
144450aa64fSDan Gohman       TargetLowering::ConstraintType CType = TLI.getConstraintType(CI.Codes[j]);
145450aa64fSDan Gohman       if (CType == TargetLowering::C_Memory)
146450aa64fSDan Gohman         return true;
147450aa64fSDan Gohman     }
148450aa64fSDan Gohman 
149450aa64fSDan Gohman     // Indirect operand accesses access memory.
150450aa64fSDan Gohman     if (CI.isIndirect)
151450aa64fSDan Gohman       return true;
152450aa64fSDan Gohman   }
153450aa64fSDan Gohman 
154450aa64fSDan Gohman   return false;
155450aa64fSDan Gohman }
156450aa64fSDan Gohman 
157450aa64fSDan Gohman /// getFCmpCondCode - Return the ISD condition code corresponding to
158450aa64fSDan Gohman /// the given LLVM IR floating-point condition code.  This includes
159450aa64fSDan Gohman /// consideration of global floating-point math flags.
160450aa64fSDan Gohman ///
161450aa64fSDan Gohman ISD::CondCode llvm::getFCmpCondCode(FCmpInst::Predicate Pred) {
162450aa64fSDan Gohman   switch (Pred) {
16350f02cb2SNick Lewycky   case FCmpInst::FCMP_FALSE: return ISD::SETFALSE;
16450f02cb2SNick Lewycky   case FCmpInst::FCMP_OEQ:   return ISD::SETOEQ;
16550f02cb2SNick Lewycky   case FCmpInst::FCMP_OGT:   return ISD::SETOGT;
16650f02cb2SNick Lewycky   case FCmpInst::FCMP_OGE:   return ISD::SETOGE;
16750f02cb2SNick Lewycky   case FCmpInst::FCMP_OLT:   return ISD::SETOLT;
16850f02cb2SNick Lewycky   case FCmpInst::FCMP_OLE:   return ISD::SETOLE;
16950f02cb2SNick Lewycky   case FCmpInst::FCMP_ONE:   return ISD::SETONE;
17050f02cb2SNick Lewycky   case FCmpInst::FCMP_ORD:   return ISD::SETO;
17150f02cb2SNick Lewycky   case FCmpInst::FCMP_UNO:   return ISD::SETUO;
17250f02cb2SNick Lewycky   case FCmpInst::FCMP_UEQ:   return ISD::SETUEQ;
17350f02cb2SNick Lewycky   case FCmpInst::FCMP_UGT:   return ISD::SETUGT;
17450f02cb2SNick Lewycky   case FCmpInst::FCMP_UGE:   return ISD::SETUGE;
17550f02cb2SNick Lewycky   case FCmpInst::FCMP_ULT:   return ISD::SETULT;
17650f02cb2SNick Lewycky   case FCmpInst::FCMP_ULE:   return ISD::SETULE;
17750f02cb2SNick Lewycky   case FCmpInst::FCMP_UNE:   return ISD::SETUNE;
17850f02cb2SNick Lewycky   case FCmpInst::FCMP_TRUE:  return ISD::SETTRUE;
17946a9f016SDavid Blaikie   default: llvm_unreachable("Invalid FCmp predicate opcode!");
180450aa64fSDan Gohman   }
18150f02cb2SNick Lewycky }
18250f02cb2SNick Lewycky 
18350f02cb2SNick Lewycky ISD::CondCode llvm::getFCmpCodeWithoutNaN(ISD::CondCode CC) {
18450f02cb2SNick Lewycky   switch (CC) {
18550f02cb2SNick Lewycky     case ISD::SETOEQ: case ISD::SETUEQ: return ISD::SETEQ;
18650f02cb2SNick Lewycky     case ISD::SETONE: case ISD::SETUNE: return ISD::SETNE;
18750f02cb2SNick Lewycky     case ISD::SETOLT: case ISD::SETULT: return ISD::SETLT;
18850f02cb2SNick Lewycky     case ISD::SETOLE: case ISD::SETULE: return ISD::SETLE;
18950f02cb2SNick Lewycky     case ISD::SETOGT: case ISD::SETUGT: return ISD::SETGT;
19050f02cb2SNick Lewycky     case ISD::SETOGE: case ISD::SETUGE: return ISD::SETGE;
19146a9f016SDavid Blaikie     default: return CC;
19250f02cb2SNick Lewycky   }
193450aa64fSDan Gohman }
194450aa64fSDan Gohman 
195450aa64fSDan Gohman /// getICmpCondCode - Return the ISD condition code corresponding to
196450aa64fSDan Gohman /// the given LLVM IR integer condition code.
197450aa64fSDan Gohman ///
198450aa64fSDan Gohman ISD::CondCode llvm::getICmpCondCode(ICmpInst::Predicate Pred) {
199450aa64fSDan Gohman   switch (Pred) {
200450aa64fSDan Gohman   case ICmpInst::ICMP_EQ:  return ISD::SETEQ;
201450aa64fSDan Gohman   case ICmpInst::ICMP_NE:  return ISD::SETNE;
202450aa64fSDan Gohman   case ICmpInst::ICMP_SLE: return ISD::SETLE;
203450aa64fSDan Gohman   case ICmpInst::ICMP_ULE: return ISD::SETULE;
204450aa64fSDan Gohman   case ICmpInst::ICMP_SGE: return ISD::SETGE;
205450aa64fSDan Gohman   case ICmpInst::ICMP_UGE: return ISD::SETUGE;
206450aa64fSDan Gohman   case ICmpInst::ICMP_SLT: return ISD::SETLT;
207450aa64fSDan Gohman   case ICmpInst::ICMP_ULT: return ISD::SETULT;
208450aa64fSDan Gohman   case ICmpInst::ICMP_SGT: return ISD::SETGT;
209450aa64fSDan Gohman   case ICmpInst::ICMP_UGT: return ISD::SETUGT;
210450aa64fSDan Gohman   default:
211450aa64fSDan Gohman     llvm_unreachable("Invalid ICmp predicate opcode!");
212450aa64fSDan Gohman   }
213450aa64fSDan Gohman }
214450aa64fSDan Gohman 
215ffc44549SStephen Lin static bool isNoopBitcast(Type *T1, Type *T2,
216c0659fadSMichael Gottesman                           const TargetLoweringBase& TLI) {
217ffc44549SStephen Lin   return T1 == T2 || (T1->isPointerTy() && T2->isPointerTy()) ||
218ffc44549SStephen Lin          (isa<VectorType>(T1) && isa<VectorType>(T2) &&
219ffc44549SStephen Lin           TLI.isTypeLegal(EVT::getEVT(T1)) && TLI.isTypeLegal(EVT::getEVT(T2)));
220ffc44549SStephen Lin }
2214f3615deSChris Lattner 
222a4415854STim Northover /// Look through operations that will be free to find the earliest source of
223a4415854STim Northover /// this value.
224a4415854STim Northover ///
225a4415854STim Northover /// @param ValLoc If V has aggegate type, we will be interested in a particular
226a4415854STim Northover /// scalar component. This records its address; the reverse of this list gives a
227a4415854STim Northover /// sequence of indices appropriate for an extractvalue to locate the important
228a4415854STim Northover /// value. This value is updated during the function and on exit will indicate
229a4415854STim Northover /// similar information for the Value returned.
230a4415854STim Northover ///
231a4415854STim Northover /// @param DataBits If this function looks through truncate instructions, this
232a4415854STim Northover /// will record the smallest size attained.
233a4415854STim Northover static const Value *getNoopInput(const Value *V,
234a4415854STim Northover                                  SmallVectorImpl<unsigned> &ValLoc,
235a4415854STim Northover                                  unsigned &DataBits,
23644ede33aSMehdi Amini                                  const TargetLoweringBase &TLI,
23744ede33aSMehdi Amini                                  const DataLayout &DL) {
238ffc44549SStephen Lin   while (true) {
239ffc44549SStephen Lin     // Try to look through V1; if V1 is not an instruction, it can't be looked
240ffc44549SStephen Lin     // through.
241a4415854STim Northover     const Instruction *I = dyn_cast<Instruction>(V);
242a4415854STim Northover     if (!I || I->getNumOperands() == 0) return V;
243c0196b1bSCraig Topper     const Value *NoopInput = nullptr;
244a4415854STim Northover 
245182fe3eeSChris Lattner     Value *Op = I->getOperand(0);
246a4415854STim Northover     if (isa<BitCastInst>(I)) {
2474f3615deSChris Lattner       // Look through truly no-op bitcasts.
248ffc44549SStephen Lin       if (isNoopBitcast(Op->getType(), I->getType(), TLI))
249ffc44549SStephen Lin         NoopInput = Op;
250ffc44549SStephen Lin     } else if (isa<GetElementPtrInst>(I)) {
251ffc44549SStephen Lin       // Look through getelementptr
252ffc44549SStephen Lin       if (cast<GetElementPtrInst>(I)->hasAllZeroIndices())
253ffc44549SStephen Lin         NoopInput = Op;
254ffc44549SStephen Lin     } else if (isa<IntToPtrInst>(I)) {
255182fe3eeSChris Lattner       // Look through inttoptr.
256ffc44549SStephen Lin       // Make sure this isn't a truncating or extending cast.  We could
257ffc44549SStephen Lin       // support this eventually, but don't bother for now.
258ffc44549SStephen Lin       if (!isa<VectorType>(I->getType()) &&
25944ede33aSMehdi Amini           DL.getPointerSizeInBits() ==
260182fe3eeSChris Lattner               cast<IntegerType>(Op->getType())->getBitWidth())
261ffc44549SStephen Lin         NoopInput = Op;
262ffc44549SStephen Lin     } else if (isa<PtrToIntInst>(I)) {
263182fe3eeSChris Lattner       // Look through ptrtoint.
264ffc44549SStephen Lin       // Make sure this isn't a truncating or extending cast.  We could
265ffc44549SStephen Lin       // support this eventually, but don't bother for now.
266ffc44549SStephen Lin       if (!isa<VectorType>(I->getType()) &&
26744ede33aSMehdi Amini           DL.getPointerSizeInBits() ==
268182fe3eeSChris Lattner               cast<IntegerType>(I->getType())->getBitWidth())
269ffc44549SStephen Lin         NoopInput = Op;
270a4415854STim Northover     } else if (isa<TruncInst>(I) &&
271a4415854STim Northover                TLI.allowTruncateForTailCall(Op->getType(), I->getType())) {
272a4415854STim Northover       DataBits = std::min(DataBits, I->getType()->getPrimitiveSizeInBits());
273a4415854STim Northover       NoopInput = Op;
274b8bd232aSStephen Lin     } else if (isa<CallInst>(I)) {
275a4415854STim Northover       // Look through call (skipping callee)
276a4415854STim Northover       for (User::const_op_iterator i = I->op_begin(), e = I->op_end() - 1;
277b8bd232aSStephen Lin            i != e; ++i) {
278b8bd232aSStephen Lin         unsigned attrInd = i - I->op_begin() + 1;
279b8bd232aSStephen Lin         if (cast<CallInst>(I)->paramHasAttr(attrInd, Attribute::Returned) &&
280b8bd232aSStephen Lin             isNoopBitcast((*i)->getType(), I->getType(), TLI)) {
281b8bd232aSStephen Lin           NoopInput = *i;
282b8bd232aSStephen Lin           break;
283b8bd232aSStephen Lin         }
284b8bd232aSStephen Lin       }
285b8bd232aSStephen Lin     } else if (isa<InvokeInst>(I)) {
286a4415854STim Northover       // Look through invoke (skipping BB, BB, Callee)
287a4415854STim Northover       for (User::const_op_iterator i = I->op_begin(), e = I->op_end() - 3;
288b8bd232aSStephen Lin            i != e; ++i) {
289b8bd232aSStephen Lin         unsigned attrInd = i - I->op_begin() + 1;
290b8bd232aSStephen Lin         if (cast<InvokeInst>(I)->paramHasAttr(attrInd, Attribute::Returned) &&
291b8bd232aSStephen Lin             isNoopBitcast((*i)->getType(), I->getType(), TLI)) {
292b8bd232aSStephen Lin           NoopInput = *i;
293b8bd232aSStephen Lin           break;
294b8bd232aSStephen Lin         }
295b8bd232aSStephen Lin       }
296a4415854STim Northover     } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(V)) {
297a4415854STim Northover       // Value may come from either the aggregate or the scalar
298a4415854STim Northover       ArrayRef<unsigned> InsertLoc = IVI->getIndices();
299e4310fe9STim Northover       if (ValLoc.size() >= InsertLoc.size() &&
300e4310fe9STim Northover           std::equal(InsertLoc.begin(), InsertLoc.end(), ValLoc.rbegin())) {
301a4415854STim Northover         // The type being inserted is a nested sub-type of the aggregate; we
302a4415854STim Northover         // have to remove those initial indices to get the location we're
303a4415854STim Northover         // interested in for the operand.
304a4415854STim Northover         ValLoc.resize(ValLoc.size() - InsertLoc.size());
305a4415854STim Northover         NoopInput = IVI->getInsertedValueOperand();
306a4415854STim Northover       } else {
307a4415854STim Northover         // The struct we're inserting into has the value we're interested in, no
308a4415854STim Northover         // change of address.
309a4415854STim Northover         NoopInput = Op;
310a4415854STim Northover       }
311a4415854STim Northover     } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(V)) {
312a4415854STim Northover       // The part we're interested in will inevitably be some sub-section of the
313a4415854STim Northover       // previous aggregate. Combine the two paths to obtain the true address of
314a4415854STim Northover       // our element.
315a4415854STim Northover       ArrayRef<unsigned> ExtractLoc = EVI->getIndices();
3164f6ac162SBenjamin Kramer       ValLoc.append(ExtractLoc.rbegin(), ExtractLoc.rend());
317a4415854STim Northover       NoopInput = Op;
318a4415854STim Northover     }
319a4415854STim Northover     // Terminate if we couldn't find anything to look through.
320a4415854STim Northover     if (!NoopInput)
321a4415854STim Northover       return V;
322a4415854STim Northover 
323a4415854STim Northover     V = NoopInput;
324ffc44549SStephen Lin   }
325182fe3eeSChris Lattner }
326182fe3eeSChris Lattner 
327a4415854STim Northover /// Return true if this scalar return value only has bits discarded on its path
328a4415854STim Northover /// from the "tail call" to the "ret". This includes the obvious noop
329a4415854STim Northover /// instructions handled by getNoopInput above as well as free truncations (or
330a4415854STim Northover /// extensions prior to the call).
331a4415854STim Northover static bool slotOnlyDiscardsData(const Value *RetVal, const Value *CallVal,
332a4415854STim Northover                                  SmallVectorImpl<unsigned> &RetIndices,
333a4415854STim Northover                                  SmallVectorImpl<unsigned> &CallIndices,
334707d68f0STim Northover                                  bool AllowDifferingSizes,
33544ede33aSMehdi Amini                                  const TargetLoweringBase &TLI,
33644ede33aSMehdi Amini                                  const DataLayout &DL) {
3374f3615deSChris Lattner 
338a4415854STim Northover   // Trace the sub-value needed by the return value as far back up the graph as
339a4415854STim Northover   // possible, in the hope that it will intersect with the value produced by the
340a4415854STim Northover   // call. In the simple case with no "returned" attribute, the hope is actually
341a4415854STim Northover   // that we end up back at the tail call instruction itself.
342a4415854STim Northover   unsigned BitsRequired = UINT_MAX;
34344ede33aSMehdi Amini   RetVal = getNoopInput(RetVal, RetIndices, BitsRequired, TLI, DL);
344ffc44549SStephen Lin 
345a4415854STim Northover   // If this slot in the value returned is undef, it doesn't matter what the
346a4415854STim Northover   // call puts there, it'll be fine.
347a4415854STim Northover   if (isa<UndefValue>(RetVal))
348a4415854STim Northover     return true;
349ffc44549SStephen Lin 
350a4415854STim Northover   // Now do a similar search up through the graph to find where the value
351a4415854STim Northover   // actually returned by the "tail call" comes from. In the simple case without
352a4415854STim Northover   // a "returned" attribute, the search will be blocked immediately and the loop
353a4415854STim Northover   // a Noop.
354a4415854STim Northover   unsigned BitsProvided = UINT_MAX;
35544ede33aSMehdi Amini   CallVal = getNoopInput(CallVal, CallIndices, BitsProvided, TLI, DL);
356a4415854STim Northover 
357a4415854STim Northover   // There's no hope if we can't actually trace them to (the same part of!) the
358a4415854STim Northover   // same value.
359a4415854STim Northover   if (CallVal != RetVal || CallIndices != RetIndices)
360a4415854STim Northover     return false;
361a4415854STim Northover 
362a4415854STim Northover   // However, intervening truncates may have made the call non-tail. Make sure
363a4415854STim Northover   // all the bits that are needed by the "ret" have been provided by the "tail
364a4415854STim Northover   // call". FIXME: with sufficiently cunning bit-tracking, we could look through
365a4415854STim Northover   // extensions too.
366707d68f0STim Northover   if (BitsProvided < BitsRequired ||
367707d68f0STim Northover       (!AllowDifferingSizes && BitsProvided != BitsRequired))
368a4415854STim Northover     return false;
369a4415854STim Northover 
370ffc44549SStephen Lin   return true;
371ffc44549SStephen Lin }
372a4415854STim Northover 
373a4415854STim Northover /// For an aggregate type, determine whether a given index is within bounds or
374a4415854STim Northover /// not.
375a4415854STim Northover static bool indexReallyValid(CompositeType *T, unsigned Idx) {
376a4415854STim Northover   if (ArrayType *AT = dyn_cast<ArrayType>(T))
377a4415854STim Northover     return Idx < AT->getNumElements();
378a4415854STim Northover 
379a4415854STim Northover   return Idx < cast<StructType>(T)->getNumElements();
380ffc44549SStephen Lin }
381a4415854STim Northover 
382a4415854STim Northover /// Move the given iterators to the next leaf type in depth first traversal.
383a4415854STim Northover ///
384a4415854STim Northover /// Performs a depth-first traversal of the type as specified by its arguments,
385a4415854STim Northover /// stopping at the next leaf node (which may be a legitimate scalar type or an
386a4415854STim Northover /// empty struct or array).
387a4415854STim Northover ///
388a4415854STim Northover /// @param SubTypes List of the partial components making up the type from
389a4415854STim Northover /// outermost to innermost non-empty aggregate. The element currently
390a4415854STim Northover /// represented is SubTypes.back()->getTypeAtIndex(Path.back() - 1).
391a4415854STim Northover ///
392a4415854STim Northover /// @param Path Set of extractvalue indices leading from the outermost type
393a4415854STim Northover /// (SubTypes[0]) to the leaf node currently represented.
394a4415854STim Northover ///
395a4415854STim Northover /// @returns true if a new type was found, false otherwise. Calling this
396a4415854STim Northover /// function again on a finished iterator will repeatedly return
397a4415854STim Northover /// false. SubTypes.back()->getTypeAtIndex(Path.back()) is either an empty
398a4415854STim Northover /// aggregate or a non-aggregate
399df03449aSBenjamin Kramer static bool advanceToNextLeafType(SmallVectorImpl<CompositeType *> &SubTypes,
400a4415854STim Northover                                   SmallVectorImpl<unsigned> &Path) {
401a4415854STim Northover   // First march back up the tree until we can successfully increment one of the
402a4415854STim Northover   // coordinates in Path.
403a4415854STim Northover   while (!Path.empty() && !indexReallyValid(SubTypes.back(), Path.back() + 1)) {
404a4415854STim Northover     Path.pop_back();
405a4415854STim Northover     SubTypes.pop_back();
406a4415854STim Northover   }
407a4415854STim Northover 
408a4415854STim Northover   // If we reached the top, then the iterator is done.
409a4415854STim Northover   if (Path.empty())
410a4415854STim Northover     return false;
411a4415854STim Northover 
412a4415854STim Northover   // We know there's *some* valid leaf now, so march back down the tree picking
413a4415854STim Northover   // out the left-most element at each node.
414a4415854STim Northover   ++Path.back();
415a4415854STim Northover   Type *DeeperType = SubTypes.back()->getTypeAtIndex(Path.back());
416a4415854STim Northover   while (DeeperType->isAggregateType()) {
417a4415854STim Northover     CompositeType *CT = cast<CompositeType>(DeeperType);
418a4415854STim Northover     if (!indexReallyValid(CT, 0))
419a4415854STim Northover       return true;
420a4415854STim Northover 
421a4415854STim Northover     SubTypes.push_back(CT);
422a4415854STim Northover     Path.push_back(0);
423a4415854STim Northover 
424a4415854STim Northover     DeeperType = CT->getTypeAtIndex(0U);
425a4415854STim Northover   }
426a4415854STim Northover 
427ffc44549SStephen Lin   return true;
428ffc44549SStephen Lin }
429a4415854STim Northover 
430a4415854STim Northover /// Find the first non-empty, scalar-like type in Next and setup the iterator
431a4415854STim Northover /// components.
432a4415854STim Northover ///
433a4415854STim Northover /// Assuming Next is an aggregate of some kind, this function will traverse the
434a4415854STim Northover /// tree from left to right (i.e. depth-first) looking for the first
435a4415854STim Northover /// non-aggregate type which will play a role in function return.
436a4415854STim Northover ///
437a4415854STim Northover /// For example, if Next was {[0 x i64], {{}, i32, {}}, i32} then we would setup
438a4415854STim Northover /// Path as [1, 1] and SubTypes as [Next, {{}, i32, {}}] to represent the first
439a4415854STim Northover /// i32 in that type.
440a4415854STim Northover static bool firstRealType(Type *Next,
441a4415854STim Northover                           SmallVectorImpl<CompositeType *> &SubTypes,
442a4415854STim Northover                           SmallVectorImpl<unsigned> &Path) {
443a4415854STim Northover   // First initialise the iterator components to the first "leaf" node
444a4415854STim Northover   // (i.e. node with no valid sub-type at any index, so {} does count as a leaf
445a4415854STim Northover   // despite nominally being an aggregate).
446a4415854STim Northover   while (Next->isAggregateType() &&
447a4415854STim Northover          indexReallyValid(cast<CompositeType>(Next), 0)) {
448a4415854STim Northover     SubTypes.push_back(cast<CompositeType>(Next));
449a4415854STim Northover     Path.push_back(0);
450a4415854STim Northover     Next = cast<CompositeType>(Next)->getTypeAtIndex(0U);
451ffc44549SStephen Lin   }
452ffc44549SStephen Lin 
453a4415854STim Northover   // If there's no Path now, Next was originally scalar already (or empty
454a4415854STim Northover   // leaf). We're done.
455a4415854STim Northover   if (Path.empty())
456a4415854STim Northover     return true;
457ffc44549SStephen Lin 
458a4415854STim Northover   // Otherwise, use normal iteration to keep looking through the tree until we
459a4415854STim Northover   // find a non-aggregate type.
460a4415854STim Northover   while (SubTypes.back()->getTypeAtIndex(Path.back())->isAggregateType()) {
461a4415854STim Northover     if (!advanceToNextLeafType(SubTypes, Path))
462ffc44549SStephen Lin       return false;
463ffc44549SStephen Lin   }
4644f3615deSChris Lattner 
465a4415854STim Northover   return true;
466a4415854STim Northover }
467a4415854STim Northover 
468a4415854STim Northover /// Set the iterator data-structures to the next non-empty, non-aggregate
469a4415854STim Northover /// subtype.
470df03449aSBenjamin Kramer static bool nextRealType(SmallVectorImpl<CompositeType *> &SubTypes,
471a4415854STim Northover                          SmallVectorImpl<unsigned> &Path) {
472a4415854STim Northover   do {
473a4415854STim Northover     if (!advanceToNextLeafType(SubTypes, Path))
474a4415854STim Northover       return false;
475a4415854STim Northover 
476a4415854STim Northover     assert(!Path.empty() && "found a leaf but didn't set the path?");
477a4415854STim Northover   } while (SubTypes.back()->getTypeAtIndex(Path.back())->isAggregateType());
478a4415854STim Northover 
479a4415854STim Northover   return true;
480a4415854STim Northover }
481a4415854STim Northover 
482a4415854STim Northover 
483450aa64fSDan Gohman /// Test if the given instruction is in a position to be optimized
484450aa64fSDan Gohman /// with a tail-call. This roughly means that it's in a block with
485450aa64fSDan Gohman /// a return and there's nothing that needs to be scheduled
486450aa64fSDan Gohman /// between it and the return.
487450aa64fSDan Gohman ///
488450aa64fSDan Gohman /// This function only tests target-independent requirements.
489480872b4SJuergen Ributzka bool llvm::isInTailCallPosition(ImmutableCallSite CS, const TargetMachine &TM) {
490450aa64fSDan Gohman   const Instruction *I = CS.getInstruction();
491450aa64fSDan Gohman   const BasicBlock *ExitBB = I->getParent();
492450aa64fSDan Gohman   const TerminatorInst *Term = ExitBB->getTerminator();
493450aa64fSDan Gohman   const ReturnInst *Ret = dyn_cast<ReturnInst>(Term);
494450aa64fSDan Gohman 
495450aa64fSDan Gohman   // The block must end in a return statement or unreachable.
496450aa64fSDan Gohman   //
497450aa64fSDan Gohman   // FIXME: Decline tailcall if it's not guaranteed and if the block ends in
498450aa64fSDan Gohman   // an unreachable, for now. The way tailcall optimization is currently
499450aa64fSDan Gohman   // implemented means it will add an epilogue followed by a jump. That is
500450aa64fSDan Gohman   // not profitable. Also, if the callee is a special function (e.g.
501450aa64fSDan Gohman   // longjmp on x86), it can end up causing miscompilation that has not
502450aa64fSDan Gohman   // been fully understood.
503450aa64fSDan Gohman   if (!Ret &&
5044ce9863dSJuergen Ributzka       (!TM.Options.GuaranteedTailCallOpt || !isa<UnreachableInst>(Term)))
5054f3615deSChris Lattner     return false;
506450aa64fSDan Gohman 
507450aa64fSDan Gohman   // If I will have a chain, make sure no other instruction that will have a
508450aa64fSDan Gohman   // chain interposes between I and the return.
509*0a92f86fSDavid Majnemer   if (I->mayHaveSideEffects() || I->mayReadFromMemory() ||
510*0a92f86fSDavid Majnemer       !isSafeToSpeculativelyExecute(I))
511b6d0bd48SBenjamin Kramer     for (BasicBlock::const_iterator BBI = std::prev(ExitBB->end(), 2);; --BBI) {
512450aa64fSDan Gohman       if (&*BBI == I)
513450aa64fSDan Gohman         break;
514450aa64fSDan Gohman       // Debug info intrinsics do not get in the way of tail call optimization.
515450aa64fSDan Gohman       if (isa<DbgInfoIntrinsic>(BBI))
516450aa64fSDan Gohman         continue;
517450aa64fSDan Gohman       if (BBI->mayHaveSideEffects() || BBI->mayReadFromMemory() ||
51875d7d5e9SDan Gohman           !isSafeToSpeculativelyExecute(BBI))
519450aa64fSDan Gohman         return false;
520450aa64fSDan Gohman     }
521450aa64fSDan Gohman 
522f734a8baSEric Christopher   const Function *F = ExitBB->getParent();
523d913448bSEric Christopher   return returnTypeIsEligibleForTailCall(
524f734a8baSEric Christopher       F, I, Ret, *TM.getSubtargetImpl(*F)->getTargetLowering());
525ce0e4c26SMichael Gottesman }
526ce0e4c26SMichael Gottesman 
527ce0e4c26SMichael Gottesman bool llvm::returnTypeIsEligibleForTailCall(const Function *F,
528ce0e4c26SMichael Gottesman                                            const Instruction *I,
529ce0e4c26SMichael Gottesman                                            const ReturnInst *Ret,
530ce0e4c26SMichael Gottesman                                            const TargetLoweringBase &TLI) {
531450aa64fSDan Gohman   // If the block ends with a void return or unreachable, it doesn't matter
532450aa64fSDan Gohman   // what the call's return type is.
533450aa64fSDan Gohman   if (!Ret || Ret->getNumOperands() == 0) return true;
534450aa64fSDan Gohman 
535450aa64fSDan Gohman   // If the return value is undef, it doesn't matter what the call's
536450aa64fSDan Gohman   // return type is.
537450aa64fSDan Gohman   if (isa<UndefValue>(Ret->getOperand(0))) return true;
538450aa64fSDan Gohman 
539707d68f0STim Northover   // Make sure the attributes attached to each return are compatible.
540ce0e4c26SMichael Gottesman   AttrBuilder CallerAttrs(F->getAttributes(),
541707d68f0STim Northover                           AttributeSet::ReturnIndex);
542707d68f0STim Northover   AttrBuilder CalleeAttrs(cast<CallInst>(I)->getAttributes(),
543707d68f0STim Northover                           AttributeSet::ReturnIndex);
544707d68f0STim Northover 
545707d68f0STim Northover   // Noalias is completely benign as far as calling convention goes, it
546707d68f0STim Northover   // shouldn't affect whether the call is a tail call.
547707d68f0STim Northover   CallerAttrs = CallerAttrs.removeAttribute(Attribute::NoAlias);
548707d68f0STim Northover   CalleeAttrs = CalleeAttrs.removeAttribute(Attribute::NoAlias);
549707d68f0STim Northover 
550707d68f0STim Northover   bool AllowDifferingSizes = true;
551707d68f0STim Northover   if (CallerAttrs.contains(Attribute::ZExt)) {
552707d68f0STim Northover     if (!CalleeAttrs.contains(Attribute::ZExt))
553450aa64fSDan Gohman       return false;
554450aa64fSDan Gohman 
555707d68f0STim Northover     AllowDifferingSizes = false;
556707d68f0STim Northover     CallerAttrs.removeAttribute(Attribute::ZExt);
557707d68f0STim Northover     CalleeAttrs.removeAttribute(Attribute::ZExt);
558707d68f0STim Northover   } else if (CallerAttrs.contains(Attribute::SExt)) {
559707d68f0STim Northover     if (!CalleeAttrs.contains(Attribute::SExt))
560707d68f0STim Northover       return false;
561707d68f0STim Northover 
562707d68f0STim Northover     AllowDifferingSizes = false;
563707d68f0STim Northover     CallerAttrs.removeAttribute(Attribute::SExt);
564707d68f0STim Northover     CalleeAttrs.removeAttribute(Attribute::SExt);
565707d68f0STim Northover   }
566707d68f0STim Northover 
567707d68f0STim Northover   // If they're still different, there's some facet we don't understand
568707d68f0STim Northover   // (currently only "inreg", but in future who knows). It may be OK but the
569707d68f0STim Northover   // only safe option is to reject the tail call.
570707d68f0STim Northover   if (CallerAttrs != CalleeAttrs)
571450aa64fSDan Gohman     return false;
572450aa64fSDan Gohman 
573a4415854STim Northover   const Value *RetVal = Ret->getOperand(0), *CallVal = I;
574a4415854STim Northover   SmallVector<unsigned, 4> RetPath, CallPath;
575a4415854STim Northover   SmallVector<CompositeType *, 4> RetSubTypes, CallSubTypes;
576a4415854STim Northover 
577a4415854STim Northover   bool RetEmpty = !firstRealType(RetVal->getType(), RetSubTypes, RetPath);
578a4415854STim Northover   bool CallEmpty = !firstRealType(CallVal->getType(), CallSubTypes, CallPath);
579a4415854STim Northover 
580a4415854STim Northover   // Nothing's actually returned, it doesn't matter what the callee put there
581a4415854STim Northover   // it's a valid tail call.
582a4415854STim Northover   if (RetEmpty)
583a4415854STim Northover     return true;
584a4415854STim Northover 
585a4415854STim Northover   // Iterate pairwise through each of the value types making up the tail call
586a4415854STim Northover   // and the corresponding return. For each one we want to know whether it's
587a4415854STim Northover   // essentially going directly from the tail call to the ret, via operations
588a4415854STim Northover   // that end up not generating any code.
589a4415854STim Northover   //
590a4415854STim Northover   // We allow a certain amount of covariance here. For example it's permitted
591a4415854STim Northover   // for the tail call to define more bits than the ret actually cares about
592a4415854STim Northover   // (e.g. via a truncate).
593a4415854STim Northover   do {
594a4415854STim Northover     if (CallEmpty) {
595a4415854STim Northover       // We've exhausted the values produced by the tail call instruction, the
596a4415854STim Northover       // rest are essentially undef. The type doesn't really matter, but we need
597a4415854STim Northover       // *something*.
598a4415854STim Northover       Type *SlotType = RetSubTypes.back()->getTypeAtIndex(RetPath.back());
599a4415854STim Northover       CallVal = UndefValue::get(SlotType);
600a4415854STim Northover     }
601a4415854STim Northover 
602a4415854STim Northover     // The manipulations performed when we're looking through an insertvalue or
603a4415854STim Northover     // an extractvalue would happen at the front of the RetPath list, so since
604a4415854STim Northover     // we have to copy it anyway it's more efficient to create a reversed copy.
6054f6ac162SBenjamin Kramer     SmallVector<unsigned, 4> TmpRetPath(RetPath.rbegin(), RetPath.rend());
6064f6ac162SBenjamin Kramer     SmallVector<unsigned, 4> TmpCallPath(CallPath.rbegin(), CallPath.rend());
607a4415854STim Northover 
608a4415854STim Northover     // Finally, we can check whether the value produced by the tail call at this
609a4415854STim Northover     // index is compatible with the value we return.
610707d68f0STim Northover     if (!slotOnlyDiscardsData(RetVal, CallVal, TmpRetPath, TmpCallPath,
61144ede33aSMehdi Amini                               AllowDifferingSizes, TLI,
61244ede33aSMehdi Amini                               F->getParent()->getDataLayout()))
613a4415854STim Northover       return false;
614a4415854STim Northover 
615a4415854STim Northover     CallEmpty  = !nextRealType(CallSubTypes, CallPath);
616a4415854STim Northover   } while(nextRealType(RetSubTypes, RetPath));
617a4415854STim Northover 
618a4415854STim Northover   return true;
619450aa64fSDan Gohman }
620f21434ccSRafael Espindola 
621f21434ccSRafael Espindola bool llvm::canBeOmittedFromSymbolTable(const GlobalValue *GV) {
622f21434ccSRafael Espindola   if (!GV->hasLinkOnceODRLinkage())
623f21434ccSRafael Espindola     return false;
624f21434ccSRafael Espindola 
625f21434ccSRafael Espindola   if (GV->hasUnnamedAddr())
626f21434ccSRafael Espindola     return true;
627f21434ccSRafael Espindola 
628f21434ccSRafael Espindola   // If it is a non constant variable, it needs to be uniqued across shared
629f21434ccSRafael Espindola   // objects.
630f21434ccSRafael Espindola   if (const GlobalVariable *Var = dyn_cast<GlobalVariable>(GV)) {
631f21434ccSRafael Espindola     if (!Var->isConstant())
632f21434ccSRafael Espindola       return false;
633f21434ccSRafael Espindola   }
634f21434ccSRafael Espindola 
635f21434ccSRafael Espindola   // An alias can point to a variable. We could try to resolve the alias to
636f21434ccSRafael Espindola   // decide, but for now just don't hide them.
637f21434ccSRafael Espindola   if (isa<GlobalAlias>(GV))
638f21434ccSRafael Espindola     return false;
639f21434ccSRafael Espindola 
640f21434ccSRafael Espindola   GlobalStatus GS;
641f21434ccSRafael Espindola   if (GlobalStatus::analyzeGlobal(GV, GS))
642f21434ccSRafael Espindola     return false;
643f21434ccSRafael Espindola 
644f21434ccSRafael Espindola   return !GS.IsCompared;
645f21434ccSRafael Espindola }
646