[SYCL Bindless Image] Lower get_image_depth builtin to resinfoptr

When image handle is loaded from memory, it is impossible to get its
depth from any implicit argument. Therefore, we have to read from
resinfoptr result.

Co-authored-by: Yury Plyakhin <[email protected]>

Author: 2 people

IGC/Compiler/Optimizer/OCLBIUtils.cpp

@@ -948,6 +948,9 @@ class CGetImageProperty : public CImagesBI
         case HEIGHT:
             prop = builder.CreateExtractElement(info, builder.getInt32(1));
             break;
+        case DEPTH:
+            prop = builder.CreateExtractElement(info, builder.getInt32(2));
+            break;
         default:
             emitError("Unsupported bindless image property requested.", NULL);
         }
@@ -1356,6 +1359,7 @@ CBuiltinsResolver::CBuiltinsResolver(CImagesBI::ParamMap* paramMap, CImagesBI::I
     if (modMD->compOpt.UseBindlessMode && !modMD->compOpt.UseLegacyBindlessMode){
         m_CommandMap["__builtin_IB_get_image_width"] = CGetImageProperty::create(paramMap, CImagesBI::ImageProperty::WIDTH);
         m_CommandMap["__builtin_IB_get_image_height"] = CGetImageProperty::create(paramMap, CImagesBI::ImageProperty::HEIGHT);
+        m_CommandMap["__builtin_IB_get_image_depth"] = CGetImageProperty::create(paramMap, CImagesBI::ImageProperty::DEPTH);
     }
 
     //convert Built-ins

IGC/Compiler/Optimizer/OCLBIUtils.h

@@ -163,7 +163,8 @@ namespace IGC
         enum ImageProperty
         {
             WIDTH,
-            HEIGHT
+            HEIGHT,
+            DEPTH
         };
 
         struct ParamInfo

IGC/Compiler/Optimizer/OpenCLPasses/ImageFuncs/ImageFuncResolution.cpp

@@ -81,6 +81,11 @@ void ImageFuncResolution::visitCallInst(CallInst& CI)
     }
     else if (funcName.equals(ImageFuncsAnalysis::GET_IMAGE_DEPTH))
     {
+        if (!isImplicitImageArgs)
+        {
+            IGC_ASSERT_MESSAGE(false, "Getting Image Depth from implicit args is supported only in bindful mode");
+            return;
+        }
         imageRes = getImageDepth(CI);
     }
     else if (funcName.equals(ImageFuncsAnalysis::GET_IMAGE_NUM_MIP_LEVELS))

IGC/Compiler/Optimizer/OpenCLPasses/ImageFuncs/ImageFuncsAnalysis.cpp

@@ -107,7 +107,7 @@ void ImageFuncsAnalysis::visitCallInst(CallInst& CI)
     {
         imageFunc = &m_argMap[ImplicitArg::IMAGE_WIDTH];
     }
-    else if (funcName == GET_IMAGE_DEPTH)
+    else if (funcName == GET_IMAGE_DEPTH && m_addImplicitImageArgs)
     {
         imageFunc = &m_argMap[ImplicitArg::IMAGE_DEPTH];
     }

IGC/Compiler/tests/ImageFuncAnalysis/get_image_depth_bindless.ll

@@ -0,0 +1,38 @@
+;=========================== begin_copyright_notice ============================
+;
+; Copyright (C) 2024 Intel Corporation
+;
+; SPDX-License-Identifier: MIT
+;
+;============================ end_copyright_notice =============================
+
+; Negative test checks that no implicit args are captured in bindless mode
+
+; RUN: igc_opt -igc-image-func-analysis -S %s -o - | FileCheck %s
+
+%opencl.image2d_t = type opaque
+
+declare i32 @__builtin_IB_get_image_depth(i32 %img)
+
+define i32 @foo(i32 %img) nounwind {
+  %id = call i32 @__builtin_IB_get_image_depth(i32 %img)
+  ret i32 %id
+}
+
+!igc.functions = !{!0}
+!IGCMetadata = !{!4}
+
+!0 = !{i32 (i32)* @foo, !1}
+!1 = !{!2, !3}
+!2 = !{!"function_type", i32 0}
+!3 = !{!"implicit_arg_desc"}
+!4 = !{!"ModuleMD", !5}
+!5 = !{!"compOpt", !6, !7}
+!6 = !{!"UseBindlessMode", i1 true}
+!7 = !{!"UseLegacyBindlessMode", i1 false}
+
+;CHECK-NOT: !{!"implicit_arg_desc", ![[A1:[0-9]+]]}
+;CHECK-NOT: ![[A2:[0-9]+]] = !{i32 22, ![[A3:[0-9]+]]}
+;CHECK-NOT: ![[A4:[0-9]+]] = !{!"explicit_arg_num", i32 0}
+
+

IGC/Compiler/tests/OCLBIConverter/get_image_prop.ll

@@ -20,23 +20,25 @@ define spir_kernel void @kernel(%spirv.Image._void_1_0_0_0_0_0_0 addrspace(1)* %
   %1 = trunc i64 %data to i32
 ; CHECK-NOT: __builtin_IB_get_image_width
 ; CHECK-NOT: __builtin_IB_get_image_height
+; CHECK-NOT: __builtin_IB_get_image_height
 ; CHECK:    [[BINDLESS_IMG:%.*]] = addrspacecast [[SPIRV_IMAGE__VOID_1_0_0_0_0_0_0]] addrspace(1)* [[IMG]] to float addrspace(393216)*
-; CHECK-NEXT:    [[TMP2:%.*]] = call <4 x i32> @llvm.genx.GenISA.resinfoptr.p393216f32(float addrspace(393216)* [[BINDLESS_IMG]], i32 0)
-; CHECK-NEXT:    [[TMP3:%.*]] = extractelement <4 x i32> [[TMP2]], i32 0
+; CHECK-NEXT:    [[TMP1:%.*]] = call <4 x i32> @llvm.genx.GenISA.resinfoptr.p393216f32(float addrspace(393216)* [[BINDLESS_IMG]], i32 0)
+; CHECK-NEXT:    extractelement <4 x i32> [[TMP1]], i32 0
 ; CHECK-NEXT:    [[BINDLESS_IMG1:%.*]] = addrspacecast [[SPIRV_IMAGE__VOID_1_0_0_0_0_0_0]] addrspace(1)* [[IMG]] to float addrspace(393216)*
-; CHECK-NEXT:    [[TMP4:%.*]] = call <4 x i32> @llvm.genx.GenISA.resinfoptr.p393216f32(float addrspace(393216)* [[BINDLESS_IMG1]], i32 0)
-; CHECK-NEXT:    [[TMP5:%.*]] = extractelement <4 x i32> [[TMP4]], i32 1
-; CHECK-NEXT:    [[VECINIT_I_I_I:%.*]] = insertelement <2 x i32> undef, i32 [[TMP3]], i64 0
-; CHECK-NEXT:    [[VECINIT2_I_I_I:%.*]] = insertelement <2 x i32> [[VECINIT_I_I_I]], i32 [[TMP5]], i64 1
-  %call.i.i.i = call spir_func i32 @__builtin_IB_get_image_width(i32 %1)
-  %call1.i.i.i = call spir_func i32 @__builtin_IB_get_image_height(i32 %1)
-  %vecinit.i.i.i = insertelement <2 x i32> undef, i32 %call.i.i.i, i64 0
-  %vecinit2.i.i.i = insertelement <2 x i32> %vecinit.i.i.i, i32 %call1.i.i.i, i64 1
+; CHECK-NEXT:    [[TMP2:%.*]] = call <4 x i32> @llvm.genx.GenISA.resinfoptr.p393216f32(float addrspace(393216)* [[BINDLESS_IMG1]], i32 0)
+; CHECK-NEXT:    extractelement <4 x i32> [[TMP2]], i32 1
+; CHECK-NEXT:    [[BINDLESS_IMG2:%.*]] = addrspacecast [[SPIRV_IMAGE__VOID_1_0_0_0_0_0_0]] addrspace(1)* [[IMG]] to float addrspace(393216)*
+; CHECK-NEXT:    [[TMP3:%.*]] = call <4 x i32> @llvm.genx.GenISA.resinfoptr.p393216f32(float addrspace(393216)* [[BINDLESS_IMG2]], i32 0)
+; CHECK-NEXT:    extractelement <4 x i32> [[TMP3]], i32 2
+  %call = call spir_func i32 @__builtin_IB_get_image_width(i32 %1)
+  %call1 = call spir_func i32 @__builtin_IB_get_image_height(i32 %1)
+  %call2 = call spir_func i32 @__builtin_IB_get_image_depth(i32 %1)
   ret void
 }
 
 declare spir_func i32 @__builtin_IB_get_image_width(i32)
 declare spir_func i32 @__builtin_IB_get_image_height(i32)
+declare spir_func i32 @__builtin_IB_get_image_depth(i32)
 
 !igc.functions = !{!0}
 !IGCMetadata = !{!3}

IGC/Compiler/tests/OCLBIConverter/get_image_prop_neg.ll

@@ -16,17 +16,18 @@
 define spir_kernel void @kernel(%spirv.Image._void_1_0_0_0_0_0_0 addrspace(1)* %img) {
   %data = ptrtoint %spirv.Image._void_1_0_0_0_0_0_0 addrspace(1)* %img to i64
   %1 = trunc i64 %data to i32
-; CHECK:    [[CALL_I_I_I:%.*]] = call spir_func i32 @__builtin_IB_get_image_width(i32 [[TMP1:%.*]])
-; CHECK-NEXT:    [[CALL1_I_I_I:%.*]] = call spir_func i32 @__builtin_IB_get_image_height(i32 [[TMP1]])
-  %call.i.i.i = call spir_func i32 @__builtin_IB_get_image_width(i32 %1)
-  %call1.i.i.i = call spir_func i32 @__builtin_IB_get_image_height(i32 %1)
-  %vecinit.i.i.i = insertelement <2 x i32> undef, i32 %call.i.i.i, i64 0
-  %vecinit2.i.i.i = insertelement <2 x i32> %vecinit.i.i.i, i32 %call1.i.i.i, i64 1
+; CHECK:      call spir_func i32 @__builtin_IB_get_image_width(i32 [[TMP1:%.*]])
+; CHECK-NEXT: call spir_func i32 @__builtin_IB_get_image_height(i32 [[TMP1]])
+; CHECK-NEXT: call spir_func i32 @__builtin_IB_get_image_depth(i32 [[TMP1]])
+  %call = call spir_func i32 @__builtin_IB_get_image_width(i32 %1)
+  %call1 = call spir_func i32 @__builtin_IB_get_image_height(i32 %1)
+  %call2 = call spir_func i32 @__builtin_IB_get_image_depth(i32 %1)
   ret void
 }
 
 declare spir_func i32 @__builtin_IB_get_image_width(i32)
 declare spir_func i32 @__builtin_IB_get_image_height(i32)
+declare spir_func i32 @__builtin_IB_get_image_depth(i32)
 
 !igc.functions = !{!0}
 !IGCMetadata = !{!3}