From 9a7849d893ebb755a607befff6b3429830421112 Mon Sep 17 00:00:00 2001
From: Tim Foley <tfoleyNV@users.noreply.github.com>
Date: Mon, 23 Apr 2018 10:37:56 -0700
Subject: Improve SSA promotion for arrays and structs (#521)

* Improve SSA promotion for arrays and structs

Fixes #518

The existing SSA pass would only handle `load(v)` and `store(v,...)`
where `v` is the variable instruction, and would bail out if `v` was
used as an operand in any other fashion.

The new pass adds support for `load(ac)` where `ac` is an "access chain"
with a gramar like:

    ac :: v
        | getElementPtr(ac, ...)
	| getFieldAddress(ac, ...)

What this means in practical terms is that we can promote a local
variable of array or structure type to an SSA temporary even if there
are loads of individual elements/fields, as along as any *assignment* to
the variable assigns the whole thing.

I've added a test case to confirm that this change fixes passing of
arrays as function parameters for Vulkan.

* Fixup: disable test on Vulkan because render-test isn't ready

This is a fix for Vulkan, but I don't think our testing setup is ready
for it.

* Fixup: error in unreachable return case, caught by clang

* Fixups based on testing

These are fixes found when testing the original changes against the user code that originated the bug report.

* `emit.cpp`: Make sure to handle array-of-texture types when deciding whether to declare a temporary as a local variable in GLSL output

* `ir-legalize-types.cpp`: Make a not of a source of validation failures that we need to clean up sooner or later (just not in scope for this bug fix change).

* `ir-ssa.cpp`:
  * When checking if something is an access chain with a promotable var at the end, make sure the recursive case recurses into the "access chain" logic instead of the leaf case
  * Add some assertions to guard the assumption that any access chain we apply has been scheduled for removal
  * Correctly emit an element *extract* instead of getting an element *address* when promoting an element access into an array being promoted
  * Eliminate a wrapper routine that was setting up an `IRBuilder` and use the one from the block being processed in the SSA pass (since it was set up for stuff just like this)

* `ir-validate.cpp`
  * Add a hack to avoid validation failures when running IR validation on the stdlib code. This case triggers for an initializer (`__init`) declaration inside an interface, since the logical "return type" is the interface type itself, which has no representation at the IR level and thus yields a null result type in a `FuncType` instruction.
---
 tests/bugs/gh-518.slang              | 36 ++++++++++++++++++++++++++++++++++++
 tests/bugs/gh-518.slang.expected.txt |  4 ++++
 2 files changed, 40 insertions(+)
 create mode 100644 tests/bugs/gh-518.slang
 create mode 100644 tests/bugs/gh-518.slang.expected.txt

(limited to 'tests')

diff --git a/tests/bugs/gh-518.slang b/tests/bugs/gh-518.slang
new file mode 100644
index 000000000..96a101db2
--- /dev/null
+++ b/tests/bugs/gh-518.slang
@@ -0,0 +1,36 @@
+//TEST(compute):COMPARE_COMPUTE_EX:-slang -compute
+//TEST(compute):COMPARE_COMPUTE_EX:-slang -compute -dx12
+//TEST_DISABLED(compute, vulkan):COMPARE_COMPUTE_EX:-vk -compute
+
+// Note: can't actually test this on Vulkan right now because
+// the support in render-test isn't good enough.
+
+// Confirm that we can handle arrays of resources
+// being passed to a function.
+
+//TEST_INPUT:ubuffer(data=[0 0 0 0], stride=4):dxbinding(0),glbinding(0),out
+RWStructuredBuffer<int> gBuffer;
+
+//TEST_INPUT: Texture2D(size=4, content=one):dxbinding(0),glbinding(0)
+//TEST_INPUT: Texture2D(size=4, content=one):dxbinding(1),glbinding(1)
+Texture2D gTextures[2];
+
+float broken(Texture2D t[2])
+{
+    return t[0].Load(int3(0)).x + t[1].Load(int3(0)).x;
+}
+
+int test(int val)
+{
+    return val*int(broken(gTextures));
+}
+
+
+[numthreads(4, 1, 1)]
+void computeMain(uint3 dispatchThreadID : SV_DispatchThreadID)
+{
+    uint tid = dispatchThreadID.x;
+    int val = int(tid);
+    val = test(val);
+    gBuffer[tid] = val;
+}
\ No newline at end of file
diff --git a/tests/bugs/gh-518.slang.expected.txt b/tests/bugs/gh-518.slang.expected.txt
new file mode 100644
index 000000000..e1e8ccec4
--- /dev/null
+++ b/tests/bugs/gh-518.slang.expected.txt
@@ -0,0 +1,4 @@
+0
+2
+4
+6
-- 
cgit v1.2.3