1 //===- StackSafetyAnalysis.cpp - Stack memory safety analysis -------------===//
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 //===----------------------------------------------------------------------===//
10 
11 #include "llvm/Analysis/StackSafetyAnalysis.h"
12 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
13 #include "llvm/IR/CallSite.h"
14 #include "llvm/IR/InstIterator.h"
15 #include "llvm/IR/IntrinsicInst.h"
16 #include "llvm/InitializePasses.h"
17 #include "llvm/Support/raw_ostream.h"
18 
19 using namespace llvm;
20 
21 #define DEBUG_TYPE "stack-safety"
22 
23 static cl::opt<int> StackSafetyMaxIterations("stack-safety-max-iterations",
24                                              cl::init(20), cl::Hidden);
25 
26 namespace {
27 
28 /// Rewrite an SCEV expression for a memory access address to an expression that
29 /// represents offset from the given alloca.
30 class AllocaOffsetRewriter : public SCEVRewriteVisitor<AllocaOffsetRewriter> {
31   const Value *AllocaPtr;
32 
33 public:
34   AllocaOffsetRewriter(ScalarEvolution &SE, const Value *AllocaPtr)
35       : SCEVRewriteVisitor(SE), AllocaPtr(AllocaPtr) {}
36 
37   const SCEV *visit(const SCEV *Expr) {
38     // Only re-write the expression if the alloca is used in an addition
39     // expression (it can be used in other types of expressions if it's cast to
40     // an int and passed as an argument.)
41     if (!isa<SCEVAddRecExpr>(Expr) && !isa<SCEVAddExpr>(Expr) &&
42         !isa<SCEVUnknown>(Expr))
43       return Expr;
44     return SCEVRewriteVisitor<AllocaOffsetRewriter>::visit(Expr);
45   }
46 
47   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
48     // FIXME: look through one or several levels of definitions?
49     // This can be inttoptr(AllocaPtr) and SCEV would not unwrap
50     // it for us.
51     if (Expr->getValue() == AllocaPtr)
52       return SE.getZero(Expr->getType());
53     return Expr;
54   }
55 };
56 
57 /// Describes use of address in as a function call argument.
58 struct PassAsArgInfo {
59   /// Function being called.
60   const GlobalValue *Callee = nullptr;
61   /// Index of argument which pass address.
62   size_t ParamNo = 0;
63   // Offset range of address from base address (alloca or calling function
64   // argument).
65   // Range should never set to empty-set, that is an invalid access range
66   // that can cause empty-set to be propagated with ConstantRange::add
67   ConstantRange Offset;
68   PassAsArgInfo(const GlobalValue *Callee, size_t ParamNo, ConstantRange Offset)
69       : Callee(Callee), ParamNo(ParamNo), Offset(Offset) {}
70 
71   StringRef getName() const { return Callee->getName(); }
72 };
73 
74 raw_ostream &operator<<(raw_ostream &OS, const PassAsArgInfo &P) {
75   return OS << "@" << P.getName() << "(arg" << P.ParamNo << ", " << P.Offset
76             << ")";
77 }
78 
79 /// Describe uses of address (alloca or parameter) inside of the function.
80 struct UseInfo {
81   // Access range if the address (alloca or parameters).
82   // It is allowed to be empty-set when there are no known accesses.
83   ConstantRange Range;
84 
85   // List of calls which pass address as an argument.
86   SmallVector<PassAsArgInfo, 4> Calls;
87 
88   explicit UseInfo(unsigned PointerSize) : Range{PointerSize, false} {}
89 
90   void updateRange(ConstantRange R) { Range = Range.unionWith(R); }
91 };
92 
93 raw_ostream &operator<<(raw_ostream &OS, const UseInfo &U) {
94   OS << U.Range;
95   for (auto &Call : U.Calls)
96     OS << ", " << Call;
97   return OS;
98 }
99 
100 struct AllocaInfo {
101   const AllocaInst *AI = nullptr;
102   uint64_t Size = 0;
103   UseInfo Use;
104 
105   AllocaInfo(unsigned PointerSize, const AllocaInst *AI, uint64_t Size)
106       : AI(AI), Size(Size), Use(PointerSize) {}
107 
108   StringRef getName() const { return AI->getName(); }
109 };
110 
111 raw_ostream &operator<<(raw_ostream &OS, const AllocaInfo &A) {
112   return OS << A.getName() << "[" << A.Size << "]: " << A.Use;
113 }
114 
115 struct ParamInfo {
116   const Argument *Arg = nullptr;
117   UseInfo Use;
118 
119   explicit ParamInfo(unsigned PointerSize, const Argument *Arg)
120       : Arg(Arg), Use(PointerSize) {}
121 
122   StringRef getName() const { return Arg ? Arg->getName() : "<N/A>"; }
123 };
124 
125 raw_ostream &operator<<(raw_ostream &OS, const ParamInfo &P) {
126   return OS << P.getName() << "[]: " << P.Use;
127 }
128 
129 /// Calculate the allocation size of a given alloca. Returns 0 if the
130 /// size can not be statically determined.
131 uint64_t getStaticAllocaAllocationSize(const AllocaInst *AI) {
132   const DataLayout &DL = AI->getModule()->getDataLayout();
133   uint64_t Size = DL.getTypeAllocSize(AI->getAllocatedType());
134   if (AI->isArrayAllocation()) {
135     auto C = dyn_cast<ConstantInt>(AI->getArraySize());
136     if (!C)
137       return 0;
138     Size *= C->getZExtValue();
139   }
140   return Size;
141 }
142 
143 } // end anonymous namespace
144 
145 /// Describes uses of allocas and parameters inside of a single function.
146 struct StackSafetyInfo::FunctionInfo {
147   // May be a Function or a GlobalAlias
148   const GlobalValue *GV = nullptr;
149   // Informations about allocas uses.
150   SmallVector<AllocaInfo, 4> Allocas;
151   // Informations about parameters uses.
152   SmallVector<ParamInfo, 4> Params;
153   // TODO: describe return value as depending on one or more of its arguments.
154 
155   // StackSafetyDataFlowAnalysis counter stored here for faster access.
156   int UpdateCount = 0;
157 
158   FunctionInfo(const StackSafetyInfo &SSI) : FunctionInfo(*SSI.Info) {}
159 
160   explicit FunctionInfo(const Function *F) : GV(F){};
161   // Creates FunctionInfo that forwards all the parameters to the aliasee.
162   explicit FunctionInfo(const GlobalAlias *A);
163 
164   FunctionInfo(FunctionInfo &&) = default;
165 
166   bool IsDSOLocal() const { return GV->isDSOLocal(); };
167 
168   bool IsInterposable() const { return GV->isInterposable(); };
169 
170   StringRef getName() const { return GV->getName(); }
171 
172   void print(raw_ostream &O) const {
173     // TODO: Consider different printout format after
174     // StackSafetyDataFlowAnalysis. Calls and parameters are irrelevant then.
175     O << "  @" << getName() << (IsDSOLocal() ? "" : " dso_preemptable")
176       << (IsInterposable() ? " interposable" : "") << "\n";
177     O << "    args uses:\n";
178     for (auto &P : Params)
179       O << "      " << P << "\n";
180     O << "    allocas uses:\n";
181     for (auto &AS : Allocas)
182       O << "      " << AS << "\n";
183   }
184 
185 private:
186   FunctionInfo(const FunctionInfo &) = default;
187 };
188 
189 StackSafetyInfo::FunctionInfo::FunctionInfo(const GlobalAlias *A) : GV(A) {
190   unsigned PointerSize = A->getParent()->getDataLayout().getPointerSizeInBits();
191   const GlobalObject *Aliasee = A->getBaseObject();
192   const FunctionType *Type = cast<FunctionType>(Aliasee->getValueType());
193   // 'Forward' all parameters to this alias to the aliasee
194   for (unsigned ArgNo = 0; ArgNo < Type->getNumParams(); ArgNo++) {
195     Params.emplace_back(PointerSize, nullptr);
196     UseInfo &US = Params.back().Use;
197     US.Calls.emplace_back(Aliasee, ArgNo, ConstantRange(APInt(PointerSize, 0)));
198   }
199 }
200 
201 namespace {
202 
203 class StackSafetyLocalAnalysis {
204   const Function &F;
205   const DataLayout &DL;
206   ScalarEvolution &SE;
207   unsigned PointerSize = 0;
208 
209   const ConstantRange UnknownRange;
210 
211   ConstantRange offsetFromAlloca(Value *Addr, const Value *AllocaPtr);
212   ConstantRange getAccessRange(Value *Addr, const Value *AllocaPtr,
213                                uint64_t AccessSize);
214   ConstantRange getMemIntrinsicAccessRange(const MemIntrinsic *MI, const Use &U,
215                                            const Value *AllocaPtr);
216 
217   bool analyzeAllUses(const Value *Ptr, UseInfo &AS);
218 
219   ConstantRange getRange(uint64_t Lower, uint64_t Upper) const {
220     return ConstantRange(APInt(PointerSize, Lower), APInt(PointerSize, Upper));
221   }
222 
223 public:
224   StackSafetyLocalAnalysis(const Function &F, ScalarEvolution &SE)
225       : F(F), DL(F.getParent()->getDataLayout()), SE(SE),
226         PointerSize(DL.getPointerSizeInBits()),
227         UnknownRange(PointerSize, true) {}
228 
229   // Run the transformation on the associated function.
230   StackSafetyInfo run();
231 };
232 
233 ConstantRange
234 StackSafetyLocalAnalysis::offsetFromAlloca(Value *Addr,
235                                            const Value *AllocaPtr) {
236   if (!SE.isSCEVable(Addr->getType()))
237     return UnknownRange;
238 
239   AllocaOffsetRewriter Rewriter(SE, AllocaPtr);
240   const SCEV *Expr = Rewriter.visit(SE.getSCEV(Addr));
241   ConstantRange Offset = SE.getUnsignedRange(Expr).zextOrTrunc(PointerSize);
242   assert(!Offset.isEmptySet());
243   return Offset;
244 }
245 
246 ConstantRange StackSafetyLocalAnalysis::getAccessRange(Value *Addr,
247                                                        const Value *AllocaPtr,
248                                                        uint64_t AccessSize) {
249   if (!SE.isSCEVable(Addr->getType()))
250     return UnknownRange;
251 
252   AllocaOffsetRewriter Rewriter(SE, AllocaPtr);
253   const SCEV *Expr = Rewriter.visit(SE.getSCEV(Addr));
254 
255   ConstantRange AccessStartRange =
256       SE.getUnsignedRange(Expr).zextOrTrunc(PointerSize);
257   ConstantRange SizeRange = getRange(0, AccessSize);
258   ConstantRange AccessRange = AccessStartRange.add(SizeRange);
259   assert(!AccessRange.isEmptySet());
260   return AccessRange;
261 }
262 
263 ConstantRange StackSafetyLocalAnalysis::getMemIntrinsicAccessRange(
264     const MemIntrinsic *MI, const Use &U, const Value *AllocaPtr) {
265   if (auto MTI = dyn_cast<MemTransferInst>(MI)) {
266     if (MTI->getRawSource() != U && MTI->getRawDest() != U)
267       return getRange(0, 1);
268   } else {
269     if (MI->getRawDest() != U)
270       return getRange(0, 1);
271   }
272   const auto *Len = dyn_cast<ConstantInt>(MI->getLength());
273   // Non-constant size => unsafe. FIXME: try SCEV getRange.
274   if (!Len)
275     return UnknownRange;
276   ConstantRange AccessRange = getAccessRange(U, AllocaPtr, Len->getZExtValue());
277   return AccessRange;
278 }
279 
280 /// The function analyzes all local uses of Ptr (alloca or argument) and
281 /// calculates local access range and all function calls where it was used.
282 bool StackSafetyLocalAnalysis::analyzeAllUses(const Value *Ptr, UseInfo &US) {
283   SmallPtrSet<const Value *, 16> Visited;
284   SmallVector<const Value *, 8> WorkList;
285   WorkList.push_back(Ptr);
286 
287   // A DFS search through all uses of the alloca in bitcasts/PHI/GEPs/etc.
288   while (!WorkList.empty()) {
289     const Value *V = WorkList.pop_back_val();
290     for (const Use &UI : V->uses()) {
291       auto I = cast<const Instruction>(UI.getUser());
292       assert(V == UI.get());
293 
294       switch (I->getOpcode()) {
295       case Instruction::Load: {
296         US.updateRange(
297             getAccessRange(UI, Ptr, DL.getTypeStoreSize(I->getType())));
298         break;
299       }
300 
301       case Instruction::VAArg:
302         // "va-arg" from a pointer is safe.
303         break;
304       case Instruction::Store: {
305         if (V == I->getOperand(0)) {
306           // Stored the pointer - conservatively assume it may be unsafe.
307           US.updateRange(UnknownRange);
308           return false;
309         }
310         US.updateRange(getAccessRange(
311             UI, Ptr, DL.getTypeStoreSize(I->getOperand(0)->getType())));
312         break;
313       }
314 
315       case Instruction::Ret:
316         // Information leak.
317         // FIXME: Process parameters correctly. This is a leak only if we return
318         // alloca.
319         US.updateRange(UnknownRange);
320         return false;
321 
322       case Instruction::Call:
323       case Instruction::Invoke: {
324         ImmutableCallSite CS(I);
325 
326         if (I->isLifetimeStartOrEnd())
327           break;
328 
329         if (const MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I)) {
330           US.updateRange(getMemIntrinsicAccessRange(MI, UI, Ptr));
331           break;
332         }
333 
334         // FIXME: consult devirt?
335         // Do not follow aliases, otherwise we could inadvertently follow
336         // dso_preemptable aliases or aliases with interposable linkage.
337         const GlobalValue *Callee =
338             dyn_cast<GlobalValue>(CS.getCalledValue()->stripPointerCasts());
339         if (!Callee) {
340           US.updateRange(UnknownRange);
341           return false;
342         }
343 
344         assert(isa<Function>(Callee) || isa<GlobalAlias>(Callee));
345 
346         ImmutableCallSite::arg_iterator B = CS.arg_begin(), E = CS.arg_end();
347         for (ImmutableCallSite::arg_iterator A = B; A != E; ++A) {
348           if (A->get() == V) {
349             ConstantRange Offset = offsetFromAlloca(UI, Ptr);
350             US.Calls.emplace_back(Callee, A - B, Offset);
351           }
352         }
353 
354         break;
355       }
356 
357       default:
358         if (Visited.insert(I).second)
359           WorkList.push_back(cast<const Instruction>(I));
360       }
361     }
362   }
363 
364   return true;
365 }
366 
367 StackSafetyInfo StackSafetyLocalAnalysis::run() {
368   StackSafetyInfo::FunctionInfo Info(&F);
369   assert(!F.isDeclaration() &&
370          "Can't run StackSafety on a function declaration");
371 
372   LLVM_DEBUG(dbgs() << "[StackSafety] " << F.getName() << "\n");
373 
374   for (auto &I : instructions(F)) {
375     if (auto AI = dyn_cast<AllocaInst>(&I)) {
376       Info.Allocas.emplace_back(PointerSize, AI,
377                                 getStaticAllocaAllocationSize(AI));
378       AllocaInfo &AS = Info.Allocas.back();
379       analyzeAllUses(AI, AS.Use);
380     }
381   }
382 
383   for (const Argument &A : make_range(F.arg_begin(), F.arg_end())) {
384     Info.Params.emplace_back(PointerSize, &A);
385     ParamInfo &PS = Info.Params.back();
386     analyzeAllUses(&A, PS.Use);
387   }
388 
389   LLVM_DEBUG(dbgs() << "[StackSafety] done\n");
390   LLVM_DEBUG(Info.print(dbgs()));
391   return StackSafetyInfo(std::move(Info));
392 }
393 
394 class StackSafetyDataFlowAnalysis {
395   using FunctionMap =
396       std::map<const GlobalValue *, StackSafetyInfo::FunctionInfo>;
397 
398   FunctionMap Functions;
399   // Callee-to-Caller multimap.
400   DenseMap<const GlobalValue *, SmallVector<const GlobalValue *, 4>> Callers;
401   SetVector<const GlobalValue *> WorkList;
402 
403   unsigned PointerSize = 0;
404   const ConstantRange UnknownRange;
405 
406   ConstantRange getArgumentAccessRange(const GlobalValue *Callee,
407                                        unsigned ParamNo) const;
408   bool updateOneUse(UseInfo &US, bool UpdateToFullSet);
409   void updateOneNode(const GlobalValue *Callee,
410                      StackSafetyInfo::FunctionInfo &FS);
411   void updateOneNode(const GlobalValue *Callee) {
412     updateOneNode(Callee, Functions.find(Callee)->second);
413   }
414   void updateAllNodes() {
415     for (auto &F : Functions)
416       updateOneNode(F.first, F.second);
417   }
418   void runDataFlow();
419 #ifndef NDEBUG
420   void verifyFixedPoint();
421 #endif
422 
423 public:
424   StackSafetyDataFlowAnalysis(
425       Module &M, std::function<const StackSafetyInfo &(Function &)> FI);
426   StackSafetyGlobalInfo run();
427 };
428 
429 StackSafetyDataFlowAnalysis::StackSafetyDataFlowAnalysis(
430     Module &M, std::function<const StackSafetyInfo &(Function &)> FI)
431     : PointerSize(M.getDataLayout().getPointerSizeInBits()),
432       UnknownRange(PointerSize, true) {
433   // Without ThinLTO, run the local analysis for every function in the TU and
434   // then run the DFA.
435   for (auto &F : M.functions())
436     if (!F.isDeclaration())
437       Functions.emplace(&F, FI(F));
438   for (auto &A : M.aliases())
439     if (isa<Function>(A.getBaseObject()))
440       Functions.emplace(&A, StackSafetyInfo::FunctionInfo(&A));
441 }
442 
443 ConstantRange
444 StackSafetyDataFlowAnalysis::getArgumentAccessRange(const GlobalValue *Callee,
445                                                     unsigned ParamNo) const {
446   auto IT = Functions.find(Callee);
447   // Unknown callee (outside of LTO domain or an indirect call).
448   if (IT == Functions.end())
449     return UnknownRange;
450   const StackSafetyInfo::FunctionInfo &FS = IT->second;
451   // The definition of this symbol may not be the definition in this linkage
452   // unit.
453   if (!FS.IsDSOLocal() || FS.IsInterposable())
454     return UnknownRange;
455   if (ParamNo >= FS.Params.size()) // possibly vararg
456     return UnknownRange;
457   return FS.Params[ParamNo].Use.Range;
458 }
459 
460 bool StackSafetyDataFlowAnalysis::updateOneUse(UseInfo &US,
461                                                bool UpdateToFullSet) {
462   bool Changed = false;
463   for (auto &CS : US.Calls) {
464     assert(!CS.Offset.isEmptySet() &&
465            "Param range can't be empty-set, invalid offset range");
466 
467     ConstantRange CalleeRange = getArgumentAccessRange(CS.Callee, CS.ParamNo);
468     CalleeRange = CalleeRange.add(CS.Offset);
469     if (!US.Range.contains(CalleeRange)) {
470       Changed = true;
471       if (UpdateToFullSet)
472         US.Range = UnknownRange;
473       else
474         US.Range = US.Range.unionWith(CalleeRange);
475     }
476   }
477   return Changed;
478 }
479 
480 void StackSafetyDataFlowAnalysis::updateOneNode(
481     const GlobalValue *Callee, StackSafetyInfo::FunctionInfo &FS) {
482   bool UpdateToFullSet = FS.UpdateCount > StackSafetyMaxIterations;
483   bool Changed = false;
484   for (auto &AS : FS.Allocas)
485     Changed |= updateOneUse(AS.Use, UpdateToFullSet);
486   for (auto &PS : FS.Params)
487     Changed |= updateOneUse(PS.Use, UpdateToFullSet);
488 
489   if (Changed) {
490     LLVM_DEBUG(dbgs() << "=== update [" << FS.UpdateCount
491                       << (UpdateToFullSet ? ", full-set" : "") << "] "
492                       << FS.getName() << "\n");
493     // Callers of this function may need updating.
494     for (auto &CallerID : Callers[Callee])
495       WorkList.insert(CallerID);
496 
497     ++FS.UpdateCount;
498   }
499 }
500 
501 void StackSafetyDataFlowAnalysis::runDataFlow() {
502   Callers.clear();
503   WorkList.clear();
504 
505   SmallVector<const GlobalValue *, 16> Callees;
506   for (auto &F : Functions) {
507     Callees.clear();
508     StackSafetyInfo::FunctionInfo &FS = F.second;
509     for (auto &AS : FS.Allocas)
510       for (auto &CS : AS.Use.Calls)
511         Callees.push_back(CS.Callee);
512     for (auto &PS : FS.Params)
513       for (auto &CS : PS.Use.Calls)
514         Callees.push_back(CS.Callee);
515 
516     llvm::sort(Callees);
517     Callees.erase(std::unique(Callees.begin(), Callees.end()), Callees.end());
518 
519     for (auto &Callee : Callees)
520       Callers[Callee].push_back(F.first);
521   }
522 
523   updateAllNodes();
524 
525   while (!WorkList.empty()) {
526     const GlobalValue *Callee = WorkList.back();
527     WorkList.pop_back();
528     updateOneNode(Callee);
529   }
530 }
531 
532 #ifndef NDEBUG
533 void StackSafetyDataFlowAnalysis::verifyFixedPoint() {
534   WorkList.clear();
535   updateAllNodes();
536   assert(WorkList.empty());
537 }
538 #endif
539 
540 StackSafetyGlobalInfo StackSafetyDataFlowAnalysis::run() {
541   runDataFlow();
542   LLVM_DEBUG(verifyFixedPoint());
543 
544   StackSafetyGlobalInfo SSI;
545   for (auto &F : Functions)
546     SSI.emplace(F.first, std::move(F.second));
547   return SSI;
548 }
549 
550 void print(const StackSafetyGlobalInfo &SSI, raw_ostream &O, const Module &M) {
551   size_t Count = 0;
552   for (auto &F : M.functions())
553     if (!F.isDeclaration()) {
554       SSI.find(&F)->second.print(O);
555       O << "\n";
556       ++Count;
557     }
558   for (auto &A : M.aliases()) {
559     SSI.find(&A)->second.print(O);
560     O << "\n";
561     ++Count;
562   }
563   assert(Count == SSI.size() && "Unexpected functions in the result");
564 }
565 
566 } // end anonymous namespace
567 
568 StackSafetyInfo::StackSafetyInfo() = default;
569 StackSafetyInfo::StackSafetyInfo(StackSafetyInfo &&) = default;
570 StackSafetyInfo &StackSafetyInfo::operator=(StackSafetyInfo &&) = default;
571 
572 StackSafetyInfo::StackSafetyInfo(FunctionInfo &&Info)
573     : Info(new FunctionInfo(std::move(Info))) {}
574 
575 StackSafetyInfo::~StackSafetyInfo() = default;
576 
577 void StackSafetyInfo::print(raw_ostream &O) const { Info->print(O); }
578 
579 AnalysisKey StackSafetyAnalysis::Key;
580 
581 StackSafetyInfo StackSafetyAnalysis::run(Function &F,
582                                          FunctionAnalysisManager &AM) {
583   StackSafetyLocalAnalysis SSLA(F, AM.getResult<ScalarEvolutionAnalysis>(F));
584   return SSLA.run();
585 }
586 
587 PreservedAnalyses StackSafetyPrinterPass::run(Function &F,
588                                               FunctionAnalysisManager &AM) {
589   OS << "'Stack Safety Local Analysis' for function '" << F.getName() << "'\n";
590   AM.getResult<StackSafetyAnalysis>(F).print(OS);
591   return PreservedAnalyses::all();
592 }
593 
594 char StackSafetyInfoWrapperPass::ID = 0;
595 
596 StackSafetyInfoWrapperPass::StackSafetyInfoWrapperPass() : FunctionPass(ID) {
597   initializeStackSafetyInfoWrapperPassPass(*PassRegistry::getPassRegistry());
598 }
599 
600 void StackSafetyInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
601   AU.addRequired<ScalarEvolutionWrapperPass>();
602   AU.setPreservesAll();
603 }
604 
605 void StackSafetyInfoWrapperPass::print(raw_ostream &O, const Module *M) const {
606   SSI.print(O);
607 }
608 
609 bool StackSafetyInfoWrapperPass::runOnFunction(Function &F) {
610   StackSafetyLocalAnalysis SSLA(
611       F, getAnalysis<ScalarEvolutionWrapperPass>().getSE());
612   SSI = StackSafetyInfo(SSLA.run());
613   return false;
614 }
615 
616 AnalysisKey StackSafetyGlobalAnalysis::Key;
617 
618 StackSafetyGlobalInfo
619 StackSafetyGlobalAnalysis::run(Module &M, ModuleAnalysisManager &AM) {
620   FunctionAnalysisManager &FAM =
621       AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
622 
623   StackSafetyDataFlowAnalysis SSDFA(
624       M, [&FAM](Function &F) -> const StackSafetyInfo & {
625         return FAM.getResult<StackSafetyAnalysis>(F);
626       });
627   return SSDFA.run();
628 }
629 
630 PreservedAnalyses StackSafetyGlobalPrinterPass::run(Module &M,
631                                                     ModuleAnalysisManager &AM) {
632   OS << "'Stack Safety Analysis' for module '" << M.getName() << "'\n";
633   print(AM.getResult<StackSafetyGlobalAnalysis>(M), OS, M);
634   return PreservedAnalyses::all();
635 }
636 
637 char StackSafetyGlobalInfoWrapperPass::ID = 0;
638 
639 StackSafetyGlobalInfoWrapperPass::StackSafetyGlobalInfoWrapperPass()
640     : ModulePass(ID) {
641   initializeStackSafetyGlobalInfoWrapperPassPass(
642       *PassRegistry::getPassRegistry());
643 }
644 
645 void StackSafetyGlobalInfoWrapperPass::print(raw_ostream &O,
646                                              const Module *M) const {
647   ::print(SSI, O, *M);
648 }
649 
650 void StackSafetyGlobalInfoWrapperPass::getAnalysisUsage(
651     AnalysisUsage &AU) const {
652   AU.addRequired<StackSafetyInfoWrapperPass>();
653 }
654 
655 bool StackSafetyGlobalInfoWrapperPass::runOnModule(Module &M) {
656   StackSafetyDataFlowAnalysis SSDFA(
657       M, [this](Function &F) -> const StackSafetyInfo & {
658         return getAnalysis<StackSafetyInfoWrapperPass>(F).getResult();
659       });
660   SSI = SSDFA.run();
661   return false;
662 }
663 
664 static const char LocalPassArg[] = "stack-safety-local";
665 static const char LocalPassName[] = "Stack Safety Local Analysis";
666 INITIALIZE_PASS_BEGIN(StackSafetyInfoWrapperPass, LocalPassArg, LocalPassName,
667                       false, true)
668 INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass)
669 INITIALIZE_PASS_END(StackSafetyInfoWrapperPass, LocalPassArg, LocalPassName,
670                     false, true)
671 
672 static const char GlobalPassName[] = "Stack Safety Analysis";
673 INITIALIZE_PASS_BEGIN(StackSafetyGlobalInfoWrapperPass, DEBUG_TYPE,
674                       GlobalPassName, false, false)
675 INITIALIZE_PASS_DEPENDENCY(StackSafetyInfoWrapperPass)
676 INITIALIZE_PASS_END(StackSafetyGlobalInfoWrapperPass, DEBUG_TYPE,
677                     GlobalPassName, false, false)
678