lib/Transforms/IPO/FunctionAttrs.cpp

   1 //===- FunctionAttrs.cpp - Pass which marks functions readnone or readonly ===//
   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 // This file implements a simple interprocedural pass which walks the
  11 // call-graph, looking for functions which do not access or only read
  12 // non-local memory, and marking them readnone/readonly.  In addition,
  13 // it marks function arguments (of pointer type) 'nocapture' if a call
  14 // to the function does not create any copies of the pointer value that
  15 // outlive the call.  This more or less means that the pointer is only
  16 // dereferenced, and not returned from the function or stored in a global.
  17 // This pass is implemented as a bottom-up traversal of the call-graph.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #define DEBUG_TYPE "functionattrs"
  22 #include "llvm/Transforms/IPO.h"
  23 #include "llvm/CallGraphSCCPass.h"
  24 #include "llvm/GlobalVariable.h"
  25 #include "llvm/IntrinsicInst.h"
  26 #include "llvm/LLVMContext.h"
  27 #include "llvm/Analysis/AliasAnalysis.h"
  28 #include "llvm/Analysis/CallGraph.h"
  29 #include "llvm/Analysis/CaptureTracking.h"
  30 #include "llvm/ADT/SmallSet.h"
  31 #include "llvm/ADT/Statistic.h"
  32 #include "llvm/ADT/UniqueVector.h"
  33 #include "llvm/Support/InstIterator.h"
  34 using namespace llvm;
  35
  36 STATISTIC(NumReadNone, "Number of functions marked readnone");
  37 STATISTIC(NumReadOnly, "Number of functions marked readonly");
  38 STATISTIC(NumNoCapture, "Number of arguments marked nocapture");
  39 STATISTIC(NumNoAlias, "Number of function returns marked noalias");
  40
  41 namespace {
  42   struct FunctionAttrs : public CallGraphSCCPass {
  43     static char ID; // Pass identification, replacement for typeid
  44     FunctionAttrs() : CallGraphSCCPass(ID), AA(0) {
  45       initializeFunctionAttrsPass(*PassRegistry::getPassRegistry());
  46     }
  47
  48     // runOnSCC - Analyze the SCC, performing the transformation if possible.
  49     bool runOnSCC(CallGraphSCC &SCC);
  50
  51     // AddReadAttrs - Deduce readonly/readnone attributes for the SCC.
  52     bool AddReadAttrs(const CallGraphSCC &SCC);
  53
  54     // AddNoCaptureAttrs - Deduce nocapture attributes for the SCC.
  55     bool AddNoCaptureAttrs(const CallGraphSCC &SCC);
  56
  57     // IsFunctionMallocLike - Does this function allocate new memory?
  58     bool IsFunctionMallocLike(Function *F,
  59                               SmallPtrSet<Function*, 8> &) const;
  60
  61     // AddNoAliasAttrs - Deduce noalias attributes for the SCC.
  62     bool AddNoAliasAttrs(const CallGraphSCC &SCC);
  63
  64     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  65       AU.setPreservesCFG();
  66       AU.addRequired<AliasAnalysis>();
  67       CallGraphSCCPass::getAnalysisUsage(AU);
  68     }
  69
  70   private:
  71     AliasAnalysis *AA;
  72   };
  73 }
  74
  75 char FunctionAttrs::ID = 0;
  76 INITIALIZE_PASS_BEGIN(FunctionAttrs, "functionattrs",
  77                 "Deduce function attributes", false, false)
  78 INITIALIZE_AG_DEPENDENCY(CallGraph)
  79 INITIALIZE_PASS_END(FunctionAttrs, "functionattrs",
  80                 "Deduce function attributes", false, false)
  81
  82 Pass *llvm::createFunctionAttrsPass() { return new FunctionAttrs(); }
  83
  84
  85 /// AddReadAttrs - Deduce readonly/readnone attributes for the SCC.
  86 bool FunctionAttrs::AddReadAttrs(const CallGraphSCC &SCC) {
  87   SmallPtrSet<Function*, 8> SCCNodes;
  88
  89   // Fill SCCNodes with the elements of the SCC.  Used for quickly
  90   // looking up whether a given CallGraphNode is in this SCC.
  91   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I)
  92     SCCNodes.insert((*I)->getFunction());
  93
  94   // Check if any of the functions in the SCC read or write memory.  If they
  95   // write memory then they can't be marked readnone or readonly.
  96   bool ReadsMemory = false;
  97   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
  98     Function *F = (*I)->getFunction();
  99
 100     if (F == 0)
 101       // External node - may write memory.  Just give up.
 102       return false;
 103
 104     AliasAnalysis::ModRefBehavior MRB = AA->getModRefBehavior(F);
 105     if (MRB == AliasAnalysis::DoesNotAccessMemory)
 106       // Already perfect!
 107       continue;
 108
 109     // Definitions with weak linkage may be overridden at linktime with
 110     // something that writes memory, so treat them like declarations.
 111     if (F->isDeclaration() || F->mayBeOverridden()) {
 112       if (!AliasAnalysis::onlyReadsMemory(MRB))
 113         // May write memory.  Just give up.
 114         return false;
 115
 116       ReadsMemory = true;
 117       continue;
 118     }
 119
 120     // Scan the function body for instructions that may read or write memory.
 121     for (inst_iterator II = inst_begin(F), E = inst_end(F); II != E; ++II) {
 122       Instruction *I = &*II;
 123
 124       // Some instructions can be ignored even if they read or write memory.
 125       // Detect these now, skipping to the next instruction if one is found.
 126       CallSite CS(cast<Value>(I));
 127       if (CS) {
 128         // Ignore calls to functions in the same SCC.
 129         if (CS.getCalledFunction() && SCCNodes.count(CS.getCalledFunction()))
 130           continue;
 131         AliasAnalysis::ModRefBehavior MRB = AA->getModRefBehavior(CS);
 132         // If the call doesn't access arbitrary memory, we may be able to
 133         // figure out something.
 134         if (!(MRB & AliasAnalysis::Anywhere &
 135               ~AliasAnalysis::ArgumentPointees)) {
 136           // If the call accesses argument pointees, check each argument.
 137           if (MRB & AliasAnalysis::AccessesArguments)
 138             // Check whether all pointer arguments point to local memory, and
 139             // ignore calls that only access local memory.
 140             for (CallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
 141                  CI != CE; ++CI) {
 142               Value *Arg = *CI;
 143               if (Arg->getType()->isPointerTy()) {
 144                 AliasAnalysis::Location Loc(Arg,
 145                                             AliasAnalysis::UnknownSize,
 146                                             I->getMetadata(LLVMContext::MD_tbaa));
 147                 if (!AA->pointsToConstantMemory(Loc, /*OrLocal=*/true)) {
 148                   if (MRB & AliasAnalysis::Mod)
 149                     // Writes non-local memory.  Give up.
 150                     return false;
 151                   if (MRB & AliasAnalysis::Ref)
 152                     // Ok, it reads non-local memory.
 153                     ReadsMemory = true;
 154                 }
 155               }
 156             }
 157           continue;
 158         }
 159         // The call could access any memory. If that includes writes, give up.
 160         if (MRB & AliasAnalysis::Mod)
 161           return false;
 162         // If it reads, note it.
 163         if (MRB & AliasAnalysis::Ref)
 164           ReadsMemory = true;
 165         continue;
 166       } else if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 167         // Ignore non-volatile loads from local memory.
 168         if (!LI->isVolatile()) {
 169           AliasAnalysis::Location Loc(LI->getPointerOperand(),
 170                                         AA->getTypeStoreSize(LI->getType()),
 171                                         LI->getMetadata(LLVMContext::MD_tbaa));
 172           if (AA->pointsToConstantMemory(Loc, /*OrLocal=*/true))
 173             continue;
 174         }
 175       } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 176         // Ignore non-volatile stores to local memory.
 177         if (!SI->isVolatile()) {
 178           const Type *StoredType = SI->getValueOperand()->getType();
 179           AliasAnalysis::Location Loc(SI->getPointerOperand(),
 180                                       AA->getTypeStoreSize(StoredType),
 181                                       SI->getMetadata(LLVMContext::MD_tbaa));
 182           if (AA->pointsToConstantMemory(Loc, /*OrLocal=*/true))
 183             continue;
 184         }
 185       } else if (VAArgInst *VI = dyn_cast<VAArgInst>(I)) {
 186         // Ignore vaargs on local memory.
 187         AliasAnalysis::Location Loc(VI->getPointerOperand(),
 188                                     AliasAnalysis::UnknownSize,
 189                                     VI->getMetadata(LLVMContext::MD_tbaa));
 190         if (AA->pointsToConstantMemory(Loc, /*OrLocal=*/true))
 191           continue;
 192       }
 193
 194       // Any remaining instructions need to be taken seriously!  Check if they
 195       // read or write memory.
 196       if (I->mayWriteToMemory())
 197         // Writes memory.  Just give up.
 198         return false;
 199
 200       // If this instruction may read memory, remember that.
 201       ReadsMemory |= I->mayReadFromMemory();
 202     }
 203   }
 204
 205   // Success!  Functions in this SCC do not access memory, or only read memory.
 206   // Give them the appropriate attribute.
 207   bool MadeChange = false;
 208   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
 209     Function *F = (*I)->getFunction();
 210
 211     if (F->doesNotAccessMemory())
 212       // Already perfect!
 213       continue;
 214
 215     if (F->onlyReadsMemory() && ReadsMemory)
 216       // No change.
 217       continue;
 218
 219     MadeChange = true;
 220
 221     // Clear out any existing attributes.
 222     F->removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
 223
 224     // Add in the new attribute.
 225     F->addAttribute(~0, ReadsMemory? Attribute::ReadOnly : Attribute::ReadNone);
 226
 227     if (ReadsMemory)
 228       ++NumReadOnly;
 229     else
 230       ++NumReadNone;
 231   }
 232
 233   return MadeChange;
 234 }
 235
 236 /// AddNoCaptureAttrs - Deduce nocapture attributes for the SCC.
 237 bool FunctionAttrs::AddNoCaptureAttrs(const CallGraphSCC &SCC) {
 238   bool Changed = false;
 239
 240   // Check each function in turn, determining which pointer arguments are not
 241   // captured.
 242   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
 243     Function *F = (*I)->getFunction();
 244
 245     if (F == 0)
 246       // External node - skip it;
 247       continue;
 248
 249     // Definitions with weak linkage may be overridden at linktime with
 250     // something that writes memory, so treat them like declarations.
 251     if (F->isDeclaration() || F->mayBeOverridden())
 252       continue;
 253
 254     for (Function::arg_iterator A = F->arg_begin(), E = F->arg_end(); A!=E; ++A)
 255       if (A->getType()->isPointerTy() && !A->hasNoCaptureAttr() &&
 256           !PointerMayBeCaptured(A, true, /*StoreCaptures=*/false)) {
 257         A->addAttr(Attribute::NoCapture);
 258         ++NumNoCapture;
 259         Changed = true;
 260       }
 261   }
 262
 263   return Changed;
 264 }
 265
 266 /// IsFunctionMallocLike - A function is malloc-like if it returns either null
 267 /// or a pointer that doesn't alias any other pointer visible to the caller.
 268 bool FunctionAttrs::IsFunctionMallocLike(Function *F,
 269                               SmallPtrSet<Function*, 8> &SCCNodes) const {
 270   UniqueVector<Value *> FlowsToReturn;
 271   for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
 272     if (ReturnInst *Ret = dyn_cast<ReturnInst>(I->getTerminator()))
 273       FlowsToReturn.insert(Ret->getReturnValue());
 274
 275   for (unsigned i = 0; i != FlowsToReturn.size(); ++i) {
 276     Value *RetVal = FlowsToReturn[i+1];   // UniqueVector[0] is reserved.
 277
 278     if (Constant *C = dyn_cast<Constant>(RetVal)) {
 279       if (!C->isNullValue() && !isa<UndefValue>(C))
 280         return false;
 281
 282       continue;
 283     }
 284
 285     if (isa<Argument>(RetVal))
 286       return false;
 287
 288     if (Instruction *RVI = dyn_cast<Instruction>(RetVal))
 289       switch (RVI->getOpcode()) {
 290         // Extend the analysis by looking upwards.
 291         case Instruction::BitCast:
 292         case Instruction::GetElementPtr:
 293           FlowsToReturn.insert(RVI->getOperand(0));
 294           continue;
 295         case Instruction::Select: {
 296           SelectInst *SI = cast<SelectInst>(RVI);
 297           FlowsToReturn.insert(SI->getTrueValue());
 298           FlowsToReturn.insert(SI->getFalseValue());
 299           continue;
 300         }
 301         case Instruction::PHI: {
 302           PHINode *PN = cast<PHINode>(RVI);
 303           for (int i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 304             FlowsToReturn.insert(PN->getIncomingValue(i));
 305           continue;
 306         }
 307
 308         // Check whether the pointer came from an allocation.
 309         case Instruction::Alloca:
 310           break;
 311         case Instruction::Call:
 312         case Instruction::Invoke: {
 313           CallSite CS(RVI);
 314           if (CS.paramHasAttr(0, Attribute::NoAlias))
 315             break;
 316           if (CS.getCalledFunction() &&
 317               SCCNodes.count(CS.getCalledFunction()))
 318             break;
 319         } // fall-through
 320         default:
 321           return false;  // Did not come from an allocation.
 322       }
 323
 324     if (PointerMayBeCaptured(RetVal, false, /*StoreCaptures=*/false))
 325       return false;
 326   }
 327
 328   return true;
 329 }
 330
 331 /// AddNoAliasAttrs - Deduce noalias attributes for the SCC.
 332 bool FunctionAttrs::AddNoAliasAttrs(const CallGraphSCC &SCC) {
 333   SmallPtrSet<Function*, 8> SCCNodes;
 334
 335   // Fill SCCNodes with the elements of the SCC.  Used for quickly
 336   // looking up whether a given CallGraphNode is in this SCC.
 337   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I)
 338     SCCNodes.insert((*I)->getFunction());
 339
 340   // Check each function in turn, determining which functions return noalias
 341   // pointers.
 342   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
 343     Function *F = (*I)->getFunction();
 344
 345     if (F == 0)
 346       // External node - skip it;
 347       return false;
 348
 349     // Already noalias.
 350     if (F->doesNotAlias(0))
 351       continue;
 352
 353     // Definitions with weak linkage may be overridden at linktime, so
 354     // treat them like declarations.
 355     if (F->isDeclaration() || F->mayBeOverridden())
 356       return false;
 357
 358     // We annotate noalias return values, which are only applicable to
 359     // pointer types.
 360     if (!F->getReturnType()->isPointerTy())
 361       continue;
 362
 363     if (!IsFunctionMallocLike(F, SCCNodes))
 364       return false;
 365   }
 366
 367   bool MadeChange = false;
 368   for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
 369     Function *F = (*I)->getFunction();
 370     if (F->doesNotAlias(0) || !F->getReturnType()->isPointerTy())
 371       continue;
 372
 373     F->setDoesNotAlias(0);
 374     ++NumNoAlias;
 375     MadeChange = true;
 376   }
 377
 378   return MadeChange;
 379 }
 380
 381 bool FunctionAttrs::runOnSCC(CallGraphSCC &SCC) {
 382   AA = &getAnalysis<AliasAnalysis>();
 383
 384   bool Changed = AddReadAttrs(SCC);
 385   Changed |= AddNoCaptureAttrs(SCC);
 386   Changed |= AddNoAliasAttrs(SCC);
 387   return Changed;
 388 }