[PATCH 0/4] MR147: vkd3d-shader: Refactor SPIR-V compilation a bit.

[Zebediah Figura (＠zfigura)]

The idea here is to eventually use vkd3d_shader_parser_compile() for d3dbc.

[PATCH 1/4] vkd3d-shader/spirv: Introduce a spirv_compile() helper.

[Zebediah Figura]

From: Zebediah Figura

---
 libs/vkd3d-shader/spirv.c                | 29 +++++++++++++++++++++---
 libs/vkd3d-shader/vkd3d_shader_main.c    | 13 +----------
 libs/vkd3d-shader/vkd3d_shader_private.h | 12 +++-------
 3 files changed, 30 insertions(+), 24 deletions(-)

diff --git a/libs/vkd3d-shader/spirv.c b/libs/vkd3d-shader/spirv.c
index ddd77ffb..e0b39420 100644
--- a/libs/vkd3d-shader/spirv.c
+++ b/libs/vkd3d-shader/spirv.c
@@ -2310,7 +2310,9 @@ static const char *spirv_compiler_get_entry_point_name(const struct spirv_compil
     return info && info->entry_point ? info->entry_point : "main";
 }

-struct spirv_compiler *spirv_compiler_create(const struct vkd3d_shader_version *shader_version,
+static void spirv_compiler_destroy(struct spirv_compiler *compiler);
+
+static struct spirv_compiler *spirv_compiler_create(const struct vkd3d_shader_version *shader_version,
         const struct vkd3d_shader_desc *shader_desc, const struct vkd3d_shader_compile_info *compile_info,
         const struct vkd3d_shader_scan_descriptor_info *scan_descriptor_info,
         struct vkd3d_shader_message_context *message_context, const struct vkd3d_shader_location *location)
@@ -9823,7 +9825,7 @@ static int spirv_compiler_handle_instruction(struct spirv_compiler *compiler,
     return ret;
 }

-int spirv_compiler_generate_spirv(struct spirv_compiler *compiler,
+static int spirv_compiler_generate_spirv(struct spirv_compiler *compiler,
         const struct vkd3d_shader_compile_info *compile_info, struct vkd3d_shader_parser *parser,
         struct vkd3d_shader_code *spirv)
 {
@@ -9916,7 +9918,28 @@ int spirv_compiler_generate_spirv(struct spirv_compiler *compiler,
     return VKD3D_OK;
 }

-void spirv_compiler_destroy(struct spirv_compiler *compiler)
+int spirv_compile(struct vkd3d_shader_parser *parser,
+        const struct vkd3d_shader_scan_descriptor_info *scan_descriptor_info,
+        const struct vkd3d_shader_compile_info *compile_info,
+        struct vkd3d_shader_code *out, struct vkd3d_shader_message_context *message_context)
+{
+    struct spirv_compiler *spirv_compiler;
+    int ret;
+
+    if (!(spirv_compiler = spirv_compiler_create(&parser->shader_version, &parser->shader_desc,
+            compile_info, scan_descriptor_info, message_context, &parser->location)))
+    {
+        ERR("Failed to create SPIR-V compiler.\n");
+        return VKD3D_ERROR;
+    }
+
+    ret = spirv_compiler_generate_spirv(spirv_compiler, compile_info, parser, out);
+
+    spirv_compiler_destroy(spirv_compiler);
+    return ret;
+}
+
+static void spirv_compiler_destroy(struct spirv_compiler *compiler)
 {
     vkd3d_free(compiler->control_flow_info);

diff --git a/libs/vkd3d-shader/vkd3d_shader_main.c b/libs/vkd3d-shader/vkd3d_shader_main.c
index 732d1cdc..b2b885aa 100644
--- a/libs/vkd3d-shader/vkd3d_shader_main.c
+++ b/libs/vkd3d-shader/vkd3d_shader_main.c
@@ -1173,7 +1173,6 @@ static int compile_dxbc_tpf(const struct vkd3d_shader_compile_info *compile_info
 {
     struct vkd3d_shader_scan_descriptor_info scan_descriptor_info;
     struct vkd3d_shader_compile_info scan_info;
-    struct spirv_compiler *spirv_compiler;
     struct vkd3d_shader_parser *parser;
     int ret;

@@ -1223,18 +1222,8 @@ static int compile_dxbc_tpf(const struct vkd3d_shader_compile_info *compile_info
         return ret;
     }

-    if (!(spirv_compiler = spirv_compiler_create(&parser->shader_version, &parser->shader_desc,
-            compile_info, &scan_descriptor_info, message_context, &parser->location)))
-    {
-        ERR("Failed to create DXBC compiler.\n");
-        vkd3d_shader_parser_destroy(parser);
-        vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
-        return VKD3D_ERROR;
-    }
-
-    ret = spirv_compiler_generate_spirv(spirv_compiler, compile_info, parser, out);
+    ret = spirv_compile(parser, &scan_descriptor_info, compile_info, out, message_context);

-    spirv_compiler_destroy(spirv_compiler);
     vkd3d_shader_parser_destroy(parser);
     vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
     return ret;
diff --git a/libs/vkd3d-shader/vkd3d_shader_private.h b/libs/vkd3d-shader/vkd3d_shader_private.h
index e2891de2..b048d5ef 100644
--- a/libs/vkd3d-shader/vkd3d_shader_private.h
+++ b/libs/vkd3d-shader/vkd3d_shader_private.h
@@ -1150,16 +1150,10 @@ void vkd3d_glsl_generator_destroy(struct vkd3d_glsl_generator *generator);

#define SPIRV_MAX_SRC_COUNT 6

-struct spirv_compiler;
-
-struct spirv_compiler *spirv_compiler_create(const struct vkd3d_shader_version *shader_version,
-        const struct vkd3d_shader_desc *shader_desc, const struct vkd3d_shader_compile_info *compile_info,
+int spirv_compile(struct vkd3d_shader_parser *parser,
         const struct vkd3d_shader_scan_descriptor_info *scan_descriptor_info,
-        struct vkd3d_shader_message_context *message_context, const struct vkd3d_shader_location *location);
-int spirv_compiler_generate_spirv(struct spirv_compiler *compiler,
-        const struct vkd3d_shader_compile_info *compile_info, struct vkd3d_shader_parser *parser,
-        struct vkd3d_shader_code *spirv);
-void spirv_compiler_destroy(struct spirv_compiler *compiler);
+        const struct vkd3d_shader_compile_info *compile_info,
+        struct vkd3d_shader_code *out, struct vkd3d_shader_message_context *message_context);

void vkd3d_compute_dxbc_checksum(const void *dxbc, size_t size, uint32_t checksum[4]);

[PATCH 2/4] vkd3d-shader/spirv: Move spirv_compiler_destroy() to avoid forward declarations.

[Zebediah Figura]

From: Zebediah Figura

---
 libs/vkd3d-shader/spirv.c | 40 +++++++++++++++++++--------------------
 1 file changed, 19 insertions(+), 21 deletions(-)

diff --git a/libs/vkd3d-shader/spirv.c b/libs/vkd3d-shader/spirv.c
index e0b39420..9504b955 100644
--- a/libs/vkd3d-shader/spirv.c
+++ b/libs/vkd3d-shader/spirv.c
@@ -2310,7 +2310,25 @@ static const char *spirv_compiler_get_entry_point_name(const struct spirv_compil
     return info && info->entry_point ? info->entry_point : "main";
 }

-static void spirv_compiler_destroy(struct spirv_compiler *compiler);
+static void spirv_compiler_destroy(struct spirv_compiler *compiler)
+{
+    vkd3d_free(compiler->control_flow_info);
+
+    vkd3d_free(compiler->output_info);
+
+    vkd3d_free(compiler->push_constants);
+    vkd3d_free(compiler->descriptor_offset_ids);
+
+    vkd3d_spirv_builder_free(&compiler->spirv_builder);
+
+    rb_destroy(&compiler->symbol_table, vkd3d_symbol_free, NULL);
+
+    vkd3d_free(compiler->spec_constants);
+
+    vkd3d_string_buffer_cache_cleanup(&compiler->string_buffers);
+
+    vkd3d_free(compiler);
+}

static struct spirv_compiler *spirv_compiler_create(const struct vkd3d_shader_version *shader_version,
         const struct vkd3d_shader_desc *shader_desc, const struct vkd3d_shader_compile_info *compile_info,
@@ -9938,23 +9956,3 @@ int spirv_compile(struct vkd3d_shader_parser *parser,
     spirv_compiler_destroy(spirv_compiler);
     return ret;
 }
-
-static void spirv_compiler_destroy(struct spirv_compiler *compiler)
-{
-    vkd3d_free(compiler->control_flow_info);
-
-    vkd3d_free(compiler->output_info);
-
-    vkd3d_free(compiler->push_constants);
-    vkd3d_free(compiler->descriptor_offset_ids);
-
-    vkd3d_spirv_builder_free(&compiler->spirv_builder);
-
-    rb_destroy(&compiler->symbol_table, vkd3d_symbol_free, NULL);
-
-    vkd3d_free(compiler->spec_constants);
-
-    vkd3d_string_buffer_cache_cleanup(&compiler->string_buffers);
-
-    vkd3d_free(compiler);
-}

[PATCH 3/4] vkd3d-shader: Reuse the existing parser for scanning in compile_dxbc_tpf().

[Zebediah Figura]

From: Zebediah Figura

---
 libs/vkd3d-shader/vkd3d_shader_main.c | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/libs/vkd3d-shader/vkd3d_shader_main.c b/libs/vkd3d-shader/vkd3d_shader_main.c
index b2b885aa..11e32ab0 100644
--- a/libs/vkd3d-shader/vkd3d_shader_main.c
+++ b/libs/vkd3d-shader/vkd3d_shader_main.c
@@ -1181,18 +1181,20 @@ static int compile_dxbc_tpf(const struct vkd3d_shader_compile_info *compile_info
     scan_descriptor_info.next = scan_info.next;
     scan_info.next = &scan_descriptor_info;

-    if ((ret = scan_dxbc(&scan_info, message_context)) < 0)
-        return ret;
-
     if ((ret = vkd3d_shader_sm4_parser_create(compile_info, message_context, &parser)) < 0)
     {
         WARN("Failed to initialise shader parser.\n");
-        vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
         return ret;
     }

vkd3d_shader_dump_shader(compile_info->source_type, parser->shader_version.type, &compile_info->source);

+    if ((ret = scan_with_parser(&scan_info, message_context, parser)) < 0)
+    {
+        vkd3d_shader_parser_destroy(parser);
+        return ret;
+    }
+
     if (compile_info->target_type == VKD3D_SHADER_TARGET_D3D_ASM)
     {
         vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);

[PATCH 4/4] vkd3d-shader: Factor out vkd3d_shader_parser_compile().

[Zebediah Figura]

From: Zebediah Figura

---
 libs/vkd3d-shader/vkd3d_shader_main.c | 79 +++++++++++++++------------
 1 file changed, 43 insertions(+), 36 deletions(-)

diff --git a/libs/vkd3d-shader/vkd3d_shader_main.c b/libs/vkd3d-shader/vkd3d_shader_main.c
index 11e32ab0..225bface 100644
--- a/libs/vkd3d-shader/vkd3d_shader_main.c
+++ b/libs/vkd3d-shader/vkd3d_shader_main.c
@@ -1168,66 +1168,73 @@ int vkd3d_shader_scan(const struct vkd3d_shader_compile_info *compile_info, char
     return ret;
 }

-static int compile_dxbc_tpf(const struct vkd3d_shader_compile_info *compile_info,
+static int vkd3d_shader_parser_compile(struct vkd3d_shader_parser *parser,
+        const struct vkd3d_shader_compile_info *compile_info,
         struct vkd3d_shader_code *out, struct vkd3d_shader_message_context *message_context)
 {
     struct vkd3d_shader_scan_descriptor_info scan_descriptor_info;
+    struct vkd3d_glsl_generator *glsl_generator;
     struct vkd3d_shader_compile_info scan_info;
-    struct vkd3d_shader_parser *parser;
     int ret;

+    vkd3d_shader_dump_shader(compile_info->source_type, parser->shader_version.type, &compile_info->source);
+
     scan_info = *compile_info;
     scan_descriptor_info.type = VKD3D_SHADER_STRUCTURE_TYPE_SCAN_DESCRIPTOR_INFO;
     scan_descriptor_info.next = scan_info.next;
     scan_info.next = &scan_descriptor_info;

-    if ((ret = vkd3d_shader_sm4_parser_create(compile_info, message_context, &parser)) < 0)
-    {
-        WARN("Failed to initialise shader parser.\n");
-        return ret;
-    }
-
-    vkd3d_shader_dump_shader(compile_info->source_type, parser->shader_version.type, &compile_info->source);
-
     if ((ret = scan_with_parser(&scan_info, message_context, parser)) < 0)
-    {
-        vkd3d_shader_parser_destroy(parser);
         return ret;
-    }

-    if (compile_info->target_type == VKD3D_SHADER_TARGET_D3D_ASM)
+    switch (compile_info->target_type)
     {
-        vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
-        ret = vkd3d_dxbc_binary_to_text(&parser->instructions, &parser->shader_version, compile_info, out);
-        vkd3d_shader_parser_destroy(parser);
-        return ret;
-    }
+        case VKD3D_SHADER_TARGET_D3D_ASM:
+            ret = vkd3d_dxbc_binary_to_text(&parser->instructions, &parser->shader_version, compile_info, out);
+            break;

-    if (compile_info->target_type == VKD3D_SHADER_TARGET_GLSL)
-    {
-        struct vkd3d_glsl_generator *glsl_generator;
+        case VKD3D_SHADER_TARGET_GLSL:
+            if (!(glsl_generator = vkd3d_glsl_generator_create(&parser->shader_version,
+                    message_context, &parser->location)))
+            {
+                ERR("Failed to create GLSL generator.\n");
+                vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
+                return VKD3D_ERROR;
+            }

-        if (!(glsl_generator = vkd3d_glsl_generator_create(&parser->shader_version,
-                message_context, &parser->location)))
-        {
-            ERR("Failed to create GLSL generator.\n");
-            vkd3d_shader_parser_destroy(parser);
-            vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
-            return VKD3D_ERROR;
-        }
+            ret = vkd3d_glsl_generator_generate(glsl_generator, parser, out);
+            vkd3d_glsl_generator_destroy(glsl_generator);
+            break;

-        ret = vkd3d_glsl_generator_generate(glsl_generator, parser, out);
+        case VKD3D_SHADER_TARGET_SPIRV_BINARY:
+        case VKD3D_SHADER_TARGET_SPIRV_TEXT:
+            ret = spirv_compile(parser, &scan_descriptor_info, compile_info, out, message_context);
+            break;

-        vkd3d_glsl_generator_destroy(glsl_generator);
-        vkd3d_shader_parser_destroy(parser);
-        vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
+        default:
+            /* Validation should prevent us from reaching this. */
+            assert(0);
+    }
+
+    vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
+    return ret;
+}
+
+static int compile_dxbc_tpf(const struct vkd3d_shader_compile_info *compile_info,
+        struct vkd3d_shader_code *out, struct vkd3d_shader_message_context *message_context)
+{
+    struct vkd3d_shader_parser *parser;
+    int ret;
+
+    if ((ret = vkd3d_shader_sm4_parser_create(compile_info, message_context, &parser)) < 0)
+    {
+        WARN("Failed to initialise shader parser.\n");
         return ret;
     }

-    ret = spirv_compile(parser, &scan_descriptor_info, compile_info, out, message_context);
+    ret = vkd3d_shader_parser_compile(parser, compile_info, out, message_context);

vkd3d_shader_parser_destroy(parser);
-    vkd3d_shader_free_scan_descriptor_info(&scan_descriptor_info);
     return ret;
 }

[PATCH 0/4] MR147: vkd3d-shader: Refactor SPIR-V compilation a bit. - approved

[Henri Verbeet (＠hverbeet)]

This merge request was approved by Henri Verbeet.