Hash :
8c78ce4b
Author :
Date :
2018-12-16T19:14:58
Use visitor pattern for Shader Variable APIs. In many places in ANGLE we need to traverse a ShaderVariable tree. We do this to store uniform offset and other information, to flatten the tree of uniforms for the front-end, or to produce active variable lists for uniform and shader storage blocks. In each case, we would write separate tree traversal code. This patch introduces a shared visitor pattern for all of the shader variable tree traversal instances. With that get more common code. Also it is easier to write new variable traversals. ProgramD3D and ProgramLinkedResources in particular get nice simplificiations. The visitor object recieves callbacks from the traversal when entering structs, array elements, and new variables. The visitor can treat these differently depending on the use case. A common visitor that constructs full variable names is used as a base class in several places. Also moves the 'isRowMajorLayout' from sh::InterfaceBlockField to sh::ShaderVariable. This allows us to forgo using templates in several call sites. Bug: angleproject:3024 Change-Id: I472d81ec775e2eee92fb3d2eb0ca83860221ba2e Reviewed-on: https://chromium-review.googlesource.com/c/1358722 Commit-Queue: Jamie Madill <jmadill@chromium.org> Reviewed-by: Yuly Novikov <ynovikov@chromium.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
//
// Copyright (c) 2013-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.
//
// blocklayout.cpp:
// Implementation for block layout classes and methods.
//
#include "compiler/translator/blocklayout.h"
#include "common/mathutil.h"
#include "common/utilities.h"
namespace sh
{
namespace
{
class BlockLayoutMapVisitor : public BlockEncoderVisitor
{
public:
BlockLayoutMapVisitor(BlockLayoutMap *blockInfoOut,
const std::string &instanceName,
BlockLayoutEncoder *encoder)
: BlockEncoderVisitor(instanceName, instanceName, encoder), mInfoOut(blockInfoOut)
{}
void encodeVariable(const ShaderVariable &variable,
const BlockMemberInfo &variableInfo,
const std::string &name,
const std::string &mappedName) override
{
ASSERT(!gl::IsSamplerType(variable.type));
(*mInfoOut)[name] = variableInfo;
}
private:
BlockLayoutMap *mInfoOut;
};
template <typename VarT>
void GetInterfaceBlockInfo(const std::vector<VarT> &fields,
const std::string &prefix,
sh::BlockLayoutEncoder *encoder,
bool inRowMajorLayout,
BlockLayoutMap *blockInfoOut)
{
// TODO(jiajia.qin@intel.com):we need to set the right structure base alignment before
// enterAggregateType for std430 layout just like GetShaderStorageBlockFieldMemberInfo did in
// ShaderStorageBlockOutputHLSL.cpp. http://anglebug.com/1920
BlockLayoutMapVisitor visitor(blockInfoOut, prefix, encoder);
TraverseShaderVariables(fields, inRowMajorLayout, &visitor);
}
void TraverseStructVariable(const ShaderVariable &variable,
bool isRowMajorLayout,
ShaderVariableVisitor *visitor)
{
const std::vector<ShaderVariable> &fields = variable.fields;
visitor->enterStructAccess(variable);
TraverseShaderVariables(fields, isRowMajorLayout, visitor);
visitor->exitStructAccess(variable);
}
void TraverseStructArrayVariable(const ShaderVariable &variable,
unsigned int arrayNestingIndex,
bool inRowMajorLayout,
ShaderVariableVisitor *visitor)
{
visitor->enterArray(variable);
// Nested arrays are processed starting from outermost (arrayNestingIndex 0u) and ending at the
// innermost. We make a special case for unsized arrays.
const unsigned int currentArraySize = variable.getNestedArraySize(arrayNestingIndex);
unsigned int count = std::max(currentArraySize, 1u);
for (unsigned int arrayElement = 0u; arrayElement < count; ++arrayElement)
{
visitor->enterArrayElement(variable, arrayElement);
ShaderVariable elementVar = variable;
elementVar.indexIntoArray(arrayElement);
if (arrayNestingIndex + 1u < variable.arraySizes.size())
{
TraverseStructArrayVariable(elementVar, arrayNestingIndex, inRowMajorLayout, visitor);
}
else
{
TraverseStructVariable(elementVar, inRowMajorLayout, visitor);
}
visitor->exitArrayElement(variable, arrayElement);
}
visitor->exitArray(variable);
}
void TraverseArrayOfArraysVariable(const ShaderVariable &variable,
unsigned int arrayNestingIndex,
bool isRowMajorMatrix,
ShaderVariableVisitor *visitor)
{
visitor->enterArray(variable);
const unsigned int currentArraySize = variable.getNestedArraySize(arrayNestingIndex);
unsigned int count = std::max(currentArraySize, 1u);
for (unsigned int arrayElement = 0u; arrayElement < count; ++arrayElement)
{
visitor->enterArrayElement(variable, arrayElement);
ShaderVariable elementVar = variable;
elementVar.indexIntoArray(arrayElement);
if (arrayNestingIndex + 2u < variable.arraySizes.size())
{
TraverseArrayOfArraysVariable(elementVar, arrayNestingIndex, isRowMajorMatrix, visitor);
}
else
{
if (gl::IsSamplerType(variable.type))
{
visitor->visitSampler(elementVar);
}
else
{
visitor->visitVariable(elementVar, isRowMajorMatrix);
}
}
visitor->exitArrayElement(variable, arrayElement);
}
visitor->exitArray(variable);
}
std::string CollapseNameStack(const std::vector<std::string> &nameStack)
{
std::stringstream strstr;
for (const std::string &part : nameStack)
{
strstr << part;
}
return strstr.str();
}
} // anonymous namespace
BlockLayoutEncoder::BlockLayoutEncoder() : mCurrentOffset(0), mStructureBaseAlignment(0) {}
BlockMemberInfo BlockLayoutEncoder::encodeType(GLenum type,
const std::vector<unsigned int> &arraySizes,
bool isRowMajorMatrix)
{
int arrayStride;
int matrixStride;
getBlockLayoutInfo(type, arraySizes, isRowMajorMatrix, &arrayStride, &matrixStride);
const BlockMemberInfo memberInfo(static_cast<int>(mCurrentOffset * BytesPerComponent),
static_cast<int>(arrayStride * BytesPerComponent),
static_cast<int>(matrixStride * BytesPerComponent),
isRowMajorMatrix);
advanceOffset(type, arraySizes, isRowMajorMatrix, arrayStride, matrixStride);
return memberInfo;
}
void BlockLayoutEncoder::increaseCurrentOffset(size_t offsetInBytes)
{
mCurrentOffset += (offsetInBytes / BytesPerComponent);
}
void BlockLayoutEncoder::setStructureBaseAlignment(size_t baseAlignment)
{
mStructureBaseAlignment = baseAlignment;
}
// static
size_t BlockLayoutEncoder::GetBlockRegister(const BlockMemberInfo &info)
{
return (info.offset / BytesPerComponent) / ComponentsPerRegister;
}
// static
size_t BlockLayoutEncoder::GetBlockRegisterElement(const BlockMemberInfo &info)
{
return (info.offset / BytesPerComponent) % ComponentsPerRegister;
}
void BlockLayoutEncoder::nextRegister()
{
mCurrentOffset = rx::roundUp<size_t>(mCurrentOffset, ComponentsPerRegister);
}
Std140BlockEncoder::Std140BlockEncoder() {}
void Std140BlockEncoder::enterAggregateType()
{
nextRegister();
}
void Std140BlockEncoder::exitAggregateType()
{
nextRegister();
}
void Std140BlockEncoder::getBlockLayoutInfo(GLenum type,
const std::vector<unsigned int> &arraySizes,
bool isRowMajorMatrix,
int *arrayStrideOut,
int *matrixStrideOut)
{
// We assume we are only dealing with 4 byte components (no doubles or half-words currently)
ASSERT(gl::VariableComponentSize(gl::VariableComponentType(type)) == BytesPerComponent);
size_t baseAlignment = 0;
int matrixStride = 0;
int arrayStride = 0;
if (gl::IsMatrixType(type))
{
baseAlignment = ComponentsPerRegister;
matrixStride = ComponentsPerRegister;
if (!arraySizes.empty())
{
const int numRegisters = gl::MatrixRegisterCount(type, isRowMajorMatrix);
arrayStride = ComponentsPerRegister * numRegisters;
}
}
else if (!arraySizes.empty())
{
baseAlignment = ComponentsPerRegister;
arrayStride = ComponentsPerRegister;
}
else
{
const int numComponents = gl::VariableComponentCount(type);
baseAlignment = (numComponents == 3 ? 4u : static_cast<size_t>(numComponents));
}
mCurrentOffset = rx::roundUp(mCurrentOffset, baseAlignment);
*matrixStrideOut = matrixStride;
*arrayStrideOut = arrayStride;
}
void Std140BlockEncoder::advanceOffset(GLenum type,
const std::vector<unsigned int> &arraySizes,
bool isRowMajorMatrix,
int arrayStride,
int matrixStride)
{
if (!arraySizes.empty())
{
mCurrentOffset += arrayStride * gl::ArraySizeProduct(arraySizes);
}
else if (gl::IsMatrixType(type))
{
const int numRegisters = gl::MatrixRegisterCount(type, isRowMajorMatrix);
mCurrentOffset += matrixStride * numRegisters;
}
else
{
mCurrentOffset += gl::VariableComponentCount(type);
}
}
Std430BlockEncoder::Std430BlockEncoder() {}
void Std430BlockEncoder::nextRegister()
{
mCurrentOffset = rx::roundUp<size_t>(mCurrentOffset, mStructureBaseAlignment);
}
void Std430BlockEncoder::getBlockLayoutInfo(GLenum type,
const std::vector<unsigned int> &arraySizes,
bool isRowMajorMatrix,
int *arrayStrideOut,
int *matrixStrideOut)
{
// We assume we are only dealing with 4 byte components (no doubles or half-words currently)
ASSERT(gl::VariableComponentSize(gl::VariableComponentType(type)) == BytesPerComponent);
size_t baseAlignment = 0;
int matrixStride = 0;
int arrayStride = 0;
if (gl::IsMatrixType(type))
{
const int numComponents = gl::MatrixComponentCount(type, isRowMajorMatrix);
baseAlignment = (numComponents == 3 ? 4u : static_cast<size_t>(numComponents));
matrixStride = baseAlignment;
if (!arraySizes.empty())
{
const int numRegisters = gl::MatrixRegisterCount(type, isRowMajorMatrix);
arrayStride = matrixStride * numRegisters;
}
}
else
{
const int numComponents = gl::VariableComponentCount(type);
baseAlignment = (numComponents == 3 ? 4u : static_cast<size_t>(numComponents));
if (!arraySizes.empty())
{
arrayStride = baseAlignment;
}
}
mStructureBaseAlignment = std::max(baseAlignment, mStructureBaseAlignment);
mCurrentOffset = rx::roundUp(mCurrentOffset, baseAlignment);
*matrixStrideOut = matrixStride;
*arrayStrideOut = arrayStride;
}
void GetInterfaceBlockInfo(const std::vector<InterfaceBlockField> &fields,
const std::string &prefix,
sh::BlockLayoutEncoder *encoder,
BlockLayoutMap *blockInfoOut)
{
// Matrix packing is always recorded in individual fields, so they'll set the row major layout
// flag to true if needed.
GetInterfaceBlockInfo(fields, prefix, encoder, false, blockInfoOut);
}
void GetUniformBlockInfo(const std::vector<Uniform> &uniforms,
const std::string &prefix,
sh::BlockLayoutEncoder *encoder,
BlockLayoutMap *blockInfoOut)
{
// Matrix packing is always recorded in individual fields, so they'll set the row major layout
// flag to true if needed.
GetInterfaceBlockInfo(uniforms, prefix, encoder, false, blockInfoOut);
}
// VariableNameVisitor implementation.
VariableNameVisitor::VariableNameVisitor(const std::string &namePrefix,
const std::string &mappedNamePrefix)
{
if (!namePrefix.empty())
{
mNameStack.push_back(namePrefix + ".");
}
if (!mappedNamePrefix.empty())
{
mMappedNameStack.push_back(mappedNamePrefix + ".");
}
}
VariableNameVisitor::~VariableNameVisitor() = default;
void VariableNameVisitor::enterStruct(const ShaderVariable &structVar)
{
mNameStack.push_back(structVar.name);
mMappedNameStack.push_back(structVar.mappedName);
}
void VariableNameVisitor::exitStruct(const ShaderVariable &structVar)
{
mNameStack.pop_back();
mMappedNameStack.pop_back();
}
void VariableNameVisitor::enterStructAccess(const ShaderVariable &structVar)
{
mNameStack.push_back(".");
mMappedNameStack.push_back(".");
}
void VariableNameVisitor::exitStructAccess(const ShaderVariable &structVar)
{
mNameStack.pop_back();
mMappedNameStack.pop_back();
}
void VariableNameVisitor::enterArray(const ShaderVariable &arrayVar)
{
if (!arrayVar.hasParentArrayIndex())
{
mNameStack.push_back(arrayVar.name);
mMappedNameStack.push_back(arrayVar.mappedName);
}
}
void VariableNameVisitor::exitArray(const ShaderVariable &arrayVar)
{
if (!arrayVar.hasParentArrayIndex())
{
mNameStack.pop_back();
mMappedNameStack.pop_back();
}
}
void VariableNameVisitor::enterArrayElement(const ShaderVariable &arrayVar,
unsigned int arrayElement)
{
std::stringstream strstr;
strstr << "[" << arrayElement << "]";
std::string elementString = strstr.str();
mNameStack.push_back(elementString);
mMappedNameStack.push_back(elementString);
}
std::string VariableNameVisitor::collapseNameStack() const
{
return CollapseNameStack(mNameStack);
}
std::string VariableNameVisitor::collapseMappedNameStack() const
{
return CollapseNameStack(mMappedNameStack);
}
void VariableNameVisitor::visitSampler(const sh::ShaderVariable &sampler)
{
if (!sampler.hasParentArrayIndex())
{
mNameStack.push_back(sampler.name);
mMappedNameStack.push_back(sampler.mappedName);
}
std::string name = collapseNameStack();
std::string mappedName = collapseMappedNameStack();
if (!sampler.hasParentArrayIndex())
{
mNameStack.pop_back();
mMappedNameStack.pop_back();
}
visitNamedSampler(sampler, name, mappedName);
}
void VariableNameVisitor::visitVariable(const ShaderVariable &variable, bool isRowMajor)
{
if (!variable.hasParentArrayIndex())
{
mNameStack.push_back(variable.name);
mMappedNameStack.push_back(variable.mappedName);
}
std::string name = collapseNameStack();
std::string mappedName = collapseMappedNameStack();
if (!variable.hasParentArrayIndex())
{
mNameStack.pop_back();
mMappedNameStack.pop_back();
}
visitNamedVariable(variable, isRowMajor, name, mappedName);
}
// BlockEncoderVisitor implementation.
BlockEncoderVisitor::BlockEncoderVisitor(const std::string &namePrefix,
const std::string &mappedNamePrefix,
BlockLayoutEncoder *encoder)
: VariableNameVisitor(namePrefix, mappedNamePrefix), mEncoder(encoder)
{}
BlockEncoderVisitor::~BlockEncoderVisitor() = default;
void BlockEncoderVisitor::enterStructAccess(const ShaderVariable &structVar)
{
VariableNameVisitor::enterStructAccess(structVar);
mEncoder->enterAggregateType();
}
void BlockEncoderVisitor::exitStructAccess(const ShaderVariable &structVar)
{
mEncoder->exitAggregateType();
VariableNameVisitor::exitStructAccess(structVar);
}
void BlockEncoderVisitor::visitNamedVariable(const ShaderVariable &variable,
bool isRowMajor,
const std::string &name,
const std::string &mappedName)
{
std::vector<unsigned int> innermostArraySize;
if (variable.isArray())
{
innermostArraySize.push_back(variable.getNestedArraySize(0));
}
BlockMemberInfo variableInfo =
mEncoder->encodeType(variable.type, innermostArraySize, isRowMajor);
encodeVariable(variable, variableInfo, name, mappedName);
}
void TraverseShaderVariable(const ShaderVariable &variable,
bool isRowMajorLayout,
ShaderVariableVisitor *visitor)
{
bool rowMajorLayout = (isRowMajorLayout || variable.isRowMajorLayout);
bool isRowMajor = rowMajorLayout && gl::IsMatrixType(variable.type);
if (variable.isStruct())
{
if (variable.isArray())
{
TraverseStructArrayVariable(variable, 0u, rowMajorLayout, visitor);
}
else
{
visitor->enterStruct(variable);
TraverseStructVariable(variable, rowMajorLayout, visitor);
visitor->exitStruct(variable);
}
}
else if (variable.isArrayOfArrays())
{
TraverseArrayOfArraysVariable(variable, 0u, isRowMajor, visitor);
}
else if (gl::IsSamplerType(variable.type))
{
visitor->visitSampler(variable);
}
else
{
visitor->visitVariable(variable, isRowMajor);
}
}
} // namespace sh