Implement `-fvk-use-dx-layout` (#4912)

* Implement `-fvk-use-dx-layout`

Fixes: #4126

Changes:
* Added fvk-use-dx-layout
* Modified `HLSLConstantBufferLayoutRulesImpl` for correctness (ex: Array is always 16 byte aligned)
* Added kFXCShaderResourceLayoutRulesFamilyImpl and kFXCConstantBufferLayoutRulesFamilyImpl to handle fvk-use-dx-layout
* Added `ConstantBufferLayoutRules` to manage constant buffer rules
* Added `alignCompositeElementOfNonAggregate`/`alignCompositeElementOfAggregate` to handle forced alignment of composites for ConstantBuffers
* `StructuredBuffer` rules are mostly equal to `scalar` layout, not much was needed to be changed to support this behavior.

* seperate legacy constant buffer and how Slang does constant-buffer normally

* undo an addition

* remove accidental test

* Address review and fix

Address review and remove GLSL support since GLSL requires a seperate legalization (need to linearlize structs like with `legalizeMetalIR` to assign explicit offsets)

* comments

* remove aggregate and non-aggregate logic

We don't need this distinction for the logic

---------

Co-authored-by: Yong He <yonghe@outlook.com>

7 files changed, 446 insertions, 0 deletions

diff --git a/tests/spirv/cbuffer-dx-layout-1.slang b/tests/spirv/cbuffer-dx-layout-1.slang
new file mode 100644
index 000000000..35d528bda
--- /dev/null
+++ b/tests/spirv/cbuffer-dx-layout-1.slang
@@ -0,0 +1,76 @@
+//TEST(compute, vulkan):COMPARE_COMPUTE_EX(filecheck-buffer=CHECK):-vk -compute -xslang -fvk-use-dx-layout -emit-spirv-directly
+//TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute -fvk-use-dx-layout
+//TEST_INPUT:cbuffer(data=[1 2.0 3.0 4.0   5 6 7 0   8 9 10 11   12 0 0 0  13 0 0 0   14 0 0 0   15 0 0 0   16 17 18 0   19 20 21 22   23 24 0 0   25 0 0 0   26 0 0 0]):name=Test
+
+//SPIRV: ArrayStride 16
+
+cbuffer Test
+{
+//SPIRV: Offset 0
+    uint v0;
+//SPIRV: Offset 4
+    float3 v1;
+
+//SPIRV: Offset 16
+    uint3 v2;
+
+//SPIRV: Offset 32
+    uint2 v3;
+//SPIRV: Offset 40
+    uint2 v4;
+
+//SPIRV: Offset 48
+    uint v5[4];
+
+// array always starts on a new register.
+//SPIRV: Offset 112
+    uint3 v6[2];
+//SPIRV: Offset 140
+// non-array can pack with a partially filled register
+    uint v7;
+
+//SPIRV: Offset 144
+    uint2 v8;
+
+// SPIRV: Offset 160
+// array always starts on a new register.
+    uint v9[2];
+};
+
+//TEST_INPUT:ubuffer(data=[0], stride=4):out,name outputBuffer
+RWStructuredBuffer<int> outputBuffer;
+
+__generic<T : IArithmetic, let N : int>
+bool comp(vector<T,N> v1, vector<T,N> v2)
+{
+    for (uint i = 0; i < N; i++)
+        if (v1[i] != v2[i])
+            return false;
+
+    return true;
+}
+
+[shader("compute")]
+[numthreads(2, 2, 1)]
+void computeMain()
+{
+    // CHECK: 64
+
+    outputBuffer[0] = (true
+            && v0 == 1
+            && comp(v1, float3(2, 3, 4))
+            && comp(v2, uint3(5, 6, 7))
+            && comp(v3, uint2(8, 9))
+            && comp(v4, uint2(10, 11))
+            && v5[0] == 12
+            && v5[1] == 13
+            && v5[2] == 14
+            && v5[3] == 15
+            && comp(v6[0], uint3(16, 17, 18))
+            && comp(v6[1], uint3(19, 20, 21))
+            && v7 == 22
+            && comp(v8, uint2(23, 24))
+            && v9[0] == 25
+            && v9[1] == 26
+        ) ? 100 : 0;
+}
\ No newline at end of file
diff --git a/tests/spirv/cbuffer-dx-layout-2.slang b/tests/spirv/cbuffer-dx-layout-2.slang
new file mode 100644
index 000000000..19bc6ea9e
--- /dev/null
+++ b/tests/spirv/cbuffer-dx-layout-2.slang
@@ -0,0 +1,86 @@
+//TEST(compute, vulkan):COMPARE_COMPUTE_EX(filecheck-buffer=CHECK):-vk -compute -xslang -fvk-use-dx-layout -emit-spirv-directly
+//TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute -fvk-use-dx-layout
+//TEST_INPUT: set Test.v0 = 1;
+//TEST_INPUT: set Test.v1 = {2.0,3.0,4.0};
+//TEST_INPUT: set Test.v2 = {5,6,7};
+//TEST_INPUT: set Test.v3 = {8,9};
+//TEST_INPUT: set Test.v4 = {10,11};
+//TEST_INPUT: set Test.v5 = {12,13,14,15};
+//TEST_INPUT: set Test.v6 = {{16,17,18}, {19,20,21}};
+//TEST_INPUT: set Test.v6 = {{16,17,18}, {19,20,21}};
+//TEST_INPUT: set Test.v7 = 22;
+//TEST_INPUT: set Test.v8 = {23,24};
+//TEST_INPUT: set Test.v9 = {25,26};
+
+//SPIRV_DX: ArrayStride 16
+
+cbuffer Test
+{
+//SPIRV: Offset 0
+    uint v0;
+//SPIRV: Offset 4
+    float3 v1;
+
+//SPIRV: Offset 16
+    uint3 v2;
+
+//SPIRV: Offset 32
+    uint2 v3;
+//SPIRV: Offset 40
+    uint2 v4;
+
+//SPIRV: Offset 48
+    uint v5[4];
+
+//SPIRV: Offset 112
+// Array always starts on a new register.
+    uint3 v6[2];
+//SPIRV: Offset 140
+// Non-array can pack with a partially filled register
+    uint v7;
+
+//SPIRV: Offset 144
+    uint2 v8;
+
+// SPIRV: Offset 160
+// Array always starts on a new register.
+    uint v9[2];
+};
+
+//TEST_INPUT:ubuffer(data=[0], stride=4):out,name outputBuffer
+RWStructuredBuffer<int> outputBuffer;
+
+__generic<T : IArithmetic, let N : int>
+bool comp(vector<T,N> v1, vector<T,N> v2)
+{
+    for (uint i = 0; i < N; i++)
+        if (v1[i] != v2[i])
+            return false;
+
+    return true;
+}
+
+[shader("compute")]
+[numthreads(2, 2, 1)]
+void computeMain()
+{
+    // CHECK: 64
+
+    outputBuffer[0] = (true
+            && v0 == 1
+            && comp(v1, float3(2, 3, 4))
+            && comp(v2, uint3(5, 6, 7))
+            && comp(v3, uint2(8, 9))
+            && comp(v4, uint2(10, 11))
+            && v5[0] == 12
+            && v5[1] == 13
+            && v5[2] == 14
+            && v5[3] == 15
+            && comp(v6[0], uint3(16, 17, 18))
+            && comp(v6[1], uint3(19, 20, 21))
+            && v7 == 22
+            && comp(v8, uint2(23, 24))
+            && v9[0] == 25
+            && v9[1] == 26
+        ) ? 100 : 0;
+}
\ No newline at end of file
diff --git a/tests/spirv/cbuffer-dx-layout-3.slang b/tests/spirv/cbuffer-dx-layout-3.slang
new file mode 100644
index 000000000..e05cd25f1
--- /dev/null
+++ b/tests/spirv/cbuffer-dx-layout-3.slang
@@ -0,0 +1,46 @@
+//TEST(compute, vulkan):COMPARE_COMPUTE_EX(filecheck-buffer=CHECK):-vk -compute -xslang -fvk-use-dx-layout -emit-spirv-directly
+//TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute -fvk-use-dx-layout 
+//TEST_INPUT:cbuffer(data=[1 0 0 0   2.0 3.0 4.0 0   5.0 6.0 7.0 0   8.0 9.0 10.0 11]):name=Test
+
+//SPIRV: ArrayStride 16
+
+cbuffer Test
+{
+//SPIRV: Offset 0
+    uint v0;
+
+//SPIRV: Offset 16
+// matrix always start on a new register
+    float3x3 v1;
+//SPIRV: Offset 60
+// Non-matrix can pack with a partially filled register
+    uint v2;
+};
+
+//TEST_INPUT:ubuffer(data=[0], stride=4):out,name outputBuffer
+RWStructuredBuffer<int> outputBuffer;
+
+__generic<T : IArithmetic, let N : int>
+bool comp(vector<T,N> v1, vector<T,N> v2)
+{
+    for (uint i = 0; i < N; i++)
+        if (v1[i] != v2[i])
+            return false;
+
+    return true;
+}
+
+[shader("compute")]
+[numthreads(2, 2, 1)]
+void computeMain()
+{
+    // CHECK: 64
+
+    outputBuffer[0] = (true
+            && v0 == 1
+            && comp(v1[0], float3(2, 3, 4))
+            && comp(v1[1], float3(5, 6, 7))
+            && comp(v1[2], float3(8, 9, 10))
+            && v2 == 11
+        ) ? 100 : 0;
+}
\ No newline at end of file
diff --git a/tests/spirv/cbuffer-dx-layout-4.slang b/tests/spirv/cbuffer-dx-layout-4.slang
new file mode 100644
index 000000000..c7df18e28
--- /dev/null
+++ b/tests/spirv/cbuffer-dx-layout-4.slang
@@ -0,0 +1,52 @@
+// For some reason CI fails this compute test by not loading data correctly
+//IGNORE_TEST(compute, vulkan):COMPARE_COMPUTE_EX(filecheck-buffer=CHECK):-vk -compute -xslang -fvk-use-dx-layout
+//TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute -fvk-use-dx-layout
+
+//TEST_INPUT: set Test.v0 = 1;
+//TEST_INPUT: set Test.v1 = {2,3};
+//TEST_INPUT: set Test.v2 = 4;
+
+struct Int_wrapper
+{
+//SPIRV: Offset 0
+    uint v0;
+//SPIRV: Offset 4
+    uint v1;
+};
+
+cbuffer Test
+{
+//SPIRV: Offset 0
+    uint v0;
+
+//SPIRV: Offset 16
+// struct's always start on a new register
+    Int_wrapper v1;
+//SPIRV: Offset 24
+// Non-struct can pack with a partially filled register
+    uint v2;
+};
+
+//TEST_INPUT:ubuffer(data=[0 0 0 0 0], stride=4):out,name outputBuffer
+RWStructuredBuffer<int> outputBuffer;
+
+[shader("compute")]
+[numthreads(2, 2, 1)]
+void computeMain()
+{
+    // CHECK: 64
+
+    outputBuffer[1] = v0;
+    outputBuffer[2] = v1.v0;
+    outputBuffer[3] = v1.v1;
+    outputBuffer[4] = v2;
+    
+    
+
+    outputBuffer[0] = (true
+            && v0 == 1
+            && v1.v0 == 2
+            && v1.v1 == 3
+            && v2 == 4
+        ) ? 100 : 0;
+}
\ No newline at end of file
diff --git a/tests/spirv/cbuffer-not-dx-layout.slang b/tests/spirv/cbuffer-not-dx-layout.slang
new file mode 100644
index 000000000..27063188d
--- /dev/null
+++ b/tests/spirv/cbuffer-not-dx-layout.slang
@@ -0,0 +1,56 @@
+//TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute
+
+cbuffer Test
+{
+//SPIRV: Offset 0
+    uint v0;
+
+//SPIRV: Offset 16
+    float3 v1;
+
+//SPIRV: Offset 32
+    uint3 v2;
+    
+//SPIRV: Offset 48
+    uint2 v3;
+
+//SPIRV: Offset 56
+    uint2 v4;
+
+//SPIRV: Offset 64
+    uint v5[4];
+
+//SPIRV: Offset 128
+    uint3 v6[2];
+};
+
+RWStructuredBuffer<int> outputBuffer;
+
+__generic<T : IArithmetic, let N : int>
+bool comp(vector<T,N> v1, vector<T,N> v2)
+{
+    for (uint i = 0; i < N; i++)
+        if (v1[i] != v2[i])
+            return false;
+
+    return true;
+}
+
+[shader("compute")]
+[numthreads(16, 16, 1)]
+void computeMain()
+{
+    outputBuffer[0] = (true
+            && v0 == 1
+            && comp(v1, float3( 2, 3, 4))
+            && comp(v2, uint3( 5, 6, 7))
+            && comp(v3, uint2( 8, 9 ))
+            && comp(v4, uint2( 10, 11 ))
+            && v5[0] == 12
+            && v5[1] == 13
+            && v5[2] == 14
+            && v5[3] == 15
+            && comp(v6[0], uint3( 16, 17, 18 ))
+            && comp(v6[1], uint3( 19, 20, 21 ))
+        ) ? 100 : 0;
+}
\ No newline at end of file
diff --git a/tests/spirv/structured-buffer-dx-layout.slang b/tests/spirv/structured-buffer-dx-layout.slang
new file mode 100644
index 000000000..678ad758d
--- /dev/null
+++ b/tests/spirv/structured-buffer-dx-layout.slang
@@ -0,0 +1,57 @@
+//TEST(compute, vulkan):COMPARE_COMPUTE_EX(filecheck-buffer=CHECK):-vk -compute -xslang -fvk-use-dx-layout -emit-spirv-directly
+//TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute -fvk-use-dx-layout
+
+struct Test_t
+{
+//SPIRV: Offset 0
+    uint v0;
+//SPIRV: Offset 4
+    float3 v1;
+//SPIRV: Offset 16
+    uint3 v2;
+//SPIRV: Offset 28
+    uint2 v3;
+//SPIRV: Offset 36
+    uint2 v4;
+//SPIRV: Offset 44
+    uint v5[4];
+//SPIRV: Offset 60
+    uint3 v6[2];
+};
+
+//TEST_INPUT:ubuffer(data=[1   2.0 3.0 4.0   5 6 7   8 9 10 11   12 13 14 15   16 17 18   19 20 21], stride=4):out,name testBuffer
+RWStructuredBuffer<Test_t> testBuffer;
+
+//TEST_INPUT:ubuffer(data=[0], stride=4):out,name outputBuffer
+RWStructuredBuffer<int> outputBuffer;
+
+__generic<T : IArithmetic, let N : int>
+bool comp(vector<T,N> v1, vector<T,N> v2)
+{
+    for (uint i = 0; i < N; i++)
+        if (v1[i] != v2[i])
+            return false;
+
+    return true;
+}
+
+[shader("compute")]
+[numthreads(16, 16, 1)]
+void computeMain()
+{
+    // CHECK: 64
+    Test_t test = testBuffer[0];
+    outputBuffer[0] = (true
+            && test.v0 == 1
+            && comp(test.v1, float3( 2, 3, 4))
+            && comp(test.v2, uint3( 5, 6, 7))
+            && comp(test.v3, uint2( 8, 9 ))
+            && comp(test.v4, uint2( 10, 11 ))
+            && test.v5[0] == 12
+            && test.v5[1] == 13
+            && test.v5[2] == 14
+            && test.v5[3] == 15
+            && comp(test.v6[0], uint3( 16, 17, 18 ))
+            && comp(test.v6[1], uint3( 19, 20, 21 ))
+        ) ? 100 : 0;
+}
\ No newline at end of file
diff --git a/tests/spirv/tbuffer-dx-layout-1.slang b/tests/spirv/tbuffer-dx-layout-1.slang
new file mode 100644
index 000000000..c1f494497
--- /dev/null
+++ b/tests/spirv/tbuffer-dx-layout-1.slang
@@ -0,0 +1,73 @@
+//IGNORE_TEST:SIMPLE(filecheck=SPIRV): -target spirv -entry computeMain -stage compute -fvk-use-dx-layout
+
+// 'tbuffer' is not implemented for SPIRV targets currently.
+
+tbuffer Test
+{
+//SPIRV: Offset 0
+    uint v0;
+//SPIRV: Offset 4
+    float3 v1;
+
+//SPIRV: Offset 16
+    uint3 v2;
+
+//SPIRV: Offset 32
+    uint2 v3;
+//SPIRV: Offset 40
+    uint2 v4;
+
+//SPIRV: Offset 48
+    uint v5[4];
+
+// array always starts on a new register.
+//SPIRV: Offset 112
+    uint3 v6[2];
+//SPIRV: Offset 140
+// non-array can pack with a partially filled register
+    uint v7;
+
+//SPIRV: Offset 144
+    uint2 v8;
+
+// SPIRV: Offset 160
+// array always starts on a new register.
+    uint v9[2];
+};
+
+RWStructuredBuffer<int> outputBuffer;
+
+__generic<T : IArithmetic, let N : int>
+bool comp(vector<T,N> v1, vector<T,N> v2)
+{
+    for (uint i = 0; i < N; i++)
+        if (v1[i] != v2[i])
+            return false;
+
+    return true;
+}
+
+[shader("compute")]
+[numthreads(2, 2, 1)]
+void computeMain()
+{
+    // CHECK: 64
+
+    outputBuffer[0] = (true
+            && v0 == 1
+            && comp(v1, float3(2, 3, 4))
+            && comp(v2, uint3(5, 6, 7))
+            && comp(v3, uint2(8, 9))
+            && comp(v4, uint2(10, 11))
+            && v5[0] == 12
+            && v5[1] == 13
+            && v5[2] == 14
+            && v5[3] == 15
+            && comp(v6[0], uint3(16, 17, 18))
+            && comp(v6[1], uint3(19, 20, 21))
+            && v7 == 22
+            && comp(v8, uint2(23, 24))
+            && v9[0] == 25
+            && v9[1] == 26
+        ) ? 100 : 0;
+}
\ No newline at end of file