Skip to content

Commit 6556901

Browse files
author
Dmitry Sidorov
committed
[Backport to 18] Add __builtin_spirv_ internal builtins (#3374)
Way they are implemented is described in: #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 f460a4d commit 6556901

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
@@ -81,5 +81,6 @@ EXT(SPV_INTEL_ternary_bitwise_function)
8181
EXT(SPV_INTEL_int4)
8282
EXT(SPV_INTEL_function_variants)
8383
EXT(SPV_INTEL_shader_atomic_bfloat16)
84+
EXT(SPV_EXT_float8)
8485
EXT(SPV_INTEL_predicated_io)
8586
EXT(SPV_INTEL_sigmoid)

‎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 {
@@ -650,7 +651,7 @@ Op getSPIRVFuncOC(StringRef Name, SmallVectorImpl<std::string> *Dec = nullptr);
650651
bool getSPIRVBuiltin(const std::string &Name, spv::BuiltIn &Builtin);
651652

652653
/// \param Name LLVM function name
653-
/// \param DemangledName demanged name of the OpenCL built-in function
654+
/// \param DemangledName demangled name of the OpenCL built-in function
654655
/// \returns true if Name is the name of the OpenCL built-in function,
655656
/// false for other functions
656657
bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp = false);
@@ -713,6 +714,9 @@ CallInst *addCallInst(Module *M, StringRef FuncName, Type *RetTy,
713714
StringRef InstName = SPIR_TEMP_NAME_PREFIX_CALL,
714715
bool TakeFuncName = true);
715716

717+
/// Check if an LLVM type is spirv.CooperativeMatrixKHR.
718+
bool isLLVMCooperativeMatrixType(llvm::Type *Ty);
719+
716720
/// Add a call instruction for SPIR-V builtin function.
717721
CallInst *addCallInstSPIRV(Module *M, StringRef FuncName, Type *RetTy,
718722
ArrayRef<Value *> Args, AttributeList *Attrs,
@@ -1012,6 +1016,84 @@ bool postProcessBuiltinsReturningStruct(Module *M, bool IsCpp = false);
10121016

10131017
bool postProcessBuiltinsWithArrayArguments(Module *M, bool IsCpp = false);
10141018

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

10171099
#endif // SPIRV_SPIRVINTERNAL_H

‎lib/SPIRV/SPIRVReader.cpp‎

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

314314
Type *SPIRVToLLVM::transFPType(SPIRVType *T) {
315315
switch (T->getFloatBitWidth()) {
316+
case 8:
317+
// No LLVM IR counter part for FP8 - map it on i8
318+
return Type::getIntNTy(*Context, 8);
316319
case 16:
317320
if (T->isTypeFloat(16, FPEncodingBFloat16KHR))
318321
return Type::getBFloatTy(*Context);
@@ -1057,6 +1060,22 @@ Value *SPIRVToLLVM::transConvertInst(SPIRVValue *BV, Function *F,
10571060
CastInst::CastOps CO = Instruction::BitCast;
10581061
bool IsExt =
10591062
Dst->getScalarSizeInBits() > Src->getType()->getScalarSizeInBits();
1063+
1064+
auto GetFPEncoding = [](SPIRVType *Ty) -> FPEncodingWrap {
1065+
if (Ty->isTypeFloat()) {
1066+
unsigned Enc =
1067+
static_cast<SPIRVTypeFloat *>(Ty)->getFloatingPointEncoding();
1068+
return static_cast<FPEncodingWrap>(Enc);
1069+
}
1070+
if (Ty->isTypeInt())
1071+
return FPEncodingWrap::Integer;
1072+
return FPEncodingWrap::IEEE754;
1073+
};
1074+
1075+
auto IsFP8Encoding = [](FPEncodingWrap Encoding) -> bool {
1076+
return Encoding == FPEncodingWrap::E4M3 || Encoding == FPEncodingWrap::E5M2;
1077+
};
1078+
10601079
switch (BC->getOpCode()) {
10611080
case OpPtrCastToGeneric:
10621081
case OpGenericCastToPtr:
@@ -1078,10 +1097,58 @@ Value *SPIRVToLLVM::transConvertInst(SPIRVValue *BV, Function *F,
10781097
case OpUConvert:
10791098
CO = IsExt ? Instruction::ZExt : Instruction::Trunc;
10801099
break;
1081-
case OpFConvert:
1082-
CO = IsExt ? Instruction::FPExt : Instruction::FPTrunc;
1100+
case OpConvertSToF:
1101+
case OpConvertFToS:
1102+
case OpConvertUToF:
1103+
case OpConvertFToU:
1104+
case OpFConvert: {
1105+
const auto OC = BC->getOpCode();
1106+
{
1107+
auto SPVOps = BC->getOperands();
1108+
auto *SPVSrcTy = SPVOps[0]->getType();
1109+
auto *SPVDstTy = BC->getType();
1110+
1111+
auto GetEncodingAndUpdateType =
1112+
[GetFPEncoding](SPIRVType *&SPVTy) -> FPEncodingWrap {
1113+
if (SPVTy->isTypeVector()) {
1114+
SPVTy = SPVTy->getVectorComponentType();
1115+
} else if (SPVTy->isTypeCooperativeMatrixKHR()) {
1116+
auto *MT = static_cast<SPIRVTypeCooperativeMatrixKHR *>(SPVTy);
1117+
SPVTy = MT->getCompType();
1118+
}
1119+
return GetFPEncoding(SPVTy);
1120+
};
1121+
1122+
FPEncodingWrap SrcEnc = GetEncodingAndUpdateType(SPVSrcTy);
1123+
FPEncodingWrap DstEnc = GetEncodingAndUpdateType(SPVDstTy);
1124+
if (IsFP8Encoding(SrcEnc) || IsFP8Encoding(DstEnc) ||
1125+
SPVSrcTy->isTypeInt(4) || SPVDstTy->isTypeInt(4)) {
1126+
FPConversionDesc FPDesc = {SrcEnc, DstEnc, BC->getOpCode()};
1127+
auto Conv = SPIRV::FPConvertToEncodingMap::rmap(FPDesc);
1128+
std::vector<Value *> Ops = {Src};
1129+
std::vector<Type *> OpsTys = {Src->getType()};
1130+
1131+
std::string BuiltinName =
1132+
kSPIRVName::InternalBuiltinPrefix + std::string(Conv);
1133+
BuiltinFuncMangleInfo Info;
1134+
std::string MangledName = mangleBuiltin(BuiltinName, OpsTys, &Info);
1135+
1136+
FunctionType *FTy = FunctionType::get(Dst, OpsTys, false);
1137+
FunctionCallee Func = M->getOrInsertFunction(MangledName, FTy);
1138+
return CallInst::Create(Func, Ops, "", BB);
1139+
}
1140+
}
1141+
1142+
if (OC == OpFConvert) {
1143+
CO = IsExt ? Instruction::FPExt : Instruction::FPTrunc;
1144+
break;
1145+
}
1146+
CO = static_cast<CastInst::CastOps>(OpCodeMap::rmap(OC));
10831147
break;
1148+
}
10841149
case OpBitcast:
1150+
if (!Dst->isPointerTy() && Dst == Src->getType())
1151+
return Src;
10851152
// OpBitcast need to be handled as a special-case when the source is a
10861153
// pointer and the destination is not a pointer, and where the source is not
10871154
// a pointer and the destination is a pointer. This is supported by the
@@ -2964,11 +3031,29 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
29643031
if (isCvtOpCode(OC) && OC != OpGenericCastToPtrExplicit) {
29653032
auto *BI = static_cast<SPIRVInstruction *>(BV);
29663033
Value *Inst = nullptr;
2967-
if (BI->hasFPRoundingMode() || BI->isSaturatedConversion() ||
2968-
BI->getType()->isTypeCooperativeMatrixKHR())
3034+
if (BI->hasFPRoundingMode() || BI->isSaturatedConversion()) {
29693035
Inst = transSPIRVBuiltinFromInst(BI, BB);
2970-
else
3036+
} else if (BI->getType()->isTypeCooperativeMatrixKHR()) {
3037+
// For cooperative matrix conversions generate __builtin_spirv
3038+
// conversions instead of __spirv_FConvert in case of mini-float
3039+
// type element type.
3040+
auto *OutMatrixElementTy =
3041+
static_cast<SPIRVTypeCooperativeMatrixKHR *>(BI->getType())
3042+
->getCompType();
3043+
auto *InMatrixElementTy =
3044+
static_cast<SPIRVTypeCooperativeMatrixKHR *>(
3045+
static_cast<SPIRVUnary *>(BI)->getOperand(0)->getType())
3046+
->getCompType();
3047+
if (OutMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E4M3EXT) ||
3048+
OutMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E5M2EXT) ||
3049+
InMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E4M3EXT) ||
3050+
InMatrixElementTy->isTypeFloat(8, FPEncodingFloat8E5M2EXT))
3051+
Inst = transConvertInst(BV, F, BB);
3052+
else
3053+
Inst = transSPIRVBuiltinFromInst(BI, BB);
3054+
} else {
29713055
Inst = transConvertInst(BV, F, BB);
3056+
}
29723057
return mapValue(BV, Inst);
29733058
}
29743059
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"
@@ -265,6 +266,12 @@ bool isSYCLBfloat16Type(llvm::Type *Ty) {
265266
return false;
266267
}
267268

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

440-
// Demangled name is a substring of the name. The DemangledName is updated only
447+
// DemangledName is a substring of Name. The DemangledName is updated only
441448
// if true is returned
442449
bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp) {
443450
if (Name == "printf") {
@@ -482,6 +489,21 @@ bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp) {
482489
return false;
483490
}
484491

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

0 commit comments

Comments
 (0)