contrib/llvm/lib/Analysis/CFLSteensAliasAnalysis.cpp

   1 //- CFLSteensAliasAnalysis.cpp - Unification-based Alias Analysis ---*- 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 // This file implements a CFL-base, summary-based alias analysis algorithm. It
  11 // does not depend on types. The algorithm is a mixture of the one described in
  12 // "Demand-driven alias analysis for C" by Xin Zheng and Radu Rugina, and "Fast
  13 // algorithms for Dyck-CFL-reachability with applications to Alias Analysis" by
  14 // Zhang Q, Lyu M R, Yuan H, and Su Z. -- to summarize the papers, we build a
  15 // graph of the uses of a variable, where each node is a memory location, and
  16 // each edge is an action that happened on that memory location.  The "actions"
  17 // can be one of Dereference, Reference, or Assign. The precision of this
  18 // analysis is roughly the same as that of an one level context-sensitive
  19 // Steensgaard's algorithm.
  20 //
  21 // Two variables are considered as aliasing iff you can reach one value's node
  22 // from the other value's node and the language formed by concatenating all of
  23 // the edge labels (actions) conforms to a context-free grammar.
  24 //
  25 // Because this algorithm requires a graph search on each query, we execute the
  26 // algorithm outlined in "Fast algorithms..." (mentioned above)
  27 // in order to transform the graph into sets of variables that may alias in
  28 // ~nlogn time (n = number of variables), which makes queries take constant
  29 // time.
  30 //===----------------------------------------------------------------------===//
  31
  32 // N.B. AliasAnalysis as a whole is phrased as a FunctionPass at the moment, and
  33 // CFLSteensAA is interprocedural. This is *technically* A Bad Thing, because
  34 // FunctionPasses are only allowed to inspect the Function that they're being
  35 // run on. Realistically, this likely isn't a problem until we allow
  36 // FunctionPasses to run concurrently.
  37
  38 #include "llvm/Analysis/CFLSteensAliasAnalysis.h"
  39 #include "CFLGraph.h"
  40 #include "StratifiedSets.h"
  41 #include "llvm/ADT/DenseMap.h"
  42 #include "llvm/ADT/None.h"
  43 #include "llvm/ADT/Optional.h"
  44 #include "llvm/Analysis/TargetLibraryInfo.h"
  45 #include "llvm/IR/Constants.h"
  46 #include "llvm/IR/Function.h"
  47 #include "llvm/Pass.h"
  48 #include "llvm/Support/Compiler.h"
  49 #include "llvm/Support/Debug.h"
  50 #include "llvm/Support/ErrorHandling.h"
  51 #include "llvm/Support/raw_ostream.h"
  52 #include <algorithm>
  53 #include <cassert>
  54 #include <memory>
  55 #include <tuple>
  56
  57 using namespace llvm;
  58 using namespace llvm::cflaa;
  59
  60 #define DEBUG_TYPE "cfl-steens-aa"
  61
  62 CFLSteensAAResult::CFLSteensAAResult(const TargetLibraryInfo &TLI)
  63     : AAResultBase(), TLI(TLI) {}
  64 CFLSteensAAResult::CFLSteensAAResult(CFLSteensAAResult &&Arg)
  65     : AAResultBase(std::move(Arg)), TLI(Arg.TLI) {}
  66 CFLSteensAAResult::~CFLSteensAAResult() {}
  67
  68 /// Information we have about a function and would like to keep around.
  69 class CFLSteensAAResult::FunctionInfo {
  70   StratifiedSets<InstantiatedValue> Sets;
  71   AliasSummary Summary;
  72
  73 public:
  74   FunctionInfo(Function &Fn, const SmallVectorImpl<Value *> &RetVals,
  75                StratifiedSets<InstantiatedValue> S);
  76
  77   const StratifiedSets<InstantiatedValue> &getStratifiedSets() const {
  78     return Sets;
  79   }
  80   const AliasSummary &getAliasSummary() const { return Summary; }
  81 };
  82
  83 const StratifiedIndex StratifiedLink::SetSentinel =
  84     std::numeric_limits<StratifiedIndex>::max();
  85
  86 //===----------------------------------------------------------------------===//
  87 // Function declarations that require types defined in the namespace above
  88 //===----------------------------------------------------------------------===//
  89
  90 /// Determines whether it would be pointless to add the given Value to our sets.
  91 static bool canSkipAddingToSets(Value *Val) {
  92   // Constants can share instances, which may falsely unify multiple
  93   // sets, e.g. in
  94   // store i32* null, i32** %ptr1
  95   // store i32* null, i32** %ptr2
  96   // clearly ptr1 and ptr2 should not be unified into the same set, so
  97   // we should filter out the (potentially shared) instance to
  98   // i32* null.
  99   if (isa<Constant>(Val)) {
 100     // TODO: Because all of these things are constant, we can determine whether
 101     // the data is *actually* mutable at graph building time. This will probably
 102     // come for free/cheap with offset awareness.
 103     bool CanStoreMutableData = isa<GlobalValue>(Val) ||
 104                                isa<ConstantExpr>(Val) ||
 105                                isa<ConstantAggregate>(Val);
 106     return !CanStoreMutableData;
 107   }
 108
 109   return false;
 110 }
 111
 112 CFLSteensAAResult::FunctionInfo::FunctionInfo(
 113     Function &Fn, const SmallVectorImpl<Value *> &RetVals,
 114     StratifiedSets<InstantiatedValue> S)
 115     : Sets(std::move(S)) {
 116   // Historically, an arbitrary upper-bound of 50 args was selected. We may want
 117   // to remove this if it doesn't really matter in practice.
 118   if (Fn.arg_size() > MaxSupportedArgsInSummary)
 119     return;
 120
 121   DenseMap<StratifiedIndex, InterfaceValue> InterfaceMap;
 122
 123   // Our intention here is to record all InterfaceValues that share the same
 124   // StratifiedIndex in RetParamRelations. For each valid InterfaceValue, we
 125   // have its StratifiedIndex scanned here and check if the index is presented
 126   // in InterfaceMap: if it is not, we add the correspondence to the map;
 127   // otherwise, an aliasing relation is found and we add it to
 128   // RetParamRelations.
 129
 130   auto AddToRetParamRelations = [&](unsigned InterfaceIndex,
 131                                     StratifiedIndex SetIndex) {
 132     unsigned Level = 0;
 133     while (true) {
 134       InterfaceValue CurrValue{InterfaceIndex, Level};
 135
 136       auto Itr = InterfaceMap.find(SetIndex);
 137       if (Itr != InterfaceMap.end()) {
 138         if (CurrValue != Itr->second)
 139           Summary.RetParamRelations.push_back(
 140               ExternalRelation{CurrValue, Itr->second, UnknownOffset});
 141         break;
 142       }
 143
 144       auto &Link = Sets.getLink(SetIndex);
 145       InterfaceMap.insert(std::make_pair(SetIndex, CurrValue));
 146       auto ExternalAttrs = getExternallyVisibleAttrs(Link.Attrs);
 147       if (ExternalAttrs.any())
 148         Summary.RetParamAttributes.push_back(
 149             ExternalAttribute{CurrValue, ExternalAttrs});
 150
 151       if (!Link.hasBelow())
 152         break;
 153
 154       ++Level;
 155       SetIndex = Link.Below;
 156     }
 157   };
 158
 159   // Populate RetParamRelations for return values
 160   for (auto *RetVal : RetVals) {
 161     assert(RetVal != nullptr);
 162     assert(RetVal->getType()->isPointerTy());
 163     auto RetInfo = Sets.find(InstantiatedValue{RetVal, 0});
 164     if (RetInfo.hasValue())
 165       AddToRetParamRelations(0, RetInfo->Index);
 166   }
 167
 168   // Populate RetParamRelations for parameters
 169   unsigned I = 0;
 170   for (auto &Param : Fn.args()) {
 171     if (Param.getType()->isPointerTy()) {
 172       auto ParamInfo = Sets.find(InstantiatedValue{&Param, 0});
 173       if (ParamInfo.hasValue())
 174         AddToRetParamRelations(I + 1, ParamInfo->Index);
 175     }
 176     ++I;
 177   }
 178 }
 179
 180 // Builds the graph + StratifiedSets for a function.
 181 CFLSteensAAResult::FunctionInfo CFLSteensAAResult::buildSetsFrom(Function *Fn) {
 182   CFLGraphBuilder<CFLSteensAAResult> GraphBuilder(*this, TLI, *Fn);
 183   StratifiedSetsBuilder<InstantiatedValue> SetBuilder;
 184
 185   // Add all CFLGraph nodes and all Dereference edges to StratifiedSets
 186   auto &Graph = GraphBuilder.getCFLGraph();
 187   for (const auto &Mapping : Graph.value_mappings()) {
 188     auto Val = Mapping.first;
 189     if (canSkipAddingToSets(Val))
 190       continue;
 191     auto &ValueInfo = Mapping.second;
 192
 193     assert(ValueInfo.getNumLevels() > 0);
 194     SetBuilder.add(InstantiatedValue{Val, 0});
 195     SetBuilder.noteAttributes(InstantiatedValue{Val, 0},
 196                               ValueInfo.getNodeInfoAtLevel(0).Attr);
 197     for (unsigned I = 0, E = ValueInfo.getNumLevels() - 1; I < E; ++I) {
 198       SetBuilder.add(InstantiatedValue{Val, I + 1});
 199       SetBuilder.noteAttributes(InstantiatedValue{Val, I + 1},
 200                                 ValueInfo.getNodeInfoAtLevel(I + 1).Attr);
 201       SetBuilder.addBelow(InstantiatedValue{Val, I},
 202                           InstantiatedValue{Val, I + 1});
 203     }
 204   }
 205
 206   // Add all assign edges to StratifiedSets
 207   for (const auto &Mapping : Graph.value_mappings()) {
 208     auto Val = Mapping.first;
 209     if (canSkipAddingToSets(Val))
 210       continue;
 211     auto &ValueInfo = Mapping.second;
 212
 213     for (unsigned I = 0, E = ValueInfo.getNumLevels(); I < E; ++I) {
 214       auto Src = InstantiatedValue{Val, I};
 215       for (auto &Edge : ValueInfo.getNodeInfoAtLevel(I).Edges)
 216         SetBuilder.addWith(Src, Edge.Other);
 217     }
 218   }
 219
 220   return FunctionInfo(*Fn, GraphBuilder.getReturnValues(), SetBuilder.build());
 221 }
 222
 223 void CFLSteensAAResult::scan(Function *Fn) {
 224   auto InsertPair = Cache.insert(std::make_pair(Fn, Optional<FunctionInfo>()));
 225   (void)InsertPair;
 226   assert(InsertPair.second &&
 227          "Trying to scan a function that has already been cached");
 228
 229   // Note that we can't do Cache[Fn] = buildSetsFrom(Fn) here: the function call
 230   // may get evaluated after operator[], potentially triggering a DenseMap
 231   // resize and invalidating the reference returned by operator[]
 232   auto FunInfo = buildSetsFrom(Fn);
 233   Cache[Fn] = std::move(FunInfo);
 234
 235   Handles.emplace_front(Fn, this);
 236 }
 237
 238 void CFLSteensAAResult::evict(Function *Fn) { Cache.erase(Fn); }
 239
 240 /// Ensures that the given function is available in the cache, and returns the
 241 /// entry.
 242 const Optional<CFLSteensAAResult::FunctionInfo> &
 243 CFLSteensAAResult::ensureCached(Function *Fn) {
 244   auto Iter = Cache.find(Fn);
 245   if (Iter == Cache.end()) {
 246     scan(Fn);
 247     Iter = Cache.find(Fn);
 248     assert(Iter != Cache.end());
 249     assert(Iter->second.hasValue());
 250   }
 251   return Iter->second;
 252 }
 253
 254 const AliasSummary *CFLSteensAAResult::getAliasSummary(Function &Fn) {
 255   auto &FunInfo = ensureCached(&Fn);
 256   if (FunInfo.hasValue())
 257     return &FunInfo->getAliasSummary();
 258   else
 259     return nullptr;
 260 }
 261
 262 AliasResult CFLSteensAAResult::query(const MemoryLocation &LocA,
 263                                      const MemoryLocation &LocB) {
 264   auto *ValA = const_cast<Value *>(LocA.Ptr);
 265   auto *ValB = const_cast<Value *>(LocB.Ptr);
 266
 267   if (!ValA->getType()->isPointerTy() || !ValB->getType()->isPointerTy())
 268     return NoAlias;
 269
 270   Function *Fn = nullptr;
 271   Function *MaybeFnA = const_cast<Function *>(parentFunctionOfValue(ValA));
 272   Function *MaybeFnB = const_cast<Function *>(parentFunctionOfValue(ValB));
 273   if (!MaybeFnA && !MaybeFnB) {
 274     // The only times this is known to happen are when globals + InlineAsm are
 275     // involved
 276     DEBUG(dbgs()
 277           << "CFLSteensAA: could not extract parent function information.\n");
 278     return MayAlias;
 279   }
 280
 281   if (MaybeFnA) {
 282     Fn = MaybeFnA;
 283     assert((!MaybeFnB || MaybeFnB == MaybeFnA) &&
 284            "Interprocedural queries not supported");
 285   } else {
 286     Fn = MaybeFnB;
 287   }
 288
 289   assert(Fn != nullptr);
 290   auto &MaybeInfo = ensureCached(Fn);
 291   assert(MaybeInfo.hasValue());
 292
 293   auto &Sets = MaybeInfo->getStratifiedSets();
 294   auto MaybeA = Sets.find(InstantiatedValue{ValA, 0});
 295   if (!MaybeA.hasValue())
 296     return MayAlias;
 297
 298   auto MaybeB = Sets.find(InstantiatedValue{ValB, 0});
 299   if (!MaybeB.hasValue())
 300     return MayAlias;
 301
 302   auto SetA = *MaybeA;
 303   auto SetB = *MaybeB;
 304   auto AttrsA = Sets.getLink(SetA.Index).Attrs;
 305   auto AttrsB = Sets.getLink(SetB.Index).Attrs;
 306
 307   // If both values are local (meaning the corresponding set has attribute
 308   // AttrNone or AttrEscaped), then we know that CFLSteensAA fully models them:
 309   // they may-alias each other if and only if they are in the same set.
 310   // If at least one value is non-local (meaning it either is global/argument or
 311   // it comes from unknown sources like integer cast), the situation becomes a
 312   // bit more interesting. We follow three general rules described below:
 313   // - Non-local values may alias each other
 314   // - AttrNone values do not alias any non-local values
 315   // - AttrEscaped do not alias globals/arguments, but they may alias
 316   // AttrUnknown values
 317   if (SetA.Index == SetB.Index)
 318     return MayAlias;
 319   if (AttrsA.none() || AttrsB.none())
 320     return NoAlias;
 321   if (hasUnknownOrCallerAttr(AttrsA) || hasUnknownOrCallerAttr(AttrsB))
 322     return MayAlias;
 323   if (isGlobalOrArgAttr(AttrsA) && isGlobalOrArgAttr(AttrsB))
 324     return MayAlias;
 325   return NoAlias;
 326 }
 327
 328 AnalysisKey CFLSteensAA::Key;
 329
 330 CFLSteensAAResult CFLSteensAA::run(Function &F, FunctionAnalysisManager &AM) {
 331   return CFLSteensAAResult(AM.getResult<TargetLibraryAnalysis>(F));
 332 }
 333
 334 char CFLSteensAAWrapperPass::ID = 0;
 335 INITIALIZE_PASS(CFLSteensAAWrapperPass, "cfl-steens-aa",
 336                 "Unification-Based CFL Alias Analysis", false, true)
 337
 338 ImmutablePass *llvm::createCFLSteensAAWrapperPass() {
 339   return new CFLSteensAAWrapperPass();
 340 }
 341
 342 CFLSteensAAWrapperPass::CFLSteensAAWrapperPass() : ImmutablePass(ID) {
 343   initializeCFLSteensAAWrapperPassPass(*PassRegistry::getPassRegistry());
 344 }
 345
 346 void CFLSteensAAWrapperPass::initializePass() {
 347   auto &TLIWP = getAnalysis<TargetLibraryInfoWrapperPass>();
 348   Result.reset(new CFLSteensAAResult(TLIWP.getTLI()));
 349 }
 350
 351 void CFLSteensAAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
 352   AU.setPreservesAll();
 353   AU.addRequired<TargetLibraryInfoWrapperPass>();
 354 }