kc3-lang/angle/src/compiler/translator/UniformHLSL.cpp

Branch : - branch - main - tag -

• Show log

  Commit

• Author : Jamie Madill
  Date : 2016-12-12 14:42:19
  Hash : d7b1ab58
  Message : Fix up translator style. Using git cl format. BUG=angleproject:650 Change-Id: I7d3f98d2b0dcfb0a8de6c35327db74e55c28d761 Reviewed-on: https://chromium-review.googlesource.com/419059 Reviewed-by: Jamie Madill <jmadill@chromium.org> Commit-Queue: Jamie Madill <jmadill@chromium.org>

• src/compiler/translator/UniformHLSL.cpp

• //
  // Copyright (c) 2014 The ANGLE Project Authors. All rights reserved.
  // Use of this source code is governed by a BSD-style license that can be
  // found in the LICENSE file.
  //
  // UniformHLSL.cpp:
  //   Methods for GLSL to HLSL translation for uniforms and interface blocks.
  //
  
  #include "compiler/translator/UniformHLSL.h"
  
  #include "common/utilities.h"
  #include "compiler/translator/StructureHLSL.h"
  #include "compiler/translator/UtilsHLSL.h"
  #include "compiler/translator/blocklayoutHLSL.h"
  #include "compiler/translator/util.h"
  
  namespace sh
  {
  
  static const char *UniformRegisterPrefix(const TType &type)
  {
      if (IsSampler(type.getBasicType()))
      {
          return "s";
      }
      else
      {
          return "c";
      }
  }
  
  static TString InterfaceBlockFieldTypeString(const TField &field, TLayoutBlockStorage blockStorage)
  {
      const TType &fieldType                   = *field.type();
      const TLayoutMatrixPacking matrixPacking = fieldType.getLayoutQualifier().matrixPacking;
      ASSERT(matrixPacking != EmpUnspecified);
      TStructure *structure = fieldType.getStruct();
  
      if (fieldType.isMatrix())
      {
          // Use HLSL row-major packing for GLSL column-major matrices
          const TString &matrixPackString =
              (matrixPacking == EmpRowMajor ? "column_major" : "row_major");
          return matrixPackString + " " + TypeString(fieldType);
      }
      else if (structure)
      {
          // Use HLSL row-major packing for GLSL column-major matrices
          return QualifiedStructNameString(*structure, matrixPacking == EmpColumnMajor,
                                           blockStorage == EbsStd140);
      }
      else
      {
          return TypeString(fieldType);
      }
  }
  
  static TString InterfaceBlockStructName(const TInterfaceBlock &interfaceBlock)
  {
      return DecoratePrivate(interfaceBlock.name()) + "_type";
  }
  
  UniformHLSL::UniformHLSL(StructureHLSL *structureHLSL,
                           ShShaderOutput outputType,
                           const std::vector<Uniform> &uniforms)
      : mUniformRegister(0),
        mInterfaceBlockRegister(0),
        mSamplerRegister(0),
        mStructureHLSL(structureHLSL),
        mOutputType(outputType),
        mUniforms(uniforms)
  {
  }
  
  void UniformHLSL::reserveUniformRegisters(unsigned int registerCount)
  {
      mUniformRegister = registerCount;
  }
  
  void UniformHLSL::reserveInterfaceBlockRegisters(unsigned int registerCount)
  {
      mInterfaceBlockRegister = registerCount;
  }
  
  const Uniform *UniformHLSL::findUniformByName(const TString &name) const
  {
      for (size_t uniformIndex = 0; uniformIndex < mUniforms.size(); ++uniformIndex)
      {
          if (mUniforms[uniformIndex].name == name.c_str())
          {
              return &mUniforms[uniformIndex];
          }
      }
  
      return nullptr;
  }
  
  unsigned int UniformHLSL::assignUniformRegister(const TType &type,
                                                  const TString &name,
                                                  unsigned int *outRegisterCount)
  {
      unsigned int registerIndex =
          (IsSampler(type.getBasicType()) ? mSamplerRegister : mUniformRegister);
  
      const Uniform *uniform = findUniformByName(name);
      ASSERT(uniform);
  
      mUniformRegisterMap[uniform->name] = registerIndex;
  
      unsigned int registerCount = HLSLVariableRegisterCount(*uniform, mOutputType);
  
      if (gl::IsSamplerType(uniform->type))
      {
          mSamplerRegister += registerCount;
      }
      else
      {
          mUniformRegister += registerCount;
      }
      if (outRegisterCount)
      {
          *outRegisterCount = registerCount;
      }
      return registerIndex;
  }
  
  unsigned int UniformHLSL::assignSamplerInStructUniformRegister(const TType &type,
                                                                 const TString &name,
                                                                 unsigned int *outRegisterCount)
  {
      // Sampler that is a field of a uniform structure.
      ASSERT(IsSampler(type.getBasicType()));
      unsigned int registerIndex                     = mSamplerRegister;
      mUniformRegisterMap[std::string(name.c_str())] = registerIndex;
      unsigned int registerCount                     = type.isArray() ? type.getArraySize() : 1u;
      mSamplerRegister += registerCount;
      if (outRegisterCount)
      {
          *outRegisterCount = registerCount;
      }
      return registerIndex;
  }
  
  void UniformHLSL::outputHLSLSamplerUniformGroup(
      TInfoSinkBase &out,
      const HLSLTextureSamplerGroup textureGroup,
      const TVector<const TIntermSymbol *> &group,
      const TMap<const TIntermSymbol *, TString> &samplerInStructSymbolsToAPINames,
      unsigned int *groupTextureRegisterIndex)
  {
      if (group.empty())
      {
          return;
      }
      unsigned int groupRegisterCount = 0;
      for (const TIntermSymbol *uniform : group)
      {
          const TType &type   = uniform->getType();
          const TString &name = uniform->getSymbol();
          unsigned int registerCount;
  
          // The uniform might be just a regular sampler or one extracted from a struct.
          unsigned int samplerArrayIndex = 0u;
          const Uniform *uniformByName   = findUniformByName(name);
          if (uniformByName)
          {
              samplerArrayIndex = assignUniformRegister(type, name, &registerCount);
          }
          else
          {
              ASSERT(samplerInStructSymbolsToAPINames.find(uniform) !=
                     samplerInStructSymbolsToAPINames.end());
              samplerArrayIndex = assignSamplerInStructUniformRegister(
                  type, samplerInStructSymbolsToAPINames.at(uniform), &registerCount);
          }
          groupRegisterCount += registerCount;
  
          if (type.isArray())
          {
              out << "static const uint " << DecorateIfNeeded(uniform->getName()) << ArrayString(type)
                  << " = {";
              for (unsigned int i = 0u; i < type.getArraySize(); ++i)
              {
                  if (i > 0u)
                      out << ", ";
                  out << (samplerArrayIndex + i);
              }
              out << "};\n";
          }
          else
          {
              out << "static const uint " << DecorateIfNeeded(uniform->getName()) << " = "
                  << samplerArrayIndex << ";\n";
          }
      }
      TString suffix = TextureGroupSuffix(textureGroup);
      // Since HLSL_TEXTURE_2D is the first group, it has a fixed offset of zero.
      if (textureGroup != HLSL_TEXTURE_2D)
      {
          out << "static const uint textureIndexOffset" << suffix << " = "
              << (*groupTextureRegisterIndex) << ";\n";
          out << "static const uint samplerIndexOffset" << suffix << " = "
              << (*groupTextureRegisterIndex) << ";\n";
      }
      out << "uniform " << TextureString(textureGroup) << " textures" << suffix << "["
          << groupRegisterCount << "]"
          << " : register(t" << (*groupTextureRegisterIndex) << ");\n";
      out << "uniform " << SamplerString(textureGroup) << " samplers" << suffix << "["
          << groupRegisterCount << "]"
          << " : register(s" << (*groupTextureRegisterIndex) << ");\n";
      *groupTextureRegisterIndex += groupRegisterCount;
  }
  
  void UniformHLSL::outputHLSL4_0_FL9_3Sampler(TInfoSinkBase &out,
                                               const TType &type,
                                               const TName &name,
                                               const unsigned int registerIndex)
  {
      out << "uniform " << SamplerString(type.getBasicType()) << " sampler_"
          << DecorateUniform(name, type) << ArrayString(type) << " : register(s" << str(registerIndex)
          << ");\n";
      out << "uniform " << TextureString(type.getBasicType()) << " texture_"
          << DecorateUniform(name, type) << ArrayString(type) << " : register(t" << str(registerIndex)
          << ");\n";
  }
  
  void UniformHLSL::outputUniform(TInfoSinkBase &out,
                                  const TType &type,
                                  const TName &name,
                                  const unsigned int registerIndex)
  {
      const TStructure *structure = type.getStruct();
      // If this is a nameless struct, we need to use its full definition, rather than its (empty)
      // name.
      // TypeString() will invoke defineNameless in this case; qualifier prefixes are unnecessary for
      // nameless structs in ES, as nameless structs cannot be used anywhere that layout qualifiers
      // are permitted.
      const TString &typeName = ((structure && !structure->name().empty())
                                     ? QualifiedStructNameString(*structure, false, false)
                                     : TypeString(type));
  
      const TString &registerString =
          TString("register(") + UniformRegisterPrefix(type) + str(registerIndex) + ")";
  
      out << "uniform " << typeName << " ";
  
      out << DecorateUniform(name, type);
  
      out << ArrayString(type) << " : " << registerString << ";\n";
  }
  
  void UniformHLSL::uniformsHeader(TInfoSinkBase &out,
                                   ShShaderOutput outputType,
                                   const ReferencedSymbols &referencedUniforms)
  {
      if (!referencedUniforms.empty())
      {
          out << "// Uniforms\n\n";
      }
      // In the case of HLSL 4, sampler uniforms need to be grouped by type before the code is
      // written. They are grouped based on the combination of the HLSL texture type and
      // HLSL sampler type, enumerated in HLSLTextureSamplerGroup.
      TVector<TVector<const TIntermSymbol *>> groupedSamplerUniforms(HLSL_TEXTURE_MAX + 1);
      TMap<const TIntermSymbol *, TString> samplerInStructSymbolsToAPINames;
      for (auto &uniformIt : referencedUniforms)
      {
          // Output regular uniforms. Group sampler uniforms by type.
          const TIntermSymbol &uniform = *uniformIt.second;
          const TType &type            = uniform.getType();
          const TName &name            = uniform.getName();
  
          if (outputType == SH_HLSL_4_1_OUTPUT && IsSampler(type.getBasicType()))
          {
              HLSLTextureSamplerGroup group = TextureGroup(type.getBasicType());
              groupedSamplerUniforms[group].push_back(&uniform);
          }
          else if (outputType == SH_HLSL_4_0_FL9_3_OUTPUT && IsSampler(type.getBasicType()))
          {
              unsigned int registerIndex = assignUniformRegister(type, name.getString(), nullptr);
              outputHLSL4_0_FL9_3Sampler(out, type, name, registerIndex);
          }
          else
          {
              if (type.isStructureContainingSamplers())
              {
                  TVector<TIntermSymbol *> samplerSymbols;
                  TMap<TIntermSymbol *, TString> symbolsToAPINames;
                  unsigned int arrayOfStructsSize = type.isArray() ? type.getArraySize() : 0u;
                  type.createSamplerSymbols("angle_" + name.getString(), name.getString(),
                                            arrayOfStructsSize, &samplerSymbols, &symbolsToAPINames);
                  for (TIntermSymbol *sampler : samplerSymbols)
                  {
                      const TType &samplerType = sampler->getType();
  
                      // Will use angle_ prefix instead of regular prefix.
                      sampler->setInternal(true);
                      const TName &samplerName = sampler->getName();
  
                      if (outputType == SH_HLSL_4_1_OUTPUT)
                      {
                          HLSLTextureSamplerGroup group = TextureGroup(samplerType.getBasicType());
                          groupedSamplerUniforms[group].push_back(sampler);
                          samplerInStructSymbolsToAPINames[sampler] = symbolsToAPINames[sampler];
                      }
                      else if (outputType == SH_HLSL_4_0_FL9_3_OUTPUT)
                      {
                          unsigned int registerIndex = assignSamplerInStructUniformRegister(
                              samplerType, symbolsToAPINames[sampler], nullptr);
                          outputHLSL4_0_FL9_3Sampler(out, samplerType, samplerName, registerIndex);
                      }
                      else
                      {
                          ASSERT(outputType == SH_HLSL_3_0_OUTPUT);
                          unsigned int registerIndex = assignSamplerInStructUniformRegister(
                              samplerType, symbolsToAPINames[sampler], nullptr);
                          outputUniform(out, samplerType, samplerName, registerIndex);
                      }
                  }
              }
              unsigned int registerIndex = assignUniformRegister(type, name.getString(), nullptr);
              outputUniform(out, type, name, registerIndex);
          }
      }
  
      if (outputType == SH_HLSL_4_1_OUTPUT)
      {
          unsigned int groupTextureRegisterIndex = 0;
          // TEXTURE_2D is special, index offset is assumed to be 0 and omitted in that case.
          ASSERT(HLSL_TEXTURE_MIN == HLSL_TEXTURE_2D);
          for (int groupId = HLSL_TEXTURE_MIN; groupId < HLSL_TEXTURE_MAX; ++groupId)
          {
              outputHLSLSamplerUniformGroup(
                  out, HLSLTextureSamplerGroup(groupId), groupedSamplerUniforms[groupId],
                  samplerInStructSymbolsToAPINames, &groupTextureRegisterIndex);
          }
      }
  }
  
  void UniformHLSL::samplerMetadataUniforms(TInfoSinkBase &out, const char *reg)
  {
      // If mSamplerRegister is 0 the shader doesn't use any textures.
      if (mSamplerRegister > 0)
      {
          out << "    struct SamplerMetadata\n"
                 "    {\n"
                 "        int baseLevel;\n"
                 "        int internalFormatBits;\n"
                 "        int wrapModes;\n"
                 "        int padding;\n"
                 "    };\n"
                 "    SamplerMetadata samplerMetadata["
              << mSamplerRegister << "] : packoffset(" << reg << ");\n";
      }
  }
  
  TString UniformHLSL::interfaceBlocksHeader(const ReferencedSymbols &referencedInterfaceBlocks)
  {
      TString interfaceBlocks;
  
      for (ReferencedSymbols::const_iterator interfaceBlockIt = referencedInterfaceBlocks.begin();
           interfaceBlockIt != referencedInterfaceBlocks.end(); interfaceBlockIt++)
      {
          const TType &nodeType                 = interfaceBlockIt->second->getType();
          const TInterfaceBlock &interfaceBlock = *nodeType.getInterfaceBlock();
  
          unsigned int arraySize      = static_cast<unsigned int>(interfaceBlock.arraySize());
          unsigned int activeRegister = mInterfaceBlockRegister;
  
          mInterfaceBlockRegisterMap[interfaceBlock.name().c_str()] = activeRegister;
          mInterfaceBlockRegister += std::max(1u, arraySize);
  
          // FIXME: interface block field names
  
          if (interfaceBlock.hasInstanceName())
          {
              interfaceBlocks += interfaceBlockStructString(interfaceBlock);
          }
  
          if (arraySize > 0)
          {
              for (unsigned int arrayIndex = 0; arrayIndex < arraySize; arrayIndex++)
              {
                  interfaceBlocks +=
                      interfaceBlockString(interfaceBlock, activeRegister + arrayIndex, arrayIndex);
              }
          }
          else
          {
              interfaceBlocks +=
                  interfaceBlockString(interfaceBlock, activeRegister, GL_INVALID_INDEX);
          }
      }
  
      return (interfaceBlocks.empty() ? "" : ("// Interface Blocks\n\n" + interfaceBlocks));
  }
  
  TString UniformHLSL::interfaceBlockString(const TInterfaceBlock &interfaceBlock,
                                            unsigned int registerIndex,
                                            unsigned int arrayIndex)
  {
      const TString &arrayIndexString =
          (arrayIndex != GL_INVALID_INDEX ? Decorate(str(arrayIndex)) : "");
      const TString &blockName = interfaceBlock.name() + arrayIndexString;
      TString hlsl;
  
      hlsl += "cbuffer " + blockName + " : register(b" + str(registerIndex) +
              ")\n"
              "{\n";
  
      if (interfaceBlock.hasInstanceName())
      {
          hlsl += "    " + InterfaceBlockStructName(interfaceBlock) + " " +
                  interfaceBlockInstanceString(interfaceBlock, arrayIndex) + ";\n";
      }
      else
      {
          const TLayoutBlockStorage blockStorage = interfaceBlock.blockStorage();
          hlsl += interfaceBlockMembersString(interfaceBlock, blockStorage);
      }
  
      hlsl += "};\n\n";
  
      return hlsl;
  }
  
  TString UniformHLSL::interfaceBlockInstanceString(const TInterfaceBlock &interfaceBlock,
                                                    unsigned int arrayIndex)
  {
      if (!interfaceBlock.hasInstanceName())
      {
          return "";
      }
      else if (interfaceBlock.isArray())
      {
          return DecoratePrivate(interfaceBlock.instanceName()) + "_" + str(arrayIndex);
      }
      else
      {
          return Decorate(interfaceBlock.instanceName());
      }
  }
  
  TString UniformHLSL::interfaceBlockMembersString(const TInterfaceBlock &interfaceBlock,
                                                   TLayoutBlockStorage blockStorage)
  {
      TString hlsl;
  
      Std140PaddingHelper padHelper = mStructureHLSL->getPaddingHelper();
  
      for (unsigned int typeIndex = 0; typeIndex < interfaceBlock.fields().size(); typeIndex++)
      {
          const TField &field    = *interfaceBlock.fields()[typeIndex];
          const TType &fieldType = *field.type();
  
          if (blockStorage == EbsStd140)
          {
              // 2 and 3 component vector types in some cases need pre-padding
              hlsl += padHelper.prePaddingString(fieldType);
          }
  
          hlsl += "    " + InterfaceBlockFieldTypeString(field, blockStorage) + " " +
                  Decorate(field.name()) + ArrayString(fieldType) + ";\n";
  
          // must pad out after matrices and arrays, where HLSL usually allows itself room to pack
          // stuff
          if (blockStorage == EbsStd140)
          {
              const bool useHLSLRowMajorPacking =
                  (fieldType.getLayoutQualifier().matrixPacking == EmpColumnMajor);
              hlsl += padHelper.postPaddingString(fieldType, useHLSLRowMajorPacking);
          }
      }
  
      return hlsl;
  }
  
  TString UniformHLSL::interfaceBlockStructString(const TInterfaceBlock &interfaceBlock)
  {
      const TLayoutBlockStorage blockStorage = interfaceBlock.blockStorage();
  
      return "struct " + InterfaceBlockStructName(interfaceBlock) +
             "\n"
             "{\n" +
             interfaceBlockMembersString(interfaceBlock, blockStorage) + "};\n\n";
  }
  }