Skip to content

Commit ea6645b

Browse files
MrSidimsMrSidims
committed
[Backport to 21] Add __builtin_spirv_ internal builtins (KhronosGroup#3374)
Way they are implemented is described in: KhronosGroup#3221 The PR also adds SPV_EXT_float8 extension and packed conversions for SPV_INTEL_int4 Currently only conversion instructions (and internal builtins) are covered. TODO: in the following PR Saturation decoration will be added. Signed-off-by: Sidorov, Dmitry <[email protected]> --------- Signed-off-by: Sidorov, Dmitry <[email protected]>
1 parent fa5f034 commit ea6645b

File tree

14 files changed

+979
-12
lines changed

14 files changed

+979
-12
lines changed

‎include/LLVMSPIRVExtensions.inc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,5 @@ EXT(SPV_INTEL_ternary_bitwise_function)
8282
EXT(SPV_INTEL_int4)
8383
EXT(SPV_INTEL_function_variants)
8484
EXT(SPV_INTEL_shader_atomic_bfloat16)
85+
EXT(SPV_EXT_float8)
8586
EXT(SPV_INTEL_predicated_io)

‎lib/SPIRV/SPIRVInternal.h‎

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,7 @@ const static char ConvertHandleToImageINTEL[] = "ConvertHandleToImageINTEL";
373373
const static char ConvertHandleToSamplerINTEL[] = "ConvertHandleToSamplerINTEL";
374374
const static char ConvertHandleToSampledImageINTEL[] =
375375
"ConvertHandleToSampledImageINTEL";
376+
const static char InternalBuiltinPrefix[] = "__builtin_spirv_";
376377
} // namespace kSPIRVName
377378

378379
namespace kSPIRVPostfix {
@@ -664,7 +665,7 @@ Op getSPIRVFuncOC(StringRef Name, SmallVectorImpl<std::string> *Dec = nullptr);
664665
bool getSPIRVBuiltin(const std::string &Name, spv::BuiltIn &Builtin);
665666

666667
/// \param Name LLVM function name
667-
/// \param DemangledName demanged name of the OpenCL built-in function
668+
/// \param DemangledName demangled name of the OpenCL built-in function
668669
/// \returns true if Name is the name of the OpenCL built-in function,
669670
/// false for other functions
670671
bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp = false);
@@ -727,6 +728,9 @@ CallInst *addCallInst(Module *M, StringRef FuncName, Type *RetTy,
727728
StringRef InstName = SPIR_TEMP_NAME_PREFIX_CALL,
728729
bool TakeFuncName = true);
729730

731+
/// Check if an LLVM type is spirv.CooperativeMatrixKHR.
732+
bool isLLVMCooperativeMatrixType(llvm::Type *Ty);
733+
730734
/// Add a call instruction for SPIR-V builtin function.
731735
CallInst *addCallInstSPIRV(Module *M, StringRef FuncName, Type *RetTy,
732736
ArrayRef<Value *> Args, AttributeList *Attrs,
@@ -1028,6 +1032,84 @@ bool postProcessBuiltinsReturningStruct(Module *M, bool IsCpp = false);
10281032

10291033
bool postProcessBuiltinsWithArrayArguments(Module *M, bool IsCpp = false);
10301034

1035+
/// \param MangledName LLVM function name.
1036+
/// \param DemangledName demangled name of the input function if it is the
1037+
/// translator's internal built-in function.
1038+
/// \returns true if MangledName is the name of the translator's internal
1039+
/// built-in function, false for other functions.
1040+
/// Used for 'mini'-floats conversion functions
1041+
bool isInternalSPIRVBuiltin(StringRef MangledName, StringRef &DemangledName);
1042+
1043+
// Wrapper around SPIR-V 1.6.4 FP Encoding to be used in the conversion
1044+
// descriptor
1045+
enum FPEncodingWrap {
1046+
Integer = FPEncoding::FPEncodingMax - 1,
1047+
IEEE754 = FPEncoding::FPEncodingMax,
1048+
BF16 = FPEncoding::FPEncodingBFloat16KHR,
1049+
E4M3 = FPEncoding::FPEncodingFloat8E4M3EXT,
1050+
E5M2 = FPEncoding::FPEncodingFloat8E5M2EXT,
1051+
};
1052+
1053+
// Structure describing non-trivial conversions (FP8 and int4)
1054+
struct FPConversionDesc {
1055+
FPEncodingWrap SrcEncoding;
1056+
FPEncodingWrap DstEncoding;
1057+
SPIRVWord ConvOpCode;
1058+
1059+
// To use as a key in std::map
1060+
bool operator==(const FPConversionDesc &Other) const {
1061+
return SrcEncoding == Other.SrcEncoding &&
1062+
DstEncoding == Other.DstEncoding && ConvOpCode == Other.ConvOpCode;
1063+
}
1064+
1065+
bool operator<(const FPConversionDesc &Other) const {
1066+
if (ConvOpCode != Other.ConvOpCode)
1067+
return ConvOpCode < Other.ConvOpCode;
1068+
if (SrcEncoding != Other.SrcEncoding)
1069+
return SrcEncoding < Other.SrcEncoding;
1070+
return DstEncoding < Other.DstEncoding;
1071+
}
1072+
};
1073+
1074+
// Maps internal builtin name to conversion descriptor
1075+
typedef SPIRVMap<llvm::StringRef, FPConversionDesc> FPConvertToEncodingMap;
1076+
1077+
// clang-format off
1078+
template <> inline void FPConvertToEncodingMap::init() {
1079+
// 8-bit conversions
1080+
add("ConvertE4M3ToFP16EXT",
1081+
{FPEncodingWrap::E4M3, FPEncodingWrap::IEEE754, OpFConvert});
1082+
add("ConvertE5M2ToFP16EXT",
1083+
{FPEncodingWrap::E5M2, FPEncodingWrap::IEEE754, OpFConvert});
1084+
add("ConvertE4M3ToBF16EXT",
1085+
{FPEncodingWrap::E4M3, FPEncodingWrap::BF16, OpFConvert});
1086+
add("ConvertE5M2ToBF16EXT",
1087+
{FPEncodingWrap::E5M2, FPEncodingWrap::BF16, OpFConvert});
1088+
add("ConvertFP16ToE4M3EXT",
1089+
{FPEncodingWrap::IEEE754, FPEncodingWrap::E4M3, OpFConvert});
1090+
add("ConvertFP16ToE5M2EXT",
1091+
{FPEncodingWrap::IEEE754, FPEncodingWrap::E5M2, OpFConvert});
1092+
add("ConvertBF16ToE4M3EXT",
1093+
{FPEncodingWrap::BF16, FPEncodingWrap::E4M3, OpFConvert});
1094+
add("ConvertBF16ToE5M2EXT",
1095+
{FPEncodingWrap::BF16, FPEncodingWrap::E5M2, OpFConvert});
1096+
1097+
add("ConvertInt4ToE4M3INTEL",
1098+
{FPEncodingWrap::Integer, FPEncodingWrap::E4M3, OpConvertSToF});
1099+
add("ConvertInt4ToE5M2INTEL",
1100+
{FPEncodingWrap::Integer, FPEncodingWrap::E5M2, OpConvertSToF});
1101+
add("ConvertInt4ToFP16INTEL",
1102+
{FPEncodingWrap::Integer, FPEncodingWrap::IEEE754, OpConvertSToF});
1103+
add("ConvertInt4ToBF16INTEL",
1104+
{FPEncodingWrap::Integer, FPEncodingWrap::BF16, OpConvertSToF});
1105+
add("ConvertFP16ToInt4INTEL",
1106+
{FPEncodingWrap::IEEE754, FPEncodingWrap::Integer, OpConvertFToS});
1107+
add("ConvertBF16ToInt4INTEL",
1108+
{FPEncodingWrap::BF16, FPEncodingWrap::Integer, OpConvertFToS});
1109+
}
1110+
1111+
// clang-format on
1112+
10311113
} // namespace SPIRV
10321114

10331115
#endif // SPIRV_SPIRVINTERNAL_H

‎lib/SPIRV/SPIRVReader.cpp‎

Lines changed: 90 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,9 @@ std::optional<uint64_t> SPIRVToLLVM::getAlignment(SPIRVValue *V) {
314314

315315
Type *SPIRVToLLVM::transFPType(SPIRVType *T) {
316316
switch (T->getFloatBitWidth()) {
317+
case 8:
318+
// No LLVM IR counter part for FP8 - map it on i8
319+
return Type::getIntNTy(*Context, 8);
317320
case 16:
318321
if (T->isTypeFloat(16, FPEncodingBFloat16KHR))
319322
return Type::getBFloatTy(*Context);
@@ -1066,6 +1069,22 @@ Value *SPIRVToLLVM::transConvertInst(SPIRVValue *BV, Function *F,
10661069
CastInst::CastOps CO = Instruction::BitCast;
10671070
bool IsExt =
10681071
Dst->getScalarSizeInBits() > Src->getType()->getScalarSizeInBits();
1072+
1073+
auto GetFPEncoding = [](SPIRVType *Ty) -> FPEncodingWrap {
1074+
if (Ty->isTypeFloat()) {
1075+
unsigned Enc =
1076+
static_cast<SPIRVTypeFloat *>(Ty)->getFloatingPointEncoding();
1077+
return static_cast<FPEncodingWrap>(Enc);
1078+
}
1079+
if (Ty->isTypeInt())
1080+
return FPEncodingWrap::Integer;
1081+
return FPEncodingWrap::IEEE754;
1082+
};
1083+
1084+
auto IsFP8Encoding = [](FPEncodingWrap Encoding) -> bool {
1085+
return Encoding == FPEncodingWrap::E4M3 || Encoding == FPEncodingWrap::E5M2;
1086+
};
1087+
10691088
switch (BC->getOpCode()) {
10701089
case OpPtrCastToGeneric:
10711090
case OpGenericCastToPtr:
@@ -1087,10 +1106,58 @@ Value *SPIRVToLLVM::transConvertInst(SPIRVValue *BV, Function *F,
10871106
case OpUConvert:
10881107
CO = IsExt ? Instruction::ZExt : Instruction::Trunc;
10891108
break;
1090-
case OpFConvert:
1091-
CO = IsExt ? Instruction::FPExt : Instruction::FPTrunc;
1109+
case OpConvertSToF:
1110+
case OpConvertFToS:
1111+
case OpConvertUToF:
1112+
case OpConvertFToU:
1113+
case OpFConvert: {
1114+
const auto OC = BC->getOpCode();
1115+
{
1116+
auto SPVOps = BC->getOperands();
1117+
auto *SPVSrcTy = SPVOps[0]->getType();
1118+
auto *SPVDstTy = BC->getType();
1119+
1120+
auto GetEncodingAndUpdateType =
1121+
[GetFPEncoding](SPIRVType *&SPVTy) -> FPEncodingWrap {
1122+
if (SPVTy->isTypeVector()) {
1123+
SPVTy = SPVTy->getVectorComponentType();
1124+
} else if (SPVTy->isTypeCooperativeMatrixKHR()) {
1125+
auto *MT = static_cast<SPIRVTypeCooperativeMatrixKHR *>(SPVTy);
1126+
SPVTy = MT->getCompType();
1127+
}
1128+
return GetFPEncoding(SPVTy);
1129+
};
1130+
1131+
FPEncodingWrap SrcEnc = GetEncodingAndUpdateType(SPVSrcTy);
1132+
FPEncodingWrap DstEnc = GetEncodingAndUpdateType(SPVDstTy);
1133+
if (IsFP8Encoding(SrcEnc) || IsFP8Encoding(DstEnc) ||
1134+
SPVSrcTy->isTypeInt(4) || SPVDstTy->isTypeInt(4)) {
1135+
FPConversionDesc FPDesc = {SrcEnc, DstEnc, BC->getOpCode()};
1136+
auto Conv = SPIRV::FPConvertToEncodingMap::rmap(FPDesc);
1137+
std::vector<Value *> Ops = {Src};
1138+
std::vector<Type *> OpsTys = {Src->getType()};
1139+
1140+
std::string BuiltinName =
1141+
kSPIRVName::InternalBuiltinPrefix + std::string(Conv);
1142+
BuiltinFuncMangleInfo Info;
1143+
std::string MangledName = mangleBuiltin(BuiltinName, OpsTys, &Info);
1144+
1145+
FunctionType *FTy = FunctionType::get(Dst, OpsTys, false);
1146+
FunctionCallee Func = M->getOrInsertFunction(MangledName, FTy);
1147+
return CallInst::Create(Func, Ops, "", BB);
1148+
}
1149+
}
1150+
1151+
if (OC == OpFConvert) {
1152+
CO = IsExt ? Instruction::FPExt : Instruction::FPTrunc;
1153+
break;
1154+
}
1155+
CO = static_cast<CastInst::CastOps>(OpCodeMap::rmap(OC));
10921156
break;
1157+
}
10931158
case OpBitcast:
1159+
if (!Dst->isPointerTy() && Dst == Src->getType())
1160+
return Src;
10941161
// OpBitcast need to be handled as a special-case when the source is a
10951162
// pointer and the destination is not a pointer, and where the source is not
10961163
// a pointer and the destination is a pointer. This is supported by the
@@ -2990,11 +3057,29 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
29903057
if (isCvtOpCode(OC) && OC != OpGenericCastToPtrExplicit) {
29913058
auto *BI = static_cast<SPIRVInstruction *>(BV);
29923059
Value *Inst = nullptr;
2993-
if (BI->hasFPRoundingMode() || BI->isSaturatedConversion() ||
2994-
BI->getType()->isTypeCooperativeMatrixKHR())
3060+
if (BI->hasFPRoundingMode() || BI->isSaturatedConversion()) {
29953061
Inst = transSPIRVBuiltinFromInst(BI, BB);
2996-
else
3062+
} else if (BI->getType()->isTypeCooperativeMatrixKHR()) {
3063+
// For cooperative matrix conversions generate __builtin_spirv
3064+
// conversions instead of __spirv_FConvert in case of mini-float
3065+
// type element type.
3066+
auto *OutMatrixElementTy =
3067+
static_cast<SPIRVTypeCooperativeMatrixKHR *>(BI->getType())
3068+
->getCompType();
3069+
auto *InMatrixElementTy =
3070+
static_cast<SPIRVTypeCooperativeMatrixKHR *>(
3071+
static_cast<SPIRVUnary *>(BI)->getOperand(0)->getType())
3072+
->getCompType();
3073+
if (OutMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E4M3EXT) ||
3074+
OutMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E5M2EXT) ||
3075+
InMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E4M3EXT) ||
3076+
InMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E5M2EXT))
3077+
Inst = transConvertInst(BV, F, BB);
3078+
else
3079+
Inst = transSPIRVBuiltinFromInst(BI, BB);
3080+
} else {
29973081
Inst = transConvertInst(BV, F, BB);
3082+
}
29983083
return mapValue(BV, Inst);
29993084
}
30003085
return mapValue(

‎lib/SPIRV/SPIRVUtil.cpp‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040

4141
// This file needs to be included before anything that declares
4242
// llvm::PointerType to avoid a compilation bug on MSVC.
43+
#include "llvm/Demangle/Demangle.h"
4344
#include "llvm/Demangle/ItaniumDemangle.h"
4445

4546
#include "FunctionDescriptor.h"
@@ -266,6 +267,12 @@ bool isSYCLBfloat16Type(llvm::Type *Ty) {
266267
return false;
267268
}
268269

270+
bool isLLVMCooperativeMatrixType(llvm::Type *Ty) {
271+
if (auto *TargetTy = dyn_cast<TargetExtType>(Ty))
272+
return TargetTy->getName() == "spirv.CooperativeMatrixKHR";
273+
return false;
274+
}
275+
269276
Function *getOrCreateFunction(Module *M, Type *RetTy, ArrayRef<Type *> ArgTypes,
270277
StringRef Name, BuiltinFuncMangleInfo *Mangle,
271278
AttributeList *Attrs, bool TakeName) {
@@ -438,7 +445,7 @@ bool getSPIRVBuiltin(const std::string &OrigName, spv::BuiltIn &B) {
438445
return getByName(R.str(), B);
439446
}
440447

441-
// Demangled name is a substring of the name. The DemangledName is updated only
448+
// DemangledName is a substring of Name. The DemangledName is updated only
442449
// if true is returned
443450
bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp) {
444451
if (Name == "printf") {
@@ -483,6 +490,21 @@ bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp) {
483490
return false;
484491
}
485492

493+
// DemangledName is a substring of Name. The DemangledName is updated only
494+
// if true is returned.
495+
bool isInternalSPIRVBuiltin(StringRef Name, StringRef &DemangledName) {
496+
if (!Name.starts_with("_Z"))
497+
return false;
498+
constexpr unsigned DemangledNameLenStart = 2;
499+
size_t Start = Name.find_first_not_of("0123456789", DemangledNameLenStart);
500+
if (!Name.substr(Start, Name.size() - 1)
501+
.starts_with(kSPIRVName::InternalBuiltinPrefix))
502+
return false;
503+
DemangledName = llvm::itaniumDemangle(Name.data(), false);
504+
DemangledName.consume_front(kSPIRVName::InternalBuiltinPrefix);
505+
return true;
506+
}
507+
486508
// Check if a mangled type Name is unsigned
487509
bool isMangledTypeUnsigned(char Mangled) {
488510
return Mangled == 'h' /* uchar */

0 commit comments

Comments
 (0)