File: NamedBarriersResolution.cpp

package info (click to toggle)
intel-graphics-compiler 1.0.12504.6-1%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 83,912 kB
  • sloc: cpp: 910,147; lisp: 202,655; ansic: 15,197; python: 4,025; yacc: 2,241; lex: 1,570; pascal: 244; sh: 104; makefile: 25
file content (422 lines) | stat: -rw-r--r-- 15,667 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
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*========================== begin_copyright_notice ============================

Copyright (C) 2020-2021 Intel Corporation

SPDX-License-Identifier: MIT

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

#include "Compiler/Optimizer/OpenCLPasses/NamedBarriers/NamedBarriersResolution.hpp"
#include "Compiler/Optimizer/OpenCLPasses/KernelArgs.hpp"
#include "Compiler/IGCPassSupport.h"
#include "common/LLVMWarningsPush.hpp"
#include <llvm/IR/Function.h>
#include <llvmWrapper/IR/Instructions.h>
#include "common/LLVMWarningsPop.hpp"
#ifndef DX_ONLY_IGC
#ifndef VK_ONLY_IGC
#include <AdaptorOCL/SPIRV/SPIRVInternal.h>
#endif //#ifndef VK_ONLY_IGC
#endif //#ifndef DX_ONLY_IGC
#include "MDFrameWork.h"
#include "Probe/Assertion.h"

#ifndef DX_ONLY_IGC
#ifndef VK_ONLY_IGC
using namespace igc_spv;
#endif //#ifndef VK_ONLY_IGC
#endif //#ifndef DX_ONLY_IGC
using namespace llvm;
using namespace IGC;
using namespace IGC::IGCMD;

// Register pass to igc-opt
#define PASS_FLAG "igc-named-barriers-resolution"
#define PASS_DESCRIPTION "Resolves named barriers"
#define PASS_CFG_ONLY false
#define PASS_ANALYSIS false
IGC_INITIALIZE_PASS_BEGIN(NamedBarriersResolution, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)
IGC_INITIALIZE_PASS_DEPENDENCY(MetaDataUtilsWrapper)
IGC_INITIALIZE_PASS_END(NamedBarriersResolution, PASS_FLAG, PASS_DESCRIPTION, PASS_CFG_ONLY, PASS_ANALYSIS)

char NamedBarriersResolution::ID = 0;

const char* NamedBarriersResolution::NAMED_BARRIERS_INIT = "_Z18named_barrier_initi";
const char* NamedBarriersResolution::NAMED_BARRIERS_BARRIER_ARG2 = "_Z24work_group_named_barrierPU3AS314__namedBarrierj";
const char* NamedBarriersResolution::NAMED_BARRIERS_BARRIER_ARG3 = "_Z24work_group_named_barrierPU3AS314__namedBarrierj12memory_scope";

const int NamedBarriersResolution::GetMaxNamedBarriers()
{
    if (NamedBarrierHWSupport())
    {
        // User can define only 32 named barriers,
        // The TG barrier is an alias for named barrier 0
        return 32;
    }
    return 8;
}

NamedBarriersResolution::NamedBarriersResolution() : ModulePass(ID)
{
    m_CountNamedBarriers = 0;
    m_GFX_GEN = IGFX_BROADWELL;
    m_NamedBarrierType = nullptr;
    m_NamedBarrierID = nullptr;
    m_NamedBarrierArray = nullptr;
    initializeNamedBarriersResolutionPass(*PassRegistry::getPassRegistry());
}

NamedBarriersResolution::NamedBarriersResolution(PRODUCT_FAMILY GFX_GEN) : ModulePass(ID)
{
    m_CountNamedBarriers = 0;
    m_GFX_GEN = GFX_GEN;
    m_NamedBarrierType = nullptr;
    m_NamedBarrierID = nullptr;
    m_NamedBarrierArray = nullptr;
    initializeNamedBarriersResolutionPass(*PassRegistry::getPassRegistry());
}

NamedBarriersResolution::~NamedBarriersResolution(void)
{ }

void NamedBarriersResolution::initGlobalVariables(llvm::Module* Module, llvm::Type* NamedBarrierStructType)
{
#ifndef DX_ONLY_IGC
#ifndef VK_ONLY_IGC
    LLVMContext& context = Module->getContext();

    m_NamedBarrierType = NamedBarrierStructType;
    llvm::Type* NamedBarrierArrayType = ArrayType::get(m_NamedBarrierType, uint64_t(GetMaxNamedBarriers()));

    m_NamedBarrierArray = new GlobalVariable(*Module, NamedBarrierArrayType, false,
        GlobalVariable::InternalLinkage, ConstantAggregateZero::get(NamedBarrierArrayType),
        "NamedBarrierArray", nullptr,
        GlobalVariable::ThreadLocalMode::NotThreadLocal,
        SPIRAS_Local);
    m_NamedBarrierID = new GlobalVariable(*Module, Type::getInt32Ty(context), false,
        GlobalVariable::InternalLinkage,
        ConstantInt::get(Type::getInt32Ty(context), 0),
        "NamedBarrierID", nullptr,
        GlobalVariable::ThreadLocalMode::NotThreadLocal,
        SPIRAS_Local);
#endif //#ifndef VK_ONLY_IGC
#endif //#ifndef DX_ONLY_IGC
}

bool NamedBarriersResolution::runOnModule(Module& M)
{
    Function* nbarrierInitF = nullptr;
    Function* nbarrierBarrierF = nullptr;

    for (auto& func : M.getFunctionList())
    {
        StringRef funcName = func.getName();
        if (funcName.equals(NamedBarriersResolution::NAMED_BARRIERS_INIT))
        {
            nbarrierInitF = &func;
        }
        else if (funcName.equals(NamedBarriersResolution::NAMED_BARRIERS_BARRIER_ARG2) ||
            funcName.equals(NamedBarriersResolution::NAMED_BARRIERS_BARRIER_ARG3))
        {
            nbarrierBarrierF = &func;
        }
        else
        {
            visit(func);
        }
    }

    if (NamedBarrierHWSupport())
    {
        // Remove not needed wrapper for Init NBarrier built-in
        for (const auto& [barrierStruct, barrierData] : m_MapInitToID)
        {
            // We dont need any more the store instruction for nbarrier struct
            for (auto user : barrierData.threadGroupNBarrierInit->users())
            {
                if (StoreInst* storeInst = dyn_cast<StoreInst>(user))
                {
                    storeInst->eraseFromParent();
                    break;
                }
            }
            barrierData.threadGroupNBarrierInit->eraseFromParent();
        }
        // Add attribute NBarrierCnt to metadata
        auto MD = getAnalysis<MetaDataUtilsWrapper>().getModuleMetaData();
        MD->NBarrierCnt = m_CountNamedBarriers;
    }
    if (IsNamedBarriersAdded())
    {
        // Remove not needed declaration
        nbarrierInitF->eraseFromParent();
        nbarrierBarrierF->eraseFromParent();
    }

    return IsNamedBarriersAdded();
}

Value* NamedBarriersResolution::FindAllocStructNBarrier(Value* Val, bool IsNBarrierInitCall)
{
    // We need to find pointer to the nbarrier structure to map
    // together named_barrier_init and work_group_named_barrier calls to have the same nbarrier ID
    if (IsNBarrierInitCall)
    {
        // The init call "named_barrier_init" will return the result to
        // store instruction which is writing to the allocated nbarrier struct (which we are looking for).
        // example:
        // %a = alloca %struct.__namedBarrier addrspace(3)*, align 8 // <- looking for
        // ...
        // %call = call spir_func %struct.__namedBarrier addrspace(3)* @_Z18named_barrier_initi(i32 1) #0
        // store %struct.__namedBarrier addrspace(3)* %call, %struct.__namedBarrier addrspace(3)** %a, align 8
        for (auto user : Val->users())
        {
            if (StoreInst* storeInst = dyn_cast<StoreInst>(user))
            {
                return storeInst->getPointerOperand();
            }
        }
        // If nbarrier struct is not used in any store instruction, it means that Mem2Reg optimization has optimized
        // alloca out and the result of named_barrier_init function is used directly in named_barriers calls
        return Val;
    }
    else
    {
        // The barrier call "work_group_named_barrier" will use previously called instruction
        // load which is pointing to the allocated nbarrier struct (which we are looking for).
        // example:
        // %a = alloca %struct.__namedBarrier addrspace(3)*, align 8 // <- looking for
        // ...
        // %1 = load %struct.__namedBarrier addrspace(3)*, %struct.__namedBarrier addrspace(3)** %a, align 8
        // call spir_func void @_Z24work_group_named_barrierPU3AS314__namedBarrierj(%struct.__namedBarrier addrspace(3)* %1, i32 1) #0
        if (LoadInst* loadInst = dyn_cast<LoadInst>(Val))
        {
            return loadInst->getPointerOperand();
        }
        // If "work_group_named_barrier" call uses NBarrier directly from "named_barriers_init", it means that alloca
        // has been optimized out by Mem2Reg optimization
        else if (CallInst* callInst = dyn_cast<CallInst>(Val))
        {
            StringRef funcName = callInst->getCalledFunction()->getName();
            IGC_ASSERT_MESSAGE(isNamedBarrierInit(funcName), "NamedBarriersResolution : Incorrect work_group_named_barrier signature");
            return callInst;
        }
        IGC_ASSERT_MESSAGE(0, "NamedBarriersResolution : Missing NBarrier struct in work_group_named_barrier function call");
    }
    return nullptr;
}

void NamedBarriersResolution::HandleNamedBarrierInitHW(CallInst& NBarrierInitCall)
{
#ifndef DX_ONLY_IGC
#ifndef VK_ONLY_IGC
    m_CountNamedBarriers++;
    IGC_ASSERT_MESSAGE(m_CountNamedBarriers <= GetMaxNamedBarriers(), "NamedBarriersResolution : We crossed the max of amount of named barriers!");
    Module* module = NBarrierInitCall.getModule();

    Value* threadGroupNBarrierID = (Value*)getInt32(module, m_CountNamedBarriers);
    Value* pointerToNBarrierStruct = FindAllocStructNBarrier((Value*)(&NBarrierInitCall), true);

    s_namedBarrierInfo structNb;
    structNb.threadGroupNBarrierID = threadGroupNBarrierID;
    structNb.threadGroupNBarrierCount = NBarrierInitCall.getArgOperand(0);
    structNb.threadGroupNBarrierInit = &NBarrierInitCall;

    // Map nbarrier struct to the his equal ID
    m_MapInitToID.insert(std::pair<Value*, s_namedBarrierInfo>(
        pointerToNBarrierStruct, structNb));
#endif //#ifndef VK_ONLY_IGC
#endif //#ifndef DX_ONLY_IGC
}

void NamedBarriersResolution::HandleNamedBarrierSyncHW(CallInst& NBarrierSyncCall)
{
    Module* module = NBarrierSyncCall.getModule();

    Value* pointerToNBarrierStruct = FindAllocStructNBarrier(NBarrierSyncCall.getArgOperand(0), false);

    auto nbStruct = m_MapInitToID[pointerToNBarrierStruct];

    IRBuilder<> IRB(&NBarrierSyncCall);

    Value* trueValue = IRB.getInt1(true);
    Value* falseValue = IRB.getInt1(false);

    ConstantInt* memFenceType = dyn_cast<ConstantInt>(NBarrierSyncCall.getArgOperand(1));
    // LOCAL = 1
    // GLOBAL = 2
    Value* isGlobal = ( (int)memFenceType->getValue().getSExtValue() & 2 ) == 2 ? trueValue : falseValue;

    GenIntrinsicInst::Create(
        GenISAIntrinsic::getDeclaration(module, GenISAIntrinsic::GenISA_memoryfence),
        {
            trueValue,  // bool commitEnable
            falseValue, // bool flushRW
            falseValue, // bool flushConstant
            falseValue, // bool flushTexture
            falseValue, // bool flushIcache
            isGlobal,   // bool isGlobal
            falseValue, // bool invalidateL1
        },
        "",
        &(NBarrierSyncCall));

    GenIntrinsicInst::Create(
        GenISAIntrinsic::getDeclaration(module, GenISAIntrinsic::GenISA_threadgroupnamedbarriers_signal),
        { nbStruct.threadGroupNBarrierID, nbStruct.threadGroupNBarrierCount },
        "",
        &(NBarrierSyncCall));

    GenIntrinsicInst::Create(
        GenISAIntrinsic::getDeclaration(module, GenISAIntrinsic::GenISA_threadgroupnamedbarriers_wait),
        { nbStruct.threadGroupNBarrierID },
        "",
        &(NBarrierSyncCall));

    NBarrierSyncCall.eraseFromParent();
}

int NamedBarriersResolution::AlignNBCnt2BarrierNumber(uint NBCnt)
{
    /*
        0   None
        1   B1
        2   B2
        3   B4
        4   B8
        5   B16
        6   B24
        7   B32
    */
    if      (NBCnt > 32) { IGC_ASSERT_EXIT_MESSAGE(0, "NamedBarriersResolution : Incorrect named barrier count"); }
    else if (NBCnt > 24) { return 32; }
    else if (NBCnt > 16) { return 24; }
    else if (NBCnt > 8)  { return 16; }
    else if (NBCnt > 4)  { return 8; }
    else if (NBCnt > 2)  { return 4; }
    else if (NBCnt > 1)  { return 2; }
    else if (NBCnt == 1) { return 1; }
    else                 { return 0; }
}

bool NamedBarriersResolution::isNamedBarrierInit(StringRef& FunctionName)
{
    return FunctionName.equals(NamedBarriersResolution::NAMED_BARRIERS_INIT);
}

bool NamedBarriersResolution::isNamedBarrierSync(StringRef& FunctionName)
{
    return FunctionName.equals(NamedBarriersResolution::NAMED_BARRIERS_BARRIER_ARG2) ||
        FunctionName.equals(NamedBarriersResolution::NAMED_BARRIERS_BARRIER_ARG3);
}

void NamedBarriersResolution::HandleNamedBarrierInitSW(CallInst& NBarrierInitCall)
{
#ifndef DX_ONLY_IGC
#ifndef VK_ONLY_IGC
    IGC_ASSERT_MESSAGE(m_CountNamedBarriers < GetMaxNamedBarriers(), "NamedBarriersResolution : We crossed the max of amount of named barriers!");
    LLVMContext& context = NBarrierInitCall.getCalledFunction()->getContext();
    Module* module = NBarrierInitCall.getModule();

    // Check if we already have setup global variabels
    if (!IsNamedBarriersAdded())
    {
        initGlobalVariables(module, NBarrierInitCall.getType()->getPointerElementType());
    }

    auto newName = "__builtin_spirv_OpNamedBarrierInitialize_i32_p3__namedBarrier_p3i32";
    SmallVector<Type*, 3> ArgsTy
    {
        Type::getInt32Ty(context),
        m_NamedBarrierType->getPointerTo(SPIRAS_Local),
        Type::getInt32PtrTy(context, SPIRAS_Local)
    };
    Type *BaseTy = cast<PointerType>(m_NamedBarrierArray->getType())->getPointerElementType();
    auto pointerNBarrier = GetElementPtrInst::Create(BaseTy, m_NamedBarrierArray, { getInt64(module, 0), getInt32(module, 0) }, "", &(NBarrierInitCall));
    auto bitcastPointerNBarrier = BitCastInst::CreatePointerBitCastOrAddrSpaceCast(pointerNBarrier, m_NamedBarrierType->getPointerTo(SPIRAS_Local), "", &(NBarrierInitCall));
    SmallVector<Value*, 3> ArgsVal
    {
        NBarrierInitCall.getArgOperand(0),
        bitcastPointerNBarrier,
        m_NamedBarrierID
    };
    auto newFType = FunctionType::get(NBarrierInitCall.getType(), ArgsTy, false);
    auto newF = module->getOrInsertFunction(newName, newFType);

    auto newCall = CallInst::Create(newF, ArgsVal, "", &(NBarrierInitCall));
    newCall->setDebugLoc(NBarrierInitCall.getDebugLoc());
    NBarrierInitCall.replaceAllUsesWith(newCall);
    NBarrierInitCall.eraseFromParent();

    m_CountNamedBarriers++;
#endif //#ifndef VK_ONLY_IGC
#endif //#ifndef DX_ONLY_IGC
}

void NamedBarriersResolution::HandleNamedBarrierSyncSW(CallInst& NBarrierSyncCall)
{
#ifndef DX_ONLY_IGC
#ifndef VK_ONLY_IGC
    LLVMContext& context = NBarrierSyncCall.getCalledFunction()->getContext();
    Module* module = NBarrierSyncCall.getModule();

    auto newName = "__builtin_spirv_OpMemoryNamedBarrierWrapperOCL_p3__namedBarrier_i32";
    SmallVector<Type*, 2> ArgsTy
    {
        m_NamedBarrierType->getPointerTo(SPIRAS_Local),
        Type::getInt32Ty(context)
    };
    SmallVector<Value*, 2> ArgsVal
    {
        NBarrierSyncCall.getArgOperand(0),
        NBarrierSyncCall.getArgOperand(1)
    };

    // For overload with 3 arguments
    if (NBarrierSyncCall.getCalledFunction()->arg_size() == 3)
    {
        newName = "__builtin_spirv_OpMemoryNamedBarrierWrapperOCL_p3__namedBarrier_i32_i32";
        ArgsTy.insert(ArgsTy.end(), Type::getInt32Ty(context));
        ArgsVal.insert(ArgsVal.end(), NBarrierSyncCall.getArgOperand(2));
    }

    auto newFType = FunctionType::get(NBarrierSyncCall.getType(), ArgsTy, false);
    auto newF = module->getOrInsertFunction(newName, newFType);

    CallInst* newCall = CallInst::Create(newF, ArgsVal, "", &(NBarrierSyncCall));
    newCall->setDebugLoc(NBarrierSyncCall.getDebugLoc());
    NBarrierSyncCall.eraseFromParent();
#endif //#ifndef VK_ONLY_IGC
#endif //#ifndef DX_ONLY_IGC
}

void NamedBarriersResolution::visitCallInst(CallInst& CI)
{
    Function* func = CI.getCalledFunction();
    if (!func)
    {
        return;
    }

    StringRef funcName = func->getName();

    if (isNamedBarrierInit(funcName))
    {
        NamedBarrierHWSupport()
            ? HandleNamedBarrierInitHW(CI)
            : HandleNamedBarrierInitSW(CI);
    }
    else if (isNamedBarrierSync(funcName))
    {
        NamedBarrierHWSupport()
            ? HandleNamedBarrierSyncHW(CI)
            : HandleNamedBarrierSyncSW(CI);
    }
}


bool NamedBarriersResolution::NamedBarrierHWSupport()
{
    bool hwSupport = m_GFX_GEN == IGFX_PVC;
    return hwSupport;
}