Skip to content

Commit 5166c40

Browse files
author
Dmitry Sidorov
committed
[Backport to 19] 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 <dmitry.sidorov@intel.com> --------- Signed-off-by: Sidorov, Dmitry <dmitry.sidorov@intel.com>
1 parent 9367883 commit 5166c40

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
@@ -83,5 +83,6 @@ EXT(SPV_INTEL_ternary_bitwise_function)
8383
EXT(SPV_INTEL_int4)
8484
EXT(SPV_INTEL_function_variants)
8585
EXT(SPV_INTEL_shader_atomic_bfloat16)
86+
EXT(SPV_EXT_float8)
8687
EXT(SPV_INTEL_predicated_io)
8788
EXT(SPV_INTEL_sigmoid)

‎lib/SPIRV/SPIRVInternal.h‎

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

379380
namespace kSPIRVPostfix {
@@ -652,7 +653,7 @@ Op getSPIRVFuncOC(StringRef Name, SmallVectorImpl<std::string> *Dec = nullptr);
652653
bool getSPIRVBuiltin(const std::string &Name, spv::BuiltIn &Builtin);
653654

654655
/// \param Name LLVM function name
655-
/// \param DemangledName demanged name of the OpenCL built-in function
656+
/// \param DemangledName demangled name of the OpenCL built-in function
656657
/// \returns true if Name is the name of the OpenCL built-in function,
657658
/// false for other functions
658659
bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp = false);
@@ -715,6 +716,9 @@ CallInst *addCallInst(Module *M, StringRef FuncName, Type *RetTy,
715716
StringRef InstName = SPIR_TEMP_NAME_PREFIX_CALL,
716717
bool TakeFuncName = true);
717718

719+
/// Check if an LLVM type is spirv.CooperativeMatrixKHR.
720+
bool isLLVMCooperativeMatrixType(llvm::Type *Ty);
721+
718722
/// Add a call instruction for SPIR-V builtin function.
719723
CallInst *addCallInstSPIRV(Module *M, StringRef FuncName, Type *RetTy,
720724
ArrayRef<Value *> Args, AttributeList *Attrs,
@@ -1015,6 +1019,84 @@ bool postProcessBuiltinsReturningStruct(Module *M, bool IsCpp = false);
10151019

10161020
bool postProcessBuiltinsWithArrayArguments(Module *M, bool IsCpp = false);
10171021

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

10201102
#endif // SPIRV_SPIRVINTERNAL_H

‎lib/SPIRV/SPIRVReader.cpp‎

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

316316
Type *SPIRVToLLVM::transFPType(SPIRVType *T) {
317317
switch (T->getFloatBitWidth()) {
318+
case 8:
319+
// No LLVM IR counter part for FP8 - map it on i8
320+
return Type::getIntNTy(*Context, 8);
318321
case 16:
319322
if (T->isTypeFloat(16, FPEncodingBFloat16KHR))
320323
return Type::getBFloatTy(*Context);
@@ -1062,6 +1065,22 @@ Value *SPIRVToLLVM::transConvertInst(SPIRVValue *BV, Function *F,
10621065
CastInst::CastOps CO = Instruction::BitCast;
10631066
bool IsExt =
10641067
Dst->getScalarSizeInBits() > Src->getType()->getScalarSizeInBits();
1068+
1069+
auto GetFPEncoding = [](SPIRVType *Ty) -> FPEncodingWrap {
1070+
if (Ty->isTypeFloat()) {
1071+
unsigned Enc =
1072+
static_cast<SPIRVTypeFloat *>(Ty)->getFloatingPointEncoding();
1073+
return static_cast<FPEncodingWrap>(Enc);
1074+
}
1075+
if (Ty->isTypeInt())
1076+
return FPEncodingWrap::Integer;
1077+
return FPEncodingWrap::IEEE754;
1078+
};
1079+
1080+
auto IsFP8Encoding = [](FPEncodingWrap Encoding) -> bool {
1081+
return Encoding == FPEncodingWrap::E4M3 || Encoding == FPEncodingWrap::E5M2;
1082+
};
1083+
10651084
switch (BC->getOpCode()) {
10661085
case OpPtrCastToGeneric:
10671086
case OpGenericCastToPtr:
@@ -1083,10 +1102,58 @@ Value *SPIRVToLLVM::transConvertInst(SPIRVValue *BV, Function *F,
10831102
case OpUConvert:
10841103
CO = IsExt ? Instruction::ZExt : Instruction::Trunc;
10851104
break;
1086-
case OpFConvert:
1087-
CO = IsExt ? Instruction::FPExt : Instruction::FPTrunc;
1105+
case OpConvertSToF:
1106+
case OpConvertFToS:
1107+
case OpConvertUToF:
1108+
case OpConvertFToU:
1109+
case OpFConvert: {
1110+
const auto OC = BC->getOpCode();
1111+
{
1112+
auto SPVOps = BC->getOperands();
1113+
auto *SPVSrcTy = SPVOps[0]->getType();
1114+
auto *SPVDstTy = BC->getType();
1115+
1116+
auto GetEncodingAndUpdateType =
1117+
[GetFPEncoding](SPIRVType *&SPVTy) -> FPEncodingWrap {
1118+
if (SPVTy->isTypeVector()) {
1119+
SPVTy = SPVTy->getVectorComponentType();
1120+
} else if (SPVTy->isTypeCooperativeMatrixKHR()) {
1121+
auto *MT = static_cast<SPIRVTypeCooperativeMatrixKHR *>(SPVTy);
1122+
SPVTy = MT->getCompType();
1123+
}
1124+
return GetFPEncoding(SPVTy);
1125+
};
1126+
1127+
FPEncodingWrap SrcEnc = GetEncodingAndUpdateType(SPVSrcTy);
1128+
FPEncodingWrap DstEnc = GetEncodingAndUpdateType(SPVDstTy);
1129+
if (IsFP8Encoding(SrcEnc) || IsFP8Encoding(DstEnc) ||
1130+
SPVSrcTy->isTypeInt(4) || SPVDstTy->isTypeInt(4)) {
1131+
FPConversionDesc FPDesc = {SrcEnc, DstEnc, BC->getOpCode()};
1132+
auto Conv = SPIRV::FPConvertToEncodingMap::rmap(FPDesc);
1133+
std::vector<Value *> Ops = {Src};
1134+
std::vector<Type *> OpsTys = {Src->getType()};
1135+
1136+
std::string BuiltinName =
1137+
kSPIRVName::InternalBuiltinPrefix + std::string(Conv);
1138+
BuiltinFuncMangleInfo Info;
1139+
std::string MangledName = mangleBuiltin(BuiltinName, OpsTys, &Info);
1140+
1141+
FunctionType *FTy = FunctionType::get(Dst, OpsTys, false);
1142+
FunctionCallee Func = M->getOrInsertFunction(MangledName, FTy);
1143+
return CallInst::Create(Func, Ops, "", BB);
1144+
}
1145+
}
1146+
1147+
if (OC == OpFConvert) {
1148+
CO = IsExt ? Instruction::FPExt : Instruction::FPTrunc;
1149+
break;
1150+
}
1151+
CO = static_cast<CastInst::CastOps>(OpCodeMap::rmap(OC));
10881152
break;
1153+
}
10891154
case OpBitcast:
1155+
if (!Dst->isPointerTy() && Dst == Src->getType())
1156+
return Src;
10901157
// OpBitcast need to be handled as a special-case when the source is a
10911158
// pointer and the destination is not a pointer, and where the source is not
10921159
// a pointer and the destination is a pointer. This is supported by the
@@ -2909,11 +2976,29 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
29092976
if (isCvtOpCode(OC) && OC != OpGenericCastToPtrExplicit) {
29102977
auto *BI = static_cast<SPIRVInstruction *>(BV);
29112978
Value *Inst = nullptr;
2912-
if (BI->hasFPRoundingMode() || BI->isSaturatedConversion() ||
2913-
BI->getType()->isTypeCooperativeMatrixKHR())
2979+
if (BI->hasFPRoundingMode() || BI->isSaturatedConversion()) {
29142980
Inst = transSPIRVBuiltinFromInst(BI, BB);
2915-
else
2981+
} else if (BI->getType()->isTypeCooperativeMatrixKHR()) {
2982+
// For cooperative matrix conversions generate __builtin_spirv
2983+
// conversions instead of __spirv_FConvert in case of mini-float
2984+
// type element type.
2985+
auto *OutMatrixElementTy =
2986+
static_cast<SPIRVTypeCooperativeMatrixKHR *>(BI->getType())
2987+
->getCompType();
2988+
auto *InMatrixElementTy =
2989+
static_cast<SPIRVTypeCooperativeMatrixKHR *>(
2990+
static_cast<SPIRVUnary *>(BI)->getOperand(0)->getType())
2991+
->getCompType();
2992+
if (OutMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E4M3EXT) ||
2993+
OutMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E5M2EXT) ||
2994+
InMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E4M3EXT) ||
2995+
InMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E5M2EXT))
2996+
Inst = transConvertInst(BV, F, BB);
2997+
else
2998+
Inst = transSPIRVBuiltinFromInst(BI, BB);
2999+
} else {
29163000
Inst = transConvertInst(BV, F, BB);
3001+
}
29173002
return mapValue(BV, Inst);
29183003
}
29193004
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)