move mod: move arch::subgroup to subgroup

Author: Firestar99

crates/spirv-std/src/arch.rs

@@ -14,13 +14,11 @@ mod atomics;
 mod barrier;
 mod demote_to_helper_invocation_ext;
 mod derivative;
-mod subgroup;
 
 pub use atomics::*;
 pub use barrier::*;
 pub use demote_to_helper_invocation_ext::*;
 pub use derivative::*;
-pub use subgroup::*;
 
 /// Result is true if any component of `vector` is true, otherwise result is
 /// false.

crates/spirv-std/src/lib.rs

@@ -105,6 +105,7 @@ mod runtime_array;
 mod sampler;
 mod scalar;
 mod scalar_or_vector;
+pub mod subgroup;
 pub mod task;
 mod typed_buffer;
 mod vector;

crates/spirv-std/src/scalar_or_vector.rs

@@ -43,7 +43,7 @@ pub unsafe trait ScalarOrVector: ScalarComposite + Default {
 /// features on the [`num_enum`] crate, or it won't compile on SPIR-V.
 ///
 /// [`Integer`]: crate::Integer
-/// [safe subgroup operations]: crate::arch::subgroup_shuffle
+/// [safe subgroup operations]: crate::subgroup::subgroup_shuffle
 /// [`FromPrimitive`]: https://docs.rs/num_enum/latest/num_enum/derive.FromPrimitive.html
 /// [`IntoPrimitive`]: https://docs.rs/num_enum/latest/num_enum/derive.IntoPrimitive.html
 /// [`num_enum`]: https://crates.io/crates/num_enum

crates/spirv-std/src/arch/subgroup.rs crates/spirv-std/src/subgroup.rscrates/spirv-std/src/arch/subgroup.rs renamed to crates/spirv-std/src/subgroup.rs

@@ -1,10 +1,26 @@
+//! Intrinsics for `subgroup` operations.
+//!
+//! The glsl equivalents are `subgroup*()` functions, see [`GL_KHR_shader_subgroup`]. Most of these translate to the
+//! SPIR-V [Non-Uniform Instructions], which have an opname starting with `OpGroupNonUniform*`. There's also some
+//! barrier operations and built-in input variables exposed in this module, similarly to glsl.
+//!
+//! Not to be confused with the [Group and Subgroup Instructions] starting with `OpGroup*`, which are unavailable in
+//! vulkan with many ops still undocumented. It seems to have fallen out of favor, never gaining glsl adoption, so
+//! we're only exposing the non-uniform variants.
+//!
+//! [`GL_KHR_shader_subgroup`]: https://github.com/KhronosGroup/GLSL/blob/main/extensions/khr/GL_KHR_shader_subgroup.txt
+//! [Non-Uniform Instructions]: https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#_non_uniform_instructions
+//! [Group and Subgroup Instructions]: https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#_group_and_subgroup_instructions
+
 #[cfg(target_arch = "spirv")]
 use crate::ScalarOrVectorTransform;
 #[cfg(target_arch = "spirv")]
-use crate::arch::{asm, barrier};
+use crate::arch::{control_barrier, memory_barrier};
 #[cfg(target_arch = "spirv")]
 use crate::memory::{Scope, Semantics};
 use crate::{Float, Integer, ScalarComposite, ScalarOrVector, SignedInteger, UnsignedInteger};
+#[cfg(target_arch = "spirv")]
+use core::arch::asm;
 
 #[cfg(target_arch = "spirv")]
 const SUBGROUP: u32 = Scope::Subgroup as u32;
@@ -59,7 +75,7 @@ pub enum GroupOperation {
 #[doc(alias = "subgroupBarrier")]
 #[inline]
 pub fn subgroup_barrier() {
-    barrier::control_barrier::<
+    control_barrier::<
         SUBGROUP,
         SUBGROUP,
         {
@@ -80,7 +96,7 @@ pub fn subgroup_barrier() {
 #[doc(alias = "subgroupMemoryBarrier")]
 #[inline]
 pub fn subgroup_memory_barrier() {
-    barrier::memory_barrier::<
+    memory_barrier::<
         SUBGROUP,
         {
             Semantics::ACQUIRE_RELEASE.bits()
@@ -100,7 +116,7 @@ pub fn subgroup_memory_barrier() {
 #[doc(alias = "subgroupMemoryBarrierBuffer")]
 #[inline]
 pub fn subgroup_memory_barrier_buffer() {
-    barrier::memory_barrier::<
+    memory_barrier::<
         SUBGROUP,
         { Semantics::ACQUIRE_RELEASE.bits() | Semantics::UNIFORM_MEMORY.bits() },
     >();
@@ -117,7 +133,7 @@ pub fn subgroup_memory_barrier_buffer() {
 #[doc(alias = "subgroupMemoryBarrierShared")]
 #[inline]
 pub fn subgroup_memory_barrier_shared() {
-    barrier::memory_barrier::<
+    memory_barrier::<
         SUBGROUP,
         { Semantics::ACQUIRE_RELEASE.bits() | Semantics::WORKGROUP_MEMORY.bits() },
     >();
@@ -132,7 +148,7 @@ pub fn subgroup_memory_barrier_shared() {
 #[doc(alias = "subgroupMemoryBarrierImage")]
 #[inline]
 pub fn subgroup_memory_barrier_image() {
-    barrier::memory_barrier::<
+    memory_barrier::<
         SUBGROUP,
         { Semantics::ACQUIRE_RELEASE.bits() | Semantics::IMAGE_MEMORY.bits() },
     >();

tests/compiletests/ui/glam/offsets_vec3_vec3a.rs

@@ -9,8 +9,8 @@
 // ignore-vulkan1.0
 // ignore-vulkan1.1
 
-use spirv_std::arch::subgroup_shuffle_up;
 use spirv_std::spirv;
+use spirv_std::subgroup::subgroup_shuffle_up;
 
 #[repr(C)]
 #[derive(Copy, Clone, Default)]

…ests/ui/arch/subgroup/subgroup_ballot.rs …piletests/ui/subgroup/subgroup_ballot.rstests/compiletests/ui/arch/subgroup/subgroup_ballot.rs renamed to tests/compiletests/ui/subgroup/subgroup_ballot.rs tests/compiletests/ui/arch/subgroup/subgroup_ballot.rs renamed to tests/compiletests/ui/subgroup/subgroup_ballot.rs

@@ -6,8 +6,8 @@
 use spirv_std::spirv;
 
 unsafe fn subgroup_ballot(predicate: bool) -> bool {
-    let ballot = spirv_std::arch::subgroup_ballot(predicate);
-    spirv_std::arch::subgroup_inverse_ballot(ballot)
+    let ballot = spirv_std::subgroup::subgroup_ballot(predicate);
+    spirv_std::subgroup::subgroup_inverse_ballot(ballot)
 }
 
 #[spirv(compute(threads(1, 1, 1)))]

…/ui/arch/subgroup/subgroup_ballot.stderr …tests/ui/subgroup/subgroup_ballot.stderrtests/compiletests/ui/arch/subgroup/subgroup_ballot.stderr renamed to tests/compiletests/ui/subgroup/subgroup_ballot.stderr tests/compiletests/ui/arch/subgroup/subgroup_ballot.stderr renamed to tests/compiletests/ui/subgroup/subgroup_ballot.stderr

@@ -3,16 +3,16 @@
 // compile-flags: -C llvm-args=--disassemble-fn=subgroup_ballot_bit_count::subgroup_ballot_bit_count
 // normalize-stderr-test "OpLine .*\n" -> ""
 
-use spirv_std::arch::{GroupOperation, SubgroupMask};
 use spirv_std::spirv;
+use spirv_std::subgroup::{GroupOperation, SubgroupMask};
 
 unsafe fn subgroup_ballot_bit_count(ballot: SubgroupMask) -> u32 {
-    spirv_std::arch::subgroup_ballot_bit_count(ballot)
+    spirv_std::subgroup::subgroup_ballot_bit_count(ballot)
 }
 
 #[spirv(compute(threads(1, 1, 1)))]
 pub fn main() {
     unsafe {
-        subgroup_ballot_bit_count(spirv_std::arch::subgroup_ballot(true));
+        subgroup_ballot_bit_count(spirv_std::subgroup::subgroup_ballot(true));
     }
 }

…ch/subgroup/subgroup_ballot_bit_count.rs …ui/subgroup/subgroup_ballot_bit_count.rstests/compiletests/ui/arch/subgroup/subgroup_ballot_bit_count.rs renamed to tests/compiletests/ui/subgroup/subgroup_ballot_bit_count.rs tests/compiletests/ui/arch/subgroup/subgroup_ballot_bit_count.rs renamed to tests/compiletests/ui/subgroup/subgroup_ballot_bit_count.rs

@@ -10,11 +10,11 @@
 // ignore-spv1.3
 // ignore-spv1.4
 
-use spirv_std::arch::{GroupOperation, SubgroupMask};
 use spirv_std::spirv;
+use spirv_std::subgroup::{GroupOperation, SubgroupMask};
 
 unsafe fn disassembly(value: i32, id: u32) -> i32 {
-    spirv_std::arch::subgroup_broadcast(value, id)
+    spirv_std::subgroup::subgroup_broadcast(value, id)
 }
 
 #[spirv(compute(threads(32, 1, 1)))]