<table border="1" cellspacing="0" cellpadding="8">
    <tr>
        <th>Issue</th>
        <td>
            <a href=https://github.com/llvm/llvm-project/issues/99140>99140</a>
        </td>
    </tr>

    <tr>
        <th>Summary</th>
        <td>
            Implement the `printf` HLSL Function
        </td>
    </tr>

    <tr>
      <th>Labels</th>
      <td>
            metabug,
            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 `printf` clang builtin,
- [ ] Link `printf` clang builtin with `hlsl_intrinsics.h`
- [ ] Add sema checks for `printf` to `CheckHLSLBuiltinFunctionCall` in `SemaChecking.cpp`
- [ ] Add codegen for `printf` to `EmitHLSLBuiltinExpr` in `CGBuiltin.cpp`
- [ ] Add codegen tests to `clang/test/CodeGenHLSL/builtins/printf.hlsl`
- [ ] Add sema tests to `clang/test/SemaHLSL/BuiltIns/printf-errors.hlsl`
- [ ] Create the `int_spv_printf` intrinsic in `IntrinsicsSPIRV.td`
- [ ] In SPIRVInstructionSelector.cpp create the `printf` lowering and map  it to `int_spv_printf` in `SPIRVInstructionSelector::selectIntrinsic`.
- [ ] Create SPIR-V backend test case in `llvm/test/CodeGen/SPIRV/hlsl-intrinsics/printf.ll`

## DirectX

There is no support for `printf` when targeting DirectX.

## SPIR-V

See "Using Debug Printf in HLSL Shaders" in https://vulkan.lunarg.com/doc/sdk/1.3.283.0/windows/debug_printf.html

## Test Case(s)

 
 ### Example 1
```hlsl
//dxc printf_test.hlsl -T lib_6_8 -enable-16bit-types -O0

export void fn(string p1) {
    return printf(p1);
}
```
## HLSL:

Submits a custom shader message to the information queue.

## Syntax

``` syntax
void printf(
   string format,
    argument ...
);
```

## Parameters

<dl> <dt>

*format* 
</dt> <dd>

The format string.

</dd> <dt>

*argument ...* 
</dt> <dd>

Optional arguments.

</dd> </dl>

## Return value

This function does not return a value.

## Remarks

This operation does nothing on devices that do not support it.

### Minimum Shader Model

This function is supported in the following shader models.



| Shader Model                                                        | Supported |
|---------------------------------------------------------------------|-----------|
| [Shader Model 4 (DirectX HLSL) or later.](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src//direct3dhlsl/dx-graphics-hlsl-sm3.md) | yes       |



 

## 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/eJzEVltv27gS_jX0y0CCTPn64AfHiXsCtGjR5BTnLaDFscQTitSSVC776xdDXRw3bgosFthAASxy9H0z31xI4b0qDeKGza_Y_Hoi2lBZtzkK96c1enKw8nWTAJtfAZtfw23daKzRBGCLrHHKhCNbZFBoYUo4tEoHZRjfsWx7-uazMo8fmMOzChXtV9rrB2WCU8arwqcVW2RnQFspwWMtoKiwePRwtO4cN1h639Hufz7ffb7qCPatKYKyZie0JitlyOoOaxEtlSnTomkukRVWYonmV0Q3tQpveG5eGnfC333ql38HHtAH3yNGYRjf0xrj-52V-AkNcTC-7_XyjO87T1JS7JcifYBLsfeg0cnbN6AJOmedv4i9cygCQqiQQJUJD755ejjJMiav1-B2TObdt9vvP9Igf0a8NRC3bo0Pro1pukONRbCOdIPijPHEpO0zOmVKEEZCLRoAFfpYL7kVE_4LHpZvWb718W10mC2y9FLoBJL8gIMoHtHIqDEUwmPPofVT_S59JDhxM74nUZNTiZ8yqXut6eE54zlcK4dF-F-3dl-hQ1AejAXfNo114X1RPldUTcKVGEiZHiA9Q-3875buEIFx_l8frfHQlvAtglEwVB5wVwmJzjPOaakKofGkFt8zvn9q9aMwqW6NcGVaWIpb2oLxvZePjO-naZ7yVZ5mjO-flZH2mcKVRPMwlG-o9Zl39yTnTnhkfOUZX3ebEP-jBRndvAgaQjCl3UXWPbFas941-VJAR_FAmYilDMk9aHV4WDysIEEjDhqT6eKgQhJeG_SQfO3lx5eo7pNVEo6GHAmx0Jop42tgyyvyBgAchtaZnofxVdxnOW2z5fVb307xxZ7Lt7387aFWwYOAovXB1uCj2lCj96JEqmYqe2WO1tWCKhb-aLHFnxL6aoJ46ZcGRvDDagxj9DG6znacbbM-qg67m9jDFghXtnHGp2kkG-N6G9HowTfhRI2B6qRbzndSs_wG6Edg-c1gvR3IYkZZvqNUhcFSjpb3FfZ-QedlOgLTF_Ii9pnPv2P42pCcQo-R-ssU9Fu_YYnxfu8S_yR0i4PDysOxP2VAWqQ-DUOFiM40_QmkFu7Rv_neNujEGUBFCaJ3fFIFegiVCCBtxB6GgApnuAT9RRlVt3XfvPDFStSX_FR-QEFJ7R2i7FrbZ-IdipG-HtXpnuXuDBv-5l_EGR1gy12HnfwTf-c4IzZN8zPXZ8D4qh-UXXfyNVgHWgR0KZtfM746H3ulClV76OfdF1U46-0xXNs4zJ-VyTmd1NoeunHYzTz_GGyTeFf08ykS5jIOLRpXSelEU6nCJ_GA8HWe1rIbNzt4RX9S7CwRsVvPpwEiCO3tx504vxrPORguR_7fCnY8DZOhMn0X_PsOHtpxIje5XOdrMcHNdMmn00XG59mk2uTFcp1luZQrma8LkctpsZzhOpvz6WF9nE8nasMzPsuW0wXPslm2SrMMF9l6xUU2k3mBczbLsBZKp3SSp9aVE-V9i5v1ejrLJlocUPt4U-a8xiAObck4p_HJeVc-_Ut_QWD5tj9xxw0bWL4dbOfXE7chquTQlp7NMq188CfyoILGzenS_e4eFI_pIYeT1unNBxnsbyeRr3H2_1jQLSUGSKnrYnza8L8CAAD__ydNoFY">