<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Issue</th>
<td>
<a href=https://github.com/llvm/llvm-project/issues/99179>99179</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>
Implement the `ReportHit` 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 `ReportHit` clang builtin,
- [ ] Link `ReportHit` clang builtin with `hlsl_intrinsics.h`
- [ ] Add sema checks for `ReportHit` to `CheckHLSLBuiltinFunctionCall` in `SemaChecking.cpp`
- [ ] Add codegen for `ReportHit` to `EmitHLSLBuiltinExpr` in `CGBuiltin.cpp`
- [ ] Add codegen tests to `clang/test/CodeGenHLSL/builtins/ReportHit.hlsl`
- [ ] Add sema tests to `clang/test/SemaHLSL/BuiltIns/ReportHit-errors.hlsl`
- [ ] Create the `int_dx_ReportHit` intrinsic in `IntrinsicsDirectX.td`
- [ ] Create the `DXILOpMapping` of `int_dx_ReportHit` to `158` in `DXIL.td`
- [ ] Create the `ReportHit.ll` and `ReportHit_errors.ll` tests in `llvm/test/CodeGen/DirectX/`
- [ ] Create the `int_spv_ReportHit` intrinsic in `IntrinsicsSPIRV.td`
- [ ] In SPIRVInstructionSelector.cpp create the `ReportHit` lowering and map it to `int_spv_ReportHit` in `SPIRVInstructionSelector::selectIntrinsic`.
- [ ] Create SPIR-V backend test case in `llvm/test/CodeGen/SPIRV/hlsl-intrinsics/ReportHit.ll`
## DirectX
| DXIL Opcode | DXIL OpName | Shader Model | Shader Stages |
| ----------- | ----------- | ------------ | ------------- |
| 158 | ReportHit | 6.3 | ('library', 'intersection') |
## SPIR-V
# [OpReportIntersectionKHR](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#OpReportIntersectionKHR):
## Description:
(OpReportIntersectionNV)**
Reserved.
[Capability](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#Capability):
**RayTracingNV**, **RayTracingKHR**
[Reserved](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#Unified).
<table style="width:100%;">
<colgroup>
<col style="width: 16%" />
<col style="width: 16%" />
<col style="width: 16%" />
<col style="width: 16%" />
<col style="width: 16%" />
<col style="width: 16%" />
</colgroup>
<thead>
<tr>
<th>Word Count</th>
<th>Opcode</th>
<th>Results</th>
<th>Operands</th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p>5</p></td>
<td class="tableblock halign-left valign-top"><p>5334</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>Hit</em></p></td>
<td
class="tableblock halign-left valign-top"><p><em><id></em><br />
<em>HitKind</em></p></td>
</tr>
</tbody>
</table>
## Test Case(s)
### Example 1
```hlsl
//dxc ReportHit_test.hlsl -T lib_6_8 -enable-16bit-types -O0
struct RayPayload
{
float4 color;
float distance;
};
export bool fn(float p1, uint p2, RayPayload p3) {
return ReportHit(p1, p2, p3);
}
```
## HLSL:
Called by an [intersection shader](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/intersection-shader.md) to report a ray intersection.
## Syntax
This intrinsic function definition is equivalent to the following function template:
```
template<attr_t>
bool ReportHit(float THit, uint HitKind, attr_t Attributes);
```
## Parameters
`THit`
A float value specifying the parametric distance of the intersection..
`HitKind`
An unsigned integer that identifies the type of hit that occurred. This is a user-specified value in the range of 0-127. The value can be read by [any hit](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/any-hit-shader.md) or [closest hit](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/closest-hit-shader.md) shaders with the **HitKind** intrinsic.
`Attributes`
The user-defined [**Intersection Attribute Structure**](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/intersection-attributes.md) structure specifying the intersection attributes.
## Return Value
**bool** True if the hit was accepted. A hit is rejected if *THit* is outside the current ray interval, or the any hit shader calls [**IgnoreHit**](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/ignorehit-function.md). The current ray interval is defined by **RayTMin** and **RayTCurrent**.
## Remarks
This function can be called from the following raytracing shader types:
* [**Intersection Shader**](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/intersection-shader.md)
## See also
<dl> <dt>
[Direct3D 12 Raytracing HLSL Reference](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/direct3d-12-raytracing-hlsl-reference.md)
</dt> </dl>
</pre>
<img width="1px" height="1px" alt="" src="http://email.email.llvm.org/o/eJzkOc1y2zjSTwNfUGRRYPR30EGWrIlrkknK9pdvbi6QaElYQwAXAG1rn36rAVIkY9lObW2Sw05pKkQ3-r8b6Ia5c3KnARZkfEnG6wte-72xiy23_zJaXRRGHBcJJeNLSsZren2oFBxAe0om2Q1UxvqP0pNJRkvF9Y4WtVReasJWJFt2ZJ-kfnibgj5Jv8cte-XUvdTeSu1k6dI9mWQDXkshqIMDp-UeygdHt8a-YO0Ngla44eOn20-XUcam1qWXRq-4UrhLatx1Cwcedkq9S8uqOievNAJ2oN-QdXWQvifq6rmynYjVHw34Pf4enHcNx-AewjYII2yzMgL-AI0yCNs0XnOEbU7KpOi6V731Bmv0QMM36Hk95JuAtca6s-xXFrgH6veAfKX29-L5fuCeUygbX1yfQruWFkr_d-rF21zXf19_-lJ95lUl9Q5Zmu1rwryhiBqNZ53zkfxtGYOQpjE3uBYD8H3jhIiNzoz8lXo8vAgTYZvGPMI27zvNVY8_6rXbr9c3387Yc61pQF1r520d8vwWFJTeWMw6Wg6EDoQp8wRW6l0w-sArSqVvMuUV5ULdvCKN5EuSL11YndQmkyw95wNkknyjBS8fQIvgV1pyB-_4NsgmbIMpmXSHxaAaVJOs-GM5YTltIxJh0xXF1KBfKqw-2lv_xQ9xfbvnAiz9bASoPuDW8x04hDSMku4_-s76JSDpMRqNZwF_MiOsJmke_iVsRthUycJyeyRsShjCplJ7sA5CFAJ03nI8mR79fAJhGL5UUch1j_rPjzdkvCZstve-chhJtiFsY2EnnbfH9GFvjTYuNXbXRCHBMLgKgvNrLbcSxKiNULr3B0VY_pooNkcRgxCBK62sgiURxWbnqP_6hsRsSdiSUpIt8f8bcGAfQaQNx_Hlile8kEr648-wqsc9GEKDuvi74cc7y0upd6hnBGKkhrjggYEFZHzZGvEzFP6_CCds3rooX3leKKDOHxWQfE0Ye5LC70m-HGUZYWOSXxLGSH4Vd5dG7aypqz7gHDEdTZCYMYqa_89sJmzzwkN-D1x0K9tDkPzq_40VdGVq7SN5APbw8XA6j7sBVyvvXiMEy7V4BfuDUFzZwWpoDDaHZ00T2Nw5F30WUqxQpnyge67kTicKtp4-xm9vqibD8hV6bRwlVZ0-4r_DN88_vMmaZMv_mDnJV3DAf9lEeZJfSkHYZIdfUVBE5qvCDvIlgGMY6d2xguHmn-EFkq84yZZ7C9tITlgeFbgWp419td6ziLANf0_d3-VZbFd-0KO_UcU_pRY_pubLchwUIAJQ8QaQDW_WO2ytVtwBYTOHF1ZAxpsn7MBNV88cBzw6Quwki7_Q92fNHSSey645ucfGLMwFNLmjShb3k_sZTUCjGsloUkif-GMFjiZfmlYstov0hh-_8qMyXITG5zIg51tluP9AS6OwjewDqZDOc11CA56u4wc8oyq0MEbRrSZsFndXI7xwa6k9rRh-dvJolccGCckppdSCr63ujCJsFskjZdjeSe35pfNtGJ7aTganSxC0OFKusc_qd2fUhQby3OW-k35fF2lpsOH9LEtrnNn6tQk3-pPUOcOxT5kCgxChAtyDN1XibNkEJzS4uQgRY5u-5CRKTg94_WNzb4O9lFPLj7S_Mx02jkft-TPJlnd76XpjybaZpamArdQyfEpH4Z-1fOQKdBggcNjYGqXME04XJxIPh0pxD13z13Nph1xx7-29j-kcItyPUQz0XVg0oW6Lia1oJKVL760sag-uC2I_fN_VyFdu-QHQFSe97uLME9dLGqU-clUDxXZLbo9oGhpaRWIry1Oy4qSKqIF70xPvVt8Te01rHV5jRCDZgaV-zz2VArTH3s0FdlhSyHqPYxriTVnW1oJIKY1hcpTT2oFNoo4SRKOz1IGD5XoXWGTJiE0DGTQ7Sq5pAdQCDzlMxpdcH1HUL0paro_JXvphvhqLipTKODzFfp0yjcSXCsWFi69WYaYOnfwpA0Nbf6qWLuS9hGyjjq4PsQqVBAItjQz6A0-XyvQ2HKG1hWa0-A2HCT-Z0fqj1en7qhicfj2yMPN0lXcTD-FvmIItAn9Y9o037yzmbywozPwn7igvS6h8SPxlAEpHLfwDSo8ltMWoxBNiiRhTeydFfAMJBaN9d_o9coUHh7EB3eR8E2dacqVcLzA7bSxExr8wAkEqpmJ7kkbnp6F6zxmERrdZhbV8GkA_S914NbxzneCryCQC0u8idOD2wbU5K113njdHRhkvvq01h-9OfsuPPs68rUNDV9Ab_pevZH18cPl9id4v-sGFMbgjAShXzpyGaqFIfkXxw3fN2Pgyvj_lazpi2JC0LsHugd7AFixgg_NrrGyXyYglXXiS8KBmW106u0N3GayhzTeaeCEWuZjnc34Bi9GUjUaTbDwdX-wXUwHlFooyH014MeV8yrNsCtl8W85EzraTC7lgGfuQTUcTlmXzfJyWLJvDFGZFlrEZm2_JhwwOXKpUqcdDauzuQjpXw2I-H03nF4oXoFz4kwVjB_C8qHdhmFkRxprHRJIvT0-wDSY-cr_Y1j6gtAjjSb5s947XF3aBSiRFvXPkQ6ak865Ty0uvYNH9XeTcA2uIcPvXh4vaqsUb8W3ePIPIyho8zDAr0XoMbHTA44L9OwAA__87jdwK">