[SPIR-V] Use Builder createSelectionMerge directly

Author: Triang3l

src/xenia/gpu/spirv_builder.h

@@ -0,0 +1,33 @@
+/**
+ ******************************************************************************
+ * Xenia : Xbox 360 Emulator Research Project                                 *
+ ******************************************************************************
+ * Copyright 2023 Ben Vanik. All rights reserved.                             *
+ * Released under the BSD license - see LICENSE in the root for more details. *
+ ******************************************************************************
+ */
+
+#ifndef XENIA_GPU_SPIRV_BUILDER_H_
+#define XENIA_GPU_SPIRV_BUILDER_H_
+
+#include "third_party/glslang/SPIRV/SpvBuilder.h"
+
+namespace xe {
+namespace gpu {
+
+// SpvBuilder with extra helpers.
+
+class SpirvBuilder : public spv::Builder {
+ public:
+  SpirvBuilder(unsigned int spv_version, unsigned int user_number,
+               spv::SpvBuildLogger* logger)
+      : spv::Builder(spv_version, user_number, logger) {}
+
+  // Make public rather than protected.
+  using spv::Builder::createSelectionMerge;
+};
+
+}  // namespace gpu
+}  // namespace xe
+
+#endif  // XENIA_GPU_SPIRV_BUILDER_H_

src/xenia/gpu/spirv_shader_translator.cc

@@ -161,7 +161,7 @@ uint32_t SpirvShaderTranslator::GetModificationRegisterCount() const {
 
 void SpirvShaderTranslator::StartTranslation() {
   // TODO(Triang3l): Logger.
-  builder_ = std::make_unique<spv::Builder>(
+  builder_ = std::make_unique<SpirvBuilder>(
       features_.spirv_version, (kSpirvMagicToolId << 16) | 1, nullptr);
 
   builder_->addCapability(IsSpirvTessEvalShader() ? spv::CapabilityTessellation
@@ -591,8 +591,8 @@ void SpirvShaderTranslator::StartTranslation() {
     main_switch_header_ = builder_->getBuildPoint();
     main_switch_merge_ =
         new spv::Block(builder_->getUniqueId(), *function_main_);
-    SpirvCreateSelectionMerge(main_switch_merge_->getId(),
-                              spv::SelectionControlDontFlattenMask);
+    builder_->createSelectionMerge(main_switch_merge_,
+                                   spv::SelectionControlDontFlattenMask);
     main_switch_op_ = std::make_unique<spv::Instruction>(spv::OpSwitch);
     main_switch_op_->addIdOperand(main_loop_pc_current);
     main_switch_op_->addIdOperand(main_switch_merge_->getId());
@@ -914,7 +914,7 @@ void SpirvShaderTranslator::ProcessLoopStartInstruction(
       spv::OpIEqual, type_bool_, loop_count_new, const_uint_0_);
   spv::Block& skip_block = builder_->makeNewBlock();
   spv::Block& body_block = builder_->makeNewBlock();
-  SpirvCreateSelectionMerge(body_block.getId());
+  builder_->createSelectionMerge(&body_block, spv::SelectionControlMaskNone);
   {
     std::unique_ptr<spv::Instruction> branch_conditional_op =
         std::make_unique<spv::Instruction>(spv::OpBranchConditional);
@@ -976,7 +976,7 @@ void SpirvShaderTranslator::ProcessLoopEndInstruction(
   spv::Block& body_block = *builder_->getBuildPoint();
   spv::Block& continue_block = builder_->makeNewBlock();
   spv::Block& break_block = builder_->makeNewBlock();
-  SpirvCreateSelectionMerge(break_block.getId());
+  builder_->createSelectionMerge(&break_block, spv::SelectionControlMaskNone);
   {
     std::unique_ptr<spv::Instruction> branch_conditional_op =
         std::make_unique<spv::Instruction>(spv::OpBranchConditional);
@@ -1293,8 +1293,8 @@ void SpirvShaderTranslator::StartVertexOrTessEvalShaderInMain() {
         spv::Block& block_load_vertex_index_pre = *builder_->getBuildPoint();
         spv::Block& block_load_vertex_index_start = builder_->makeNewBlock();
         spv::Block& block_load_vertex_index_merge = builder_->makeNewBlock();
-        SpirvCreateSelectionMerge(block_load_vertex_index_merge.getId(),
-                                  spv::SelectionControlDontFlattenMask);
+        builder_->createSelectionMerge(&block_load_vertex_index_merge,
+                                       spv::SelectionControlDontFlattenMask);
         builder_->createConditionalBranch(load_vertex_index,
                                           &block_load_vertex_index_start,
                                           &block_load_vertex_index_merge);
@@ -1389,8 +1389,8 @@ void SpirvShaderTranslator::StartVertexOrTessEvalShaderInMain() {
           spv::Block& block_load_vertex_index_pre = *builder_->getBuildPoint();
           spv::Block& block_load_vertex_index_start = builder_->makeNewBlock();
           spv::Block& block_load_vertex_index_merge = builder_->makeNewBlock();
-          SpirvCreateSelectionMerge(block_load_vertex_index_merge.getId(),
-                                    spv::SelectionControlDontFlattenMask);
+          builder_->createSelectionMerge(&block_load_vertex_index_merge,
+                                         spv::SelectionControlDontFlattenMask);
           builder_->createConditionalBranch(load_vertex_index,
                                             &block_load_vertex_index_start,
                                             &block_load_vertex_index_merge);
@@ -1992,8 +1992,8 @@ void SpirvShaderTranslator::StartFragmentShaderInMain() {
           builder_->makeNewBlock();
       main_fsi_early_depth_stencil_execute_quad_merge_ =
           &builder_->makeNewBlock();
-      SpirvCreateSelectionMerge(
-          main_fsi_early_depth_stencil_execute_quad_merge_->getId(),
+      builder_->createSelectionMerge(
+          main_fsi_early_depth_stencil_execute_quad_merge_,
           spv::SelectionControlDontFlattenMask);
       builder_->createConditionalBranch(
           quad_needs_execution, &main_fsi_early_depth_stencil_execute_quad,
@@ -2244,7 +2244,8 @@ void SpirvShaderTranslator::UpdateExecConditionals(
   cf_exec_condition_ = condition;
   cf_exec_conditional_merge_ = new spv::Block(
       builder_->getUniqueId(), builder_->getBuildPoint()->getParent());
-  SpirvCreateSelectionMerge(cf_exec_conditional_merge_->getId());
+  builder_->createSelectionMerge(cf_exec_conditional_merge_,
+                                 spv::SelectionControlDontFlattenMask);
   spv::Block& inner_block = builder_->makeNewBlock();
   builder_->createConditionalBranch(
       condition_id, condition ? &inner_block : cf_exec_conditional_merge_,
@@ -2284,7 +2285,8 @@ void SpirvShaderTranslator::UpdateInstructionPredication(bool predicated,
   spv::Block& predicated_block = builder_->makeNewBlock();
   cf_instruction_predicate_merge_ = new spv::Block(
       builder_->getUniqueId(), builder_->getBuildPoint()->getParent());
-  SpirvCreateSelectionMerge(cf_instruction_predicate_merge_->getId());
+  builder_->createSelectionMerge(cf_instruction_predicate_merge_,
+                                 spv::SelectionControlMaskNone);
   builder_->createConditionalBranch(
       predicate_id,
       condition ? &predicated_block : cf_instruction_predicate_merge_,
@@ -2870,7 +2872,8 @@ spv::Id SpirvShaderTranslator::EndianSwap32Uint(spv::Id value, spv::Id endian) {
   assert_false(block_pre_8in16.isTerminated());
   spv::Block& block_8in16 = builder_->makeNewBlock();
   spv::Block& block_8in16_merge = builder_->makeNewBlock();
-  SpirvCreateSelectionMerge(block_8in16_merge.getId());
+  builder_->createSelectionMerge(&block_8in16_merge,
+                                 spv::SelectionControlMaskNone);
   builder_->createConditionalBranch(is_8in16_or_8in32, &block_8in16,
                                     &block_8in16_merge);
   builder_->setBuildPoint(&block_8in16);
@@ -2910,7 +2913,8 @@ spv::Id SpirvShaderTranslator::EndianSwap32Uint(spv::Id value, spv::Id endian) {
   spv::Block& block_pre_16in32 = *builder_->getBuildPoint();
   spv::Block& block_16in32 = builder_->makeNewBlock();
   spv::Block& block_16in32_merge = builder_->makeNewBlock();
-  SpirvCreateSelectionMerge(block_16in32_merge.getId());
+  builder_->createSelectionMerge(&block_16in32_merge,
+                                 spv::SelectionControlMaskNone);
   builder_->createConditionalBranch(is_8in32_or_16in32, &block_16in32,
                                     &block_16in32_merge);
   builder_->setBuildPoint(&block_16in32);
@@ -2982,8 +2986,8 @@ spv::Id SpirvShaderTranslator::LoadUint32FromSharedMemory(
   std::unique_ptr<spv::Instruction> value_phi_op =
       std::make_unique<spv::Instruction>(value_phi_result, type_uint_,
                                          spv::OpPhi);
-  SpirvCreateSelectionMerge(switch_merge_block.getId(),
-                            spv::SelectionControlDontFlattenMask);
+  builder_->createSelectionMerge(&switch_merge_block,
+                                 spv::SelectionControlDontFlattenMask);
   {
     std::unique_ptr<spv::Instruction> switch_op =
         std::make_unique<spv::Instruction>(spv::OpSwitch);

src/xenia/gpu/spirv_shader_translator.h

@@ -17,8 +17,8 @@
 #include <utility>
 #include <vector>
 
-#include "third_party/glslang/SPIRV/SpvBuilder.h"
 #include "xenia/gpu/shader_translator.h"
+#include "xenia/gpu/spirv_builder.h"
 #include "xenia/gpu/xenos.h"
 #include "xenia/ui/vulkan/vulkan_provider.h"
 
@@ -374,30 +374,30 @@ class SpirvShaderTranslator : public ShaderTranslator {
 
   // Converts the color value externally clamped to [0, 31.875] to 7e3 floating
   // point, with zeros in bits 10:31, rounding to the nearest even.
-  static spv::Id PreClampedFloat32To7e3(spv::Builder& builder,
+  static spv::Id PreClampedFloat32To7e3(SpirvBuilder& builder,
                                         spv::Id f32_scalar,
                                         spv::Id ext_inst_glsl_std_450);
   // Same as PreClampedFloat32To7e3, but clamps the input to [0, 31.875].
-  static spv::Id UnclampedFloat32To7e3(spv::Builder& builder,
+  static spv::Id UnclampedFloat32To7e3(SpirvBuilder& builder,
                                        spv::Id f32_scalar,
                                        spv::Id ext_inst_glsl_std_450);
   // Converts the 7e3 number in bits [f10_shift, f10_shift + 10) to a 32-bit
   // float.
-  static spv::Id Float7e3To32(spv::Builder& builder, spv::Id f10_uint_scalar,
+  static spv::Id Float7e3To32(SpirvBuilder& builder, spv::Id f10_uint_scalar,
                               uint32_t f10_shift, bool result_as_uint,
                               spv::Id ext_inst_glsl_std_450);
   // Converts the depth value externally clamped to the representable [0, 2)
   // range to 20e4 floating point, with zeros in bits 24:31, rounding to the
   // nearest even or towards zero. If remap_from_0_to_0_5 is true, it's assumed
   // that 0...1 is pre-remapped to 0...0.5 in the input.
-  static spv::Id PreClampedDepthTo20e4(spv::Builder& builder,
+  static spv::Id PreClampedDepthTo20e4(SpirvBuilder& builder,
                                        spv::Id f32_scalar,
                                        bool round_to_nearest_even,
                                        bool remap_from_0_to_0_5,
                                        spv::Id ext_inst_glsl_std_450);
   // Converts the 20e4 number in bits [f24_shift, f24_shift + 10) to a 32-bit
   // float.
-  static spv::Id Depth20e4To32(spv::Builder& builder, spv::Id f24_uint_scalar,
+  static spv::Id Depth20e4To32(SpirvBuilder& builder, spv::Id f24_uint_scalar,
                                uint32_t f24_shift, bool remap_to_0_to_0_5,
                                bool result_as_uint,
                                spv::Id ext_inst_glsl_std_450);
@@ -451,15 +451,6 @@ class SpirvShaderTranslator : public ShaderTranslator {
 
   // Builder helpers.
   spv::Id SpirvSmearScalarResultOrConstant(spv::Id scalar, spv::Id vector_type);
-  void SpirvCreateSelectionMerge(
-      spv::Id merge_block_id, spv::SelectionControlMask selection_control_mask =
-                                  spv::SelectionControlMaskNone) {
-    std::unique_ptr<spv::Instruction> selection_merge_op =
-        std::make_unique<spv::Instruction>(spv::OpSelectionMerge);
-    selection_merge_op->addIdOperand(merge_block_id);
-    selection_merge_op->addImmediateOperand(selection_control_mask);
-    builder_->getBuildPoint()->addInstruction(std::move(selection_merge_op));
-  }
 
   Modification GetSpirvShaderModification() const {
     return Modification(current_translation().modification());
@@ -689,7 +680,7 @@ class SpirvShaderTranslator : public ShaderTranslator {
   // and stencil testing with fragment shader interlock.
   bool is_depth_only_fragment_shader_ = false;
 
-  std::unique_ptr<spv::Builder> builder_;
+  std::unique_ptr<SpirvBuilder> builder_;
 
   std::vector<spv::Id> id_vector_temp_;
   // For helper functions like operand loading, so they don't conflict with

src/xenia/gpu/spirv_shader_translator_alu.cc

@@ -62,7 +62,7 @@ void SpirvShaderTranslator::KillPixel(spv::Id condition) {
   builder_->createBranch(merge_block);
 
   builder_->setBuildPoint(&header_block);
-  SpirvCreateSelectionMerge(merge_block->getId());
+  builder_->createSelectionMerge(merge_block, spv::SelectionControlMaskNone);
   builder_->createConditionalBranch(condition, kill_block, merge_block);
 
   function.addBlock(merge_block);

src/xenia/gpu/spirv_shader_translator_fetch.cc

@@ -1178,8 +1178,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
           spv::Block& block_dimension_head = *builder_->getBuildPoint();
           spv::Block& block_dimension_merge = builder_->makeNewBlock();
           spv::Block& block_dimension_3d = builder_->makeNewBlock();
-          SpirvCreateSelectionMerge(block_dimension_merge.getId(),
-                                    spv::SelectionControlDontFlattenMask);
+          builder_->createSelectionMerge(&block_dimension_merge,
+                                         spv::SelectionControlDontFlattenMask);
           assert_true(data_is_3d != spv::NoResult);
           builder_->createConditionalBranch(data_is_3d, &block_dimension_3d,
                                             &block_dimension_merge);
@@ -1209,8 +1209,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
           spv::Block* block_dimension_3d =
               z_offset != spv::NoResult ? &builder_->makeNewBlock() : nullptr;
           spv::Block& block_dimension_stacked = builder_->makeNewBlock();
-          SpirvCreateSelectionMerge(block_dimension_merge.getId(),
-                                    spv::SelectionControlDontFlattenMask);
+          builder_->createSelectionMerge(&block_dimension_merge,
+                                         spv::SelectionControlDontFlattenMask);
           assert_true(data_is_3d != spv::NoResult);
           builder_->createConditionalBranch(
               data_is_3d,
@@ -1318,7 +1318,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
         spv::Block& block_ma_y = builder_->makeNewBlock();
         spv::Block& block_ma_z = builder_->makeNewBlock();
         spv::Block& block_ma_merge = builder_->makeNewBlock();
-        SpirvCreateSelectionMerge(block_ma_merge.getId());
+        builder_->createSelectionMerge(&block_ma_merge,
+                                       spv::SelectionControlMaskNone);
         {
           std::unique_ptr<spv::Instruction> ma_switch_op =
               std::make_unique<spv::Instruction>(spv::OpSwitch);
@@ -1441,8 +1442,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
           spv::Block& block_dimension_3d_start = builder_->makeNewBlock();
           spv::Block& block_dimension_stacked_start = builder_->makeNewBlock();
           spv::Block& block_dimension_merge = builder_->makeNewBlock();
-          SpirvCreateSelectionMerge(block_dimension_merge.getId(),
-                                    spv::SelectionControlDontFlattenMask);
+          builder_->createSelectionMerge(&block_dimension_merge,
+                                         spv::SelectionControlDontFlattenMask);
           assert_true(data_is_3d != spv::NoResult);
           builder_->createConditionalBranch(data_is_3d,
                                             &block_dimension_3d_start,
@@ -1843,8 +1844,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
           spv::Block& block_dimension_3d_start = builder_->makeNewBlock();
           spv::Block& block_dimension_stacked_start = builder_->makeNewBlock();
           spv::Block& block_dimension_merge = builder_->makeNewBlock();
-          SpirvCreateSelectionMerge(block_dimension_merge.getId(),
-                                    spv::SelectionControlDontFlattenMask);
+          builder_->createSelectionMerge(&block_dimension_merge,
+                                         spv::SelectionControlDontFlattenMask);
           assert_true(data_is_3d != spv::NoResult);
           builder_->createConditionalBranch(data_is_3d,
                                             &block_dimension_3d_start,
@@ -2021,8 +2022,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
                                             ? builder_->makeNewBlock()
                                             : block_z_head;
             if (vol_filter_is_linear != spv::NoResult) {
-              SpirvCreateSelectionMerge(block_z_merge.getId(),
-                                        spv::SelectionControlDontFlattenMask);
+              builder_->createSelectionMerge(
+                  &block_z_merge, spv::SelectionControlDontFlattenMask);
               builder_->createConditionalBranch(
                   vol_filter_is_linear, &block_z_linear, &block_z_merge);
               builder_->setBuildPoint(&block_z_linear);
@@ -2187,8 +2188,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
             spv::Block& block_swizzle_constant = builder_->makeNewBlock();
             spv::Block& block_swizzle_component = builder_->makeNewBlock();
             spv::Block& block_swizzle_merge = builder_->makeNewBlock();
-            SpirvCreateSelectionMerge(block_swizzle_merge.getId(),
-                                      spv::SelectionControlDontFlattenMask);
+            builder_->createSelectionMerge(
+                &block_swizzle_merge, spv::SelectionControlDontFlattenMask);
             builder_->createConditionalBranch(swizzle_bit_2,
                                               &block_swizzle_constant,
                                               &block_swizzle_component);
@@ -2279,8 +2280,8 @@ void SpirvShaderTranslator::ProcessTextureFetchInstruction(
             spv::Block& block_sign_unsigned_biased = builder_->makeNewBlock();
             spv::Block& block_sign_gamma_start = builder_->makeNewBlock();
             spv::Block& block_sign_merge = builder_->makeNewBlock();
-            SpirvCreateSelectionMerge(block_sign_merge.getId(),
-                                      spv::SelectionControlDontFlattenMask);
+            builder_->createSelectionMerge(
+                &block_sign_merge, spv::SelectionControlDontFlattenMask);
             {
               std::unique_ptr<spv::Instruction> sign_switch_op =
                   std::make_unique<spv::Instruction>(spv::OpSwitch);
@@ -2543,8 +2544,8 @@ void SpirvShaderTranslator::SampleTexture(
     spv::Block& block_sign_head = *builder_->getBuildPoint();
     spv::Block& block_sign = builder_->makeNewBlock();
     spv::Block& block_sign_merge = builder_->makeNewBlock();
-    SpirvCreateSelectionMerge(block_sign_merge.getId(),
-                              spv::SelectionControlDontFlattenMask);
+    builder_->createSelectionMerge(&block_sign_merge,
+                                   spv::SelectionControlDontFlattenMask);
     // Unsigned (i == 0) - if there are any non-signed components.
     // Signed (i == 1) - if there are any signed components.
     builder_->createConditionalBranch(i ? is_any_signed : is_all_signed,
@@ -2601,8 +2602,8 @@ spv::Id SpirvShaderTranslator::QueryTextureLod(
   spv::Block& block_sign_signed = builder_->makeNewBlock();
   spv::Block& block_sign_unsigned = builder_->makeNewBlock();
   spv::Block& block_sign_merge = builder_->makeNewBlock();
-  SpirvCreateSelectionMerge(block_sign_merge.getId(),
-                            spv::SelectionControlDontFlattenMask);
+  builder_->createSelectionMerge(&block_sign_merge,
+                                 spv::SelectionControlDontFlattenMask);
   builder_->createConditionalBranch(is_all_signed, &block_sign_signed,
                                     &block_sign_unsigned);
   builder_->setBuildPoint(&block_sign_signed);