File: WIFuncsAnalysis.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 (115 lines) | stat: -rw-r--r-- 4,765 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
/*========================== begin_copyright_notice ============================

Copyright (C) 2017-2021 Intel Corporation

SPDX-License-Identifier: MIT

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

#pragma once

#include "Compiler/MetaDataUtilsWrapper.h"
#include "Compiler/CodeGenContextWrapper.hpp"

#include "common/LLVMWarningsPush.hpp"
#include <llvm/Pass.h>
#include <llvm/IR/InstVisitor.h>
#include <llvm/ADT/StringRef.h>
#include "common/LLVMWarningsPop.hpp"

namespace IGC {
/// @brief  WIFuncsAnalysis pass used for analyzing which OpenCL WI (work item) functions
///         are used in the different functions in the module and creating metadata that represents
///         the implicit information needed by each function for resolving these function calls

class WIFuncsAnalysis : public llvm::ModulePass, public llvm::InstVisitor<WIFuncsAnalysis> {
public:
  // Pass identification, replacement for typeid
  static char ID;

  /// @brief  Constructor
  WIFuncsAnalysis();

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

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

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

  /// @brief  Main entry point.
  ///         Runs on all functions defined in the given module, finds all OpenCL WI function calls,
  ///         analyzes them and creates metadata that represents the implicit information needed
  ///         by each function for resolving these function calls
  /// @param  M The destination module.
  virtual bool runOnModule(llvm::Module &M) override;

  /// @brief  Call instructions visitor.
  ///         Checks for OpenCL WI functions and analyzes it
  /// @param  CI The call instruction.
  void visitCallInst(llvm::CallInst &CI);

  static const llvm::StringRef GET_LOCAL_ID_X;
  static const llvm::StringRef GET_LOCAL_ID_Y;
  static const llvm::StringRef GET_LOCAL_ID_Z;
  static const llvm::StringRef GET_GROUP_ID;
  static const llvm::StringRef GET_LOCAL_THREAD_ID;
  static const llvm::StringRef GET_GLOBAL_SIZE;
  static const llvm::StringRef GET_LOCAL_SIZE;
  static const llvm::StringRef GET_GLOBAL_OFFSET;
  static const llvm::StringRef GET_WORK_DIM;
  static const llvm::StringRef GET_NUM_GROUPS;
  static const llvm::StringRef GET_ENQUEUED_LOCAL_SIZE;
  static const llvm::StringRef GET_STAGE_IN_GRID_ORIGIN;
  static const llvm::StringRef GET_STAGE_IN_GRID_SIZE;
  static const llvm::StringRef GET_SYNC_BUFFER;
  static const llvm::StringRef GET_ASSERT_BUFFER;

private:
  /// @brief  Function entry point.
  ///         Finds all OpenCL WI (Work item) function calls in this function, analyzes them and creates
  ///         metadata that represents the implicit information needed by this function
  ///         for resolving these function calls
  /// @param  F The destination function.
  bool runOnFunction(llvm::Function &F);

  /// @brief  Marks whether group id is needed by the current function
  bool m_hasGroupID = false;
  /// @brief  Marks whether local thread id is needed by the current function
  bool m_hasLocalThreadID = false;
  /// @brief  Marks whether global offset is needed by the current function
  bool m_hasGlobalOffset = false;
  /// @brief  Marks whether local id is needed by the current function
  bool m_hasLocalID = false;
  /// @brief  Marks whether global size is needed by the current function
  bool m_hasGlobalSize = false;
  /// @brief  Marks whether local size is needed by the current function
  bool m_hasLocalSize = false;
  /// @brief  Marks whether work dimension is needed by the current function
  bool m_hasWorkDim = false;
  /// @brief  Marks whether number of work groups is needed by the current function
  bool m_hasNumGroups = false;
  /// @brief  Marks whether enqueued local size is needed by the current function
  bool m_hasEnqueuedLocalSize = false;
  /// @brief  Marks whether stage_in_grid_origin is needed by the current function
  bool m_hasStageInGridOrigin = false;
  /// @brief  Marks whether stage_in_grid_size is needed by the current function
  bool m_hasStageInGridSize = false;
  /// @brief  Marks whether sync buffer is needed by the current function
  bool m_hasSyncBuffer = false;
  /// @brief  Marks whether assert buffer is needed by the current function
  bool m_hasAssertBuffer = false;
  /// @brief Marks whether kernel has stackcalls
  bool m_hasStackCalls = false;

  /// @brief MetaData utils used to generate LLVM metadata
  IGCMD::MetaDataUtils *m_pMDUtils = nullptr;
  /// @brief context for compilation
  IGC::CodeGenContext *m_ctx = nullptr;
};

} // namespace IGC