<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Issue</th>
<td>
<a href=https://github.com/llvm/llvm-project/issues/99204>99204</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>
Implement the `CheckAccessFullyMapped` HLSL Function
</td>
</tr>
<tr>
<th>Labels</th>
<td>
metabug,
backend:DirectX,
HLSL,
backend:SPIR-V,
bot:HLSL
</td>
</tr>
<tr>
<th>Assignees</th>
<td>
</td>
</tr>
<tr>
<th>Reporter</th>
<td>
farzonl
</td>
</tr>
</table>
<pre>
- [ ] Implement `CheckAccessFullyMapped` clang builtin,
- [ ] Link `CheckAccessFullyMapped` clang builtin with `hlsl_intrinsics.h`
- [ ] Add sema checks for `CheckAccessFullyMapped` to `CheckHLSLBuiltinFunctionCall` in `SemaChecking.cpp`
- [ ] Add codegen for `CheckAccessFullyMapped` to `EmitHLSLBuiltinExpr` in `CGBuiltin.cpp`
- [ ] Add codegen tests to `clang/test/CodeGenHLSL/builtins/CheckAccessFullyMapped.hlsl`
- [ ] Add sema tests to `clang/test/SemaHLSL/BuiltIns/CheckAccessFullyMapped-errors.hlsl`
- [ ] Create the `int_dx_CheckAccessFullyMapped` intrinsic in `IntrinsicsDirectX.td`
- [ ] Create the `DXILOpMapping` of `int_dx_CheckAccessFullyMapped` to `71` in `DXIL.td`
- [ ] Create the `CheckAccessFullyMapped.ll` and `CheckAccessFullyMapped_errors.ll` tests in `llvm/test/CodeGen/DirectX/`
- [ ] Create the `int_spv_CheckAccessFullyMapped` intrinsic in `IntrinsicsSPIRV.td`
- [ ] In SPIRVInstructionSelector.cpp create the `CheckAccessFullyMapped` lowering and map it to `int_spv_CheckAccessFullyMapped` in `SPIRVInstructionSelector::selectIntrinsic`.
- [ ] Create SPIR-V backend test case in `llvm/test/CodeGen/SPIRV/hlsl-intrinsics/CheckAccessFullyMapped.ll`
## DirectX
| DXIL Opcode | DXIL OpName | Shader Model | Shader Stages |
| ----------- | ----------- | ------------ | ------------- |
| 71 | CheckAccessFullyMapped | 6.0 | () |
## SPIR-V
# [OpImageSparseTexelsResident](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#OpImageSparseTexelsResident):
## Description:
Translates a *Resident Code* into a Boolean. Result is **false** if any
of the texels were in uncommitted texture memory, and **true**
otherwise.
*Result Type* must be a [*Boolean type*](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#Boolean) scalar.
*Resident Code* is a value from an **OpImageSparse…** instruction that
results in a resident code.
[Capability](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#Capability):
**SparseResidency**
<table>
<colgroup>
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 20%" />
<col style="width: 20%" />
</colgroup>
<thead>
<tr>
<th>Word Count</th>
<th>Opcode</th>
<th>Results</th>
<th>Operands</th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p>4</p></td>
<td class="tableblock halign-left valign-top"><p>316</p></td>
<td
class="tableblock halign-left valign-top"><p><em><id></em><br />
<em>Result Type</em></p></td>
<td class="tableblock halign-left valign-top"><p><a
href="#ResultId"><em>Result <id></em></a></p></td>
<td
class="tableblock halign-left valign-top"><p><em><id></em><br />
<em>Resident Code</em></p></td>
</tr>
</tbody>
</table>
## Test Case(s)
### Example 1
```hlsl
//dxc CheckAccessFullyMapped_test.hlsl -T lib_6_8 -enable-16bit-types -O0
RWBuffer<float4> g_buffer;
[numthreads(1, 1, 1)]
[shader("pixel")]
bool fn( ) : SV_Target {
uint p1;
float4 data = g_buffer.Load(0, p1);
return CheckAccessFullyMapped(p1);
}
```
## HLSL:
Determines whether all values from a **Sample**, **Gather**, or **Load** operation accessed mapped tiles in a [tiled resource](/windows/desktop/direct3d11/direct3d-11-2-features).
## Syntax
``` syntax
bool CheckAccessFullyMapped(
in uint_only status
);
```
## Parameters
<dl> <dt>
*status* \[in\]
</dt> <dd>
Type: **uint\_only**
The status value that is returned from a **Sample**, **Gather**, or **Load** operation. Because you can't access this status value directly, you need to pass it to **CheckAccessFullyMapped**.
</dd> </dl>
## Return value
Type: **bool**
Returns a **Boolean** value that indicates whether all values from a **Sample**, **Gather**, or **Load** operation accessed mapped tiles in a [tiled resource](/windows/desktop/direct3d11/direct3d-11-2-features). Returns **TRUE** if all values from the operation accessed mapped tiles; otherwise, returns **FALSE** if any values were taken from an unmapped tile.
## Remarks
### Minimum Shader Model
This function is supported in the following shader models.
| Shader Model | Supported |
|-----------------------------------------------------------------------------|-----------|
| [Shader Model 5](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/d3d11-graphics-reference-sm5.md) and higher shader models | yes |
This function is supported in the following types of shaders:
| Vertex | Hull | Domain | Geometry | Pixel | Compute |
|--------|------|--------|----------|-------|---------|
| | | | | x | x |
## See also
<dl> <dt>
[Intrinsic Functions](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/dx-graphics-hlsl-intrinsic-functions.md)
</dt> </dl>
</pre>
<img width="1px" height="1px" alt="" src="http://email.email.llvm.org/o/eJzcWVFz4ygS_jXkhbJKRpFjP_hBtuPZVGVutpLc7L6lsNS2uCBQAZrE9-uvGiRZmsTJ7N7OXd25XDE00N183dDdhFsrDgpgSdIVSTcXvHGlNss9N__USl7sdHFcTihJV5SkG3pT1RIqUI6SWbwuIX_K8hys3TZSHj_zuoaCzGKaS64OdNcI6YQibE3i7MTjVqinP7CcPgtX4vxSWvkolDNCWZHbqCSzeMQ4KwpqoeI0R86W7rV5X47T_fgvt_e3qyBw26jcCa3WXEqcJRTOuoeK-5lCHaK8rt8SnusCDqB-VPB1JdxA7vVLbU7y1p9a8kfCHFhnW44eOMK2SCNsu9YFfAKFMgjbtnhaHHhTswgRPgvqO3IQm1aIV_rmHSETMEYb-6astQHugLoSUIhQ7rF4eTyPYu8LLWQ3vW9shIHc_R654n0Rm99vbr_UyFGoA7LU-x-S7DTFeVfTk72Q1fvyzrtEFByNq-L8nMcWtzA1GCNIlvJb9crmhG1bEAjbfoyzrb_9KaDvf725-_rGtm8U9UM3yjrT-ON0DxJypw36M81HGpyXLPUzGKEOHpuK15QK1_rgj6jtD-4ZPUiSkSSzvtdviMzi6C2okMnkK93x_AlU4eGnObfwgQm8bMK26OyT09V1_gTK9kzglyWEJbSzYqBdrSk6Gv1S4_Gng_7feBX69yUvwNDPugA5JNw7fgCLlJbR5PShH_RfEyYDRldTP_z2lvzQLIr9L2Fzwhbd0n6PAd2ehOB_qW8qfoD7mhsLD_AC0t6BFQUoR9INYfPSudqiDdmWsK2Bg7DOHKOn0milbaTNocV_ggawNXjYGyX2AoppZ5uodJUkLHlPHFugmJFNwOZG1OhNYYhSEmcPhisruQNLOSUs6xhQ9AfCMjxGmnK60loCVxG9A9tIR4XF2YRley4thCYVe8rVkcSZ3vtT4rxO9BmM97lG5bqqhHOAzvjiGgO0gkqbI2HrcJF4Ps40LUdk5Uowz8JC5PX1f4KeqMbDsfZaVo11dAe4h3RFWNaqS10Y_xnotyLQNWzOJTevFPwOSET4G5cN0L3RFeWq3e7IjOSakXlMslnbmK86bE-XAXUldyTOjMfA36icmk4enrGotXy6WvOa74QU7vgzMBhw9w7XbZ6wLGynRSE_9vbEb7J2fCeBJNehl2t5MLqphwRq3RGnbAhjz6JwJbJnMWEpYYyi-v_Lkwnbvtq0K4EXp54ZDJDk-jdtCrrWjXJhuScOxsPl-vZYOCz23EIwXBVnRl9RsWdGvbHamHu_uYkCM2RrAzre_jup8ydacikOaiJh7_B4YNvpmjAWpCM-l0FSfdKn-Ev4JtPZu5xJnP1p3iRZQ4W_bCYdSVaiIGx2wFYQFAaT9c6MHMOTh5fbaPLPAIEka07irDSwD8sJS4ICN0U_cajWRzsibMs_Uve_iOzgVv4hbF87_MjFkTC4zOJx0H3AnGvNMULOLd6RftDHiTADJ12_cKxQ6RRHZ3H4-lIjbu_p4iU_k6k8Yvrm6xI6eaBS7B5nj3M6AYU6TaaznXATDIKWTr60Odrdb6tmvwdDkvVeau4uSXJND4-7lrjqY4dqKlca4IUlbD7FGN39WWAw8XOsz9N8isRq8QLSO1A7vtNa0r0ibE59BpVk9P7r4wM3B3CUXAVJi0YoR-tpJ3kRlKIFd5ySZNOrFt1qXhA2j1GJ2mvRLTHgGqPOQETYfDj7ajOE-WQqXwt2OdMGHJhKKLD0uQRMQSiXMoRv28bvNnzfe-O18Y2tW-onjotOVCyufSdswod0jTevD-jc6wy-WsD00wkJbVwn6Qp7BQZ43ZgcQhwnbPssVKGfMTwXYJ_8KdkWPvFOiul00JlMpxM22QPHjAu9MBonskfl-EtL6nChtqN6I55F1mc8QpE1I1mMlnzUSh6pddw11svocB8i3sv-lRteIda2Tw0Kif6IDXc6UyxrObKMknRN0pVQ_nfTn0I_3a8r-nXhBs1a6FE9kq69hsN85KGEVuE2P8P8CvO14FZQ_OUGj-gKct5YoEfd0ByzyCvXegF1pbBjfYIhpU-TcYEC9BFNa25tV1t6CefMhGNRjzCCVbRgYVsOcPZWuQvHyQt_C0h0iSGAYb7tEepTY7_rIaaqELkvNv4fTxXtcAiaPNz9_XpQGH23UayPPlCVJCvalz-4XTPiv81u769HlVcnwBdcjj-B6kuNRg04R99Zu-LmyQ5pSP4slKiaalSad-dFWLpvHxzxnNimrrXBsk4ov7G9llI_C3WgIT7QClfbaBQhvy_7_82P59cr0hf6k7_yM-Z3ekwg6Wq0lfStYusgXNnsolxXhG0_i9xoq_duo32F9SxUwgjb7qTeoZMFauuCE2vyNhFonc9nB2xboE9ODobXpcjtxMAeDKgcJrZKo6rAoItldSkOeNZGtvB4HcGe0BsZx9_nf9zcIdXQ-1aWPT1C9Db_CsbBixf_SyPDa89GV1wo3_wEugJnjr7zK2YU4Z1GV3Xj4LVd--ZbtHFnSD7ZbuA-48aoGTov37Xexa0LrwCUS6vfD3Dpqn_Oo91bvv1PedHLyYXGj36Tzuw2eNPrYNvFj4timRSLZMEvYDm9YtPpLJ6z2UW53CXzXbLg-6t0nk_zRZGk-0sOcZGzJN7Hi_xCLFnMLuOr6YzF0-QyjdIin8_SoriM8zzN00tyGUPFhYyk_FZF2hwuhLUNLBcLFl9eSL4Daf0_ghirwPFdc_A56Jow1j59kiTr35XbkfDy_2pa9_LRDWhHkqybm24uzBKVmOyagyWXsRTW2ZNaTjgJy9N_mz58KEbGvbUvGiOX79i6fa718muj_wG5I2zroUAjBzS-Ldm_AgAA___-gBQ7">