1 //===- AliasAnalysisEvaluator.h - Alias Analysis Accuracy Evaluator -------===// 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 /// \file 9 /// 10 /// This file implements a simple N^2 alias analysis accuracy evaluator. The 11 /// analysis result is a set of statistics of how many times the AA 12 /// infrastructure provides each kind of alias result and mod/ref result when 13 /// queried with all pairs of pointers in the function. 14 /// 15 /// It can be used to evaluate a change in an alias analysis implementation, 16 /// algorithm, or the AA pipeline infrastructure itself. It acts like a stable 17 /// and easily tested consumer of all AA information exposed. 18 /// 19 /// This is inspired and adapted from code by: Naveen Neelakantam, Francesco 20 /// Spadini, and Wojciech Stryjewski. 21 /// 22 //===----------------------------------------------------------------------===// 23 24 #ifndef LLVM_ANALYSIS_ALIASANALYSISEVALUATOR_H 25 #define LLVM_ANALYSIS_ALIASANALYSISEVALUATOR_H 26 27 #include "llvm/IR/PassManager.h" 28 29 namespace llvm { 30 class AAResults; 31 class Function; 32 class FunctionPass; 33 34 class AAEvaluator : public PassInfoMixin<AAEvaluator> { 35 int64_t FunctionCount = 0; 36 int64_t NoAliasCount = 0, MayAliasCount = 0, PartialAliasCount = 0; 37 int64_t MustAliasCount = 0; 38 int64_t NoModRefCount = 0, ModCount = 0, RefCount = 0, ModRefCount = 0; 39 int64_t MustCount = 0, MustRefCount = 0, MustModCount = 0; 40 int64_t MustModRefCount = 0; 41 42 public: 43 AAEvaluator() = default; 44 AAEvaluator(AAEvaluator &&Arg) 45 : FunctionCount(Arg.FunctionCount), NoAliasCount(Arg.NoAliasCount), 46 MayAliasCount(Arg.MayAliasCount), 47 PartialAliasCount(Arg.PartialAliasCount), 48 MustAliasCount(Arg.MustAliasCount), NoModRefCount(Arg.NoModRefCount), 49 ModCount(Arg.ModCount), RefCount(Arg.RefCount), 50 ModRefCount(Arg.ModRefCount), MustCount(Arg.MustCount), 51 MustRefCount(Arg.MustRefCount), MustModCount(Arg.MustModCount), 52 MustModRefCount(Arg.MustModRefCount) { 53 Arg.FunctionCount = 0; 54 } 55 ~AAEvaluator(); 56 57 /// Run the pass over the function. 58 PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM); 59 60 private: 61 // Allow the legacy pass to run this using an internal API. 62 friend class AAEvalLegacyPass; 63 64 void runInternal(Function &F, AAResults &AA); 65 }; 66 67 /// Create a wrapper of the above for the legacy pass manager. 68 FunctionPass *createAAEvalPass(); 69 70 } 71 72 #endif 73