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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*========================== begin_copyright_notice ============================
Copyright (C) 2017-2021 Intel Corporation
SPDX-License-Identifier: MIT
============================= end_copyright_notice ===========================*/
#include "Compiler/Optimizer/OpenCLPasses/ImageFuncs/ImageFuncsAnalysis.hpp"
#include "Compiler/Optimizer/OCLBIUtils.h"
#include "Compiler/IGCPassSupport.h"
#include <set>
#include "Probe/Assertion.h"
using namespace llvm;
using namespace IGC;
// Register pass to igc-opt
#define PASS_FLAG "igc-image-func-analysis"
#define PASS_DESCRIPTION "Analyzes image height, width, depth functions"
#define PASS_CFG_ONLY false
#define PASS_ANALYSIS false
IGC_INITIALIZE_PASS_BEGIN(ImageFuncsAnalysis, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
IGC_INITIALIZE_PASS_DEPENDENCY(MetaDataUtilsWrapper)
IGC_INITIALIZE_PASS_DEPENDENCY(CodeGenContextWrapper)
IGC_INITIALIZE_PASS_END(ImageFuncsAnalysis, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
char ImageFuncsAnalysis::ID = 0;
ImageFuncsAnalysis::ImageFuncsAnalysis() : ModulePass(ID) {
initializeImageFuncsAnalysisPass(*PassRegistry::getPassRegistry());
}
// All image functions needed resolved by implicit arguments
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_HEIGHT = "__builtin_IB_get_image_height";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_WIDTH = "__builtin_IB_get_image_width";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_DEPTH = "__builtin_IB_get_image_depth";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_NUM_MIP_LEVELS = "__builtin_IB_get_image_num_mip_levels";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_CHANNEL_DATA_TYPE = "__builtin_IB_get_image_channel_data_type";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_CHANNEL_ORDER = "__builtin_IB_get_image_channel_order";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_SRGB_CHANNEL_ORDER = "__builtin_IB_get_image_srgb_channel_order";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE1D_ARRAY_SIZE = "__builtin_IB_get_image1d_array_size";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE2D_ARRAY_SIZE = "__builtin_IB_get_image2d_array_size";
const llvm::StringRef ImageFuncsAnalysis::GET_IMAGE_NUM_SAMPLES = "__builtin_IB_get_image_num_samples";
const llvm::StringRef ImageFuncsAnalysis::GET_SAMPLER_ADDRESS_MODE = "__builtin_IB_get_address_mode";
const llvm::StringRef ImageFuncsAnalysis::GET_SAMPLER_NORMALIZED_COORDS = "__builtin_IB_is_normalized_coords";
const llvm::StringRef ImageFuncsAnalysis::GET_SAMPLER_SNAP_WA_REQUIRED = "__builtin_IB_get_snap_wa_reqd";
const llvm::StringRef ImageFuncsAnalysis::GET_FLAT_IMAGE_BASEOFFSET = "__builtin_IB_get_flat_image_baseoffset";
const llvm::StringRef ImageFuncsAnalysis::GET_FLAT_IMAGE_HEIGHT = "__builtin_IB_get_flat_image_height";
const llvm::StringRef ImageFuncsAnalysis::GET_FLAT_IMAGE_WIDTH = "__builtin_IB_get_flat_image_width";
const llvm::StringRef ImageFuncsAnalysis::GET_FLAT_IMAGE_PITCH = "__builtin_IB_get_flat_image_pitch";
bool ImageFuncsAnalysis::runOnModule(Module &M) {
bool changed = false;
m_pMDUtils = getAnalysis<MetaDataUtilsWrapper>().getMetaDataUtils();
CodeGenContext *ctx = getAnalysis<CodeGenContextWrapper>().getCodeGenContext();
m_useAdvancedBindlessMode = ctx->getModuleMetaData()->UseBindlessImage;
m_useBindlessImageWithSamplerTracking = ctx->getModuleMetaData()->UseBindlessImageWithSamplerTracking;
m_useSPVINTELBindlessImages = ctx->getModuleMetaData()->extensions.spvINTELBindlessImages;
// Run on all functions defined in this module
for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
Function *pFunc = &(*I);
if (pFunc->isDeclaration())
continue;
if (runOnFunction(*pFunc)) {
changed = true;
}
}
// Update LLVM metadata based on IGC MetadataUtils
if (changed)
m_pMDUtils->save(M.getContext());
return changed;
}
bool ImageFuncsAnalysis::runOnFunction(Function &F) {
// Visit the function
visit(F);
ImplicitArgs::addImageArgs(F, m_argMap, m_pMDUtils);
m_argMap.clear();
return true;
}
void ImageFuncsAnalysis::visitCallInst(CallInst &CI) {
if (!CI.getCalledFunction()) {
return;
}
StringRef funcName = CI.getCalledFunction()->getName();
// Check for OpenCL image dimension function calls
std::set<int> *imageFunc = nullptr;
if (funcName == GET_IMAGE_HEIGHT && !m_useAdvancedBindlessMode) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_HEIGHT];
} else if (funcName == GET_IMAGE_WIDTH && !m_useAdvancedBindlessMode) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_WIDTH];
} else if (funcName == GET_IMAGE_DEPTH && !m_useAdvancedBindlessMode) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_DEPTH];
} else if (funcName == GET_IMAGE_NUM_MIP_LEVELS) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_NUM_MIP_LEVELS];
} else if (funcName == GET_IMAGE_CHANNEL_DATA_TYPE) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_CHANNEL_DATA_TYPE];
} else if (funcName == GET_IMAGE_CHANNEL_ORDER) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_CHANNEL_ORDER];
} else if (funcName == GET_IMAGE_SRGB_CHANNEL_ORDER) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_SRGB_CHANNEL_ORDER];
} else if ((funcName == GET_IMAGE1D_ARRAY_SIZE || funcName == GET_IMAGE2D_ARRAY_SIZE) && !m_useAdvancedBindlessMode) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_ARRAY_SIZE];
} else if (funcName == GET_IMAGE_NUM_SAMPLES) {
imageFunc = &m_argMap[ImplicitArg::IMAGE_NUM_SAMPLES];
} else if (funcName == GET_SAMPLER_ADDRESS_MODE) {
imageFunc = &m_argMap[ImplicitArg::SAMPLER_ADDRESS];
} else if (funcName == GET_SAMPLER_NORMALIZED_COORDS) {
imageFunc = &m_argMap[ImplicitArg::SAMPLER_NORMALIZED];
}
// The SNAP_WA is disabled for SPV_INTEL_bindless_images extension.
// For further information, refer to the ImageFuncResolution.cpp file.
else if (funcName == GET_SAMPLER_SNAP_WA_REQUIRED && !m_useSPVINTELBindlessImages) {
imageFunc = &m_argMap[ImplicitArg::SAMPLER_SNAP_WA];
} else if (funcName == GET_FLAT_IMAGE_BASEOFFSET) {
imageFunc = &m_argMap[ImplicitArg::FLAT_IMAGE_BASEOFFSET];
} else if (funcName == GET_FLAT_IMAGE_HEIGHT) {
imageFunc = &m_argMap[ImplicitArg::FLAT_IMAGE_HEIGHT];
} else if (funcName == GET_FLAT_IMAGE_WIDTH) {
imageFunc = &m_argMap[ImplicitArg::FLAT_IMAGE_WIDTH];
} else if (funcName == GET_FLAT_IMAGE_PITCH) {
imageFunc = &m_argMap[ImplicitArg::FLAT_IMAGE_PITCH];
} else {
if (funcName.endswith("sample_l") && m_useBindlessImageWithSamplerTracking) {
Value *callArg = ValueTracker::track(&CI, 1, getAnalysis<MetaDataUtilsWrapper>().getMetaDataUtils(),
getAnalysis<MetaDataUtilsWrapper>().getModuleMetaData());
if (!callArg)
return;
if (ConstantInt *ConstInt = dyn_cast<ConstantInt>(callArg)) {
// Inline sampler doesn't associate with an explicit argument.
// To avoid adding a new metadata entry, inline sampler value is stored as
// explicit argument number.
uint64_t InlineSamplerInitValue = ConstInt->getZExtValue();
auto [_, IsNew] = m_argMap[ImplicitArg::INLINE_SAMPLER].insert(int_cast<int>(InlineSamplerInitValue));
if (!IsNew) {
// Sampler initialized by this specific value was already processed.
// No new sampler will be created. Skip creating inline sampler metadata.
return;
}
// Add metadata for the inline sampler.
ModuleMetaData *ModMD = getAnalysis<MetaDataUtilsWrapper>().getModuleMetaData();
FunctionMetaData &FuncMD = ModMD->FuncMD[CI.getFunction()];
ResourceAllocMD &ResAllocMD = FuncMD.resAllocMD;
InlineSamplersMD InlineSamplerMD;
CImagesBI::CreateInlineSamplerAnnotations(CI.getFunction()->getParent(), InlineSamplerMD,
InlineSamplerInitValue);
InlineSamplerMD.index = m_inlineSamplerIndex++;
ResAllocMD.inlineSamplersMD.push_back(InlineSamplerMD);
}
}
// Non image function, do nothing
return;
}
// Extract the arg num and add it to the appropriate data structure
IGC_ASSERT_MESSAGE(IGCLLVM::getNumArgOperands(&CI) == 1,
"Supported image/sampler functions are expected to have only one argument");
// We only care about image and sampler arguments here, inline samplers
// don't require extra kernel parameters.
ModuleMetaData *modMD = getAnalysis<MetaDataUtilsWrapper>().getModuleMetaData();
Value *callArg = ValueTracker::track(&CI, 0, getAnalysis<MetaDataUtilsWrapper>().getMetaDataUtils(), modMD);
// Return false when sampler track back to a SYCL bindless image argment,
// since in this case we don't need implicit args.
auto isImageOrSamplerArgument = [modMD](Argument *arg) {
FunctionMetaData funcMD = modMD->FuncMD.find(arg->getParent())->second;
std::string typeName = funcMD.m_OpenCLArgBaseTypes[arg->getArgNo()];
return typeName.rfind("sampler_t", 0) != std::string::npos || typeName.rfind("image", 0) != std::string::npos;
};
// TODO: For now assume that we may not trace a sampler/texture for indirect access.
// In this case we provide no WA support for indirect case and all WAs will return 0.
// These WAs need to be reworked to support indirect case in the future.
if (callArg) {
if (Argument *arg = dyn_cast<Argument>(callArg)) {
if (isImageOrSamplerArgument(arg)) {
imageFunc->insert(arg->getArgNo());
return;
}
}
}
// Only these args should be hit by the indirect case
IGC_ASSERT(funcName == GET_SAMPLER_ADDRESS_MODE || funcName == GET_SAMPLER_NORMALIZED_COORDS ||
funcName == GET_SAMPLER_SNAP_WA_REQUIRED);
}
|
