Skip to content

Commit e866b4b

Browse files
s-perrons-perron
authored
[SPIRV] Refactor OpExecutionModeId (#7378)
The current implementation of OpExecutionModeId assumes that the operands must be OpConstants. However, they could be the id of a spec constant. The first step in allowing OpExecutionModeId is to modify the internal representation of the instruction to hold general spirv instructions. Part of #5960 and #3092.
1 parent 34b6d0f commit e866b4b

13 files changed

+171
-58
lines changed

‎tools/clang/include/clang/SPIRV/SpirvBuilder.h

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -615,8 +615,15 @@ class SpirvBuilder {
615615
inline SpirvInstruction *addExecutionMode(SpirvFunction *entryPoint,
616616
spv::ExecutionMode em,
617617
llvm::ArrayRef<uint32_t> params,
618-
SourceLocation,
619-
bool useIdParams = false);
618+
SourceLocation);
619+
620+
/// \brief Adds an execution mode to the module under construction if it does
621+
/// not already exist. Return the newly added instruction or the existing
622+
/// instruction, if one already exists.
623+
inline SpirvInstruction *
624+
addExecutionModeId(SpirvFunction *entryPoint, spv::ExecutionMode em,
625+
llvm::ArrayRef<SpirvInstruction *> params,
626+
SourceLocation loc);
620627

621628
/// \brief Adds an OpModuleProcessed instruction to the module under
622629
/// construction.
@@ -963,17 +970,44 @@ SpirvBuilder::setDebugSource(uint32_t major, uint32_t minor,
963970
SpirvInstruction *
964971
SpirvBuilder::addExecutionMode(SpirvFunction *entryPoint, spv::ExecutionMode em,
965972
llvm::ArrayRef<uint32_t> params,
966-
SourceLocation loc, bool useIdParams) {
973+
SourceLocation loc) {
967974
SpirvExecutionMode *mode = nullptr;
968-
SpirvExecutionMode *existingInstruction =
975+
SpirvExecutionModeBase *existingInstruction =
969976
mod->findExecutionMode(entryPoint, em);
970977

971978
if (!existingInstruction) {
972-
mode = new (context)
973-
SpirvExecutionMode(loc, entryPoint, em, params, useIdParams);
979+
mode = new (context) SpirvExecutionMode(loc, entryPoint, em, params);
980+
mod->addExecutionMode(mode);
981+
} else {
982+
// No execution mode can be used with both OpExecutionMode and
983+
// OpExecutionModeId. If this assert is triggered, then either this
984+
// `addExecutionModeId` should have been called with `em` or the existing
985+
// instruction is wrong.
986+
assert(existingInstruction->getKind() ==
987+
SpirvInstruction::IK_ExecutionMode);
988+
mode = cast<SpirvExecutionMode>(existingInstruction);
989+
}
990+
991+
return mode;
992+
}
993+
994+
SpirvInstruction *SpirvBuilder::addExecutionModeId(
995+
SpirvFunction *entryPoint, spv::ExecutionMode em,
996+
llvm::ArrayRef<SpirvInstruction *> params, SourceLocation loc) {
997+
SpirvExecutionModeId *mode = nullptr;
998+
SpirvExecutionModeBase *existingInstruction =
999+
mod->findExecutionMode(entryPoint, em);
1000+
if (!existingInstruction) {
1001+
mode = new (context) SpirvExecutionModeId(loc, entryPoint, em, params);
9741002
mod->addExecutionMode(mode);
9751003
} else {
976-
mode = existingInstruction;
1004+
// No execution mode can be used with both OpExecutionMode and
1005+
// OpExecutionModeId. If this assert is triggered, then either this
1006+
// `addExecutionMode` should have been called with `em` or the existing
1007+
// instruction is wrong.
1008+
assert(existingInstruction->getKind() ==
1009+
SpirvInstruction::IK_ExecutionModeId);
1010+
mode = cast<SpirvExecutionModeId>(existingInstruction);
9771011
}
9781012

9791013
return mode;

‎tools/clang/include/clang/SPIRV/SpirvInstruction.h

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ class SpirvInstruction {
5757
IK_MemoryModel, // OpMemoryModel
5858
IK_EntryPoint, // OpEntryPoint
5959
IK_ExecutionMode, // OpExecutionMode
60+
IK_ExecutionModeId, // OpExecutionModeId
6061
IK_String, // OpString (debug)
6162
IK_Source, // OpSource (debug)
6263
IK_ModuleProcessed, // OpModuleProcessed (debug)
@@ -404,12 +405,34 @@ class SpirvEntryPoint : public SpirvInstruction {
404405
llvm::SmallVector<SpirvVariable *, 8> interfaceVec;
405406
};
406407

408+
class SpirvExecutionModeBase : public SpirvInstruction {
409+
public:
410+
SpirvExecutionModeBase(Kind kind, spv::Op opcode, SourceLocation loc,
411+
SpirvFunction *entryPointFunction,
412+
spv::ExecutionMode executionMode)
413+
: SpirvInstruction(kind, opcode, QualType(), loc),
414+
entryPoint(entryPointFunction), execMode(executionMode) {}
415+
416+
DEFINE_RELEASE_MEMORY_FOR_CLASS(SpirvExecutionModeBase)
417+
418+
// For LLVM-style RTTI
419+
static bool classof(const SpirvInstruction *inst) { return false; }
420+
421+
bool invokeVisitor(Visitor *v) override;
422+
423+
SpirvFunction *getEntryPoint() const { return entryPoint; }
424+
spv::ExecutionMode getExecutionMode() const { return execMode; }
425+
426+
private:
427+
SpirvFunction *entryPoint;
428+
spv::ExecutionMode execMode;
429+
};
430+
407431
/// \brief OpExecutionMode and OpExecutionModeId instructions
408-
class SpirvExecutionMode : public SpirvInstruction {
432+
class SpirvExecutionMode : public SpirvExecutionModeBase {
409433
public:
410434
SpirvExecutionMode(SourceLocation loc, SpirvFunction *entryPointFunction,
411-
spv::ExecutionMode, llvm::ArrayRef<uint32_t> params,
412-
bool usesIdParams);
435+
spv::ExecutionMode, llvm::ArrayRef<uint32_t> params);
413436

414437
DEFINE_RELEASE_MEMORY_FOR_CLASS(SpirvExecutionMode)
415438

@@ -420,16 +443,34 @@ class SpirvExecutionMode : public SpirvInstruction {
420443

421444
bool invokeVisitor(Visitor *v) override;
422445

423-
SpirvFunction *getEntryPoint() const { return entryPoint; }
424-
spv::ExecutionMode getExecutionMode() const { return execMode; }
425446
llvm::ArrayRef<uint32_t> getParams() const { return params; }
426447

427448
private:
428-
SpirvFunction *entryPoint;
429-
spv::ExecutionMode execMode;
430449
llvm::SmallVector<uint32_t, 4> params;
431450
};
432451

452+
/// \brief OpExecutionModeId
453+
class SpirvExecutionModeId : public SpirvExecutionModeBase {
454+
public:
455+
SpirvExecutionModeId(SourceLocation loc, SpirvFunction *entryPointFunction,
456+
spv::ExecutionMode em,
457+
llvm::ArrayRef<SpirvInstruction *> params);
458+
459+
DEFINE_RELEASE_MEMORY_FOR_CLASS(SpirvExecutionModeId)
460+
461+
// For LLVM-style RTTI
462+
static bool classof(const SpirvInstruction *inst) {
463+
return inst->getKind() == IK_ExecutionModeId;
464+
}
465+
466+
bool invokeVisitor(Visitor *v) override;
467+
468+
llvm::ArrayRef<SpirvInstruction *> getParams() const { return params; }
469+
470+
private:
471+
llvm::SmallVector<SpirvInstruction *, 4> params;
472+
};
473+
433474
/// \brief OpString instruction
434475
class SpirvString : public SpirvInstruction {
435476
public:

‎tools/clang/include/clang/SPIRV/SpirvModule.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,11 @@ class SpirvModule {
119119

120120
// Returns an existing execution mode instruction that is the same as em if it
121121
// exists. Return nullptr otherwise.
122-
SpirvExecutionMode *findExecutionMode(SpirvFunction *entryPoint,
123-
spv::ExecutionMode em);
122+
SpirvExecutionModeBase *findExecutionMode(SpirvFunction *entryPoint,
123+
spv::ExecutionMode em);
124124

125125
// Adds an execution mode to the module.
126-
void addExecutionMode(SpirvExecutionMode *);
126+
void addExecutionMode(SpirvExecutionModeBase *em);
127127

128128
// Adds an extension to the module. Returns true if the extension was added.
129129
// Returns false otherwise (e.g. if the extension already existed).
@@ -194,7 +194,7 @@ class SpirvModule {
194194
llvm::SmallVector<SpirvExtInstImport *, 1> extInstSets;
195195
SpirvMemoryModel *memoryModel;
196196
llvm::SmallVector<SpirvEntryPoint *, 1> entryPoints;
197-
llvm::SmallVector<SpirvExecutionMode *, 4> executionModes;
197+
llvm::SmallVector<SpirvExecutionModeBase *, 4> executionModes;
198198
llvm::SmallVector<SpirvString *, 4> constStrings;
199199
std::vector<SpirvSource *> sources;
200200
std::vector<SpirvModuleProcessed *> moduleProcesses;

‎tools/clang/include/clang/SPIRV/SpirvVisitor.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class Visitor {
6464
DEFINE_VISIT_METHOD(SpirvExtInstImport)
6565
DEFINE_VISIT_METHOD(SpirvMemoryModel)
6666
DEFINE_VISIT_METHOD(SpirvEntryPoint)
67-
DEFINE_VISIT_METHOD(SpirvExecutionMode)
67+
DEFINE_VISIT_METHOD(SpirvExecutionModeBase)
6868
DEFINE_VISIT_METHOD(SpirvString)
6969
DEFINE_VISIT_METHOD(SpirvSource)
7070
DEFINE_VISIT_METHOD(SpirvModuleProcessed)

‎tools/clang/lib/SPIRV/CapabilityVisitor.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ bool CapabilityVisitor::visit(SpirvEntryPoint *entryPoint) {
639639
return true;
640640
}
641641

642-
bool CapabilityVisitor::visit(SpirvExecutionMode *execMode) {
642+
bool CapabilityVisitor::visit(SpirvExecutionModeBase *execMode) {
643643
spv::ExecutionMode executionMode = execMode->getExecutionMode();
644644
SourceLocation execModeSourceLocation = execMode->getSourceLocation();
645645
SourceLocation entryPointSourceLocation =

‎tools/clang/lib/SPIRV/CapabilityVisitor.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class CapabilityVisitor : public Visitor {
3131

3232
bool visit(SpirvDecoration *decor) override;
3333
bool visit(SpirvEntryPoint *) override;
34-
bool visit(SpirvExecutionMode *) override;
34+
bool visit(SpirvExecutionModeBase *execMode) override;
3535
bool visit(SpirvImageQuery *) override;
3636
bool visit(SpirvImageOp *) override;
3737
bool visit(SpirvImageSparseTexelsResident *) override;

‎tools/clang/lib/SPIRV/EmitVisitor.cpp

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -617,19 +617,20 @@ bool EmitVisitor::visit(SpirvEntryPoint *inst) {
617617
return true;
618618
}
619619

620-
bool EmitVisitor::visit(SpirvExecutionMode *inst) {
620+
bool EmitVisitor::visit(SpirvExecutionModeBase *inst) {
621621
initInstruction(inst);
622622
curInst.push_back(getOrAssignResultId<SpirvFunction>(inst->getEntryPoint()));
623623
curInst.push_back(static_cast<uint32_t>(inst->getExecutionMode()));
624-
if (inst->getopcode() == spv::Op::OpExecutionMode) {
625-
curInst.insert(curInst.end(), inst->getParams().begin(),
626-
inst->getParams().end());
627-
} else {
628-
for (uint32_t param : inst->getParams()) {
629-
curInst.push_back(typeHandler.getOrCreateConstantInt(
630-
llvm::APInt(32, param), context.getUIntType(32),
631-
/*isSpecConst */ false));
624+
if (auto *exeModeId = dyn_cast<SpirvExecutionModeId>(inst)) {
625+
for (SpirvInstruction *param : exeModeId->getParams()) {
626+
if (auto *ConstantInst = dyn_cast<SpirvConstant>(param))
627+
typeHandler.getOrCreateConstant(ConstantInst);
628+
curInst.push_back(getOrAssignResultId<SpirvInstruction>(param));
632629
}
630+
} else {
631+
auto *exeMode = llvm::cast<SpirvExecutionMode>(inst);
632+
ArrayRef<uint32_t> params = exeMode->getParams();
633+
curInst.insert(curInst.end(), params.begin(), params.end());
633634
}
634635
finalizeInstruction(&preambleBinary);
635636
return true;

‎tools/clang/lib/SPIRV/EmitVisitor.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ class EmitVisitor : public Visitor {
233233
bool visit(SpirvEmitVertex *) override;
234234
bool visit(SpirvEndPrimitive *) override;
235235
bool visit(SpirvEntryPoint *) override;
236-
bool visit(SpirvExecutionMode *) override;
236+
bool visit(SpirvExecutionModeBase *) override;
237237
bool visit(SpirvString *) override;
238238
bool visit(SpirvSource *) override;
239239
bool visit(SpirvModuleProcessed *) override;

‎tools/clang/lib/SPIRV/SpirvEmitter.cpp

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1146,8 +1146,9 @@ void SpirvEmitter::doStmt(const Stmt *stmt,
11461146
// All cases for expressions used as statements
11471147
SpirvInstruction *result = doExpr(expr);
11481148

1149-
if (result && result->getKind() == SpirvInstruction::IK_ExecutionMode &&
1150-
!attrs.empty()) {
1149+
if (result && !attrs.empty() &&
1150+
(result->getKind() == SpirvInstruction::IK_ExecutionMode ||
1151+
result->getKind() == SpirvInstruction::IK_ExecutionModeId)) {
11511152
// Handle [[vk::ext_capability(..)]] and [[vk::ext_extension(..)]]
11521153
// attributes for vk::ext_execution_mode[_id](..).
11531154
createSpirvIntrInstExt(
@@ -9161,10 +9162,10 @@ SpirvEmitter::processIntrinsicCallExpr(const CallExpr *callExpr) {
91619162
retVal = processRawBufferStore(callExpr);
91629163
break;
91639164
case hlsl::IntrinsicOp::IOP_Vkext_execution_mode:
9164-
retVal = processIntrinsicExecutionMode(callExpr, false);
9165+
retVal = processIntrinsicExecutionMode(callExpr);
91659166
break;
91669167
case hlsl::IntrinsicOp::IOP_Vkext_execution_mode_id:
9167-
retVal = processIntrinsicExecutionMode(callExpr, true);
9168+
retVal = processIntrinsicExecutionModeId(callExpr);
91689169
break;
91699170
case hlsl::IntrinsicOp::IOP_saturate:
91709171
retVal = processIntrinsicSaturate(callExpr);
@@ -15120,8 +15121,7 @@ SpirvEmitter::processCooperativeMatrixGetLength(const CallExpr *call) {
1512015121
}
1512115122

1512215123
SpirvInstruction *
15123-
SpirvEmitter::processIntrinsicExecutionMode(const CallExpr *expr,
15124-
bool useIdParams) {
15124+
SpirvEmitter::processIntrinsicExecutionMode(const CallExpr *expr) {
1512515125
llvm::SmallVector<uint32_t, 2> execModesParams;
1512615126
uint32_t exeMode = 0;
1512715127
const auto args = expr->getArgs();
@@ -15145,9 +15145,38 @@ SpirvEmitter::processIntrinsicExecutionMode(const CallExpr *expr,
1514515145
assert(entryFunction != nullptr);
1514615146
assert(exeMode != 0);
1514715147

15148-
return spvBuilder.addExecutionMode(
15149-
entryFunction, static_cast<spv::ExecutionMode>(exeMode), execModesParams,
15150-
expr->getExprLoc(), useIdParams);
15148+
return spvBuilder.addExecutionMode(entryFunction,
15149+
static_cast<spv::ExecutionMode>(exeMode),
15150+
execModesParams, expr->getExprLoc());
15151+
}
15152+
15153+
SpirvInstruction *
15154+
SpirvEmitter::processIntrinsicExecutionModeId(const CallExpr *expr) {
15155+
assert(expr->getNumArgs() > 0);
15156+
uint32_t exeMode = 0;
15157+
const Expr *modeExpr = expr->getArg(0);
15158+
Expr::EvalResult evalResult;
15159+
if (modeExpr->EvaluateAsRValue(evalResult, astContext) &&
15160+
!evalResult.HasSideEffects && evalResult.Val.isInt()) {
15161+
exeMode = evalResult.Val.getInt().getZExtValue();
15162+
} else {
15163+
emitError("The execution mode must be constant integer",
15164+
expr->getExprLoc());
15165+
return nullptr;
15166+
}
15167+
15168+
llvm::SmallVector<SpirvInstruction *, 2> execModesParams;
15169+
const auto args = expr->getArgs();
15170+
for (uint32_t i = 1; i < expr->getNumArgs(); ++i) {
15171+
const Expr *argExpr = args[i];
15172+
SpirvInstruction *argInst = doExpr(argExpr);
15173+
execModesParams.push_back(argInst);
15174+
}
15175+
15176+
assert(entryFunction != nullptr);
15177+
return spvBuilder.addExecutionModeId(entryFunction,
15178+
static_cast<spv::ExecutionMode>(exeMode),
15179+
execModesParams, expr->getExprLoc());
1515115180
}
1515215181

1515315182
SpirvInstruction *
@@ -15218,8 +15247,9 @@ bool SpirvEmitter::spirvToolsValidate(std::vector<uint32_t> *mod,
1521815247
void SpirvEmitter::addDerivativeGroupExecutionMode() {
1521915248
assert(spvContext.isCS());
1522015249

15221-
SpirvExecutionMode *numThreadsEm = spvBuilder.getModule()->findExecutionMode(
15222-
entryFunction, spv::ExecutionMode::LocalSize);
15250+
SpirvExecutionMode *numThreadsEm =
15251+
cast<SpirvExecutionMode>(spvBuilder.getModule()->findExecutionMode(
15252+
entryFunction, spv::ExecutionMode::LocalSize));
1522315253
auto numThreads = numThreadsEm->getParams();
1522415254

1522515255
// The layout of the quad is determined by the numer of threads in each

‎tools/clang/lib/SPIRV/SpirvEmitter.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -781,8 +781,9 @@ class SpirvEmitter : public ASTConsumer {
781781
SpirvInstruction *processCooperativeMatrixGetLength(const CallExpr *call);
782782

783783
/// Process vk::ext_execution_mode intrinsic
784-
SpirvInstruction *processIntrinsicExecutionMode(const CallExpr *expr,
785-
bool useIdParams);
784+
SpirvInstruction *processIntrinsicExecutionMode(const CallExpr *expr);
785+
/// Process vk::ext_execution_mode_id intrinsic
786+
SpirvInstruction *processIntrinsicExecutionModeId(const CallExpr *expr);
786787

787788
/// Processes the 'firstbit{high|low}' intrinsic functions.
788789
SpirvInstruction *processIntrinsicFirstbit(const CallExpr *,

‎tools/clang/lib/SPIRV/SpirvInstruction.cpp

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvExtension)
3333
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvExtInstImport)
3434
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvMemoryModel)
3535
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvEntryPoint)
36+
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvExecutionModeBase)
3637
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvExecutionMode)
38+
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvExecutionModeId)
3739
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvString)
3840
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvSource)
3941
DEFINE_INVOKE_VISITOR_FOR_CLASS(SpirvModuleProcessed)
@@ -207,13 +209,16 @@ SpirvEntryPoint::SpirvEntryPoint(SourceLocation loc,
207209
// OpExecutionMode and OpExecutionModeId instructions
208210
SpirvExecutionMode::SpirvExecutionMode(SourceLocation loc, SpirvFunction *entry,
209211
spv::ExecutionMode em,
210-
llvm::ArrayRef<uint32_t> paramsVec,
211-
bool usesIdParams)
212-
: SpirvInstruction(IK_ExecutionMode,
213-
usesIdParams ? spv::Op::OpExecutionModeId
214-
: spv::Op::OpExecutionMode,
215-
QualType(), loc),
216-
entryPoint(entry), execMode(em),
212+
llvm::ArrayRef<uint32_t> paramsVec)
213+
: SpirvExecutionModeBase(IK_ExecutionMode, spv::Op::OpExecutionMode, loc,
214+
entry, em),
215+
params(paramsVec.begin(), paramsVec.end()) {}
216+
217+
SpirvExecutionModeId::SpirvExecutionModeId(
218+
SourceLocation loc, SpirvFunction *entry, spv::ExecutionMode em,
219+
llvm::ArrayRef<SpirvInstruction *> paramsVec)
220+
: SpirvExecutionModeBase(IK_ExecutionModeId, spv::Op::OpExecutionModeId,
221+
loc, entry, em),
217222
params(paramsVec.begin(), paramsVec.end()) {}
218223

219224
SpirvString::SpirvString(SourceLocation loc, llvm::StringRef stringLiteral)

0 commit comments

Comments
 (0)