Add RGA compiler support to HLSL (#3961)gh-3951

* Add RGA compiler support to HLSL

AMD's Radeon GPU Analyzer (RGA) tool is an indispensible tool for
graphics programmers to inspect the instructions that will be
compiled by the driver for a given shader and GPU. The integration of
this compiler into CE is slightly unconventional for reasons to be
explained here:

When trying to compile HLSL directly to ISA, RGA requires a full
pipeline state description (specified for graphics pipelines using a
gpso file), and a root signature, since changes to either affect how
resources and data within the shader are accessed or written to.
Specifying both is difficult to the extent that it would add significant
usage friction to the tool. An informal survey among other senior
graphics programming practitioners suggested unanimous agreement to
infer both pipeline state and root signature where possible, with the
expectation that if more accurate ISA code was needed, RGA could be used
directly offline.

Fortunately, RGA supplies an alternative workflow, wherein SPIR-V code
can be compiled directly to the approximate ISA, bypassing both the
pipeline and root signature requirement. To use RGA, the following steps
are performed:

1. Use the default DXC compiler to emit SPIR-V as text to a temporary
   file in the selected temp folder.
2. Compile the ISA using RGA, consuming the output of step 1
3. Rename the resulting file to the output file CE expects

In addition, a non-standard argument --asic is added to the user
options. This argument is filtered for DXC, but for RGA is forwarded as
the selected ASIC to emit ISA for.

These steps are performed by a single `rga.js` script, which is invoked
as an executable. This chaining could have been added within CE library
code directly, but being an atypical flow, felt more appropriate as a
separate script (which has the benefit of faster iteration, due to being
loaded on each compilation request). The paths to DXC and RGA are
supplied as arguments through a simple CLI interface.

NOTE: This commit also adds `-Zi` and `-Qembed_debug` flags to both DXC
and RGA, which provides line association data for DXIL.

Signed-off-by: Jeremy Ong <jeremycong@gmail.com>

* Incorporate PR feedback (see commit body)

This commit introduces several changes:

- HLSL compiler is now Typescript
- A new RGACompiler Typescript class is used to invoke RGA
- The multi-phase compilation that was previously done using a Node
  script now leverages the existing sandboxed execution facilities
- The DXC compiler is configurable as a property on the RGA
  configuration, and an example is provided in hlsl.defaults.properties

As there are several steps needed to compile HLSL to AMD ISA as before,
as steps are done asynchronously so the runtime can continue to service
other requests during compilation (either DXC or RGA) or file I/O.

Signed-off-by: Jeremy Ong <jeremycong@gmail.com>

Signed-off-by: Jeremy Ong <jeremycong@gmail.com>
Co-authored-by: Rubén Rincón Blanco <ruben@rinconblanco.es>

1 files changed, 70 insertions, 0 deletions

diff --git a/lib/compilers/hlsl.ts b/lib/compilers/hlsl.ts
new file mode 100644
index 000000000..2925a0154
--- /dev/null
+++ b/lib/compilers/hlsl.ts
@@ -0,0 +1,70 @@
+// Copyright (c) 2022, Compiler Explorer Authors
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+//     * Redistributions of source code must retain the above copyright notice,
+//       this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above copyright
+//       notice, this list of conditions and the following disclaimer in the
+//       documentation and/or other materials provided with the distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+import path from 'path';
+
+import {ParseFilters} from '../../types/features/filters.interfaces';
+import {BaseCompiler} from '../base-compiler';
+
+export class HLSLCompiler extends BaseCompiler {
+    static get key() {
+        return 'hlsl';
+    }
+
+    constructor(info: any, env: any) {
+        super(info, env);
+
+        this.compiler.supportsIntel = false;
+    }
+
+    /* eslint-disable no-unused-vars */
+    override optionsForFilter(filters: ParseFilters, outputFilename: string, userOptions?: string[]): string[] {
+        return [
+            '-Zi', // Embed debug information to get DXIL line associations
+            '-Qembed_debug', // Silences the warning associated with embedded debug information
+            `-Fc ${outputFilename}`, // Output object
+        ];
+    }
+    /* eslint-enable no-unused-vars */
+
+    override filterUserOptions(userOptions: any) {
+        // RGA supports a non-standard flag --asic [ASIC] which must be removed when compiling with DXC
+        const options = userOptions.slice(0);
+        // Scan for the RGA-specific argument --asic and strip it and its corresponding argument
+        // Assumes the argument exists at most once (compilation will fail if supplied more than
+        // once regardless)
+        for (let i = 0; i !== options.length; ++i) {
+            const option = options[i];
+            if (option === '--asic') {
+                options.splice(i, 2);
+                break;
+            }
+        }
+        return options;
+    }
+
+    override getIrOutputFilename(inputFilename: string) {
+        return this.getOutputFilename(path.dirname(inputFilename), this.outputFilebase).replace('.s', '.dxil');
+    }
+}