Skip to content

Commit

Permalink
Add IAddCarry and ISubBorrow builtins (KhronosGroup#2392) (KhronosGro…
Browse files Browse the repository at this point in the history 
…up#2442)

The fix adds support for IR builtin calls
__spirv_IAddCarry and __spirv_ISubBorrow.
It's also first part of fix which removes noncompliance of uadd/sub_with_overflow intrinsics.
SPIRVUtil changes are needed to support situations where builtin don't have corresponding store instruction.

Co-authored-by: bwlodarcz <bertrand.wlodarczyk@intel.com>
  • Loading branch information
@igorban-intel @bwlodarcz
igorban-intel and bwlodarcz authored Mar 22, 2024
1 parent 2a290ad commit 577ceda
Show file tree
Hide file tree
Showing 7 changed files with 366 additions and 29 deletions.
12 changes: 2 additions & 10 deletions lib/SPIRV/SPIRVReader.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2305,20 +2305,12 @@ Value *SPIRVToLLVM::transValueWithoutDecoration(SPIRVValue *BV, Function *F,
return mapValue(BV,
transRelational(static_cast<SPIRVInstruction *>(BV), BB));
case OpIAddCarry: {
IRBuilder<> Builder(BB);
auto *BC = static_cast<SPIRVBinary *>(BV);
return mapValue(BV, Builder.CreateBinaryIntrinsic(
Intrinsic::uadd_with_overflow,
transValue(BC->getOperand(0), F, BB),
transValue(BC->getOperand(1), F, BB)));
return mapValue(BV, transBuiltinFromInst("__spirv_IAddCarry", BC, BB));
}
case OpISubBorrow: {
IRBuilder<> Builder(BB);
auto *BC = static_cast<SPIRVBinary *>(BV);
return mapValue(BV, Builder.CreateBinaryIntrinsic(
Intrinsic::usub_with_overflow,
transValue(BC->getOperand(0), F, BB),
transValue(BC->getOperand(1), F, BB)));
return mapValue(BV, transBuiltinFromInst("__spirv_ISubBorrow", BC, BB));
}
case OpGetKernelWorkGroupSize:
case OpGetKernelPreferredWorkGroupSizeMultiple:
Expand Down
27 changes: 21 additions & 6 deletions lib/SPIRV/SPIRVUtil.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1853,23 +1853,38 @@ bool postProcessBuiltinReturningStruct(Function *F) {
SmallVector<Instruction *, 32> InstToRemove;
for (auto *U : F->users()) {
if (auto *CI = dyn_cast<CallInst>(U)) {
auto *ST = cast<StoreInst>(*(CI->user_begin()));
IRBuilder<> Builder(CI->getParent());
Builder.SetInsertPoint(CI);
SmallVector<User *, 5> Users(CI->users());
Value *A = nullptr;
for (auto *U : Users) {
if (auto *SI = dyn_cast<StoreInst>(U)) {
A = SI->getPointerOperand();
InstToRemove.push_back(SI);
break;
}
}
if (!A) {
A = Builder.CreateAlloca(F->getReturnType());
}
std::vector<Type *> ArgTys;
getFunctionTypeParameterTypes(F->getFunctionType(), ArgTys);
ArgTys.insert(ArgTys.begin(),
PointerType::get(F->getReturnType(), SPIRAS_Private));
ArgTys.insert(ArgTys.begin(), A->getType());
auto *NewF =
getOrCreateFunction(M, Type::getVoidTy(*Context), ArgTys, Name);
auto SRetAttr = Attribute::get(*Context, Attribute::AttrKind::StructRet,
F->getReturnType());
NewF->addParamAttr(0, SRetAttr);
NewF->setCallingConv(F->getCallingConv());
auto Args = getArguments(CI);
Args.insert(Args.begin(), ST->getPointerOperand());
auto *NewCI = CallInst::Create(NewF, Args, CI->getName(), CI);
Args.insert(Args.begin(), A);
CallInst *NewCI = Builder.CreateCall(NewF, Args, CI->getName());
NewCI->addParamAttr(0, SRetAttr);
NewCI->setCallingConv(CI->getCallingConv());
InstToRemove.push_back(ST);
SmallVector<User *, 5> CIUsers(CI->users());
for (auto *CIUser : CIUsers) {
CIUser->replaceUsesOfWith(CI, A);
}
InstToRemove.push_back(CI);
}
}
Expand Down
18 changes: 18 additions & 0 deletions lib/SPIRV/SPIRVWriter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4379,6 +4379,24 @@ LLVMToSPIRVBase::transBuiltinToInstWithoutDecoration(Op OC, CallInst *CI,
return BM->addArbFloatPointIntelInst(OC, transType(ResTy), InA, InB,
Literals, BB);
}
case OpIAddCarry: {
Function *F = CI->getCalledFunction();
auto *RetTy = F->arg_begin()->getType()->getPointerElementType();
StructType *St = cast<StructType>(RetTy);
SPIRVValue *V = BM->addBinaryInst(OpIAddCarry, transType(St),
transValue(CI->getArgOperand(1), BB),
transValue(CI->getArgOperand(2), BB), BB);
return BM->addStoreInst(transValue(CI->getArgOperand(0), BB), V, {}, BB);
}
case OpISubBorrow: {
Function *F = CI->getCalledFunction();
auto *RetTy = F->arg_begin()->getType()->getPointerElementType();
StructType *St = cast<StructType>(RetTy);
SPIRVValue *V = BM->addBinaryInst(OpISubBorrow, transType(St),
transValue(CI->getArgOperand(1), BB),
transValue(CI->getArgOperand(2), BB), BB);
return BM->addStoreInst(transValue(CI->getArgOperand(0), BB), V, {}, BB);
}
default: {
if (isCvtOpCode(OC) && OC != OpGenericCastToPtrExplicit) {
return BM->addUnaryInst(OC, transType(CI->getType()),
Expand Down
163 changes: 163 additions & 0 deletions test/iaddcarry_builtin.ll
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
; REQUIRES: spirv-dis
; RUN: llvm-as %s -o %t.bc
; RUN: llvm-spirv %t.bc -o %t.spv
; RUN: spirv-dis --raw-id %t.spv | FileCheck --check-prefix CHECK-SPIRV %s
; RUN: spirv-val %t.spv
; RUN: llvm-spirv -r %t.spv -o %t.rev.bc
; RUN: llvm-dis %t.rev.bc -o - | FileCheck --check-prefix CHECK-LLVM %s

target triple = "spir64-unknown-unknown"

%i8struct = type {i8, i8}
%i16struct = type {i16, i16}
%i32struct = type {i32, i32}
%i64struct = type {i64, i64}
%vecstruct = type {<4 x i32>, <4 x i32>}

; CHECK-SPIRV-DAG: [[uchar:%[a-z0-9_]+]] = OpTypeInt 8
; CHECK-SPIRV-DAG: [[ushort:%[a-z0-9_]+]] = OpTypeInt 16
; CHECK-SPIRV-DAG: [[uint:%[a-z0-9_]+]] = OpTypeInt 32
; CHECK-SPIRV-DAG: [[ulong:%[a-z0-9_]+]] = OpTypeInt 64
; CHECK-SPIRV-DAG: [[void:%[a-z0-9_]+]] = OpTypeVoid
; CHECK-SPIRV-DAG: [[i8struct:%[a-z0-9_]+]] = OpTypeStruct [[uchar]] [[uchar]]
; CHECK-SPIRV-DAG: [[_ptr_Function_i8struct:%[a-z0-9_]+]] = OpTypePointer Function [[i8struct]]
; CHECK-SPIRV-DAG: [[i16struct:%[a-z0-9_]+]] = OpTypeStruct [[ushort]] [[ushort]]
; CHECK-SPIRV-DAG: [[_ptr_Function_i16struct:%[a-z0-9_]+]] = OpTypePointer Function [[i16struct]]
; CHECK-SPIRV-DAG: [[i32struct:%[a-z0-9_]+]] = OpTypeStruct [[uint]] [[uint]]
; CHECK-SPIRV-DAG: [[_ptr_Function_i32struct:%[a-z0-9_]+]] = OpTypePointer Function [[i32struct]]
; CHECK-SPIRV-DAG: [[i64struct:%[a-z0-9_]+]] = OpTypeStruct [[ulong]] [[ulong]]
; CHECK-SPIRV-DAG: [[_ptr_Function_i64struct:%[a-z0-9_]+]] = OpTypePointer Function [[i64struct]]
; CHECK-SPIRV-DAG: [[v4uint:%[a-z0-9_]+]] = OpTypeVector [[uint]] 4
; CHECK-SPIRV-DAG: [[vecstruct:%[a-z0-9_]+]] = OpTypeStruct [[v4uint]] [[v4uint]]
; CHECK-SPIRV-DAG: [[_ptr_Function_vecstruct:%[a-z0-9_]+]] = OpTypePointer Function [[vecstruct]]
; CHECK-SPIRV-DAG: [[struct_anon:%[a-z0-9_.]+]] = OpTypeStruct [[uint]] [[uint]]
; CHECK-SPIRV-DAG: [[_ptr_Function_struct_anon:%[a-z0-9_]+]] = OpTypePointer Function [[struct_anon]]
; CHECK-SPIRV-DAG: [[_ptr_Generic_struct_anon:%[a-z0-9_]+]] = OpTypePointer Generic [[struct_anon]]

; CHECK-LLVM-DAG: [[i8struct:%[a-z0-9_.]+]] = type { i8, i8 }
; CHECK-LLVM-DAG: [[i16struct:%[a-z0-9_.]+]] = type { i16, i16 }
; CHECK-LLVM-DAG: [[i32struct:%[a-z0-9_.]+]] = type { i32, i32 }
; CHECK-LLVM-DAG: [[i64struct:%[a-z0-9_.]+]] = type { i64, i64 }
; CHECK-LLVM-DAG: [[vecstruct:%[a-z0-9_.]+]] = type { <4 x i32>, <4 x i32> }
; CHECK-LLVM-DAG: [[struct_anon:%[a-z0-9_.]+]] = type { i32, i32 }

define spir_func void @test_builtin_iaddcarrycc(i8 %a, i8 %b) {
entry:
%0 = alloca %i8struct
call void @_Z17__spirv_IAddCarrycc(%i8struct* %0, i8 %a, i8 %b)
ret void
}

; CHECK-SPIRV: [[a:%[a-z0-9_]+]] = OpFunctionParameter [[uchar]]
; CHECK-SPIRV: [[b:%[a-z0-9_]+]] = OpFunctionParameter [[uchar]]
; CHECK-SPIRV: [[entry:%[a-z0-9_]+]] = OpLabel
; CHECK-SPIRV: [[var_11:%[a-z0-9_]+]] = OpVariable [[_ptr_Function_i8struct]] Function
; CHECK-SPIRV: [[var_12:%[a-z0-9_]+]] = OpIAddCarry [[i8struct]] [[a]] [[b]]
; CHECK-SPIRV: OpStore [[var_11]] [[var_12]]
; CHECK-SPIRV: OpReturn
; CHECK-SPIRV: OpFunctionEnd

; CHECK-LLVM: %0 = alloca [[i8struct]], align 8
; CHECK-LLVM: call spir_func void @_Z17__spirv_IAddCarrycc([[i8struct]]* sret %0, i8 %a, i8 %b)
; CHECK-LLVM: ret void
define spir_func void @test_builtin_iaddcarryss(i16 %a, i16 %b) {
entry:
%0 = alloca %i16struct
call void @_Z17__spirv_IAddCarryss(%i16struct* %0, i16 %a, i16 %b)
ret void
}
; CHECK-SPIRV: [[a_0:%[a-z0-9_]+]] = OpFunctionParameter [[ushort]]
; CHECK-SPIRV: [[b_0:%[a-z0-9_]+]] = OpFunctionParameter [[ushort]]
; CHECK-SPIRV: [[entry_0:%[a-z0-9_]+]] = OpLabel
; CHECK-SPIRV: [[var_21:%[a-z0-9_]+]] = OpVariable [[_ptr_Function_i16struct]] Function
; CHECK-SPIRV: [[var_22:%[a-z0-9_]+]] = OpIAddCarry [[i16struct]] [[a_0]] [[b_0]]
; CHECK-SPIRV: OpStore [[var_21]] [[var_22]]
; CHECK-SPIRV: OpReturn
; CHECK-SPIRV: OpFunctionEnd

; CHECK-LLVM: %0 = alloca [[i16struct]], align 8
; CHECK-LLVM: call spir_func void @_Z17__spirv_IAddCarryss([[i16struct]]* sret %0, i16 %a, i16 %b)
; CHECK-LLVM: ret void
define spir_func void @test_builtin_iaddcarryii(i32 %a, i32 %b) {
entry:
%0 = alloca %i32struct
call void @_Z17__spirv_IAddCarryii(%i32struct* %0, i32 %a, i32 %b)
ret void
}
; CHECK-SPIRV: [[a_1:%[a-z0-9_]+]] = OpFunctionParameter [[uint]]
; CHECK-SPIRV: [[b_1:%[a-z0-9_]+]] = OpFunctionParameter [[uint]]
; CHECK-SPIRV: [[entry_1:%[a-z0-9_]+]] = OpLabel
; CHECK-SPIRV: [[var_31:%[a-z0-9_]+]] = OpVariable [[_ptr_Function_i32struct]] Function
; CHECK-SPIRV: [[var_32:%[a-z0-9_]+]] = OpIAddCarry [[i32struct]] [[a_1]] [[b_1]]
; CHECK-SPIRV: OpStore [[var_31]] [[var_32]]
; CHECK-SPIRV: OpReturn
; CHECK-SPIRV: OpFunctionEnd

; CHECK-LLVM: %0 = alloca [[i32struct]], align 8
; CHECK-LLVM: call spir_func void @_Z17__spirv_IAddCarryii([[i32struct]]* sret %0, i32 %a, i32 %b)
; CHECK-LLVM: ret void
define spir_func void @test_builtin_iaddcarryll(i64 %a, i64 %b) {
entry:
%0 = alloca %i64struct
call void @_Z17__spirv_IAddCarryll(%i64struct* %0, i64 %a, i64 %b)
ret void
}
; CHECK-SPIRV: [[a_2:%[a-z0-9_]+]] = OpFunctionParameter [[ulong]]
; CHECK-SPIRV: [[b_2:%[a-z0-9_]+]] = OpFunctionParameter [[ulong]]
; CHECK-SPIRV: [[entry_2:%[a-z0-9_]+]] = OpLabel
; CHECK-SPIRV: [[var_41:%[a-z0-9_]+]] = OpVariable [[_ptr_Function_i64struct]] Function
; CHECK-SPIRV: [[var_42:%[a-z0-9_]+]] = OpIAddCarry [[i64struct]] [[a_2]] [[b_2]]
; CHECK-SPIRV: OpStore [[var_41]] [[var_42]]
; CHECK-SPIRV: OpReturn
; CHECK-SPIRV: OpFunctionEnd

; CHECK-LLVM: %0 = alloca [[i64struct]]
; CHECK-LLVM: call spir_func void @_Z17__spirv_IAddCarryll([[i64struct]]* sret %0, i64 %a, i64 %b)
; CHECK-LLVM: ret void
define spir_func void @test_builtin_iaddcarryDv4_xS_(<4 x i32> %a, <4 x i32> %b) {
entry:
%0 = alloca %vecstruct
call void @_Z17__spirv_IAddCarryDv4_iS_(%vecstruct* %0, <4 x i32> %a, <4 x i32> %b)
ret void
}
; CHECK-SPIRV: [[a_3:%[a-z0-9_]+]] = OpFunctionParameter [[v4uint]]
; CHECK-SPIRV: [[b_3:%[a-z0-9_]+]] = OpFunctionParameter [[v4uint]]
; CHECK-SPIRV: [[entry_3:%[a-z0-9_]+]] = OpLabel
; CHECK-SPIRV: [[var_51:%[a-z0-9_]+]] = OpVariable [[_ptr_Function_vecstruct]] Function
; CHECK-SPIRV: [[var_52:%[a-z0-9_]+]] = OpIAddCarry [[vecstruct]] [[a_3]] [[b_3]]
; CHECK-SPIRV: OpStore [[var_51]] [[var_52]]
; CHECK-SPIRV: OpReturn
; CHECK-SPIRV: OpFunctionEnd

; CHECK-LLVM: %0 = alloca [[vecstruct]]
; CHECK-LLVM: call spir_func void @_Z17__spirv_IAddCarryDv4_iS_([[vecstruct]]* sret %0, <4 x i32> %a, <4 x i32> %b)
; CHECK-LLVM: ret void

%struct.anon = type { i32, i32 }

define spir_func void @test_builtin_iaddcarry_anon(i32 %a, i32 %b) {
entry:
%0 = alloca %struct.anon
%1 = addrspacecast %struct.anon* %0 to %struct.anon addrspace(4)*
call spir_func void @_Z17__spirv_IAddCarryIiiE4anonIT_T0_ES1_S2_(%struct.anon addrspace(4)* %1, i32 %a, i32 %b)
ret void
}
; CHECK-SPIRV: [[a_4:%[a-z0-9_]+]] = OpFunctionParameter [[uint]]
; CHECK-SPIRV: [[b_4:%[a-z0-9_]+]] = OpFunctionParameter [[uint]]
; CHECK-SPIRV: [[entry_4:%[a-z0-9_]+]] = OpLabel
; CHECK-SPIRV: [[var_59:%[a-z0-9_]+]] = OpVariable [[_ptr_Function_struct_anon]] Function
; CHECK-SPIRV: [[var_61:%[a-z0-9_]+]] = OpPtrCastToGeneric [[_ptr_Generic_struct_anon]] [[var_59]]
; CHECK-SPIRV: [[var_62:%[a-z0-9_]+]] = OpIAddCarry [[struct_anon]] [[a_4]] [[b_4]]
; CHECK-SPIRV: OpStore [[var_61]] [[var_62]]

; CHECK-LLVM: %0 = alloca [[struct_anon]], align 8
; CHECK-LLVM: %1 = addrspacecast [[struct_anon]]* %0 to [[struct_anon]] addrspace(4)*
; CHECK-LLVM: call spir_func void @_Z17__spirv_IAddCarryii.1([[struct_anon]] addrspace(4)* sret %1, i32 %a, i32 %b)
; CHECK-LLVM: ret void

declare void @_Z17__spirv_IAddCarryIiiE4anonIT_T0_ES1_S2_(%struct.anon addrspace(4)* align 4, i32, i32)
declare void @_Z17__spirv_IAddCarrycc(%i8struct*, i8, i8)
declare void @_Z17__spirv_IAddCarryss(%i16struct*, i16, i16)
declare void @_Z17__spirv_IAddCarryii(%i32struct*, i32, i32)
declare void @_Z17__spirv_IAddCarryll(%i64struct*, i64, i64)
declare void @_Z17__spirv_IAddCarryDv4_iS_(%vecstruct*, <4 x i32>, <4 x i32>)
Loading

0 comments on commit 577ceda

Please sign in to comment.