Skip to content

Implement the GroupMemoryBarrierWithGroupSync HLSL Function #70103

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

Closed
12 tasks
Tracked by #99235 ...
llvm-beanz opened this issue Oct 24, 2023 · 2 comments · Fixed by #111883, #111884, #111888 or #114349
Closed
12 tasks
Tracked by #99235 ...

Implement the GroupMemoryBarrierWithGroupSync HLSL Function #70103

llvm-beanz opened this issue Oct 24, 2023 · 2 comments · Fixed by #111883, #111884, #111888 or #114349
Assignees
Labels
backend:DirectX HLSL HLSL Language Support

Comments

@llvm-beanz
Copy link
Collaborator

llvm-beanz commented Oct 24, 2023

AC:

  • The intrinsic is implemented
  • Tests validate that it is lowered to LLVM-IR
  • Tests validate that control forms are not hoisted out of control flow
    ** Maps to the correct construct
  • Implement GroupMemoryBarrierWithGroupSync clang builtin,
  • Link GroupMemoryBarrierWithGroupSync clang builtin with hlsl_intrinsics.h
  • Add sema checks for GroupMemoryBarrierWithGroupSync to CheckHLSLBuiltinFunctionCall in SemaChecking.cpp
  • Add codegen for GroupMemoryBarrierWithGroupSync to EmitHLSLBuiltinExpr in CGBuiltin.cpp
  • Add codegen tests to clang/test/CodeGenHLSL/builtins/GroupMemoryBarrierWithGroupSync.hlsl
  • Add sema tests to clang/test/SemaHLSL/BuiltIns/GroupMemoryBarrierWithGroupSync-errors.hlsl
  • Create the int_dx_GroupMemoryBarrierWithGroupSync intrinsic in IntrinsicsDirectX.td
  • Create the DXILOpMapping of int_dx_GroupMemoryBarrierWithGroupSync to 80 in DXIL.td
  • Create the GroupMemoryBarrierWithGroupSync.ll and GroupMemoryBarrierWithGroupSync_errors.ll tests in llvm/test/CodeGen/DirectX/
  • Create the int_spv_GroupMemoryBarrierWithGroupSync intrinsic in IntrinsicsSPIRV.td
  • In SPIRVInstructionSelector.cpp create the GroupMemoryBarrierWithGroupSync lowering and map it to int_spv_GroupMemoryBarrierWithGroupSync in SPIRVInstructionSelector::selectIntrinsic.
  • Create SPIR-V backend test case in llvm/test/CodeGen/SPIRV/hlsl-intrinsics/GroupMemoryBarrierWithGroupSync.ll

DirectX

DXIL Opcode DXIL OpName Shader Model Shader Stages
80 Barrier 6.0 ()

SPIR-V

OpControlBarrier:

Description:

Wait for all active invocations within the specified
Scope to reach the current point of execution.

All active invocations within Execution scope reach
this point of execution before any invocation proceeds beyond it.

When Execution is Workgroup or larger, behavior is undefined
unless all invocations within Execution execute the same dynamic
instance of this instruction.

If Semantics is not None, this instruction also serves as an
OpMemoryBarrier instruction, and also performs
and adheres to the description and semantics of an OpMemoryBarrier
instruction with the same Memory and Semantics operands. This allows
atomically specifying both a control barrier and a memory barrier (that
is, without needing two instructions). If Semantics is None,
Memory is ignored.

Before version 1.3, it is only valid to use this instruction with
TessellationControl, GLCompute, or Kernel execution
models
. There is no such restriction starting with
version 1.3.

If used with the TessellationControl execution
model
, it also implicitly synchronizes the Output
Storage Class: Writes to Output variables
performed by any invocation executed prior to a OpControlBarrier are
visible to any other invocation proceeding beyond that
OpControlBarrier.

Word Count Opcode Results Operands

4

224

Scope <id>
Execution

Scope <id>
Memory

Memory Semantics <id>
Semantics

Test Case(s)

Example 1

//dxc GroupMemoryBarrierWithGroupSync_test.hlsl -T lib_6_8  -enable-16bit-types -spirv -fspv-target-env=universal1.5 -fcgl -O0

export void fn() {
    return GroupMemoryBarrierWithGroupSync();
}

HLSL:

Blocks execution of all threads in a group until all group shared accesses have been completed and all threads in the group have reached this call.

Syntax

void GroupMemoryBarrierWithGroupSync(void);

Parameters

This function has no parameters.

Return value

This function does not return a value.

Remarks

The behavior of calls to this function that are within diverging branches of a thread group are undefined.

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

 

See also

Intrinsic Functions

Shader Model 5

@llvm-beanz llvm-beanz converted this from a draft issue Oct 24, 2023
@llvm-beanz llvm-beanz added the HLSL HLSL Language Support label Oct 24, 2023
@farzonl farzonl changed the title [HLSL] implement GroupMemoryBarrierWithGroupSync intrinsic Implement the GroupMemoryBarrierWithGroupSync HLSL Function Jul 16, 2024
@damyanp
Copy link
Contributor

damyanp commented Oct 4, 2024

Marking re-estimate this. Since this was originally refined, we have a different approach to implementing intrinsics and the way we've been estimating intrinsics has changed quite a bit.

@adam-yang
Copy link
Contributor

I'll be working on this.

@damyanp damyanp moved this to Active in HLSL Support Oct 9, 2024
@adam-yang adam-yang moved this from Active to Needs Review in HLSL Support Oct 14, 2024
@github-project-automation github-project-automation bot moved this from Needs Review to Closed in HLSL Support Oct 29, 2024
adam-yang added a commit that referenced this issue Oct 29, 2024
partially fixes #70103

### Changes
* Added int_spv_group_memory_barrier_with_group_sync intrinsic in
IntrinsicsSPIRV.td
* Added lowering for int_spv_group_memory_barrier_with_group_sync in
SPIRVInstructionSelector.cpp
* Added SPIRV backend test case

### Related PRs
* [[clang][HLSL] Add GroupMemoryBarrierWithGroupSync intrinsic
#111883](#111883)
* [[DXIL] Add GroupMemoryBarrierWithGroupSync intrinsic
#111884](#111884)
@adam-yang adam-yang moved this from Closed to Active in HLSL Support Oct 31, 2024
@adam-yang adam-yang moved this from Active to Needs Review in HLSL Support Oct 31, 2024
@damyanp damyanp reopened this Oct 31, 2024
NoumanAmir657 pushed a commit to NoumanAmir657/llvm-project that referenced this issue Nov 4, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
fixes llvm#112974
partially fixes llvm#70103

### Changes
- Added new tablegen based way of lowering dx intrinsics to DXIL ops.
- Added int_dx_group_memory_barrier_with_group_sync intrinsic in
IntrinsicsDirectX.td
- Added expansion for int_dx_group_memory_barrier_with_group_sync in
DXILIntrinsicExpansion.cpp`
- Added DXIL backend test case

### Related PRs
* [[clang][HLSL] Add GroupMemoryBarrierWithGroupSync intrinsic
llvm#111883](llvm#111883)
* [[SPIRV] Add GroupMemoryBarrierWithGroupSync intrinsic
llvm#111888](llvm#111888)
NoumanAmir657 pushed a commit to NoumanAmir657/llvm-project that referenced this issue Nov 4, 2024
partially fixes llvm#70103

### Changes
* Added int_spv_group_memory_barrier_with_group_sync intrinsic in
IntrinsicsSPIRV.td
* Added lowering for int_spv_group_memory_barrier_with_group_sync in
SPIRVInstructionSelector.cpp
* Added SPIRV backend test case

### Related PRs
* [[clang][HLSL] Add GroupMemoryBarrierWithGroupSync intrinsic
llvm#111883](llvm#111883)
* [[DXIL] Add GroupMemoryBarrierWithGroupSync intrinsic
llvm#111884](llvm#111884)
@github-project-automation github-project-automation bot moved this from Needs Review to Closed in HLSL Support Dec 2, 2024
@damyanp damyanp moved this from Closed to Active in HLSL Support Dec 2, 2024
@damyanp damyanp reopened this Dec 2, 2024
adam-yang added a commit that referenced this issue Dec 3, 2024
partially fixes #70103 

### Changes
* Implemented `GroupMemoryBarrierWithGroupSync` clang builtin
* Linked `GroupMemoryBarrierWithGroupSync` clang builtin with
`hlsl_intrinsics.h`
* Added sema checks for `GroupMemoryBarrierWithGroupSync` to
`CheckHLSLBuiltinFunctionCall` in
`SemaChecking.cpp`
* Add codegen for `GroupMemoryBarrierWithGroupSync` to
`EmitHLSLBuiltinExpr` in `CGBuiltin.cpp`
* Add codegen tests to
`clang/test/CodeGenHLSL/builtins/GroupMemoryBarrierWithGroupSync.hlsl`
* Add sema tests to
`clang/test/SemaHLSL/BuiltIns/GroupMemoryBarrierWithGroupSync-errors.hlsl`

### Related PRs
* [[DXIL] Add GroupMemoryBarrierWithGroupSync intrinsic
#111884](#111884)
* [[SPIRV] Add GroupMemoryBarrierWithGroupSync intrinsic
#111888](#111888)
@github-project-automation github-project-automation bot moved this from Active to Closed in HLSL Support Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment