Skip to content

Commit 5c90259

Browse files
vmaksimovmaksimo
committed
SPV_KHR_untyped_pointers - implement OpUntypedVariableKHR (#2709)
This continues #2687 by introducing untyped variables. Spec: https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/KHR/SPV_KHR_untyped_pointers.html Original commit: KhronosGroup/SPIRV-LLVM-Translator@484e4070adb0a95
1 parent 2eff920 commit 5c90259

File tree

15 files changed

+336
-81
lines changed

15 files changed

+336
-81
lines changed

‎llvm-spirv/lib/SPIRV/SPIRVReader.cpp‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1529,9 +1529,15 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
15291529
case OpUndef:
15301530
return mapValue(BV, UndefValue::get(transType(BV->getType())));
15311531

1532-
case OpVariable: {
1533-
auto *BVar = static_cast<SPIRVVariable *>(BV);
1534-
auto *PreTransTy = BVar->getType()->getPointerElementType();
1532+
case OpVariable:
1533+
case OpUntypedVariableKHR: {
1534+
auto *BVar = static_cast<SPIRVVariableBase *>(BV);
1535+
SPIRVType *PreTransTy = BVar->getType()->getPointerElementType();
1536+
if (BVar->getType()->isTypeUntypedPointerKHR()) {
1537+
auto *UntypedVar = static_cast<SPIRVUntypedVariableKHR *>(BVar);
1538+
if (SPIRVType *DT = UntypedVar->getDataType())
1539+
PreTransTy = DT;
1540+
}
15351541
auto *Ty = transType(PreTransTy);
15361542
bool IsConst = BVar->isConstant();
15371543
llvm::GlobalValue::LinkageTypes LinkageTy = transLinkageType(BVar);
@@ -4062,7 +4068,7 @@ bool SPIRVToLLVM::transDecoration(SPIRVValue *BV, Value *V) {
40624068
return true;
40634069
}
40644070

4065-
void SPIRVToLLVM::transGlobalCtorDtors(SPIRVVariable *BV) {
4071+
void SPIRVToLLVM::transGlobalCtorDtors(SPIRVVariableBase *BV) {
40664072
if (BV->getName() != "llvm.global_ctors" &&
40674073
BV->getName() != "llvm.global_dtors")
40684074
return;
@@ -4907,15 +4913,17 @@ SPIRVToLLVM::transLinkageType(const SPIRVValue *V) {
49074913
return GlobalValue::ExternalLinkage;
49084914
}
49094915
// Variable declaration
4910-
if (V->getOpCode() == OpVariable) {
4911-
if (static_cast<const SPIRVVariable *>(V)->getInitializer() == 0)
4916+
if (V->getOpCode() == OpVariable ||
4917+
V->getOpCode() == OpUntypedVariableKHR) {
4918+
if (static_cast<const SPIRVVariableBase *>(V)->getInitializer() == 0)
49124919
return GlobalValue::ExternalLinkage;
49134920
}
49144921
// Definition
49154922
return GlobalValue::AvailableExternallyLinkage;
49164923
case LinkageTypeExport:
4917-
if (V->getOpCode() == OpVariable) {
4918-
if (static_cast<const SPIRVVariable *>(V)->getInitializer() == 0)
4924+
if (V->getOpCode() == OpVariable ||
4925+
V->getOpCode() == OpUntypedVariableKHR) {
4926+
if (static_cast<const SPIRVVariableBase *>(V)->getInitializer() == 0)
49194927
// Tentative definition
49204928
return GlobalValue::CommonLinkage;
49214929
}

‎llvm-spirv/lib/SPIRV/SPIRVReader.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ class SPIRVToLLVM : private BuiltinCallHelper {
251251

252252
void transUserSemantic(SPIRV::SPIRVFunction *Fun);
253253
void transGlobalAnnotations();
254-
void transGlobalCtorDtors(SPIRVVariable *BV);
254+
void transGlobalCtorDtors(SPIRVVariableBase *BV);
255255
void createCXXStructor(const char *ListName,
256256
SmallVectorImpl<Function *> &Funcs);
257257
void transIntelFPGADecorations(SPIRVValue *BV, Value *V);

‎llvm-spirv/lib/SPIRV/SPIRVWriter.cpp‎

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -755,8 +755,8 @@ SPIRVType *LLVMToSPIRVBase::transPointerType(SPIRVType *ET, unsigned AddrSpc) {
755755

756756
SPIRVType *TranslatedTy = nullptr;
757757
if (BM->isAllowedToUseExtension(ExtensionID::SPV_KHR_untyped_pointers) &&
758-
!(ET->isTypeArray() || ET->isTypeVector() || ET->isTypeImage() ||
759-
ET->isTypeSampler() || ET->isTypePipe())) {
758+
!(ET->isTypeArray() || ET->isTypeVector() || ET->isTypeStruct() ||
759+
ET->isTypeImage() || ET->isTypeSampler() || ET->isTypePipe())) {
760760
TranslatedTy = BM->addUntypedPointerKHRType(
761761
SPIRSPIRVAddrSpaceMap::map(static_cast<SPIRAddressSpace>(AddrSpc)));
762762
} else {
@@ -1329,7 +1329,8 @@ SPIRVValue *LLVMToSPIRVBase::transConstantUse(Constant *C,
13291329
if (Trans->getType() == ExpectedType || Trans->getType()->isTypePipeStorage())
13301330
return Trans;
13311331

1332-
assert(C->getType()->isPointerTy() &&
1332+
assert((C->getType()->isPointerTy() ||
1333+
ExpectedType->isTypeUntypedPointerKHR()) &&
13331334
"Only pointer type mismatches should be possible");
13341335
// In the common case of strings ([N x i8] GVs), see if we can emit a GEP
13351336
// instruction.
@@ -2067,8 +2068,12 @@ LLVMToSPIRVBase::transValueWithoutDecoration(Value *V, SPIRVBasicBlock *BB,
20672068
}
20682069
}
20692070
}
2070-
SPIRVType *TransTy = transType(Ty);
2071-
BVarInit = transConstantUse(Init, TransTy->getPointerElementType());
2071+
if (BM->isAllowedToUseExtension(ExtensionID::SPV_KHR_untyped_pointers)) {
2072+
BVarInit = transConstantUse(Init, transType(Init->getType()));
2073+
} else {
2074+
SPIRVType *TransTy = transType(Ty);
2075+
BVarInit = transConstantUse(Init, TransTy->getPointerElementType());
2076+
}
20722077
}
20732078

20742079
SPIRVStorageClassKind StorageClass;
@@ -2101,9 +2106,12 @@ LLVMToSPIRVBase::transValueWithoutDecoration(Value *V, SPIRVBasicBlock *BB,
21012106
}
21022107

21032108
SPIRVType *TranslatedTy = transType(Ty);
2104-
auto *BVar = static_cast<SPIRVVariable *>(
2105-
BM->addVariable(TranslatedTy, GV->isConstant(), transLinkageType(GV),
2106-
BVarInit, GV->getName().str(), StorageClass, nullptr));
2109+
auto *BVar = static_cast<SPIRVVariableBase *>(BM->addVariable(
2110+
TranslatedTy,
2111+
TranslatedTy->isTypeUntypedPointerKHR() ? transType(GV->getValueType())
2112+
: nullptr,
2113+
GV->isConstant(), transLinkageType(GV), BVarInit, GV->getName().str(),
2114+
StorageClass, nullptr));
21072115

21082116
if (IsVectorCompute) {
21092117
BVar->addDecorate(DecorationVectorComputeVariableINTEL);
@@ -2292,8 +2300,9 @@ LLVMToSPIRVBase::transValueWithoutDecoration(Value *V, SPIRVBasicBlock *BB,
22922300
StorageClassFunction,
22932301
BM->addArrayType(transType(Alc->getAllocatedType()), Length));
22942302
SPIRVValue *Arr = BM->addVariable(
2295-
AllocationType, false, spv::internal::LinkageTypeInternal, nullptr,
2296-
Alc->getName().str() + "_alloca", StorageClassFunction, BB);
2303+
AllocationType, nullptr, false, spv::internal::LinkageTypeInternal,
2304+
nullptr, Alc->getName().str() + "_alloca", StorageClassFunction,
2305+
BB);
22972306
// Manually set alignment. OpBitcast created below will be decorated as
22982307
// that's the SPIR-V value mapped to the original LLVM one.
22992308
transAlign(Alc, Arr);
@@ -2317,7 +2326,10 @@ LLVMToSPIRVBase::transValueWithoutDecoration(Value *V, SPIRVBasicBlock *BB,
23172326
TranslatedTy->getPointerElementType())
23182327
: TranslatedTy;
23192328
SPIRVValue *Var = BM->addVariable(
2320-
VarTy, false, spv::internal::LinkageTypeInternal, nullptr,
2329+
VarTy,
2330+
VarTy->isTypeUntypedPointerKHR() ? transType(Alc->getAllocatedType())
2331+
: nullptr,
2332+
false, spv::internal::LinkageTypeInternal, nullptr,
23212333
Alc->getName().str(), StorageClassFunction, BB);
23222334
if (V->getType()->getPointerAddressSpace() == SPIRAS_Generic) {
23232335
SPIRVValue *Cast =
@@ -2762,7 +2774,7 @@ void checkIsGlobalVar(SPIRVEntry *E, Decoration Dec) {
27622774
E->getErrorLog().checkError(E->isVariable(), SPIRVEC_InvalidModule, ErrStr);
27632775

27642776
auto AddrSpace = SPIRSPIRVAddrSpaceMap::rmap(
2765-
static_cast<SPIRVVariable *>(E)->getStorageClass());
2777+
static_cast<SPIRVVariableBase *>(E)->getStorageClass());
27662778
ErrStr += " in a global (module) scope";
27672779
E->getErrorLog().checkError(AddrSpace == SPIRAS_Global, SPIRVEC_InvalidModule,
27682780
ErrStr);
@@ -2910,10 +2922,11 @@ static void transMetadataDecorations(Metadata *MD, SPIRVValue *Target) {
29102922
case spv::internal::DecorationInitModeINTEL:
29112923
case DecorationInitModeINTEL: {
29122924
checkIsGlobalVar(Target, DecoKind);
2913-
ErrLog.checkError(static_cast<SPIRVVariable *>(Target)->getInitializer(),
2914-
SPIRVEC_InvalidLlvmModule,
2915-
"InitModeINTEL only be applied to a global (module "
2916-
"scope) variable which has an Initializer operand");
2925+
ErrLog.checkError(
2926+
static_cast<SPIRVVariableBase *>(Target)->getInitializer(),
2927+
SPIRVEC_InvalidLlvmModule,
2928+
"InitModeINTEL only be applied to a global (module "
2929+
"scope) variable which has an Initializer operand");
29172930

29182931
ErrLog.checkError(NumOperands == 2, SPIRVEC_InvalidLlvmModule,
29192932
"InitModeINTEL requires exactly 1 extra operand");
@@ -4155,14 +4168,18 @@ SPIRVValue *LLVMToSPIRVBase::transIntrinsicInst(IntrinsicInst *II,
41554168
SPIRVType *FTy = transType(II->getType()->getStructElementType(0));
41564169
SPIRVTypePointer *ITy = static_cast<SPIRVTypePointer *>(transPointerType(
41574170
II->getType()->getStructElementType(1), SPIRAS_Private));
4158-
4159-
unsigned BitWidth = ITy->getElementType()->getBitWidth();
4160-
BM->getErrorLog().checkError(BitWidth == 32, SPIRVEC_InvalidBitWidth,
4161-
std::to_string(BitWidth));
4162-
4171+
if (!ITy->isTypeUntypedPointerKHR()) {
4172+
unsigned BitWidth = ITy->getElementType()->getBitWidth();
4173+
BM->getErrorLog().checkError(BitWidth == 32, SPIRVEC_InvalidBitWidth,
4174+
std::to_string(BitWidth));
4175+
}
41634176
SPIRVValue *IntVal =
4164-
BM->addVariable(ITy, false, spv::internal::LinkageTypeInternal, nullptr,
4165-
"", ITy->getStorageClass(), BB);
4177+
BM->addVariable(ITy,
4178+
ITy->isTypeUntypedPointerKHR()
4179+
? transType(II->getType()->getStructElementType(1))
4180+
: nullptr,
4181+
false, spv::internal::LinkageTypeInternal, nullptr, "",
4182+
ITy->getStorageClass(), BB);
41664183

41674184
std::vector<SPIRVValue *> Ops{transValue(II->getArgOperand(0), BB), IntVal};
41684185

@@ -4584,7 +4601,7 @@ SPIRVValue *LLVMToSPIRVBase::transIntrinsicInst(IntrinsicInst *II,
45844601
Init = BM->addCompositeConstant(CompositeTy, Elts);
45854602
}
45864603
SPIRVType *VarTy = transPointerType(AT, SPIRV::SPIRAS_Constant);
4587-
SPIRVValue *Var = BM->addVariable(VarTy, /*isConstant*/ true,
4604+
SPIRVValue *Var = BM->addVariable(VarTy, nullptr, /*isConstant*/ true,
45884605
spv::internal::LinkageTypeInternal, Init,
45894606
"", StorageClassUniformConstant, nullptr);
45904607
SPIRVType *SourceTy =

‎llvm-spirv/lib/SPIRV/libSPIRV/SPIRVBasicBlock.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ SPIRVInstruction *SPIRVBasicBlock::getVariableInsertionPoint() const {
9494
isa<OpNoLine>(Inst) ||
9595
// Note: OpVariable and OpPhi instructions do not belong to the
9696
// same block in a valid SPIR-V module.
97-
isa<OpPhi>(Inst));
97+
isa<OpPhi>(Inst) || isa<OpUntypedVariableKHR>(Inst));
9898
});
9999
if (IP == InstVec.end())
100100
return nullptr;

‎llvm-spirv/lib/SPIRV/libSPIRV/SPIRVBasicBlock.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ class SPIRVBasicBlock : public SPIRVValue {
7777
const SPIRVInstruction *getTerminateInstr() const {
7878
return InstVec.empty() ? nullptr : InstVec.back();
7979
}
80-
// OpVariable instructions must be the first instructions in the block,
80+
// Variables must be the first instructions in the block,
8181
// intermixed with OpLine and OpNoLine instructions. Return first instruction
82-
// not being an OpVariable, OpLine or OpNoLine.
82+
// not being an OpVariable, OpUntypedVariableKHR, OpLine or OpNoLine.
8383
SPIRVInstruction *getVariableInsertionPoint() const;
8484

8585
void setScope(SPIRVEntry *Scope) override;

‎llvm-spirv/lib/SPIRV/libSPIRV/SPIRVEntry.cpp‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,8 @@ SPIRVEntry::getDecorationIds(Decoration Kind) const {
559559
}
560560

561561
bool SPIRVEntry::hasLinkageType() const {
562-
return OpCode == OpFunction || OpCode == OpVariable;
562+
return OpCode == OpFunction || OpCode == OpVariable ||
563+
OpCode == OpUntypedVariableKHR;
563564
}
564565

565566
bool SPIRVEntry::isExtInst(const SPIRVExtInstSetKind InstSet) const {

‎llvm-spirv/lib/SPIRV/libSPIRV/SPIRVEntry.h‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,9 @@ class SPIRVEntry {
339339
bool isUndef() const { return OpCode == OpUndef; }
340340
bool isControlBarrier() const { return OpCode == OpControlBarrier; }
341341
bool isMemoryBarrier() const { return OpCode == OpMemoryBarrier; }
342-
bool isVariable() const { return OpCode == OpVariable; }
342+
bool isVariable() const {
343+
return OpCode == OpVariable || OpCode == OpUntypedVariableKHR;
344+
}
343345
bool isEndOfBlock() const;
344346
virtual bool isInst() const { return false; }
345347
virtual bool isOperandLiteral(unsigned Index) const {

‎llvm-spirv/lib/SPIRV/libSPIRV/SPIRVInstruction.h‎

Lines changed: 90 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -452,24 +452,25 @@ class SPIRVMemoryAccess {
452452
SPIRVId NoAliasInstID;
453453
};
454454

455-
class SPIRVVariable : public SPIRVInstruction {
455+
class SPIRVVariableBase : public SPIRVInstruction {
456456
public:
457457
// Complete constructor for integer constant
458-
SPIRVVariable(SPIRVType *TheType, SPIRVId TheId, SPIRVValue *TheInitializer,
459-
const std::string &TheName,
460-
SPIRVStorageClassKind TheStorageClass, SPIRVBasicBlock *TheBB,
461-
SPIRVModule *TheM)
462-
: SPIRVInstruction(TheInitializer && !TheInitializer->isUndef() ? 5 : 4,
463-
OpVariable, TheType, TheId, TheBB, TheM),
458+
SPIRVVariableBase(Op OC, SPIRVType *TheType, SPIRVId TheId,
459+
SPIRVValue *TheInitializer, const std::string &TheName,
460+
SPIRVStorageClassKind TheStorageClass,
461+
SPIRVBasicBlock *TheBB, SPIRVModule *TheM, SPIRVWord WC)
462+
: SPIRVInstruction(WC, OC, TheType, TheId, TheBB, TheM),
464463
StorageClass(TheStorageClass) {
465464
if (TheInitializer && !TheInitializer->isUndef())
466465
Initializer.push_back(TheInitializer->getId());
467466
Name = TheName;
468467
validate();
469468
}
470-
// Incomplete constructor
471-
SPIRVVariable()
472-
: SPIRVInstruction(OpVariable), StorageClass(StorageClassFunction) {}
469+
// Incomplete constructors
470+
SPIRVVariableBase(Op OC)
471+
: SPIRVInstruction(OC), StorageClass(StorageClassFunction) {}
472+
SPIRVVariableBase()
473+
: SPIRVInstruction(OpNop), StorageClass(StorageClassFunction) {}
473474

474475
SPIRVStorageClassKind getStorageClass() const { return StorageClass; }
475476
SPIRVValue *getInitializer() const {
@@ -521,6 +522,77 @@ class SPIRVVariable : public SPIRVInstruction {
521522
std::vector<SPIRVId> Initializer;
522523
};
523524

525+
class SPIRVVariable : public SPIRVVariableBase {
526+
public:
527+
// Complete constructor for integer constant
528+
SPIRVVariable(SPIRVType *TheType, SPIRVId TheId, SPIRVValue *TheInitializer,
529+
const std::string &TheName,
530+
SPIRVStorageClassKind TheStorageClass, SPIRVBasicBlock *TheBB,
531+
SPIRVModule *TheM)
532+
: SPIRVVariableBase(OpVariable, TheType, TheId, TheInitializer, TheName,
533+
TheStorageClass, TheBB, TheM,
534+
TheInitializer && !TheInitializer->isUndef() ? 5
535+
: 4) {}
536+
// Incomplete constructor
537+
SPIRVVariable() : SPIRVVariableBase(OpVariable) {}
538+
};
539+
540+
class SPIRVUntypedVariableKHR : public SPIRVVariableBase {
541+
public:
542+
SPIRVUntypedVariableKHR(SPIRVType *TheType, SPIRVId TheId,
543+
SPIRVType *TheDataType, SPIRVValue *TheInitializer,
544+
const std::string &TheName,
545+
SPIRVStorageClassKind TheStorageClass,
546+
SPIRVBasicBlock *TheBB, SPIRVModule *TheM)
547+
: SPIRVVariableBase(
548+
OpUntypedVariableKHR, TheType, TheId, TheInitializer, TheName,
549+
TheStorageClass, TheBB, TheM,
550+
TheDataType && !TheDataType->isUndef()
551+
? (TheInitializer && !TheInitializer->isUndef() ? 6 : 5)
552+
: 4) {
553+
if (TheDataType && !TheDataType->isUndef())
554+
DataType.push_back(TheDataType->getId());
555+
validate();
556+
}
557+
SPIRVUntypedVariableKHR() : SPIRVVariableBase(OpUntypedVariableKHR) {}
558+
SPIRVType *getDataType() const {
559+
if (DataType.empty())
560+
return nullptr;
561+
assert(DataType.size() == 1);
562+
return get<SPIRVType>(DataType[0]);
563+
}
564+
std::vector<SPIRVEntry *> getNonLiteralOperands() const override {
565+
std::vector<SPIRVEntry *> Vec;
566+
if (SPIRVType *T = getDataType())
567+
Vec.push_back(T);
568+
if (SPIRVValue *V = getInitializer())
569+
Vec.push_back(V);
570+
return Vec;
571+
}
572+
std::optional<ExtensionID> getRequiredExtension() const override {
573+
return ExtensionID::SPV_KHR_untyped_pointers;
574+
}
575+
SPIRVCapVec getRequiredCapability() const override {
576+
return getVec(CapabilityUntypedPointersKHR);
577+
}
578+
579+
protected:
580+
void validate() const override {
581+
SPIRVVariableBase::validate();
582+
assert(DataType.size() == 1 || DataType.empty());
583+
}
584+
void setWordCount(SPIRVWord TheWordCount) override {
585+
SPIRVEntry::setWordCount(TheWordCount);
586+
if (TheWordCount > 4)
587+
DataType.resize(1);
588+
if (TheWordCount > 5)
589+
Initializer.resize(1);
590+
}
591+
_SPIRV_DEF_ENCDEC5(Type, Id, StorageClass, DataType, Initializer)
592+
593+
std::vector<SPIRVId> DataType;
594+
};
595+
524596
class SPIRVStore : public SPIRVInstruction, public SPIRVMemoryAccess {
525597
public:
526598
const static SPIRVWord FixedWords = 3;
@@ -572,9 +644,6 @@ class SPIRVStore : public SPIRVInstruction, public SPIRVMemoryAccess {
572644
(getValueType(PtrId)
573645
->getPointerElementType()
574646
->isTypeUntypedPointerKHR() ||
575-
// TODO: This check should be removed once we support untyped
576-
// variables.
577-
getValueType(ValId)->isTypeUntypedPointerKHR() ||
578647
getValueType(PtrId)->getPointerElementType() == getValueType(ValId)) &&
579648
"Inconsistent operand types");
580649
}
@@ -629,8 +698,6 @@ class SPIRVLoad : public SPIRVInstruction, public SPIRVMemoryAccess {
629698
getValueType(PtrId)
630699
->getPointerElementType()
631700
->isTypeUntypedPointerKHR() ||
632-
// TODO: This check should be removed once we support untyped
633-
// variables.
634701
Type->isTypeUntypedPointerKHR() ||
635702
Type == getValueType(PtrId)->getPointerElementType()) &&
636703
"Inconsistent types");
@@ -688,9 +755,14 @@ class SPIRVBinary : public SPIRVInstTemplateBase {
688755
} else if (isBinaryPtrOpCode(OpCode)) {
689756
assert((Op1Ty->isTypePointer() && Op2Ty->isTypePointer()) &&
690757
"Invalid types for PtrEqual, PtrNotEqual, or PtrDiff instruction");
691-
assert(static_cast<SPIRVTypePointer *>(Op1Ty)->getElementType() ==
692-
static_cast<SPIRVTypePointer *>(Op2Ty)->getElementType() &&
693-
"Invalid types for PtrEqual, PtrNotEqual, or PtrDiff instruction");
758+
if (!Op1Ty->isTypeUntypedPointerKHR() ||
759+
!Op2Ty->isTypeUntypedPointerKHR())
760+
assert(
761+
static_cast<SPIRVTypePointer *>(Op1Ty)->getElementType() ==
762+
static_cast<SPIRVTypePointer *>(Op2Ty)->getElementType() &&
763+
"Invalid types for PtrEqual, PtrNotEqual, or PtrDiff instruction");
764+
else if (OpCode == OpPtrDiff)
765+
assert(Op1Ty == Op2Ty && "Invalid types for PtrDiff instruction");
694766
} else {
695767
assert(0 && "Invalid op code!");
696768
}

0 commit comments

Comments
 (0)