Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement the InterlockedMin HLSL Function #99123

Open
12 tasks
Tracked by #99235
farzonl opened this issue Jul 16, 2024 · 0 comments
Open
12 tasks
Tracked by #99235

Implement the InterlockedMin HLSL Function #99123

farzonl opened this issue Jul 16, 2024 · 0 comments
Labels
backend:DirectX backend:SPIR-V bot:HLSL HLSL HLSL Language Support metabug Issue to collect references to a group of similar or related issues.

Comments

@farzonl
Copy link
Member

farzonl commented Jul 16, 2024

  • Implement InterlockedMin clang builtin,
  • Link InterlockedMin clang builtin with hlsl_intrinsics.h
  • Add sema checks for InterlockedMin to CheckHLSLBuiltinFunctionCall in SemaChecking.cpp
  • Add codegen for InterlockedMin to EmitHLSLBuiltinExpr in CGBuiltin.cpp
  • Add codegen tests to clang/test/CodeGenHLSL/builtins/InterlockedMin.hlsl
  • Add sema tests to clang/test/SemaHLSL/BuiltIns/InterlockedMin-errors.hlsl
  • Create the int_dx_InterlockedMin intrinsic in IntrinsicsDirectX.td
  • Create the DXILOpMapping of int_dx_InterlockedMin to 160 in DXIL.td
  • Create the InterlockedMin.ll and InterlockedMin_errors.ll tests in llvm/test/CodeGen/DirectX/
  • Create the int_spv_InterlockedMin intrinsic in IntrinsicsSPIRV.td
  • In SPIRVInstructionSelector.cpp create the InterlockedMin lowering and map it to int_spv_InterlockedMin in SPIRVInstructionSelector::selectIntrinsic.
  • Create SPIR-V backend test case in llvm/test/CodeGen/SPIRV/hlsl-intrinsics/InterlockedMin.ll

DirectX

DXIL Opcode DXIL OpName Shader Model Shader Stages
160 CreateHandleForLib 6.3 ()

SPIR-V

OpAtomicSMin:

Description:

Perform the following steps atomically with respect to any other atomic
accesses within Scope to the same location:

  1. load through Pointer to get an Original Value,
  2. get a New Value by finding the smallest signed integer of Original
    Value
    and Value, and
  3. store the New Value back through Pointer.

The instruction’s result is the Original Value.

Result Type must be an integer type scalar.

The type of Value must be the same as Result Type. The type of the
value pointed to by Pointer must be the same as Result Type.

Memory is a memory Scope.

Word Count Opcode Results Operands

7

236

<id>
Result Type

Result <id>

<id>
Pointer

Scope <id>
Memory

Memory Semantics <id>
Semantics

<id>
Value

Test Case(s)

Example 1

//dxc InterlockedMin_test.hlsl -T lib_6_8 -enable-16bit-types -O0

RWStructuredBuffer<int64_t> buffer : register(u0);
[numthreads(1, 1, 1)]
export void fn(uint3 dispatchThreadID : SV_DispatchThreadID, int64_t p1) {
int index = dispatchThreadID.x;
    return InterlockedMin(buffer[index], p1);
}

Example 2

//dxc InterlockedMin_1_test.hlsl -T lib_6_8 -enable-16bit-types -O0

RWStructuredBuffer<int64_t> buffer : register(u0);
[numthreads(1, 1, 1)]
export void fn(uint3 dispatchThreadID : SV_DispatchThreadID, int64_t p1, int64_t p2) {
int index = dispatchThreadID.x;
    return InterlockedMin(buffer[index], p1, p2);
}

Example 3

//dxc InterlockedMin_2_test.hlsl -T lib_6_8 -enable-16bit-types -O0

RWStructuredBuffer<int> buffer : register(u0);
[numthreads(1, 1, 1)]
export void fn(uint3 dispatchThreadID : SV_DispatchThreadID, int p1) {
int index = dispatchThreadID.x;
    return InterlockedMin(buffer[index], p1);
}

Example 4

//dxc InterlockedMin_3_test.hlsl -T lib_6_8 -enable-16bit-types -O0

RWStructuredBuffer<int> buffer : register(u0);
[numthreads(1, 1, 1)]
export void fn(uint3 dispatchThreadID : SV_DispatchThreadID, int p1, int p2) {
int index = dispatchThreadID.x;
    return InterlockedMin(buffer[index], p1, p2);
}

HLSL:

Performs a guaranteed atomic min.

Syntax

void InterlockedMin(
  in  R dest,
  in  T value,
  out T original_value
);

Parameters

dest [in]

Type: R

The destination address.

value [in]

Type: T

The input value.

original_value [out]

Type: T

Optional. The original input value.

Return value

This function does not return a value.

Remarks

This operation can only be performed on int and uint typed resources and shared memory variables. There are two possible uses for this function. The first is when R is a shared memory variable type. In this case, the function performs an atomic min of value to the shared memory register referenced by dest. The second scenario is when R is a resource variable type. In this scenario, the function performs an atomic min of value to the resource location referenced by dest. The overloaded function has an additional output variable which will be set to the original value of dest. This overloaded operation is only available when R is readable and writable.

Interlocked operations do not imply any memory fence/barrier.

Minimum Shader Model

This function is supported in the following shader models.

Shader Model Supported
Shader Model 5 and higher shader models yes

 

This function is supported in the following types of shaders:

Vertex Hull Domain Geometry Pixel Compute
x x x x x x

 

See also

Intrinsic Functions

Shader Model 5

@farzonl farzonl added backend:DirectX backend:SPIR-V bot:HLSL HLSL HLSL Language Support metabug Issue to collect references to a group of similar or related issues. labels Jul 16, 2024
@damyanp damyanp moved this to Ready in HLSL Support Oct 30, 2024
@damyanp damyanp moved this from Ready to Planning in HLSL Support Oct 30, 2024
@farzonl farzonl moved this from Planning to Designing in HLSL Support Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend:DirectX backend:SPIR-V bot:HLSL HLSL HLSL Language Support metabug Issue to collect references to a group of similar or related issues.
Projects
Status: Designing
Development

No branches or pull requests

1 participant