File: AddImplicitArgs.hpp

package info (click to toggle)
intel-graphics-compiler2 2.16.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 106,644 kB
  • sloc: cpp: 805,640; lisp: 287,672; ansic: 16,414; python: 3,952; yacc: 2,588; lex: 1,666; pascal: 313; sh: 186; makefile: 35
file content (134 lines) | stat: -rw-r--r-- 4,698 bytes parent folder | download
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*========================== begin_copyright_notice ============================

Copyright (C) 2017-2021 Intel Corporation

SPDX-License-Identifier: MIT

============================= end_copyright_notice ===========================*/

#pragma once

#include "AdaptorCommon/ImplicitArgs.hpp"
#include "Compiler/MetaDataUtilsWrapper.h"

#include "common/LLVMWarningsPush.hpp"
#include <llvm/Pass.h>
#include <llvm/Analysis/CallGraph.h>
#include "common/LLVMWarningsPop.hpp"

#include <set>
#include <map>

namespace IGC {
class CodeGenContext;
}

namespace IGC {
// struct
typedef std::map<unsigned int, llvm::Argument *> InfoToImpArgMap;
typedef std::map<llvm::Function *, InfoToImpArgMap> FuncInfoToImpArgMap;

typedef std::map<llvm::Argument *, unsigned int> ImpArgToExpNum;
typedef std::map<llvm::Function *, ImpArgToExpNum> FuncImpToExpNumMap;

/// @brief  AddImplicitArgs pass used for changing the function signatures and calls to represent
///         the implicit arguments needed by each function and passed from the OpenCL runtime
///         This pass depdends on the WIFuncAnalysis pass runing before it
/// @Author Marina Yatsina
class AddImplicitArgs : public llvm::ModulePass {
public:
  // Pass identification, replacement for typeid
  static char ID;

  /// @brief  Constructor
  AddImplicitArgs();

  /// @brief  Destructor
  ~AddImplicitArgs() {}

  /// @brief  Provides name of pass
  virtual llvm::StringRef getPassName() const override { return "AddImplicitArgs"; }

  virtual void getAnalysisUsage(llvm::AnalysisUsage &AU) const override {
    AU.addRequired<CodeGenContextWrapper>();
    AU.addRequired<MetaDataUtilsWrapper>();
  }

  /// @brief  Main entry point.
  ///         Goes over all functions and changes their signature to contain the implicit arguments
  ///         needed by each function, goes over all function calls and adds the implicit arguments
  ///         to the function calls
  /// @param  M The destination module.
  virtual bool runOnModule(llvm::Module &M) override;

  /// @brief  Check if a function has a stackcall in its call path to
  ///         decide whether implicit args should be added
  /// @param  pFunc           Source function
  static bool hasStackCallInCG(const llvm::Function *pFunc);

private:
  /// @brief  Create the type of the new function,
  ///         including all explicit and needed impliict parameters
  /// @param  pFunc           The old function
  /// @param  pImplicitArgs   The implicit arguments needed by this function
  /// @returns    The new function type
  static llvm::FunctionType *getNewFuncType(const llvm::Function *pFunc, const ImplicitArgs &implicitArgs);

  /// @brief  Transfers uses of old arguments to new arguments, sets names of all arguments
  /// @param  pFunc           The old function
  /// @param  pNewFunc        The new function
  /// @param  pImplicitArgs   The implicit arguments needed by this function
  void updateNewFuncArgs(llvm::Function *pFunc, llvm::Function *pNewFunc, const ImplicitArgs &implicitArgs);

  /// @brief  Replace old CallInst with new CallInst
  void replaceAllUsesWithNewOCLBuiltinFunction(llvm::Function *old_func, llvm::Function *new_func);

  static llvm::Value *coerce(llvm::Value *arg, llvm::Type *type, llvm::Instruction *insertBefore);

  /// @brief  Metadata API object.
  IGC::IGCMD::MetaDataUtils *m_pMdUtils;

  FuncInfoToImpArgMap m_FuncInfoToImpArgMap;
  FuncImpToExpNumMap m_FuncImpToExpNumMap;
};

} // namespace IGC

// Builtin CallGraph Analysis Class
namespace IGC {

struct ImplicitArgumentDetail {
  ImplicitArg::ArgMap ArgsMaps;
  std::set<unsigned int> StructArgSet;
};

class BuiltinCallGraphAnalysis : public llvm::ModulePass {
public:
  static char ID;

  BuiltinCallGraphAnalysis();
  ~BuiltinCallGraphAnalysis() {}

  virtual llvm::StringRef getPassName() const override { return "BuiltinCallGraphAnalysis"; }

  void getAnalysisUsage(llvm::AnalysisUsage &AU) const override {
    AU.addRequired<MetaDataUtilsWrapper>();
    AU.addRequired<CodeGenContextWrapper>();
    AU.addRequired<llvm::CallGraphWrapperPass>();
  }

  virtual bool runOnModule(llvm::Module &M) override;

  void traverseCallGraphSCC(const std::vector<llvm::CallGraphNode *> &SCCNodes);
  void combineTwoArgDetail(ImplicitArgumentDetail &, const ImplicitArgumentDetail &, llvm::Value *) const;
  void writeBackAllIntoMetaData(const ImplicitArgumentDetail &, llvm::Function *);

  bool pruneCallGraphForStackCalls(llvm::CallGraph &CG);

private:
  IGC::IGCMD::MetaDataUtils *m_pMdUtils;
  llvm::SmallDenseMap<llvm::Function *, ImplicitArgumentDetail *> argMap;
  llvm::SmallVector<std::unique_ptr<ImplicitArgumentDetail>, 4> argDetails;
};

} // namespace IGC