aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/Analysis/FunctionPropertiesAnalysis.h
blob: 81bdf6fa7b6fb809d19fc2e4c36a65c992e113c0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#pragma once 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic push 
#pragma GCC diagnostic ignored "-Wunused-parameter" 
#endif 
 
//=- FunctionPropertiesAnalysis.h - Function Properties Analysis --*- C++ -*-=// 
// 
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 
// See https://llvm.org/LICENSE.txt for license information. 
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 
// 
//===----------------------------------------------------------------------===// 
// 
// This file defines the FunctionPropertiesInfo and FunctionPropertiesAnalysis 
// classes used to extract function properties. 
// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_FUNCTIONPROPERTIESANALYSIS_H_ 
#define LLVM_FUNCTIONPROPERTIESANALYSIS_H_ 
 
#include "llvm/Analysis/LoopInfo.h" 
#include "llvm/IR/PassManager.h" 
 
namespace llvm { 
class Function; 
 
class FunctionPropertiesInfo { 
public: 
  static FunctionPropertiesInfo getFunctionPropertiesInfo(const Function &F, 
                                                          const LoopInfo &LI); 
 
  void print(raw_ostream &OS) const; 
 
  /// Number of basic blocks 
  int64_t BasicBlockCount = 0; 
 
  /// Number of blocks reached from a conditional instruction, or that are 
  /// 'cases' of a SwitchInstr. 
  // FIXME: We may want to replace this with a more meaningful metric, like 
  // number of conditionally executed blocks: 
  // 'if (a) s();' would be counted here as 2 blocks, just like 
  // 'if (a) s(); else s2(); s3();' would. 
  int64_t BlocksReachedFromConditionalInstruction = 0; 
 
  /// Number of uses of this function, plus 1 if the function is callable 
  /// outside the module. 
  int64_t Uses = 0; 
 
  /// Number of direct calls made from this function to other functions 
  /// defined in this module. 
  int64_t DirectCallsToDefinedFunctions = 0; 
 
  // Load Instruction Count 
  int64_t LoadInstCount = 0; 
 
  // Store Instruction Count 
  int64_t StoreInstCount = 0; 
 
  // Maximum Loop Depth in the Function 
  int64_t MaxLoopDepth = 0; 
 
  // Number of Top Level Loops in the Function 
  int64_t TopLevelLoopCount = 0; 
}; 
 
// Analysis pass 
class FunctionPropertiesAnalysis 
    : public AnalysisInfoMixin<FunctionPropertiesAnalysis> { 
 
public: 
  static AnalysisKey Key; 
 
  using Result = FunctionPropertiesInfo; 
 
  Result run(Function &F, FunctionAnalysisManager &FAM); 
}; 
 
/// Printer pass for the FunctionPropertiesAnalysis results. 
class FunctionPropertiesPrinterPass 
    : public PassInfoMixin<FunctionPropertiesPrinterPass> { 
  raw_ostream &OS; 
 
public: 
  explicit FunctionPropertiesPrinterPass(raw_ostream &OS) : OS(OS) {} 
 
  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM); 
}; 
 
} // namespace llvm 
#endif // LLVM_FUNCTIONPROPERTIESANALYSIS_H_ 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic pop 
#endif