summaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/CodeGen/MachineFunctionPass.h
blob: 3616b90a2485e9f306ad84d81414e4405c0657b8 (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
#pragma once 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic push 
#pragma GCC diagnostic ignored "-Wunused-parameter" 
#endif 
 
//===-- MachineFunctionPass.h - Pass for MachineFunctions --------*-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 MachineFunctionPass class.  MachineFunctionPass's are 
// just FunctionPass's, except they operate on machine code as part of a code 
// generator.  Because they operate on machine code, not the LLVM 
// representation, MachineFunctionPass's are not allowed to modify the LLVM 
// representation.  Due to this limitation, the MachineFunctionPass class takes 
// care of declaring that no LLVM passes are invalidated. 
// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_CODEGEN_MACHINEFUNCTIONPASS_H 
#define LLVM_CODEGEN_MACHINEFUNCTIONPASS_H 
 
#include "llvm/CodeGen/MachineFunction.h" 
#include "llvm/Pass.h" 
 
namespace llvm { 
 
/// MachineFunctionPass - This class adapts the FunctionPass interface to 
/// allow convenient creation of passes that operate on the MachineFunction 
/// representation. Instead of overriding runOnFunction, subclasses 
/// override runOnMachineFunction. 
class MachineFunctionPass : public FunctionPass { 
public: 
  bool doInitialization(Module&) override { 
    // Cache the properties info at module-init time so we don't have to 
    // construct them for every function. 
    RequiredProperties = getRequiredProperties(); 
    SetProperties = getSetProperties(); 
    ClearedProperties = getClearedProperties(); 
    return false; 
  } 
protected: 
  explicit MachineFunctionPass(char &ID) : FunctionPass(ID) {} 
 
  /// runOnMachineFunction - This method must be overloaded to perform the 
  /// desired machine code transformation or analysis. 
  /// 
  virtual bool runOnMachineFunction(MachineFunction &MF) = 0; 
 
  /// getAnalysisUsage - Subclasses that override getAnalysisUsage 
  /// must call this. 
  /// 
  /// For MachineFunctionPasses, calling AU.preservesCFG() indicates that 
  /// the pass does not modify the MachineBasicBlock CFG. 
  /// 
  void getAnalysisUsage(AnalysisUsage &AU) const override; 
 
  virtual MachineFunctionProperties getRequiredProperties() const { 
    return MachineFunctionProperties(); 
  } 
  virtual MachineFunctionProperties getSetProperties() const { 
    return MachineFunctionProperties(); 
  } 
  virtual MachineFunctionProperties getClearedProperties() const { 
    return MachineFunctionProperties(); 
  } 
 
private: 
  MachineFunctionProperties RequiredProperties; 
  MachineFunctionProperties SetProperties; 
  MachineFunctionProperties ClearedProperties; 
 
  /// createPrinterPass - Get a machine function printer pass. 
  Pass *createPrinterPass(raw_ostream &O, 
                          const std::string &Banner) const override; 
 
  bool runOnFunction(Function &F) override; 
}; 
 
} // End llvm namespace 
 
#endif 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic pop 
#endif